Debian Codegraph @

upstream/debian-unstable/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: 05/26/2026
6 .\" Manual: File Formats and Conventions
7 .\" Source: Samba 4.24.3-Debian-4.24.3+dfsg-1
8 .\" Language: English
9 .\"
10 .TH "SMB\&.CONF" "5" "05/26/2026" "Samba 4\&.24\&.3\-Debian\-4\&.24\&.3+dfs" "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 automount fs types (G)
1761 .PP
1762 .RS 4
1763 This parameter specifies a list of additional filesystem magic numbers that should trigger automounting when accessed\&.
1764 .sp
1765 The values should be specified as hexadecimal numbers (with or without 0x prefix), separated by spaces or commas\&.
1766 .sp
1767 Note: This parameter is only available on Linux systems\&.
1768 .sp
1769 To find the filesystem magic number for a mounted filesystem, consult /usr/include/linux/magic\&.h or call:
1770 stat \-f \-c \*(Aq0x%t\*(Aq /path/to/mountpoint
1771 .sp
1772 Note: autofs (0x187) is always checked and does not need to be included in this list\&.
1773 .sp
1774 Default:
1775 \fI\fIautomount fs types\fR\fR\fI = \fR\fI\fR\fI \fR
1776 .sp
1777 Example:
1778 \fI\fIautomount fs types\fR\fR\fI = \fR\fI0xA0B0C0D0 0x12345678\fR\fI \fR
1779 .RE
1780
1781 available (S)
1782 .PP
1783 .RS 4
1784 This parameter lets you "turn off" a service\&. If
1785 \fIavailable = no\fR, then
1786 \fIALL\fR
1787 attempts to connect to the service will fail\&. Such failures are logged\&.
1788 .sp
1789 Default:
1790 \fI\fIavailable\fR\fR\fI = \fR\fIyes\fR\fI \fR
1791 .RE
1792
1793 bind dns directory
1794 .PP
1795 .RS 4
1796 This parameter is a synonym for
1797 binddns dir\&.
1798 .RE
1799
1800 binddns dir (G)
1801 .PP
1802 .RS 4
1803 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!
1804 .sp
1805 Default:
1806 \fI\fIbinddns dir\fR\fR\fI = \fR\fI/var/lib/samba/bind\-dns\fR\fI \fR
1807 .RE
1808
1809 bind interfaces only (G)
1810 .PP
1811 .RS 4
1812 This global parameter allows the Samba admin to limit what interfaces on a machine will serve SMB requests\&. It affects file service
1813 \fBsmbd\fR(8)
1814 and name service
1815 \fBnmbd\fR(8)
1816 in a slightly different ways\&.
1817 .sp
1818 For name service it causes
1819 nmbd
1820 to bind to ports 137 and 138 on the interfaces listed in the
1821 \m[blue]\fBinterfaces\fR\m[]
1822 parameter\&.
1823 nmbd
1824 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
1825 nmbd
1826 will service name requests on all of these sockets\&. If
1827 \m[blue]\fBbind interfaces only\fR\m[]
1828 is set then
1829 nmbd
1830 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
1831 \m[blue]\fBinterfaces\fR\m[]
1832 parameter list\&. As unicast packets are received on the other sockets it allows
1833 nmbd
1834 to refuse to serve names to machines that send packets that arrive through any interfaces not listed in the
1835 \m[blue]\fBinterfaces\fR\m[]
1836 list\&. IP Source address spoofing does defeat this simple check, however, so it must not be used seriously as a security feature for
1837 nmbd\&.
1838 .sp
1839 For file service it causes
1840 \fBsmbd\fR(8)
1841 to bind only to the interface list given in the
1842 \m[blue]\fBinterfaces\fR\m[]
1843 parameter\&. This restricts the networks that
1844 smbd
1845 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\&.
1846 .sp
1847 If
1848 \m[blue]\fBbind interfaces only\fR\m[]
1849 is set and the network address
1850 \fI127\&.0\&.0\&.1\fR
1851 is not added to the
1852 \m[blue]\fBinterfaces\fR\m[]
1853 parameter list
1854 \fBsmbpasswd\fR(8)
1855 may not work as expected due to the reasons covered below\&.
1856 .sp
1857 To change a users SMB password, the
1858 smbpasswd
1859 by default connects to the
1860 \fIlocalhost \- 127\&.0\&.0\&.1\fR
1861 address as an SMB client to issue the password change request\&. If
1862 \m[blue]\fBbind interfaces only\fR\m[]
1863 is set then unless the network address
1864 \fI127\&.0\&.0\&.1\fR
1865 is added to the
1866 \m[blue]\fBinterfaces\fR\m[]
1867 parameter list then
1868 smbpasswd
1869 will fail to connect in it\*(Aqs default mode\&.
1870 smbpasswd
1871 can be forced to use the primary IP interface of the local host by using its
1872 \fBsmbpasswd\fR(8)
1873 \fI\-r \fR\fI\fIremote machine\fR\fR
1874 parameter, with
1875 \fIremote machine\fR
1876 set to the IP name of the primary interface of the local host\&.
1877 .sp
1878 Default:
1879 \fI\fIbind interfaces only\fR\fR\fI = \fR\fIno\fR\fI \fR
1880 .RE
1881
1882 blocking locks (S)
1883 .PP
1884 .RS 4
1885 This parameter controls the behavior of
1886 \fBsmbd\fR(8)
1887 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\&.
1888 .sp
1889 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\&.
1890 .sp
1891 If this parameter is set to
1892 \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\&.
1893 .sp
1894 Default:
1895 \fI\fIblocking locks\fR\fR\fI = \fR\fIyes\fR\fI \fR
1896 .RE
1897
1898 block size (S)
1899 .PP
1900 .RS 4
1901 This parameter controls the behavior of
1902 \fBsmbd\fR(8)
1903 when reporting disk free sizes\&. By default, this reports a disk block size of 1024 bytes\&.
1904 .sp
1905 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\&.
1906 .sp
1907 Changing this option does not change the disk free reporting size, just the block size unit reported to the client\&.
1908 .sp
1909 Default:
1910 \fI\fIblock size\fR\fR\fI = \fR\fI1024\fR\fI \fR
1911 .sp
1912 Example:
1913 \fI\fIblock size\fR\fR\fI = \fR\fI4096\fR\fI \fR
1914 .RE
1915
1916 browsable
1917 .PP
1918 .RS 4
1919 This parameter is a synonym for
1920 browseable\&.
1921 .RE
1922
1923 browseable (S)
1924 .PP
1925 .RS 4
1926 This controls whether this share is seen in the list of available shares in a net view and in the browse list\&.
1927 .sp
1928 Default:
1929 \fI\fIbrowseable\fR\fR\fI = \fR\fIyes\fR\fI \fR
1930 .RE
1931
1932 browse list (G)
1933 .PP
1934 .RS 4
1935 This controls whether
1936 \fBsmbd\fR(8)
1937 will serve a browse list to a client doing a
1938 NetServerEnum
1939 call\&. Normally set to
1940 \fByes\fR\&. You should never need to change this\&.
1941 .sp
1942 Default:
1943 \fI\fIbrowse list\fR\fR\fI = \fR\fIyes\fR\fI \fR
1944 .RE
1945
1946 cache directory (G)
1947 .PP
1948 .RS 4
1949 Usually, most of the TDB files are stored in the
1950 \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
1951 \fIstate directory\fR
1952 and the
1953 \fIcache directory\fR
1954 options\&.
1955 .sp
1956 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\&.
1957 .sp
1958 Default:
1959 \fI\fIcache directory\fR\fR\fI = \fR\fI/var/cache/samba\fR\fI \fR
1960 .sp
1961 Example:
1962 \fI\fIcache directory\fR\fR\fI = \fR\fI/var/run/samba/locks/cache\fR\fI \fR
1963 .RE
1964
1965 casesignames
1966 .PP
1967 .RS 4
1968 This parameter is a synonym for
1969 case sensitive\&.
1970 .RE
1971
1972 case sensitive (S)
1973 .PP
1974 .RS 4
1975 See the discussion in the section
1976 name mangling\&.
1977 .sp
1978 Default:
1979 \fI\fIcase sensitive\fR\fR\fI = \fR\fIauto\fR\fI \fR
1980 .RE
1981
1982 change notify (G)
1983 .PP
1984 .RS 4
1985 This parameter specifies whether Samba should reply to a client\*(Aqs file change notify requests\&.
1986 .sp
1987 You should never need to change this parameter
1988 .sp
1989 Default:
1990 \fI\fIchange notify\fR\fR\fI = \fR\fIyes\fR\fI \fR
1991 .RE
1992
1993 change share command (G)
1994 .PP
1995 .RS 4
1996 Samba 2\&.2\&.0 introduced the ability to dynamically add and delete shares via the Windows NT 4\&.0 Server Manager\&. The
1997 \fIchange share command\fR
1998 is used to define an external program or script which will modify an existing service definition in
1999 smb\&.conf\&.
2000 .sp
2001 In order to successfully execute the
2002 \fIchange share command\fR,
2003 smbd
2004 requires that the administrator connects using a root account (i\&.e\&. uid == 0) or has the
2005 SeDiskOperatorPrivilege\&. Scripts defined in the
2006 \fIchange share command\fR
2007 parameter are executed as root\&.
2008 .sp
2009 When executed,
2010 smbd
2011 will automatically invoke the
2012 \fIchange share command\fR
2013 with six parameters\&.
2014 .RS
2015 .sp
2016 .RS 4
2017 .ie n \{\
2018 \h'-04'\(bu\h'+03'\c
2019 .\}
2020 .el \{\
2021 .sp -1
2022 .IP \(bu 2.3
2023 .\}
2024 \fIconfigFile\fR
2025 \- the location of the global
2026 smb\&.conf
2027 file\&.
2028 .RE
2029 .sp
2030 .RS 4
2031 .ie n \{\
2032 \h'-04'\(bu\h'+03'\c
2033 .\}
2034 .el \{\
2035 .sp -1
2036 .IP \(bu 2.3
2037 .\}
2038 \fIshareName\fR
2039 \- the name of the new share\&.
2040 .RE
2041 .sp
2042 .RS 4
2043 .ie n \{\
2044 \h'-04'\(bu\h'+03'\c
2045 .\}
2046 .el \{\
2047 .sp -1
2048 .IP \(bu 2.3
2049 .\}
2050 \fIpathName\fR
2051 \- path to an **existing** directory on disk\&.
2052 .RE
2053 .sp
2054 .RS 4
2055 .ie n \{\
2056 \h'-04'\(bu\h'+03'\c
2057 .\}
2058 .el \{\
2059 .sp -1
2060 .IP \(bu 2.3
2061 .\}
2062 \fIcomment\fR
2063 \- comment string to associate with the new share\&.
2064 .RE
2065 .sp
2066 .RS 4
2067 .ie n \{\
2068 \h'-04'\(bu\h'+03'\c
2069 .\}
2070 .el \{\
2071 .sp -1
2072 .IP \(bu 2.3
2073 .\}
2074 \fImax connections\fR
2075 Number of maximum simultaneous connections to this share\&.
2076 .RE
2077 .sp
2078 .RS 4
2079 .ie n \{\
2080 \h'-04'\(bu\h'+03'\c
2081 .\}
2082 .el \{\
2083 .sp -1
2084 .IP \(bu 2.3
2085 .\}
2086 \fICSC policy\fR
2087 \- client side caching policy in string form\&. Valid values are: manual, documents, programs, disable\&.
2088 .RE
2089 .sp
2090 .RE
2091 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\&.
2092 .sp
2093 Default:
2094 \fI\fIchange share command\fR\fR\fI = \fR\fI\fR\fI \fR
2095 .sp
2096 Example:
2097 \fI\fIchange share command\fR\fR\fI = \fR\fI/usr/local/bin/changeshare\fR\fI \fR
2098 .RE
2099
2100 check parent directory delete on close (S)
2101 .PP
2102 .RS 4
2103 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\&.
2104 .sp
2105 Default:
2106 \fI\fIcheck parent directory delete on close\fR\fR\fI = \fR\fIno\fR\fI \fR
2107 .RE
2108
2109 check password script (G)
2110 .PP
2111 .RS 4
2112 The name of a program that can be used to check password complexity\&. The password is sent to the program\*(Aqs standard input\&.
2113 .sp
2114 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\&.
2115 .sp
2116 In Samba AD, this script will be run
2117 \fIAS ROOT\fR
2118 by
2119 \fBsamba\fR(8)
2120 without any substitutions\&.
2121 .sp
2122 Note that starting with Samba 4\&.11 the following environment variables are exported to the script:
2123 .RS
2124 .sp
2125 .RS 4
2126 .ie n \{\
2127 \h'-04'\(bu\h'+03'\c
2128 .\}
2129 .el \{\
2130 .sp -1
2131 .IP \(bu 2.3
2132 .\}
2133 SAMBA_CPS_ACCOUNT_NAME is always present and contains the sAMAccountName of user\&. It is the same as the \*(Aq%u\*(Aq substitutions in the non AD DC case\&.
2134 .RE
2135 .sp
2136 .RS 4
2137 .ie n \{\
2138 \h'-04'\(bu\h'+03'\c
2139 .\}
2140 .el \{\
2141 .sp -1
2142 .IP \(bu 2.3
2143 .\}
2144 SAMBA_CPS_USER_PRINCIPAL_NAME is optional in the AD DC case if the userPrincipalName is present\&.
2145 .RE
2146 .sp
2147 .RS 4
2148 .ie n \{\
2149 \h'-04'\(bu\h'+03'\c
2150 .\}
2151 .el \{\
2152 .sp -1
2153 .IP \(bu 2.3
2154 .\}
2155 SAMBA_CPS_FULL_NAME is optional if the displayName is present\&.
2156 .RE
2157 .sp
2158 .RE
2159 Even on a non AD DC SAMBA_CPS_ACCOUNT_NAME is the preferred way to access the account name, as it contains the raw value provided by the client\&. If that\*(Aqs not possible you should use single quotes (directly) around %u, e\&.g\&. /path/to/somescript \*(Aq%u\*(Aq, see CVE\-2026\-4408 for more details\&.
2160 .sp
2161 Note: In the example directory is a sample program called
2162 crackcheck
2163 that uses cracklib to check the password quality\&.
2164 .sp
2165 Default:
2166 \fI\fIcheck password script\fR\fR\fI = \fR\fI # Disabled\fR\fI \fR
2167 .sp
2168 Example:
2169 \fI\fIcheck password script\fR\fR\fI = \fR\fI/usr/local/sbin/crackcheck\fR\fI \fR
2170 .RE
2171
2172 client ipc max protocol (G)
2173 .PP
2174 .RS 4
2175 The value of the parameter (a string) is the highest protocol level that will be supported 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 latest supported protocol, currently
2182 \fBSMB3_11\fR\&.
2183 .sp
2184 See
2185 \m[blue]\fBclient max protocol\fR\m[]
2186 for a full list of available protocols\&. The values CORE, COREPLUS, LANMAN1, LANMAN2 are silently upgraded to NT1\&.
2187 .sp
2188 Default:
2189 \fI\fIclient ipc max protocol\fR\fR\fI = \fR\fIdefault\fR\fI \fR
2190 .sp
2191 Example:
2192 \fI\fIclient ipc max protocol\fR\fR\fI = \fR\fISMB2_10\fR\fI \fR
2193 .RE
2194
2195 client ipc min protocol (G)
2196 .PP
2197 .RS 4
2198 This setting controls the minimum protocol version that the will be attempted to use for IPC$ connections as DCERPC transport\&.
2199 .sp
2200 Normally this option should not be set as the automatic negotiation phase in the SMB protocol takes care of choosing the appropriate protocol\&.
2201 .sp
2202 The value
2203 \fBdefault\fR
2204 refers to the higher value of
2205 \fBNT1\fR
2206 and the effective value of
2207 \m[blue]\fBclient min protocol\fR\m[]\&.
2208 .sp
2209 See
2210 \m[blue]\fBclient max protocol\fR\m[]
2211 for a full list of available protocols\&. The values CORE, COREPLUS, LANMAN1, LANMAN2 are silently upgraded to NT1\&.
2212 .sp
2213 Default:
2214 \fI\fIclient ipc min protocol\fR\fR\fI = \fR\fIdefault\fR\fI \fR
2215 .sp
2216 Example:
2217 \fI\fIclient ipc min protocol\fR\fR\fI = \fR\fISMB3_11\fR\fI \fR
2218 .RE
2219
2220 client ipc signing (G)
2221 .PP
2222 .RS 4
2223 This controls whether the client is allowed or required to use SMB signing for IPC$ connections as DCERPC transport\&. Possible values are
2224 \fIdesired\fR,
2225 \fIrequired\fR
2226 and
2227 \fIdisabled\fR\&.
2228 .sp
2229 When set to required or default, SMB signing is mandatory\&.
2230 .sp
2231 When set to desired, SMB signing is offered, but not enforced and if set to disabled, SMB signing is not offered either\&.
2232 .sp
2233 Connections from winbindd to Active Directory Domain Controllers always enforce signing\&.
2234 .sp
2235 Default:
2236 \fI\fIclient ipc signing\fR\fR\fI = \fR\fIdefault\fR\fI \fR
2237 .RE
2238
2239 client lanman auth (G)
2240 .PP
2241 .RS 4
2242 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\&.
2243 .sp
2244 That is, in the future, the current default of
2245 client NTLMv2 auth = yes
2246 will be the enforced behaviour\&.
2247 .sp
2248 This parameter determines whether or not
2249 \fBsmbclient\fR(8)
2250 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\&.
2251 .sp
2252 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\&.
2253 .sp
2254 Disabling this option will also disable the
2255 client plaintext auth
2256 option\&.
2257 .sp
2258 Likewise, if the
2259 client ntlmv2 auth
2260 parameter is enabled, then only NTLMv2 logins will be attempted\&.
2261 .sp
2262 Default:
2263 \fI\fIclient lanman auth\fR\fR\fI = \fR\fIno\fR\fI \fR
2264 .RE
2265
2266 client ldap sasl wrapping (G)
2267 .PP
2268 .RS 4
2269 The
2270 \m[blue]\fBclient ldap sasl wrapping\fR\m[]
2271 defines whether ldap traffic will be signed or signed and encrypted (sealed)\&. Possible values are
2272 \fIplain\fR,
2273 \fIsign\fR
2274 and
2275 \fIseal\fR\&.
2276 .sp
2277 The values
2278 \fIsign\fR
2279 and
2280 \fIseal\fR
2281 are only available if Samba has been compiled against a modern OpenLDAP version (2\&.3\&.x or higher)\&.
2282 .sp
2283 This option is needed firstly to secure the privacy of administrative connections from
2284 samba\-tool, including in particular new or reset passwords for users\&. For this reason the default is
2285 \fIseal\fR\&.
2286 .sp
2287 Additionally,
2288 winbindd
2289 and the
2290 net
2291 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
2292 \fIsign\fR
2293 is required in practice\&.
2294 .sp
2295 The default value is
2296 \fIseal\fR\&. That implies synchronizing the time with the KDC in the case of using
2297 \fIKerberos\fR\&.
2298 .sp
2299 In order to force using LDAP (on port 389) with STARTTLS or LDAPS (on port 636), it is possible to use
2300 \fIstarttls\fR
2301 or
2302 \fIldaps\fR\&. In that case the NTLMSSP or Kerberos authentication using the TLS channel bindings in order to glue it to the connection\&.
2303 .sp
2304 Default:
2305 \fI\fIclient ldap sasl wrapping\fR\fR\fI = \fR\fIseal\fR\fI \fR
2306 .RE
2307
2308 client max protocol (G)
2309 .PP
2310 .RS 4
2311 The value of the parameter (a string) is the highest protocol level that will be supported by the client\&.
2312 .sp
2313 Possible values are :
2314 .RS
2315 .sp
2316 .RS 4
2317 .ie n \{\
2318 \h'-04'\(bu\h'+03'\c
2319 .\}
2320 .el \{\
2321 .sp -1
2322 .IP \(bu 2.3
2323 .\}
2324 \fBCORE\fR: Earliest version\&. No concept of user names\&.
2325 .RE
2326 .sp
2327 .RS 4
2328 .ie n \{\
2329 \h'-04'\(bu\h'+03'\c
2330 .\}
2331 .el \{\
2332 .sp -1
2333 .IP \(bu 2.3
2334 .\}
2335 \fBCOREPLUS\fR: Slight improvements on CORE for efficiency\&.
2336 .RE
2337 .sp
2338 .RS 4
2339 .ie n \{\
2340 \h'-04'\(bu\h'+03'\c
2341 .\}
2342 .el \{\
2343 .sp -1
2344 .IP \(bu 2.3
2345 .\}
2346 \fBLANMAN1\fR: First
2347 \fImodern\fR
2348 version of the protocol\&. Long filename support\&.
2349 .RE
2350 .sp
2351 .RS 4
2352 .ie n \{\
2353 \h'-04'\(bu\h'+03'\c
2354 .\}
2355 .el \{\
2356 .sp -1
2357 .IP \(bu 2.3
2358 .\}
2359 \fBLANMAN2\fR: Updates to Lanman1 protocol\&.
2360 .RE
2361 .sp
2362 .RS 4
2363 .ie n \{\
2364 \h'-04'\(bu\h'+03'\c
2365 .\}
2366 .el \{\
2367 .sp -1
2368 .IP \(bu 2.3
2369 .\}
2370 \fBNT1\fR: Current up to date version of the protocol\&. Used by Windows NT\&. Known as CIFS\&.
2371 .RE
2372 .sp
2373 .RS 4
2374 .ie n \{\
2375 \h'-04'\(bu\h'+03'\c
2376 .\}
2377 .el \{\
2378 .sp -1
2379 .IP \(bu 2.3
2380 .\}
2381 \fBSMB2\fR: Re\-implementation of the SMB protocol\&. Used by Windows Vista and later versions of Windows\&. SMB2 has sub protocols available\&.
2382 .RS
2383 .sp
2384 .RS 4
2385 .ie n \{\
2386 \h'-04'\(bu\h'+03'\c
2387 .\}
2388 .el \{\
2389 .sp -1
2390 .IP \(bu 2.3
2391 .\}
2392 \fBSMB2_02\fR: The earliest SMB2 version\&.
2393 .RE
2394 .sp
2395 .RS 4
2396 .ie n \{\
2397 \h'-04'\(bu\h'+03'\c
2398 .\}
2399 .el \{\
2400 .sp -1
2401 .IP \(bu 2.3
2402 .\}
2403 \fBSMB2_10\fR: Windows 7 SMB2 version\&.
2404 .RE
2405 .sp
2406 .RE
2407 By default SMB2 selects the SMB2_10 variant\&.
2408 .RE
2409 .sp
2410 .RS 4
2411 .ie n \{\
2412 \h'-04'\(bu\h'+03'\c
2413 .\}
2414 .el \{\
2415 .sp -1
2416 .IP \(bu 2.3
2417 .\}
2418 \fBSMB3\fR: The same as SMB2\&. Used by Windows 8\&. SMB3 has sub protocols available\&.
2419 .RS
2420 .sp
2421 .RS 4
2422 .ie n \{\
2423 \h'-04'\(bu\h'+03'\c
2424 .\}
2425 .el \{\
2426 .sp -1
2427 .IP \(bu 2.3
2428 .\}
2429 \fBSMB3_00\fR: Windows 8 SMB3 version\&.
2430 .RE
2431 .sp
2432 .RS 4
2433 .ie n \{\
2434 \h'-04'\(bu\h'+03'\c
2435 .\}
2436 .el \{\
2437 .sp -1
2438 .IP \(bu 2.3
2439 .\}
2440 \fBSMB3_02\fR: Windows 8\&.1 SMB3 version\&.
2441 .RE
2442 .sp
2443 .RS 4
2444 .ie n \{\
2445 \h'-04'\(bu\h'+03'\c
2446 .\}
2447 .el \{\
2448 .sp -1
2449 .IP \(bu 2.3
2450 .\}
2451 \fBSMB3_11\fR: Windows 10 SMB3 version\&.
2452 .RE
2453 .sp
2454 .RE
2455 By default SMB3 selects the SMB3_11 variant\&.
2456 .RE
2457 .sp
2458 .RE
2459 Normally this option should not be set as the automatic negotiation phase in the SMB protocol takes care of choosing the appropriate protocol\&.
2460 .sp
2461 The value
2462 \fBdefault\fR
2463 refers to
2464 \fBSMB3_11\fR\&.
2465 .sp
2466 IPC$ connections for DCERPC e\&.g\&. in winbindd, are handled by the
2467 \m[blue]\fBclient ipc max protocol\fR\m[]
2468 option\&.
2469 .sp
2470 Default:
2471 \fI\fIclient max protocol\fR\fR\fI = \fR\fIdefault\fR\fI \fR
2472 .sp
2473 Example:
2474 \fI\fIclient max protocol\fR\fR\fI = \fR\fILANMAN1\fR\fI \fR
2475 .RE
2476
2477 client min protocol (G)
2478 .PP
2479 .RS 4
2480 This setting controls the minimum protocol version that the client will attempt to use\&.
2481 .sp
2482 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\&.
2483 .sp
2484 See
2485 Related command: \m[blue]\fBclient max protocol\fR\m[]
2486 for a full list of available protocols\&.
2487 .sp
2488 IPC$ connections for DCERPC e\&.g\&. in winbindd, are handled by the
2489 \m[blue]\fBclient ipc min protocol\fR\m[]
2490 option\&.
2491 .sp
2492 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\&.
2493 .sp
2494 Default:
2495 \fI\fIclient min protocol\fR\fR\fI = \fR\fISMB2_02\fR\fI \fR
2496 .sp
2497 Example:
2498 \fI\fIclient min protocol\fR\fR\fI = \fR\fINT1\fR\fI \fR
2499 .RE
2500
2501 client netlogon ping protocol (G)
2502 .PP
2503 .RS 4
2504 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\&.
2505 .sp
2506 Possible values are :
2507 .RS
2508 .sp
2509 .RS 4
2510 .ie n \{\
2511 \h'-04'\(bu\h'+03'\c
2512 .\}
2513 .el \{\
2514 .sp -1
2515 .IP \(bu 2.3
2516 .\}
2517 \fBCLDAP\fR
2518 .RE
2519 .sp
2520 .RS 4
2521 .ie n \{\
2522 \h'-04'\(bu\h'+03'\c
2523 .\}
2524 .el \{\
2525 .sp -1
2526 .IP \(bu 2.3
2527 .\}
2528 \fBLDAP\fR
2529 .RE
2530 .sp
2531 .RS 4
2532 .ie n \{\
2533 \h'-04'\(bu\h'+03'\c
2534 .\}
2535 .el \{\
2536 .sp -1
2537 .IP \(bu 2.3
2538 .\}
2539 \fBLDAPS\fR
2540 .RE
2541 .sp
2542 .RS 4
2543 .ie n \{\
2544 \h'-04'\(bu\h'+03'\c
2545 .\}
2546 .el \{\
2547 .sp -1
2548 .IP \(bu 2.3
2549 .\}
2550 \fBSTARTTLS\fR
2551 .RE
2552 .sp
2553 .RE
2554 Default:
2555 \fI\fIclient netlogon ping protocol\fR\fR\fI = \fR\fICLDAP\fR\fI \fR
2556 .RE
2557
2558 client NTLMv2 auth (G)
2559 .PP
2560 .RS 4
2561 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\&.
2562 .sp
2563 That is, in the future, the current default of
2564 client NTLMv2 auth = yes
2565 will be the enforced behaviour\&.
2566 .sp
2567 This parameter determines whether or not
2568 \fBsmbclient\fR(8)
2569 will attempt to authenticate itself to servers using the NTLMv2 encrypted password response\&.
2570 .sp
2571 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
2572 .sp
2573 Similarly, if enabled, NTLMv1,
2574 client lanman auth
2575 and
2576 client plaintext auth
2577 authentication will be disabled\&. This also disables share\-level authentication\&.
2578 .sp
2579 If disabled, an NTLM response (and possibly a LANMAN response) will be sent by the client, depending on the value of
2580 client lanman auth\&.
2581 .sp
2582 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\&.
2583 .sp
2584 When
2585 \m[blue]\fBclient use spnego\fR\m[]
2586 is also set to
2587 \fByes\fR
2588 extended security (SPNEGO) is required in order to use NTLMv2 only within NTLMSSP\&. This behavior was introduced with the patches for CVE\-2016\-2111\&.
2589 .sp
2590 Default:
2591 \fI\fIclient NTLMv2 auth\fR\fR\fI = \fR\fIyes\fR\fI \fR
2592 .RE
2593
2594 client plaintext auth (G)
2595 .PP
2596 .RS 4
2597 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\&.
2598 .sp
2599 That is, in the future, the current default of
2600 client plaintext auth = no
2601 will be the enforced behaviour\&.
2602 .sp
2603 Specifies whether a client should send a plaintext password if the server does not support encrypted passwords\&.
2604 .sp
2605 Default:
2606 \fI\fIclient plaintext auth\fR\fR\fI = \fR\fIno\fR\fI \fR
2607 .RE
2608
2609 client protection (G)
2610 .PP
2611 .RS 4
2612 This parameter defines which protection Samba client tools should use by default\&.
2613 .sp
2614 Possible client settings are:
2615 .RS
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 \fIdefault\fR
2626 \- Use the individual default values of the options:
2627 .RS
2628 .sp
2629 .RS 4
2630 .ie n \{\
2631 \h'-04'\(bu\h'+03'\c
2632 .\}
2633 .el \{\
2634 .sp -1
2635 .IP \(bu 2.3
2636 .\}
2637 \fIclient signing\fR
2638 .RE
2639 .sp
2640 .RS 4
2641 .ie n \{\
2642 \h'-04'\(bu\h'+03'\c
2643 .\}
2644 .el \{\
2645 .sp -1
2646 .IP \(bu 2.3
2647 .\}
2648 \fIclient smb encrypt\fR
2649 .RE
2650 .sp
2651 .RE
2652 .RE
2653 .sp
2654 .RS 4
2655 .ie n \{\
2656 \h'-04'\(bu\h'+03'\c
2657 .\}
2658 .el \{\
2659 .sp -1
2660 .IP \(bu 2.3
2661 .\}
2662 \fIplain\fR
2663 \- This will send everything just as plaintext, signing or encryption are turned off\&.
2664 .RE
2665 .sp
2666 .RS 4
2667 .ie n \{\
2668 \h'-04'\(bu\h'+03'\c
2669 .\}
2670 .el \{\
2671 .sp -1
2672 .IP \(bu 2.3
2673 .\}
2674 \fIsign\fR
2675 \- This will enable integrity checking\&.
2676 .RE
2677 .sp
2678 .RS 4
2679 .ie n \{\
2680 \h'-04'\(bu\h'+03'\c
2681 .\}
2682 .el \{\
2683 .sp -1
2684 .IP \(bu 2.3
2685 .\}
2686 \fIencrypt\fR
2687 \- This will enable integrity checks and force encryption for privacy\&.
2688 .RE
2689 .sp
2690 .RE
2691 Default:
2692 \fI\fIclient protection\fR\fR\fI = \fR\fIdefault\fR\fI \fR
2693 .RE
2694
2695 client schannel (G)
2696 .PP
2697 .RS 4
2698 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\&.
2699 .sp
2700 This controls whether the client offers or even demands the use of the netlogon schannel\&.
2701 \m[blue]\fBclient schannel = no\fR\m[]
2702 does not offer the schannel,
2703 \m[blue]\fBclient schannel = auto\fR\m[]
2704 offers the schannel but does not enforce it, and
2705 \m[blue]\fBclient schannel = yes\fR\m[]
2706 denies access if the server is not able to speak netlogon schannel\&.
2707 .sp
2708 Note that for active directory domains this is hardcoded to
2709 \m[blue]\fBclient schannel = yes\fR\m[]\&.
2710 .sp
2711 This option is over\-ridden by the
2712 \m[blue]\fBrequire strong key\fR\m[]
2713 option\&.
2714 .sp
2715 Default:
2716 \fI\fIclient schannel\fR\fR\fI = \fR\fIyes\fR\fI \fR
2717 .sp
2718 Example:
2719 \fI\fIclient schannel\fR\fR\fI = \fR\fIauto\fR\fI \fR
2720 .RE
2721
2722 client signing (G)
2723 .PP
2724 .RS 4
2725 This controls whether the client is allowed or required to use SMB signing\&. Possible values are
2726 \fIdesired\fR,
2727 \fIrequired\fR
2728 and
2729 \fIdisabled\fR\&.
2730 .sp
2731 When set to desired or default, SMB signing is offered, but not enforced\&.
2732 .sp
2733 When set to required, SMB signing is mandatory and if set to disabled, SMB signing is not offered either\&.
2734 .sp
2735 IPC$ connections for DCERPC e\&.g\&. in winbindd, are handled by the
2736 \m[blue]\fBclient ipc signing\fR\m[]
2737 option\&.
2738 .sp
2739 Default:
2740 \fI\fIclient signing\fR\fR\fI = \fR\fIdefault\fR\fI \fR
2741 .RE
2742
2743 client smb encrypt (G)
2744 .PP
2745 .RS 4
2746 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:
2747 .RS
2748 .sp
2749 .RS 4
2750 .ie n \{\
2751 \h'-04'\(bu\h'+03'\c
2752 .\}
2753 .el \{\
2754 .sp -1
2755 .IP \(bu 2.3
2756 .\}
2757 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\&.
2758 .RE
2759 .sp
2760 .RS 4
2761 .ie n \{\
2762 \h'-04'\(bu\h'+03'\c
2763 .\}
2764 .el \{\
2765 .sp -1
2766 .IP \(bu 2.3
2767 .\}
2768 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\&.
2769 .RE
2770 .sp
2771 .RE
2772 This parameter can be set globally\&. Possible values are
2773 \fIoff\fR,
2774 \fIif_required\fR,
2775 \fIdesired\fR, and
2776 \fIrequired\fR\&. A special value is
2777 \fIdefault\fR
2778 which is the implicit default setting of
2779 \fIif_required\fR\&.
2780 .PP
2781 \fIEffects for SMB1\fR
2782 .RS 4
2783 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\&.
2784 .sp
2785 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\&.
2786 .RE
2787 .PP
2788 \fIEffects for SMB3 and newer\fR
2789 .RS 4
2790 Native SMB transport encryption is available in SMB version 3\&.0 or newer\&. It is only used by Samba if
2791 \fIclient max protocol\fR
2792 is set to
2793 \fISMB3\fR
2794 or newer\&.
2795 .sp
2796 These features can be controlled with settings of
2797 \fIclient smb encrypt\fR
2798 as follows:
2799 .RS
2800 .sp
2801 .RS 4
2802 .ie n \{\
2803 \h'-04'\(bu\h'+03'\c
2804 .\}
2805 .el \{\
2806 .sp -1
2807 .IP \(bu 2.3
2808 .\}
2809 Leaving it as default, explicitly setting
2810 \fIdefault\fR, or setting it to
2811 \fIif_required\fR
2812 globally will enable negotiation of encryption but will not turn on data encryption globally\&.
2813 .RE
2814 .sp
2815 .RS 4
2816 .ie n \{\
2817 \h'-04'\(bu\h'+03'\c
2818 .\}
2819 .el \{\
2820 .sp -1
2821 .IP \(bu 2.3
2822 .\}
2823 Setting it to
2824 \fIdesired\fR
2825 globally will enable negotiation and will turn on data encryption on sessions and share connections for those servers that support it\&.
2826 .RE
2827 .sp
2828 .RS 4
2829 .ie n \{\
2830 \h'-04'\(bu\h'+03'\c
2831 .\}
2832 .el \{\
2833 .sp -1
2834 .IP \(bu 2.3
2835 .\}
2836 Setting it to
2837 \fIrequired\fR
2838 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\&.
2839 .RE
2840 .sp
2841 .RS 4
2842 .ie n \{\
2843 \h'-04'\(bu\h'+03'\c
2844 .\}
2845 .el \{\
2846 .sp -1
2847 .IP \(bu 2.3
2848 .\}
2849 Setting it to
2850 \fIoff\fR
2851 globally will completely disable the encryption feature for all connections\&.
2852 .RE
2853 .sp
2854 .RE
2855 .RE
2856 .sp
2857 Default:
2858 \fI\fIclient smb encrypt\fR\fR\fI = \fR\fIdefault\fR\fI \fR
2859 .RE
2860
2861 client smb3 encryption algorithms (G)
2862 .PP
2863 .RS 4
2864 This parameter specifies the availability and order of encryption algorithms which are available for negotiation in the SMB3_11 dialect\&.
2865 .sp
2866 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\&.
2867 .sp
2868 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\&.
2869 .sp
2870 Default:
2871 \fI\fIclient smb3 encryption algorithms\fR\fR\fI = \fR\fIAES\-128\-GCM, AES\-128\-CCM, AES\-256\-GCM, AES\-256\-CCM\fR\fI \fR
2872 .sp
2873 Example:
2874 \fI\fIclient smb3 encryption algorithms\fR\fR\fI = \fR\fIAES\-256\-GCM\fR\fI \fR
2875 .sp
2876 Example:
2877 \fI\fIclient smb3 encryption algorithms\fR\fR\fI = \fR\fI\-AES\-128\-GCM \-AES\-128\-CCM\fR\fI \fR
2878 .RE
2879
2880 client smb encryption over quic (G)
2881 .PP
2882 .RS 4
2883 This parameter controls whether the client requires SMB level encryption even when the transport is already encrypted via QUIC and thus TLS\&.
2884 .sp
2885 \fIclient smb encrypt\fR
2886 controls the use of the encryption mechanism introduced with SMB3\&.0\&. If
2887 \fIclient smb encryption over quic\fR
2888 value is set to
2889 \fIno\fR,
2890 \fIand\fR
2891 the client connects via a validated QUIC (and thus TLS) connection, the client ignores the requirements from the parameter
2892 \fIclient smb encrypt\fR
2893 to avoid double encryption\&.
2894 .sp
2895 If
2896 \fIclient smb encryption over quic\fR
2897 is left at its default
2898 \fIyes\fR, the client connects over normal TCP, or the
2899 \fItls verify peer\fR
2900 was set to anything less than
2901 \fBca_and_name\fR, the requirements from
2902 \fIclient smb encrypt\fR
2903 apply\&.
2904 .sp
2905 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
2906 \fIclient smb encryption over quic\fR
2907 parameter\&.
2908 .sp
2909 Default:
2910 \fI\fIclient smb encryption over quic\fR\fR\fI = \fR\fIyes\fR\fI \fR
2911 .RE
2912
2913 client smb3 signing algorithms (G)
2914 .PP
2915 .RS 4
2916 This parameter specifies the availability and order of signing algorithms which are available for negotiation in the SMB3_11 dialect\&.
2917 .sp
2918 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\&.
2919 .sp
2920 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\&.
2921 .sp
2922 Default:
2923 \fI\fIclient smb3 signing algorithms\fR\fR\fI = \fR\fIAES\-128\-GMAC, AES\-128\-CMAC, HMAC\-SHA256\fR\fI \fR
2924 .sp
2925 Example:
2926 \fI\fIclient smb3 signing algorithms\fR\fR\fI = \fR\fIAES\-128\-CMAC, HMAC\-SHA256\fR\fI \fR
2927 .sp
2928 Example:
2929 \fI\fIclient smb3 signing algorithms\fR\fR\fI = \fR\fI\-AES\-128\-CMAC\fR\fI \fR
2930 .RE
2931
2932 client smb transports (G)
2933 .PP
2934 .RS 4
2935 Specifies which transports and ports the client should try to connect to for SMB traffic\&.
2936 .sp
2937 The order matters as they are tried in order with short delays for the fallbacks\&.
2938 .sp
2939 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\&.
2940 .sp
2941 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\&.
2942 .sp
2943 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:
2944 \m[blue]\fBtls enabled\fR\m[],
2945 \m[blue]\fBtls ca directories\fR\m[],
2946 \m[blue]\fBtls trust system cas\fR\m[],
2947 \m[blue]\fBtls cafile\fR\m[],
2948 \m[blue]\fBtls certfile\fR\m[],
2949 \m[blue]\fBtls keyfile\fR\m[]
2950 and
2951 \m[blue]\fBtls verify peer\fR\m[]\&.
2952 .sp
2953 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\&.
2954 .sp
2955 Numerical ports are handled as \*(Aqtcp\*(Aq except port \*(Aq139\*(Aq is handled as \*(Aqnbt\*(Aq\&.
2956 .sp
2957 Note that\*(Aqs currently a limit of 10 unique transports, all others will be ignored\&.
2958 .sp
2959 Default:
2960 \fI\fIclient smb transports\fR\fR\fI = \fR\fItcp, nbt\fR\fI \fR
2961 .sp
2962 Example:
2963 \fI\fIclient smb transports\fR\fR\fI = \fR\fI445\fR\fI \fR
2964 .sp
2965 Example:
2966 \fI\fIclient smb transports\fR\fR\fI = \fR\fItcp, tcp:1445\fR\fI \fR
2967 .sp
2968 Example:
2969 \fI\fIclient smb transports\fR\fR\fI = \fR\fI8000, nbt:1139\fR\fI \fR
2970 .sp
2971 Example:
2972 \fI\fIclient smb transports\fR\fR\fI = \fR\fItcp, quic, nbt\fR\fI \fR
2973 .sp
2974 Example:
2975 \fI\fIclient smb transports\fR\fR\fI = \fR\fI+quic\fR\fI \fR
2976 .RE
2977
2978 client use kerberos (G)
2979 .PP
2980 .RS 4
2981 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\&.
2982 .sp
2983 Possible option settings are:
2984 .RS
2985 .sp
2986 .RS 4
2987 .ie n \{\
2988 \h'-04'\(bu\h'+03'\c
2989 .\}
2990 .el \{\
2991 .sp -1
2992 .IP \(bu 2.3
2993 .\}
2994 \fIdesired\fR
2995 \- Kerberos authentication will be tried first and if it fails it automatically fallback to NTLM\&.
2996 .RE
2997 .sp
2998 .RS 4
2999 .ie n \{\
3000 \h'-04'\(bu\h'+03'\c
3001 .\}
3002 .el \{\
3003 .sp -1
3004 .IP \(bu 2.3
3005 .\}
3006 \fIrequired\fR
3007 \- Kerberos authentication will be required\&. There will be no fallback to NTLM or a different alternative\&.
3008 .RE
3009 .sp
3010 .RS 4
3011 .ie n \{\
3012 \h'-04'\(bu\h'+03'\c
3013 .\}
3014 .el \{\
3015 .sp -1
3016 .IP \(bu 2.3
3017 .\}
3018 \fIoff\fR
3019 \- Don\*(Aqt use Kerberos, use NTLM instead or another alternative\&.
3020 .RE
3021 .sp
3022 .RE
3023 In case that weak cryptography is not allowed (e\&.g\&. FIPS mode) the default will be forced to
3024 \fIrequired\fR\&.
3025 .sp
3026 Default:
3027 \fI\fIclient use kerberos\fR\fR\fI = \fR\fIdesired\fR\fI \fR
3028 .RE
3029
3030 client use krb5 netlogon (G)
3031 .PP
3032 .RS 4
3033 \fIThis option is experimental for now!\fR
3034 .sp
3035 This option controls whether winbindd (and other client tools) try to use ServerAuthenticateKerberos for the netlogon secure channel\&.
3036 .sp
3037 The behavior can be controlled per netbios domain by using \*(Aqclient use krb5 netlogon:NETBIOSDOMAIN = yes|no\*(Aq as option\&.
3038 .sp
3039 This option is over\-ridden by the
3040 \m[blue]\fBreject aes netlogon servers\fR\m[]
3041 option (if it is effectively on) and lets
3042 \m[blue]\fBclient use krb5 netlogon\fR\m[]
3043 be yes as well\&.
3044 .sp
3045 The \*(Aqdefault\*(Aq currently maps to \*(Aqno\*(Aq\&.
3046 .sp
3047 A meaning of \*(Aqauto\*(Aq depends on the used kerberos library and the trust/domain type\&.
3048 .sp
3049 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\&.
3050 .sp
3051 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\&.
3052 .sp
3053 \fI WARNING: This option is experimental in this Samba version (see VERSION section below) and should not be used in production! \fR
3054 .sp
3055 Default:
3056 \fI\fIclient use krb5 netlogon\fR\fR\fI = \fR\fIdefault\fR\fI \fR
3057 .sp
3058 Example:
3059 \fI\fIclient use krb5 netlogon\fR\fR\fI = \fR\fIno\fR\fI \fR
3060 .sp
3061 Example:
3062 \fI\fIclient use krb5 netlogon\fR\fR\fI = \fR\fIauto\fR\fI \fR
3063 .sp
3064 Example:
3065 \fI\fIclient use krb5 netlogon\fR\fR\fI = \fR\fIyes\fR\fI \fR
3066 .RE
3067
3068 client use spnego (G)
3069 .PP
3070 .RS 4
3071 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\&.
3072 .sp
3073 That is, in the future, the current default of
3074 client use spnego = yes
3075 will be the enforced behaviour\&.
3076 .sp
3077 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\&.
3078 .sp
3079 When
3080 \m[blue]\fBclient NTLMv2 auth\fR\m[]
3081 is also set to
3082 \fByes\fR
3083 extended security (SPNEGO) is required in order to use NTLMv2 only within NTLMSSP\&. This behavior was introduced with the patches for CVE\-2016\-2111\&.
3084 .sp
3085 Default:
3086 \fI\fIclient use spnego\fR\fR\fI = \fR\fIyes\fR\fI \fR
3087 .RE
3088
3089 cluster addresses (G)
3090 .PP
3091 .RS 4
3092 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
3093 \fInet ads dns register\fR
3094 is called with
3095 \m[blue]\fBclustering = yes\fR\m[]
3096 configured\&.
3097 .sp
3098 Default:
3099 \fI\fIcluster addresses\fR\fR\fI = \fR\fI\fR\fI \fR
3100 .sp
3101 Example:
3102 \fI\fIcluster addresses\fR\fR\fI = \fR\fI10\&.0\&.0\&.1 10\&.0\&.0\&.2 10\&.0\&.0\&.3\fR\fI \fR
3103 .RE
3104
3105 clustering (G)
3106 .PP
3107 .RS 4
3108 This parameter specifies whether Samba should contact ctdb for accessing its tdb files and use ctdb as a backend for its messaging backend\&.
3109 .sp
3110 Set this parameter to
3111 yes
3112 only if you have a cluster setup with ctdb running\&.
3113 .sp
3114 Default:
3115 \fI\fIclustering\fR\fR\fI = \fR\fIno\fR\fI \fR
3116 .RE
3117
3118 comment (S)
3119 .PP
3120 .RS 4
3121 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
3122 net view
3123 to list what shares are available\&.
3124 .sp
3125 If you want to set the string that is displayed next to the machine name then see the
3126 \m[blue]\fBserver string\fR\m[]
3127 parameter\&.
3128 .sp
3129 Default:
3130 \fI\fIcomment\fR\fR\fI = \fR\fI # No comment\fR\fI \fR
3131 .sp
3132 Example:
3133 \fI\fIcomment\fR\fR\fI = \fR\fIFred\*(Aqs Files\fR\fI \fR
3134 .RE
3135
3136 config backend (G)
3137 .PP
3138 .RS 4
3139 This controls the backend for storing the configuration\&. Possible values are
3140 \fIfile\fR
3141 (the default) and
3142 \fIregistry\fR\&. When
3143 \m[blue]\fBconfig backend = registry\fR\m[]
3144 is encountered while loading
3145 \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
3146 \fIregistry shares\fR
3147 is set to
3148 \fIyes\fR\&.
3149 .sp
3150 Note: This option can not be set inside the registry configuration itself\&.
3151 .sp
3152 Default:
3153 \fI\fIconfig backend\fR\fR\fI = \fR\fIfile\fR\fI \fR
3154 .sp
3155 Example:
3156 \fI\fIconfig backend\fR\fR\fI = \fR\fIregistry\fR\fI \fR
3157 .RE
3158
3159 config file (G)
3160 .PP
3161 .RS 4
3162 This allows you to override the config file to use, instead of the default (usually
3163 smb\&.conf)\&. There is a chicken and egg problem here as this option is set in the config file!
3164 .sp
3165 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\&.
3166 .sp
3167 This option takes the usual substitutions, which can be very useful\&.
3168 .sp
3169 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)\&.
3170 .sp
3171 \fINo default\fR
3172 .sp
3173 Example:
3174 \fI\fIconfig file\fR\fR\fI = \fR\fI/usr/local/samba/lib/smb\&.conf\&.%m\fR\fI \fR
3175 .RE
3176
3177 copy (S)
3178 .PP
3179 .RS 4
3180 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\&.
3181 .sp
3182 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\&.
3183 .sp
3184 Default:
3185 \fI\fIcopy\fR\fR\fI = \fR\fI\fR\fI \fR
3186 .sp
3187 Example:
3188 \fI\fIcopy\fR\fR\fI = \fR\fIotherservice\fR\fI \fR
3189 .RE
3190
3191 create krb5 conf (G)
3192 .PP
3193 .RS 4
3194 Setting this parameter to
3195 no
3196 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\&.
3197 .sp
3198 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\&.
3199 .sp
3200 Default:
3201 \fI\fIcreate krb5 conf\fR\fR\fI = \fR\fIyes\fR\fI \fR
3202 .RE
3203
3204 create mode
3205 .PP
3206 .RS 4
3207 This parameter is a synonym for
3208 create mask\&.
3209 .RE
3210
3211 create mask (S)
3212 .PP
3213 .RS 4
3214 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
3215 \fInot\fR
3216 set here will be removed from the modes set on a file when it is created\&.
3217 .sp
3218 The default value of this parameter removes the
3219 group
3220 and
3221 other
3222 write and execute bits from the UNIX modes\&.
3223 .sp
3224 Following this Samba will bit\-wise \*(AqOR\*(Aq the UNIX mode created from this parameter with the value of the
3225 \m[blue]\fBforce create mode\fR\m[]
3226 parameter which is set to 000 by default\&.
3227 .sp
3228 This parameter does not affect directory masks\&. See the parameter
3229 \m[blue]\fBdirectory mask\fR\m[]
3230 for details\&.
3231 .sp
3232 Default:
3233 \fI\fIcreate mask\fR\fR\fI = \fR\fI0744\fR\fI \fR
3234 .sp
3235 Example:
3236 \fI\fIcreate mask\fR\fR\fI = \fR\fI0775\fR\fI \fR
3237 .RE
3238
3239 csc policy (S)
3240 .PP
3241 .RS 4
3242 This stands for
3243 \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\&.
3244 .sp
3245 These values correspond to those used on Windows servers\&.
3246 .sp
3247 For example, shares containing roaming profiles can have offline caching disabled using
3248 \m[blue]\fBcsc policy = disable\fR\m[]\&.
3249 .sp
3250 Default:
3251 \fI\fIcsc policy\fR\fR\fI = \fR\fImanual\fR\fI \fR
3252 .sp
3253 Example:
3254 \fI\fIcsc policy\fR\fR\fI = \fR\fIprograms\fR\fI \fR
3255 .RE
3256
3257 ctdbd socket (G)
3258 .PP
3259 .RS 4
3260 In a test environment, this parameter can be used when
3261 clustering=yes
3262 to specify an alternate location for the CTDB Unix domain socket\&.
3263 .sp
3264 This parameter should not be set in production environments\&. If it is not set then the (correct) build\-time default is used\&.
3265 .sp
3266 Default:
3267 \fI\fIctdbd socket\fR\fR\fI = \fR\fI\fR\fI \fR
3268 .sp
3269 Example:
3270 \fI\fIctdbd socket\fR\fR\fI = \fR\fI/var/run/altctdb/ctdbd\&.socket\fR\fI \fR
3271 .RE
3272
3273 ctdb locktime warn threshold (G)
3274 .PP
3275 .RS 4
3276 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,
3277 \fIsmbd\fR
3278 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\&.
3279 .sp
3280 The default value of 0 disables this logging\&.
3281 .sp
3282 Default:
3283 \fI\fIctdb locktime warn threshold\fR\fR\fI = \fR\fI0\fR\fI \fR
3284 .RE
3285
3286 ctdb timeout (G)
3287 .PP
3288 .RS 4
3289 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
3290 \fIclustering=yes\fR\&.
3291 .sp
3292 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\&.
3293 .sp
3294 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\&.
3295 .sp
3296 Setting
3297 \fIctdb timeout\fR
3298 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\&.
3299 .sp
3300 Default:
3301 \fI\fIctdb timeout\fR\fR\fI = \fR\fI0\fR\fI \fR
3302 .RE
3303
3304 cups connection timeout (G)
3305 .PP
3306 .RS 4
3307 This parameter is only applicable if
3308 \m[blue]\fBprinting\fR\m[]
3309 is set to
3310 \fBcups\fR\&.
3311 .sp
3312 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\&.
3313 .sp
3314 Default:
3315 \fI\fIcups connection timeout\fR\fR\fI = \fR\fI30\fR\fI \fR
3316 .sp
3317 Example:
3318 \fI\fIcups connection timeout\fR\fR\fI = \fR\fI60\fR\fI \fR
3319 .RE
3320
3321 cups encrypt (G)
3322 .PP
3323 .RS 4
3324 This parameter is only applicable if
3325 \m[blue]\fBprinting\fR\m[]
3326 is set to
3327 \fBcups\fR
3328 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
3329 \fIauto\fR,
3330 \fIyes\fR
3331 and
3332 \fIno\fR
3333 .sp
3334 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\&.
3335 .sp
3336 Default:
3337 \fI\fIcups encrypt\fR\fR\fI = \fR\fIno\fR\fI \fR
3338 .RE
3339
3340 cups options (S)
3341 .PP
3342 .RS 4
3343 This parameter is only applicable if
3344 \m[blue]\fBprinting\fR\m[]
3345 is set to
3346 \fBcups\fR\&. Its value is a free form string of options passed directly to the cups library\&.
3347 .sp
3348 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\&.
3349 .sp
3350 You should set this parameter to
3351 \fBraw\fR
3352 if your CUPS server
3353 error_log
3354 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
3355 /etc/cups/mime\&.{convs,types}\&.
3356 .sp
3357 Default:
3358 \fI\fIcups options\fR\fR\fI = \fR\fI""\fR\fI \fR
3359 .sp
3360 Example:
3361 \fI\fIcups options\fR\fR\fI = \fR\fI"raw media=a4"\fR\fI \fR
3362 .RE
3363
3364 cups server (G)
3365 .PP
3366 .RS 4
3367 This parameter is only applicable if
3368 \m[blue]\fBprinting\fR\m[]
3369 is set to
3370 \fBcups\fR\&.
3371 .sp
3372 If set, this option overrides the ServerName option in the CUPS
3373 client\&.conf\&. This is necessary if you have virtual samba servers that connect to different CUPS daemons\&.
3374 .sp
3375 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\&.
3376 .sp
3377 Default:
3378 \fI\fIcups server\fR\fR\fI = \fR\fI""\fR\fI \fR
3379 .sp
3380 Example:
3381 \fI\fIcups server\fR\fR\fI = \fR\fImycupsserver\fR\fI \fR
3382 .sp
3383 Example:
3384 \fI\fIcups server\fR\fR\fI = \fR\fImycupsserver:1631\fR\fI \fR
3385 .RE
3386
3387 dcerpc endpoint servers (G)
3388 .PP
3389 .RS 4
3390 Specifies which DCE/RPC endpoint servers should be run\&.
3391 .sp
3392 Default:
3393 \fI\fIdcerpc endpoint servers\fR\fR\fI = \fR\fIepmapper, samr, netlogon, lsarpc, drsuapi, dssetup, unixinfo, browser, eventlog6, backupkey, dnsserver\fR\fI \fR
3394 .sp
3395 Example:
3396 \fI\fIdcerpc endpoint servers\fR\fR\fI = \fR\fIrpcecho\fR\fI \fR
3397 .RE
3398
3399 deadtime (G)
3400 .PP
3401 .RS 4
3402 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\&.
3403 .sp
3404 This is useful to stop a server\*(Aqs resources being exhausted by a large number of inactive connections\&.
3405 .sp
3406 Most clients have an auto\-reconnect feature when a connection is broken so in most cases this parameter should be transparent to users\&.
3407 .sp
3408 Using this parameter with a timeout of a few minutes is recommended for most systems\&.
3409 .sp
3410 A deadtime of zero indicates that no auto\-disconnection should be performed\&.
3411 .sp
3412 Default:
3413 \fI\fIdeadtime\fR\fR\fI = \fR\fI10080\fR\fI \fR
3414 .sp
3415 Example:
3416 \fI\fIdeadtime\fR\fR\fI = \fR\fI15\fR\fI \fR
3417 .RE
3418
3419 debug class (G)
3420 .PP
3421 .RS 4
3422 With this boolean parameter enabled, the debug class (DBGC_CLASS) will be displayed in the debug header\&.
3423 .sp
3424 For more information about currently available debug classes, see section about
3425 \m[blue]\fBlog level\fR\m[]\&.
3426 .sp
3427 Default:
3428 \fI\fIdebug class\fR\fR\fI = \fR\fIno\fR\fI \fR
3429 .RE
3430
3431 debug encryption (G)
3432 .PP
3433 .RS 4
3434 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\&.
3435 .sp
3436 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\&.
3437 .sp
3438 Default:
3439 \fI\fIdebug encryption\fR\fR\fI = \fR\fIno\fR\fI \fR
3440 .RE
3441
3442 debug hires timestamp (G)
3443 .PP
3444 .RS 4
3445 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\&.
3446 .sp
3447 Note that the parameter
3448 \m[blue]\fBdebug timestamp\fR\m[]
3449 or
3450 \m[blue]\fBdebug syslog format\fR\m[]
3451 must be on for this to have an effect\&.
3452 .sp
3453 Default:
3454 \fI\fIdebug hires timestamp\fR\fR\fI = \fR\fIyes\fR\fI \fR
3455 .RE
3456
3457 debug pid (G)
3458 .PP
3459 .RS 4
3460 When using only one log file for more then one forked
3461 \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\&.
3462 .sp
3463 Note that the parameter
3464 \m[blue]\fBdebug timestamp\fR\m[]
3465 must be on for this to have an effect\&.
3466 .sp
3467 Default:
3468 \fI\fIdebug pid\fR\fR\fI = \fR\fIno\fR\fI \fR
3469 .RE
3470
3471 debug prefix timestamp (G)
3472 .PP
3473 .RS 4
3474 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
3475 \m[blue]\fBdebug timestamp\fR\m[]
3476 parameter\&. This gives timestamps to the messages without adding an additional line\&.
3477 .sp
3478 Note that this parameter overrides the
3479 \m[blue]\fBdebug timestamp\fR\m[]
3480 parameter\&.
3481 .sp
3482 Default:
3483 \fI\fIdebug prefix timestamp\fR\fR\fI = \fR\fIno\fR\fI \fR
3484 .RE
3485
3486 debug syslog format (G)
3487 .PP
3488 .RS 4
3489 With this option enabled (\fByes\fR
3490 (alias
3491 \fBin_logs\fR) or
3492 \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\&.
3493 .sp
3494 The value
3495 \fBalways\fR
3496 produces this log format even to
3497 \fBSTDOUT\fR
3498 or
3499 \fBSTDERR\fR
3500 .sp
3501 The value
3502 \fBno\fR
3503 defers to other parameters and typically produces traditional two\-line Samba logs to log files\&.
3504 .sp
3505 If
3506 \m[blue]\fBdebug hires timestamp\fR\m[]
3507 is also enabled then an RFC5424 timestamp is used instead\&.
3508 .sp
3509 Default:
3510 \fI\fIdebug syslog format\fR\fR\fI = \fR\fIno\fR\fI \fR
3511 .RE
3512
3513 winbind debug traceid (G)
3514 .PP
3515 .RS 4
3516 With this boolean parameter enabled, the per request unique traceid will be displayed in the debug header for winbind processes\&.
3517 .sp
3518 Default:
3519 \fI\fIwinbind debug traceid\fR\fR\fI = \fR\fIyes\fR\fI \fR
3520 .RE
3521
3522 debug uid (G)
3523 .PP
3524 .RS 4
3525 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\&.
3526 .sp
3527 Note that the parameter
3528 \m[blue]\fBdebug timestamp\fR\m[]
3529 must be on for this to have an effect\&.
3530 .sp
3531 Default:
3532 \fI\fIdebug uid\fR\fR\fI = \fR\fIno\fR\fI \fR
3533 .RE
3534
3535 dedicated keytab file (G)
3536 .PP
3537 .RS 4
3538 Specifies the absolute path to the kerberos keytab file when
3539 \m[blue]\fBkerberos method\fR\m[]
3540 is set to "dedicated keytab"\&.
3541 .sp
3542 Default:
3543 \fI\fIdedicated keytab file\fR\fR\fI = \fR\fI\fR\fI \fR
3544 .sp
3545 Example:
3546 \fI\fIdedicated keytab file\fR\fR\fI = \fR\fI/usr/local/etc/krb5\&.keytab\fR\fI \fR
3547 .RE
3548
3549 default case (S)
3550 .PP
3551 .RS 4
3552 See the section on
3553 name mangling\&. Also note the
3554 \m[blue]\fBshort preserve case\fR\m[]
3555 parameter\&.
3556 .sp
3557 Default:
3558 \fI\fIdefault case\fR\fR\fI = \fR\fIlower\fR\fI \fR
3559 .RE
3560
3561 default devmode (S)
3562 .PP
3563 .RS 4
3564 This parameter is only applicable to
3565 \m[blue]\fBprintable\fR\m[]
3566 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\&.
3567 .sp
3568 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)\&.
3569 .sp
3570 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
3571 default devmode = yes
3572 will instruct smbd to generate a default one\&.
3573 .sp
3574 For more information on Windows NT/2k printing and Device Modes, see the
3575 MSDN documentation\&.
3576 .sp
3577 Default:
3578 \fI\fIdefault devmode\fR\fR\fI = \fR\fIyes\fR\fI \fR
3579 .RE
3580
3581 default
3582 .PP
3583 .RS 4
3584 This parameter is a synonym for
3585 default service\&.
3586 .RE
3587
3588 default service (G)
3589 .PP
3590 .RS 4
3591 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
3592 \fINOT\fR
3593 given in the parameter value (see example below)\&.
3594 .sp
3595 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\&.
3596 .sp
3597 Typically the default service would be a
3598 \m[blue]\fBguest ok\fR\m[],
3599 \m[blue]\fBread only\fR\m[]
3600 service\&.
3601 .sp
3602 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
3603 \fI%S\fR
3604 to make a wildcard service\&.
3605 .sp
3606 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\&.
3607 .sp
3608 Default:
3609 \fI\fIdefault service\fR\fR\fI = \fR\fI\fR\fI \fR
3610 .sp
3611 Example:
3612 \fI\fIdefault service\fR\fR\fI = \fR\fIpub\fR\fI \fR
3613 .RE
3614
3615 defer sharing violations (G)
3616 .PP
3617 .RS 4
3618 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\&.
3619 .sp
3620 UNIX by default does not have this behaviour\&.
3621 .sp
3622 There should be no reason to turn off this parameter, as it is designed to enable Samba to more correctly emulate Windows\&.
3623 .sp
3624 Default:
3625 \fI\fIdefer sharing violations\fR\fR\fI = \fR\fIyes\fR\fI \fR
3626 .RE
3627
3628 delete group script (G)
3629 .PP
3630 .RS 4
3631 This is the full pathname to a script that will be run
3632 \fIAS ROOT\fR
3633 by
3634 \fBsmbd\fR(8)
3635 when a group is requested to be deleted\&. It will expand any
3636 \fI%g\fR
3637 to the group name passed\&. This script is only useful for installations using the Windows NT domain administration tools\&.
3638 .sp
3639 Default:
3640 \fI\fIdelete group script\fR\fR\fI = \fR\fI\fR\fI \fR
3641 .RE
3642
3643 deleteprinter command (G)
3644 .PP
3645 .RS 4
3646 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\&.
3647 .sp
3648 For a Samba host this means that the printer must be physically deleted from the underlying printing system\&. The
3649 \m[blue]\fBdeleteprinter command\fR\m[]
3650 defines a script to be run which will perform the necessary operations for removing the printer from the print system and from
3651 smb\&.conf\&.
3652 .sp
3653 The
3654 \m[blue]\fBdeleteprinter command\fR\m[]
3655 is automatically called with only one parameter:
3656 \m[blue]\fBprinter name\fR\m[]\&.
3657 .sp
3658 Once the
3659 \m[blue]\fBdeleteprinter command\fR\m[]
3660 has been executed,
3661 smbd
3662 will reparse the
3663 smb\&.conf
3664 to check that the associated printer no longer exists\&. If the sharename is still valid, then
3665 smbd
3666 will return an ACCESS_DENIED error to the client\&.
3667 .sp
3668 Default:
3669 \fI\fIdeleteprinter command\fR\fR\fI = \fR\fI\fR\fI \fR
3670 .sp
3671 Example:
3672 \fI\fIdeleteprinter command\fR\fR\fI = \fR\fI/usr/bin/removeprinter\fR\fI \fR
3673 .RE
3674
3675 delete readonly (S)
3676 .PP
3677 .RS 4
3678 This parameter allows readonly files to be deleted\&. This is not normal DOS semantics, but is allowed by UNIX\&.
3679 .sp
3680 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\&.
3681 .sp
3682 Default:
3683 \fI\fIdelete readonly\fR\fR\fI = \fR\fIno\fR\fI \fR
3684 .RE
3685
3686 delete share command (G)
3687 .PP
3688 .RS 4
3689 Samba 2\&.2\&.0 introduced the ability to dynamically add and delete shares via the Windows NT 4\&.0 Server Manager\&. The
3690 \fIdelete share command\fR
3691 is used to define an external program or script which will remove an existing service definition from
3692 smb\&.conf\&.
3693 .sp
3694 In order to successfully execute the
3695 \fIdelete share command\fR,
3696 smbd
3697 requires that the administrator connects using a root account (i\&.e\&. uid == 0) or has the
3698 SeDiskOperatorPrivilege\&. Scripts defined in the
3699 \fIdelete share command\fR
3700 parameter are executed as root\&.
3701 .sp
3702 When executed,
3703 smbd
3704 will automatically invoke the
3705 \fIdelete share command\fR
3706 with two parameters\&.
3707 .RS
3708 .sp
3709 .RS 4
3710 .ie n \{\
3711 \h'-04'\(bu\h'+03'\c
3712 .\}
3713 .el \{\
3714 .sp -1
3715 .IP \(bu 2.3
3716 .\}
3717 \fIconfigFile\fR
3718 \- the location of the global
3719 smb\&.conf
3720 file\&.
3721 .RE
3722 .sp
3723 .RS 4
3724 .ie n \{\
3725 \h'-04'\(bu\h'+03'\c
3726 .\}
3727 .el \{\
3728 .sp -1
3729 .IP \(bu 2.3
3730 .\}
3731 \fIshareName\fR
3732 \- the name of the existing service\&.
3733 .RE
3734 .sp
3735 .RE
3736 This parameter is only used to remove file shares\&. To delete printer shares, see the
3737 \m[blue]\fBdeleteprinter command\fR\m[]\&.
3738 .sp
3739 Default:
3740 \fI\fIdelete share command\fR\fR\fI = \fR\fI\fR\fI \fR
3741 .sp
3742 Example:
3743 \fI\fIdelete share command\fR\fR\fI = \fR\fI/usr/local/bin/delshare\fR\fI \fR
3744 .RE
3745
3746 delete user from group script (G)
3747 .PP
3748 .RS 4
3749 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
3750 \fBsmbd\fR(8)
3751 \fIAS ROOT\fR\&. Any
3752 \fI%g\fR
3753 will be replaced with the group name and any
3754 \fI%u\fR
3755 will be replaced with the user name\&.
3756 .sp
3757 Default:
3758 \fI\fIdelete user from group script\fR\fR\fI = \fR\fI\fR\fI \fR
3759 .sp
3760 Example:
3761 \fI\fIdelete user from group script\fR\fR\fI = \fR\fI/usr/sbin/deluser %u %g\fR\fI \fR
3762 .RE
3763
3764 delete user script (G)
3765 .PP
3766 .RS 4
3767 This is the full pathname to a script that will be run by
3768 \fBsmbd\fR(8)
3769 when managing users with remote RPC (NT) tools\&.
3770 .sp
3771 This script is called when a remote client removes a user from the server, normally using \*(AqUser Manager for Domains\*(Aq or
3772 rpcclient\&.
3773 .sp
3774 This script should delete the given UNIX username\&.
3775 .sp
3776 Default:
3777 \fI\fIdelete user script\fR\fR\fI = \fR\fI\fR\fI \fR
3778 .sp
3779 Example:
3780 \fI\fIdelete user script\fR\fR\fI = \fR\fI/usr/local/samba/bin/del_user %u\fR\fI \fR
3781 .RE
3782
3783 delete veto files (S)
3784 .PP
3785 .RS 4
3786 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
3787 \m[blue]\fBveto files\fR\m[],
3788 \m[blue]\fBhide special files\fR\m[],
3789 \m[blue]\fBhide unreadable\fR\m[],
3790 \m[blue]\fBhide unwriteable files\fR\m[]
3791 options)\&. If this option is set to
3792 \fBno\fR
3793 (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\&.
3794 .sp
3795 If this option is set to
3796 \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\&.
3797 \&.AppleDouble)
3798 .sp
3799 Setting
3800 \m[blue]\fBdelete veto files = yes\fR\m[]
3801 allows these directories to be transparently deleted when the parent directory is deleted (so long as the user has permissions to do so)\&.
3802 .sp
3803 Default:
3804 \fI\fIdelete veto files\fR\fR\fI = \fR\fIno\fR\fI \fR
3805 .RE
3806
3807 dfree cache time (S)
3808 .PP
3809 .RS 4
3810 The
3811 \fIdfree cache time\fR
3812 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\&.
3813 .sp
3814 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
3815 \m[blue]\fBdfree command\fR\m[]
3816 scripts increasing the load\&.
3817 .sp
3818 By default this parameter is zero, meaning no caching will be done\&.
3819 .sp
3820 \fINo default\fR
3821 .sp
3822 Example:
3823 \fI\fIdfree cache time\fR\fR\fI = \fR\fI60\fR\fI \fR
3824 .RE
3825
3826 dfree command (S)
3827 .PP
3828 .RS 4
3829 The
3830 \fIdfree command\fR
3831 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\&.
3832 .sp
3833 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\&.
3834 .sp
3835 In Samba version 3\&.0\&.21 this parameter has been changed to be a per\-share parameter, and in addition the parameter
3836 \m[blue]\fBdfree cache time\fR\m[]
3837 was added to allow the output of this script to be cached for systems under heavy load\&.
3838 .sp
3839 The external program will be passed a single parameter indicating a directory in the filesystem being queried\&. This will typically consist of the string
3840 \&./\&. 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\&.
3841 .sp
3842 Note: Your script should
3843 \fINOT\fR
3844 be setuid or setgid and should be owned by (and writeable only by) root!
3845 .sp
3846 Where the script dfree (which must be made executable) could be:
3847 .sp
3848 .if n \{\
3849 .RS 4
3850 .\}
3851 .nf
3852
3853 #!/bin/sh
3854 df "$1" | tail \-1 | awk \*(Aq{print $(NF\-4),$(NF\-2)}\*(Aq
3855 .fi
3856 .if n \{\
3857 .RE
3858 .\}
3859 .sp
3860 or perhaps (on Sys V based systems):
3861 .sp
3862 .if n \{\
3863 .RS 4
3864 .\}
3865 .nf
3866
3867 #!/bin/sh
3868 /usr/bin/df \-k "$1" | tail \-1 | awk \*(Aq{print $3" "$5}\*(Aq
3869 .fi
3870 .if n \{\
3871 .RE
3872 .\}
3873 .sp
3874 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\&.
3875 .sp
3876 By default internal routines for determining the disk capacity and remaining space will be used\&.
3877 .sp
3878 \fINo default\fR
3879 .sp
3880 Example:
3881 \fI\fIdfree command\fR\fR\fI = \fR\fI/usr/local/samba/bin/dfree\fR\fI \fR
3882 .RE
3883
3884 dgram port (G)
3885 .PP
3886 .RS 4
3887 Specifies which ports the server should listen on for NetBIOS datagram traffic\&.
3888 .sp
3889 Default:
3890 \fI\fIdgram port\fR\fR\fI = \fR\fI138\fR\fI \fR
3891 .RE
3892
3893 directory mode
3894 .PP
3895 .RS 4
3896 This parameter is a synonym for
3897 directory mask\&.
3898 .RE
3899
3900 directory mask (S)
3901 .PP
3902 .RS 4
3903 This parameter is the octal modes which are used when converting DOS modes to UNIX modes when creating UNIX directories\&.
3904 .sp
3905 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
3906 \fInot\fR
3907 set here will be removed from the modes set on a directory when it is created\&.
3908 .sp
3909 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\&.
3910 .sp
3911 Following this Samba will bit\-wise \*(AqOR\*(Aq the UNIX mode created from this parameter with the value of the
3912 \m[blue]\fBforce directory mode\fR\m[]
3913 parameter\&. This parameter is set to 000 by default (i\&.e\&. no extra mode bits are added)\&.
3914 .sp
3915 Default:
3916 \fI\fIdirectory mask\fR\fR\fI = \fR\fI0755\fR\fI \fR
3917 .sp
3918 Example:
3919 \fI\fIdirectory mask\fR\fR\fI = \fR\fI0775\fR\fI \fR
3920 .RE
3921
3922 directory security mask (S)
3923 .PP
3924 .RS 4
3925 This parameter has been removed for Samba 4\&.0\&.0\&.
3926 .sp
3927 \fINo default\fR
3928 .RE
3929
3930 disable netbios (G)
3931 .PP
3932 .RS 4
3933 Enabling this parameter will disable netbios support in Samba\&. Netbios is the only available form of browsing in Windows versions prior to Windows 2000\&.
3934 .if n \{\
3935 .sp
3936 .\}
3937 .RS 4
3938 .it 1 an-trap
3939 .nr an-no-space-flag 1
3940 .nr an-break-flag 1
3941 .br
3942 .ps +1
3943 \fBNote\fR
3944 .ps -1
3945 .br
3946 Clients that only support netbios won\*(Aqt be able to see your samba server when netbios support is disabled\&.
3947 .sp .5v
3948 .RE
3949 Default:
3950 \fI\fIdisable netbios\fR\fR\fI = \fR\fIno\fR\fI \fR
3951 .RE
3952
3953 disable spoolss (G)
3954 .PP
3955 .RS 4
3956 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\&.
3957 \fIBe very careful about enabling this parameter\&.\fR
3958 .sp
3959 Default:
3960 \fI\fIdisable spoolss\fR\fR\fI = \fR\fIno\fR\fI \fR
3961 .RE
3962
3963 dmapi support (S)
3964 .PP
3965 .RS 4
3966 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\&.
3967 .sp
3968 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\&.
3969 .sp
3970 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\&.
3971 .sp
3972 Default:
3973 \fI\fIdmapi support\fR\fR\fI = \fR\fIno\fR\fI \fR
3974 .RE
3975
3976 dns hostname (G)
3977 .PP
3978 .RS 4
3979
3980 This value is used:
3981
3982 .RS
3983 .sp
3984 .RS 4
3985 .ie n \{\
3986 \h'-04'\(bu\h'+03'\c
3987 .\}
3988 .el \{\
3989 .sp -1
3990 .IP \(bu 2.3
3991 .\}
3992 to register DNS record with AD during a join or by calling
3993 .sp
3994 .if n \{\
3995 .RS 4
3996 .\}
3997 .nf
3998 net ads dns register
3999 .fi
4000 .if n \{\
4001 .RE
4002 .\}
4003 .RE
4004 .sp
4005 .RS 4
4006 .ie n \{\
4007 \h'-04'\(bu\h'+03'\c
4008 .\}
4009 .el \{\
4010 .sp -1
4011 .IP \(bu 2.3
4012 .\}
4013 during Kerberos authentication to create service principal names
4014 .RE
4015 .sp
4016 .RS 4
4017 .ie n \{\
4018 \h'-04'\(bu\h'+03'\c
4019 .\}
4020 .el \{\
4021 .sp -1
4022 .IP \(bu 2.3
4023 .\}
4024 during keytab creation \- see the
4025 \m[blue]\fBsync machine password to keytab\fR\m[]
4026 parameter
4027 .RE
4028 .sp
4029 .RE
4030 This is not supported in samba\-tool yet\&.
4031
4032 Default:
4033 \fI\fIdns hostname\fR\fR\fI = \fR\fI[netbios name]\&.[realm]\fR\fI \fR
4034 .sp
4035 Example:
4036 \fI\fIdns hostname\fR\fR\fI = \fR\fIclient\-hostname\&.example\&.com\fR\fI \fR
4037 .RE
4038
4039 dns forwarder (G)
4040 .PP
4041 .RS 4
4042 This option specifies the list of DNS servers that DNS requests will be forwarded to if they can not be handled by Samba itself\&.
4043 .sp
4044 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\&.
4045 .sp
4046 Default:
4047 \fI\fIdns forwarder\fR\fR\fI = \fR\fI\fR\fI \fR
4048 .sp
4049 Example:
4050 \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
4051 .RE
4052
4053 dns port (G)
4054 .PP
4055 .RS 4
4056 Specifies which ports the server should listen on for DNS traffic\&.
4057 .sp
4058 It makes possible to use another DNS server as a front and forward to Samba\&.
4059 .if n \{\
4060 .sp
4061 .\}
4062 .RS 4
4063 .it 1 an-trap
4064 .nr an-no-space-flag 1
4065 .nr an-break-flag 1
4066 .br
4067 .ps +1
4068 \fBWarning\fR
4069 .ps -1
4070 .br
4071 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\&.
4072 .sp .5v
4073 .RE
4074 Default:
4075 \fI\fIdns port\fR\fR\fI = \fR\fI53\fR\fI \fR
4076 .RE
4077
4078 dns proxy (G)
4079 .PP
4080 .RS 4
4081 Specifies that
4082 \fBnmbd\fR(8)
4083 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\&.
4084 .sp
4085 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\&.
4086 .sp
4087 nmbd
4088 spawns a second copy of itself to do the DNS name lookup requests, as doing a name lookup is a blocking action\&.
4089 .sp
4090 Default:
4091 \fI\fIdns proxy\fR\fR\fI = \fR\fIyes\fR\fI \fR
4092 .RE
4093
4094 dns update command (G)
4095 .PP
4096 .RS 4
4097 This option sets the command that is called when there are DNS updates\&. It should update the local machines DNS names using TSIG\-GSS\&.
4098 .sp
4099 Default:
4100 \fI\fIdns update command\fR\fR\fI = \fR\fI/build/reproducible\-path/samba\-4\&.24\&.3+dfsg/source4/scripting/bin/samba_dnsupdate\fR\fI \fR
4101 .sp
4102 Example:
4103 \fI\fIdns update command\fR\fR\fI = \fR\fI/usr/local/sbin/dnsupdate\fR\fI \fR
4104 .RE
4105
4106 dns zone scavenging (G)
4107 .PP
4108 .RS 4
4109 When enabled (the default is disabled) unused dynamic dns records are periodically removed\&.
4110 .if n \{\
4111 .sp
4112 .\}
4113 .RS 4
4114 .it 1 an-trap
4115 .nr an-no-space-flag 1
4116 .nr an-break-flag 1
4117 .br
4118 .ps +1
4119 \fBWarning\fR
4120 .ps -1
4121 .br
4122 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\&.
4123 .sp .5v
4124 .RE
4125 .if n \{\
4126 .sp
4127 .\}
4128 .RS 4
4129 .it 1 an-trap
4130 .nr an-no-space-flag 1
4131 .nr an-break-flag 1
4132 .br
4133 .ps +1
4134 \fBNote\fR
4135 .ps -1
4136 .br
4137 If one record for a DNS name is static (non\-aging) then no other record for that DNS name will be scavenged\&.
4138 .sp .5v
4139 .RE
4140 Default:
4141 \fI\fIdns zone scavenging\fR\fR\fI = \fR\fIno\fR\fI \fR
4142 .RE
4143
4144 dns zone transfer clients allow (G)
4145 .PP
4146 .RS 4
4147 This option specifies the list of IPs authorized to ask for dns zone transfer from bind DLZ module\&.
4148 .sp
4149 The IP list is comma and space separated and specified in the same syntax as used in
4150 \m[blue]\fBhosts allow\fR\m[], specifically including IP address, IP prefixes and IP address masks\&.
4151 .sp
4152 As this is a DNS server option, hostnames are naturally not permitted\&.
4153 .sp
4154 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
4155 \m[blue]\fBdns zone transfer clients deny\fR\m[]
4156 .sp
4157 Default:
4158 \fI\fIdns zone transfer clients allow\fR\fR\fI = \fR\fI\fR\fI \fR
4159 .sp
4160 Example:
4161 \fI\fIdns zone transfer clients allow\fR\fR\fI = \fR\fI192\&.168\&.0\&.1\fR\fI \fR
4162 .RE
4163
4164 dns zone transfer clients deny (G)
4165 .PP
4166 .RS 4
4167 This option specifies the list of IPs denied to ask for dns zone transfer from bind DLZ module\&.
4168 .sp
4169 The IP list is comma and space separated and specified in the same syntax as used in
4170 \m[blue]\fBhosts allow\fR\m[], specifically including IP address, IP prefixes and IP address masks\&.
4171 .sp
4172 As this is a DNS server option, hostnames are naturally not permitted\&.
4173 .sp
4174 If a client identified in this list sends a zone transfer request, it will always be denied, even if they are in
4175 \m[blue]\fBdns zone transfer clients allow\fR\m[]\&. This allows the definition of specific denied clients within an authorized subnet\&.
4176 .sp
4177 Default:
4178 \fI\fIdns zone transfer clients deny\fR\fR\fI = \fR\fI\fR\fI \fR
4179 .sp
4180 Example:
4181 \fI\fIdns zone transfer clients deny\fR\fR\fI = \fR\fI192\&.168\&.0\&.1\fR\fI \fR
4182 .RE
4183
4184 domain logons (G)
4185 .PP
4186 .RS 4
4187 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\&.
4188 .sp
4189 That is, in the future, the current default of
4190 domain logons = no
4191 will be the enforced behaviour\&.
4192 .sp
4193 If set to
4194 \fByes\fR, the Samba server will provide the netlogon service for Windows 9X network logons for the
4195 \m[blue]\fBworkgroup\fR\m[]
4196 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\&.
4197 .sp
4198 Default:
4199 \fI\fIdomain logons\fR\fR\fI = \fR\fIno\fR\fI \fR
4200 .RE
4201
4202 domain master (G)
4203 .PP
4204 .RS 4
4205 Tell
4206 \fBsmbd\fR(8)
4207 to enable WAN\-wide browse list collation\&. Setting this option causes
4208 nmbd
4209 to claim a special domain specific NetBIOS name that identifies it as a domain master browser for its given
4210 \m[blue]\fBworkgroup\fR\m[]\&. Local master browsers in the same
4211 \m[blue]\fBworkgroup\fR\m[]
4212 on broadcast\-isolated subnets will give this
4213 nmbd
4214 their local browse lists, and then ask
4215 \fBsmbd\fR(8)
4216 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\&.
4217 .sp
4218 Note that Windows NT Primary Domain Controllers expect to be able to claim this
4219 \m[blue]\fBworkgroup\fR\m[]
4220 specific special NetBIOS name that identifies them as domain master browsers for that
4221 \m[blue]\fBworkgroup\fR\m[]
4222 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
4223 nmbd
4224 claims the special name for a
4225 \m[blue]\fBworkgroup\fR\m[]
4226 before a Windows NT PDC is able to do so then cross subnet browsing will behave strangely and may fail\&.
4227 .sp
4228 If
4229 \m[blue]\fBdomain logons = yes\fR\m[], then the default behavior is to enable the
4230 \m[blue]\fBdomain master\fR\m[]
4231 parameter\&. If
4232 \m[blue]\fBdomain logons\fR\m[]
4233 is not enabled (the default setting), then neither will
4234 \m[blue]\fBdomain master\fR\m[]
4235 be enabled by default\&.
4236 .sp
4237 When
4238 \m[blue]\fBdomain logons = Yes\fR\m[]
4239 the default setting for this parameter is Yes, with the result that Samba will be a PDC\&. If
4240 \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\&.
4241 .sp
4242 Default:
4243 \fI\fIdomain master\fR\fR\fI = \fR\fIauto\fR\fI \fR
4244 .RE
4245
4246 dont descend (S)
4247 .PP
4248 .RS 4
4249 There are certain directories on some systems (e\&.g\&., the
4250 /proc
4251 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\&.
4252 .sp
4253 Note that Samba can be very fussy about the exact format of the "dont descend" entries\&. For example you may need
4254 \&./proc
4255 instead of just
4256 /proc\&. Experimentation is the best policy :\-)
4257 .sp
4258 Default:
4259 \fI\fIdont descend\fR\fR\fI = \fR\fI\fR\fI \fR
4260 .sp
4261 Example:
4262 \fI\fIdont descend\fR\fR\fI = \fR\fI/proc,/dev\fR\fI \fR
4263 .RE
4264
4265 dos charset (G)
4266 .PP
4267 .RS 4
4268 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\&.
4269 .sp
4270 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
4271 \fBtestparm\fR(1)
4272 to check the default on your system\&.
4273 .sp
4274 \fINo default\fR
4275 .RE
4276
4277 dos filemode (S)
4278 .PP
4279 .RS 4
4280 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\&.
4281 .sp
4282 Default:
4283 \fI\fIdos filemode\fR\fR\fI = \fR\fIno\fR\fI \fR
4284 .RE
4285
4286 dos filetime resolution (S)
4287 .PP
4288 .RS 4
4289 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
4290 \fBsmbd\fR(8)\&.
4291 .sp
4292 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\&.
4293 .sp
4294 Default:
4295 \fI\fIdos filetime resolution\fR\fR\fI = \fR\fIno\fR\fI \fR
4296 .RE
4297
4298 dos filetimes (S)
4299 .PP
4300 .RS 4
4301 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
4302 smbd
4303 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\&.
4304 .sp
4305 Default:
4306 \fI\fIdos filetimes\fR\fR\fI = \fR\fIyes\fR\fI \fR
4307 .RE
4308
4309 dsdb event notification (G)
4310 .PP
4311 .RS 4
4312 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
4313 dsdb_event\&.
4314 .sp
4315 This is
4316 \fInot\fR
4317 needed for the audit logging described in
4318 \m[blue]\fBlog level\fR\m[]\&.
4319 .sp
4320 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)\&.
4321 .sp
4322 The Samba database events are also logged via the normal logging methods when the
4323 \m[blue]\fBlog level\fR\m[]
4324 is set appropriately, say to
4325 dsdb_json_audit:5\&.
4326 .sp
4327 Default:
4328 \fI\fIdsdb event notification\fR\fR\fI = \fR\fIno\fR\fI \fR
4329 .RE
4330
4331 dsdb group change notification (G)
4332 .PP
4333 .RS 4
4334 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
4335 dsdb_group_event\&.
4336 .sp
4337 This is
4338 \fInot\fR
4339 needed for the audit logging described in
4340 \m[blue]\fBlog level\fR\m[]\&.
4341 .sp
4342 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)\&.
4343 .sp
4344 The Samba database events are also logged via the normal logging methods when the
4345 \m[blue]\fBlog level\fR\m[]
4346 is set appropriately, say to
4347 dsdb_group_json_audit:5\&.
4348 .sp
4349 Default:
4350 \fI\fIdsdb group change notification\fR\fR\fI = \fR\fIno\fR\fI \fR
4351 .RE
4352
4353 dsdb password event notification (G)
4354 .PP
4355 .RS 4
4356 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
4357 password_event\&.
4358 .sp
4359 This is
4360 \fInot\fR
4361 needed for the audit logging described in
4362 \m[blue]\fBlog level\fR\m[]\&.
4363 .sp
4364 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)\&.
4365 .sp
4366 The Samba database events are also logged via the normal logging methods when the
4367 \m[blue]\fBlog level\fR\m[]
4368 is set appropriately, say to
4369 dsdb_password_json_audit:5\&.
4370 .sp
4371 Default:
4372 \fI\fIdsdb password event notification\fR\fR\fI = \fR\fIno\fR\fI \fR
4373 .RE
4374
4375 durable handles (S)
4376 .PP
4377 .RS 4
4378 This boolean parameter controls whether Samba can grant SMB2 durable file handles on a share\&.
4379 .sp
4380 Note that durable handles are only enabled if
4381 \m[blue]\fBkernel oplocks = no\fR\m[],
4382 \m[blue]\fBkernel share modes = no\fR\m[], and
4383 \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\&.
4384 .sp
4385 Also note that, for the time being, durability is not granted for a handle that has the delete on close flag set\&.
4386 .sp
4387 Default:
4388 \fI\fIdurable handles\fR\fR\fI = \fR\fIyes\fR\fI \fR
4389 .RE
4390
4391 ea support (S)
4392 .PP
4393 .RS 4
4394 This boolean parameter controls whether
4395 \fBsmbd\fR(8)
4396 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:
4397 .RS
4398 .sp
4399 .RS 4
4400 .ie n \{\
4401 \h'-04'\(bu\h'+03'\c
4402 .\}
4403 .el \{\
4404 .sp -1
4405 .IP \(bu 2.3
4406 .\}
4407 Samba must have been built with extended attributes support\&.
4408 .RE
4409 .sp
4410 .RS 4
4411 .ie n \{\
4412 \h'-04'\(bu\h'+03'\c
4413 .\}
4414 .el \{\
4415 .sp -1
4416 .IP \(bu 2.3
4417 .\}
4418 The underlying filesystem exposed by the share must support extended attributes (e\&.g\&. the getfattr(1)
4419 / setfattr(1)
4420 utilities must work)\&.
4421 .RE
4422 .sp
4423 .RS 4
4424 .ie n \{\
4425 \h'-04'\(bu\h'+03'\c
4426 .\}
4427 .el \{\
4428 .sp -1
4429 .IP \(bu 2.3
4430 .\}
4431 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)\&.
4432 .RE
4433 .sp
4434 .RE
4435 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\&.
4436 .sp
4437 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\&.
4438 .sp
4439 Default:
4440 \fI\fIea support\fR\fR\fI = \fR\fIyes\fR\fI \fR
4441 .RE
4442
4443 elasticsearch:address (S)
4444 .PP
4445 .RS 4
4446 Specifies the name of the Elasticsearch server to use for Spotlight queries when using the Elasticsearch backend\&.
4447 .sp
4448 Default:
4449 \fI\fIelasticsearch:address\fR\fR\fI = \fR\fIlocalhost\fR\fI \fR
4450 .sp
4451 Example:
4452 \fI\fIelasticsearch:address\fR\fR\fI = \fR\fIneedle\&.haystack\&.samba\&.org\fR\fI \fR
4453 .RE
4454
4455 elasticsearch:default_fields (G)
4456 .PP
4457 .RS 4
4458 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\&.
4459 .sp
4460 This option expects a list of Elasticsearch attributes separated by comma where each attributes must be enclosed in double quotes\&.
4461 .sp
4462 Default:
4463 \fI\fIelasticsearch:default_fields\fR\fR\fI = \fR\fI"file\&.filename", "content"\fR\fI \fR
4464 .sp
4465 Example:
4466 \fI\fIelasticsearch:default_fields\fR\fR\fI = \fR\fI"foo", "bar"\fR\fI \fR
4467 .RE
4468
4469 elasticsearch:force substring search (G)
4470 .PP
4471 .RS 4
4472 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"\&.
4473 .sp
4474 Default:
4475 \fI\fIelasticsearch:force substring search\fR\fR\fI = \fR\fIno\fR\fI \fR
4476 .sp
4477 Example:
4478 \fI\fIelasticsearch:force substring search\fR\fR\fI = \fR\fIyes\fR\fI \fR
4479 .RE
4480
4481 elasticsearch:ignore unknown attribute (G)
4482 .PP
4483 .RS 4
4484 Ignore unknown Spotlight attributes in search queries\&. An example query using the unsupported attribute
4485 "kMDItemTopic"
4486 would be
4487 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\&.
4488 .sp
4489 Default:
4490 \fI\fIelasticsearch:ignore unknown attribute\fR\fR\fI = \fR\fIno\fR\fI \fR
4491 .sp
4492 Example:
4493 \fI\fIelasticsearch:ignore unknown attribute\fR\fR\fI = \fR\fIyes\fR\fI \fR
4494 .RE
4495
4496 elasticsearch:ignore unknown type (G)
4497 .PP
4498 .RS 4
4499 Ignore unknown Spotlight types in search queries\&. An example query using the unsupported type
4500 "public\&.calendar\-event"
4501 would be
4502 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\&.
4503 .sp
4504 Default:
4505 \fI\fIelasticsearch:ignore unknown type\fR\fR\fI = \fR\fIno\fR\fI \fR
4506 .sp
4507 Example:
4508 \fI\fIelasticsearch:ignore unknown type\fR\fR\fI = \fR\fIyes\fR\fI \fR
4509 .RE
4510
4511 elasticsearch:index (S)
4512 .PP
4513 .RS 4
4514 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\&.
4515 .sp
4516 Default:
4517 \fI\fIelasticsearch:index\fR\fR\fI = \fR\fI_all\fR\fI \fR
4518 .sp
4519 Example:
4520 \fI\fIelasticsearch:index\fR\fR\fI = \fR\fIspotlight\fR\fI \fR
4521 .RE
4522
4523 elasticsearch:mappings (G)
4524 .PP
4525 .RS 4
4526 Path to a file specifying metadata attribute mappings in JSON format\&. Use by the Elasticsearch backend of the Spotlight RPC service\&.
4527 .sp
4528 Default:
4529 \fI\fIelasticsearch:mappings\fR\fR\fI = \fR\fI/usr/share/samba/elasticsearch_mappings\&.json\fR\fI \fR
4530 .sp
4531 Example:
4532 \fI\fIelasticsearch:mappings\fR\fR\fI = \fR\fI/usr/share/foo/mymappings\&.json\fR\fI \fR
4533 .RE
4534
4535 elasticsearch:max results (S)
4536 .PP
4537 .RS 4
4538 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\&.
4539 .sp
4540 Default:
4541 \fI\fIelasticsearch:max results\fR\fR\fI = \fR\fI100\fR\fI \fR
4542 .sp
4543 Example:
4544 \fI\fIelasticsearch:max results\fR\fR\fI = \fR\fI10\fR\fI \fR
4545 .RE
4546
4547 elasticsearch:port (S)
4548 .PP
4549 .RS 4
4550 Specifies the TCP port of the Elasticsearch server to use for Spotlight queries when using the Elasticsearch backend\&.
4551 .sp
4552 Default:
4553 \fI\fIelasticsearch:port\fR\fR\fI = \fR\fI9200\fR\fI \fR
4554 .sp
4555 Example:
4556 \fI\fIelasticsearch:port\fR\fR\fI = \fR\fI9201\fR\fI \fR
4557 .RE
4558
4559 elasticsearch:use tls (S)
4560 .PP
4561 .RS 4
4562 Specifies whether to use HTTPS when talking to the Elasticsearch server used for Spotlight queries when using the Elasticsearch backend\&.
4563 .sp
4564 Default:
4565 \fI\fIelasticsearch:use tls\fR\fR\fI = \fR\fIno\fR\fI \fR
4566 .sp
4567 Example:
4568 \fI\fIelasticsearch:use tls\fR\fR\fI = \fR\fIyes\fR\fI \fR
4569 .RE
4570
4571 enable asu support (G)
4572 .PP
4573 .RS 4
4574 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\&.
4575 .sp
4576 Default:
4577 \fI\fIenable asu support\fR\fR\fI = \fR\fIno\fR\fI \fR
4578 .RE
4579
4580 enable core files (G)
4581 .PP
4582 .RS 4
4583 This parameter specifies whether core dumps should be written on internal exits\&. Normally set to
4584 \fByes\fR\&. You should never need to change this\&.
4585 .sp
4586 Default:
4587 \fI\fIenable core files\fR\fR\fI = \fR\fIyes\fR\fI \fR
4588 .sp
4589 Example:
4590 \fI\fIenable core files\fR\fR\fI = \fR\fIno\fR\fI \fR
4591 .RE
4592
4593 enable privileges (G)
4594 .PP
4595 .RS 4
4596 This deprecated parameter controls whether or not smbd will honor privileges assigned to specific SIDs via either
4597 net rpc rights
4598 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\&.
4599 .sp
4600 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\&.
4601 .sp
4602 Please read the extended description provided in the Samba HOWTO documentation\&.
4603 .sp
4604 Default:
4605 \fI\fIenable privileges\fR\fR\fI = \fR\fIyes\fR\fI \fR
4606 .RE
4607
4608 enable spoolss (G)
4609 .PP
4610 .RS 4
4611 Inverted synonym for
4612 \m[blue]\fBdisable spoolss\fR\m[]\&.
4613 .sp
4614 Default:
4615 \fI\fIenable spoolss\fR\fR\fI = \fR\fIyes\fR\fI \fR
4616 .RE
4617
4618 encrypt passwords (G)
4619 .PP
4620 .RS 4
4621 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\&.
4622 .sp
4623 That is, in the future, the current default of
4624 encrypt passwords = yes
4625 will be the enforced behaviour\&.
4626 .sp
4627 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\&.
4628 .sp
4629 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\&.
4630 .sp
4631 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\&.
4632 .sp
4633 In order for encrypted passwords to work correctly
4634 \fBsmbd\fR(8)
4635 must either have access to a local
4636 \fBsmbpasswd\fR(5)
4637 file (see the
4638 \fBsmbpasswd\fR(8)
4639 program for information on how to set up and maintain this file), or set the
4640 \m[blue]\fBsecurity = [domain|ads]\fR\m[]
4641 parameter which causes
4642 smbd
4643 to authenticate against another server\&.
4644 .sp
4645 Default:
4646 \fI\fIencrypt passwords\fR\fR\fI = \fR\fIyes\fR\fI \fR
4647 .RE
4648
4649 enhanced browsing (G)
4650 .PP
4651 .RS 4
4652 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\&.
4653 .sp
4654 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\&.
4655 .sp
4656 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\&.
4657 .sp
4658 In general you should leave this option enabled as it makes cross\-subnet browse propagation much more reliable\&.
4659 .sp
4660 Default:
4661 \fI\fIenhanced browsing\fR\fR\fI = \fR\fIyes\fR\fI \fR
4662 .RE
4663
4664 enumports command (G)
4665 .PP
4666 .RS 4
4667 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
4668 does not use a port name for anything) other than the default
4669 \fB"Samba Printer Port"\fR, you can define
4670 \fIenumports command\fR
4671 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\&.
4672 .sp
4673 Default:
4674 \fI\fIenumports command\fR\fR\fI = \fR\fI\fR\fI \fR
4675 .sp
4676 Example:
4677 \fI\fIenumports command\fR\fR\fI = \fR\fI/usr/bin/listports\fR\fI \fR
4678 .RE
4679
4680 eventlog list (G)
4681 .PP
4682 .RS 4
4683 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
4684 $(statedir)/eventlog\&.
4685 .sp
4686 The administrator must use an external process to parse the normal Unix logs such as
4687 /var/log/messages
4688 and write then entries to the eventlog tdb files\&. Refer to the eventlogadm(8) utility for how to write eventlog entries\&.
4689 .sp
4690 Default:
4691 \fI\fIeventlog list\fR\fR\fI = \fR\fI\fR\fI \fR
4692 .sp
4693 Example:
4694 \fI\fIeventlog list\fR\fR\fI = \fR\fISecurity Application Syslog Apache\fR\fI \fR
4695 .RE
4696
4697 fake directory create times (S)
4698 .PP
4699 .RS 4
4700 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\&.
4701 .sp
4702 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\&.
4703 .sp
4704 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\&.
4705 .sp
4706 Default:
4707 \fI\fIfake directory create times\fR\fR\fI = \fR\fIno\fR\fI \fR
4708 .RE
4709
4710 fake oplocks (S)
4711 .PP
4712 .RS 4
4713 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\&.
4714 .sp
4715 When you set
4716 fake oplocks = yes,
4717 \fBsmbd\fR(8)
4718 will always grant oplock requests no matter how many clients are using the file\&.
4719 .sp
4720 It is generally much better to use the real
4721 \m[blue]\fBoplocks\fR\m[]
4722 support rather than this parameter\&.
4723 .sp
4724 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!
4725 .sp
4726 Default:
4727 \fI\fIfake oplocks\fR\fR\fI = \fR\fIno\fR\fI \fR
4728 .RE
4729
4730 follow symlinks (S)
4731 .PP
4732 .RS 4
4733 This parameter allows the Samba administrator to stop
4734 \fBsmbd\fR(8)
4735 from following symbolic links in a particular share\&. Setting this parameter to
4736 \fBno\fR
4737 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
4738 /etc/passwd
4739 in their home directory for instance\&. However it will slow filename lookups down slightly\&.
4740 .sp
4741 This option is enabled (i\&.e\&.
4742 smbd
4743 will follow symbolic links) by default\&.
4744 .sp
4745 Default:
4746 \fI\fIfollow symlinks\fR\fR\fI = \fR\fIyes\fR\fI \fR
4747 .RE
4748
4749 smbd force process locks (S)
4750 .PP
4751 .RS 4
4752 This boolean option tells
4753 smbd
4754 whether to forcefully disable the use of Open File Description locks on Linux\&.
4755 .sp
4756 This option should not be changed from the default unless you know what you\*(Aqre doing\&.
4757 .sp
4758 Default:
4759 \fI\fIsmbd force process locks\fR\fR\fI = \fR\fIno\fR\fI \fR
4760 .RE
4761
4762 force create mode (S)
4763 .PP
4764 .RS 4
4765 This parameter specifies a set of UNIX mode bit permissions that will
4766 \fIalways\fR
4767 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
4768 \fIcreate mask\fR
4769 parameter is applied\&.
4770 .sp
4771 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\&.
4772 .sp
4773 Default:
4774 \fI\fIforce create mode\fR\fR\fI = \fR\fI0000\fR\fI \fR
4775 .sp
4776 Example:
4777 \fI\fIforce create mode\fR\fR\fI = \fR\fI0755\fR\fI \fR
4778 .RE
4779
4780 force directory mode (S)
4781 .PP
4782 .RS 4
4783 This parameter specifies a set of UNIX mode bit permissions that will
4784 \fIalways\fR
4785 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
4786 \fIdirectory mask\fR
4787 is applied\&.
4788 .sp
4789 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\&.
4790 .sp
4791 Default:
4792 \fI\fIforce directory mode\fR\fR\fI = \fR\fI0000\fR\fI \fR
4793 .sp
4794 Example:
4795 \fI\fIforce directory mode\fR\fR\fI = \fR\fI0755\fR\fI \fR
4796 .RE
4797
4798 force directory security mode (S)
4799 .PP
4800 .RS 4
4801 This parameter has been removed for Samba 4\&.0\&.0\&.
4802 .sp
4803 \fINo default\fR
4804 .RE
4805
4806 group
4807 .PP
4808 .RS 4
4809 This parameter is a synonym for
4810 force group\&.
4811 .RE
4812
4813 force group (S)
4814 .PP
4815 .RS 4
4816 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\&.
4817 .sp
4818 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
4819 force group = +sys
4820 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\&.
4821 .sp
4822 If the
4823 \m[blue]\fBforce user\fR\m[]
4824 parameter is also set the group specified in
4825 \fIforce group\fR
4826 will override the primary group set in
4827 \fIforce user\fR\&.
4828 .sp
4829 Default:
4830 \fI\fIforce group\fR\fR\fI = \fR\fI\fR\fI \fR
4831 .sp
4832 Example:
4833 \fI\fIforce group\fR\fR\fI = \fR\fIagroup\fR\fI \fR
4834 .RE
4835
4836 force printername (S)
4837 .PP
4838 .RS 4
4839 When printing from Windows NT (or later), each printer in
4840 smb\&.conf
4841 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
4842 \fIprinter name\fR
4843 option)\&.
4844 .sp
4845 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
4846 \fIforce printername = yes\fR\&.
4847 .sp
4848 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\&.
4849 .sp
4850 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\&.
4851 .sp
4852 Default:
4853 \fI\fIforce printername\fR\fR\fI = \fR\fIno\fR\fI \fR
4854 .RE
4855
4856 force security mode (S)
4857 .PP
4858 .RS 4
4859 This parameter has been removed for Samba 4\&.0\&.0\&.
4860 .sp
4861 \fINo default\fR
4862 .RE
4863
4864 force unknown acl user (S)
4865 .PP
4866 .RS 4
4867 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\&.
4868 .sp
4869 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\&.
4870 .sp
4871 Try using this parameter when XCOPY /O gives an ACCESS_DENIED error\&.
4872 .sp
4873 Default:
4874 \fI\fIforce unknown acl user\fR\fR\fI = \fR\fIno\fR\fI \fR
4875 .RE
4876
4877 force user (S)
4878 .PP
4879 .RS 4
4880 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\&.
4881 .sp
4882 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\&.
4883 .sp
4884 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)\&.
4885 .sp
4886 Default:
4887 \fI\fIforce user\fR\fR\fI = \fR\fI\fR\fI \fR
4888 .sp
4889 Example:
4890 \fI\fIforce user\fR\fR\fI = \fR\fIauser\fR\fI \fR
4891 .RE
4892
4893 fss: prune stale (G)
4894 .PP
4895 .RS 4
4896 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\&.
4897 .sp
4898 Default:
4899 \fI\fIfss: prune stale\fR\fR\fI = \fR\fIno\fR\fI \fR
4900 .sp
4901 Example:
4902 \fI\fIfss: prune stale\fR\fR\fI = \fR\fIyes\fR\fI \fR
4903 .RE
4904
4905 fss: sequence timeout (G)
4906 .PP
4907 .RS 4
4908 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\&.
4909 .sp
4910 Default:
4911 \fI\fIfss: sequence timeout\fR\fR\fI = \fR\fI180 or 1800, depending on operation\fR\fI \fR
4912 .sp
4913 Example:
4914 \fI\fIfss: sequence timeout\fR\fR\fI = \fR\fI0\fR\fI \fR
4915 .RE
4916
4917 fstype (S)
4918 .PP
4919 .RS 4
4920 This parameter allows the administrator to configure the string that specifies the type of filesystem a share is using that is reported by
4921 \fBsmbd\fR(8)
4922 when a client queries the filesystem type for a share\&. The default type is
4923 \fBNTFS\fR
4924 for compatibility with Windows NT but this can be changed to other strings such as
4925 \fBSamba\fR
4926 or
4927 \fBFAT\fR
4928 if required\&.
4929 .sp
4930 Default:
4931 \fI\fIfstype\fR\fR\fI = \fR\fINTFS\fR\fI \fR
4932 .sp
4933 Example:
4934 \fI\fIfstype\fR\fR\fI = \fR\fISamba\fR\fI \fR
4935 .RE
4936
4937 get quota command (G)
4938 .PP
4939 .RS 4
4940 The
4941 get quota command
4942 should only be used whenever there is no operating system API available from the OS that samba can use\&.
4943 .sp
4944 This option is only available Samba was compiled with quotas support\&.
4945 .sp
4946 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\&.
4947 .sp
4948 Such a script is being given 3 arguments:
4949 .RS
4950 .sp
4951 .RS 4
4952 .ie n \{\
4953 \h'-04'\(bu\h'+03'\c
4954 .\}
4955 .el \{\
4956 .sp -1
4957 .IP \(bu 2.3
4958 .\}
4959 directory
4960 .RE
4961 .sp
4962 .RS 4
4963 .ie n \{\
4964 \h'-04'\(bu\h'+03'\c
4965 .\}
4966 .el \{\
4967 .sp -1
4968 .IP \(bu 2.3
4969 .\}
4970 type of query
4971 .RE
4972 .sp
4973 .RS 4
4974 .ie n \{\
4975 \h'-04'\(bu\h'+03'\c
4976 .\}
4977 .el \{\
4978 .sp -1
4979 .IP \(bu 2.3
4980 .\}
4981 uid of user or gid of group
4982 .RE
4983 .sp
4984 .RE
4985 The directory is actually mostly just "\&." \- It needs to be treated relatively to the current working directory that the script can also query\&.
4986 .sp
4987 The type of query can be one of:
4988 .RS
4989 .sp
4990 .RS 4
4991 .ie n \{\
4992 \h'-04'\(bu\h'+03'\c
4993 .\}
4994 .el \{\
4995 .sp -1
4996 .IP \(bu 2.3
4997 .\}
4998 1 \- user quotas
4999 .RE
5000 .sp
5001 .RS 4
5002 .ie n \{\
5003 \h'-04'\(bu\h'+03'\c
5004 .\}
5005 .el \{\
5006 .sp -1
5007 .IP \(bu 2.3
5008 .\}
5009 2 \- user default quotas (uid = \-1)
5010 .RE
5011 .sp
5012 .RS 4
5013 .ie n \{\
5014 \h'-04'\(bu\h'+03'\c
5015 .\}
5016 .el \{\
5017 .sp -1
5018 .IP \(bu 2.3
5019 .\}
5020 3 \- group quotas
5021 .RE
5022 .sp
5023 .RS 4
5024 .ie n \{\
5025 \h'-04'\(bu\h'+03'\c
5026 .\}
5027 .el \{\
5028 .sp -1
5029 .IP \(bu 2.3
5030 .\}
5031 4 \- group default quotas (gid = \-1)
5032 .RE
5033 .sp
5034 .RE
5035 This script should print one line as output with spaces between the columns\&. The printed columns should be:
5036 .RS
5037 .sp
5038 .RS 4
5039 .ie n \{\
5040 \h'-04'\(bu\h'+03'\c
5041 .\}
5042 .el \{\
5043 .sp -1
5044 .IP \(bu 2.3
5045 .\}
5046 1 \- quota flags (0 = no quotas, 1 = quotas enabled, 2 = quotas enabled and enforced)
5047 .RE
5048 .sp
5049 .RS 4
5050 .ie n \{\
5051 \h'-04'\(bu\h'+03'\c
5052 .\}
5053 .el \{\
5054 .sp -1
5055 .IP \(bu 2.3
5056 .\}
5057 2 \- number of currently used blocks
5058 .RE
5059 .sp
5060 .RS 4
5061 .ie n \{\
5062 \h'-04'\(bu\h'+03'\c
5063 .\}
5064 .el \{\
5065 .sp -1
5066 .IP \(bu 2.3
5067 .\}
5068 3 \- the softlimit number of blocks
5069 .RE
5070 .sp
5071 .RS 4
5072 .ie n \{\
5073 \h'-04'\(bu\h'+03'\c
5074 .\}
5075 .el \{\
5076 .sp -1
5077 .IP \(bu 2.3
5078 .\}
5079 4 \- the hardlimit number of blocks
5080 .RE
5081 .sp
5082 .RS 4
5083 .ie n \{\
5084 \h'-04'\(bu\h'+03'\c
5085 .\}
5086 .el \{\
5087 .sp -1
5088 .IP \(bu 2.3
5089 .\}
5090 5 \- currently used number of inodes
5091 .RE
5092 .sp
5093 .RS 4
5094 .ie n \{\
5095 \h'-04'\(bu\h'+03'\c
5096 .\}
5097 .el \{\
5098 .sp -1
5099 .IP \(bu 2.3
5100 .\}
5101 6 \- the softlimit number of inodes
5102 .RE
5103 .sp
5104 .RS 4
5105 .ie n \{\
5106 \h'-04'\(bu\h'+03'\c
5107 .\}
5108 .el \{\
5109 .sp -1
5110 .IP \(bu 2.3
5111 .\}
5112 7 \- the hardlimit number of inodes
5113 .RE
5114 .sp
5115 .RS 4
5116 .ie n \{\
5117 \h'-04'\(bu\h'+03'\c
5118 .\}
5119 .el \{\
5120 .sp -1
5121 .IP \(bu 2.3
5122 .\}
5123 8 (optional) \- the number of bytes in a block(default is 1024)
5124 .RE
5125 .sp
5126 .RE
5127 Default:
5128 \fI\fIget quota command\fR\fR\fI = \fR\fI\fR\fI \fR
5129 .sp
5130 Example:
5131 \fI\fIget quota command\fR\fR\fI = \fR\fI/usr/local/sbin/query_quota\fR\fI \fR
5132 .RE
5133
5134 getwd cache (G)
5135 .PP
5136 .RS 4
5137 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
5138 \m[blue]\fBwide links\fR\m[]
5139 parameter is set to
5140 \fBno\fR\&.
5141 .sp
5142 Default:
5143 \fI\fIgetwd cache\fR\fR\fI = \fR\fIyes\fR\fI \fR
5144 .RE
5145
5146 gpo update command (G)
5147 .PP
5148 .RS 4
5149 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\&.
5150 .sp
5151 Default:
5152 \fI\fIgpo update command\fR\fR\fI = \fR\fI/build/reproducible\-path/samba\-4\&.24\&.3+dfsg/source4/scripting/bin/samba\-gpupdate\fR\fI \fR
5153 .sp
5154 Example:
5155 \fI\fIgpo update command\fR\fR\fI = \fR\fI/usr/local/sbin/gpoupdate\fR\fI \fR
5156 .RE
5157
5158 guest account (G)
5159 .PP
5160 .RS 4
5161 This is a username which will be used for access to services which are specified as
5162 \m[blue]\fBguest ok\fR\m[]
5163 (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\&.
5164 .sp
5165 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
5166 su \-
5167 command) and trying to print using the system print command such as
5168 lpr(1)
5169 or
5170 lp(1)\&.
5171 .sp
5172 This parameter does not accept % macros, because many parts of the system require this value to be constant for correct operation\&.
5173 .sp
5174 Default:
5175 \fI\fIguest account\fR\fR\fI = \fR\fInobody # default can be changed at compile\-time\fR\fI \fR
5176 .sp
5177 Example:
5178 \fI\fIguest account\fR\fR\fI = \fR\fIftp\fR\fI \fR
5179 .RE
5180
5181 public
5182 .PP
5183 .RS 4
5184 This parameter is a synonym for
5185 guest ok\&.
5186 .RE
5187
5188 guest ok (S)
5189 .PP
5190 .RS 4
5191 If this parameter is
5192 \fByes\fR
5193 for a service, then no password is required to connect to the service\&. Privileges will be those of the
5194 \m[blue]\fBguest account\fR\m[]\&.
5195 .sp
5196 This parameter nullifies the benefits of setting
5197 \m[blue]\fBrestrict anonymous = 2\fR\m[]
5198 .sp
5199 See the section below on
5200 \m[blue]\fBsecurity\fR\m[]
5201 for more information about this option\&.
5202 .sp
5203 Default:
5204 \fI\fIguest ok\fR\fR\fI = \fR\fIno\fR\fI \fR
5205 .RE
5206
5207 only guest
5208 .PP
5209 .RS 4
5210 This parameter is a synonym for
5211 guest only\&.
5212 .RE
5213
5214 guest only (S)
5215 .PP
5216 .RS 4
5217 If this parameter is
5218 \fByes\fR
5219 for a service, then only guest connections to the service are permitted\&. This parameter will have no effect if
5220 \m[blue]\fBguest ok\fR\m[]
5221 is not set for the service\&.
5222 .sp
5223 See the section below on
5224 \m[blue]\fBsecurity\fR\m[]
5225 for more information about this option\&.
5226 .sp
5227 Default:
5228 \fI\fIguest only\fR\fR\fI = \fR\fIno\fR\fI \fR
5229 .RE
5230
5231 hide dot files (S)
5232 .PP
5233 .RS 4
5234 This is a boolean parameter that controls whether files starting with a dot appear as hidden files\&.
5235 .sp
5236 Default:
5237 \fI\fIhide dot files\fR\fR\fI = \fR\fIyes\fR\fI \fR
5238 .RE
5239
5240 hide files (S)
5241 .PP
5242 .RS 4
5243 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\&.
5244 .sp
5245 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\&.
5246 .sp
5247 \m[blue]\fBhide files\fR\m[]
5248 can also be used as a parametric option where NAME in
5249 .sp
5250 hide files : NAME =
5251 .sp
5252 specifies a user or group name with the same syntax as
5253 \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\&.
5254 .sp
5255 Each entry must be a Unix path, not a DOS path and must not include the Unix directory separator \*(Aq/\*(Aq\&.
5256 .sp
5257 Note that the case sensitivity option is applicable in hiding files\&.
5258 .sp
5259 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\&.
5260 .sp
5261 The example shown above is based on files that the Macintosh SMB client (DAVE) available from
5262 Thursby
5263 creates for internal use, and also still hides all files beginning with a dot\&.
5264 .sp
5265 An example of us of this parameter is:
5266 .sp
5267 .if n \{\
5268 .RS 4
5269 .\}
5270 .nf
5271 hide files = /\&.*/DesktopFolderDB/TrashFor%m/resource\&.frk/
5272
5273 ; Hide some files for anyone and some files for specific users and groups
5274 hide files = /hideforall1/
5275 hide files : USER = /hidetoforuser/
5276 hide files : GROUP = /hideforgroup/
5277 hide files : UNIVERSITY\eAlumnis = /somefile\&.txt/
5278 hide files : john@university\&.org = /anotherfile\&.txt/
5279 hide files : S\-1\-5\-21\-123\-456\-789\-1000 = /secretfile\&.txt/
5280
5281 .fi
5282 .if n \{\
5283 .RE
5284 .\}
5285 .sp
5286 Default:
5287 \fI\fIhide files\fR\fR\fI = \fR\fI # no file are hidden\fR\fI \fR
5288 .RE
5289
5290 hide new files timeout (S)
5291 .PP
5292 .RS 4
5293 Setting this parameter to something but 0 hides files that have been modified less than N seconds ago\&.
5294 .sp
5295 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\&.
5296 .sp
5297 Default:
5298 \fI\fIhide new files timeout\fR\fR\fI = \fR\fI0\fR\fI \fR
5299 .RE
5300
5301 hide special files (S)
5302 .PP
5303 .RS 4
5304 This parameter prevents clients from seeing special files such as sockets, devices and fifo\*(Aqs in directory listings\&.
5305 .sp
5306 Default:
5307 \fI\fIhide special files\fR\fR\fI = \fR\fIno\fR\fI \fR
5308 .RE
5309
5310 hide unreadable (S)
5311 .PP
5312 .RS 4
5313 This parameter prevents clients from seeing the existence of files that cannot be read\&. Defaults to off\&.
5314 .sp
5315 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\&.
5316 .sp
5317 Default:
5318 \fI\fIhide unreadable\fR\fR\fI = \fR\fIno\fR\fI \fR
5319 .RE
5320
5321 hide unwriteable files (S)
5322 .PP
5323 .RS 4
5324 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\&.
5325 .sp
5326 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\&.
5327 .sp
5328 Default:
5329 \fI\fIhide unwriteable files\fR\fR\fI = \fR\fIno\fR\fI \fR
5330 .RE
5331
5332 honor change notify privilege (S)
5333 .PP
5334 .RS 4
5335 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\&.
5336 .sp
5337 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\&.
5338 .sp
5339 Default:
5340 \fI\fIhonor change notify privilege\fR\fR\fI = \fR\fIno\fR\fI \fR
5341 .RE
5342
5343 host msdfs (G)
5344 .PP
5345 .RS 4
5346 If set to
5347 \fByes\fR, Samba will act as a Dfs server, and allow Dfs\-aware clients to browse Dfs trees hosted on the server\&.
5348 .sp
5349 See also the
5350 \m[blue]\fBmsdfs root\fR\m[]
5351 share level parameter\&. For more information on setting up a Dfs tree on Samba, refer to the MSFDS chapter in the book Samba3\-HOWTO\&.
5352 .sp
5353 Default:
5354 \fI\fIhost msdfs\fR\fR\fI = \fR\fIyes\fR\fI \fR
5355 .RE
5356
5357 hostname lookups (G)
5358 .PP
5359 .RS 4
5360 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
5361 hosts deny
5362 and
5363 hosts allow\&.
5364 .sp
5365 Default:
5366 \fI\fIhostname lookups\fR\fR\fI = \fR\fIno\fR\fI \fR
5367 .sp
5368 Example:
5369 \fI\fIhostname lookups\fR\fR\fI = \fR\fIyes\fR\fI \fR
5370 .RE
5371
5372 allow hosts
5373 .PP
5374 .RS 4
5375 This parameter is a synonym for
5376 hosts allow\&.
5377 .RE
5378
5379 hosts allow (S)
5380 .PP
5381 .RS 4
5382 A synonym for this parameter is
5383 \m[blue]\fBallow hosts\fR\m[]\&.
5384 .sp
5385 This parameter is a comma, space, or tab delimited set of hosts which are permitted to access a service\&.
5386 .sp
5387 If specified in the [global] section then it will apply to all services, regardless of whether the individual service has a different setting\&.
5388 .sp
5389 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
5390 allow hosts = 150\&.203\&.5\&.\&. The full syntax of the list is described in the man page
5391 hosts_access(5)\&. Note that this man page may not be present on your system, so a brief description will be given here also\&.
5392 .sp
5393 Note that the localhost address 127\&.0\&.0\&.1 will always be allowed access unless specifically denied by a
5394 \m[blue]\fBhosts deny\fR\m[]
5395 option\&.
5396 .sp
5397 You can also specify hosts by network/netmask pairs and by netgroup names if your system supports netgroups\&. The
5398 \fIEXCEPT\fR
5399 keyword can also be used to limit a wildcard list\&. The following examples may provide some help:
5400 .sp
5401 Example 1: allow all IPs in 150\&.203\&.*\&.*; except one
5402 .sp
5403 hosts allow = 150\&.203\&. EXCEPT 150\&.203\&.6\&.66
5404 .sp
5405 Example 2: allow hosts that match the given network/netmask
5406 .sp
5407 hosts allow = 150\&.203\&.15\&.0/255\&.255\&.255\&.0
5408 .sp
5409 Example 3: allow a couple of hosts
5410 .sp
5411 hosts allow = lapland, arvidsjaur
5412 .sp
5413 Example 4: allow only hosts in NIS netgroup "foonet", but deny access from one particular host
5414 .sp
5415 hosts allow = @foonet
5416 .sp
5417 hosts deny = pirate
5418 .if n \{\
5419 .sp
5420 .\}
5421 .RS 4
5422 .it 1 an-trap
5423 .nr an-no-space-flag 1
5424 .nr an-break-flag 1
5425 .br
5426 .ps +1
5427 \fBNote\fR
5428 .ps -1
5429 .br
5430 Note that access still requires suitable user\-level passwords\&.
5431 .sp .5v
5432 .RE
5433 See
5434 \fBtestparm\fR(1)
5435 for a way of testing your host access to see if it does what you expect\&.
5436 .sp
5437 Default:
5438 \fI\fIhosts allow\fR\fR\fI = \fR\fI # none (i\&.e\&., all hosts permitted access)\fR\fI \fR
5439 .sp
5440 Example:
5441 \fI\fIhosts allow\fR\fR\fI = \fR\fI150\&.203\&.5\&. myhost\&.mynet\&.edu\&.au\fR\fI \fR
5442 .RE
5443
5444 deny hosts
5445 .PP
5446 .RS 4
5447 This parameter is a synonym for
5448 hosts deny\&.
5449 .RE
5450
5451 hosts deny (S)
5452 .PP
5453 .RS 4
5454 The opposite of
5455 \fIhosts allow\fR
5456 \- hosts listed here are
5457 \fINOT\fR
5458 permitted access to services unless the specific services have their own lists to override this one\&. Where the lists conflict, the
5459 \fIallow\fR
5460 list takes precedence\&.
5461 .sp
5462 In the event that it is necessary to deny all by default, use the keyword ALL (or the netmask
5463 0\&.0\&.0\&.0/0) and then explicitly specify to the
5464 \m[blue]\fBhosts allow = hosts allow\fR\m[]
5465 parameter those hosts that should be permitted access\&.
5466 .sp
5467 Default:
5468 \fI\fIhosts deny\fR\fR\fI = \fR\fI # none (i\&.e\&., no hosts specifically excluded)\fR\fI \fR
5469 .sp
5470 Example:
5471 \fI\fIhosts deny\fR\fR\fI = \fR\fI150\&.203\&.4\&. badhost\&.mynet\&.edu\&.au\fR\fI \fR
5472 .RE
5473
5474 idmap backend (G)
5475 .PP
5476 .RS 4
5477 The idmap backend provides a plugin interface for Winbind to use varying backends to store SID/uid/gid mapping tables\&.
5478 .sp
5479 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
5480 \m[blue]\fBidmap config * : backend\fR\m[]\&.
5481 .sp
5482 Default:
5483 \fI\fIidmap backend\fR\fR\fI = \fR\fItdb\fR\fI \fR
5484 .RE
5485
5486 idmap cache time (G)
5487 .PP
5488 .RS 4
5489 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\&.
5490 .sp
5491 Default:
5492 \fI\fIidmap cache time\fR\fR\fI = \fR\fI604800\fR\fI \fR
5493 .RE
5494
5495 idmap config DOMAIN : OPTION (G)
5496 .PP
5497 .RS 4
5498 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
5499 \m[blue]\fBidmap config\fR\m[]
5500 prefix\&. An idmap option consists of the
5501 \m[blue]\fBidmap config\fR\m[]
5502 prefix, followed by a domain name or the asterisk character (*), a colon, and the name of an idmap setting for the chosen domain\&.
5503 .sp
5504 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\&.
5505 .sp
5506 There are three general options available:
5507 .PP
5508 backend = backend_name
5509 .RS 4
5510 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\&.
5511 .sp
5512 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\&.
5513 .RE
5514 .PP
5515 range = low \- high
5516 .RS 4
5517 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\&.
5518 .sp
5519 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\&.
5520 .sp
5521 Note that the low value interacts with the
5522 \m[blue]\fBmin domain uid\fR\m[]
5523 option!
5524 .RE
5525 .PP
5526 read only = yes|no
5527 .RS 4
5528 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\&.
5529 .RE
5530 .sp
5531 The following example illustrates how to configure the
5532 \fBidmap_ad\fR(8)
5533 backend for the CORP domain and the
5534 \fBidmap_tdb\fR(8)
5535 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\&.
5536 .sp
5537 .if n \{\
5538 .RS 4
5539 .\}
5540 .nf
5541 idmap config * : backend = tdb
5542 idmap config * : range = 1000000\-1999999
5543
5544 idmap config CORP : backend = ad
5545 idmap config CORP : range = 1000\-999999
5546
5547 .fi
5548 .if n \{\
5549 .RE
5550 .\}
5551 .sp
5552 \fINo default\fR
5553 .RE
5554
5555 winbind gid
5556 .PP
5557 .RS 4
5558 This parameter is a synonym for
5559 idmap gid\&.
5560 .RE
5561
5562 idmap gid (G)
5563 .PP
5564 .RS 4
5565 The idmap gid parameter specifies the range of group ids for the default idmap configuration\&. It is now deprecated in favour of
5566 \m[blue]\fBidmap config * : range\fR\m[]\&.
5567 .sp
5568 See the
5569 \m[blue]\fBidmap config\fR\m[]
5570 option\&.
5571 .sp
5572 Default:
5573 \fI\fIidmap gid\fR\fR\fI = \fR\fI\fR\fI \fR
5574 .sp
5575 Example:
5576 \fI\fIidmap gid\fR\fR\fI = \fR\fI10000\-20000\fR\fI \fR
5577 .RE
5578
5579 idmap negative cache time (G)
5580 .PP
5581 .RS 4
5582 This parameter specifies the number of seconds that Winbind\*(Aqs idmap interface will cache negative SID/uid/gid query results\&.
5583 .sp
5584 Default:
5585 \fI\fIidmap negative cache time\fR\fR\fI = \fR\fI120\fR\fI \fR
5586 .RE
5587
5588 winbind uid
5589 .PP
5590 .RS 4
5591 This parameter is a synonym for
5592 idmap uid\&.
5593 .RE
5594
5595 idmap uid (G)
5596 .PP
5597 .RS 4
5598 The idmap uid parameter specifies the range of user ids for the default idmap configuration\&. It is now deprecated in favour of
5599 \m[blue]\fBidmap config * : range\fR\m[]\&.
5600 .sp
5601 See the
5602 \m[blue]\fBidmap config\fR\m[]
5603 option\&.
5604 .sp
5605 Default:
5606 \fI\fIidmap uid\fR\fR\fI = \fR\fI\fR\fI \fR
5607 .sp
5608 Example:
5609 \fI\fIidmap uid\fR\fR\fI = \fR\fI10000\-20000\fR\fI \fR
5610 .RE
5611
5612 include (S)
5613 .PP
5614 .RS 4
5615 This allows you to include one config file inside another\&. The file is included literally, as though typed in place\&.
5616 .sp
5617 It takes the standard substitutions, except
5618 \fI%u\fR,
5619 \fI%P\fR
5620 and
5621 \fI%S\fR\&.
5622 .sp
5623 The parameter
5624 \fIinclude = registry\fR
5625 has a special meaning: It does
5626 \fInot\fR
5627 include a file named
5628 \fIregistry\fR
5629 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\&.
5630 .sp
5631 Default:
5632 \fI\fIinclude\fR\fR\fI = \fR\fI\fR\fI \fR
5633 .sp
5634 Example:
5635 \fI\fIinclude\fR\fR\fI = \fR\fI/usr/local/samba/lib/admin_smb\&.conf\fR\fI \fR
5636 .RE
5637
5638 include system krb5 conf (G)
5639 .PP
5640 .RS 4
5641 Setting this parameter to
5642 no
5643 will prevent winbind to include the system /etc/krb5\&.conf file into the krb5\&.conf file it creates\&. See also
5644 \m[blue]\fBcreate krb5 conf\fR\m[]\&. This option only applies to Samba built with MIT Kerberos\&.
5645 .sp
5646 Default:
5647 \fI\fIinclude system krb5 conf\fR\fR\fI = \fR\fIyes\fR\fI \fR
5648 .RE
5649
5650 inherit acls (S)
5651 .PP
5652 .RS 4
5653 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\&.
5654 .sp
5655 Default:
5656 \fI\fIinherit acls\fR\fR\fI = \fR\fIno\fR\fI \fR
5657 .RE
5658
5659 inherit owner (S)
5660 .PP
5661 .RS 4
5662 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\&.
5663 .sp
5664 Valid options are:
5665 .RS
5666 .sp
5667 .RS 4
5668 .ie n \{\
5669 \h'-04'\(bu\h'+03'\c
5670 .\}
5671 .el \{\
5672 .sp -1
5673 .IP \(bu 2.3
5674 .\}
5675 \fBno\fR
5676 \- 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\&.
5677 .RE
5678 .sp
5679 .RS 4
5680 .ie n \{\
5681 \h'-04'\(bu\h'+03'\c
5682 .\}
5683 .el \{\
5684 .sp -1
5685 .IP \(bu 2.3
5686 .\}
5687 \fBwindows and unix\fR
5688 \- The Windows (SID) owner and the UNIX (uid) owner of new files and directories are set to the respective owner of the parent directory\&.
5689 .RE
5690 .sp
5691 .RS 4
5692 .ie n \{\
5693 \h'-04'\(bu\h'+03'\c
5694 .\}
5695 .el \{\
5696 .sp -1
5697 .IP \(bu 2.3
5698 .\}
5699 \fByes\fR
5700 \- a synonym for
5701 \fBwindows and unix\fR\&.
5702 .RE
5703 .sp
5704 .RS 4
5705 .ie n \{\
5706 \h'-04'\(bu\h'+03'\c
5707 .\}
5708 .el \{\
5709 .sp -1
5710 .IP \(bu 2.3
5711 .\}
5712 \fBunix only\fR
5713 \- Only the UNIX owner is set to the UNIX owner of the parent directory\&.
5714 .RE
5715 .sp
5716 .RE
5717 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\&.
5718 .sp
5719 The
5720 \fBunix only\fR
5721 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
5722 \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\&.
5723 .sp
5724 Default:
5725 \fI\fIinherit owner\fR\fR\fI = \fR\fIno\fR\fI \fR
5726 .RE
5727
5728 inherit permissions (S)
5729 .PP
5730 .RS 4
5731 The permissions on new files and directories are normally governed by
5732 \m[blue]\fBcreate mask\fR\m[],
5733 \m[blue]\fBdirectory mask\fR\m[],
5734 \m[blue]\fBforce create mode\fR\m[]
5735 and
5736 \m[blue]\fBforce directory mode\fR\m[]
5737 but the boolean inherit permissions parameter overrides this\&.
5738 .sp
5739 New directories inherit the mode of the parent directory, including bits such as setgid\&.
5740 .sp
5741 New files inherit their read/write bits from the parent directory\&. Their execute bits continue to be determined by
5742 \m[blue]\fBmap archive\fR\m[],
5743 \m[blue]\fBmap hidden\fR\m[]
5744 and
5745 \m[blue]\fBmap system\fR\m[]
5746 as usual\&.
5747 .sp
5748 Note that the setuid bit is
5749 \fInever\fR
5750 set via inheritance (the code explicitly prohibits this)\&.
5751 .sp
5752 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\&.
5753 .sp
5754 Default:
5755 \fI\fIinherit permissions\fR\fR\fI = \fR\fIno\fR\fI \fR
5756 .RE
5757
5758 init logon delay (G)
5759 .PP
5760 .RS 4
5761 This parameter specifies a delay in milliseconds for the hosts configured for delayed initial samlogon with
5762 \m[blue]\fBinit logon delayed hosts\fR\m[]\&.
5763 .sp
5764 Default:
5765 \fI\fIinit logon delay\fR\fR\fI = \fR\fI100\fR\fI \fR
5766 .RE
5767
5768 init logon delayed hosts (G)
5769 .PP
5770 .RS 4
5771 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)\&.
5772 .sp
5773 The length of the delay can be specified with the
5774 \m[blue]\fBinit logon delay\fR\m[]
5775 parameter\&.
5776 .sp
5777 Default:
5778 \fI\fIinit logon delayed hosts\fR\fR\fI = \fR\fI\fR\fI \fR
5779 .sp
5780 Example:
5781 \fI\fIinit logon delayed hosts\fR\fR\fI = \fR\fI150\&.203\&.5\&. myhost\&.mynet\&.de\fR\fI \fR
5782 .RE
5783
5784 interfaces (G)
5785 .PP
5786 .RS 4
5787 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\&.
5788 .sp
5789 The option takes a list of interface strings\&. Each string can be in any of the following forms:
5790 .RS
5791 .sp
5792 .RS 4
5793 .ie n \{\
5794 \h'-04'\(bu\h'+03'\c
5795 .\}
5796 .el \{\
5797 .sp -1
5798 .IP \(bu 2.3
5799 .\}
5800 a network interface name (such as eth0)\&. This may include shell\-like wildcards so eth* will match any interface starting with the substring "eth"
5801 .RE
5802 .sp
5803 .RS 4
5804 .ie n \{\
5805 \h'-04'\(bu\h'+03'\c
5806 .\}
5807 .el \{\
5808 .sp -1
5809 .IP \(bu 2.3
5810 .\}
5811 an IP address\&. In this case the netmask is determined from the list of interfaces obtained from the kernel
5812 .RE
5813 .sp
5814 .RS 4
5815 .ie n \{\
5816 \h'-04'\(bu\h'+03'\c
5817 .\}
5818 .el \{\
5819 .sp -1
5820 .IP \(bu 2.3
5821 .\}
5822 an IP/mask pair\&.
5823 .RE
5824 .sp
5825 .RS 4
5826 .ie n \{\
5827 \h'-04'\(bu\h'+03'\c
5828 .\}
5829 .el \{\
5830 .sp -1
5831 .IP \(bu 2.3
5832 .\}
5833 a broadcast/mask pair\&.
5834 .RE
5835 .sp
5836 .RE
5837 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\&.
5838 .sp
5839 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\&.
5840 .sp
5841 By default Samba enables all active interfaces that are broadcast capable except the loopback adaptor (IP address 127\&.0\&.0\&.1)\&.
5842 .sp
5843 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):
5844 .sp
5845 "interface[;key1=value1[,key2=value2[\&.\&.\&.]]]"
5846 .sp
5847 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\&.
5848 .sp
5849 The possible values for options are "dynamic" and "nodynamic"\&. Use this option in combination with setting
5850 \m[blue]\fBbind interfaces only\fR\m[]
5851 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)\&.
5852 .sp
5853 Note that dynamically opening/closing listening sockets is only available on some operating systems (currently Linux)\&.
5854 .sp
5855 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\&.
5856 .sp
5857 The other examples show how per interface extra parameters can be specified\&. Notice the possible usage of "," and ";", which makes the double quoting necessary\&.
5858 .sp
5859 Default:
5860 \fI\fIinterfaces\fR\fR\fI = \fR\fI\fR\fI \fR
5861 .sp
5862 Example:
5863 \fI\fIinterfaces\fR\fR\fI = \fR\fIeth0 192\&.168\&.2\&.10/24 192\&.168\&.3\&.10/255\&.255\&.255\&.0\fR\fI \fR
5864 .sp
5865 Example:
5866 \fI\fIinterfaces\fR\fR\fI = \fR\fIeth0, 192\&.168\&.2\&.10/24; 192\&.168\&.3\&.10/255\&.255\&.255\&.0\fR\fI \fR
5867 .sp
5868 Example:
5869 \fI\fIinterfaces\fR\fR\fI = \fR\fI"eth0;if_index=65,speed=1000000000,capability=RSS"\fR\fI \fR
5870 .sp
5871 Example:
5872 \fI\fIinterfaces\fR\fR\fI = \fR\fI"lo;speed=1000000000" "eth0;capability=RSS"\fR\fI \fR
5873 .sp
5874 Example:
5875 \fI\fIinterfaces\fR\fR\fI = \fR\fI"lo;speed=1000000000" , "eth0;capability=RSS"\fR\fI \fR
5876 .sp
5877 Example:
5878 \fI\fIinterfaces\fR\fR\fI = \fR\fI"eth0;capability=RSS" , "rdma1;capability=RDMA" ; "rdma2;capability=RSS,capability=RDMA"\fR\fI \fR
5879 .sp
5880 Example:
5881 \fI\fIinterfaces\fR\fR\fI = \fR\fI"eth0;options=dynamic"\fR\fI \fR
5882 .RE
5883
5884 invalid users (S)
5885 .PP
5886 .RS 4
5887 This is a list of users that should not be allowed to login to this service\&. This is really a
5888 \fIparanoid\fR
5889 check to absolutely ensure an improper setting does not breach your security\&.
5890 .sp
5891 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\&.
5892 .sp
5893 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
5894 \fI+&group\fR
5895 means check the UNIX group database, followed by the NIS netgroup database, and the value
5896 \fI&+group\fR
5897 means check the NIS netgroup database, followed by the UNIX group database (the same as the \*(Aq@\*(Aq prefix)\&.
5898 .sp
5899 The current servicename is substituted for
5900 \fI%S\fR\&. This is useful in the [homes] section\&.
5901 .sp
5902 Default:
5903 \fI\fIinvalid users\fR\fR\fI = \fR\fI # no invalid users\fR\fI \fR
5904 .sp
5905 Example:
5906 \fI\fIinvalid users\fR\fR\fI = \fR\fIroot fred admin @wheel\fR\fI \fR
5907 .RE
5908
5909 iprint server (G)
5910 .PP
5911 .RS 4
5912 This parameter is only applicable if
5913 \m[blue]\fBprinting\fR\m[]
5914 is set to
5915 \fBiprint\fR\&.
5916 .sp
5917 If set, this option overrides the ServerName option in the CUPS
5918 client\&.conf\&. This is necessary if you have virtual samba servers that connect to different CUPS daemons\&.
5919 .sp
5920 Default:
5921 \fI\fIiprint server\fR\fR\fI = \fR\fI""\fR\fI \fR
5922 .sp
5923 Example:
5924 \fI\fIiprint server\fR\fR\fI = \fR\fIMYCUPSSERVER\fR\fI \fR
5925 .RE
5926
5927 kdc always include pac (G)
5928 .PP
5929 .RS 4
5930 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\&.
5931 .sp
5932 This option currently only applies if the embedded Heimdal KDC is used\&.
5933 .sp
5934 Default:
5935 \fI\fIkdc always include pac\fR\fR\fI = \fR\fIyes\fR\fI \fR
5936 .RE
5937
5938 certificate backdating compensation (G)
5939 .PP
5940 .RS 4
5941 When performing certificate based kerberos authentication (PKINIT) with
5942 \m[blue]\fBstrong certificate binding enforcement = compatibility\fR\m[]
5943 .sp
5944 This parameter specifies the number of minutes that a certificate\*(Aqs issue date may precede the creation of a user\*(Aqs account\&.
5945 .sp
5946 More details can be found at
5947 KB5014754: Certificate\-based authentication changes on Windows domain controllers
5948 .sp
5949 Default:
5950 \fI\fIcertificate backdating compensation\fR\fR\fI = \fR\fI0\fR\fI \fR
5951 .RE
5952
5953 strong certificate binding enforcement (G)
5954 .PP
5955 .RS 4
5956 This parameter controls the enforcement of Windows Certificate bindings as outlined in
5957 KB5014754: Certificate\-based authentication changes on Windows domain controllers, when performing certificate based kerberos authentication (PKINIT)
5958 .sp
5959 The possible values are:
5960 .RS
5961 .sp
5962 .RS 4
5963 .ie n \{\
5964 \h'-04'\(bu\h'+03'\c
5965 .\}
5966 .el \{\
5967 .sp -1
5968 .IP \(bu 2.3
5969 .\}
5970 \fBnone\fR
5971 .sp
5972 No validation of the certificate mappings is performed
5973 .RE
5974 .sp
5975 .RS 4
5976 .ie n \{\
5977 \h'-04'\(bu\h'+03'\c
5978 .\}
5979 .el \{\
5980 .sp -1
5981 .IP \(bu 2.3
5982 .\}
5983 \fBcompatibility\fR
5984 .sp
5985 Weak certificate mappings are permitted\&.
5986 .sp
5987 In compatibility mode for WEAK mappings the date the certificate was issued must be after the date that the user was created\&.
5988 .sp
5989 \fBUnless\fR
5990 \m[blue]\fBcertificate backdating compensation\fR\m[]
5991 has a value\&. In that case the certificate may have been issued no more than that number of minutes before the user was created\&.
5992 .RE
5993 .sp
5994 .RS 4
5995 .ie n \{\
5996 \h'-04'\(bu\h'+03'\c
5997 .\}
5998 .el \{\
5999 .sp -1
6000 .IP \(bu 2.3
6001 .\}
6002 \fBfull\fR
6003 .sp
6004 Only
6005 \fBstrong\fR
6006 certificate mappings are permitted\&. This is the default\&.
6007 .RE
6008 .sp
6009 .RE
6010 .sp
6011 Certificate mappings are configured in the users
6012 \fBaltSecurityIdentities\fR
6013 attribute and may be any of:
6014 .RS
6015 .sp
6016 .RS 4
6017 .ie n \{\
6018 \h'-04'\(bu\h'+03'\c
6019 .\}
6020 .el \{\
6021 .sp -1
6022 .IP \(bu 2.3
6023 .\}
6024 X509 Issuer and subject
6025 .sp
6026 Example: "X509:<I>IssuerName<S>SubjectName"
6027 .sp
6028 The values provided for the issuer name and subject name must match those in the user\*(Aqs certificate exactly\&.
6029 .sp
6030 \fIWEAK\fR
6031 .RE
6032 .sp
6033 .RS 4
6034 .ie n \{\
6035 \h'-04'\(bu\h'+03'\c
6036 .\}
6037 .el \{\
6038 .sp -1
6039 .IP \(bu 2.3
6040 .\}
6041 X509 Subject only
6042 .sp
6043 Example: "X509:<S>SubjectName"
6044 .sp
6045 The value provided for the issuer subject name must match that in the user\*(Aqs certificate exactly\&.
6046 .sp
6047 \fIWEAK\fR
6048 .RE
6049 .sp
6050 .RS 4
6051 .ie n \{\
6052 \h'-04'\(bu\h'+03'\c
6053 .\}
6054 .el \{\
6055 .sp -1
6056 .IP \(bu 2.3
6057 .\}
6058 X509 RFC822
6059 .sp
6060 Example: "X509:<RFC822>test@example\&.com"
6061 .sp
6062 Email address
6063 .sp
6064 \fIWEAK\fR
6065 .RE
6066 .sp
6067 .RS 4
6068 .ie n \{\
6069 \h'-04'\(bu\h'+03'\c
6070 .\}
6071 .el \{\
6072 .sp -1
6073 .IP \(bu 2.3
6074 .\}
6075 X509 Issuer and serial number
6076 .sp
6077 Example: "X509:<I>IssuerName<SR>123456789"
6078 .sp
6079 Certificate issuer and serial number
6080 .sp
6081 \fISTRONG\fR
6082 .RE
6083 .sp
6084 .RS 4
6085 .ie n \{\
6086 \h'-04'\(bu\h'+03'\c
6087 .\}
6088 .el \{\
6089 .sp -1
6090 .IP \(bu 2.3
6091 .\}
6092 X509 Subject Key Identifier
6093 .sp
6094 Example: "<SKI>01234xxxxx"
6095 .sp
6096 \fISTRONG\fR
6097 .RE
6098 .sp
6099 .RS 4
6100 .ie n \{\
6101 \h'-04'\(bu\h'+03'\c
6102 .\}
6103 .el \{\
6104 .sp -1
6105 .IP \(bu 2.3
6106 .\}
6107 X509 public key SHA1
6108 .sp
6109 Example: "X509:<SHA1\-PUKEY>1234567890abcdef"
6110 .sp
6111 The SHA1 hash of the certificate\*(Aqs public key
6112 .sp
6113 \fISTRONG\fR
6114 .RE
6115 .sp
6116 .RE
6117 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
6118 \fISTRONG\fR
6119 mapping\&.
6120 .sp
6121 Default:
6122 \fI\fIstrong certificate binding enforcement\fR\fR\fI = \fR\fIfull\fR\fI \fR
6123 .RE
6124
6125 kdc default domain supported enctypes (G)
6126 .PP
6127 .RS 4
6128 Set the default value of
6129 \fBmsDS\-SupportedEncryptionTypes\fR
6130 for service accounts in Active Directory that are missing this value or where
6131 \fBmsDS\-SupportedEncryptionTypes\fR
6132 is set to 0\&.
6133 .sp
6134 This allows Samba administrators to match the configuration flexibility provided by the
6135 \fBHKEY_LOCAL_MACHINE\eSystem\eCurrentControlSet\eservices\eKDC\eDefaultDomainSupportedEncTypes\fR
6136 Registry Value on Windows\&.
6137 .sp
6138 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\&.
6139 .sp
6140 Specified values are ORed together bitwise, and those currently supported consist of:
6141 .RS
6142 .sp
6143 .RS 4
6144 .ie n \{\
6145 \h'-04'\(bu\h'+03'\c
6146 .\}
6147 .el \{\
6148 .sp -1
6149 .IP \(bu 2.3
6150 .\}
6151 \fBarcfour\-hmac\-md5\fR,
6152 \fBrc4\-hmac\fR,
6153 \fB0x4\fR, or
6154 \fB4\fR
6155 .sp
6156 Known on Windows as Kerberos RC4 encryption
6157 .RE
6158 .sp
6159 .RS 4
6160 .ie n \{\
6161 \h'-04'\(bu\h'+03'\c
6162 .\}
6163 .el \{\
6164 .sp -1
6165 .IP \(bu 2.3
6166 .\}
6167 \fBaes128\-cts\-hmac\-sha1\-96\fR,
6168 \fBaes128\-cts\fR,
6169 \fB0x8\fR, or
6170 \fB8\fR
6171 .sp
6172 Known on Windows as Kerberos AES 128 bit encryption
6173 .RE
6174 .sp
6175 .RS 4
6176 .ie n \{\
6177 \h'-04'\(bu\h'+03'\c
6178 .\}
6179 .el \{\
6180 .sp -1
6181 .IP \(bu 2.3
6182 .\}
6183 \fBaes256\-cts\-hmac\-sha1\-96\fR,
6184 \fBaes256\-cts\fR,
6185 \fB0x10\fR, or
6186 \fB16\fR
6187 .sp
6188 Known on Windows as Kerberos AES 256 bit encryption
6189 .RE
6190 .sp
6191 .RS 4
6192 .ie n \{\
6193 \h'-04'\(bu\h'+03'\c
6194 .\}
6195 .el \{\
6196 .sp -1
6197 .IP \(bu 2.3
6198 .\}
6199 \fBaes256\-cts\-hmac\-sha1\-96\-sk\fR,
6200 \fBaes256\-cts\-sk\fR,
6201 \fB0x20\fR, or
6202 \fB32\fR
6203 .sp
6204 Allow AES session keys\&. When this is set, it indicates to the KDC that AES session keys can be used, even when
6205 \fBaes256\-cts\fR
6206 and
6207 \fBaes128\-cts\fR
6208 are not set\&. This allows use of AES keys against hosts otherwise only configured with RC4 for ticket keys (which is the default)\&.
6209 .RE
6210 .sp
6211 .RE
6212 Default:
6213 \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
6214 .RE
6215
6216 kdc enable fast (G)
6217 .PP
6218 .RS 4
6219 With the Samba 4\&.16 the embedded Heimdal KDC brings support for RFC6113 FAST, which wasn\*(Aqt available in older Samba versions\&.
6220 .sp
6221 This option is mostly for testing and currently only applies if the embedded Heimdal KDC is used\&.
6222 .sp
6223 Default:
6224 \fI\fIkdc enable fast\fR\fR\fI = \fR\fIyes\fR\fI \fR
6225 .RE
6226
6227 kdc force enable rc4 weak session keys (G)
6228 .PP
6229 .RS 4
6230 \fBRFC8429\fR
6231 declares that
6232 \fBrc4\-hmac\fR
6233 Kerberos ciphers are weak and there are known attacks on Active Directory use of this cipher suite\&.
6234 .sp
6235 However for compatibility with Microsoft Windows this option allows the KDC to assume that regardless of the value set in a service account\*(Aqs
6236 \fBmsDS\-SupportedEncryptionTypes\fR
6237 attribute that a
6238 \fBrc4\-hmac\fR
6239 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\&.
6240 .sp
6241 Default:
6242 \fI\fIkdc force enable rc4 weak session keys\fR\fR\fI = \fR\fIno\fR\fI \fR
6243 .RE
6244
6245 kdc name match implicit dollar without canonicalization (G)
6246 .PP
6247 .RS 4
6248 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\&.
6249 .sp
6250 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\&.
6251 .sp
6252 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\&.
6253 .sp
6254 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\&.
6255 .sp
6256 Default:
6257 \fI\fIkdc name match implicit dollar without canonicalization\fR\fR\fI = \fR\fIyes\fR\fI \fR
6258 .RE
6259
6260 kdc require canonicalization (G)
6261 .PP
6262 .RS 4
6263 Require that Kerberos clients use the canonicalization flag\&.
6264 .sp
6265 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\&.
6266 .sp
6267 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\&.
6268 .sp
6269 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\&.
6270 .sp
6271 Default:
6272 \fI\fIkdc require canonicalization\fR\fR\fI = \fR\fIno\fR\fI \fR
6273 .RE
6274
6275 kdc supported enctypes (G)
6276 .PP
6277 .RS 4
6278 On an active directory domain controller, this is the list of supported encryption types for local running kdc\&.
6279 .sp
6280 This allows Samba administrators to remove support for weak/unused encryption types, similar the configuration flexibility provided by the
6281 \fBNetwork security: Configure encryption types allowed for Kerberos\fR
6282 GPO/Local Policies/Security Options Value, which results in the
6283 \fBHKEY_LOCAL_MACHINE\eSOFTWARE\eMicrosoft\eWindows\eCurrentVersion\ePolicies\eSystem\eKerberos\eParameters\eSupportedEncryptionTypes\fR
6284 Registry Value on Windows\&.
6285 .sp
6286 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\&.
6287 .sp
6288 Specified values are ORed together bitwise, and those currently supported consist of:
6289 .RS
6290 .sp
6291 .RS 4
6292 .ie n \{\
6293 \h'-04'\(bu\h'+03'\c
6294 .\}
6295 .el \{\
6296 .sp -1
6297 .IP \(bu 2.3
6298 .\}
6299 \fBarcfour\-hmac\-md5\fR,
6300 \fBrc4\-hmac\fR,
6301 \fB0x4\fR, or
6302 \fB4\fR
6303 .sp
6304 Known on Windows as Kerberos RC4 encryption
6305 .RE
6306 .sp
6307 .RS 4
6308 .ie n \{\
6309 \h'-04'\(bu\h'+03'\c
6310 .\}
6311 .el \{\
6312 .sp -1
6313 .IP \(bu 2.3
6314 .\}
6315 \fBaes128\-cts\-hmac\-sha1\-96\fR,
6316 \fBaes128\-cts\fR,
6317 \fB0x8\fR, or
6318 \fB8\fR
6319 .sp
6320 Known on Windows as Kerberos AES 128 bit encryption
6321 .RE
6322 .sp
6323 .RS 4
6324 .ie n \{\
6325 \h'-04'\(bu\h'+03'\c
6326 .\}
6327 .el \{\
6328 .sp -1
6329 .IP \(bu 2.3
6330 .\}
6331 \fBaes256\-cts\-hmac\-sha1\-96\fR,
6332 \fBaes256\-cts\fR,
6333 \fB0x10\fR, or
6334 \fB16\fR
6335 .sp
6336 Known on Windows as Kerberos AES 256 bit encryption
6337 .RE
6338 .sp
6339 .RE
6340 Default:
6341 \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
6342 .RE
6343
6344 keepalive (G)
6345 .PP
6346 .RS 4
6347 The value of the parameter (an integer) represents the number of seconds between
6348 \fIkeepalive\fR
6349 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\&.
6350 .sp
6351 Keepalives should, in general, not be needed if the socket has the SO_KEEPALIVE attribute set on it by default\&. (see
6352 \m[blue]\fBsocket options\fR\m[])\&. Basically you should only use this option if you strike difficulties\&.
6353 .sp
6354 Please note this option only applies to SMB1 client connections, and has no effect on SMB2 clients\&.
6355 .sp
6356 Default:
6357 \fI\fIkeepalive\fR\fR\fI = \fR\fI300\fR\fI \fR
6358 .sp
6359 Example:
6360 \fI\fIkeepalive\fR\fR\fI = \fR\fI600\fR\fI \fR
6361 .RE
6362
6363 kerberos encryption types (G)
6364 .PP
6365 .RS 4
6366 This parameter determines the encryption types to use when operating as a Kerberos client\&. Possible values are
6367 \fIall\fR,
6368 \fIstrong\fR, and
6369 \fIlegacy\fR\&.
6370 .sp
6371 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
6372 \fBwinbindd\fR(8)
6373 and
6374 \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\&.
6375 .sp
6376 When set to
6377 \fBall\fR, all active directory encryption types are allowed\&.
6378 .sp
6379 When set to
6380 \fBstrong\fR, only AES\-based encryption types are offered\&. This can be used in hardened environments to prevent downgrade attacks\&.
6381 .sp
6382 When set to
6383 \fBlegacy\fR, only RC4\-HMAC\-MD5 is allowed\&. AVOID using this option, because of
6384 CVE\-2022\-37966
6385 see
6386 https://bugzilla\&.samba\&.org/show_bug\&.cgi?id=15237\&.
6387 .sp
6388 Default:
6389 \fI\fIkerberos encryption types\fR\fR\fI = \fR\fIall\fR\fI \fR
6390 .RE
6391
6392 kerberos method (G)
6393 .PP
6394 .RS 4
6395 Controls how kerberos tickets are verified\&.
6396 .sp
6397 Valid options are:
6398 .RS
6399 .sp
6400 .RS 4
6401 .ie n \{\
6402 \h'-04'\(bu\h'+03'\c
6403 .\}
6404 .el \{\
6405 .sp -1
6406 .IP \(bu 2.3
6407 .\}
6408 secrets only \- use only the secrets\&.tdb for ticket verification (default)
6409 .RE
6410 .sp
6411 .RS 4
6412 .ie n \{\
6413 \h'-04'\(bu\h'+03'\c
6414 .\}
6415 .el \{\
6416 .sp -1
6417 .IP \(bu 2.3
6418 .\}
6419 system keytab \- use only the system keytab for ticket verification
6420 .RE
6421 .sp
6422 .RS 4
6423 .ie n \{\
6424 \h'-04'\(bu\h'+03'\c
6425 .\}
6426 .el \{\
6427 .sp -1
6428 .IP \(bu 2.3
6429 .\}
6430 dedicated keytab \- use a dedicated keytab for ticket verification
6431 .RE
6432 .sp
6433 .RS 4
6434 .ie n \{\
6435 \h'-04'\(bu\h'+03'\c
6436 .\}
6437 .el \{\
6438 .sp -1
6439 .IP \(bu 2.3
6440 .\}
6441 secrets and keytab \- use the secrets\&.tdb first, then the system keytab
6442 .RE
6443 .sp
6444 .RE
6445 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\&.
6446 .sp
6447 When the kerberos method is in "dedicated keytab" mode,
6448 \m[blue]\fBdedicated keytab file\fR\m[]
6449 must be set to specify the location of the keytab file\&.
6450 .sp
6451 Suggested configuration is to use the default value \*(Aqsecrets only\*(Aq together with the
6452 \m[blue]\fBsync machine password to keytab\fR\m[]
6453 option\&.
6454 .sp
6455 Default:
6456 \fI\fIkerberos method\fR\fR\fI = \fR\fIdefault\fR\fI \fR
6457 .RE
6458
6459 kernel change notify (G)
6460 .PP
6461 .RS 4
6462 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\&.
6463 .sp
6464 This parameter is only used when your kernel supports change notification to user programs using the inotify interface\&.
6465 .sp
6466 Default:
6467 \fI\fIkernel change notify\fR\fR\fI = \fR\fIyes\fR\fI \fR
6468 .RE
6469
6470 kernel oplocks (S)
6471 .PP
6472 .RS 4
6473 For UNIXes that support kernel based
6474 \m[blue]\fBoplocks\fR\m[]
6475 (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\&.
6476 .sp
6477 Kernel oplocks support allows Samba
6478 \fIoplocks \fR
6479 to be broken whenever a local UNIX process or NFS operation accesses a file that
6480 \fBsmbd\fR(8)
6481 has oplocked\&. This allows complete data consistency between SMB/CIFS, NFS and local file access (and is a
6482 \fIvery\fR
6483 cool feature :\-)\&.
6484 .sp
6485 If you do not need this interaction, you should disable the parameter on Linux to get Level II oplocks and the associated performance benefit\&.
6486 .sp
6487 This parameter defaults to
6488 \fBno\fR
6489 and is translated to a no\-op on systems that do not have the necessary kernel support\&.
6490 .sp
6491 Default:
6492 \fI\fIkernel oplocks\fR\fR\fI = \fR\fIno\fR\fI \fR
6493 .RE
6494
6495 kernel share modes (S)
6496 .PP
6497 .RS 4
6498 This parameter controls whether SMB share modes are translated into file system specific sharemode calls\&.
6499 .sp
6500 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\&.
6501 .sp
6502 Note that in order to use SMB2 durable file handles on a share, you have to turn kernel share modes off\&.
6503 .sp
6504 This parameter defaults to
6505 \fBno\fR\&. Setting it to
6506 \fByes\fR
6507 requires a file system module that supports file system sharemodes, otherwise attempts to access files will fail with a sharing violation\&.
6508 .sp
6509 Default:
6510 \fI\fIkernel share modes\fR\fR\fI = \fR\fIno\fR\fI \fR
6511 .RE
6512
6513 kpasswd port (G)
6514 .PP
6515 .RS 4
6516 Specifies which ports the Kerberos server should listen on for password changes\&.
6517 .sp
6518 Default:
6519 \fI\fIkpasswd port\fR\fR\fI = \fR\fI464\fR\fI \fR
6520 .RE
6521
6522 krb5 acceptor report canonical client name (G)
6523 .PP
6524 .RS 4
6525 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\&.
6526 .sp
6527 This option currently only applies if the embedded Heimdal KDC is used\&.
6528 .sp
6529 Default:
6530 \fI\fIkrb5 acceptor report canonical client name\fR\fR\fI = \fR\fIyes\fR\fI \fR
6531 .RE
6532
6533 krb5 port (G)
6534 .PP
6535 .RS 4
6536 Specifies which port the KDC should listen on for Kerberos traffic\&.
6537 .sp
6538 Default:
6539 \fI\fIkrb5 port\fR\fR\fI = \fR\fI88\fR\fI \fR
6540 .RE
6541
6542 lanman auth (G)
6543 .PP
6544 .RS 4
6545 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\&.
6546 .sp
6547 That is, in the future, the current default of
6548 lanman auth = no
6549 will be the enforced behaviour\&.
6550 .sp
6551 This parameter determines whether or not
6552 \fBsmbd\fR(8)
6553 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\&.
6554 .sp
6555 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\&.
6556 .sp
6557 When this parameter is set to
6558 no
6559 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\&.
6560 .sp
6561 Unlike the
6562 \fIencrypt passwords\fR
6563 option, this parameter cannot alter client behaviour, and the LANMAN response will still be sent over the network\&. See the
6564 client lanman auth
6565 to disable this for Samba\*(Aqs clients (such as smbclient)
6566 .sp
6567 This parameter is overridden by
6568 \fIntlm auth\fR, so unless that it is also set to
6569 \fBntlmv1\-permitted\fR
6570 or
6571 \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\&.
6572 .sp
6573 \fIThis parameter has no impact on the Samba AD DC, LM authentication is always disabled and no LM password is ever stored\&.\fR
6574 .sp
6575 Default:
6576 \fI\fIlanman auth\fR\fR\fI = \fR\fIno\fR\fI \fR
6577 .RE
6578
6579 large readwrite (G)
6580 .PP
6581 .RS 4
6582 This parameter determines whether or not
6583 \fBsmbd\fR(8)
6584 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\&.
6585 .sp
6586 Default:
6587 \fI\fIlarge readwrite\fR\fR\fI = \fR\fIyes\fR\fI \fR
6588 .RE
6589
6590 ldap admin dn (G)
6591 .PP
6592 .RS 4
6593 The
6594 \m[blue]\fBldap admin dn\fR\m[]
6595 defines the Distinguished Name (DN) name used by Samba to contact the ldap server when retrieving user account information\&. The
6596 \m[blue]\fBldap admin dn\fR\m[]
6597 is used in conjunction with the admin dn password stored in the
6598 private/secrets\&.tdb
6599 file\&. See the
6600 \fBsmbpasswd\fR(8)
6601 man page for more information on how to accomplish this\&.
6602 .sp
6603 The
6604 \m[blue]\fBldap admin dn\fR\m[]
6605 requires a fully specified DN\&. The
6606 \m[blue]\fBldap suffix\fR\m[]
6607 is not appended to the
6608 \m[blue]\fBldap admin dn\fR\m[]\&.
6609 .sp
6610 \fINo default\fR
6611 .RE
6612
6613 ldap connection timeout (G)
6614 .PP
6615 .RS 4
6616 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\&.
6617 .sp
6618 This parameter is different from
6619 \m[blue]\fBldap timeout\fR\m[]
6620 which affects operations on LDAP servers using an existing connection and not establishing an initial connection\&.
6621 .sp
6622 Default:
6623 \fI\fIldap connection timeout\fR\fR\fI = \fR\fI2\fR\fI \fR
6624 .RE
6625
6626 ldap debug level (G)
6627 .PP
6628 .RS 4
6629 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
6630 \fBslapd.conf\fR(5)
6631 manpage\&. A typical useful value will be
6632 \fI1\fR
6633 for tracing function calls\&.
6634 .sp
6635 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
6636 \fIldap debug threshold\fR\&.
6637 .sp
6638 Default:
6639 \fI\fIldap debug level\fR\fR\fI = \fR\fI0\fR\fI \fR
6640 .sp
6641 Example:
6642 \fI\fIldap debug level\fR\fR\fI = \fR\fI1\fR\fI \fR
6643 .RE
6644
6645 ldap debug threshold (G)
6646 .PP
6647 .RS 4
6648 This parameter controls the Samba debug level at which the ldap library debug output is printed in the Samba logs\&. See the description of
6649 \fIldap debug level\fR
6650 for details\&.
6651 .sp
6652 Default:
6653 \fI\fIldap debug threshold\fR\fR\fI = \fR\fI10\fR\fI \fR
6654 .sp
6655 Example:
6656 \fI\fIldap debug threshold\fR\fR\fI = \fR\fI5\fR\fI \fR
6657 .RE
6658
6659 ldap delete dn (G)
6660 .PP
6661 .RS 4
6662 This parameter specifies whether a delete operation in the ldapsam deletes the complete entry or only the attributes specific to Samba\&.
6663 .sp
6664 Default:
6665 \fI\fIldap delete dn\fR\fR\fI = \fR\fIno\fR\fI \fR
6666 .RE
6667
6668 ldap deref (G)
6669 .PP
6670 .RS 4
6671 This option controls whether Samba should tell the LDAP library to use a certain alias dereferencing method\&. The default is
6672 \fIauto\fR, which means that the default setting of the ldap client library will be kept\&. Other possible values are
6673 \fInever\fR,
6674 \fIfinding\fR,
6675 \fIsearching\fR
6676 and
6677 \fIalways\fR\&. Grab your LDAP manual for more information\&.
6678 .sp
6679 Default:
6680 \fI\fIldap deref\fR\fR\fI = \fR\fIauto\fR\fI \fR
6681 .sp
6682 Example:
6683 \fI\fIldap deref\fR\fR\fI = \fR\fIsearching\fR\fI \fR
6684 .RE
6685
6686 ldap follow referral (G)
6687 .PP
6688 .RS 4
6689 This option controls whether to follow LDAP referrals or not when searching for entries in the LDAP database\&. Possible values are
6690 \fIon\fR
6691 to enable following referrals,
6692 \fIoff\fR
6693 to disable this, and
6694 \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)\&.
6695 .sp
6696 Default:
6697 \fI\fIldap follow referral\fR\fR\fI = \fR\fIauto\fR\fI \fR
6698 .sp
6699 Example:
6700 \fI\fIldap follow referral\fR\fR\fI = \fR\fIoff\fR\fI \fR
6701 .RE
6702
6703 ldap group suffix (G)
6704 .PP
6705 .RS 4
6706 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
6707 \m[blue]\fBldap suffix\fR\m[]
6708 will be used instead\&. The suffix string is prepended to the
6709 \m[blue]\fBldap suffix\fR\m[]
6710 string so use a partial DN\&.
6711 .sp
6712 Default:
6713 \fI\fIldap group suffix\fR\fR\fI = \fR\fI\fR\fI \fR
6714 .sp
6715 Example:
6716 \fI\fIldap group suffix\fR\fR\fI = \fR\fIou=Groups\fR\fI \fR
6717 .RE
6718
6719 ldap idmap suffix (G)
6720 .PP
6721 .RS 4
6722 This parameters specifies the suffix that is used when storing idmap mappings\&. If this parameter is unset, the value of
6723 \m[blue]\fBldap suffix\fR\m[]
6724 will be used instead\&. The suffix string is prepended to the
6725 \m[blue]\fBldap suffix\fR\m[]
6726 string so use a partial DN\&.
6727 .sp
6728 Default:
6729 \fI\fIldap idmap suffix\fR\fR\fI = \fR\fI\fR\fI \fR
6730 .sp
6731 Example:
6732 \fI\fIldap idmap suffix\fR\fR\fI = \fR\fIou=Idmap\fR\fI \fR
6733 .RE
6734
6735 ldap machine suffix (G)
6736 .PP
6737 .RS 4
6738 It specifies where machines should be added to the ldap tree\&. If this parameter is unset, the value of
6739 \m[blue]\fBldap suffix\fR\m[]
6740 will be used instead\&. The suffix string is prepended to the
6741 \m[blue]\fBldap suffix\fR\m[]
6742 string so use a partial DN\&.
6743 .sp
6744 Default:
6745 \fI\fIldap machine suffix\fR\fR\fI = \fR\fI\fR\fI \fR
6746 .sp
6747 Example:
6748 \fI\fIldap machine suffix\fR\fR\fI = \fR\fIou=Computers\fR\fI \fR
6749 .RE
6750
6751 ldap max anonymous request size (G)
6752 .PP
6753 .RS 4
6754 This parameter specifies the maximum permitted size (in bytes) for an LDAP request received on an anonymous connection\&.
6755 .sp
6756 If the request size exceeds this limit the request will be rejected\&.
6757 .sp
6758 Default:
6759 \fI\fIldap max anonymous request size\fR\fR\fI = \fR\fI256000\fR\fI \fR
6760 .sp
6761 Example:
6762 \fI\fIldap max anonymous request size\fR\fR\fI = \fR\fI500000\fR\fI \fR
6763 .RE
6764
6765 ldap max authenticated request size (G)
6766 .PP
6767 .RS 4
6768 This parameter specifies the maximum permitted size (in bytes) for an LDAP request received on an authenticated connection\&.
6769 .sp
6770 If the request size exceeds this limit the request will be rejected\&.
6771 .sp
6772 Default:
6773 \fI\fIldap max authenticated request size\fR\fR\fI = \fR\fI16777216\fR\fI \fR
6774 .sp
6775 Example:
6776 \fI\fIldap max authenticated request size\fR\fR\fI = \fR\fI4194304\fR\fI \fR
6777 .RE
6778
6779 ldap max search request size (G)
6780 .PP
6781 .RS 4
6782 This parameter specifies the maximum permitted size (in bytes) for an LDAP search request\&.
6783 .sp
6784 If the request size exceeds this limit the request will be rejected\&.
6785 .sp
6786 Default:
6787 \fI\fIldap max search request size\fR\fR\fI = \fR\fI256000\fR\fI \fR
6788 .sp
6789 Example:
6790 \fI\fIldap max search request size\fR\fR\fI = \fR\fI4194304\fR\fI \fR
6791 .RE
6792
6793 ldap page size (G)
6794 .PP
6795 .RS 4
6796 This parameter specifies the number of entries per page\&.
6797 .sp
6798 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\&.
6799 .sp
6800 Default:
6801 \fI\fIldap page size\fR\fR\fI = \fR\fI1000\fR\fI \fR
6802 .sp
6803 Example:
6804 \fI\fIldap page size\fR\fR\fI = \fR\fI512\fR\fI \fR
6805 .RE
6806
6807 ldap password sync
6808 .PP
6809 .RS 4
6810 This parameter is a synonym for
6811 ldap passwd sync\&.
6812 .RE
6813
6814 ldap passwd sync (G)
6815 .PP
6816 .RS 4
6817 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\&.
6818 .sp
6819 The
6820 \m[blue]\fBldap passwd sync\fR\m[]
6821 can be set to one of three values:
6822 .RS
6823 .sp
6824 .RS 4
6825 .ie n \{\
6826 \h'-04'\(bu\h'+03'\c
6827 .\}
6828 .el \{\
6829 .sp -1
6830 .IP \(bu 2.3
6831 .\}
6832 \fIYes\fR
6833 = Try to update the LDAP, NT and LM passwords and update the pwdLastSet time\&.
6834 .RE
6835 .sp
6836 .RS 4
6837 .ie n \{\
6838 \h'-04'\(bu\h'+03'\c
6839 .\}
6840 .el \{\
6841 .sp -1
6842 .IP \(bu 2.3
6843 .\}
6844 \fINo\fR
6845 = Update NT and LM passwords and update the pwdLastSet time\&.
6846 .RE
6847 .sp
6848 .RS 4
6849 .ie n \{\
6850 \h'-04'\(bu\h'+03'\c
6851 .\}
6852 .el \{\
6853 .sp -1
6854 .IP \(bu 2.3
6855 .\}
6856 \fIOnly\fR
6857 = Only update the LDAP password and let the LDAP server do the rest\&.
6858 .RE
6859 .sp
6860 .RE
6861 Default:
6862 \fI\fIldap passwd sync\fR\fR\fI = \fR\fIno\fR\fI \fR
6863 .RE
6864
6865 ldap replication sleep (G)
6866 .PP
6867 .RS 4
6868 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\&.
6869 .sp
6870 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\&.
6871 .sp
6872 The value is specified in milliseconds, the maximum value is 5000 (5 seconds)\&.
6873 .sp
6874 Default:
6875 \fI\fIldap replication sleep\fR\fR\fI = \fR\fI1000\fR\fI \fR
6876 .RE
6877
6878 ldapsam:editposix (G)
6879 .PP
6880 .RS 4
6881 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\&.
6882 .sp
6883 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
6884 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
6885 \m[blue]\fBldapsam:trusted = yes\fR\m[]
6886 option is usually sufficient to use
6887 \m[blue]\fBldapsam:editposix = yes\fR\m[]
6888 as well\&.
6889 .sp
6890 An example configuration can be the following:
6891 .sp
6892 .if n \{\
6893 .RS 4
6894 .\}
6895 .nf
6896 encrypt passwords = true
6897 passdb backend = ldapsam
6898
6899 ldapsam:trusted=yes
6900 ldapsam:editposix=yes
6901
6902 ldap admin dn = cn=admin,dc=samba,dc=org
6903 ldap delete dn = yes
6904 ldap group suffix = ou=groups
6905 ldap idmap suffix = ou=idmap
6906 ldap machine suffix = ou=computers
6907 ldap user suffix = ou=users
6908 ldap suffix = dc=samba,dc=org
6909
6910 idmap backend = ldap:"ldap://localhost"
6911
6912 idmap uid = 5000\-50000
6913 idmap gid = 5000\-50000
6914
6915 .fi
6916 .if n \{\
6917 .RE
6918 .\}
6919 .sp
6920 This configuration assumes a directory layout like described in the following ldif:
6921 .sp
6922 .if n \{\
6923 .RS 4
6924 .\}
6925 .nf
6926 dn: dc=samba,dc=org
6927 objectClass: top
6928 objectClass: dcObject
6929 objectClass: organization
6930 o: samba\&.org
6931 dc: samba
6932
6933 dn: cn=admin,dc=samba,dc=org
6934 objectClass: simpleSecurityObject
6935 objectClass: organizationalRole
6936 cn: admin
6937 description: LDAP administrator
6938 userPassword: secret
6939
6940 dn: ou=users,dc=samba,dc=org
6941 objectClass: top
6942 objectClass: organizationalUnit
6943 ou: users
6944
6945 dn: ou=groups,dc=samba,dc=org
6946 objectClass: top
6947 objectClass: organizationalUnit
6948 ou: groups
6949
6950 dn: ou=idmap,dc=samba,dc=org
6951 objectClass: top
6952 objectClass: organizationalUnit
6953 ou: idmap
6954
6955 dn: ou=computers,dc=samba,dc=org
6956 objectClass: top
6957 objectClass: organizationalUnit
6958 ou: computers
6959
6960 .fi
6961 .if n \{\
6962 .RE
6963 .\}
6964 .sp
6965 Default:
6966 \fI\fIldapsam:editposix\fR\fR\fI = \fR\fIno\fR\fI \fR
6967 .RE
6968
6969 ldapsam:trusted (G)
6970 .PP
6971 .RS 4
6972 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\&.
6973 .sp
6974 To make Samba scale well in large environments, the
6975 \m[blue]\fBldapsam:trusted = yes\fR\m[]
6976 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,
6977 \m[blue]\fBldapsam:trusted = yes\fR\m[]
6978 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\&.
6979 .sp
6980 Default:
6981 \fI\fIldapsam:trusted\fR\fR\fI = \fR\fIno\fR\fI \fR
6982 .RE
6983
6984 ldap server require strong auth (G)
6985 .PP
6986 .RS 4
6987 The
6988 \m[blue]\fBldap server require strong auth\fR\m[]
6989 defines whether the ldap server requires ldap traffic to be signed or signed and encrypted (sealed)\&. Possible values are
6990 \fIno\fR,
6991 \fIallow_sasl_without_tls_channel_bindings\fR
6992 and
6993 \fIyes\fR\&.
6994 .sp
6995 Windows has
6996 \fILdapEnforceChannelBinding\fR
6997 under
6998 \fIHKLM\eSYSTEM\eCurrentControlSet\eServices\eNTDS\eParameters\e\fR\&.
6999 .sp
7000 A value of
7001 \fIno\fR
7002 allows simple and sasl binds over all transports\&. This matches LdapEnforceChannelBinding=0\&.
7003 .sp
7004 A value of
7005 \fIallow_sasl_without_tls_channel_bindings\fR
7006 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
7007 \fIyes\fR
7008 is not possible\&. Unencrypted connections only allow sasl binds with sign or seal\&. This matches LdapEnforceChannelBinding=1\&.
7009 .sp
7010 Before support for tls channel bindings existed in Samba, a value of
7011 \fIallow_sasl_over_tls\fR
7012 was possible in order to allow sasl binds without tls channel bindings\&. This is now misleading as a value of
7013 \fIyes\fR
7014 will now allow sasl binds with tls channel bindings\&. Configurations should be changed to
7015 \fIyes\fR
7016 instead or
7017 \fIallow_sasl_without_tls_channel_bindings\fR
7018 if really required\&. Currently
7019 \fIallow_sasl_over_tls\fR
7020 is just an alias of
7021 \fIallow_sasl_without_tls_channel_bindings\fR, but it will be removed in future versions\&.
7022 .sp
7023 A value of
7024 \fIyes\fR
7025 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\&.
7026 .sp
7027 Default:
7028 \fI\fIldap server require strong auth\fR\fR\fI = \fR\fIyes\fR\fI \fR
7029 .RE
7030
7031 ldap ssl (G)
7032 .PP
7033 .RS 4
7034 This option is used to define whether or not Samba should use SSL when connecting to the ldap server This is
7035 \fINOT\fR
7036 related to Samba\*(Aqs previous SSL support which was enabled by specifying the
7037 \-\-with\-ssl
7038 option to the
7039 configure
7040 script\&.
7041 .sp
7042 LDAP connections should be secured where possible\&. This may be done setting
7043 \fIeither\fR
7044 this parameter to
7045 \fIstart tls\fR
7046 \fIor\fR
7047 by specifying
7048 \fIldaps://\fR
7049 in the URL argument of
7050 \m[blue]\fBpassdb backend\fR\m[]\&.
7051 .sp
7052 The
7053 \m[blue]\fBldap ssl\fR\m[]
7054 can be set to one of two values:
7055 .RS
7056 .sp
7057 .RS 4
7058 .ie n \{\
7059 \h'-04'\(bu\h'+03'\c
7060 .\}
7061 .el \{\
7062 .sp -1
7063 .IP \(bu 2.3
7064 .\}
7065 \fIOff\fR
7066 = Never use SSL when querying the directory\&.
7067 .RE
7068 .sp
7069 .RS 4
7070 .ie n \{\
7071 \h'-04'\(bu\h'+03'\c
7072 .\}
7073 .el \{\
7074 .sp -1
7075 .IP \(bu 2.3
7076 .\}
7077 \fIstart tls\fR
7078 = Use the LDAPv3 StartTLS extended operation (RFC2830) for communicating with the directory server\&.
7079 .RE
7080 .sp
7081 .RE
7082 Please note that this parameter does only affect
7083 \fIrpc\fR
7084 methods\&.
7085 .sp
7086 Default:
7087 \fI\fIldap ssl\fR\fR\fI = \fR\fIstart tls\fR\fI \fR
7088 .RE
7089
7090 ldap suffix (G)
7091 .PP
7092 .RS 4
7093 Specifies the base for all ldap suffixes and for storing the sambaDomain object\&.
7094 .sp
7095 The ldap suffix will be appended to the values specified for the
7096 \m[blue]\fBldap user suffix\fR\m[],
7097 \m[blue]\fBldap group suffix\fR\m[],
7098 \m[blue]\fBldap machine suffix\fR\m[], and the
7099 \m[blue]\fBldap idmap suffix\fR\m[]\&. Each of these should be given only a DN relative to the
7100 \m[blue]\fBldap suffix\fR\m[]\&.
7101 .sp
7102 Default:
7103 \fI\fIldap suffix\fR\fR\fI = \fR\fI\fR\fI \fR
7104 .sp
7105 Example:
7106 \fI\fIldap suffix\fR\fR\fI = \fR\fIdc=samba,dc=org\fR\fI \fR
7107 .RE
7108
7109 ldap timeout (G)
7110 .PP
7111 .RS 4
7112 This parameter defines the number of seconds that Samba should use as timeout for LDAP operations\&.
7113 .sp
7114 Default:
7115 \fI\fIldap timeout\fR\fR\fI = \fR\fI15\fR\fI \fR
7116 .RE
7117
7118 ldap user suffix (G)
7119 .PP
7120 .RS 4
7121 This parameter specifies where users are added to the tree\&. If this parameter is unset, the value of
7122 \m[blue]\fBldap suffix\fR\m[]
7123 will be used instead\&. The suffix string is prepended to the
7124 \m[blue]\fBldap suffix\fR\m[]
7125 string so use a partial DN\&.
7126 .sp
7127 Default:
7128 \fI\fIldap user suffix\fR\fR\fI = \fR\fI\fR\fI \fR
7129 .sp
7130 Example:
7131 \fI\fIldap user suffix\fR\fR\fI = \fR\fIou=people\fR\fI \fR
7132 .RE
7133
7134 level2 oplocks (S)
7135 .PP
7136 .RS 4
7137 This parameter controls whether Samba supports level2 (read\-only) oplocks on a share\&.
7138 .sp
7139 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)\&.
7140 .sp
7141 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\&.
7142 .sp
7143 It is recommended that this parameter be turned on to speed access to shared executables\&.
7144 .sp
7145 For more discussions on level2 oplocks see the CIFS spec\&.
7146 .sp
7147 Currently, if
7148 \m[blue]\fBkernel oplocks\fR\m[]
7149 are supported then level2 oplocks are not granted (even if this parameter is set to
7150 \fByes\fR)\&. Note also, the
7151 \m[blue]\fBoplocks\fR\m[]
7152 parameter must be set to
7153 \fByes\fR
7154 on this share in order for this parameter to have any effect\&.
7155 .sp
7156 Default:
7157 \fI\fIlevel2 oplocks\fR\fR\fI = \fR\fIyes\fR\fI \fR
7158 .RE
7159
7160 lm announce (G)
7161 .PP
7162 .RS 4
7163 This parameter determines if
7164 \fBnmbd\fR(8)
7165 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,
7166 \fByes\fR,
7167 \fBno\fR, or
7168 \fBauto\fR\&. The default is
7169 \fBauto\fR\&. If set to
7170 \fBno\fR
7171 Samba will never produce these broadcasts\&. If set to
7172 \fByes\fR
7173 Samba will produce Lanman announce broadcasts at a frequency set by the parameter
7174 \m[blue]\fBlm interval\fR\m[]\&. If set to
7175 \fBauto\fR
7176 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
7177 \m[blue]\fBlm interval\fR\m[]\&.
7178 .sp
7179 Default:
7180 \fI\fIlm announce\fR\fR\fI = \fR\fIauto\fR\fI \fR
7181 .sp
7182 Example:
7183 \fI\fIlm announce\fR\fR\fI = \fR\fIyes\fR\fI \fR
7184 .RE
7185
7186 lm interval (G)
7187 .PP
7188 .RS 4
7189 If Samba is set to produce Lanman announce broadcasts needed by OS/2 clients (see the
7190 \m[blue]\fBlm announce\fR\m[]
7191 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
7192 \m[blue]\fBlm announce\fR\m[]
7193 parameter\&.
7194 .sp
7195 Default:
7196 \fI\fIlm interval\fR\fR\fI = \fR\fI60\fR\fI \fR
7197 .sp
7198 Example:
7199 \fI\fIlm interval\fR\fR\fI = \fR\fI120\fR\fI \fR
7200 .RE
7201
7202 load printers (G)
7203 .PP
7204 .RS 4
7205 A boolean variable that controls whether all printers in the printcap will be loaded for browsing by default\&. See the
7206 printers
7207 section for more details\&.
7208 .sp
7209 Default:
7210 \fI\fIload printers\fR\fR\fI = \fR\fIyes\fR\fI \fR
7211 .RE
7212
7213 local master (G)
7214 .PP
7215 .RS 4
7216 This option allows
7217 \fBnmbd\fR(8)
7218 to try and become a local master browser on a subnet\&. If set to
7219 \fBno\fR
7220 then
7221 nmbd
7222 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
7223 \fByes\fR\&. Setting this value to
7224 \fByes\fR
7225 doesn\*(Aqt mean that Samba will
7226 \fIbecome\fR
7227 the local master browser on a subnet, just that
7228 nmbd
7229 will
7230 \fIparticipate\fR
7231 in elections for local master browser\&.
7232 .sp
7233 Setting this value to
7234 \fBno\fR
7235 will cause
7236 nmbd
7237 \fInever\fR
7238 to become a local master browser\&.
7239 .sp
7240 Default:
7241 \fI\fIlocal master\fR\fR\fI = \fR\fIyes\fR\fI \fR
7242 .RE
7243
7244 lock dir
7245 .PP
7246 .RS 4
7247 This parameter is a synonym for
7248 lock directory\&.
7249 .RE
7250
7251 lock directory (G)
7252 .PP
7253 .RS 4
7254 This option specifies the directory where lock files will be placed\&. The lock files are used to implement the
7255 \m[blue]\fBmax connections\fR\m[]
7256 option\&.
7257 .sp
7258 Note: This option can not be set inside registry configurations\&.
7259 .sp
7260 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)
7261 .sp
7262 Default:
7263 \fI\fIlock directory\fR\fR\fI = \fR\fI/run/samba\fR\fI \fR
7264 .sp
7265 Example:
7266 \fI\fIlock directory\fR\fR\fI = \fR\fI/var/run/samba/locks\fR\fI \fR
7267 .RE
7268
7269 locking (S)
7270 .PP
7271 .RS 4
7272 This controls whether or not locking will be performed by the server in response to lock requests from the client\&.
7273 .sp
7274 If
7275 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\&.
7276 .sp
7277 If
7278 locking = yes, real locking will be performed by the server\&.
7279 .sp
7280 This option
7281 \fImay\fR
7282 be useful for read\-only filesystems which
7283 \fImay\fR
7284 not need locking (such as CDROM drives), although setting this parameter of
7285 \fBno\fR
7286 is not really recommended even in this case\&.
7287 .sp
7288 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\&.
7289 .sp
7290 Default:
7291 \fI\fIlocking\fR\fR\fI = \fR\fIyes\fR\fI \fR
7292 .RE
7293
7294 lock spin time (G)
7295 .PP
7296 .RS 4
7297 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
7298 lock spin count
7299 parameter is no longer used in Samba 3\&.0\&.24\&. You should not need to change the value of this parameter\&.
7300 .sp
7301 Default:
7302 \fI\fIlock spin time\fR\fR\fI = \fR\fI200\fR\fI \fR
7303 .RE
7304
7305 log file (G)
7306 .PP
7307 .RS 4
7308 This option allows you to override the name of the Samba log file (also known as the debug file)\&.
7309 .sp
7310 This option takes the standard substitutions, allowing you to have separate log files for each user or machine\&.
7311 .sp
7312 \fINo default\fR
7313 .sp
7314 Example:
7315 \fI\fIlog file\fR\fR\fI = \fR\fI/usr/local/samba/var/log\&.%m\fR\fI \fR
7316 .RE
7317
7318 logging (G)
7319 .PP
7320 .RS 4
7321 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]\&.
7322 .sp
7323 The \*(Aqoption\*(Aq parameter can be used to pass backend\-specific options\&.
7324 .sp
7325 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
7326 \m[blue]\fBlog level\fR\m[]
7327 determines overall log levels, while the log levels specified here define what is sent to the individual backends\&.
7328 .sp
7329 When
7330 \m[blue]\fBlogging\fR\m[]
7331 is set, it overrides the
7332 \m[blue]\fBsyslog\fR\m[]
7333 and
7334 \m[blue]\fBsyslog only\fR\m[]
7335 parameters\&.
7336 .sp
7337 Some backends are only available when Samba has been compiled with the additional libraries\&. The overall list of logging backends:
7338 .RS
7339 .sp
7340 .RS 4
7341 .ie n \{\
7342 \h'-04'\(bu\h'+03'\c
7343 .\}
7344 .el \{\
7345 .sp -1
7346 .IP \(bu 2.3
7347 .\}
7348 \fIsyslog\fR
7349 .RE
7350 .sp
7351 .RS 4
7352 .ie n \{\
7353 \h'-04'\(bu\h'+03'\c
7354 .\}
7355 .el \{\
7356 .sp -1
7357 .IP \(bu 2.3
7358 .\}
7359 \fIfile\fR
7360 .RE
7361 .sp
7362 .RS 4
7363 .ie n \{\
7364 \h'-04'\(bu\h'+03'\c
7365 .\}
7366 .el \{\
7367 .sp -1
7368 .IP \(bu 2.3
7369 .\}
7370 \fIsystemd\fR
7371 .RE
7372 .sp
7373 .RS 4
7374 .ie n \{\
7375 \h'-04'\(bu\h'+03'\c
7376 .\}
7377 .el \{\
7378 .sp -1
7379 .IP \(bu 2.3
7380 .\}
7381 \fIlttng\fR
7382 .RE
7383 .sp
7384 .RS 4
7385 .ie n \{\
7386 \h'-04'\(bu\h'+03'\c
7387 .\}
7388 .el \{\
7389 .sp -1
7390 .IP \(bu 2.3
7391 .\}
7392 \fIgpfs\fR
7393 .RE
7394 .sp
7395 .RS 4
7396 .ie n \{\
7397 \h'-04'\(bu\h'+03'\c
7398 .\}
7399 .el \{\
7400 .sp -1
7401 .IP \(bu 2.3
7402 .\}
7403 \fIringbuf\fR
7404 .RE
7405 .sp
7406 .RE
7407 The
7408 \fIringbuf\fR
7409 backend supports an optional size argument to change the buffer size used, the default is 1 MB:
7410 \fIringbuf:size=NBYTES\fR
7411 .sp
7412 Default:
7413 \fI\fIlogging\fR\fR\fI = \fR\fI\fR\fI \fR
7414 .sp
7415 Example:
7416 \fI\fIlogging\fR\fR\fI = \fR\fIsyslog@1 file\fR\fI \fR
7417 .RE
7418
7419 debuglevel
7420 .PP
7421 .RS 4
7422 This parameter is a synonym for
7423 log level\&.
7424 .RE
7425
7426 log level (G)
7427 .PP
7428 .RS 4
7429 The value of the parameter (a string) allows the debug level (logging level) to be specified in the
7430 smb\&.conf
7431 file\&.
7432 .sp
7433 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:
7434 .RS
7435 .sp
7436 .RS 4
7437 .ie n \{\
7438 \h'-04'\(bu\h'+03'\c
7439 .\}
7440 .el \{\
7441 .sp -1
7442 .IP \(bu 2.3
7443 .\}
7444 \fIall\fR
7445 .RE
7446 .sp
7447 .RS 4
7448 .ie n \{\
7449 \h'-04'\(bu\h'+03'\c
7450 .\}
7451 .el \{\
7452 .sp -1
7453 .IP \(bu 2.3
7454 .\}
7455 \fItdb\fR
7456 .RE
7457 .sp
7458 .RS 4
7459 .ie n \{\
7460 \h'-04'\(bu\h'+03'\c
7461 .\}
7462 .el \{\
7463 .sp -1
7464 .IP \(bu 2.3
7465 .\}
7466 \fIprintdrivers\fR
7467 .RE
7468 .sp
7469 .RS 4
7470 .ie n \{\
7471 \h'-04'\(bu\h'+03'\c
7472 .\}
7473 .el \{\
7474 .sp -1
7475 .IP \(bu 2.3
7476 .\}
7477 \fIlanman\fR
7478 .RE
7479 .sp
7480 .RS 4
7481 .ie n \{\
7482 \h'-04'\(bu\h'+03'\c
7483 .\}
7484 .el \{\
7485 .sp -1
7486 .IP \(bu 2.3
7487 .\}
7488 \fIsmb\fR
7489 .RE
7490 .sp
7491 .RS 4
7492 .ie n \{\
7493 \h'-04'\(bu\h'+03'\c
7494 .\}
7495 .el \{\
7496 .sp -1
7497 .IP \(bu 2.3
7498 .\}
7499 \fIrpc_parse\fR
7500 .RE
7501 .sp
7502 .RS 4
7503 .ie n \{\
7504 \h'-04'\(bu\h'+03'\c
7505 .\}
7506 .el \{\
7507 .sp -1
7508 .IP \(bu 2.3
7509 .\}
7510 \fIrpc_srv\fR
7511 .RE
7512 .sp
7513 .RS 4
7514 .ie n \{\
7515 \h'-04'\(bu\h'+03'\c
7516 .\}
7517 .el \{\
7518 .sp -1
7519 .IP \(bu 2.3
7520 .\}
7521 \fIrpc_cli\fR
7522 .RE
7523 .sp
7524 .RS 4
7525 .ie n \{\
7526 \h'-04'\(bu\h'+03'\c
7527 .\}
7528 .el \{\
7529 .sp -1
7530 .IP \(bu 2.3
7531 .\}
7532 \fIpassdb\fR
7533 .RE
7534 .sp
7535 .RS 4
7536 .ie n \{\
7537 \h'-04'\(bu\h'+03'\c
7538 .\}
7539 .el \{\
7540 .sp -1
7541 .IP \(bu 2.3
7542 .\}
7543 \fIsam\fR
7544 .RE
7545 .sp
7546 .RS 4
7547 .ie n \{\
7548 \h'-04'\(bu\h'+03'\c
7549 .\}
7550 .el \{\
7551 .sp -1
7552 .IP \(bu 2.3
7553 .\}
7554 \fIauth\fR
7555 .RE
7556 .sp
7557 .RS 4
7558 .ie n \{\
7559 \h'-04'\(bu\h'+03'\c
7560 .\}
7561 .el \{\
7562 .sp -1
7563 .IP \(bu 2.3
7564 .\}
7565 \fIwinbind\fR
7566 .RE
7567 .sp
7568 .RS 4
7569 .ie n \{\
7570 \h'-04'\(bu\h'+03'\c
7571 .\}
7572 .el \{\
7573 .sp -1
7574 .IP \(bu 2.3
7575 .\}
7576 \fIvfs\fR
7577 .RE
7578 .sp
7579 .RS 4
7580 .ie n \{\
7581 \h'-04'\(bu\h'+03'\c
7582 .\}
7583 .el \{\
7584 .sp -1
7585 .IP \(bu 2.3
7586 .\}
7587 \fIidmap\fR
7588 .RE
7589 .sp
7590 .RS 4
7591 .ie n \{\
7592 \h'-04'\(bu\h'+03'\c
7593 .\}
7594 .el \{\
7595 .sp -1
7596 .IP \(bu 2.3
7597 .\}
7598 \fIquota\fR
7599 .RE
7600 .sp
7601 .RS 4
7602 .ie n \{\
7603 \h'-04'\(bu\h'+03'\c
7604 .\}
7605 .el \{\
7606 .sp -1
7607 .IP \(bu 2.3
7608 .\}
7609 \fIacls\fR
7610 .RE
7611 .sp
7612 .RS 4
7613 .ie n \{\
7614 \h'-04'\(bu\h'+03'\c
7615 .\}
7616 .el \{\
7617 .sp -1
7618 .IP \(bu 2.3
7619 .\}
7620 \fIlocking\fR
7621 .RE
7622 .sp
7623 .RS 4
7624 .ie n \{\
7625 \h'-04'\(bu\h'+03'\c
7626 .\}
7627 .el \{\
7628 .sp -1
7629 .IP \(bu 2.3
7630 .\}
7631 \fImsdfs\fR
7632 .RE
7633 .sp
7634 .RS 4
7635 .ie n \{\
7636 \h'-04'\(bu\h'+03'\c
7637 .\}
7638 .el \{\
7639 .sp -1
7640 .IP \(bu 2.3
7641 .\}
7642 \fIdmapi\fR
7643 .RE
7644 .sp
7645 .RS 4
7646 .ie n \{\
7647 \h'-04'\(bu\h'+03'\c
7648 .\}
7649 .el \{\
7650 .sp -1
7651 .IP \(bu 2.3
7652 .\}
7653 \fIregistry\fR
7654 .RE
7655 .sp
7656 .RS 4
7657 .ie n \{\
7658 \h'-04'\(bu\h'+03'\c
7659 .\}
7660 .el \{\
7661 .sp -1
7662 .IP \(bu 2.3
7663 .\}
7664 \fIscavenger\fR
7665 .RE
7666 .sp
7667 .RS 4
7668 .ie n \{\
7669 \h'-04'\(bu\h'+03'\c
7670 .\}
7671 .el \{\
7672 .sp -1
7673 .IP \(bu 2.3
7674 .\}
7675 \fIdns\fR
7676 .RE
7677 .sp
7678 .RS 4
7679 .ie n \{\
7680 \h'-04'\(bu\h'+03'\c
7681 .\}
7682 .el \{\
7683 .sp -1
7684 .IP \(bu 2.3
7685 .\}
7686 \fIldb\fR
7687 .RE
7688 .sp
7689 .RS 4
7690 .ie n \{\
7691 \h'-04'\(bu\h'+03'\c
7692 .\}
7693 .el \{\
7694 .sp -1
7695 .IP \(bu 2.3
7696 .\}
7697 \fItevent\fR
7698 .RE
7699 .sp
7700 .RS 4
7701 .ie n \{\
7702 \h'-04'\(bu\h'+03'\c
7703 .\}
7704 .el \{\
7705 .sp -1
7706 .IP \(bu 2.3
7707 .\}
7708 \fIauth_audit\fR
7709 .RE
7710 .sp
7711 .RS 4
7712 .ie n \{\
7713 \h'-04'\(bu\h'+03'\c
7714 .\}
7715 .el \{\
7716 .sp -1
7717 .IP \(bu 2.3
7718 .\}
7719 \fIauth_json_audit\fR
7720 .RE
7721 .sp
7722 .RS 4
7723 .ie n \{\
7724 \h'-04'\(bu\h'+03'\c
7725 .\}
7726 .el \{\
7727 .sp -1
7728 .IP \(bu 2.3
7729 .\}
7730 \fIkerberos\fR
7731 .RE
7732 .sp
7733 .RS 4
7734 .ie n \{\
7735 \h'-04'\(bu\h'+03'\c
7736 .\}
7737 .el \{\
7738 .sp -1
7739 .IP \(bu 2.3
7740 .\}
7741 \fIdrs_repl\fR
7742 .RE
7743 .sp
7744 .RS 4
7745 .ie n \{\
7746 \h'-04'\(bu\h'+03'\c
7747 .\}
7748 .el \{\
7749 .sp -1
7750 .IP \(bu 2.3
7751 .\}
7752 \fIsmb2\fR
7753 .RE
7754 .sp
7755 .RS 4
7756 .ie n \{\
7757 \h'-04'\(bu\h'+03'\c
7758 .\}
7759 .el \{\
7760 .sp -1
7761 .IP \(bu 2.3
7762 .\}
7763 \fIsmb2_credits\fR
7764 .RE
7765 .sp
7766 .RS 4
7767 .ie n \{\
7768 \h'-04'\(bu\h'+03'\c
7769 .\}
7770 .el \{\
7771 .sp -1
7772 .IP \(bu 2.3
7773 .\}
7774 \fIdsdb_audit\fR
7775 .RE
7776 .sp
7777 .RS 4
7778 .ie n \{\
7779 \h'-04'\(bu\h'+03'\c
7780 .\}
7781 .el \{\
7782 .sp -1
7783 .IP \(bu 2.3
7784 .\}
7785 \fIdsdb_json_audit\fR
7786 .RE
7787 .sp
7788 .RS 4
7789 .ie n \{\
7790 \h'-04'\(bu\h'+03'\c
7791 .\}
7792 .el \{\
7793 .sp -1
7794 .IP \(bu 2.3
7795 .\}
7796 \fIdsdb_password_audit\fR
7797 .RE
7798 .sp
7799 .RS 4
7800 .ie n \{\
7801 \h'-04'\(bu\h'+03'\c
7802 .\}
7803 .el \{\
7804 .sp -1
7805 .IP \(bu 2.3
7806 .\}
7807 \fIdsdb_password_json_audit\fR
7808 .RE
7809 .sp
7810 .RS 4
7811 .ie n \{\
7812 \h'-04'\(bu\h'+03'\c
7813 .\}
7814 .el \{\
7815 .sp -1
7816 .IP \(bu 2.3
7817 .\}
7818 \fIdsdb_transaction_audit\fR
7819 .RE
7820 .sp
7821 .RS 4
7822 .ie n \{\
7823 \h'-04'\(bu\h'+03'\c
7824 .\}
7825 .el \{\
7826 .sp -1
7827 .IP \(bu 2.3
7828 .\}
7829 \fIdsdb_transaction_json_audit\fR
7830 .RE
7831 .sp
7832 .RS 4
7833 .ie n \{\
7834 \h'-04'\(bu\h'+03'\c
7835 .\}
7836 .el \{\
7837 .sp -1
7838 .IP \(bu 2.3
7839 .\}
7840 \fIdsdb_group_audit\fR
7841 .RE
7842 .sp
7843 .RS 4
7844 .ie n \{\
7845 \h'-04'\(bu\h'+03'\c
7846 .\}
7847 .el \{\
7848 .sp -1
7849 .IP \(bu 2.3
7850 .\}
7851 \fIdsdb_group_json_audit\fR
7852 .RE
7853 .sp
7854 .RS 4
7855 .ie n \{\
7856 \h'-04'\(bu\h'+03'\c
7857 .\}
7858 .el \{\
7859 .sp -1
7860 .IP \(bu 2.3
7861 .\}
7862 \fIldapsrv\fR
7863 .RE
7864 .sp
7865 .RE
7866 Various modules register dynamic debug classes at first usage:
7867 .RS
7868 .sp
7869 .RS 4
7870 .ie n \{\
7871 \h'-04'\(bu\h'+03'\c
7872 .\}
7873 .el \{\
7874 .sp -1
7875 .IP \(bu 2.3
7876 .\}
7877 \fIcatia\fR
7878 .RE
7879 .sp
7880 .RS 4
7881 .ie n \{\
7882 \h'-04'\(bu\h'+03'\c
7883 .\}
7884 .el \{\
7885 .sp -1
7886 .IP \(bu 2.3
7887 .\}
7888 \fIdfs_samba4\fR
7889 .RE
7890 .sp
7891 .RS 4
7892 .ie n \{\
7893 \h'-04'\(bu\h'+03'\c
7894 .\}
7895 .el \{\
7896 .sp -1
7897 .IP \(bu 2.3
7898 .\}
7899 \fIextd_audit\fR
7900 .RE
7901 .sp
7902 .RS 4
7903 .ie n \{\
7904 \h'-04'\(bu\h'+03'\c
7905 .\}
7906 .el \{\
7907 .sp -1
7908 .IP \(bu 2.3
7909 .\}
7910 \fIfileid\fR
7911 .RE
7912 .sp
7913 .RS 4
7914 .ie n \{\
7915 \h'-04'\(bu\h'+03'\c
7916 .\}
7917 .el \{\
7918 .sp -1
7919 .IP \(bu 2.3
7920 .\}
7921 \fIfruit\fR
7922 .RE
7923 .sp
7924 .RS 4
7925 .ie n \{\
7926 \h'-04'\(bu\h'+03'\c
7927 .\}
7928 .el \{\
7929 .sp -1
7930 .IP \(bu 2.3
7931 .\}
7932 \fIfull_audit\fR
7933 .RE
7934 .sp
7935 .RS 4
7936 .ie n \{\
7937 \h'-04'\(bu\h'+03'\c
7938 .\}
7939 .el \{\
7940 .sp -1
7941 .IP \(bu 2.3
7942 .\}
7943 \fImedia_harmony\fR
7944 .RE
7945 .sp
7946 .RS 4
7947 .ie n \{\
7948 \h'-04'\(bu\h'+03'\c
7949 .\}
7950 .el \{\
7951 .sp -1
7952 .IP \(bu 2.3
7953 .\}
7954 \fIpreopen\fR
7955 .RE
7956 .sp
7957 .RS 4
7958 .ie n \{\
7959 \h'-04'\(bu\h'+03'\c
7960 .\}
7961 .el \{\
7962 .sp -1
7963 .IP \(bu 2.3
7964 .\}
7965 \fIrecycle\fR
7966 .RE
7967 .sp
7968 .RS 4
7969 .ie n \{\
7970 \h'-04'\(bu\h'+03'\c
7971 .\}
7972 .el \{\
7973 .sp -1
7974 .IP \(bu 2.3
7975 .\}
7976 \fIshadow_copy\fR
7977 .RE
7978 .sp
7979 .RS 4
7980 .ie n \{\
7981 \h'-04'\(bu\h'+03'\c
7982 .\}
7983 .el \{\
7984 .sp -1
7985 .IP \(bu 2.3
7986 .\}
7987 \fIshadow_copy\fR
7988 .RE
7989 .sp
7990 .RS 4
7991 .ie n \{\
7992 \h'-04'\(bu\h'+03'\c
7993 .\}
7994 .el \{\
7995 .sp -1
7996 .IP \(bu 2.3
7997 .\}
7998 \fIunityed_media\fR
7999 .RE
8000 .sp
8001 .RS 4
8002 .ie n \{\
8003 \h'-04'\(bu\h'+03'\c
8004 .\}
8005 .el \{\
8006 .sp -1
8007 .IP \(bu 2.3
8008 .\}
8009 \fIvirusfilter\fR
8010 .RE
8011 .sp
8012 .RE
8013 To configure the logging for specific classes to go into a different file then
8014 \m[blue]\fBlog file\fR\m[], you can append
8015 \fI@PATH\fR
8016 to the class, eg
8017 \fIlog level = 1 full_audit:1@/var/log/audit\&.log\fR\&.
8018 .sp
8019 Authentication and authorization audit information is logged under the
8020 \fIauth_audit\fR, and if Samba was not compiled with \-\-without\-json, a JSON representation is logged under
8021 \fIauth_json_audit\fR\&.
8022 .sp
8023 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\&.
8024 .sp
8025 Log levels for
8026 \fIauth_audit\fR
8027 and
8028 \fIauth_audit_json\fR
8029 are:
8030 .RS
8031 .sp
8032 .RS 4
8033 .ie n \{\
8034 \h'-04'\(bu\h'+03'\c
8035 .\}
8036 .el \{\
8037 .sp -1
8038 .IP \(bu 2.3
8039 .\}
8040 2: Authentication Failure
8041 .RE
8042 .sp
8043 .RS 4
8044 .ie n \{\
8045 \h'-04'\(bu\h'+03'\c
8046 .\}
8047 .el \{\
8048 .sp -1
8049 .IP \(bu 2.3
8050 .\}
8051 3: Authentication Success
8052 .RE
8053 .sp
8054 .RS 4
8055 .ie n \{\
8056 \h'-04'\(bu\h'+03'\c
8057 .\}
8058 .el \{\
8059 .sp -1
8060 .IP \(bu 2.3
8061 .\}
8062 4: Authorization Success
8063 .RE
8064 .sp
8065 .RS 4
8066 .ie n \{\
8067 \h'-04'\(bu\h'+03'\c
8068 .\}
8069 .el \{\
8070 .sp -1
8071 .IP \(bu 2.3
8072 .\}
8073 5: Anonymous Authentication and Authorization Success
8074 .RE
8075 .sp
8076 .RE
8077 Changes to the AD DC
8078 sam\&.ldb
8079 database are logged under the
8080 \fIdsdb_audit\fR
8081 and a JSON representation is logged under
8082 \fIdsdb_json_audit\fR\&.
8083 .sp
8084 Group membership changes to the AD DC
8085 sam\&.ldb
8086 database are logged under the
8087 \fIdsdb_group_audit\fR
8088 and a JSON representation is logged under
8089 \fIdsdb_group_json_audit\fR\&.
8090 .sp
8091 Log levels for
8092 \fIdsdb_audit\fR,
8093 \fIdsdb_json_audit\fR,
8094 \fIdsdb_group_audit\fR,
8095 \fIdsdb_group_json_audit\fR
8096 and
8097 \fIdsdb_json_audit\fR
8098 are:
8099 .RS
8100 .sp
8101 .RS 4
8102 .ie n \{\
8103 \h'-04'\(bu\h'+03'\c
8104 .\}
8105 .el \{\
8106 .sp -1
8107 .IP \(bu 2.3
8108 .\}
8109 5: Database modifications
8110 .RE
8111 .sp
8112 .RS 4
8113 .ie n \{\
8114 \h'-04'\(bu\h'+03'\c
8115 .\}
8116 .el \{\
8117 .sp -1
8118 .IP \(bu 2.3
8119 .\}
8120 5: Replicated updates from another DC
8121 .RE
8122 .sp
8123 .RE
8124 In the AD DC, password changes, password resets, and certain authentication related attribute changes are logged under
8125 \fIdsdb_password_audit\fR
8126 and a JSON representation is logged under the
8127 \fIdsdb_password_json_audit\fR\&. Password changes will also appears as authentication events via
8128 \fIauth_audit\fR
8129 and
8130 \fIauth_audit_json\fR\&.
8131 .sp
8132 Log levels for
8133 \fIdsdb_password_audit\fR
8134 and
8135 \fIdsdb_password_json_audit\fR
8136 are:
8137 .RS
8138 .sp
8139 .RS 4
8140 .ie n \{\
8141 \h'-04'\(bu\h'+03'\c
8142 .\}
8143 .el \{\
8144 .sp -1
8145 .IP \(bu 2.3
8146 .\}
8147 5: Successful password changes and resets, and authentication related attribute changes\&.
8148 .RE
8149 .sp
8150 .RE
8151 Changes to the following attributes are logged:
8152 .RS
8153 .sp
8154 .RS 4
8155 .ie n \{\
8156 \h'-04'\(bu\h'+03'\c
8157 .\}
8158 .el \{\
8159 .sp -1
8160 .IP \(bu 2.3
8161 .\}
8162 altSecurityIdentities
8163 .RE
8164 .sp
8165 .RS 4
8166 .ie n \{\
8167 \h'-04'\(bu\h'+03'\c
8168 .\}
8169 .el \{\
8170 .sp -1
8171 .IP \(bu 2.3
8172 .\}
8173 dNSHostName
8174 .RE
8175 .sp
8176 .RS 4
8177 .ie n \{\
8178 \h'-04'\(bu\h'+03'\c
8179 .\}
8180 .el \{\
8181 .sp -1
8182 .IP \(bu 2.3
8183 .\}
8184 msDS\-AdditionalDnsHostName
8185 .RE
8186 .sp
8187 .RS 4
8188 .ie n \{\
8189 \h'-04'\(bu\h'+03'\c
8190 .\}
8191 .el \{\
8192 .sp -1
8193 .IP \(bu 2.3
8194 .\}
8195 msDS\-KeyCredentialLink
8196 .RE
8197 .sp
8198 .RS 4
8199 .ie n \{\
8200 \h'-04'\(bu\h'+03'\c
8201 .\}
8202 .el \{\
8203 .sp -1
8204 .IP \(bu 2.3
8205 .\}
8206 servicePrincipalName
8207 .RE
8208 .sp
8209 .RE
8210 In the
8211 \fIdsdb_password_json_audit\fR
8212 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\&.
8213 .sp
8214 Transaction rollbacks and prepare commit failures are logged under the
8215 \fIdsdb_transaction_audit\fR
8216 and a JSON representation is logged under the
8217 \fIdsdb_transaction_json_audit\fR\&.
8218 .sp
8219 Log levels for
8220 \fIdsdb_transaction_audit\fR
8221 and
8222 \fIdsdb_transaction_json\fR
8223 are:
8224 .RS
8225 .sp
8226 .RS 4
8227 .ie n \{\
8228 \h'-04'\(bu\h'+03'\c
8229 .\}
8230 .el \{\
8231 .sp -1
8232 .IP \(bu 2.3
8233 .\}
8234 5: Transaction failure (rollback)
8235 .RE
8236 .sp
8237 .RS 4
8238 .ie n \{\
8239 \h'-04'\(bu\h'+03'\c
8240 .\}
8241 .el \{\
8242 .sp -1
8243 .IP \(bu 2.3
8244 .\}
8245 10: Transaction success (commit)
8246 .RE
8247 .sp
8248 .RE
8249 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
8250 sam\&.ldb
8251 operations that have been rolled back, and so have not actually persisted\&.
8252 .if n \{\
8253 .sp
8254 .\}
8255 .RS 4
8256 .it 1 an-trap
8257 .nr an-no-space-flag 1
8258 .nr an-break-flag 1
8259 .br
8260 .ps +1
8261 \fBWarning\fR
8262 .ps -1
8263 .br
8264 Changes to
8265 sam\&.ldb
8266 made locally by the
8267 root
8268 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\&.
8269 .sp .5v
8270 .RE
8271 Default:
8272 \fI\fIlog level\fR\fR\fI = \fR\fI0\fR\fI \fR
8273 .sp
8274 Example:
8275 \fI\fIlog level\fR\fR\fI = \fR\fI3 passdb:5 auth:10 winbind:2\fR\fI \fR
8276 .sp
8277 Example:
8278 \fI\fIlog level\fR\fR\fI = \fR\fI1 full_audit:1@/var/log/audit\&.log winbind:2\fR\fI \fR
8279 .RE
8280
8281 log nt token command (G)
8282 .PP
8283 .RS 4
8284 This option can be set to a command that will be called when new nt tokens are created\&.
8285 .sp
8286 This is only useful for development purposes\&.
8287 .sp
8288 Default:
8289 \fI\fIlog nt token command\fR\fR\fI = \fR\fI\fR\fI \fR
8290 .RE
8291
8292 logon drive (G)
8293 .PP
8294 .RS 4
8295 This parameter specifies the local path to which the home directory will be connected (see
8296 \m[blue]\fBlogon home\fR\m[]) and is only used by NT Workstations\&.
8297 .sp
8298 Note that this option is only useful if Samba is set up as a logon server\&.
8299 .sp
8300 Default:
8301 \fI\fIlogon drive\fR\fR\fI = \fR\fI\fR\fI \fR
8302 .sp
8303 Example:
8304 \fI\fIlogon drive\fR\fR\fI = \fR\fIh:\fR\fI \fR
8305 .RE
8306
8307 logon home (G)
8308 .PP
8309 .RS 4
8310 This parameter specifies the home directory location when a Win95/98 or NT Workstation logs into a Samba PDC\&. It allows you to do
8311 .sp
8312 C:\e>\fBNET USE H: /HOME\fR
8313 .sp
8314 from a command prompt, for example\&.
8315 .sp
8316 This option takes the standard substitutions, allowing you to have separate logon scripts for each user or machine\&.
8317 .sp
8318 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:
8319 .sp
8320 logon home = \e\e%N\e%U\eprofile
8321 .sp
8322 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
8323 net use /home
8324 but use the whole string when dealing with profiles\&.
8325 .sp
8326 Note that in prior versions of Samba, the
8327 \m[blue]\fBlogon path\fR\m[]
8328 was returned rather than
8329 \fIlogon home\fR\&. This broke
8330 net use /home
8331 but allowed profiles outside the home directory\&. The current implementation is correct, and can be used for profiles if you use the above trick\&.
8332 .sp
8333 Disable this feature by setting
8334 \m[blue]\fBlogon home = ""\fR\m[]
8335 \- using the empty string\&.
8336 .sp
8337 This option is only useful if Samba is set up as a logon server\&.
8338 .sp
8339 Default:
8340 \fI\fIlogon home\fR\fR\fI = \fR\fI\e\e%N\e%U\fR\fI \fR
8341 .sp
8342 Example:
8343 \fI\fIlogon home\fR\fR\fI = \fR\fI\e\eremote_smb_server\e%U\fR\fI \fR
8344 .RE
8345
8346 logon path (G)
8347 .PP
8348 .RS 4
8349 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
8350 \m[blue]\fBlogon home\fR\m[]
8351 parameter\&.
8352 .sp
8353 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",
8354 desktop,
8355 start menu,
8356 network neighborhood,
8357 programs
8358 and other folders, and their contents, are loaded and displayed on your Windows NT client\&.
8359 .sp
8360 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
8361 \fIMAN\fRdatory profile)\&.
8362 .sp
8363 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)\&.
8364 .sp
8365 This option takes the standard substitutions, allowing you to have separate logon scripts for each user or machine\&.
8366 .if n \{\
8367 .sp
8368 .\}
8369 .RS 4
8370 .it 1 an-trap
8371 .nr an-no-space-flag 1
8372 .nr an-break-flag 1
8373 .br
8374 .ps +1
8375 \fBWarning\fR
8376 .ps -1
8377 .br
8378 Do not quote the value\&. Setting this as
8379 \(lq\e\e%N\eprofile\e%U\(rq
8380 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)\&.
8381 .sp .5v
8382 .RE
8383 Note that this option is only useful if Samba is set up as a domain controller\&.
8384 .sp
8385 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\&.
8386 .sp
8387 An example of use is:
8388 .sp
8389 .if n \{\
8390 .RS 4
8391 .\}
8392 .nf
8393 logon path = \e\ePROFILESERVER\ePROFILE\e%U
8394 .fi
8395 .if n \{\
8396 .RE
8397 .\}
8398 .sp
8399 In this example the use of roaming profiles is disabled (depending also on passdb settings):
8400 .sp
8401 .if n \{\
8402 .RS 4
8403 .\}
8404 .nf
8405 logon path =
8406 .fi
8407 .if n \{\
8408 .RE
8409 .\}
8410 .sp
8411 Default:
8412 \fI\fIlogon path\fR\fR\fI = \fR\fI\e\e%N\e%U\eprofile\fR\fI \fR
8413 .RE
8414
8415 logon script (G)
8416 .PP
8417 .RS 4
8418 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\&.
8419 .sp
8420 The script must be a relative path to the
8421 \fI[netlogon]\fR
8422 service\&. If the [netlogon] service specifies a
8423 \m[blue]\fBpath\fR\m[]
8424 of
8425 /usr/local/samba/netlogon, and
8426 \m[blue]\fBlogon script = STARTUP\&.BAT\fR\m[], then the file that will be downloaded is:
8427 .sp
8428 .if n \{\
8429 .RS 4
8430 .\}
8431 .nf
8432 /usr/local/samba/netlogon/STARTUP\&.BAT
8433 .fi
8434 .if n \{\
8435 .RE
8436 .\}
8437 .sp
8438 The contents of the batch file are entirely your choice\&. A suggested command would be to add
8439 NET TIME \e\eSERVER /SET /YES, to force every machine to synchronize clocks with the same time server\&. Another use would be to add
8440 NET USE U: \e\eSERVER\eUTILS
8441 for commonly used utilities, or
8442 .sp
8443 .if n \{\
8444 .RS 4
8445 .\}
8446 .nf
8447 \fBNET USE Q: \e\eSERVER\eISO9001_QA\fR
8448 .fi
8449 .if n \{\
8450 .RE
8451 .\}
8452 .sp
8453 for example\&.
8454 .sp
8455 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\&.
8456 .sp
8457 This option takes the standard substitutions, allowing you to have separate logon scripts for each user or machine\&.
8458 .sp
8459 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
8460 scriptPath
8461 is used instead\&. For configurations where
8462 \m[blue]\fBpassdb backend = ldapsam\fR\m[]
8463 is in use, this option only defines a default value in case LDAP attribute
8464 sambaLogonScript
8465 is missing\&.
8466 .sp
8467 Default:
8468 \fI\fIlogon script\fR\fR\fI = \fR\fI\fR\fI \fR
8469 .sp
8470 Example:
8471 \fI\fIlogon script\fR\fR\fI = \fR\fIscripts\e%U\&.bat\fR\fI \fR
8472 .RE
8473
8474 log writeable files on exit (G)
8475 .PP
8476 .RS 4
8477 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\&.
8478 .sp
8479 Default:
8480 \fI\fIlog writeable files on exit\fR\fR\fI = \fR\fIno\fR\fI \fR
8481 .RE
8482
8483 lppause command (S)
8484 .PP
8485 .RS 4
8486 This parameter specifies the command to be executed on the server host in order to stop printing or spooling a specific print job\&.
8487 .sp
8488 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\&.
8489 .sp
8490 If a
8491 \fI%p\fR
8492 is given then the printer name is put in its place\&. A
8493 \fI%j\fR
8494 is replaced with the job number (an integer)\&. On HPUX (see
8495 \fIprinting=hpux \fR), if the
8496 \fI\-p%p\fR
8497 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\&.
8498 .sp
8499 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\&.
8500 .sp
8501 Currently no default value is given to this string, unless the value of the
8502 \m[blue]\fBprinting\fR\m[]
8503 parameter is
8504 \fBSYSV\fR, in which case the default is :
8505 lp \-i %p\-%j \-H hold
8506 or if the value of the
8507 \fIprinting\fR
8508 parameter is
8509 \fBSOFTQ\fR, then the default is:
8510 qstat \-s \-j%j \-h\&.
8511 .sp
8512 Default:
8513 \fI\fIlppause command\fR\fR\fI = \fR\fI # determined by printing parameter\fR\fI \fR
8514 .sp
8515 Example:
8516 \fI\fIlppause command\fR\fR\fI = \fR\fI/usr/bin/lpalt %p\-%j \-p0\fR\fI \fR
8517 .RE
8518
8519 lpq cache time (G)
8520 .PP
8521 .RS 4
8522 This controls how long lpq info will be cached for to prevent the
8523 lpq
8524 command being called too often\&. A separate cache is kept for each variation of the
8525 lpq
8526 command used by the system, so if you use different
8527 lpq
8528 commands for different users then they won\*(Aqt share cache information\&.
8529 .sp
8530 The cache files are stored in
8531 /tmp/lpq\&.xxxx
8532 where xxxx is a hash of the
8533 lpq
8534 command in use\&.
8535 .sp
8536 The default is 30 seconds, meaning that the cached results of a previous identical
8537 lpq
8538 command will be used if the cached data is less than 30 seconds old\&. A large value may be advisable if your
8539 lpq
8540 command is very slow\&.
8541 .sp
8542 A value of 0 will disable caching completely\&.
8543 .sp
8544 Default:
8545 \fI\fIlpq cache time\fR\fR\fI = \fR\fI30\fR\fI \fR
8546 .sp
8547 Example:
8548 \fI\fIlpq cache time\fR\fR\fI = \fR\fI10\fR\fI \fR
8549 .RE
8550
8551 lpq command (S)
8552 .PP
8553 .RS 4
8554 This parameter specifies the command to be executed on the server host in order to obtain
8555 lpq\-style printer status information\&.
8556 .sp
8557 This command should be a program or script which takes a printer name as its only parameter and outputs printer status information\&.
8558 .sp
8559 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
8560 \fIprinting =\fR
8561 option\&.
8562 .sp
8563 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\&.
8564 .sp
8565 If a
8566 \fI%p\fR
8567 is given then the printer name is put in its place\&. Otherwise it is placed at the end of the command\&.
8568 .sp
8569 Note that it is good practice to include the absolute path in the
8570 \fIlpq command\fR
8571 as the
8572 \fB$PATH \fR
8573 may not be available to the server\&. When compiled with the CUPS libraries, no
8574 \fIlpq command\fR
8575 is needed because smbd will make a library call to obtain the print queue listing\&.
8576 .sp
8577 Default:
8578 \fI\fIlpq command\fR\fR\fI = \fR\fI # determined by printing parameter\fR\fI \fR
8579 .sp
8580 Example:
8581 \fI\fIlpq command\fR\fR\fI = \fR\fI/usr/bin/lpq \-P%p\fR\fI \fR
8582 .RE
8583
8584 lpresume command (S)
8585 .PP
8586 .RS 4
8587 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\&.
8588 .sp
8589 This command should be a program or script which takes a printer name and job number to resume the print job\&. See also the
8590 \m[blue]\fBlppause command\fR\m[]
8591 parameter\&.
8592 .sp
8593 If a
8594 \fI%p\fR
8595 is given then the printer name is put in its place\&. A
8596 \fI%j\fR
8597 is replaced with the job number (an integer)\&.
8598 .sp
8599 Note that it is good practice to include the absolute path in the
8600 \fIlpresume command\fR
8601 as the PATH may not be available to the server\&.
8602 .sp
8603 See also the
8604 \m[blue]\fBprinting\fR\m[]
8605 parameter\&.
8606 .sp
8607 Default: Currently no default value is given to this string, unless the value of the
8608 \fIprinting\fR
8609 parameter is
8610 \fBSYSV\fR, in which case the default is:
8611 .sp
8612 lp \-i %p\-%j \-H resume
8613 .sp
8614 or if the value of the
8615 \fIprinting\fR
8616 parameter is
8617 \fBSOFTQ\fR, then the default is:
8618 .sp
8619 qstat \-s \-j%j \-r
8620 .sp
8621 Default:
8622 \fI\fIlpresume command\fR\fR\fI = \fR\fI # determined by printing parameter\fR\fI \fR
8623 .sp
8624 Example:
8625 \fI\fIlpresume command\fR\fR\fI = \fR\fI/usr/bin/lpalt %p\-%j \-p2\fR\fI \fR
8626 .RE
8627
8628 lprm command (S)
8629 .PP
8630 .RS 4
8631 This parameter specifies the command to be executed on the server host in order to delete a print job\&.
8632 .sp
8633 This command should be a program or script which takes a printer name and job number, and deletes the print job\&.
8634 .sp
8635 If a
8636 \fI%p\fR
8637 is given then the printer name is put in its place\&. A
8638 \fI%j\fR
8639 is replaced with the job number (an integer)\&.
8640 .sp
8641 Note that it is good practice to include the absolute path in the
8642 \fIlprm command\fR
8643 as the PATH may not be available to the server\&.
8644 .sp
8645 Examples of use are:
8646 .sp
8647 .if n \{\
8648 .RS 4
8649 .\}
8650 .nf
8651 lprm command = /usr/bin/lprm \-P%p %j
8652
8653 or
8654
8655 lprm command = /usr/bin/cancel %p\-%j
8656 .fi
8657 .if n \{\
8658 .RE
8659 .\}
8660 .sp
8661 Default:
8662 \fI\fIlprm command\fR\fR\fI = \fR\fI # determined by printing parameter\fR\fI \fR
8663 .RE
8664
8665 lsa over netlogon (G)
8666 .PP
8667 .RS 4
8668 Setting this deprecated option will allow the RPC server in the AD DC to answer the LSARPC interface on the
8669 \epipe\enetlogon
8670 IPC pipe\&.
8671 .sp
8672 When enabled, this matches the behaviour of Microsoft\*(Aqs Windows, due to their internal implementation choices\&.
8673 .sp
8674 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\&.
8675 .sp
8676 Default:
8677 \fI\fIlsa over netlogon\fR\fR\fI = \fR\fIno\fR\fI \fR
8678 .RE
8679
8680 machine password timeout (G)
8681 .PP
8682 .RS 4
8683 If a Samba server is a member of a Windows NT or Active Directory Domain (see the
8684 \m[blue]\fBsecurity = domain\fR\m[]
8685 and
8686 \m[blue]\fBsecurity = ads\fR\m[]
8687 parameters), then periodically a running winbindd process will try and change the MACHINE ACCOUNT PASSWORD stored in the TDB called
8688 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\&.
8689 .sp
8690 See also
8691 \fBsmbpasswd\fR(8), and the
8692 \m[blue]\fBsecurity = domain\fR\m[]
8693 and
8694 \m[blue]\fBsecurity = ads\fR\m[]
8695 parameters\&.
8696 .sp
8697 Default:
8698 \fI\fImachine password timeout\fR\fR\fI = \fR\fI604800\fR\fI \fR
8699 .RE
8700
8701 magic output (S)
8702 .PP
8703 .RS 4
8704 This parameter specifies the name of a file which will contain output created by a magic script (see the
8705 \m[blue]\fBmagic script\fR\m[]
8706 parameter below)\&.
8707 .if n \{\
8708 .sp
8709 .\}
8710 .RS 4
8711 .it 1 an-trap
8712 .nr an-no-space-flag 1
8713 .nr an-break-flag 1
8714 .br
8715 .ps +1
8716 \fBWarning\fR
8717 .ps -1
8718 .br
8719 If two clients use the same
8720 \fImagic script \fR
8721 in the same directory the output file content is undefined\&.
8722 .sp .5v
8723 .RE
8724 Default:
8725 \fI\fImagic output\fR\fR\fI = \fR\fI # <magic script name>\&.out\fR\fI \fR
8726 .sp
8727 Example:
8728 \fI\fImagic output\fR\fR\fI = \fR\fImyfile\&.txt\fR\fI \fR
8729 .RE
8730
8731 magic script (S)
8732 .PP
8733 .RS 4
8734 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\&.
8735 .sp
8736 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\&.
8737 .sp
8738 If the script generates output, output will be sent to the file specified by the
8739 \m[blue]\fBmagic output\fR\m[]
8740 parameter (see above)\&.
8741 .sp
8742 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
8743 \fIas is\fR
8744 on the host, which for some hosts and some shells will require filtering at the DOS end\&.
8745 .sp
8746 Magic scripts are
8747 \fIEXPERIMENTAL\fR
8748 and should
8749 \fINOT\fR
8750 be relied upon\&.
8751 .sp
8752 Default:
8753 \fI\fImagic script\fR\fR\fI = \fR\fI\fR\fI \fR
8754 .sp
8755 Example:
8756 \fI\fImagic script\fR\fR\fI = \fR\fIuser\&.csh\fR\fI \fR
8757 .RE
8758
8759 mangled names (S)
8760 .PP
8761 .RS 4
8762 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\&.
8763 .sp
8764 See the section on
8765 name mangling
8766 for details on how to control the mangling process\&.
8767 .sp
8768 Possible option settings are
8769 .RS
8770 .sp
8771 .RS 4
8772 .ie n \{\
8773 \h'-04'\(bu\h'+03'\c
8774 .\}
8775 .el \{\
8776 .sp -1
8777 .IP \(bu 2.3
8778 .\}
8779 \fIyes\fR
8780 \- enables name mangling for all not DOS 8\&.3 conforming names\&.
8781 .RE
8782 .sp
8783 .RS 4
8784 .ie n \{\
8785 \h'-04'\(bu\h'+03'\c
8786 .\}
8787 .el \{\
8788 .sp -1
8789 .IP \(bu 2.3
8790 .\}
8791 \fIno\fR
8792 \- disables any name mangling\&.
8793 .RE
8794 .sp
8795 .RS 4
8796 .ie n \{\
8797 \h'-04'\(bu\h'+03'\c
8798 .\}
8799 .el \{\
8800 .sp -1
8801 .IP \(bu 2.3
8802 .\}
8803 \fIillegal (default)\fR
8804 \- does mangling for names with illegal NTFS characters\&. This is the most sensible setting for modern clients that don\*(Aqt use the shortname anymore\&.
8805 .RE
8806 .sp
8807 .RE
8808 If mangling is used then the mangling method is as follows:
8809 .RS
8810 .sp
8811 .RS 4
8812 .ie n \{\
8813 \h'-04'\(bu\h'+03'\c
8814 .\}
8815 .el \{\
8816 .sp -1
8817 .IP \(bu 2.3
8818 .\}
8819 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\&.
8820 .RE
8821 .sp
8822 .RS 4
8823 .ie n \{\
8824 \h'-04'\(bu\h'+03'\c
8825 .\}
8826 .el \{\
8827 .sp -1
8828 .IP \(bu 2.3
8829 .\}
8830 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\&.
8831 .sp
8832 Note that the character to use may be specified using the
8833 \m[blue]\fBmangling char\fR\m[]
8834 option, if you don\*(Aqt like \*(Aq~\*(Aq\&.
8835 .RE
8836 .sp
8837 .RS 4
8838 .ie n \{\
8839 \h'-04'\(bu\h'+03'\c
8840 .\}
8841 .el \{\
8842 .sp -1
8843 .IP \(bu 2.3
8844 .\}
8845 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)\&.
8846 .RE
8847 .sp
8848 .RE
8849 The two\-digit hash value consists of upper case alphanumeric characters\&.
8850 .sp
8851 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\&.
8852 .sp
8853 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\&.
8854 .sp
8855 Default:
8856 \fI\fImangled names\fR\fR\fI = \fR\fIillegal\fR\fI \fR
8857 .sp
8858 Example:
8859 \fI\fImangled names\fR\fR\fI = \fR\fIno\fR\fI \fR
8860 .RE
8861
8862 mangle prefix (G)
8863 .PP
8864 .RS 4
8865 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\&.
8866 .sp
8867 mangle prefix is effective only when mangling method is hash2\&.
8868 .sp
8869 Default:
8870 \fI\fImangle prefix\fR\fR\fI = \fR\fI1\fR\fI \fR
8871 .sp
8872 Example:
8873 \fI\fImangle prefix\fR\fR\fI = \fR\fI4\fR\fI \fR
8874 .RE
8875
8876 mangling char (S)
8877 .PP
8878 .RS 4
8879 This controls what character is used as the
8880 \fImagic\fR
8881 character in
8882 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\&.
8883 .sp
8884 Default:
8885 \fI\fImangling char\fR\fR\fI = \fR\fI~\fR\fI \fR
8886 .sp
8887 Example:
8888 \fI\fImangling char\fR\fR\fI = \fR\fI^\fR\fI \fR
8889 .RE
8890
8891 mangling method (G)
8892 .PP
8893 .RS 4
8894 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\&.
8895 .sp
8896 Default:
8897 \fI\fImangling method\fR\fR\fI = \fR\fIhash2\fR\fI \fR
8898 .sp
8899 Example:
8900 \fI\fImangling method\fR\fR\fI = \fR\fIhash\fR\fI \fR
8901 .RE
8902
8903 map acl inherit (S)
8904 .PP
8905 .RS 4
8906 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
8907 \fBsmbd\fR(8)
8908 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\&.
8909 .sp
8910 Default:
8911 \fI\fImap acl inherit\fR\fR\fI = \fR\fIno\fR\fI \fR
8912 .RE
8913
8914 map archive (S)
8915 .PP
8916 .RS 4
8917 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\&.\&.\&.
8918 .sp
8919 Note that this parameter will be ignored if the
8920 \m[blue]\fBstore dos attributes\fR\m[]
8921 parameter is set, as the DOS archive attribute will then be stored inside a UNIX extended attribute\&.
8922 .sp
8923 Note that this requires the
8924 \m[blue]\fBcreate mask\fR\m[]
8925 parameter to be set such that owner execute bit is not masked out (i\&.e\&. it must include 100)\&. See the parameter
8926 \m[blue]\fBcreate mask\fR\m[]
8927 for details\&.
8928 .sp
8929 Default:
8930 \fI\fImap archive\fR\fR\fI = \fR\fIyes\fR\fI \fR
8931 .RE
8932
8933 map hidden (S)
8934 .PP
8935 .RS 4
8936 This controls whether DOS style hidden files should be mapped to the UNIX world execute bit\&.
8937 .sp
8938 Note that this parameter will be ignored if the
8939 \m[blue]\fBstore dos attributes\fR\m[]
8940 parameter is set, as the DOS hidden attribute will then be stored inside a UNIX extended attribute\&.
8941 .sp
8942 Note that this requires the
8943 \m[blue]\fBcreate mask\fR\m[]
8944 to be set such that the world execute bit is not masked out (i\&.e\&. it must include 001)\&. See the parameter
8945 \m[blue]\fBcreate mask\fR\m[]
8946 for details\&.
8947 .sp
8948 Default:
8949 \fI\fImap hidden\fR\fR\fI = \fR\fIno\fR\fI \fR
8950 .RE
8951
8952 map readonly (S)
8953 .PP
8954 .RS 4
8955 This controls how the DOS read only attribute should be mapped from a UNIX filesystem\&.
8956 .sp
8957 This parameter can take three different values, which tell
8958 \fBsmbd\fR(8)
8959 how to display the read only attribute on files, where either
8960 \m[blue]\fBstore dos attributes\fR\m[]
8961 is set to
8962 \fBNo\fR, or no extended attribute is present\&. If
8963 \m[blue]\fBstore dos attributes\fR\m[]
8964 is set to
8965 \fByes\fR
8966 then this parameter is
8967 \fIignored\fR\&. This is a new parameter introduced in Samba version 3\&.0\&.21\&.
8968 .sp
8969 The three settings are :
8970 .RS
8971 .sp
8972 .RS 4
8973 .ie n \{\
8974 \h'-04'\(bu\h'+03'\c
8975 .\}
8976 .el \{\
8977 .sp -1
8978 .IP \(bu 2.3
8979 .\}
8980 \fBYes\fR
8981 \- 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\&.
8982 .RE
8983 .sp
8984 .RS 4
8985 .ie n \{\
8986 \h'-04'\(bu\h'+03'\c
8987 .\}
8988 .el \{\
8989 .sp -1
8990 .IP \(bu 2.3
8991 .\}
8992 \fBPermissions\fR
8993 \- The read only DOS attribute is mapped to the effective permissions of the connecting user, as evaluated by
8994 \fBsmbd\fR(8)
8995 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\&.
8996 .RE
8997 .sp
8998 .RS 4
8999 .ie n \{\
9000 \h'-04'\(bu\h'+03'\c
9001 .\}
9002 .el \{\
9003 .sp -1
9004 .IP \(bu 2.3
9005 .\}
9006 \fBNo\fR
9007 \- The read only DOS attribute is unaffected by permissions, and can only be set by the
9008 \m[blue]\fBstore dos attributes\fR\m[]
9009 method\&. This may be useful for exporting mounted CDs\&.
9010 .RE
9011 .sp
9012 .RE
9013 Note that this parameter will be ignored if the
9014 \m[blue]\fBstore dos attributes\fR\m[]
9015 parameter is set, as the DOS \*(Aqread\-only\*(Aq attribute will then be stored inside a UNIX extended attribute\&.
9016 .sp
9017 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
9018 \m[blue]\fBstore dos attributes\fR\m[]
9019 has been changed to
9020 \fBYes\fR
9021 in Samba release 4\&.9\&.0 and above\&.
9022 .sp
9023 Default:
9024 \fI\fImap readonly\fR\fR\fI = \fR\fIno\fR\fI \fR
9025 .RE
9026
9027 map system (S)
9028 .PP
9029 .RS 4
9030 This controls whether DOS style system files should be mapped to the UNIX group execute bit\&.
9031 .sp
9032 Note that this parameter will be ignored if the
9033 \m[blue]\fBstore dos attributes\fR\m[]
9034 parameter is set, as the DOS system attribute will then be stored inside a UNIX extended attribute\&.
9035 .sp
9036 Note that this requires the
9037 \m[blue]\fBcreate mask\fR\m[]
9038 to be set such that the group execute bit is not masked out (i\&.e\&. it must include 010)\&. See the parameter
9039 \m[blue]\fBcreate mask\fR\m[]
9040 for details\&.
9041 .sp
9042 Default:
9043 \fI\fImap system\fR\fR\fI = \fR\fIno\fR\fI \fR
9044 .RE
9045
9046 map to guest (G)
9047 .PP
9048 .RS 4
9049 This parameter can take four different values, which tell
9050 \fBsmbd\fR(8)
9051 what to do with user login requests that don\*(Aqt match a valid UNIX user in some way\&.
9052 .sp
9053 The four settings are :
9054 .RS
9055 .sp
9056 .RS 4
9057 .ie n \{\
9058 \h'-04'\(bu\h'+03'\c
9059 .\}
9060 .el \{\
9061 .sp -1
9062 .IP \(bu 2.3
9063 .\}
9064 \fBNever\fR
9065 \- Means user login requests with an invalid password are rejected\&. This is the default\&.
9066 .RE
9067 .sp
9068 .RS 4
9069 .ie n \{\
9070 \h'-04'\(bu\h'+03'\c
9071 .\}
9072 .el \{\
9073 .sp -1
9074 .IP \(bu 2.3
9075 .\}
9076 \fBBad User\fR
9077 \- 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
9078 \m[blue]\fBguest account\fR\m[]\&.
9079 .RE
9080 .sp
9081 .RS 4
9082 .ie n \{\
9083 \h'-04'\(bu\h'+03'\c
9084 .\}
9085 .el \{\
9086 .sp -1
9087 .IP \(bu 2.3
9088 .\}
9089 \fBBad Password\fR
9090 \- Means user logins with an invalid password are treated as a guest login and mapped into the
9091 \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
9092 \fIhate\fR
9093 you if you set the
9094 \fImap to guest\fR
9095 parameter this way :\-)\&.
9096 .RE
9097 .sp
9098 .RS 4
9099 .ie n \{\
9100 \h'-04'\(bu\h'+03'\c
9101 .\}
9102 .el \{\
9103 .sp -1
9104 .IP \(bu 2.3
9105 .\}
9106 \fBBad Uid\fR
9107 \- 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\&.
9108 .RE
9109 .sp
9110 .RE
9111 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
9112 \fInot\fR
9113 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\&.
9114 .sp
9115 Default:
9116 \fI\fImap to guest\fR\fR\fI = \fR\fINever\fR\fI \fR
9117 .sp
9118 Example:
9119 \fI\fImap to guest\fR\fR\fI = \fR\fIBad User\fR\fI \fR
9120 .RE
9121
9122 max connections (S)
9123 .PP
9124 .RS 4
9125 This option allows the number of simultaneous connections to a service to be limited\&. If
9126 \fImax connections\fR
9127 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\&.
9128 .sp
9129 Record lock files are used to implement this feature\&. The lock files will be stored in the directory specified by the
9130 \m[blue]\fBlock directory\fR\m[]
9131 option\&.
9132 .sp
9133 Default:
9134 \fI\fImax connections\fR\fR\fI = \fR\fI0\fR\fI \fR
9135 .sp
9136 Example:
9137 \fI\fImax connections\fR\fR\fI = \fR\fI10\fR\fI \fR
9138 .RE
9139
9140 max disk size (G)
9141 .PP
9142 .RS 4
9143 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\&.
9144 .sp
9145 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
9146 \fImax disk size\fR\&.
9147 .sp
9148 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\&.
9149 .sp
9150 A
9151 \fImax disk size\fR
9152 of 0 means no limit\&.
9153 .sp
9154 Default:
9155 \fI\fImax disk size\fR\fR\fI = \fR\fI0\fR\fI \fR
9156 .sp
9157 Example:
9158 \fI\fImax disk size\fR\fR\fI = \fR\fI1000\fR\fI \fR
9159 .RE
9160
9161 max log size (G)
9162 .PP
9163 .RS 4
9164 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
9165 \&.old
9166 extension\&.
9167 .sp
9168 A size of 0 means no limit\&.
9169 .sp
9170 Default:
9171 \fI\fImax log size\fR\fR\fI = \fR\fI5000\fR\fI \fR
9172 .sp
9173 Example:
9174 \fI\fImax log size\fR\fR\fI = \fR\fI1000\fR\fI \fR
9175 .RE
9176
9177 max mux (G)
9178 .PP
9179 .RS 4
9180 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\&.
9181 .sp
9182 Default:
9183 \fI\fImax mux\fR\fR\fI = \fR\fI50\fR\fI \fR
9184 .RE
9185
9186 max open files (G)
9187 .PP
9188 .RS 4
9189 This parameter limits the maximum number of open files that one
9190 \fBsmbd\fR(8)
9191 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\&.
9192 .sp
9193 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\&.
9194 .sp
9195 Default:
9196 \fI\fImax open files\fR\fR\fI = \fR\fI16384\fR\fI \fR
9197 .RE
9198
9199 max print jobs (S)
9200 .PP
9201 .RS 4
9202 This parameter limits the maximum number of jobs allowable in a Samba printer queue at any given moment\&. If this number is exceeded,
9203 \fBsmbd\fR(8)
9204 will remote "Out of Space" to the client\&.
9205 .sp
9206 Default:
9207 \fI\fImax print jobs\fR\fR\fI = \fR\fI1000\fR\fI \fR
9208 .sp
9209 Example:
9210 \fI\fImax print jobs\fR\fR\fI = \fR\fI5000\fR\fI \fR
9211 .RE
9212
9213 max reported print jobs (S)
9214 .PP
9215 .RS 4
9216 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\&.
9217 .sp
9218 Default:
9219 \fI\fImax reported print jobs\fR\fR\fI = \fR\fI0\fR\fI \fR
9220 .sp
9221 Example:
9222 \fI\fImax reported print jobs\fR\fR\fI = \fR\fI1000\fR\fI \fR
9223 .RE
9224
9225 max smbd processes (G)
9226 .PP
9227 .RS 4
9228 This parameter limits the maximum number of
9229 \fBsmbd\fR(8)
9230 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
9231 \fBsmbd\fR(8)
9232 associated with him or her to handle connections to all shares from a given host\&.
9233 .sp
9234 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\&.
9235 .sp
9236 Default:
9237 \fI\fImax smbd processes\fR\fR\fI = \fR\fI0\fR\fI \fR
9238 .sp
9239 Example:
9240 \fI\fImax smbd processes\fR\fR\fI = \fR\fI1000\fR\fI \fR
9241 .RE
9242
9243 max stat cache size (G)
9244 .PP
9245 .RS 4
9246 This parameter limits the size in memory of any
9247 \fIstat cache\fR
9248 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\&.
9249 .sp
9250 Default:
9251 \fI\fImax stat cache size\fR\fR\fI = \fR\fI512\fR\fI \fR
9252 .sp
9253 Example:
9254 \fI\fImax stat cache size\fR\fR\fI = \fR\fI100\fR\fI \fR
9255 .RE
9256
9257 max ttl (G)
9258 .PP
9259 .RS 4
9260 This option tells
9261 \fBnmbd\fR(8)
9262 what the default \*(Aqtime to live\*(Aq of NetBIOS names should be (in seconds) when
9263 nmbd
9264 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\&.
9265 .sp
9266 Default:
9267 \fI\fImax ttl\fR\fR\fI = \fR\fI259200\fR\fI \fR
9268 .RE
9269
9270 max wins ttl (G)
9271 .PP
9272 .RS 4
9273 This option tells
9274 \fBsmbd\fR(8)
9275 when acting as a WINS server (\m[blue]\fBwins support = yes\fR\m[]) what the maximum \*(Aqtime to live\*(Aq of NetBIOS names that
9276 nmbd
9277 will grant will be (in seconds)\&. You should never need to change this parameter\&. The default is 6 days (518400 seconds)\&.
9278 .sp
9279 Default:
9280 \fI\fImax wins ttl\fR\fR\fI = \fR\fI518400\fR\fI \fR
9281 .RE
9282
9283 max xmit (G)
9284 .PP
9285 .RS 4
9286 This option controls the maximum packet size that will be negotiated by Samba\*(Aqs
9287 \fBsmbd\fR(8)
9288 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\&.
9289 .sp
9290 Default:
9291 \fI\fImax xmit\fR\fR\fI = \fR\fI16644\fR\fI \fR
9292 .sp
9293 Example:
9294 \fI\fImax xmit\fR\fR\fI = \fR\fI8192\fR\fI \fR
9295 .RE
9296
9297 mdns name (G)
9298 .PP
9299 .RS 4
9300 This parameter controls the name that multicast DNS support advertises as its\*(Aq hostname\&.
9301 .sp
9302 The default is to use the NETBIOS name which is typically the hostname in all capital letters\&.
9303 .sp
9304 A setting of mdns will defer the hostname configuration to the MDNS library that is used\&.
9305 .sp
9306 Default:
9307 \fI\fImdns name\fR\fR\fI = \fR\fInetbios\fR\fI \fR
9308 .RE
9309
9310 message command (G)
9311 .PP
9312 .RS 4
9313 This specifies what command to run when the server receives a WinPopup style message\&.
9314 .sp
9315 This would normally be a command that would deliver the message somehow\&. How this is to be done is up to your imagination\&.
9316 .sp
9317 An example is:
9318 .sp
9319 .if n \{\
9320 .RS 4
9321 .\}
9322 .nf
9323 message command = csh \-c \*(Aqxedit %s;rm %s\*(Aq &
9324 .fi
9325 .if n \{\
9326 .RE
9327 .\}
9328 .sp
9329 This delivers the message using
9330 xedit, then removes it afterwards\&.
9331 \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)\&.
9332 .sp
9333 All messages are delivered as the global guest user\&. The command takes the standard substitutions, although
9334 \fI %u\fR
9335 won\*(Aqt work (\fI%U\fR
9336 may be better in this case)\&.
9337 .sp
9338 Apart from the standard substitutions, some additional ones apply\&. In particular:
9339 .RS
9340 .sp
9341 .RS 4
9342 .ie n \{\
9343 \h'-04'\(bu\h'+03'\c
9344 .\}
9345 .el \{\
9346 .sp -1
9347 .IP \(bu 2.3
9348 .\}
9349 \fI%s\fR
9350 = the filename containing the message\&.
9351 .RE
9352 .sp
9353 .RS 4
9354 .ie n \{\
9355 \h'-04'\(bu\h'+03'\c
9356 .\}
9357 .el \{\
9358 .sp -1
9359 .IP \(bu 2.3
9360 .\}
9361 \fI%t\fR
9362 = the destination that the message was sent to (probably the server name)\&.
9363 .RE
9364 .sp
9365 .RS 4
9366 .ie n \{\
9367 \h'-04'\(bu\h'+03'\c
9368 .\}
9369 .el \{\
9370 .sp -1
9371 .IP \(bu 2.3
9372 .\}
9373 \fI%f\fR
9374 = who the message is from\&.
9375 .RE
9376 .sp
9377 .RE
9378 You could make this command send mail, or whatever else takes your fancy\&. Please let us know of any really interesting ideas you have\&.
9379 .sp
9380 Here\*(Aqs a way of sending the messages as mail to root:
9381 .sp
9382 .if n \{\
9383 .RS 4
9384 .\}
9385 .nf
9386 message command = /bin/mail \-s \*(Aqmessage from %f on %m\*(Aq root < %s; rm %s
9387 .fi
9388 .if n \{\
9389 .RE
9390 .\}
9391 .sp
9392 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\&.
9393 .sp
9394 If you want to silently delete it then try:
9395 .sp
9396 .if n \{\
9397 .RS 4
9398 .\}
9399 .nf
9400 message command = rm %s
9401 .fi
9402 .if n \{\
9403 .RE
9404 .\}
9405 .sp
9406 Default:
9407 \fI\fImessage command\fR\fR\fI = \fR\fI\fR\fI \fR
9408 .sp
9409 Example:
9410 \fI\fImessage command\fR\fR\fI = \fR\fIcsh \-c \*(Aqxedit %s; rm %s\*(Aq &\fR\fI \fR
9411 .RE
9412
9413 min domain uid (G)
9414 .PP
9415 .RS 4
9416 The integer parameter specifies the minimum uid allowed when mapping a local account to a domain account\&.
9417 .sp
9418 Note that this option interacts with the configured
9419 \fIidmap ranges\fR!
9420 .sp
9421 Default:
9422 \fI\fImin domain uid\fR\fR\fI = \fR\fI1000\fR\fI \fR
9423 .RE
9424
9425 min print space (S)
9426 .PP
9427 .RS 4
9428 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\&.
9429 .sp
9430 Default:
9431 \fI\fImin print space\fR\fR\fI = \fR\fI0\fR\fI \fR
9432 .sp
9433 Example:
9434 \fI\fImin print space\fR\fR\fI = \fR\fI2000\fR\fI \fR
9435 .RE
9436
9437 min receivefile size (G)
9438 .PP
9439 .RS 4
9440 This option changes the behavior of
9441 \fBsmbd\fR(8)
9442 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\&.
9443 .sp
9444 Note this option will have NO EFFECT if set on a SMB signed connection\&.
9445 .sp
9446 The default is zero, which disables this option\&.
9447 .sp
9448 Default:
9449 \fI\fImin receivefile size\fR\fR\fI = \fR\fI0\fR\fI \fR
9450 .RE
9451
9452 min wins ttl (G)
9453 .PP
9454 .RS 4
9455 This option tells
9456 \fBnmbd\fR(8)
9457 when acting as a WINS server (\m[blue]\fBwins support = yes\fR\m[]) what the minimum \*(Aqtime to live\*(Aq of NetBIOS names that
9458 nmbd
9459 will grant will be (in seconds)\&. You should never need to change this parameter\&. The default is 6 hours (21600 seconds)\&.
9460 .sp
9461 Default:
9462 \fI\fImin wins ttl\fR\fR\fI = \fR\fI21600\fR\fI \fR
9463 .RE
9464
9465 mit kdc command (G)
9466 .PP
9467 .RS 4
9468 This option specifies the path to the MIT kdc binary\&.
9469 .sp
9470 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\&.
9471 .sp
9472 Default:
9473 \fI\fImit kdc command\fR\fR\fI = \fR\fI\fR\fI \fR
9474 .sp
9475 Example:
9476 \fI\fImit kdc command\fR\fR\fI = \fR\fI/opt/mit/sbin/krb5kdc\fR\fI \fR
9477 .RE
9478
9479 msdfs proxy (S)
9480 .PP
9481 .RS 4
9482 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\&.
9483 .sp
9484 Only Dfs roots can act as proxy shares\&. Take a look at the
9485 \m[blue]\fBmsdfs root\fR\m[]
9486 and
9487 \m[blue]\fBhost msdfs\fR\m[]
9488 options to find out how to set up a Dfs root share\&.
9489 .sp
9490 \fINo default\fR
9491 .sp
9492 Example:
9493 \fI\fImsdfs proxy\fR\fR\fI = \fR\fI\eotherserver\esomeshare,\eotherserver2\esomeshare\fR\fI \fR
9494 .RE
9495
9496 msdfs root (S)
9497 .PP
9498 .RS 4
9499 If set to
9500 \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
9501 msdfs:serverA\e\eshareA,serverB\e\eshareB
9502 and so on\&. For more information on setting up a Dfs tree on Samba, refer to the MSDFS chapter in the Samba3\-HOWTO book\&.
9503 .sp
9504 Default:
9505 \fI\fImsdfs root\fR\fR\fI = \fR\fIno\fR\fI \fR
9506 .RE
9507
9508 msdfs shuffle referrals (S)
9509 .PP
9510 .RS 4
9511 If set to
9512 \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\&.
9513 .sp
9514 Default:
9515 \fI\fImsdfs shuffle referrals\fR\fR\fI = \fR\fIno\fR\fI \fR
9516 .RE
9517
9518 multicast dns register (G)
9519 .PP
9520 .RS 4
9521 If compiled with proper support for it, Samba will announce itself with multicast DNS services like for example provided by the Avahi daemon\&.
9522 .sp
9523 This parameter allows disabling Samba to register itself\&.
9524 .sp
9525 Default:
9526 \fI\fImulticast dns register\fR\fR\fI = \fR\fIyes\fR\fI \fR
9527 .RE
9528
9529 name cache timeout (G)
9530 .PP
9531 .RS 4
9532 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\&.
9533 .sp
9534 Default:
9535 \fI\fIname cache timeout\fR\fR\fI = \fR\fI660\fR\fI \fR
9536 .sp
9537 Example:
9538 \fI\fIname cache timeout\fR\fR\fI = \fR\fI0\fR\fI \fR
9539 .RE
9540
9541 name resolve order (G)
9542 .PP
9543 .RS 4
9544 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\&.
9545 .sp
9546 The options are: "lmhosts", "host", "wins" and "bcast"\&. They cause names to be resolved as follows:
9547 .RS
9548 .sp
9549 .RS 4
9550 .ie n \{\
9551 \h'-04'\(bu\h'+03'\c
9552 .\}
9553 .el \{\
9554 .sp -1
9555 .IP \(bu 2.3
9556 .\}
9557 \fBlmhosts\fR
9558 : 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\&.
9559 .RE
9560 .sp
9561 .RS 4
9562 .ie n \{\
9563 \h'-04'\(bu\h'+03'\c
9564 .\}
9565 .el \{\
9566 .sp -1
9567 .IP \(bu 2.3
9568 .\}
9569 \fBhost\fR
9570 : Do a standard host name to IP address resolution, using the system
9571 /etc/hosts
9572 or DNS lookups\&. This method of name resolution is operating system depended for instance on IRIX or Solaris this may be controlled by the
9573 /etc/nsswitch\&.conf
9574 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\&.
9575 .RE
9576 .sp
9577 .RS 4
9578 .ie n \{\
9579 \h'-04'\(bu\h'+03'\c
9580 .\}
9581 .el \{\
9582 .sp -1
9583 .IP \(bu 2.3
9584 .\}
9585 \fBwins\fR
9586 : Query a name with the IP address listed in the
9587 \m[blue]\fBWINSSERVER\fR\m[]
9588 parameter\&. If no WINS server has been specified this method will be ignored\&.
9589 .RE
9590 .sp
9591 .RS 4
9592 .ie n \{\
9593 \h'-04'\(bu\h'+03'\c
9594 .\}
9595 .el \{\
9596 .sp -1
9597 .IP \(bu 2.3
9598 .\}
9599 \fBbcast\fR
9600 : Do a broadcast on each of the known local interfaces listed in the
9601 \m[blue]\fBinterfaces\fR\m[]
9602 parameter\&. This is the least reliable of the name resolution methods as it depends on the target host being on a locally connected subnet\&.
9603 .RE
9604 .sp
9605 .RE
9606 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\&.
9607 .sp
9608 When Samba is functioning in ADS security mode (security = ads) it is advised to use following settings for
9609 \fIname resolve order\fR:
9610 .sp
9611 name resolve order = wins bcast
9612 .sp
9613 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\&.
9614 .sp
9615 Default:
9616 \fI\fIname resolve order\fR\fR\fI = \fR\fIlmhosts wins host bcast\fR\fI \fR
9617 .sp
9618 Example:
9619 \fI\fIname resolve order\fR\fR\fI = \fR\fIlmhosts bcast host\fR\fI \fR
9620 .RE
9621
9622 socket address
9623 .PP
9624 .RS 4
9625 This parameter is a synonym for
9626 nbt client socket address\&.
9627 .RE
9628
9629 nbt client socket address (G)
9630 .PP
9631 .RS 4
9632 This option allows you to control what address Samba will send NBT client packets from, and process replies using, including in nmbd\&.
9633 .sp
9634 Setting this option should never be necessary on usual Samba servers running only one nmbd\&.
9635 .sp
9636 By default Samba will send UDP packets from the OS default address for the destination, and accept replies on 0\&.0\&.0\&.0\&.
9637 .sp
9638 This parameter is deprecated\&. See
9639 \m[blue]\fBbind interfaces only = Yes\fR\m[]
9640 and
9641 \m[blue]\fBinterfaces\fR\m[]
9642 for the previous behaviour of controlling the normal listening sockets\&.
9643 .sp
9644 Default:
9645 \fI\fInbt client socket address\fR\fR\fI = \fR\fI0\&.0\&.0\&.0\fR\fI \fR
9646 .sp
9647 Example:
9648 \fI\fInbt client socket address\fR\fR\fI = \fR\fI192\&.168\&.2\&.20\fR\fI \fR
9649 .RE
9650
9651 nbtd:wins_prepend1Bto1Cqueries (G)
9652 .PP
9653 .RS 4
9654 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)\&.
9655 .sp
9656 Default:
9657 \fI\fInbtd:wins_prepend1Bto1Cqueries\fR\fR\fI = \fR\fIyes\fR\fI \fR
9658 .RE
9659
9660 nbtd:wins_wins_randomize1Clist (G)
9661 .PP
9662 .RS 4
9663 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\&.
9664 .sp
9665 Default:
9666 \fI\fInbtd:wins_wins_randomize1Clist\fR\fR\fI = \fR\fIno\fR\fI \fR
9667 .RE
9668
9669 nbtd:wins_randomize1Clist_mask (G)
9670 .PP
9671 .RS 4
9672 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\&.
9673 .sp
9674 Default:
9675 \fI\fInbtd:wins_randomize1Clist_mask\fR\fR\fI = \fR\fI255\&.255\&.255\&.0\fR\fI \fR
9676 .RE
9677
9678 nbt port (G)
9679 .PP
9680 .RS 4
9681 Specifies which port the server should use for NetBIOS over IP name services traffic\&.
9682 .sp
9683 Default:
9684 \fI\fInbt port\fR\fR\fI = \fR\fI137\fR\fI \fR
9685 .RE
9686
9687 ncalrpc dir (G)
9688 .PP
9689 .RS 4
9690 This directory will hold a series of named pipes to allow RPC over inter\-process communication\&.
9691 .sp
9692 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
9693 .sp
9694 Default:
9695 \fI\fIncalrpc dir\fR\fR\fI = \fR\fI/run/samba/ncalrpc\fR\fI \fR
9696 .sp
9697 Example:
9698 \fI\fIncalrpc dir\fR\fR\fI = \fR\fI/var/run/samba/ncalrpc\fR\fI \fR
9699 .RE
9700
9701 netbios aliases (G)
9702 .PP
9703 .RS 4
9704 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\&.
9705 .sp
9706 Default:
9707 \fI\fInetbios aliases\fR\fR\fI = \fR\fI # empty string (no additional names)\fR\fI \fR
9708 .sp
9709 Example:
9710 \fI\fInetbios aliases\fR\fR\fI = \fR\fITEST TEST1 TEST2\fR\fI \fR
9711 .RE
9712
9713 netbios name (G)
9714 .PP
9715 .RS 4
9716 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\&.
9717 .sp
9718 Note that the maximum length for a NetBIOS name is 15 characters\&.
9719 .sp
9720 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
9721 PIPE\&. To avoid this problem, do not name your Samba server
9722 PIPE\&.
9723 .sp
9724 Default:
9725 \fI\fInetbios name\fR\fR\fI = \fR\fI # machine DNS name\fR\fI \fR
9726 .sp
9727 Example:
9728 \fI\fInetbios name\fR\fR\fI = \fR\fIMYNAME\fR\fI \fR
9729 .RE
9730
9731 netbios scope (G)
9732 .PP
9733 .RS 4
9734 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\&.
9735 .sp
9736 Default:
9737 \fI\fInetbios scope\fR\fR\fI = \fR\fI\fR\fI \fR
9738 .RE
9739
9740 neutralize nt4 emulation (G)
9741 .PP
9742 .RS 4
9743 This option controls whether winbindd sends the NETLOGON_NEG_NEUTRALIZE_NT4_EMULATION flag in order to bypass the NT4 emulation of a domain controller\&.
9744 .sp
9745 Typically you should not need set this\&. It can be useful for upgrades from NT4 to AD domains\&.
9746 .sp
9747 The behavior can be controlled per netbios domain by using \*(Aqneutralize nt4 emulation:NETBIOSDOMAIN = yes\*(Aq as option\&.
9748 .sp
9749 Default:
9750 \fI\fIneutralize nt4 emulation\fR\fR\fI = \fR\fIno\fR\fI \fR
9751 .RE
9752
9753 nmbd bind explicit broadcast (G)
9754 .PP
9755 .RS 4
9756 This option causes
9757 \fBnmbd\fR(8)
9758 to explicitly bind to the broadcast address of the local subnets\&. This is needed to make nmbd work correctly in combination with the
9759 \m[blue]\fBsocket address\fR\m[]
9760 option\&. You should not need to unset this option\&.
9761 .sp
9762 Default:
9763 \fI\fInmbd bind explicit broadcast\fR\fR\fI = \fR\fIyes\fR\fI \fR
9764 .RE
9765
9766 nsupdate command (G)
9767 .PP
9768 .RS 4
9769 This option sets the path to the
9770 nsupdate
9771 command which is used for GSS\-TSIG dynamic DNS updates\&.
9772 .sp
9773 Default:
9774 \fI\fInsupdate command\fR\fR\fI = \fR\fI/usr/bin/nsupdate \-g\fR\fI \fR
9775 .RE
9776
9777 nt hash store (G)
9778 .PP
9779 .RS 4
9780 This parameter determines whether or not
9781 \fBsamba\fR(8)
9782 will, as an AD DC, attempt to store the NT password hash used in NTLM and NTLMv2 authentication for users in this domain\&.
9783 .sp
9784 If so configured, the Samba Active Directory Domain Controller, will, except for trust accounts (computers, domain controllers and inter\-domain trusts),
9785 \fINOT store the NT hash\fR
9786 for new and changed accounts in the sam\&.ldb database\&.
9787 .sp
9788 This avoids the storage of an unsalted hash for these user\-created passwords\&. As a consequence the
9789 \fBarcfour\-hmac\-md5\fR
9790 Kerberos key type is also unavailable in the KDC for these users \- thankfully
9791 \fImodern clients will select an AES based key instead\&.\fR
9792 .sp
9793 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\&.
9794 .sp
9795 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\&.
9796 .sp
9797 The available settings are:
9798 .RS
9799 .sp
9800 .RS 4
9801 .ie n \{\
9802 \h'-04'\(bu\h'+03'\c
9803 .\}
9804 .el \{\
9805 .sp -1
9806 .IP \(bu 2.3
9807 .\}
9808 \fBalways\fR
9809 \- Always store the NT hash (as machine accounts will also always store an NT hash, a hash will be stored for all accounts)\&.
9810 .sp
9811 This setting may be useful if
9812 \fIntlm auth\fR
9813 is set to
9814 \fBdisabled\fR
9815 for a trial period
9816 .RE
9817 .sp
9818 .RS 4
9819 .ie n \{\
9820 \h'-04'\(bu\h'+03'\c
9821 .\}
9822 .el \{\
9823 .sp -1
9824 .IP \(bu 2.3
9825 .\}
9826 \fBnever\fR
9827 \- Never store the NT hash for user accounts, only for machine accounts
9828 .RE
9829 .sp
9830 .RS 4
9831 .ie n \{\
9832 \h'-04'\(bu\h'+03'\c
9833 .\}
9834 .el \{\
9835 .sp -1
9836 .IP \(bu 2.3
9837 .\}
9838 \fBauto\fR
9839 \- Store an NT hash if
9840 \fIntlm auth\fR
9841 is not set to
9842 \fBdisabled\fR\&.
9843 .RE
9844 .sp
9845 .RE
9846 Default:
9847 \fI\fInt hash store\fR\fR\fI = \fR\fIalways\fR\fI \fR
9848 .RE
9849
9850 nt acl support (S)
9851 .PP
9852 .RS 4
9853 This boolean parameter controls whether
9854 \fBsmbd\fR(8)
9855 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\&.
9856 .sp
9857 Default:
9858 \fI\fInt acl support\fR\fR\fI = \fR\fIyes\fR\fI \fR
9859 .RE
9860
9861 ntlm auth (G)
9862 .PP
9863 .RS 4
9864 This parameter determines whether or not
9865 \fBsmbd\fR(8)
9866 will attempt to authenticate users using the NTLM encrypted password response for this local passdb (SAM or account database)\&.
9867 .sp
9868 If disabled, both NTLM and LanMan authentication against the local passdb is disabled\&.
9869 .sp
9870 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\&.
9871 .sp
9872 By default with
9873 ntlm auth
9874 set to
9875 \fBntlmv2\-only\fR
9876 only NTLMv2 logins will be permitted\&. All modern clients support NTLMv2 by default, but some older clients will require special configuration to use it\&.
9877 .sp
9878 The primary user of NTLMv1 is MSCHAPv2 for VPNs and 802\&.1x\&.
9879 .sp
9880 The available settings are:
9881 .RS
9882 .sp
9883 .RS 4
9884 .ie n \{\
9885 \h'-04'\(bu\h'+03'\c
9886 .\}
9887 .el \{\
9888 .sp -1
9889 .IP \(bu 2.3
9890 .\}
9891 \fBntlmv1\-permitted\fR
9892 (alias
9893 \fByes\fR) \- Allow NTLMv1 and above for all clients\&.
9894 .sp
9895 This is the required setting to enable the
9896 \fIlanman auth\fR
9897 parameter\&.
9898 .RE
9899 .sp
9900 .RS 4
9901 .ie n \{\
9902 \h'-04'\(bu\h'+03'\c
9903 .\}
9904 .el \{\
9905 .sp -1
9906 .IP \(bu 2.3
9907 .\}
9908 \fBntlmv2\-only\fR
9909 (alias
9910 \fBno\fR) \- Do not allow NTLMv1 to be used, but permit NTLMv2\&.
9911 .RE
9912 .sp
9913 .RS 4
9914 .ie n \{\
9915 \h'-04'\(bu\h'+03'\c
9916 .\}
9917 .el \{\
9918 .sp -1
9919 .IP \(bu 2.3
9920 .\}
9921 \fBmschapv2\-and\-ntlmv2\-only\fR
9922 \- Only allow NTLMv1 when the client promises that it is providing MSCHAPv2 authentication (such as the
9923 ntlm_auth
9924 tool)\&.
9925 .RE
9926 .sp
9927 .RS 4
9928 .ie n \{\
9929 \h'-04'\(bu\h'+03'\c
9930 .\}
9931 .el \{\
9932 .sp -1
9933 .IP \(bu 2.3
9934 .\}
9935 \fBdisabled\fR
9936 \- Do not accept NTLM (or LanMan) authentication of any level, nor permit NTLM password changes\&.
9937 .sp
9938 \fIWARNING:\fR
9939 Both Microsoft Windows and Samba
9940 \fIRead Only Domain Controllers\fR
9941 (RODCs) convert a plain\-text LDAP Simple Bind into an NTLMv2 authentication to forward to a full DC\&. Setting this option to
9942 \fBdisabled\fR
9943 will cause these forwarded authentications to fail\&.
9944 .sp
9945 Additionally, for Samba acting as an Active Directory Domain Controller, for user accounts, if
9946 \fInt hash store\fR
9947 is set to the default setting of
9948 \fBauto\fR, the
9949 \fINT hash will not be stored\fR
9950 in the sam\&.ldb database for new users and after a password change\&.
9951 .RE
9952 .sp
9953 .RE
9954 The default changed from
9955 \fByes\fR
9956 to
9957 \fBno\fR
9958 with Samba 4\&.5\&. The default changed again to
9959 \fBntlmv2\-only\fR
9960 with Samba 4\&.7, however the behaviour is unchanged\&.
9961 .sp
9962 Default:
9963 \fI\fIntlm auth\fR\fR\fI = \fR\fIntlmv2\-only\fR\fI \fR
9964 .RE
9965
9966 nt pipe support (G)
9967 .PP
9968 .RS 4
9969 This boolean parameter controls whether
9970 \fBsmbd\fR(8)
9971 will allow Windows NT clients to connect to the NT SMB specific
9972 \fBIPC$\fR
9973 pipes\&. This is a developer debugging option and can be left alone\&.
9974 .sp
9975 Default:
9976 \fI\fInt pipe support\fR\fR\fI = \fR\fIyes\fR\fI \fR
9977 .RE
9978
9979 ntp signd socket directory (G)
9980 .PP
9981 .RS 4
9982 This setting controls the location of the socket that the NTP daemon uses to communicate with Samba for signing packets\&.
9983 .sp
9984 If a non\-default path is specified here, then it is also necessary to make NTP aware of the new path using the
9985 \fBntpsigndsocket\fR
9986 directive in
9987 ntp\&.conf\&.
9988 .sp
9989 Default:
9990 \fI\fIntp signd socket directory\fR\fR\fI = \fR\fI/var/lib/samba/ntp_signd\fR\fI \fR
9991 .RE
9992
9993 nt status support (G)
9994 .PP
9995 .RS 4
9996 This boolean parameter controls whether
9997 \fBsmbd\fR(8)
9998 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
9999 \fBno\fR
10000 then Samba offers exactly the same DOS error codes that versions prior to Samba 2\&.2\&.3 reported\&.
10001 .sp
10002 You should not need to ever disable this parameter\&.
10003 .sp
10004 Default:
10005 \fI\fInt status support\fR\fR\fI = \fR\fIyes\fR\fI \fR
10006 .RE
10007
10008 ntvfs handler (S)
10009 .PP
10010 .RS 4
10011 This specifies the NTVFS handlers for this share\&.
10012 .RS
10013 .sp
10014 .RS 4
10015 .ie n \{\
10016 \h'-04'\(bu\h'+03'\c
10017 .\}
10018 .el \{\
10019 .sp -1
10020 .IP \(bu 2.3
10021 .\}
10022 unixuid: Sets up user credentials based on POSIX gid/uid\&.
10023 .RE
10024 .sp
10025 .RS 4
10026 .ie n \{\
10027 \h'-04'\(bu\h'+03'\c
10028 .\}
10029 .el \{\
10030 .sp -1
10031 .IP \(bu 2.3
10032 .\}
10033 cifs: Proxies a remote CIFS FS\&. Mainly useful for testing\&.
10034 .RE
10035 .sp
10036 .RS 4
10037 .ie n \{\
10038 \h'-04'\(bu\h'+03'\c
10039 .\}
10040 .el \{\
10041 .sp -1
10042 .IP \(bu 2.3
10043 .\}
10044 nbench: Filter module that saves data useful to the nbench benchmark suite\&.
10045 .RE
10046 .sp
10047 .RS 4
10048 .ie n \{\
10049 \h'-04'\(bu\h'+03'\c
10050 .\}
10051 .el \{\
10052 .sp -1
10053 .IP \(bu 2.3
10054 .\}
10055 ipc: Allows using SMB for inter process communication\&. Only used for the IPC$ share\&.
10056 .RE
10057 .sp
10058 .RS 4
10059 .ie n \{\
10060 \h'-04'\(bu\h'+03'\c
10061 .\}
10062 .el \{\
10063 .sp -1
10064 .IP \(bu 2.3
10065 .\}
10066 posix: Maps POSIX FS semantics to NT semantics
10067 .RE
10068 .sp
10069 .RS 4
10070 .ie n \{\
10071 \h'-04'\(bu\h'+03'\c
10072 .\}
10073 .el \{\
10074 .sp -1
10075 .IP \(bu 2.3
10076 .\}
10077 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\&.
10078 .RE
10079 .sp
10080 .RE
10081 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\&.
10082 .sp
10083 Default:
10084 \fI\fIntvfs handler\fR\fR\fI = \fR\fIunixuid, default\fR\fI \fR
10085 .RE
10086
10087 null passwords (G)
10088 .PP
10089 .RS 4
10090 Allow or disallow client access to accounts that have null passwords\&.
10091 .sp
10092 See also
10093 \fBsmbpasswd\fR(5)\&.
10094 .sp
10095 Default:
10096 \fI\fInull passwords\fR\fR\fI = \fR\fIno\fR\fI \fR
10097 .RE
10098
10099 obey pam restrictions (G)
10100 .PP
10101 .RS 4
10102 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
10103 \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\&.
10104 .sp
10105 Default:
10106 \fI\fIobey pam restrictions\fR\fR\fI = \fR\fIno\fR\fI \fR
10107 .RE
10108
10109 old password allowed period (G)
10110 .PP
10111 .RS 4
10112 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\&.
10113 .sp
10114 This parameter only applies when
10115 \m[blue]\fBserver role\fR\m[]
10116 is set to Active Directory Domain Controller\&.
10117 .sp
10118 Default:
10119 \fI\fIold password allowed period\fR\fR\fI = \fR\fI60\fR\fI \fR
10120 .RE
10121
10122 oplock break wait time (G)
10123 .PP
10124 .RS 4
10125 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\&.
10126 .if n \{\
10127 .sp
10128 .\}
10129 .RS 4
10130 .it 1 an-trap
10131 .nr an-no-space-flag 1
10132 .nr an-break-flag 1
10133 .br
10134 .ps +1
10135 \fBWarning\fR
10136 .ps -1
10137 .br
10138 DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ AND UNDERSTOOD THE SAMBA OPLOCK CODE\&.
10139 .sp .5v
10140 .RE
10141 Default:
10142 \fI\fIoplock break wait time\fR\fR\fI = \fR\fI0\fR\fI \fR
10143 .RE
10144
10145 oplocks (S)
10146 .PP
10147 .RS 4
10148 This boolean option tells
10149 smbd
10150 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)\&.
10151 .sp
10152 Oplocks may be selectively turned off on certain files with a share\&. See the
10153 \m[blue]\fBveto oplock files\fR\m[]
10154 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
10155 \m[blue]\fBkernel oplocks\fR\m[]
10156 parameter for details\&.
10157 .sp
10158 Default:
10159 \fI\fIoplocks\fR\fR\fI = \fR\fIyes\fR\fI \fR
10160 .RE
10161
10162 os2 driver map (G)
10163 .PP
10164 .RS 4
10165 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:
10166 .sp
10167 <nt driver name> = <os2 driver name>\&.<device name>
10168 .sp
10169 For example, a valid entry using the HP LaserJet 5 printer driver would appear as
10170 HP LaserJet 5L = LASERJET\&.HP LaserJet 5L\&.
10171 .sp
10172 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\&.
10173 .sp
10174 Default:
10175 \fI\fIos2 driver map\fR\fR\fI = \fR\fI\fR\fI \fR
10176 .RE
10177
10178 os level (G)
10179 .PP
10180 .RS 4
10181 This integer value controls what level Samba advertises itself as for browse elections\&. The value of this parameter determines whether
10182 \fBnmbd\fR(8)
10183 has a chance of becoming a local master browser for the
10184 \m[blue]\fBworkgroup\fR\m[]
10185 in the local broadcast area\&.
10186 .sp
10187 \fI Note:\fR
10188 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\&.
10189 \fINote:\fR
10190 The maximum value for this parameter is 255\&. If you use higher values, counting will start at 0!
10191 .sp
10192 Default:
10193 \fI\fIos level\fR\fR\fI = \fR\fI20\fR\fI \fR
10194 .sp
10195 Example:
10196 \fI\fIos level\fR\fR\fI = \fR\fI65\fR\fI \fR
10197 .RE
10198
10199 pam password change (G)
10200 .PP
10201 .RS 4
10202 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
10203 \m[blue]\fBpasswd program\fR\m[]\&. It should be possible to enable this without changing your
10204 \m[blue]\fBpasswd chat\fR\m[]
10205 parameter for most setups\&.
10206 .sp
10207 Default:
10208 \fI\fIpam password change\fR\fR\fI = \fR\fIno\fR\fI \fR
10209 .RE
10210
10211 panic action (G)
10212 .PP
10213 .RS 4
10214 This is a Samba developer option that allows a system command to be called when either
10215 \fBsmbd\fR(8)
10216 or
10217 \fBnmbd\fR(8)
10218 crashes\&. This is usually used to draw attention to the fact that a problem occurred\&.
10219 .sp
10220 Default:
10221 \fI\fIpanic action\fR\fR\fI = \fR\fI\fR\fI \fR
10222 .sp
10223 Example:
10224 \fI\fIpanic action\fR\fR\fI = \fR\fI/bin/sleep 90000\fR\fI \fR
10225 .RE
10226
10227 passdb backend (G)
10228 .PP
10229 .RS 4
10230 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\&.
10231 .sp
10232 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\&.
10233 .sp
10234 Available backends can include:
10235 .RS
10236 .sp
10237 .RS 4
10238 .ie n \{\
10239 \h'-04'\(bu\h'+03'\c
10240 .\}
10241 .el \{\
10242 .sp -1
10243 .IP \(bu 2.3
10244 .\}
10245 smbpasswd
10246 \- 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\&.
10247 .RE
10248 .sp
10249 .RS 4
10250 .ie n \{\
10251 \h'-04'\(bu\h'+03'\c
10252 .\}
10253 .el \{\
10254 .sp -1
10255 .IP \(bu 2.3
10256 .\}
10257 tdbsam
10258 \- The TDB based password storage backend\&. Takes a path to the TDB as an optional argument (defaults to passdb\&.tdb in the
10259 \m[blue]\fBprivate dir\fR\m[]
10260 directory\&.
10261 .RE
10262 .sp
10263 .RS 4
10264 .ie n \{\
10265 \h'-04'\(bu\h'+03'\c
10266 .\}
10267 .el \{\
10268 .sp -1
10269 .IP \(bu 2.3
10270 .\}
10271 ldapsam
10272 \- The LDAP based passdb backend\&. Takes an LDAP URL as an optional argument (defaults to
10273 ldap://localhost)
10274 .sp
10275 LDAP connections should be secured where possible\&. This may be done using either Start\-TLS (see
10276 \m[blue]\fBldap ssl\fR\m[]) or by specifying
10277 \fIldaps://\fR
10278 in the URL argument\&.
10279 .sp
10280 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\&.
10281 .RE
10282 .sp
10283 .RE
10284
10285 Examples of use are:
10286 .sp
10287 .if n \{\
10288 .RS 4
10289 .\}
10290 .nf
10291 passdb backend = tdbsam:/etc/samba/private/passdb\&.tdb
10292
10293 or multi server LDAP URL with OpenLDAP library:
10294
10295 passdb backend = ldapsam:"ldap://ldap\-1\&.example\&.com ldap://ldap\-2\&.example\&.com"
10296
10297 or multi server LDAP URL with Netscape based LDAP library:
10298
10299 passdb backend = ldapsam:"ldap://ldap\-1\&.example\&.com ldap\-2\&.example\&.com"
10300 .fi
10301 .if n \{\
10302 .RE
10303 .\}
10304 .sp
10305 Default:
10306 \fI\fIpassdb backend\fR\fR\fI = \fR\fItdbsam\fR\fI \fR
10307 .RE
10308
10309 passdb expand explicit (G)
10310 .PP
10311 .RS 4
10312 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\&.
10313 .sp
10314 Default:
10315 \fI\fIpassdb expand explicit\fR\fR\fI = \fR\fIno\fR\fI \fR
10316 .RE
10317
10318 passwd chat (G)
10319 .PP
10320 .RS 4
10321 This string controls the
10322 \fI"chat"\fR
10323 conversation that takes places between
10324 \fBsmbd\fR(8)
10325 and the local password changing program to change the user\*(Aqs password\&. The string describes a sequence of response\-receive pairs that
10326 \fBsmbd\fR(8)
10327 uses to determine what to send to the
10328 \m[blue]\fBpasswd program\fR\m[]
10329 and what to expect back\&. If the expected output is not received then the password is not changed\&.
10330 .sp
10331 This chat sequence is often quite site specific, depending on what local methods are used for password control\&.
10332 .sp
10333 Note that this parameter only is used if the
10334 \m[blue]\fBunix password sync\fR\m[]
10335 parameter is set to
10336 \fByes\fR\&. This sequence is then called
10337 \fIAS ROOT\fR
10338 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\&.
10339 .sp
10340 The string can contain the macro
10341 \fI%n\fR
10342 which is substituted for the new password\&. The old password (\fI%o\fR) is only available when
10343 \m[blue]\fBencrypt passwords\fR\m[]
10344 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\&.
10345 .sp
10346 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\&.
10347 .sp
10348 If the
10349 \m[blue]\fBpam password change\fR\m[]
10350 parameter is set to
10351 \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\&.
10352 .sp
10353 Default:
10354 \fI\fIpasswd chat\fR\fR\fI = \fR\fI*new*password* %n\en *new*password* %n\en *changed*\fR\fI \fR
10355 .sp
10356 Example:
10357 \fI\fIpasswd chat\fR\fR\fI = \fR\fI"*Enter NEW password*" %n\en "*Reenter NEW password*" %n\en "*Password changed*"\fR\fI \fR
10358 .RE
10359
10360 passwd chat debug (G)
10361 .PP
10362 .RS 4
10363 This boolean specifies if the passwd chat script parameter is run in
10364 \fIdebug\fR
10365 mode\&. In this mode the strings passed to and received from the passwd chat are printed in the
10366 \fBsmbd\fR(8)
10367 log with a
10368 \m[blue]\fBdebug level\fR\m[]
10369 of 100\&. This is a dangerous option as it will allow plaintext passwords to be seen in the
10370 smbd
10371 log\&. It is available to help Samba admins debug their
10372 \fIpasswd chat\fR
10373 scripts when calling the
10374 \fIpasswd program\fR
10375 and should be turned off after this has been done\&. This option has no effect if the
10376 \m[blue]\fBpam password change\fR\m[]
10377 parameter is set\&. This parameter is off by default\&.
10378 .sp
10379 Default:
10380 \fI\fIpasswd chat debug\fR\fR\fI = \fR\fIno\fR\fI \fR
10381 .RE
10382
10383 passwd chat timeout (G)
10384 .PP
10385 .RS 4
10386 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\&.
10387 .sp
10388 Default:
10389 \fI\fIpasswd chat timeout\fR\fR\fI = \fR\fI2\fR\fI \fR
10390 .RE
10391
10392 passwd program (G)
10393 .PP
10394 .RS 4
10395 The name of a program that can be used to set UNIX user passwords\&. Any occurrences of
10396 \fI%u\fR
10397 will be replaced with the user name\&. The user name is checked for existence before calling the password changing program\&.
10398 .sp
10399 Also note that many passwd programs insist in
10400 \fIreasonable \fR
10401 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\&.
10402 .sp
10403 \fINote\fR
10404 that if the
10405 \fIunix password sync\fR
10406 parameter is set to
10407 \fByes \fR
10408 then this program is called
10409 \fIAS ROOT\fR
10410 before the SMB password in the smbpasswd file is changed\&. If this UNIX password change fails, then
10411 smbd
10412 will fail to change the SMB password also (this is by design)\&.
10413 .sp
10414 If the
10415 \fIunix password sync\fR
10416 parameter is set this parameter
10417 \fIMUST USE ABSOLUTE PATHS\fR
10418 for
10419 \fIALL\fR
10420 programs called, and must be examined for security implications\&. Note that by default
10421 \fIunix password sync\fR
10422 is set to
10423 \fBno\fR\&.
10424 .sp
10425 Default:
10426 \fI\fIpasswd program\fR\fR\fI = \fR\fI\fR\fI \fR
10427 .sp
10428 Example:
10429 \fI\fIpasswd program\fR\fR\fI = \fR\fI/bin/passwd %u\fR\fI \fR
10430 .RE
10431
10432 password hash gpg key ids (G)
10433 .PP
10434 .RS 4
10435 If
10436 samba
10437 is running as an active directory domain controller, it is possible to store the cleartext password of accounts in a PGP/OpenGPG encrypted form\&.
10438 .sp
10439 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\&.
10440 .sp
10441 The value is stored as \*(AqPrimary:SambaGPG\*(Aq in the
10442 supplementalCredentials
10443 attribute\&.
10444 .sp
10445 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\&.
10446 .sp
10447 This option is only available if
10448 samba
10449 was compiled with
10450 gpgme
10451 support\&.
10452 .sp
10453 You may need to export the
10454 GNUPGHOME
10455 environment variable before starting
10456 samba\&.
10457 \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
10458 .sp
10459 Being able to restore the cleartext password helps, when they need to be imported into other authentication systems later (see
10460 samba\-tool user getpassword) or you want to keep the passwords in sync with another system, e\&.g\&. an OpenLDAP server (see
10461 samba\-tool user syncpasswords)\&.
10462 .sp
10463 While this option needs to be configured on all domain controllers, the
10464 samba\-tool user syncpasswords
10465 command should run on a single domain controller only (typically the PDC\-emulator)\&.
10466 .sp
10467 Default:
10468 \fI\fIpassword hash gpg key ids\fR\fR\fI = \fR\fI\fR\fI \fR
10469 .sp
10470 Example:
10471 \fI\fIpassword hash gpg key ids\fR\fR\fI = \fR\fI4952E40301FAB41A\fR\fI \fR
10472 .sp
10473 Example:
10474 \fI\fIpassword hash gpg key ids\fR\fR\fI = \fR\fIselftest@samba\&.example\&.com\fR\fI \fR
10475 .sp
10476 Example:
10477 \fI\fIpassword hash gpg key ids\fR\fR\fI = \fR\fIselftest@samba\&.example\&.com, 4952E40301FAB41A\fR\fI \fR
10478 .RE
10479
10480 password hash userPassword schemes (G)
10481 .PP
10482 .RS 4
10483 This parameter determines whether or not
10484 \fBsamba\fR(8)
10485 acting as an Active Directory Domain Controller will attempt to store additional passwords hash types for the user
10486 .sp
10487 The values are stored as \*(AqPrimary:userPassword\*(Aq in the
10488 supplementalCredentials
10489 attribute\&. The value of this option is a hash type\&.
10490 .sp
10491 The currently supported hash types are:
10492 .RS
10493 .sp
10494 .RS 4
10495 .ie n \{\
10496 \h'-04'\(bu\h'+03'\c
10497 .\}
10498 .el \{\
10499 .sp -1
10500 .IP \(bu 2.3
10501 .\}
10502 \fBCryptSHA256\fR
10503 .RE
10504 .sp
10505 .RS 4
10506 .ie n \{\
10507 \h'-04'\(bu\h'+03'\c
10508 .\}
10509 .el \{\
10510 .sp -1
10511 .IP \(bu 2.3
10512 .\}
10513 \fBCryptSHA512\fR
10514 .RE
10515 .sp
10516 .RE
10517 Multiple instances of a hash type may be computed and stored\&. The password hashes are calculated using the
10518 \fBcrypt\fR(3)
10519 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
10520 \fBcrypt\fR(3)
10521 are used\&.
10522 .sp
10523 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\&.
10524 .sp
10525 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
10526 samba\-tool user
10527 will ignore the stored hash values\&.
10528 .sp
10529 Being able to obtain the hashed password helps, when they need to be imported into other authentication systems later (see
10530 samba\-tool user getpassword) or you want to keep the passwords in sync with another system, e\&.g\&. an OpenLDAP server (see
10531 samba\-tool user syncpasswords)\&.
10532 .sp
10533 Related command:
10534 \m[blue]\fBunix password sync\fR\m[]
10535 .sp
10536 Default:
10537 \fI\fIpassword hash userPassword schemes\fR\fR\fI = \fR\fI\fR\fI \fR
10538 .sp
10539 Example:
10540 \fI\fIpassword hash userPassword schemes\fR\fR\fI = \fR\fICryptSHA256\fR\fI \fR
10541 .sp
10542 Example:
10543 \fI\fIpassword hash userPassword schemes\fR\fR\fI = \fR\fICryptSHA256 CryptSHA512\fR\fI \fR
10544 .sp
10545 Example:
10546 \fI\fIpassword hash userPassword schemes\fR\fR\fI = \fR\fICryptSHA256:rounds=5000 CryptSHA512:rounds=7000\fR\fI \fR
10547 .RE
10548
10549 password server (G)
10550 .PP
10551 .RS 4
10552 By specifying the name of a domain controller with this option, and using
10553 security = [ads|domain]
10554 it is possible to get Samba to do all its username/password validation using a specific remote server\&.
10555 .sp
10556 Ideally, this option
10557 \fIshould not\fR
10558 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\&.
10559 .sp
10560 \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
10561 \fIpassword server\fR
10562 option then
10563 smbd
10564 will try each in turn till it finds one that responds\&. This is useful in case your primary server goes down\&.
10565 .sp
10566 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\&.
10567 .sp
10568 If parameter is a name, it is looked up using the parameter
10569 \m[blue]\fBname resolve order\fR\m[]
10570 and so may resolved by any method and order described in that parameter\&.
10571 .sp
10572 Default:
10573 \fI\fIpassword server\fR\fR\fI = \fR\fI*\fR\fI \fR
10574 .sp
10575 Example:
10576 \fI\fIpassword server\fR\fR\fI = \fR\fINT\-PDC, NT\-BDC1, NT\-BDC2, *\fR\fI \fR
10577 .sp
10578 Example:
10579 \fI\fIpassword server\fR\fR\fI = \fR\fIwindc\&.mydomain\&.com:389 192\&.168\&.1\&.101 *\fR\fI \fR
10580 .RE
10581
10582 directory
10583 .PP
10584 .RS 4
10585 This parameter is a synonym for
10586 path\&.
10587 .RE
10588
10589 path (S)
10590 .PP
10591 .RS 4
10592 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\&.
10593 .sp
10594 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\&.
10595 .sp
10596 Any occurrences of
10597 \fI%u\fR
10598 in the path will be replaced with the UNIX username that the client is using on this connection\&. Any occurrences of
10599 \fI%m\fR
10600 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\&.
10601 .sp
10602 Note that this path will be based on
10603 \m[blue]\fBroot dir\fR\m[]
10604 if one was specified\&.
10605 .sp
10606 Default:
10607 \fI\fIpath\fR\fR\fI = \fR\fI\fR\fI \fR
10608 .sp
10609 Example:
10610 \fI\fIpath\fR\fR\fI = \fR\fI/home/fred\fR\fI \fR
10611 .RE
10612
10613 perfcount module (G)
10614 .PP
10615 .RS 4
10616 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\&.
10617 .sp
10618 \fINo default\fR
10619 .RE
10620
10621 pid directory (G)
10622 .PP
10623 .RS 4
10624 This option specifies the directory where pid files will be placed\&.
10625 .sp
10626 Default:
10627 \fI\fIpid directory\fR\fR\fI = \fR\fI/run/samba\fR\fI \fR
10628 .sp
10629 Example:
10630 \fI\fIpid directory\fR\fR\fI = \fR\fI/var/run/\fR\fI \fR
10631 .RE
10632
10633 posix locking (S)
10634 .PP
10635 .RS 4
10636 The
10637 \fBsmbd\fR(8)
10638 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\&.
10639 .sp
10640 Default:
10641 \fI\fIposix locking\fR\fR\fI = \fR\fIyes\fR\fI \fR
10642 .RE
10643
10644 postexec (S)
10645 .PP
10646 .RS 4
10647 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\&.
10648 .sp
10649 An interesting example may be to unmount server resources:
10650 .sp
10651 postexec = /etc/umount /cdrom
10652 .sp
10653 Default:
10654 \fI\fIpostexec\fR\fR\fI = \fR\fI\fR\fI \fR
10655 .sp
10656 Example:
10657 \fI\fIpostexec\fR\fR\fI = \fR\fIecho \e"%u disconnected from %S from %m (%I)\e" >> /tmp/log\fR\fI \fR
10658 .RE
10659
10660 exec
10661 .PP
10662 .RS 4
10663 This parameter is a synonym for
10664 preexec\&.
10665 .RE
10666
10667 preexec (S)
10668 .PP
10669 .RS 4
10670 This option specifies a command to be run whenever the service is connected to\&. It takes the usual substitutions\&.
10671 .sp
10672 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:
10673 .sp
10674 preexec = csh \-c \*(Aqecho \e"Welcome to %S!\e" | /usr/local/samba/bin/smbclient \-M %m \-I %I\*(Aq &
10675 .sp
10676 Of course, this could get annoying after a while :\-)
10677 .sp
10678 See also
10679 \m[blue]\fBpreexec close\fR\m[]
10680 and
10681 \m[blue]\fBpostexec\fR\m[]\&.
10682 .sp
10683 Default:
10684 \fI\fIpreexec\fR\fR\fI = \fR\fI\fR\fI \fR
10685 .sp
10686 Example:
10687 \fI\fIpreexec\fR\fR\fI = \fR\fIecho \e"%u connected to %S from %m (%I)\e" >> /tmp/log\fR\fI \fR
10688 .RE
10689
10690 preexec close (S)
10691 .PP
10692 .RS 4
10693 This boolean option controls whether a non\-zero return code from
10694 \m[blue]\fBpreexec\fR\m[]
10695 should close the service being connected to\&.
10696 .sp
10697 Default:
10698 \fI\fIpreexec close\fR\fR\fI = \fR\fIno\fR\fI \fR
10699 .RE
10700
10701 prefered master
10702 .PP
10703 .RS 4
10704 This parameter is a synonym for
10705 preferred master\&.
10706 .RE
10707
10708 preferred master (G)
10709 .PP
10710 .RS 4
10711 This boolean parameter controls if
10712 \fBnmbd\fR(8)
10713 is a preferred master browser for its workgroup\&.
10714 .sp
10715 If this is set to
10716 \fByes\fR, on startup,
10717 nmbd
10718 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
10719 \m[blue]\fBdomain master = yes\fR\m[], so that
10720 nmbd
10721 can guarantee becoming a domain master\&.
10722 .sp
10723 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\&.
10724 .sp
10725 Default:
10726 \fI\fIpreferred master\fR\fR\fI = \fR\fIauto\fR\fI \fR
10727 .RE
10728
10729 prefork backoff increment (G)
10730 .PP
10731 .RS 4
10732 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"\&.
10733 .sp
10734 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\&.
10735 .sp
10736 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
10737 .sp
10738 Default:
10739 \fI\fIprefork backoff increment\fR\fR\fI = \fR\fI10\fR\fI \fR
10740 .RE
10741
10742 prefork children (G)
10743 .PP
10744 .RS 4
10745 This option controls the number of worker processes that are started for each service when prefork process model is enabled (see
10746 \fBsamba\fR(8)
10747 \-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\&.
10748 .sp
10749 This should be set to a small multiple of the number of CPU\*(Aqs available on the server
10750 .sp
10751 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\&.
10752 .sp
10753 Default:
10754 \fI\fIprefork children\fR\fR\fI = \fR\fI4\fR\fI \fR
10755 .RE
10756
10757 prefork maximum backoff (G)
10758 .PP
10759 .RS 4
10760 This option controls the maximum delay before a failed pre\-fork process is restarted\&.
10761 .sp
10762 Default:
10763 \fI\fIprefork maximum backoff\fR\fR\fI = \fR\fI120\fR\fI \fR
10764 .RE
10765
10766 preload modules (G)
10767 .PP
10768 .RS 4
10769 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\&.
10770 .sp
10771 Default:
10772 \fI\fIpreload modules\fR\fR\fI = \fR\fI\fR\fI \fR
10773 .sp
10774 Example:
10775 \fI\fIpreload modules\fR\fR\fI = \fR\fI/usr/lib/samba/passdb/mysql\&.so\fR\fI \fR
10776 .RE
10777
10778 preserve case (S)
10779 .PP
10780 .RS 4
10781 This controls if new filenames are created with the case that the client passes, or if they are forced to be the
10782 \m[blue]\fBdefault case\fR\m[]\&.
10783 .sp
10784 See the section on
10785 NAME MANGLING
10786 for a fuller discussion\&.
10787 .sp
10788 Default:
10789 \fI\fIpreserve case\fR\fR\fI = \fR\fIyes\fR\fI \fR
10790 .RE
10791
10792 print ok
10793 .PP
10794 .RS 4
10795 This parameter is a synonym for
10796 printable\&.
10797 .RE
10798
10799 printable (S)
10800 .PP
10801 .RS 4
10802 If this parameter is
10803 \fByes\fR, then clients may open, write to and submit spool files on the directory specified for the service\&.
10804 .sp
10805 Note that a printable service will ALWAYS allow writing to the service path (user privileges permitting) via the spooling of print data\&. The
10806 \m[blue]\fBread only\fR\m[]
10807 parameter controls only non\-printing access to the resource\&.
10808 .sp
10809 Default:
10810 \fI\fIprintable\fR\fR\fI = \fR\fIno\fR\fI \fR
10811 .RE
10812
10813 printcap cache time (G)
10814 .PP
10815 .RS 4
10816 This option specifies the number of seconds before the printing subsystem is again asked for the known printers\&.
10817 .sp
10818 Setting this parameter to 0 disables any rescanning for new or removed printers after the initial startup\&.
10819 .sp
10820 Default:
10821 \fI\fIprintcap cache time\fR\fR\fI = \fR\fI750\fR\fI \fR
10822 .sp
10823 Example:
10824 \fI\fIprintcap cache time\fR\fR\fI = \fR\fI600\fR\fI \fR
10825 .RE
10826
10827 printcap
10828 .PP
10829 .RS 4
10830 This parameter is a synonym for
10831 printcap name\&.
10832 .RE
10833
10834 printcap name (G)
10835 .PP
10836 .RS 4
10837 This parameter may be used to override the compiled\-in default printcap name used by the server (usually
10838 /etc/printcap)\&. See the discussion of the
10839 [printers]
10840 section above for reasons why you might want to do this\&.
10841 .sp
10842 To use the CUPS printing interface set
10843 printcap name = cups\&. This should be supplemented by an additional setting
10844 \m[blue]\fBprinting = cups\fR\m[]
10845 in the [global] section\&.
10846 printcap name = cups
10847 will use the "dummy" printcap created by CUPS, as specified in your CUPS configuration file\&.
10848 .sp
10849 On System V systems that use
10850 lpstat
10851 to list available printers you can use
10852 printcap name = lpstat
10853 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
10854 \fI printcap name\fR
10855 is set to
10856 lpstat
10857 on these systems then Samba will launch
10858 lpstat \-v
10859 and attempt to parse the output to obtain a printer list\&.
10860 .sp
10861 A minimal printcap file would look something like this:
10862 .sp
10863 .if n \{\
10864 .RS 4
10865 .\}
10866 .nf
10867 print1|My Printer 1
10868 print2|My Printer 2
10869 print3|My Printer 3
10870 print4|My Printer 4
10871 print5|My Printer 5
10872 .fi
10873 .if n \{\
10874 .RE
10875 .\}
10876 .sp
10877 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\&.
10878 .if n \{\
10879 .sp
10880 .\}
10881 .RS 4
10882 .it 1 an-trap
10883 .nr an-no-space-flag 1
10884 .nr an-break-flag 1
10885 .br
10886 .ps +1
10887 \fBNote\fR
10888 .ps -1
10889 .br
10890 Under AIX the default printcap name is
10891 /etc/qconfig\&. Samba will assume the file is in AIX
10892 qconfig
10893 format if the string
10894 qconfig
10895 appears in the printcap filename\&.
10896 .sp .5v
10897 .RE
10898 Default:
10899 \fI\fIprintcap name\fR\fR\fI = \fR\fI/etc/printcap\fR\fI \fR
10900 .sp
10901 Example:
10902 \fI\fIprintcap name\fR\fR\fI = \fR\fI/etc/myprintcap\fR\fI \fR
10903 .RE
10904
10905 print command (S)
10906 .PP
10907 .RS 4
10908 After a print job has finished spooling to a service, this command will be used via a
10909 system()
10910 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\&.
10911 .sp
10912 The print command is simply a text string\&. It will be used verbatim after macro substitutions have been made:
10913 .sp
10914 %s, %f \- the path to the spool file name
10915 .sp
10916 %p \- the appropriate printer name
10917 .sp
10918 %J \- the job name as transmitted by the client, but with dangerous characters being replaced by _\&. You should use single quotes (directly) around %J, e\&.g\&. \*(Aq%J\*(Aq, see CVE\-2026\-4480 for more details\&.
10919 .sp
10920 %c \- The number of printed pages of the spooled job (if known)\&.
10921 .sp
10922 %z \- the size of the spooled print job (in bytes)
10923 .sp
10924 The print command
10925 \fIMUST\fR
10926 contain at least one occurrence of
10927 \fI%s\fR
10928 or
10929 \fI%f \fR
10930 \- the
10931 \fI%p\fR
10932 is optional\&. At the time a job is submitted, if no printer name is supplied the
10933 \fI%p \fR
10934 will be silently removed from the printer command\&.
10935 .sp
10936 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\&.
10937 .sp
10938 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\&.
10939 .sp
10940 Note that printing may fail on some UNIXes from the
10941 \fBnobody\fR
10942 account\&. If this happens then create an alternative guest account that can print and set the
10943 \m[blue]\fBguest account\fR\m[]
10944 in the [global] section\&.
10945 .sp
10946 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\&.
10947 .sp
10948 print command = echo Printing %s >> /tmp/print\&.log; lpr \-P %p %s; rm %s
10949 .sp
10950 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
10951 \m[blue]\fBprinting\fR\m[]
10952 parameter\&.
10953 .sp
10954 Default: For
10955 printing = BSD, AIX, QNX, LPRNG or PLP :
10956 .sp
10957 print command = lpr \-r \-P%p %s
10958 .sp
10959 For
10960 printing = SYSV or HPUX :
10961 .sp
10962 print command = lp \-c \-d%p %s; rm %s
10963 .sp
10964 For
10965 printing = SOFTQ :
10966 .sp
10967 print command = lp \-d%p \-s %s; rm %s
10968 .sp
10969 For printing = CUPS : If SAMBA is compiled against libcups, then
10970 \m[blue]\fBprintcap = cups\fR\m[]
10971 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
10972 lp \-c \-d%p \-oraw; rm %s\&. With
10973 printing = cups, and if SAMBA is compiled against libcups, any manually set print command will be ignored\&.
10974 .sp
10975 \fINo default\fR
10976 .sp
10977 Example:
10978 \fI\fIprint command\fR\fR\fI = \fR\fI/usr/local/samba/bin/myprintscript %p %s\fR\fI \fR
10979 .RE
10980
10981 printer
10982 .PP
10983 .RS 4
10984 This parameter is a synonym for
10985 printer name\&.
10986 .RE
10987
10988 printer name (S)
10989 .PP
10990 .RS 4
10991 This parameter specifies the name of the printer to which print jobs spooled through a printable service will be sent\&.
10992 .sp
10993 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\&.
10994 .sp
10995 The default value of the
10996 \m[blue]\fBprinter name\fR\m[]
10997 may be
10998 lp
10999 on many systems\&.
11000 .sp
11001 Default:
11002 \fI\fIprinter name\fR\fR\fI = \fR\fI\fR\fI \fR
11003 .sp
11004 Example:
11005 \fI\fIprinter name\fR\fR\fI = \fR\fIlaserwriter\fR\fI \fR
11006 .RE
11007
11008 printing (S)
11009 .PP
11010 .RS 4
11011 This parameters controls how printer status information is interpreted on your system\&. It also affects the default values for the
11012 \fIprint command\fR,
11013 \fIlpq command\fR,
11014 \fIlppause command \fR,
11015 \fIlpresume command\fR, and
11016 \fIlprm command\fR
11017 if specified in the [global] section\&.
11018 .sp
11019 Currently nine printing styles are supported\&. They are
11020 \fBBSD\fR,
11021 \fBAIX\fR,
11022 \fBLPRNG\fR,
11023 \fBPLP\fR,
11024 \fBSYSV\fR,
11025 \fBHPUX\fR,
11026 \fBQNX\fR,
11027 \fBSOFTQ\fR,
11028 \fBCUPS\fR
11029 and
11030 \fBIPRINT\fR\&.
11031 .sp
11032 Be aware that CUPS and IPRINT are only available if the CUPS development library was available at the time Samba was compiled or packaged\&.
11033 .sp
11034 To see what the defaults are for the other print commands when using the various options use the
11035 \fBtestparm\fR(1)
11036 program\&.
11037 .sp
11038 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
11039 \fIprinting\fR
11040 option since it will reset the printing commands to default values\&.
11041 .sp
11042 See also the discussion in the
11043 [printers]
11044 section\&.
11045 .sp
11046 See
11047 testparm \-v\&.
11048 for the default value on your system
11049 .sp
11050 Default:
11051 \fI\fIprinting\fR\fR\fI = \fR\fI # Depends on the operating system\fR\fI \fR
11052 .RE
11053
11054 printjob username (S)
11055 .PP
11056 .RS 4
11057 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\&.
11058 .sp
11059 Default:
11060 \fI\fIprintjob username\fR\fR\fI = \fR\fI%U\fR\fI \fR
11061 .sp
11062 Example:
11063 \fI\fIprintjob username\fR\fR\fI = \fR\fI%D\e%U\fR\fI \fR
11064 .RE
11065
11066 print notify backchannel (S)
11067 .PP
11068 .RS 4
11069 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\&.
11070 .sp
11071 Default:
11072 \fI\fIprint notify backchannel\fR\fR\fI = \fR\fIno\fR\fI \fR
11073 .RE
11074
11075 private directory
11076 .PP
11077 .RS 4
11078 This parameter is a synonym for
11079 private dir\&.
11080 .RE
11081
11082 private dir (G)
11083 .PP
11084 .RS 4
11085 This parameters defines the directory smbd will use for storing such files as
11086 smbpasswd
11087 and
11088 secrets\&.tdb\&.
11089 .sp
11090 Default:
11091 \fI\fIprivate dir\fR\fR\fI = \fR\fI/var/lib/samba/private\fR\fI \fR
11092 .RE
11093
11094 queuepause command (S)
11095 .PP
11096 .RS 4
11097 This parameter specifies the command to be executed on the server host in order to pause the printer queue\&.
11098 .sp
11099 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\&.
11100 .sp
11101 This command is not supported by Windows for Workgroups, but can be issued from the Printers window under Windows 95 and NT\&.
11102 .sp
11103 If a
11104 \fI%p\fR
11105 is given then the printer name is put in its place\&. Otherwise it is placed at the end of the command\&.
11106 .sp
11107 Note that it is good practice to include the absolute path in the command as the PATH may not be available to the server\&.
11108 .sp
11109 Default:
11110 \fI\fIqueuepause command\fR\fR\fI = \fR\fI # determined by printing parameter\fR\fI \fR
11111 .sp
11112 Example:
11113 \fI\fIqueuepause command\fR\fR\fI = \fR\fIdisable %p\fR\fI \fR
11114 .RE
11115
11116 queueresume command (S)
11117 .PP
11118 .RS 4
11119 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[])\&.
11120 .sp
11121 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\&.
11122 .sp
11123 This command is not supported by Windows for Workgroups, but can be issued from the Printers window under Windows 95 and NT\&.
11124 .sp
11125 If a
11126 \fI%p\fR
11127 is given then the printer name is put in its place\&. Otherwise it is placed at the end of the command\&.
11128 .sp
11129 Note that it is good practice to include the absolute path in the command as the PATH may not be available to the server\&.
11130 .sp
11131 Default:
11132 \fI\fIqueueresume command\fR\fR\fI = \fR\fI # determined by printing parameter\fR\fI \fR
11133 .sp
11134 Example:
11135 \fI\fIqueueresume command\fR\fR\fI = \fR\fIenable %p\fR\fI \fR
11136 .RE
11137
11138 raw NTLMv2 auth (G)
11139 .PP
11140 .RS 4
11141 This parameter has been deprecated since Samba 4\&.13 and support for NTLMv2 authentication without NTLMSSP will be removed in a future Samba release\&.
11142 .sp
11143 That is, in the future, the current default of
11144 raw NTLMv2 auth = no
11145 will be the enforced behaviour\&.
11146 .sp
11147 This parameter determines whether or not
11148 \fBsmbd\fR(8)
11149 will allow SMB1 clients without extended security (without SPNEGO) to use NTLMv2 authentication\&.
11150 .sp
11151 If this option,
11152 lanman auth
11153 and
11154 ntlm auth
11155 are all disabled, then only clients with SPNEGO support will be permitted\&. That means NTLMv2 is only supported within NTLMSSP\&.
11156 .sp
11157 Default:
11158 \fI\fIraw NTLMv2 auth\fR\fR\fI = \fR\fIno\fR\fI \fR
11159 .RE
11160
11161 read list (S)
11162 .PP
11163 .RS 4
11164 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
11165 \m[blue]\fBread only\fR\m[]
11166 option is set to\&. The list can include group names using the syntax described in the
11167 \m[blue]\fBinvalid users\fR\m[]
11168 parameter\&.
11169 .sp
11170 Default:
11171 \fI\fIread list\fR\fR\fI = \fR\fI\fR\fI \fR
11172 .sp
11173 Example:
11174 \fI\fIread list\fR\fR\fI = \fR\fImary, @students\fR\fI \fR
11175 .RE
11176
11177 read only (S)
11178 .PP
11179 .RS 4
11180 An inverted synonym is
11181 \m[blue]\fBwriteable\fR\m[]\&.
11182 .sp
11183 If this parameter is
11184 \fByes\fR, then users of a service may not create or modify files in the service\*(Aqs directory\&.
11185 .sp
11186 Note that a printable service (printable = yes) will
11187 \fIALWAYS\fR
11188 allow writing to the directory (user privileges permitting), but only via spooling operations\&.
11189 .sp
11190 Default:
11191 \fI\fIread only\fR\fR\fI = \fR\fIyes\fR\fI \fR
11192 .RE
11193
11194 read raw (G)
11195 .PP
11196 .RS 4
11197 This is ignored if
11198 \m[blue]\fBasync smb echo handler\fR\m[]
11199 is set, because this feature is incompatible with raw read SMB requests
11200 .sp
11201 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\&.
11202 .sp
11203 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\&.
11204 .sp
11205 In general this parameter should be viewed as a system tuning tool and left severely alone\&.
11206 .sp
11207 Default:
11208 \fI\fIread raw\fR\fR\fI = \fR\fIyes\fR\fI \fR
11209 .RE
11210
11211 realm (G)
11212 .PP
11213 .RS 4
11214 This option specifies the kerberos realm to use\&. The realm is used as the ADS equivalent of the NT4
11215 domain\&. It is usually set to the DNS name of the kerberos server\&.
11216 .sp
11217 Default:
11218 \fI\fIrealm\fR\fR\fI = \fR\fI\fR\fI \fR
11219 .sp
11220 Example:
11221 \fI\fIrealm\fR\fR\fI = \fR\fImysambabox\&.mycompany\&.com\fR\fI \fR
11222 .RE
11223
11224 registry shares (G)
11225 .PP
11226 .RS 4
11227 This turns on or off support for share definitions read from registry\&. Shares defined in
11228 \fIsmb\&.conf\fR
11229 take precedence over shares with the same name defined in registry\&. See the section on registry\-based configuration for details\&.
11230 .sp
11231 Note that this parameter defaults to
11232 \fIno\fR, but it is set to
11233 \fIyes\fR
11234 when
11235 \fIconfig backend\fR
11236 is set to
11237 \fIregistry\fR\&.
11238 .sp
11239 Default:
11240 \fI\fIregistry shares\fR\fR\fI = \fR\fIno\fR\fI \fR
11241 .sp
11242 Example:
11243 \fI\fIregistry shares\fR\fR\fI = \fR\fIyes\fR\fI \fR
11244 .RE
11245
11246 reject aes netlogon servers (G)
11247 .PP
11248 .RS 4
11249 This option controls whether winbindd requires support for ServerAuthenticateKerberos support for the netlogon secure channel\&.
11250 .sp
11251 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\&.
11252 .sp
11253 The following flags will be required: NETLOGON_NEG_PASSWORD_SET2, NETLOGON_NEG_SUPPORTS_KERBEROS_AUTH and NETLOGON_NEG_AUTHENTICATED_RPC\&.
11254 .sp
11255 You can set this to yes if all domain controllers support ServerAuthenticateKerberos\&. This will prevent downgrade attacks\&.
11256 .sp
11257 The behavior can be controlled per netbios domain by using \*(Aqreject aes netlogon servers:NETBIOSDOMAIN = no\*(Aq as option\&.
11258 .sp
11259 This option overrides the
11260 \m[blue]\fBreject md5 servers\fR\m[]
11261 option\&.
11262 .sp
11263 This option overrides the
11264 \m[blue]\fBclient use krb5 netlogon\fR\m[]
11265 option (if it is effectively off)\&.
11266 .sp
11267 Default:
11268 \fI\fIreject aes netlogon servers\fR\fR\fI = \fR\fIno\fR\fI \fR
11269 .RE
11270
11271 reject md5 clients (G)
11272 .PP
11273 .RS 4
11274 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)\&.
11275 .sp
11276 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\&.
11277 .sp
11278 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
11279 https://www\&.samba\&.org/samba/security/CVE\-2022\-38023\&.html
11280 for more details\&.
11281 .sp
11282 The default changed from \*(Aqno\*(Aq to \*(Aqyes\*(Aq, with the patches for
11283 CVE\-2022\-38023
11284 see
11285 https://bugzilla\&.samba\&.org/show_bug\&.cgi?id=15240\&.
11286 .sp
11287 \fIAvoid using this option!\fR
11288 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
11289 CVE\-2022\-38023
11290 see
11291 https://bugzilla\&.samba\&.org/show_bug\&.cgi?id=15240\&.
11292 .sp
11293 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)\&.
11294 .sp
11295 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\&.
11296 .sp
11297 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\&.
11298 .sp
11299 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\&.
11300 .sp
11301 Default:
11302 \fI\fIreject md5 clients\fR\fR\fI = \fR\fIyes\fR\fI \fR
11303 .RE
11304
11305 server reject md5 schannel:COMPUTERACCOUNT (G)
11306 .PP
11307 .RS 4
11308 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)\&.
11309 .sp
11310 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)\&.
11311 .sp
11312 Samba will log a warning in the log files at log level 5 if a setting is still needed for the specified computer account\&.
11313 .sp
11314 See
11315 CVE\-2022\-38023,
11316 https://bugzilla\&.samba\&.org/show_bug\&.cgi?id=15240\&.
11317 .sp
11318 This option overrides the
11319 \m[blue]\fBreject md5 clients\fR\m[]
11320 option\&.
11321 .sp
11322 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\&.
11323 .sp
11324 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\&.
11325 .sp
11326 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\&.
11327 .sp
11328 .if n \{\
11329 .RS 4
11330 .\}
11331 .nf
11332 server reject md5 schannel:LEGACYCOMPUTER1$ = no
11333 server reject aes schannel:LEGACYCOMPUTER1$ = no
11334 server reject md5 schannel:NASBOX$ = no
11335 server reject aes schannel:NASBOX$ = no
11336 server reject md5 schannel:LEGACYCOMPUTER2$ = no
11337 server reject aes schannel:LEGACYCOMPUTER2$ = no
11338
11339 .fi
11340 .if n \{\
11341 .RE
11342 .\}
11343 .sp
11344 \fINo default\fR
11345 .RE
11346
11347 reject md5 servers (G)
11348 .PP
11349 .RS 4
11350 This option controls whether winbindd requires support for aes support for the netlogon secure channel\&.
11351 .sp
11352 The following flags will be required NETLOGON_NEG_ARCFOUR, NETLOGON_NEG_SUPPORTS_AES, NETLOGON_NEG_PASSWORD_SET2 and NETLOGON_NEG_AUTHENTICATED_RPC\&.
11353 .sp
11354 You can set this to yes if all domain controllers support aes\&. This will prevent downgrade attacks\&.
11355 .sp
11356 The behavior can be controlled per netbios domain by using \*(Aqreject md5 servers:NETBIOSDOMAIN = no\*(Aq as option\&.
11357 .sp
11358 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
11359 .sp
11360 This option is over\-ridden by the
11361 \m[blue]\fBreject aes netlogon servers\fR\m[]
11362 option\&.
11363 .sp
11364 This option overrides the
11365 \m[blue]\fBrequire strong key\fR\m[]
11366 option\&.
11367 .sp
11368 Default:
11369 \fI\fIreject md5 servers\fR\fR\fI = \fR\fIyes\fR\fI \fR
11370 .RE
11371
11372 remote announce (G)
11373 .PP
11374 .RS 4
11375 This option allows you to setup
11376 \fBnmbd\fR(8)
11377 to periodically announce itself to arbitrary IP addresses with an arbitrary workgroup name\&.
11378 .sp
11379 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\&.
11380 .sp
11381 For example:
11382 .sp
11383 .if n \{\
11384 .RS 4
11385 .\}
11386 .nf
11387 remote announce = 192\&.168\&.2\&.255/SERVERS 192\&.168\&.4\&.255/STAFF
11388 .fi
11389 .if n \{\
11390 .RE
11391 .\}
11392 .sp
11393 the above line would cause
11394 nmbd
11395 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
11396 \m[blue]\fBworkgroup\fR\m[]
11397 parameter is used instead\&.
11398 .sp
11399 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\&.
11400 .sp
11401 See the chapter on Network Browsing in the Samba\-HOWTO book\&.
11402 .sp
11403 Default:
11404 \fI\fIremote announce\fR\fR\fI = \fR\fI\fR\fI \fR
11405 .RE
11406
11407 remote browse sync (G)
11408 .PP
11409 .RS 4
11410 This option allows you to setup
11411 \fBnmbd\fR(8)
11412 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\&.
11413 .sp
11414 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\&.
11415 .sp
11416 For example:
11417 .sp
11418 .if n \{\
11419 .RS 4
11420 .\}
11421 .nf
11422 \fIremote browse sync = 192\&.168\&.2\&.255 192\&.168\&.4\&.255\fR
11423 .fi
11424 .if n \{\
11425 .RE
11426 .\}
11427 .sp
11428 the above line would cause
11429 nmbd
11430 to request the master browser on the specified subnets or addresses to synchronize their browse lists with the local server\&.
11431 .sp
11432 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\&.
11433 .sp
11434 The
11435 \m[blue]\fBremote browse sync\fR\m[]
11436 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\&.
11437 .sp
11438 Default:
11439 \fI\fIremote browse sync\fR\fR\fI = \fR\fI\fR\fI \fR
11440 .RE
11441
11442 rename user script (G)
11443 .PP
11444 .RS 4
11445 This is the full pathname to a script that will be run as root by
11446 \fBsmbd\fR(8)
11447 under special circumstances described below\&.
11448 .sp
11449 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,
11450 %uold
11451 and
11452 %unew, will be substituted with the old and new usernames, respectively\&. The script should return 0 upon successful completion, and nonzero otherwise\&.
11453 .if n \{\
11454 .sp
11455 .\}
11456 .RS 4
11457 .it 1 an-trap
11458 .nr an-no-space-flag 1
11459 .nr an-break-flag 1
11460 .br
11461 .ps +1
11462 \fBNote\fR
11463 .ps -1
11464 .br
11465 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\&.
11466 .sp .5v
11467 .RE
11468 Default:
11469 \fI\fIrename user script\fR\fR\fI = \fR\fI\fR\fI \fR
11470 .RE
11471
11472 require strong key (G)
11473 .PP
11474 .RS 4
11475 This option controls whether winbindd requires support for md5 strong key support for the netlogon secure channel\&.
11476 .sp
11477 The following flags will be required NETLOGON_NEG_STRONG_KEYS, NETLOGON_NEG_ARCFOUR and NETLOGON_NEG_AUTHENTICATED_RPC\&.
11478 .sp
11479 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\&.
11480 .sp
11481 The behavior can be controlled per netbios domain by using \*(Aqrequire strong key:NETBIOSDOMAIN = no\*(Aq as option\&.
11482 .sp
11483 Note for active directory domain this option is hardcoded to \*(Aqyes\*(Aq
11484 .sp
11485 This option is over\-ridden by the
11486 \m[blue]\fBreject md5 servers\fR\m[]
11487 option\&.
11488 .sp
11489 This option overrides the
11490 \m[blue]\fBclient schannel\fR\m[]
11491 option\&.
11492 .sp
11493 Default:
11494 \fI\fIrequire strong key\fR\fR\fI = \fR\fIyes\fR\fI \fR
11495 .RE
11496
11497 reset on zero vc (G)
11498 .PP
11499 .RS 4
11500 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\&.
11501 .sp
11502 Default:
11503 \fI\fIreset on zero vc\fR\fR\fI = \fR\fIno\fR\fI \fR
11504 .RE
11505
11506 restrict anonymous (G)
11507 .PP
11508 .RS 4
11509 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:
11510 .sp
11511 .if n \{\
11512 .RS 4
11513 .\}
11514 .nf
11515 HKEY_LOCAL_MACHINE\eSYSTEM\eCurrentControlSet\eControl\eLsa\eRestrictAnonymous
11516
11517 .fi
11518 .if n \{\
11519 .RE
11520 .\}
11521 .sp
11522 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\&.
11523 .sp
11524 Setting
11525 \m[blue]\fBrestrict anonymous = 1\fR\m[]
11526 will disable anonymous SAMR access\&.
11527 .sp
11528 Setting
11529 \m[blue]\fBrestrict anonymous = 2\fR\m[]
11530 will, in addition to restricting SAMR access, disallow anonymous connections to the IPC$ share in general\&. Setting
11531 \m[blue]\fBguest ok = yes\fR\m[]
11532 on any share will remove the security advantage\&.
11533 .sp
11534 Default:
11535 \fI\fIrestrict anonymous\fR\fR\fI = \fR\fI0\fR\fI \fR
11536 .RE
11537
11538 root
11539 .PP
11540 .RS 4
11541 This parameter is a synonym for
11542 root directory\&.
11543 .RE
11544
11545 root dir
11546 .PP
11547 .RS 4
11548 This parameter is a synonym for
11549 root directory\&.
11550 .RE
11551
11552 root directory (G)
11553 .PP
11554 .RS 4
11555 The server will
11556 chroot()
11557 (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
11558 \m[blue]\fBwide links\fR\m[]
11559 parameter)\&.
11560 .sp
11561 Adding a
11562 \fIroot directory\fR
11563 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
11564 \fIroot directory\fR
11565 option,
11566 \fIincluding\fR
11567 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
11568 \fIroot directory\fR
11569 tree\&. In particular you will need to mirror
11570 /etc/passwd
11571 (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\&.
11572 .sp
11573 Default:
11574 \fI\fIroot directory\fR\fR\fI = \fR\fI\fR\fI \fR
11575 .sp
11576 Example:
11577 \fI\fIroot directory\fR\fR\fI = \fR\fI/homes/smb\fR\fI \fR
11578 .RE
11579
11580 root postexec (S)
11581 .PP
11582 .RS 4
11583 This is the same as the
11584 \fIpostexec\fR
11585 parameter except that the command is run as root\&. This is useful for unmounting filesystems (such as CDROMs) after a connection is closed\&.
11586 .sp
11587 Default:
11588 \fI\fIroot postexec\fR\fR\fI = \fR\fI\fR\fI \fR
11589 .RE
11590
11591 root preexec (S)
11592 .PP
11593 .RS 4
11594 This is the same as the
11595 \fIpreexec\fR
11596 parameter except that the command is run as root\&. This is useful for mounting filesystems (such as CDROMs) when a connection is opened\&.
11597 .sp
11598 Default:
11599 \fI\fIroot preexec\fR\fR\fI = \fR\fI\fR\fI \fR
11600 .RE
11601
11602 root preexec close (S)
11603 .PP
11604 .RS 4
11605 This is the same as the
11606 \fIpreexec close \fR
11607 parameter except that the command is run as root\&.
11608 .sp
11609 Default:
11610 \fI\fIroot preexec close\fR\fR\fI = \fR\fIno\fR\fI \fR
11611 .RE
11612
11613 rpc big endian (G)
11614 .PP
11615 .RS 4
11616 Setting this option will force the RPC client and server to transfer data in big endian\&.
11617 .sp
11618 If it is disabled, data will be transferred in little endian\&.
11619 .sp
11620 The behaviour is independent of the endianness of the host machine\&.
11621 .sp
11622 Default:
11623 \fI\fIrpc big endian\fR\fR\fI = \fR\fIno\fR\fI \fR
11624 .RE
11625
11626 rpc server dynamic port range (G)
11627 .PP
11628 .RS 4
11629 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\&.
11630 .sp
11631 This applies to RPC servers in all server roles\&.
11632 .sp
11633 Default:
11634 \fI\fIrpc server dynamic port range\fR\fR\fI = \fR\fI49152\-65535\fR\fI \fR
11635 .RE
11636
11637 rpc server port (G)
11638 .PP
11639 .RS 4
11640 Specifies which port the server should listen on for DCE/RPC over TCP/IP traffic\&.
11641 .sp
11642 This controls the default port for all protocols, except for NETLOGON\&.
11643 .sp
11644 If unset, the first available port from
11645 \m[blue]\fBrpc server dynamic port range\fR\m[]
11646 is used, e\&.g\&. 49152\&.
11647 .sp
11648 The NETLOGON server will use the next available port, e\&.g\&. 49153\&. To change this port use (eg) rpc server port:netlogon = 4000\&.
11649 .sp
11650 Furthermore, all RPC servers can have the port they use specified independenty, with (for example) rpc server port:drsuapi = 5000\&.
11651 .sp
11652 This option applies currently only when
11653 \fBsamba\fR(8)
11654 runs as an active directory domain controller\&.
11655 .sp
11656 The default value 0 causes Samba to select the first available port from
11657 \m[blue]\fBrpc server dynamic port range\fR\m[]\&.
11658 .sp
11659 Default:
11660 \fI\fIrpc server port\fR\fR\fI = \fR\fI0\fR\fI \fR
11661 .RE
11662
11663 rpc start on demand helpers (G)
11664 .PP
11665 .RS 4
11666 This global parameter determines if
11667 samba\-dcerpcd
11668 should be started on demand to service named pipe (np) DCE\-RPC requests from
11669 smbd
11670 or
11671 winbindd\&. This is the normal case where no startup scripts have been modified to start
11672 samba\-dcerpcd
11673 as a daemon\&.
11674 .sp
11675 If
11676 samba\-dcerpcd
11677 is started as a daemon or via a system service manager such as systemd, this parameter MUST be set to "no", otherwise
11678 samba\-dcerpcd
11679 will fail to start\&.
11680 .sp
11681 Default:
11682 \fI\fIrpc start on demand helpers\fR\fR\fI = \fR\fIyes\fR\fI \fR
11683 .RE
11684
11685 samba kcc command (G)
11686 .PP
11687 .RS 4
11688 This option specifies the path to the Samba KCC command\&. This script is used for replication topology replication\&.
11689 .sp
11690 It should not be necessary to modify this option except for testing purposes or if the
11691 samba_kcc
11692 was installed in a non\-default location\&.
11693 .sp
11694 Default:
11695 \fI\fIsamba kcc command\fR\fR\fI = \fR\fI/build/reproducible\-path/samba\-4\&.24\&.3+dfsg/source4/scripting/bin/samba_kcc\fR\fI \fR
11696 .sp
11697 Example:
11698 \fI\fIsamba kcc command\fR\fR\fI = \fR\fI/usr/local/bin/kcc\fR\fI \fR
11699 .RE
11700
11701 security (G)
11702 .PP
11703 .RS 4
11704 This option affects how clients respond to Samba and is one of the most important settings in the
11705 smb\&.conf
11706 file\&.
11707 .sp
11708 Unless
11709 \m[blue]\fBserver role\fR\m[]
11710 is specified, the default is
11711 security = user, as this is the most common setting, used for a standalone file server or a DC\&.
11712 .sp
11713 The alternatives to
11714 security = user
11715 are
11716 security = ads
11717 or
11718 security = domain, which support joining Samba to a Windows domain
11719 .sp
11720 You should use
11721 security = user
11722 and
11723 \m[blue]\fBmap to guest\fR\m[]
11724 if you want to mainly setup shares without a password (guest shares)\&. This is commonly used for a shared printer server\&.
11725 .sp
11726 The different settings will now be explained\&.
11727 .sp
11728 \fISECURITY = AUTO\fR
11729 .sp
11730 This is the default security setting in Samba, and causes Samba to consult the
11731 \m[blue]\fBserver role\fR\m[]
11732 parameter (if set) to determine the security mode\&.
11733 .sp
11734 \fISECURITY = USER\fR
11735 .sp
11736 If
11737 \m[blue]\fBserver role\fR\m[]
11738 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
11739 \m[blue]\fBusername map\fR\m[]
11740 parameter)\&. Encrypted passwords (see the
11741 \m[blue]\fBencrypt passwords\fR\m[]
11742 parameter) can also be used in this security mode\&. Parameters such as
11743 \m[blue]\fBforce user\fR\m[]
11744 and
11745 \m[blue]\fBguest only\fR\m[]
11746 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\&.
11747 .sp
11748 \fINote\fR
11749 that the name of the resource being requested is
11750 \fInot\fR
11751 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
11752 \m[blue]\fBguest account\fR\m[]\&. See the
11753 \m[blue]\fBmap to guest\fR\m[]
11754 parameter for details on doing this\&.
11755 .sp
11756 \fISECURITY = DOMAIN\fR
11757 .sp
11758 This mode will only work correctly if
11759 \fBnet\fR(8)
11760 has been used to add this machine into a Windows NT Domain\&. It expects the
11761 \m[blue]\fBencrypt passwords\fR\m[]
11762 parameter to be set to
11763 \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\&.
11764 .sp
11765 \fINote\fR
11766 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\&.
11767 .sp
11768 \fINote\fR
11769 that from the client\*(Aqs point of view
11770 security = domain
11771 is the same as
11772 security = user\&. It only affects how the server deals with the authentication, it does not in any way affect what the client sees\&.
11773 .sp
11774 \fINote\fR
11775 that the name of the resource being requested is
11776 \fInot\fR
11777 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
11778 \m[blue]\fBguest account\fR\m[]\&. See the
11779 \m[blue]\fBmap to guest\fR\m[]
11780 parameter for details on doing this\&.
11781 .sp
11782 See also the
11783 \m[blue]\fBpassword server\fR\m[]
11784 parameter and the
11785 \m[blue]\fBencrypt passwords\fR\m[]
11786 parameter\&.
11787 .sp
11788 \fISECURITY = ADS\fR
11789 .sp
11790 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\&.
11791 .sp
11792 Note that this mode does NOT make Samba operate as a Active Directory Domain Controller\&.
11793 .sp
11794 Note that this forces
11795 \m[blue]\fBrequire strong key = yes\fR\m[]
11796 and
11797 \m[blue]\fBclient schannel = yes\fR\m[]
11798 for the primary domain\&.
11799 .sp
11800 Read the chapter about Domain Membership in the HOWTO for details\&.
11801 .sp
11802 Default:
11803 \fI\fIsecurity\fR\fR\fI = \fR\fIAUTO\fR\fI \fR
11804 .sp
11805 Example:
11806 \fI\fIsecurity\fR\fR\fI = \fR\fIDOMAIN\fR\fI \fR
11807 .RE
11808
11809 security mask (S)
11810 .PP
11811 .RS 4
11812 This parameter has been removed for Samba 4\&.0\&.0\&.
11813 .sp
11814 \fINo default\fR
11815 .RE
11816
11817 server addresses (S)
11818 .PP
11819 .RS 4
11820 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\&.
11821 .sp
11822 An empty list means to offer a share on all interfaces\&.
11823 .sp
11824 Default:
11825 \fI\fIserver addresses\fR\fR\fI = \fR\fI\fR\fI \fR
11826 .RE
11827
11828 max protocol
11829 .PP
11830 .RS 4
11831 This parameter is a synonym for
11832 server max protocol\&.
11833 .RE
11834
11835 protocol
11836 .PP
11837 .RS 4
11838 This parameter is a synonym for
11839 server max protocol\&.
11840 .RE
11841
11842 server max protocol (G)
11843 .PP
11844 .RS 4
11845 The value of the parameter (a string) is the highest protocol level that will be supported by the server\&.
11846 .sp
11847 Possible values are :
11848 .RS
11849 .sp
11850 .RS 4
11851 .ie n \{\
11852 \h'-04'\(bu\h'+03'\c
11853 .\}
11854 .el \{\
11855 .sp -1
11856 .IP \(bu 2.3
11857 .\}
11858 \fBLANMAN1\fR: First
11859 \fImodern\fR
11860 version of the protocol\&. Long filename support\&.
11861 .RE
11862 .sp
11863 .RS 4
11864 .ie n \{\
11865 \h'-04'\(bu\h'+03'\c
11866 .\}
11867 .el \{\
11868 .sp -1
11869 .IP \(bu 2.3
11870 .\}
11871 \fBLANMAN2\fR: Updates to Lanman1 protocol\&.
11872 .RE
11873 .sp
11874 .RS 4
11875 .ie n \{\
11876 \h'-04'\(bu\h'+03'\c
11877 .\}
11878 .el \{\
11879 .sp -1
11880 .IP \(bu 2.3
11881 .\}
11882 \fBNT1\fR: Current up to date version of the protocol\&. Used by Windows NT\&. Known as CIFS\&.
11883 .RE
11884 .sp
11885 .RS 4
11886 .ie n \{\
11887 \h'-04'\(bu\h'+03'\c
11888 .\}
11889 .el \{\
11890 .sp -1
11891 .IP \(bu 2.3
11892 .\}
11893 \fBSMB2\fR: Re\-implementation of the SMB protocol\&. Used by Windows Vista and later versions of Windows\&. SMB2 has sub protocols available\&.
11894 .RS
11895 .sp
11896 .RS 4
11897 .ie n \{\
11898 \h'-04'\(bu\h'+03'\c
11899 .\}
11900 .el \{\
11901 .sp -1
11902 .IP \(bu 2.3
11903 .\}
11904 \fBSMB2_02\fR: The earliest SMB2 version\&.
11905 .RE
11906 .sp
11907 .RS 4
11908 .ie n \{\
11909 \h'-04'\(bu\h'+03'\c
11910 .\}
11911 .el \{\
11912 .sp -1
11913 .IP \(bu 2.3
11914 .\}
11915 \fBSMB2_10\fR: Windows 7 SMB2 version\&.
11916 .RE
11917 .sp
11918 .RE
11919 By default SMB2 selects the SMB2_10 variant\&.
11920 .RE
11921 .sp
11922 .RS 4
11923 .ie n \{\
11924 \h'-04'\(bu\h'+03'\c
11925 .\}
11926 .el \{\
11927 .sp -1
11928 .IP \(bu 2.3
11929 .\}
11930 \fBSMB3\fR: The same as SMB2\&. Used by Windows 8\&. SMB3 has sub protocols available\&.
11931 .RS
11932 .sp
11933 .RS 4
11934 .ie n \{\
11935 \h'-04'\(bu\h'+03'\c
11936 .\}
11937 .el \{\
11938 .sp -1
11939 .IP \(bu 2.3
11940 .\}
11941 \fBSMB3_00\fR: Windows 8 SMB3 version\&.
11942 .RE
11943 .sp
11944 .RS 4
11945 .ie n \{\
11946 \h'-04'\(bu\h'+03'\c
11947 .\}
11948 .el \{\
11949 .sp -1
11950 .IP \(bu 2.3
11951 .\}
11952 \fBSMB3_02\fR: Windows 8\&.1 SMB3 version\&.
11953 .RE
11954 .sp
11955 .RS 4
11956 .ie n \{\
11957 \h'-04'\(bu\h'+03'\c
11958 .\}
11959 .el \{\
11960 .sp -1
11961 .IP \(bu 2.3
11962 .\}
11963 \fBSMB3_11\fR: Windows 10 SMB3 version\&.
11964 .RE
11965 .sp
11966 .RE
11967 By default SMB3 selects the SMB3_11 variant\&.
11968 .RE
11969 .sp
11970 .RE
11971 Normally this option should not be set as the automatic negotiation phase in the SMB protocol takes care of choosing the appropriate protocol\&.
11972 .sp
11973 Default:
11974 \fI\fIserver max protocol\fR\fR\fI = \fR\fISMB3\fR\fI \fR
11975 .sp
11976 Example:
11977 \fI\fIserver max protocol\fR\fR\fI = \fR\fILANMAN1\fR\fI \fR
11978 .RE
11979
11980 min protocol
11981 .PP
11982 .RS 4
11983 This parameter is a synonym for
11984 server min protocol\&.
11985 .RE
11986
11987 server min protocol (G)
11988 .PP
11989 .RS 4
11990 This setting controls the minimum protocol version that the server will allow the client to use\&.
11991 .sp
11992 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\&.
11993 .sp
11994 See
11995 Related command: \m[blue]\fBserver max protocol\fR\m[]
11996 for a full list of available protocols\&.
11997 .sp
11998 Default:
11999 \fI\fIserver min protocol\fR\fR\fI = \fR\fISMB2_02\fR\fI \fR
12000 .sp
12001 Example:
12002 \fI\fIserver min protocol\fR\fR\fI = \fR\fINT1\fR\fI \fR
12003 .RE
12004
12005 server multi channel support (G)
12006 .PP
12007 .RS 4
12008 This boolean parameter controls whether
12009 \fBsmbd\fR(8)
12010 will support SMB3 multi\-channel\&.
12011 .sp
12012 This parameter was added with version 4\&.4\&.
12013 .sp
12014 Note that this feature was still considered experimental up to 4\&.14\&.
12015 .sp
12016 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
12017 \fBforce:server multi channel support=yes\fR
12018 in addition\&.
12019 .sp
12020 This option is enabled by default starting with to 4\&.15 (on Linux and FreeBSD)\&.
12021 .sp
12022 Default:
12023 \fI\fIserver multi channel support\fR\fR\fI = \fR\fIyes\fR\fI \fR
12024 .RE
12025
12026 server reject aes schannel (G)
12027 .PP
12028 .RS 4
12029 \fIThis option is experimental for now!\fR
12030 .sp
12031 This option controls whether the netlogon server (currently only in \*(Aqactive directory domain controller\*(Aq mode), will reject clients which do not support ServerAuthenticateKerberos\&.
12032 .sp
12033 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\&.
12034 .sp
12035 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\&.
12036 .sp
12037 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)\&.
12038 .sp
12039 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
12040 .sp
12041 Admins can use \*(Aq\m[blue]\fBserver reject aes schannel:COMPUTERACCOUNT = no/yes\fR\m[]\*(Aq options in order to have more control
12042 .sp
12043 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\&.
12044 .sp
12045 This option interacts with the \*(Aq\m[blue]\fBserver support krb5 netlogon\fR\m[]\*(Aq option\&.
12046 .sp
12047 For now \*(Aq\m[blue]\fBserver reject aes schannel\fR\m[]\*(Aq is EXPERIMENTAL and should not be configured explicitly\&.
12048 .sp
12049 Default:
12050 \fI\fIserver reject aes schannel\fR\fR\fI = \fR\fIno\fR\fI \fR
12051 .sp
12052 Example:
12053 \fI\fIserver reject aes schannel\fR\fR\fI = \fR\fIyes\fR\fI \fR
12054 .RE
12055
12056 server reject aes schannel:COMPUTERACCOUNT (G)
12057 .PP
12058 .RS 4
12059 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)\&.
12060 .sp
12061 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\&.
12062 .sp
12063 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)\&.
12064 .sp
12065 Samba will log a warning in the log files at log level 5 if a setting is still needed for the specified computer account\&.
12066 .sp
12067 This option overrides the
12068 \m[blue]\fBserver reject aes schannel\fR\m[]
12069 option\&.
12070 .sp
12071 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\&.
12072 .sp
12073 .if n \{\
12074 .RS 4
12075 .\}
12076 .nf
12077 server reject aes schannel:LEGACYCOMPUTER1$ = no
12078 server reject aes schannel:NASBOX$ = no
12079 server reject aes schannel:LEGACYCOMPUTER2$ = no
12080 server reject aes schannel:HIGHPRIVACYSRV$ = yes
12081
12082 .fi
12083 .if n \{\
12084 .RE
12085 .\}
12086 .sp
12087 \fINo default\fR
12088 .RE
12089
12090 server role (G)
12091 .PP
12092 .RS 4
12093 This option determines the basic operating mode of a Samba server and is one of the most important settings in the
12094 smb\&.conf
12095 file\&.
12096 .sp
12097 The default is
12098 server role = auto, as causes Samba to operate according to the
12099 \m[blue]\fBsecurity\fR\m[]
12100 setting, or if not specified as a simple file server that is not connected to any domain\&.
12101 .sp
12102 The alternatives are
12103 server role = standalone
12104 or
12105 server role = member server, which support joining Samba to a Windows domain, along with
12106 server role = domain controller, which run Samba as a Windows domain controller\&.
12107 .sp
12108 You should use
12109 server role = standalone
12110 and
12111 \m[blue]\fBmap to guest\fR\m[]
12112 if you want to mainly setup shares without a password (guest shares)\&. This is commonly used for a shared printer server\&.
12113 .sp
12114 \fISERVER ROLE = AUTO\fR
12115 .sp
12116 This is the default server role in Samba, and causes Samba to consult the
12117 \m[blue]\fBsecurity\fR\m[]
12118 parameter (if set) to determine the server role, giving compatible behaviours to previous Samba versions\&.
12119 .sp
12120 \fISERVER ROLE = STANDALONE\fR
12121 .sp
12122 If
12123 \m[blue]\fBsecurity\fR\m[]
12124 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
12125 \m[blue]\fBusername map\fR\m[]
12126 parameter) stored on this machine\&. Encrypted passwords (see the
12127 \m[blue]\fBencrypt passwords\fR\m[]
12128 parameter) are by default used in this security mode\&. Parameters such as
12129 \m[blue]\fBforce user\fR\m[]
12130 and
12131 \m[blue]\fBguest only\fR\m[]
12132 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\&.
12133 .sp
12134 \fISERVER ROLE = MEMBER SERVER\fR
12135 .sp
12136 This mode will only work correctly if
12137 \fBnet\fR(8)
12138 has been used to add this machine into a Windows Domain\&. It expects the
12139 \m[blue]\fBencrypt passwords\fR\m[]
12140 parameter to be set to
12141 \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\&.
12142 .sp
12143 \fINote\fR
12144 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\&.
12145 .sp
12146 \fISERVER ROLE = CLASSIC PRIMARY DOMAIN CONTROLLER\fR
12147 .sp
12148 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)\&.
12149 .sp
12150 \fISERVER ROLE = CLASSIC BACKUP DOMAIN CONTROLLER\fR
12151 .sp
12152 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\&.
12153 .sp
12154 \fISERVER ROLE = ACTIVE DIRECTORY DOMAIN CONTROLLER\fR
12155 .sp
12156 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
12157 Samba4 HOWTO
12158 .sp
12159 \fISERVER ROLE = IPA PRIMARY DOMAIN CONTROLLER\fR
12160 .sp
12161 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\&.
12162 .sp
12163 Default:
12164 \fI\fIserver role\fR\fR\fI = \fR\fIAUTO\fR\fI \fR
12165 .sp
12166 Example:
12167 \fI\fIserver role\fR\fR\fI = \fR\fIACTIVE DIRECTORY DOMAIN CONTROLLER\fR\fI \fR
12168 .RE
12169
12170 server schannel (G)
12171 .PP
12172 .RS 4
12173 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)\&.
12174 .sp
12175 \fIAvoid using this option!\fR
12176 Use explicit \*(Aq\m[blue]\fBserver require schannel:COMPUTERACCOUNT = no\fR\m[]\*(Aq instead!
12177 .sp
12178 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)\&.
12179 .sp
12180 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\&.
12181 .sp
12182 See
12183 CVE\-2020\-1472(ZeroLogon),
12184 https://bugzilla\&.samba\&.org/show_bug\&.cgi?id=14497\&.
12185 .sp
12186 This option is over\-ridden by the
12187 \m[blue]\fBserver require schannel:COMPUTERACCOUNT\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 Default:
12193 \fI\fIserver schannel\fR\fR\fI = \fR\fIyes\fR\fI \fR
12194 .RE
12195
12196 server require schannel:COMPUTERACCOUNT (G)
12197 .PP
12198 .RS 4
12199 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)\&.
12200 .sp
12201 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)\&.
12202 .sp
12203 Samba will warn in the log files at log level 5, if a setting is still needed for the specified computer account\&.
12204 .sp
12205 See
12206 CVE\-2020\-1472(ZeroLogon),
12207 https://bugzilla\&.samba\&.org/show_bug\&.cgi?id=14497\&.
12208 .sp
12209 This option overrides the
12210 \m[blue]\fBserver schannel\fR\m[]
12211 option\&.
12212 .sp
12213 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\&.
12214 .sp
12215 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
12216 .sp
12217 .if n \{\
12218 .RS 4
12219 .\}
12220 .nf
12221 server require schannel:LEGACYCOMPUTER1$ = no
12222 server require schannel seal:LEGACYCOMPUTER1$ = no
12223 server require schannel:NASBOX$ = no
12224 server require schannel seal:NASBOX$ = no
12225 server require schannel:LEGACYCOMPUTER2$ = no
12226 server require schannel seal:LEGACYCOMPUTER2$ = no
12227
12228 .fi
12229 .if n \{\
12230 .RE
12231 .\}
12232 .sp
12233 \fINo default\fR
12234 .RE
12235
12236 server schannel require seal (G)
12237 .PP
12238 .RS 4
12239 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)\&.
12240 .sp
12241 This option controls whether the netlogon server, will reject the usage of netlogon secure channel without privacy/enryption\&.
12242 .sp
12243 The option is modelled after the registry key available on Windows\&.
12244 .sp
12245 .if n \{\
12246 .RS 4
12247 .\}
12248 .nf
12249 HKEY_LOCAL_MACHINE\eSYSTEM\eCurrentControlSet\eServices\eNetlogon\eParameters\eRequireSeal=2
12250
12251 .fi
12252 .if n \{\
12253 .RE
12254 .\}
12255 .sp
12256 \fIAvoid using this option!\fR
12257 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
12258 CVE\-2022\-38023
12259 see
12260 https://bugzilla\&.samba\&.org/show_bug\&.cgi?id=15240\&.
12261 .sp
12262 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)\&.
12263 .sp
12264 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\&.
12265 .sp
12266 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\&.
12267 .sp
12268 This option is over\-ridden by the
12269 \m[blue]\fBserver schannel require seal:COMPUTERACCOUNT\fR\m[]
12270 option\&.
12271 .sp
12272 Default:
12273 \fI\fIserver schannel require seal\fR\fR\fI = \fR\fIyes\fR\fI \fR
12274 .RE
12275
12276 server schannel require seal:COMPUTERACCOUNT (G)
12277 .PP
12278 .RS 4
12279 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)\&.
12280 .sp
12281 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)\&.
12282 .sp
12283 Samba will warn in the log files at log level 5, if a setting is still needed for the specified computer account\&.
12284 .sp
12285 See
12286 CVE\-2022\-38023,
12287 https://bugzilla\&.samba\&.org/show_bug\&.cgi?id=15240\&.
12288 .sp
12289 This option overrides the \*(Aq\m[blue]\fBserver schannel require seal\fR\m[]\*(Aq option\&.
12290 .sp
12291 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\&.
12292 .sp
12293 .if n \{\
12294 .RS 4
12295 .\}
12296 .nf
12297 server require schannel seal:LEGACYCOMPUTER1$ = no
12298 server require schannel seal:NASBOX$ = no
12299 server require schannel seal:LEGACYCOMPUTER2$ = no
12300
12301 .fi
12302 .if n \{\
12303 .RE
12304 .\}
12305 .sp
12306 \fINo default\fR
12307 .RE
12308
12309 server services (G)
12310 .PP
12311 .RS 4
12312 This option contains the services that the Samba daemon will run\&.
12313 .sp
12314 An entry in the
12315 smb\&.conf
12316 file can either override the previous value completely or entries can be removed from or added to it by prefixing them with
12317 \fB+\fR
12318 or
12319 \fB\-\fR\&.
12320 .sp
12321 Default:
12322 \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
12323 .sp
12324 Example:
12325 \fI\fIserver services\fR\fR\fI = \fR\fI\-s3fs, +smb\fR\fI \fR
12326 .RE
12327
12328 server signing (G)
12329 .PP
12330 .RS 4
12331 This controls whether the client is allowed or required to use SMB1 and SMB2 signing\&. Possible values are
12332 \fIdefault\fR,
12333 \fIauto\fR,
12334 \fImandatory\fR
12335 and
12336 \fIdisabled\fR\&.
12337 .sp
12338 By default, and when smb signing is set to
12339 \fIdefault\fR, smb signing is required when
12340 \m[blue]\fBserver role\fR\m[]
12341 is
12342 \fIactive directory domain controller\fR
12343 and disabled otherwise\&.
12344 .sp
12345 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\&.
12346 .sp
12347 For the SMB2 protocol, by design, signing cannot be disabled\&. In the case where SMB2 is negotiated, if this parameter is set to
12348 \fIdisabled\fR, it will be treated as
12349 \fIauto\fR\&. Setting it to
12350 \fImandatory\fR
12351 will still require SMB2 clients to use signing\&.
12352 .sp
12353 Default:
12354 \fI\fIserver signing\fR\fR\fI = \fR\fIdefault\fR\fI \fR
12355 .RE
12356
12357 server smb encrypt (S)
12358 .PP
12359 .RS 4
12360 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:
12361 .RS
12362 .sp
12363 .RS 4
12364 .ie n \{\
12365 \h'-04'\(bu\h'+03'\c
12366 .\}
12367 .el \{\
12368 .sp -1
12369 .IP \(bu 2.3
12370 .\}
12371 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\&.
12372 .RE
12373 .sp
12374 .RS 4
12375 .ie n \{\
12376 \h'-04'\(bu\h'+03'\c
12377 .\}
12378 .el \{\
12379 .sp -1
12380 .IP \(bu 2.3
12381 .\}
12382 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\&.
12383 .RE
12384 .sp
12385 .RE
12386 This parameter can be set globally and on a per\-share bases\&. Possible values are
12387 \fIoff\fR,
12388 \fIif_required\fR,
12389 \fIdesired\fR, and
12390 \fIrequired\fR\&. A special value is
12391 \fIdefault\fR
12392 which is the implicit default setting of
12393 \fIif_required\fR\&.
12394 .PP
12395 \fIEffects for SMB1\fR
12396 .RS 4
12397 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\&.
12398 .sp
12399 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
12400 \fImust\fR
12401 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\&.
12402 .sp
12403 If SMB encryption is selected, Windows style SMB signing (see the
12404 \m[blue]\fBserver signing\fR\m[]
12405 option) is no longer necessary, as the GSSAPI flags use select both signing and sealing of the data\&.
12406 .sp
12407 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\&.
12408 .RE
12409 .PP
12410 \fIEffects for SMB3\&.0 and newer\fR
12411 .RS 4
12412 Native SMB transport encryption is available in SMB version 3\&.0 or newer\&. It is only offered by Samba if
12413 \fIserver max protocol\fR
12414 is set to
12415 \fISMB3\fR
12416 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\&.
12417 .sp
12418 The protocol implementation offers various options:
12419 .RS
12420 .sp
12421 .RS 4
12422 .ie n \{\
12423 \h'-04'\(bu\h'+03'\c
12424 .\}
12425 .el \{\
12426 .sp -1
12427 .IP \(bu 2.3
12428 .\}
12429 The capability to perform SMB encryption can be negotiated during protocol negotiation\&.
12430 .RE
12431 .sp
12432 .RS 4
12433 .ie n \{\
12434 \h'-04'\(bu\h'+03'\c
12435 .\}
12436 .el \{\
12437 .sp -1
12438 .IP \(bu 2.3
12439 .\}
12440 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\&.
12441 .RE
12442 .sp
12443 .RS 4
12444 .ie n \{\
12445 \h'-04'\(bu\h'+03'\c
12446 .\}
12447 .el \{\
12448 .sp -1
12449 .IP \(bu 2.3
12450 .\}
12451 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\&.
12452 .RE
12453 .sp
12454 .RS 4
12455 .ie n \{\
12456 \h'-04'\(bu\h'+03'\c
12457 .\}
12458 .el \{\
12459 .sp -1
12460 .IP \(bu 2.3
12461 .\}
12462 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\&.
12463 .RE
12464 .sp
12465 .RE
12466 These features can be controlled with settings of
12467 \fIserver smb encrypt\fR
12468 as follows:
12469 .RS
12470 .sp
12471 .RS 4
12472 .ie n \{\
12473 \h'-04'\(bu\h'+03'\c
12474 .\}
12475 .el \{\
12476 .sp -1
12477 .IP \(bu 2.3
12478 .\}
12479 Leaving it as default, explicitly setting
12480 \fIdefault\fR, or setting it to
12481 \fIif_required\fR
12482 globally will enable negotiation of encryption but will not turn on data encryption globally or per share\&.
12483 .RE
12484 .sp
12485 .RS 4
12486 .ie n \{\
12487 \h'-04'\(bu\h'+03'\c
12488 .\}
12489 .el \{\
12490 .sp -1
12491 .IP \(bu 2.3
12492 .\}
12493 Setting it to
12494 \fIdesired\fR
12495 globally will enable negotiation and will turn on data encryption on sessions and share connections for those clients that support it\&.
12496 .RE
12497 .sp
12498 .RS 4
12499 .ie n \{\
12500 \h'-04'\(bu\h'+03'\c
12501 .\}
12502 .el \{\
12503 .sp -1
12504 .IP \(bu 2.3
12505 .\}
12506 Setting it to
12507 \fIrequired\fR
12508 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\&.
12509 .RE
12510 .sp
12511 .RS 4
12512 .ie n \{\
12513 \h'-04'\(bu\h'+03'\c
12514 .\}
12515 .el \{\
12516 .sp -1
12517 .IP \(bu 2.3
12518 .\}
12519 Setting it to
12520 \fIoff\fR
12521 globally will completely disable the encryption feature for all connections\&. Setting
12522 \fIserver smb encrypt = required\fR
12523 for individual shares (while it\*(Aqs globally off) will deny access to this shares for all clients\&.
12524 .RE
12525 .sp
12526 .RS 4
12527 .ie n \{\
12528 \h'-04'\(bu\h'+03'\c
12529 .\}
12530 .el \{\
12531 .sp -1
12532 .IP \(bu 2.3
12533 .\}
12534 Setting it to
12535 \fIdesired\fR
12536 on a share will turn on data encryption for this share for clients that support encryption if negotiation has been enabled globally\&.
12537 .RE
12538 .sp
12539 .RS 4
12540 .ie n \{\
12541 \h'-04'\(bu\h'+03'\c
12542 .\}
12543 .el \{\
12544 .sp -1
12545 .IP \(bu 2.3
12546 .\}
12547 Setting it to
12548 \fIrequired\fR
12549 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\&.
12550 .sp
12551 Note that this allows per\-share enforcing to be controlled in Samba differently from Windows: In Windows,
12552 \fIRejectUnencryptedAccess\fR
12553 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
12554 \fIserver smb encrypt\fR
12555 to
12556 \fIif_required\fR, and then set all shares that should be encrypted to
12557 \fIrequired\fR\&. Additionally, it is possible in Samba to have some shares with encryption
12558 \fIrequired\fR
12559 and some other shares with encryption only
12560 \fIdesired\fR, which is not possible in Windows\&.
12561 .RE
12562 .sp
12563 .RS 4
12564 .ie n \{\
12565 \h'-04'\(bu\h'+03'\c
12566 .\}
12567 .el \{\
12568 .sp -1
12569 .IP \(bu 2.3
12570 .\}
12571 Setting it to
12572 \fIoff\fR
12573 or
12574 \fIif_required\fR
12575 for a share has no effect\&.
12576 .RE
12577 .sp
12578 .RE
12579 .RE
12580 .sp
12581 Default:
12582 \fI\fIserver smb encrypt\fR\fR\fI = \fR\fIdefault\fR\fI \fR
12583 .RE
12584
12585 server smb3 encryption algorithms (G)
12586 .PP
12587 .RS 4
12588 This parameter specifies the availability and order of encryption algorithms which are available for negotiation in the SMB3_11 dialect\&.
12589 .sp
12590 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\&.
12591 .sp
12592 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\&.
12593 .sp
12594 Default:
12595 \fI\fIserver smb3 encryption algorithms\fR\fR\fI = \fR\fIAES\-128\-GCM, AES\-128\-CCM, AES\-256\-GCM, AES\-256\-CCM\fR\fI \fR
12596 .sp
12597 Example:
12598 \fI\fIserver smb3 encryption algorithms\fR\fR\fI = \fR\fIAES\-256\-GCM\fR\fI \fR
12599 .sp
12600 Example:
12601 \fI\fIserver smb3 encryption algorithms\fR\fR\fI = \fR\fI\-AES\-128\-GCM \-AES\-128\-CCM\fR\fI \fR
12602 .RE
12603
12604 server smb encryption over quic (G)
12605 .PP
12606 .RS 4
12607 This parameter controls whether the SMB server requires SMB\-level encryption although the transport is encrypted via QUIC\&.
12608 .sp
12609 \fIserver smb encrypt\fR
12610 controls the use of the encryption mechanism introduced with SMB3\&.0\&. If
12611 \fIserver smb encryption over quic\fR
12612 value is set to
12613 \fIno\fR,
12614 \fIand\fR
12615 the client connects via a validated QUIC (and thus TLS) connection, the server ignores the requirements from the parameter
12616 \fIserver smb encrypt\fR
12617 and accepts all SMB\-level packets inside the QUIC connection as encrypted in a trustworthy way\&. This avoids costly double\-encryption\&.
12618 .sp
12619 If
12620 \fIserver smb encryption over quic\fR
12621 is left at its default
12622 \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
12623 \fIserver smb encrypt\fR
12624 apply\&.
12625 .sp
12626 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
12627 \fIserver smb encryption over quic\fR
12628 parameter\&.
12629 .sp
12630 Windows has a similar SMB server setting with the
12631 \fIDisableSmbEncryptionOnSecureConnection\fR
12632 switch in the
12633 Set\-SmbServerConfiguration
12634 PowerShell commandlet\&.
12635 .sp
12636 Default:
12637 \fI\fIserver smb encryption over quic\fR\fR\fI = \fR\fIyes\fR\fI \fR
12638 .RE
12639
12640 server smb3 signing algorithms (G)
12641 .PP
12642 .RS 4
12643 This parameter specifies the availability and order of signing algorithms which are available for negotiation in the SMB3_11 dialect\&.
12644 .sp
12645 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\&.
12646 .sp
12647 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\&.
12648 .sp
12649 Default:
12650 \fI\fIserver smb3 signing algorithms\fR\fR\fI = \fR\fIAES\-128\-GMAC, AES\-128\-CMAC, HMAC\-SHA256\fR\fI \fR
12651 .sp
12652 Example:
12653 \fI\fIserver smb3 signing algorithms\fR\fR\fI = \fR\fIAES\-128\-CMAC, HMAC\-SHA256\fR\fI \fR
12654 .sp
12655 Example:
12656 \fI\fIserver smb3 signing algorithms\fR\fR\fI = \fR\fI\-AES\-128\-CMAC\fR\fI \fR
12657 .RE
12658
12659 server smb transports (G)
12660 .PP
12661 .RS 4
12662 Specifies which transports and ports the server should listen on for SMB traffic\&.
12663 .sp
12664 The order matters only for mDNS registrations, the first \*(Aqtcp\*(Aq or \*(Aqnbt\*(Aq port is used for that\&.
12665 .sp
12666 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\&.
12667 .sp
12668 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\&.
12669 .sp
12670 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:
12671 \m[blue]\fBtls enabled\fR\m[],
12672 \m[blue]\fBtls cafile\fR\m[],
12673 \m[blue]\fBtls certfile\fR\m[]
12674 and
12675 \m[blue]\fBtls keyfile\fR\m[]\&. If the files pointed to by
12676 \m[blue]\fBtls cafile\fR\m[],
12677 \m[blue]\fBtls certfile\fR\m[]
12678 and
12679 \m[blue]\fBtls keyfile\fR\m[]
12680 all do not exist, a self\-signed tls certificate is generated automatically at startup\&.
12681 .sp
12682 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\&.
12683 .sp
12684 Numerical ports are handled as \*(Aqtcp\*(Aq except port \*(Aq139\*(Aq is handled as \*(Aqnbt\*(Aq\&.
12685 .sp
12686 Note that\*(Aqs currently a limit of 10 unique transports, all others will be ignored\&.
12687 .sp
12688 Default:
12689 \fI\fIserver smb transports\fR\fR\fI = \fR\fItcp, nbt\fR\fI \fR
12690 .sp
12691 Example:
12692 \fI\fIserver smb transports\fR\fR\fI = \fR\fI445\fR\fI \fR
12693 .sp
12694 Example:
12695 \fI\fIserver smb transports\fR\fR\fI = \fR\fItcp, tcp:1445\fR\fI \fR
12696 .sp
12697 Example:
12698 \fI\fIserver smb transports\fR\fR\fI = \fR\fI8000, nbt:1139\fR\fI \fR
12699 .sp
12700 Example:
12701 \fI\fIserver smb transports\fR\fR\fI = \fR\fItcp, quic, nbt\fR\fI \fR
12702 .sp
12703 Example:
12704 \fI\fIserver smb transports\fR\fR\fI = \fR\fI+quic\fR\fI \fR
12705 .RE
12706
12707 smb ports (G)
12708 .PP
12709 .RS 4
12710 This is a synonym for
12711 \m[blue]\fBserver smb transports\fR\m[]\&.
12712 .sp
12713 \fINo default\fR
12714 .RE
12715
12716 server string (G)
12717 .PP
12718 .RS 4
12719 This controls what string will show up in the printer comment box in print manager and next to the IPC connection in
12720 net view\&. It can be any string that you wish to show to your users\&.
12721 .sp
12722 It also sets what will appear in browse lists next to the machine name\&.
12723 .sp
12724 A
12725 \fI%v\fR
12726 will be replaced with the Samba version number\&.
12727 .sp
12728 A
12729 \fI%h\fR
12730 will be replaced with the hostname\&.
12731 .sp
12732 Default:
12733 \fI\fIserver string\fR\fR\fI = \fR\fISamba %v\fR\fI \fR
12734 .sp
12735 Example:
12736 \fI\fIserver string\fR\fR\fI = \fR\fIUniversity of GNUs Samba Server\fR\fI \fR
12737 .RE
12738
12739 server support krb5 netlogon (G)
12740 .PP
12741 .RS 4
12742 \fIThis option is experimental for now!\fR
12743 .sp
12744 This option controls whether the netlogon server (currently only in \*(Aqactive directory domain controller\*(Aq mode), will provide support for ServerAuthenticateKerberos\&.
12745 .sp
12746 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\&.
12747 .sp
12748 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\&.
12749 .sp
12750 Default:
12751 \fI\fIserver support krb5 netlogon\fR\fR\fI = \fR\fIno\fR\fI \fR
12752 .sp
12753 Example:
12754 \fI\fIserver support krb5 netlogon\fR\fR\fI = \fR\fIyes\fR\fI \fR
12755 .RE
12756
12757 set primary group script (G)
12758 .PP
12759 .RS 4
12760 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
12761 net rpc vampire\&.
12762 \fI%u\fR
12763 will be replaced with the user whose primary group is to be set\&.
12764 \fI%g\fR
12765 will be replaced with the group to set\&.
12766 .sp
12767 Default:
12768 \fI\fIset primary group script\fR\fR\fI = \fR\fI\fR\fI \fR
12769 .sp
12770 Example:
12771 \fI\fIset primary group script\fR\fR\fI = \fR\fI/usr/sbin/usermod \-g \*(Aq%g\*(Aq \*(Aq%u\*(Aq\fR\fI \fR
12772 .RE
12773
12774 set quota command (G)
12775 .PP
12776 .RS 4
12777 The
12778 set quota command
12779 should only be used whenever there is no operating system API available from the OS that samba can use\&.
12780 .sp
12781 This option is only available if Samba was compiled with quota support\&.
12782 .sp
12783 This parameter should specify the path to a script that can set quota for the specified arguments\&.
12784 .sp
12785 The specified script should take the following arguments:
12786 .RS
12787 .sp
12788 .RS 4
12789 .ie n \{\
12790 \h'-04'\(bu\h'+03'\c
12791 .\}
12792 .el \{\
12793 .sp -1
12794 .IP \(bu 2.3
12795 .\}
12796 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\&.
12797 .RE
12798 .sp
12799 .RS 4
12800 .ie n \{\
12801 \h'-04'\(bu\h'+03'\c
12802 .\}
12803 .el \{\
12804 .sp -1
12805 .IP \(bu 2.3
12806 .\}
12807 2 \- quota type
12808 .RS
12809 .sp
12810 .RS 4
12811 .ie n \{\
12812 \h'-04'\(bu\h'+03'\c
12813 .\}
12814 .el \{\
12815 .sp -1
12816 .IP \(bu 2.3
12817 .\}
12818 1 \- user quotas
12819 .RE
12820 .sp
12821 .RS 4
12822 .ie n \{\
12823 \h'-04'\(bu\h'+03'\c
12824 .\}
12825 .el \{\
12826 .sp -1
12827 .IP \(bu 2.3
12828 .\}
12829 2 \- user default quotas (uid = \-1)
12830 .RE
12831 .sp
12832 .RS 4
12833 .ie n \{\
12834 \h'-04'\(bu\h'+03'\c
12835 .\}
12836 .el \{\
12837 .sp -1
12838 .IP \(bu 2.3
12839 .\}
12840 3 \- group quotas
12841 .RE
12842 .sp
12843 .RS 4
12844 .ie n \{\
12845 \h'-04'\(bu\h'+03'\c
12846 .\}
12847 .el \{\
12848 .sp -1
12849 .IP \(bu 2.3
12850 .\}
12851 4 \- group default quotas (gid = \-1)
12852 .RE
12853 .sp
12854 .RE
12855 .RE
12856 .sp
12857 .RS 4
12858 .ie n \{\
12859 \h'-04'\(bu\h'+03'\c
12860 .\}
12861 .el \{\
12862 .sp -1
12863 .IP \(bu 2.3
12864 .\}
12865 3 \- id (uid for user, gid for group, \-1 if N/A)
12866 .RE
12867 .sp
12868 .RS 4
12869 .ie n \{\
12870 \h'-04'\(bu\h'+03'\c
12871 .\}
12872 .el \{\
12873 .sp -1
12874 .IP \(bu 2.3
12875 .\}
12876 4 \- quota state (0 = disable, 1 = enable, 2 = enable and enforce)
12877 .RE
12878 .sp
12879 .RS 4
12880 .ie n \{\
12881 \h'-04'\(bu\h'+03'\c
12882 .\}
12883 .el \{\
12884 .sp -1
12885 .IP \(bu 2.3
12886 .\}
12887 5 \- block softlimit
12888 .RE
12889 .sp
12890 .RS 4
12891 .ie n \{\
12892 \h'-04'\(bu\h'+03'\c
12893 .\}
12894 .el \{\
12895 .sp -1
12896 .IP \(bu 2.3
12897 .\}
12898 6 \- block hardlimit
12899 .RE
12900 .sp
12901 .RS 4
12902 .ie n \{\
12903 \h'-04'\(bu\h'+03'\c
12904 .\}
12905 .el \{\
12906 .sp -1
12907 .IP \(bu 2.3
12908 .\}
12909 7 \- inode softlimit
12910 .RE
12911 .sp
12912 .RS 4
12913 .ie n \{\
12914 \h'-04'\(bu\h'+03'\c
12915 .\}
12916 .el \{\
12917 .sp -1
12918 .IP \(bu 2.3
12919 .\}
12920 8 \- inode hardlimit
12921 .RE
12922 .sp
12923 .RS 4
12924 .ie n \{\
12925 \h'-04'\(bu\h'+03'\c
12926 .\}
12927 .el \{\
12928 .sp -1
12929 .IP \(bu 2.3
12930 .\}
12931 9(optional) \- block size, defaults to 1024
12932 .RE
12933 .sp
12934 .RE
12935 The script should output at least one line of data on success\&. And nothing on failure\&.
12936 .sp
12937 Default:
12938 \fI\fIset quota command\fR\fR\fI = \fR\fI\fR\fI \fR
12939 .sp
12940 Example:
12941 \fI\fIset quota command\fR\fR\fI = \fR\fI/usr/local/sbin/set_quota\fR\fI \fR
12942 .RE
12943
12944 share:fake_fscaps (S)
12945 .PP
12946 .RS 4
12947 This is needed to support some special applications that makes use of filesystem specific features like sparse files or block reflink copy\&.
12948 .sp
12949 With
12950 \m[blue]\fBshare:fake_fscaps = 64\fR\m[]
12951 the SPARSE_FILES (0x40) file system capability flag is set\&.
12952 .sp
12953 With
12954 \m[blue]\fBshare:fake_fscaps = 134217728\fR\m[]
12955 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\&.
12956 .sp
12957 The complete list can be found in MS\-FSCC 2\&.5\&.1 FileFsAttributeInformation\&. Note that only decimal values can be used in the configuration\&.
12958 .sp
12959 Default:
12960 \fI\fIshare:fake_fscaps\fR\fR\fI = \fR\fI0\fR\fI \fR
12961 .RE
12962
12963 short preserve case (S)
12964 .PP
12965 .RS 4
12966 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
12967 \m[blue]\fBdefault case\fR\m[]\&. This option can be use with
12968 \m[blue]\fBpreserve case = yes\fR\m[]
12969 to permit long filenames to retain their case, while short names are lowered\&.
12970 .sp
12971 See the section on
12972 NAME MANGLING\&.
12973 .sp
12974 Default:
12975 \fI\fIshort preserve case\fR\fR\fI = \fR\fIyes\fR\fI \fR
12976 .RE
12977
12978 show add printer wizard (G)
12979 .PP
12980 .RS 4
12981 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\&.
12982 .sp
12983 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\&.
12984 .sp
12985 Disabling the
12986 \fIshow add printer wizard\fR
12987 parameter will always cause the OpenPrinterEx() on the server to fail\&. Thus the APW icon will never be displayed\&.
12988 .if n \{\
12989 .sp
12990 .\}
12991 .RS 4
12992 .it 1 an-trap
12993 .nr an-no-space-flag 1
12994 .nr an-break-flag 1
12995 .br
12996 .ps +1
12997 \fBNote\fR
12998 .ps -1
12999 .br
13000 This does not prevent the same user from having administrative privilege on an individual printer\&.
13001 .sp .5v
13002 .RE
13003 Default:
13004 \fI\fIshow add printer wizard\fR\fR\fI = \fR\fIyes\fR\fI \fR
13005 .RE
13006
13007 shutdown script (G)
13008 .PP
13009 .RS 4
13010 This a full path name to a script called by
13011 \fBsmbd\fR(8)
13012 that should start a shutdown procedure\&.
13013 .sp
13014 If the connected user possesses the
13015 \fBSeRemoteShutdownPrivilege\fR, right, this command will be run as root\&.
13016 .sp
13017 The %z %t %r %f variables are expanded as follows:
13018 .RS
13019 .sp
13020 .RS 4
13021 .ie n \{\
13022 \h'-04'\(bu\h'+03'\c
13023 .\}
13024 .el \{\
13025 .sp -1
13026 .IP \(bu 2.3
13027 .\}
13028 \fI%z\fR
13029 will be substituted with the shutdown message sent to the server\&.
13030 .RE
13031 .sp
13032 .RS 4
13033 .ie n \{\
13034 \h'-04'\(bu\h'+03'\c
13035 .\}
13036 .el \{\
13037 .sp -1
13038 .IP \(bu 2.3
13039 .\}
13040 \fI%t\fR
13041 will be substituted with the number of seconds to wait before effectively starting the shutdown procedure\&.
13042 .RE
13043 .sp
13044 .RS 4
13045 .ie n \{\
13046 \h'-04'\(bu\h'+03'\c
13047 .\}
13048 .el \{\
13049 .sp -1
13050 .IP \(bu 2.3
13051 .\}
13052 \fI%r\fR
13053 will be substituted with the switch
13054 \fI\-r\fR\&. It means reboot after shutdown for NT\&.
13055 .RE
13056 .sp
13057 .RS 4
13058 .ie n \{\
13059 \h'-04'\(bu\h'+03'\c
13060 .\}
13061 .el \{\
13062 .sp -1
13063 .IP \(bu 2.3
13064 .\}
13065 \fI%f\fR
13066 will be substituted with the switch
13067 \fI\-f\fR\&. It means force the shutdown even if applications do not respond for NT\&.
13068 .RE
13069 .sp
13070 .RE
13071 Shutdown script example:
13072 .sp
13073 .if n \{\
13074 .RS 4
13075 .\}
13076 .nf
13077 #!/bin/bash
13078
13079 time=$2
13080 let time="${time} / 60"
13081 let time="${time} + 1"
13082
13083 /sbin/shutdown $3 $4 +$time $1 &
13084
13085 .fi
13086 .if n \{\
13087 .RE
13088 .\}
13089 .sp
13090 Shutdown does not return so we need to launch it in background\&.
13091 .sp
13092 Default:
13093 \fI\fIshutdown script\fR\fR\fI = \fR\fI\fR\fI \fR
13094 .sp
13095 Example:
13096 \fI\fIshutdown script\fR\fR\fI = \fR\fI/usr/local/samba/sbin/shutdown %m %t %r %f\fR\fI \fR
13097 .RE
13098
13099 unix extensions
13100 .PP
13101 .RS 4
13102 This parameter is a synonym for
13103 smb1 unix extensions\&.
13104 .RE
13105
13106 smb1 unix extensions (G)
13107 .PP
13108 .RS 4
13109 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\&.
13110 .sp
13111 Note if this parameter is turned on, the
13112 \m[blue]\fBwide links\fR\m[]
13113 parameter will automatically be disabled\&.
13114 .sp
13115 See the parameter
13116 \m[blue]\fBallow insecure wide links\fR\m[]
13117 if you wish to change this coupling between the two parameters\&.
13118 .sp
13119 Default:
13120 \fI\fIsmb1 unix extensions\fR\fR\fI = \fR\fIyes\fR\fI \fR
13121 .RE
13122
13123 smb2 disable lock sequence checking (G)
13124 .PP
13125 .RS 4
13126 This boolean parameter controls whether
13127 \fBsmbd\fR(8)
13128 will disable lock sequence checking even for multi\-channel connections as well as durable handles\&.
13129 .sp
13130 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\&.
13131 .sp
13132 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]\&.
13133 .sp
13134 By default Samba behaves according to the specification and implements lock sequence checking when multi\-channel is used\&.
13135 .sp
13136 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\&.
13137 .sp
13138 Note: it\*(Aqs likely that this option will be removed again if future Windows versions change their behavior\&.
13139 .sp
13140 Note: Samba does not implement Open\&.IsResilient and Open\&.IsPersistent yet\&.
13141 .sp
13142 Default:
13143 \fI\fIsmb2 disable lock sequence checking\fR\fR\fI = \fR\fIno\fR\fI \fR
13144 .sp
13145 Example:
13146 \fI\fIsmb2 disable lock sequence checking\fR\fR\fI = \fR\fIyes\fR\fI \fR
13147 .RE
13148
13149 smb2 disable oplock break retry (G)
13150 .PP
13151 .RS 4
13152 This boolean parameter controls whether
13153 \fBsmbd\fR(8)
13154 will trigger smb2 oplock break notification retries when using
13155 \m[blue]\fBserver multi channel support = yes\fR\m[]\&.
13156 .sp
13157 The [MS\-SMB2] specification documents that a server should send smb2 oplock break notification retries on all available channel to the given client\&.
13158 .sp
13159 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]\&.
13160 .sp
13161 By default Samba behaves according to the specification and send smb2 oplock break notification retries\&.
13162 .sp
13163 Warning: Only enable this option if existing clients can\*(Aqt handle possible retries and it turns out that the Windows Server behavior is required\&.
13164 .sp
13165 Note: it\*(Aqs likely that this option gets removed again if future Windows versions change their behavior\&.
13166 .sp
13167 Note: this only applies to oplocks and not SMB2 leases\&.
13168 .sp
13169 Default:
13170 \fI\fIsmb2 disable oplock break retry\fR\fR\fI = \fR\fIno\fR\fI \fR
13171 .sp
13172 Example:
13173 \fI\fIsmb2 disable oplock break retry\fR\fR\fI = \fR\fIyes\fR\fI \fR
13174 .RE
13175
13176 smb2 leases (G)
13177 .PP
13178 .RS 4
13179 This boolean option tells
13180 smbd
13181 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\&.
13182 .sp
13183 This is only available with
13184 \m[blue]\fBoplocks = yes\fR\m[]
13185 and
13186 \m[blue]\fBkernel oplocks = no\fR\m[]\&.
13187 .sp
13188 Default:
13189 \fI\fIsmb2 leases\fR\fR\fI = \fR\fIyes\fR\fI \fR
13190 .RE
13191
13192 smb2 max credits (G)
13193 .PP
13194 .RS 4
13195 This option controls the maximum number of outstanding simultaneous SMB2 operations that Samba tells the client it will allow\&. This is similar to the
13196 \m[blue]\fBmax mux\fR\m[]
13197 parameter for SMB1\&. You should never need to set this parameter\&.
13198 .sp
13199 The default is 8192 credits, which is the same as a Windows 2008R2 SMB2 server\&.
13200 .sp
13201 Default:
13202 \fI\fIsmb2 max credits\fR\fR\fI = \fR\fI8192\fR\fI \fR
13203 .RE
13204
13205 smb2 max read (G)
13206 .PP
13207 .RS 4
13208 This option specifies the protocol value that
13209 \fBsmbd\fR(8)
13210 will return to a client, informing the client of the largest size that may be returned by a single SMB2 read call\&.
13211 .sp
13212 The maximum is 8388608 bytes (8MiB), which is the same as a Windows Server 2012 r2\&.
13213 .sp
13214 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)\&.
13215 .sp
13216 Default:
13217 \fI\fIsmb2 max read\fR\fR\fI = \fR\fI8388608\fR\fI \fR
13218 .RE
13219
13220 smb2 max trans (G)
13221 .PP
13222 .RS 4
13223 This option specifies the protocol value that
13224 \fBsmbd\fR(8)
13225 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\&.
13226 .sp
13227 The maximum is 8388608 bytes (8MiB), which is the same as a Windows Server 2012 r2\&.
13228 .sp
13229 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)\&.
13230 .sp
13231 Default:
13232 \fI\fIsmb2 max trans\fR\fR\fI = \fR\fI8388608\fR\fI \fR
13233 .RE
13234
13235 smb2 max write (G)
13236 .PP
13237 .RS 4
13238 This option specifies the protocol value that
13239 \fBsmbd\fR(8)
13240 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\&.
13241 .sp
13242 The maximum is 8388608 bytes (8MiB), which is the same as a Windows Server 2012 r2\&.
13243 .sp
13244 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)\&.
13245 .sp
13246 Default:
13247 \fI\fIsmb2 max write\fR\fR\fI = \fR\fI8388608\fR\fI \fR
13248 .RE
13249
13250 smb3 directory leases (G)
13251 .PP
13252 .RS 4
13253 This is an enumerated type that controls
13254 smbd
13255 whether SMB3 directory leases are enabled\&. Directory Leasing is an SMB3\-only feature which allows clients to cache directories\&.
13256 .sp
13257 Possible values for
13258 \m[blue]\fBsmb3 directory leases\fR\m[]
13259 are
13260 \fByes\fR,
13261 \fBno\fR
13262 and
13263 \fBauto\fR,
13264 \fBauto\fR
13265 being the default\&.
13266 .sp
13267 When set to
13268 \fBauto\fR, the effective value depends on the option
13269 \m[blue]\fBclustering\fR\m[]\&. If
13270 \m[blue]\fBclustering\fR\m[]
13271 is enabled,
13272 \m[blue]\fBsmb3 directory leases\fR\m[]
13273 are disabled and the other way around\&.
13274 .sp
13275 \m[blue]\fBsmb3 directory leases\fR\m[]
13276 are only available with
13277 \m[blue]\fBsmb2 leases = yes\fR\m[],
13278 \m[blue]\fBoplocks = yes\fR\m[]
13279 and
13280 \m[blue]\fBkernel oplocks = no\fR\m[]\&.
13281 .sp
13282 Enabling
13283 \m[blue]\fBsmb3 directory leases\fR\m[]
13284 implicitly enables
13285 \m[blue]\fBstrict rename\fR\m[]\&.
13286 .sp
13287 Default:
13288 \fI\fIsmb3 directory leases\fR\fR\fI = \fR\fIauto\fR\fI \fR
13289 .RE
13290
13291 smb3 share cap:CONTINUOUS AVAILABILITY (S)
13292 .PP
13293 .RS 4
13294 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)\&.
13295 .sp
13296 Note: this option only applies to disk shares\&.
13297 .sp
13298 In a ctdb cluster shares are continuously available, but windows clients mix this with the global persistent handles support\&.
13299 .sp
13300 Persistent handles are requested if SMB2_SHARE_CAP_CONTINUOUS_AVAILABILITY is present even without SMB2_CAP_PERSISTENT_HANDLES\&.
13301 .sp
13302 And SMB2_SHARE_CAP_CONTINUOUS_AVAILABILITY is required for SMB2_SHARE_CAP_CLUSTER to have an effect\&.
13303 .sp
13304 So we better don\*(Aqt announce this by default until we support persistent handles\&.
13305 .sp
13306 The
13307 \m[blue]\fBsmb3 share cap:CONTINUOUS AVAILABILITY\fR\m[]
13308 option can be used to force the announcement of SMB2_SHARE_CAP_CONTINUOUS_AVAILABILITY\&.
13309 .sp
13310 Warning: only use this if you know what you are doing!
13311 .sp
13312 .if n \{\
13313 .RS 4
13314 .\}
13315 .nf
13316 smb3 share cap:CONTINUOUS AVAILABILITY = yes
13317
13318 .fi
13319 .if n \{\
13320 .RE
13321 .\}
13322 .sp
13323 \fINo default\fR
13324 .RE
13325
13326 smb3 share cap:SCALE OUT (S)
13327 .PP
13328 .RS 4
13329 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\&.
13330 .sp
13331 Note: this option only applies to disk shares\&.
13332 .sp
13333 In a ctdb cluster we have multiple active nodes, so we announce SMB2_SHARE_CAP_SCALEOUT in a cluster\&.
13334 .sp
13335 The
13336 \m[blue]\fBsmb3 share cap:SCALE OUT\fR\m[]
13337 option can be used to disable the announcement of SMB2_SHARE_CAP_SCALEOUT, even if
13338 \m[blue]\fBclustering\fR\m[]
13339 is yes\&.
13340 .sp
13341 .if n \{\
13342 .RS 4
13343 .\}
13344 .nf
13345 clustering = yes
13346 smb3 share cap: SCALE OUT = no
13347
13348 .fi
13349 .if n \{\
13350 .RE
13351 .\}
13352 .sp
13353 \fINo default\fR
13354 .RE
13355
13356 smb3 share cap:CLUSTER (S)
13357 .PP
13358 .RS 4
13359 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\&.
13360 .sp
13361 Note: this option only applies to disk shares\&.
13362 .sp
13363 rpcd_witness is only active if
13364 \fBsamba-dcerpcd\fR(8)
13365 is not started as on demand helper and only in a ctdb cluster\&.
13366 .sp
13367 So we announce SMB2_SHARE_CAP_CLUSTER only if
13368 \m[blue]\fBclustering\fR\m[]
13369 is yes and
13370 \m[blue]\fBrpc start on demand helpers\fR\m[]
13371 is no\&.
13372 .sp
13373 The
13374 \m[blue]\fBsmb3 share cap:SCALE OUT\fR\m[]
13375 option can be used to control the announcement of SMB2_SHARE_CAP_CLUSTER independent of
13376 \m[blue]\fBclustering\fR\m[]
13377 and
13378 \m[blue]\fBrpc start on demand helpers\fR\m[]\&.
13379 .sp
13380 Example to disable the announcement of SMB2_SHARE_CAP_CLUSTER:
13381 .sp
13382 .if n \{\
13383 .RS 4
13384 .\}
13385 .nf
13386 clustering = yes
13387 rpc start on demand helpers = no
13388 smb3 share cap: CLUSTER = no
13389
13390 .fi
13391 .if n \{\
13392 .RE
13393 .\}
13394 .sp
13395 Example to force the announcement of SMB2_SHARE_CAP_CLUSTER:
13396 .sp
13397 .if n \{\
13398 .RS 4
13399 .\}
13400 .nf
13401 smb3 share cap: CLUSTER = yes
13402
13403 .fi
13404 .if n \{\
13405 .RE
13406 .\}
13407 .sp
13408 Example to let Windows clients use the witness service, see
13409 \m[blue]\fBsmb3 share cap:CONTINUOUS AVAILABILITY\fR\m[]
13410 option and USE AT YOUR OWN RISK!:
13411 .sp
13412 .if n \{\
13413 .RS 4
13414 .\}
13415 .nf
13416 clustering = yes
13417 rpc start on demand helpers = no
13418 # This is the default with the above:
13419 # smb3 share cap: CLUSTER = yes
13420 #
13421 # Use at you own risk!
13422 smb3 share cap: CONTINUOUS AVAILABILITY = yes
13423
13424 .fi
13425 .if n \{\
13426 .RE
13427 .\}
13428 .sp
13429 \fINo default\fR
13430 .RE
13431
13432 smb3 share cap:ASYMMETRIC (S)
13433 .PP
13434 .RS 4
13435 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
13436 net witness share\-move
13437 can be used to control the node usage\&.
13438 .sp
13439 Note: this option only applies to disk shares\&.
13440 .sp
13441 Shares in a ctdb cluster are symmetric by design, so we don\*(Aqt announce SMB2_SHARE_CAP_ASYMMETRIC by default\&.
13442 .sp
13443 The
13444 \m[blue]\fBsmb3 share cap:ASYMMETRIC\fR\m[]
13445 option can be used to force the announcement of SMB2_SHARE_CAP_ASYMMETRIC\&.
13446 .sp
13447 Example to force the announcement of SMB2_SHARE_CAP_ASYMMETRIC:
13448 .sp
13449 .if n \{\
13450 .RS 4
13451 .\}
13452 .nf
13453 smb3 share cap: ASYMMETRIC = yes
13454
13455 .fi
13456 .if n \{\
13457 .RE
13458 .\}
13459 .sp
13460 Example to let Windows clients use the witness service, see
13461 \m[blue]\fBsmb3 share cap:CONTINUOUS AVAILABILITY\fR\m[]
13462 option and USE AT YOUR OWN RISK!:
13463 .sp
13464 .if n \{\
13465 .RS 4
13466 .\}
13467 .nf
13468 clustering = yes
13469 rpc start on demand helpers = no
13470 # This is the default with the above:
13471 # smb3 share cap: CLUSTER = yes
13472 #
13473 # Use at you own risk!
13474 smb3 share cap: CONTINUOUS AVAILABILITY = yes
13475 smb3 share cap: ASYMMETRIC = yes
13476
13477 .fi
13478 .if n \{\
13479 .RE
13480 .\}
13481 .sp
13482 \fINo default\fR
13483 .RE
13484
13485 smb3 unix extensions (S)
13486 .PP
13487 .RS 4
13488 Support for SMB 3\&.1\&.1 Unix Extensions\&.
13489 .sp
13490 Default:
13491 \fI\fIsmb3 unix extensions\fR\fR\fI = \fR\fIyes\fR\fI \fR
13492 .RE
13493
13494 smbd async dosmode (S)
13495 .PP
13496 .RS 4
13497 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\&.
13498 .sp
13499 Default:
13500 \fI\fIsmbd async dosmode\fR\fR\fI = \fR\fIno\fR\fI \fR
13501 .RE
13502
13503 smbd getinfo ask sharemode (S)
13504 .PP
13505 .RS 4
13506 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\&.
13507 .sp
13508 Default:
13509 \fI\fIsmbd getinfo ask sharemode\fR\fR\fI = \fR\fIyes\fR\fI \fR
13510 .RE
13511
13512 smbd max async dosmode (S)
13513 .PP
13514 .RS 4
13515 This parameter controls how many async operations to fetch the DOS attributes the fileserver will queue when doing directory listings\&.
13516 .sp
13517 Default:
13518 \fI\fIsmbd max async dosmode\fR\fR\fI = \fR\fIaio max threads * 2\fR\fI \fR
13519 .RE
13520
13521 smbd max xattr size (S)
13522 .PP
13523 .RS 4
13524 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\&.
13525 .sp
13526 Default:
13527 \fI\fIsmbd max xattr size\fR\fR\fI = \fR\fI65536\fR\fI \fR
13528 .RE
13529
13530 smbd profiling share (S)
13531 .PP
13532 .RS 4
13533 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
13534 \m[blue]\fBsmbd profiling level\fR\m[]
13535 is enabled\&.
13536 .sp
13537 Default:
13538 \fI\fIsmbd profiling share\fR\fR\fI = \fR\fIno\fR\fI \fR
13539 .RE
13540
13541 smbd profiling level (G)
13542 .PP
13543 .RS 4
13544 This parameter allows the administrator to enable profiling support\&.
13545 .sp
13546 Possible values are
13547 \fBoff\fR,
13548 \fBcount\fR
13549 and
13550 \fBon\fR\&.
13551 .sp
13552 Default:
13553 \fI\fIsmbd profiling level\fR\fR\fI = \fR\fIoff\fR\fI \fR
13554 .sp
13555 Example:
13556 \fI\fIsmbd profiling level\fR\fR\fI = \fR\fIon\fR\fI \fR
13557 .RE
13558
13559 smbd search ask sharemode (S)
13560 .PP
13561 .RS 4
13562 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\&.
13563 .sp
13564 Default:
13565 \fI\fIsmbd search ask sharemode\fR\fR\fI = \fR\fIyes\fR\fI \fR
13566 .RE
13567
13568 smb encrypt (S)
13569 .PP
13570 .RS 4
13571 This is a synonym for
13572 \m[blue]\fBserver smb encrypt\fR\m[]\&.
13573 .sp
13574 Default:
13575 \fI\fIsmb encrypt\fR\fR\fI = \fR\fIdefault\fR\fI \fR
13576 .RE
13577
13578 smb passwd file (G)
13579 .PP
13580 .RS 4
13581 This option sets the path to the encrypted smbpasswd file\&. By default the path to the smbpasswd file is compiled into Samba\&.
13582 .sp
13583 An example of use is:
13584 .sp
13585 .if n \{\
13586 .RS 4
13587 .\}
13588 .nf
13589 smb passwd file = /etc/samba/smbpasswd
13590 .fi
13591 .if n \{\
13592 .RE
13593 .\}
13594 .sp
13595 Default:
13596 \fI\fIsmb passwd file\fR\fR\fI = \fR\fI/etc/samba/smbpasswd\fR\fI \fR
13597 .RE
13598
13599 socket options (G)
13600 .PP
13601 .RS 4
13602 .if n \{\
13603 .sp
13604 .\}
13605 .RS 4
13606 .it 1 an-trap
13607 .nr an-no-space-flag 1
13608 .nr an-break-flag 1
13609 .br
13610 .ps +1
13611 \fBWarning\fR
13612 .ps -1
13613 .br
13614 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\&.
13615 .sp
13616 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
13617 \fItest\fR
13618 the effect before making any large changes\&.
13619 .sp .5v
13620 .RE
13621 .sp
13622 This option allows you to set socket options to be used when talking with the client\&.
13623 .sp
13624 Socket options are controls on the networking layer of the operating systems which allow the connection to be tuned\&.
13625 .sp
13626 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
13627 man setsockopt
13628 will help)\&.
13629 .sp
13630 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
13631 samba\-technical@lists\&.samba\&.org\&.
13632 .sp
13633 Any of the supported socket options may be combined in any way you like, as long as your OS allows it\&.
13634 .sp
13635 This is the list of socket options currently settable using this option:
13636 .RS
13637 .sp
13638 .RS 4
13639 .ie n \{\
13640 \h'-04'\(bu\h'+03'\c
13641 .\}
13642 .el \{\
13643 .sp -1
13644 .IP \(bu 2.3
13645 .\}
13646 SO_KEEPALIVE
13647 .RE
13648 .sp
13649 .RS 4
13650 .ie n \{\
13651 \h'-04'\(bu\h'+03'\c
13652 .\}
13653 .el \{\
13654 .sp -1
13655 .IP \(bu 2.3
13656 .\}
13657 SO_REUSEADDR
13658 .RE
13659 .sp
13660 .RS 4
13661 .ie n \{\
13662 \h'-04'\(bu\h'+03'\c
13663 .\}
13664 .el \{\
13665 .sp -1
13666 .IP \(bu 2.3
13667 .\}
13668 SO_BROADCAST
13669 .RE
13670 .sp
13671 .RS 4
13672 .ie n \{\
13673 \h'-04'\(bu\h'+03'\c
13674 .\}
13675 .el \{\
13676 .sp -1
13677 .IP \(bu 2.3
13678 .\}
13679 TCP_NODELAY
13680 .RE
13681 .sp
13682 .RS 4
13683 .ie n \{\
13684 \h'-04'\(bu\h'+03'\c
13685 .\}
13686 .el \{\
13687 .sp -1
13688 .IP \(bu 2.3
13689 .\}
13690 TCP_KEEPCNT *
13691 .RE
13692 .sp
13693 .RS 4
13694 .ie n \{\
13695 \h'-04'\(bu\h'+03'\c
13696 .\}
13697 .el \{\
13698 .sp -1
13699 .IP \(bu 2.3
13700 .\}
13701 TCP_KEEPIDLE *
13702 .RE
13703 .sp
13704 .RS 4
13705 .ie n \{\
13706 \h'-04'\(bu\h'+03'\c
13707 .\}
13708 .el \{\
13709 .sp -1
13710 .IP \(bu 2.3
13711 .\}
13712 TCP_KEEPINTVL *
13713 .RE
13714 .sp
13715 .RS 4
13716 .ie n \{\
13717 \h'-04'\(bu\h'+03'\c
13718 .\}
13719 .el \{\
13720 .sp -1
13721 .IP \(bu 2.3
13722 .\}
13723 IPTOS_LOWDELAY
13724 .RE
13725 .sp
13726 .RS 4
13727 .ie n \{\
13728 \h'-04'\(bu\h'+03'\c
13729 .\}
13730 .el \{\
13731 .sp -1
13732 .IP \(bu 2.3
13733 .\}
13734 IPTOS_THROUGHPUT
13735 .RE
13736 .sp
13737 .RS 4
13738 .ie n \{\
13739 \h'-04'\(bu\h'+03'\c
13740 .\}
13741 .el \{\
13742 .sp -1
13743 .IP \(bu 2.3
13744 .\}
13745 SO_REUSEPORT
13746 .RE
13747 .sp
13748 .RS 4
13749 .ie n \{\
13750 \h'-04'\(bu\h'+03'\c
13751 .\}
13752 .el \{\
13753 .sp -1
13754 .IP \(bu 2.3
13755 .\}
13756 SO_SNDBUF *
13757 .RE
13758 .sp
13759 .RS 4
13760 .ie n \{\
13761 \h'-04'\(bu\h'+03'\c
13762 .\}
13763 .el \{\
13764 .sp -1
13765 .IP \(bu 2.3
13766 .\}
13767 SO_RCVBUF *
13768 .RE
13769 .sp
13770 .RS 4
13771 .ie n \{\
13772 \h'-04'\(bu\h'+03'\c
13773 .\}
13774 .el \{\
13775 .sp -1
13776 .IP \(bu 2.3
13777 .\}
13778 SO_SNDLOWAT *
13779 .RE
13780 .sp
13781 .RS 4
13782 .ie n \{\
13783 \h'-04'\(bu\h'+03'\c
13784 .\}
13785 .el \{\
13786 .sp -1
13787 .IP \(bu 2.3
13788 .\}
13789 SO_RCVLOWAT *
13790 .RE
13791 .sp
13792 .RS 4
13793 .ie n \{\
13794 \h'-04'\(bu\h'+03'\c
13795 .\}
13796 .el \{\
13797 .sp -1
13798 .IP \(bu 2.3
13799 .\}
13800 SO_SNDTIMEO *
13801 .RE
13802 .sp
13803 .RS 4
13804 .ie n \{\
13805 \h'-04'\(bu\h'+03'\c
13806 .\}
13807 .el \{\
13808 .sp -1
13809 .IP \(bu 2.3
13810 .\}
13811 SO_RCVTIMEO *
13812 .RE
13813 .sp
13814 .RS 4
13815 .ie n \{\
13816 \h'-04'\(bu\h'+03'\c
13817 .\}
13818 .el \{\
13819 .sp -1
13820 .IP \(bu 2.3
13821 .\}
13822 TCP_FASTACK *
13823 .RE
13824 .sp
13825 .RS 4
13826 .ie n \{\
13827 \h'-04'\(bu\h'+03'\c
13828 .\}
13829 .el \{\
13830 .sp -1
13831 .IP \(bu 2.3
13832 .\}
13833 TCP_QUICKACK
13834 .RE
13835 .sp
13836 .RS 4
13837 .ie n \{\
13838 \h'-04'\(bu\h'+03'\c
13839 .\}
13840 .el \{\
13841 .sp -1
13842 .IP \(bu 2.3
13843 .\}
13844 TCP_NODELAYACK
13845 .RE
13846 .sp
13847 .RS 4
13848 .ie n \{\
13849 \h'-04'\(bu\h'+03'\c
13850 .\}
13851 .el \{\
13852 .sp -1
13853 .IP \(bu 2.3
13854 .\}
13855 TCP_KEEPALIVE_THRESHOLD *
13856 .RE
13857 .sp
13858 .RS 4
13859 .ie n \{\
13860 \h'-04'\(bu\h'+03'\c
13861 .\}
13862 .el \{\
13863 .sp -1
13864 .IP \(bu 2.3
13865 .\}
13866 TCP_KEEPALIVE_ABORT_THRESHOLD *
13867 .RE
13868 .sp
13869 .RS 4
13870 .ie n \{\
13871 \h'-04'\(bu\h'+03'\c
13872 .\}
13873 .el \{\
13874 .sp -1
13875 .IP \(bu 2.3
13876 .\}
13877 TCP_DEFER_ACCEPT *
13878 .RE
13879 .sp
13880 .RS 4
13881 .ie n \{\
13882 \h'-04'\(bu\h'+03'\c
13883 .\}
13884 .el \{\
13885 .sp -1
13886 .IP \(bu 2.3
13887 .\}
13888 TCP_USER_TIMEOUT *
13889 .RE
13890 .sp
13891 .RE
13892 Those marked with a
13893 \fI\*(Aq*\*(Aq\fR
13894 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\&.
13895 .sp
13896 To specify an argument use the syntax SOME_OPTION = VALUE for example
13897 SO_SNDBUF = 8192\&. Note that you must not have any spaces before or after the = sign\&.
13898 .sp
13899 If you are on a local network then a sensible option might be:
13900 .sp
13901 socket options = IPTOS_LOWDELAY
13902 .sp
13903 If you have a local network then you could try:
13904 .sp
13905 socket options = IPTOS_LOWDELAY TCP_NODELAY
13906 .sp
13907 If you are on a wide area network then perhaps try setting IPTOS_THROUGHPUT\&.
13908 .sp
13909 Note that several of the options may cause your Samba server to fail completely\&. Use these options with caution!
13910 .sp
13911 Default:
13912 \fI\fIsocket options\fR\fR\fI = \fR\fITCP_NODELAY\fR\fI \fR
13913 .sp
13914 Example:
13915 \fI\fIsocket options\fR\fR\fI = \fR\fIIPTOS_LOWDELAY\fR\fI \fR
13916 .RE
13917
13918 spn update command (G)
13919 .PP
13920 .RS 4
13921 This option sets the command that for updating servicePrincipalName names from
13922 spn_update_list\&.
13923 .sp
13924 Default:
13925 \fI\fIspn update command\fR\fR\fI = \fR\fI/build/reproducible\-path/samba\-4\&.24\&.3+dfsg/source4/scripting/bin/samba_spnupdate\fR\fI \fR
13926 .sp
13927 Example:
13928 \fI\fIspn update command\fR\fR\fI = \fR\fI/usr/local/sbin/spnupdate\fR\fI \fR
13929 .RE
13930
13931 spoolss: architecture (G)
13932 .PP
13933 .RS 4
13934 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\&.
13935 .sp
13936 Default:
13937 \fI\fIspoolss: architecture\fR\fR\fI = \fR\fIWindows x64\fR\fI \fR
13938 .sp
13939 Example:
13940 \fI\fIspoolss: architecture\fR\fR\fI = \fR\fIWindows NT x86\fR\fI \fR
13941 .RE
13942
13943 spoolss: os_major (G)
13944 .PP
13945 .RS 4
13946 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)\&.
13947 .sp
13948 Default:
13949 \fI\fIspoolss: os_major\fR\fR\fI = \fR\fI5\fR\fI \fR
13950 .sp
13951 Example:
13952 \fI\fIspoolss: os_major\fR\fR\fI = \fR\fI6\fR\fI \fR
13953 .RE
13954
13955 spoolss: os_minor (G)
13956 .PP
13957 .RS 4
13958 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)\&.
13959 .sp
13960 Default:
13961 \fI\fIspoolss: os_minor\fR\fR\fI = \fR\fI0\fR\fI \fR
13962 .sp
13963 Example:
13964 \fI\fIspoolss: os_minor\fR\fR\fI = \fR\fI1\fR\fI \fR
13965 .RE
13966
13967 spoolss: os_build (G)
13968 .PP
13969 .RS 4
13970 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)\&.
13971 .sp
13972 Default:
13973 \fI\fIspoolss: os_build\fR\fR\fI = \fR\fI2195\fR\fI \fR
13974 .sp
13975 Example:
13976 \fI\fIspoolss: os_build\fR\fR\fI = \fR\fI7601\fR\fI \fR
13977 .RE
13978
13979 spoolss_client: os_major (G)
13980 .PP
13981 .RS 4
13982 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)\&.
13983 .sp
13984 Default:
13985 \fI\fIspoolss_client: os_major\fR\fR\fI = \fR\fI6\fR\fI \fR
13986 .RE
13987
13988 spoolss_client: os_minor (G)
13989 .PP
13990 .RS 4
13991 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)\&.
13992 .sp
13993 Default:
13994 \fI\fIspoolss_client: os_minor\fR\fR\fI = \fR\fI1\fR\fI \fR
13995 .RE
13996
13997 spoolss_client: os_build (G)
13998 .PP
13999 .RS 4
14000 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)\&.
14001 .sp
14002 Default:
14003 \fI\fIspoolss_client: os_build\fR\fR\fI = \fR\fI7007\fR\fI \fR
14004 .RE
14005
14006 spotlight (S)
14007 .PP
14008 .RS 4
14009 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\&.
14010 .sp
14011 Spotlight has several prerequisites:
14012 .RS
14013 .sp
14014 .RS 4
14015 .ie n \{\
14016 \h'-04'\(bu\h'+03'\c
14017 .\}
14018 .el \{\
14019 .sp -1
14020 .IP \(bu 2.3
14021 .\}
14022 Samba must be configured and built with Spotlight support\&.
14023 .RE
14024 .sp
14025 .RS 4
14026 .ie n \{\
14027 \h'-04'\(bu\h'+03'\c
14028 .\}
14029 .el \{\
14030 .sp -1
14031 .IP \(bu 2.3
14032 .\}
14033 Tracker integration must be setup and the share must be indexed by Tracker\&.
14034 .RE
14035 .sp
14036 .RE
14037 For a detailed set of instructions please see
14038 https://wiki\&.samba\&.org/index\&.php/Spotlight\&.
14039 .sp
14040 Default:
14041 \fI\fIspotlight\fR\fR\fI = \fR\fIno\fR\fI \fR
14042 .RE
14043
14044 spotlight backend (S)
14045 .PP
14046 .RS 4
14047 Spotlight search backend\&. Available backends:
14048 .RS
14049 .sp
14050 .RS 4
14051 .ie n \{\
14052 \h'-04'\(bu\h'+03'\c
14053 .\}
14054 .el \{\
14055 .sp -1
14056 .IP \(bu 2.3
14057 .\}
14058 \fBnoindex\fR
14059 \- a backend that returns no results\&.
14060 .RE
14061 .sp
14062 .RE
14063 .RS
14064 .sp
14065 .RS 4
14066 .ie n \{\
14067 \h'-04'\(bu\h'+03'\c
14068 .\}
14069 .el \{\
14070 .sp -1
14071 .IP \(bu 2.3
14072 .\}
14073 \fBtracker\fR
14074 \- Gnome Tracker\&.
14075 .RE
14076 .sp
14077 .RS 4
14078 .ie n \{\
14079 \h'-04'\(bu\h'+03'\c
14080 .\}
14081 .el \{\
14082 .sp -1
14083 .IP \(bu 2.3
14084 .\}
14085 \fBelasticsearch\fR
14086 \- a backend that uses JSON and REST over HTTP(s) to query an Elasticsearch server\&.
14087 .RE
14088 .sp
14089 .RE
14090 .sp
14091 Default:
14092 \fI\fIspotlight backend\fR\fR\fI = \fR\fInoindex\fR\fI \fR
14093 .RE
14094
14095 stat cache (G)
14096 .PP
14097 .RS 4
14098 This parameter determines if
14099 \fBsmbd\fR(8)
14100 will use a cache in order to speed up case insensitive name mappings\&. You should never need to change this parameter\&.
14101 .sp
14102 Default:
14103 \fI\fIstat cache\fR\fR\fI = \fR\fIyes\fR\fI \fR
14104 .RE
14105
14106 state directory (G)
14107 .PP
14108 .RS 4
14109 Usually, most of the TDB files are stored in the
14110 \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
14111 \fIstate directory\fR
14112 and the
14113 \fIcache directory\fR
14114 options\&.
14115 .sp
14116 This option specifies the directory where TDB files containing important persistent data will be stored\&.
14117 .sp
14118 Default:
14119 \fI\fIstate directory\fR\fR\fI = \fR\fI/var/lib/samba\fR\fI \fR
14120 .sp
14121 Example:
14122 \fI\fIstate directory\fR\fR\fI = \fR\fI/var/run/samba/locks/state\fR\fI \fR
14123 .RE
14124
14125 store dos attributes (S)
14126 .PP
14127 .RS 4
14128 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
14129 \m[blue]\fBmap hidden\fR\m[]
14130 and
14131 \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
14132 \m[blue]\fBmap hidden\fR\m[],
14133 \m[blue]\fBmap system\fR\m[],
14134 \m[blue]\fBmap archive\fR\m[]
14135 and
14136 \m[blue]\fBmap readonly\fR\m[]
14137 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\&.
14138 .sp
14139 Default:
14140 \fI\fIstore dos attributes\fR\fR\fI = \fR\fIyes\fR\fI \fR
14141 .RE
14142
14143 strict allocate (S)
14144 .PP
14145 .RS 4
14146 This is a boolean that controls the handling of disk space allocation in the server\&. When this is set to
14147 \fByes\fR
14148 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\&.
14149 .sp
14150 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\&.
14151 .sp
14152 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\&.
14153 .sp
14154 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\&.
14155 .sp
14156 Default:
14157 \fI\fIstrict allocate\fR\fR\fI = \fR\fIno\fR\fI \fR
14158 .RE
14159
14160 strict locking (S)
14161 .PP
14162 .RS 4
14163 This is an enumerated type that controls the handling of file locking in the server\&. When this is set to
14164 \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\&.
14165 .sp
14166 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\&.
14167 .sp
14168 When strict locking is disabled, the server performs file lock checks only when the client explicitly asks for them\&.
14169 .sp
14170 Well\-behaved clients always ask for lock checks when it is important\&. So in the vast majority of cases,
14171 strict locking = Auto
14172 or
14173 strict locking = no
14174 is acceptable\&.
14175 .sp
14176 Default:
14177 \fI\fIstrict locking\fR\fR\fI = \fR\fIAuto\fR\fI \fR
14178 .RE
14179
14180 strict rename (S)
14181 .PP
14182 .RS 4
14183 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\&.
14184 .sp
14185 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\&.
14186 .sp
14187 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\&.
14188 .sp
14189 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\&.
14190 .sp
14191 If the client has requested UNIX extensions (POSIX pathnames) then renames are always allowed and this parameter has no effect\&.
14192 .sp
14193 Enabling
14194 \m[blue]\fBsmb3 directory leases\fR\m[]
14195 implicitly enables
14196 \m[blue]\fBstrict rename\fR\m[]\&.
14197 .sp
14198 Default:
14199 \fI\fIstrict rename\fR\fR\fI = \fR\fIno\fR\fI \fR
14200 .RE
14201
14202 strict sync (S)
14203 .PP
14204 .RS 4
14205 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
14206 \fByes\fR, which is the default, then Windows applications can force the smbd server to synchronize unwritten data onto the disk\&. If set to
14207 \fBno\fR
14208 then smbd will ignore client requests to synchronize unwritten data onto stable storage on disk\&.
14209 .sp
14210 In Samba 4\&.7\&.0, the default for this parameter changed from
14211 \fBno\fR
14212 to
14213 \fByes\fR
14214 to better match the expectations of SMB2/3 clients and improve application safety when running against smbd\&.
14215 .sp
14216 The flush request from SMB2/3 clients is handled asynchronously inside smbd, so leaving the parameter as the default value of
14217 \fByes\fR
14218 does not block the processing of other requests to the smbd process\&.
14219 .sp
14220 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
14221 \fBno\fR
14222 means that
14223 \fBsmbd\fR(8)
14224 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\&.
14225 .sp
14226 Default:
14227 \fI\fIstrict sync\fR\fR\fI = \fR\fIyes\fR\fI \fR
14228 .RE
14229
14230 svcctl list (G)
14231 .PP
14232 .RS 4
14233 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\&.
14234 .sp
14235 The administrator must create a directory name
14236 svcctl
14237 in Samba\*(Aqs $(libdir) and create symbolic links to the init scripts in
14238 /etc/init\&.d/\&. The name of the links must match the names given as part of the
14239 \fIsvcctl list\fR\&.
14240 .sp
14241 Default:
14242 \fI\fIsvcctl list\fR\fR\fI = \fR\fI\fR\fI \fR
14243 .sp
14244 Example:
14245 \fI\fIsvcctl list\fR\fR\fI = \fR\fIcups postfix portmap httpd\fR\fI \fR
14246 .RE
14247
14248 sync always (S)
14249 .PP
14250 .RS 4
14251 This is a boolean parameter that controls whether writes will always be written to stable storage before the write call returns\&. If this is
14252 \fBno\fR
14253 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
14254 \fByes\fR
14255 then every write will be followed by a
14256 fsync()
14257 call to ensure the data is written to disk\&. Note that the
14258 \fIstrict sync\fR
14259 parameter must be set to
14260 \fByes\fR
14261 in order for this parameter to have any effect\&.
14262 .sp
14263 Default:
14264 \fI\fIsync always\fR\fR\fI = \fR\fIno\fR\fI \fR
14265 .RE
14266
14267 sync machine password script (G)
14268 .PP
14269 .RS 4
14270 This is the full pathname to a script that will be run by
14271 \fBwinbindd\fR(8)
14272 when a machine account password is updated\&.
14273 .sp
14274 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
14275 \fB46\&.update\-keytabs\&.script\fR
14276 in ctdb, it re\-creates the keytab during the ctdb recovered event:
14277 .sp
14278 .if n \{\
14279 .RS 4
14280 .\}
14281 .nf
14282 onnode all ctdb event script enable legacy 46\&.update\-keytabs\&.script
14283
14284 .fi
14285 .if n \{\
14286 .RE
14287 .\}
14288 .sp
14289 Default:
14290 \fI\fIsync machine password script\fR\fR\fI = \fR\fI\fR\fI \fR
14291 .sp
14292 Example:
14293 \fI\fIsync machine password script\fR\fR\fI = \fR\fI/usr/share/ctdb/scripts/winbind_ctdb_updatekeytab\&.sh\fR\fI \fR
14294 .RE
14295
14296 sync machine password to keytab (G)
14297 .PP
14298 .RS 4
14299 This option allows you to describe what keytabs and how should be updated when machine account is changed via one of these commands
14300 .sp
14301 .if n \{\
14302 .RS 4
14303 .\}
14304 .nf
14305 wbinfo \-\-change\-secret
14306 rpcclient \-\-machine\-pass \-c change_trust_pw
14307 net rpc changetrustpw
14308 net ads changetrustpw
14309 .fi
14310 .if n \{\
14311 .RE
14312 .\}
14313 .sp
14314 or by winbindd doing regular updates (see
14315 \m[blue]\fBmachine password timeout\fR\m[])
14316 .sp
14317 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:
14318 .sp
14319 .if n \{\
14320 .RS 4
14321 .\}
14322 .nf
14323 absolute_path_to_keytab:spn_spec[:spn_spec]*[:sync_etypes][:sync_kvno][:netbios_aliases][:additional_dns_hostnames][:machine_password]
14324 .fi
14325 .if n \{\
14326 .RE
14327 .\}
14328 .sp
14329 spn_spec can be specified multiple times (separated using \*(Aq:\*(Aq) and each spn_spec can have exactly one of these forms:
14330 .sp
14331 .if n \{\
14332 .RS 4
14333 .\}
14334 .nf
14335 account_name
14336 sync_account_name
14337 sync_upn
14338 sync_spns
14339 spn_prefixes=value1[,value2[\&.\&.\&.]]
14340 spns=value1[,value2[\&.\&.\&.]]
14341 .fi
14342 .if n \{\
14343 .RE
14344 .\}
14345 .sp
14346 Every keytab contains principals according the specification below:
14347 .sp
14348 .if n \{\
14349 .RS 4
14350 .\}
14351 .nf
14352 account_name \- COMPUTER$@REALM
14353 sync_account_name \- uses attribute "sAMAccountName" from AD
14354 sync_upn \- uses attribute "userPrincipalName" (if exists in AD)
14355 sync_spns \- uses attribute "servicePrincipalName" (if exists in AD)
14356 spn_prefixes \- creates these two principals from each prefix\&. e\&.g\&.:
14357 prefix/\m[blue]\fBnetbios name\fR\m[]@REALM
14358 prefix/\m[blue]\fBdns hostname\fR\m[]@REALM
14359 with :netbios_aliases for each netbiosalias in \m[blue]\fBnetbios aliases\fR\m[]
14360 prefix/netbiosalias@REALM
14361 prefix/netbiosalias\&.dnsdomain@REALM
14362 with :additional_dns_hostnames for each additionaldnshostname in \m[blue]\fBadditional dns hostnames\fR\m[]
14363 prefix/additionaldnshostname@REALM
14364 \- \*(Aqhost\*(Aq principal should be created using specifier spn_prefixes
14365 spns \- creates only the principals defined in the list
14366 .fi
14367 .if n \{\
14368 .RE
14369 .\}
14370 .sp
14371 \*(Aqaccount_name\*(Aq and \*(Aqsync_account_name\*(Aq are the same, just the source differs (secrets\&.tdb vs\&. AD)\&.
14372 .sp
14373 Options:
14374 .sp
14375 .if n \{\
14376 .RS 4
14377 .\}
14378 .nf
14379 sync_etypes \- attribute "msDS\-SupportedEncryptionTypes" is read from AD and is used to find the highest common enc type for AD and KRB5 lib\&.
14380 sync_kvno \- attribute "msDS\-KeyVersionNumber" from AD is used to set KVNO\&. If this option is missing, KVNO is set to \-1\&.
14381 netbios_aliases \- evaluated only for spn_prefixes (see details above)\&.
14382 additional_dns_hostnames \- evaluated only for spn_prefixes (see details above)\&.
14383 machine_password \- mandatory, if missing the entry is ignored\&. For future use\&.
14384 .fi
14385 .if n \{\
14386 .RE
14387 .\}
14388 .sp
14389 Example:
14390 .sp
14391 .if n \{\
14392 .RS 4
14393 .\}
14394 .nf
14395 "/path/to/keytab0:account_name:machine_password",
14396 "/path/to/keytab1:account_name:sync_etypes:sync_kvno:machine_password",
14397 "/path/to/keytab2:sync_spns:machine_password",
14398 "/path/to/keytab3:sync_spns:sync_kvno:machine_password",
14399 "/path/to/keytab4:spn_prefixes=imap,smtp:machine_password",
14400 "/path/to/keytab5:spn_prefixes=imap,smtp:netbios_aliases:additional_dns_hostnames:sync_kvno:machine_password",
14401 "/path/to/keytab6:spns=wurst/brot@REALM:machine_password",
14402 "/path/to/keytab7:spns=wurst/brot@REALM,wurst2/brot@REALM:sync_kvno:machine_password",
14403 "/path/to/keytab8:sync_account_name:sync_upn:sync_spns:spn_prefixes=host,cifs,http:spns=wurst/brot@REALM:sync_kvno:machine_password"
14404 .fi
14405 .if n \{\
14406 .RE
14407 .\}
14408 .sp
14409 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\&.
14410 .sp
14411 If no value is present and
14412 \m[blue]\fBkerberos method\fR\m[]
14413 is different from \*(Aqsecrets only\*(Aq, the behavior differs between winbind and net utility:
14414 .RS
14415 .sp
14416 .RS 4
14417 .ie n \{\
14418 \h'-04'\(bu\h'+03'\c
14419 .\}
14420 .el \{\
14421 .sp -1
14422 .IP \(bu 2.3
14423 .\}
14424 \fBwinbind\fR
14425 uses value
14426 .sp
14427 .if n \{\
14428 .RS 4
14429 .\}
14430 .nf
14431 /path/to/keytab:host:account_name:sync_spns:sync_kvno:machine_password
14432 .fi
14433 .if n \{\
14434 .RE
14435 .\}
14436 .sp
14437 where the path to the keytab is obtained either from the krb5 library or from
14438 \m[blue]\fBdedicated keytab file\fR\m[]\&.
14439 .RE
14440 .sp
14441 .RS 4
14442 .ie n \{\
14443 \h'-04'\(bu\h'+03'\c
14444 .\}
14445 .el \{\
14446 .sp -1
14447 .IP \(bu 2.3
14448 .\}
14449 \fBnet changesecretpw \-f\fR
14450 command uses the default \*(Aqdisabled\*(Aq value\&.
14451 .RE
14452 .sp
14453 .RS 4
14454 .ie n \{\
14455 \h'-04'\(bu\h'+03'\c
14456 .\}
14457 .el \{\
14458 .sp -1
14459 .IP \(bu 2.3
14460 .\}
14461 No other
14462 \fBnet\fR
14463 subcommands use the \*(Aqdisabled\*(Aq value\&.
14464 .RE
14465 .sp
14466 .RE
14467 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\&.
14468 .sp
14469 Suggested configuration is together with
14470 \m[blue]\fBkerberos method\fR\m[]
14471 set to the default value \*(Aqsecrets only\*(Aq\&.
14472 .sp
14473 In clustered environments it is recommended to set
14474 \m[blue]\fBsync machine password script\fR\m[]
14475 to update the machine password on all nodes\&.
14476 .sp
14477 \fINo default\fR
14478 .RE
14479
14480 syslog (G)
14481 .PP
14482 .RS 4
14483 This parameter maps how Samba debug messages are logged onto the system syslog logging levels\&. Samba debug level zero maps onto syslog
14484 \fBLOG_ERR\fR, debug level one maps onto
14485 \fBLOG_WARNING\fR, debug level two maps onto
14486 \fBLOG_NOTICE\fR, debug level three maps onto LOG_INFO\&. All higher levels are mapped to
14487 \fBLOG_DEBUG\fR\&.
14488 .sp
14489 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
14490 \fIsyslog only\fR
14491 is enabled\&.
14492 .sp
14493 The
14494 \m[blue]\fBlogging\fR\m[]
14495 parameter should be used instead\&. When
14496 \m[blue]\fBlogging\fR\m[]
14497 is set, it overrides the
14498 \m[blue]\fBsyslog\fR\m[]
14499 parameter\&.
14500 .sp
14501 Default:
14502 \fI\fIsyslog\fR\fR\fI = \fR\fI1\fR\fI \fR
14503 .RE
14504
14505 syslog only (G)
14506 .PP
14507 .RS 4
14508 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
14509 \fIsyslog only\fR
14510 is enabled\&.
14511 .sp
14512 The
14513 \m[blue]\fBlogging\fR\m[]
14514 parameter should be used instead\&. When
14515 \m[blue]\fBlogging\fR\m[]
14516 is set, it overrides the
14517 \m[blue]\fBsyslog only\fR\m[]
14518 parameter\&.
14519 .sp
14520 Default:
14521 \fI\fIsyslog only\fR\fR\fI = \fR\fIno\fR\fI \fR
14522 .RE
14523
14524 template homedir (G)
14525 .PP
14526 .RS 4
14527 When filling out the user information for a Windows NT user, the
14528 \fBwinbindd\fR(8)
14529 daemon uses this parameter to fill in the home directory for that user\&. If the string
14530 \fI%D\fR
14531 is present it is substituted with the user\*(Aqs Windows NT domain name\&. If the string
14532 \fI%U\fR
14533 is present it is substituted with the user\*(Aqs Windows NT user name\&.
14534 .sp
14535 Default:
14536 \fI\fItemplate homedir\fR\fR\fI = \fR\fI/home/%D/%U\fR\fI \fR
14537 .RE
14538
14539 template shell (G)
14540 .PP
14541 .RS 4
14542 When filling out the user information for a Windows NT user, the
14543 \fBwinbindd\fR(8)
14544 daemon uses this parameter to fill in the login shell for that user\&.
14545 .sp
14546 Default:
14547 \fI\fItemplate shell\fR\fR\fI = \fR\fI/bin/false\fR\fI \fR
14548 .RE
14549
14550 time server (G)
14551 .PP
14552 .RS 4
14553 This parameter determines if
14554 \fBnmbd\fR(8)
14555 advertises itself as a time server to Windows clients\&.
14556 .sp
14557 Default:
14558 \fI\fItime server\fR\fR\fI = \fR\fIno\fR\fI \fR
14559 .RE
14560
14561 debug timestamp
14562 .PP
14563 .RS 4
14564 This parameter is a synonym for
14565 timestamp logs\&.
14566 .RE
14567
14568 timestamp logs (G)
14569 .PP
14570 .RS 4
14571 Samba debug log messages are timestamped by default\&. If you are running at a high
14572 \m[blue]\fBdebug level\fR\m[]
14573 these timestamps can be distracting\&. This boolean parameter allows timestamping to be turned off\&.
14574 .sp
14575 Default:
14576 \fI\fItimestamp logs\fR\fR\fI = \fR\fIyes\fR\fI \fR
14577 .RE
14578
14579 tls ca directories (G)
14580 .PP
14581 .RS 4
14582 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\&.
14583 .sp
14584 \fINo default\fR
14585 .RE
14586
14587 tls cafile (G)
14588 .PP
14589 .RS 4
14590 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\&.
14591 .sp
14592 This path is relative to
14593 \m[blue]\fBprivate dir\fR\m[]
14594 if the path does not start with a /\&.
14595 .sp
14596 Default:
14597 \fI\fItls cafile\fR\fR\fI = \fR\fItls/ca\&.pem\fR\fI \fR
14598 .RE
14599
14600 tls certfile (G)
14601 .PP
14602 .RS 4
14603 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\&.
14604 .sp
14605 This path is relative to
14606 \m[blue]\fBprivate dir\fR\m[]
14607 if the path does not start with a /\&.
14608 .sp
14609 Default:
14610 \fI\fItls certfile\fR\fR\fI = \fR\fItls/cert\&.pem\fR\fI \fR
14611 .RE
14612
14613 tls crlfile (G)
14614 .PP
14615 .RS 4
14616 This option can be set to a file containing a certificate revocation list (CRL)\&.
14617 .sp
14618 This path is relative to
14619 \m[blue]\fBprivate dir\fR\m[]
14620 if the path does not start with a /\&.
14621 .sp
14622 Default:
14623 \fI\fItls crlfile\fR\fR\fI = \fR\fI\fR\fI \fR
14624 .RE
14625
14626 tls dh params file (G)
14627 .PP
14628 .RS 4
14629 This option can be set to a file with Diffie\-Hellman parameters which will be used with DH ciphers\&.
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 dh params file\fR\fR\fI = \fR\fI\fR\fI \fR
14637 .RE
14638
14639 tls enabled (G)
14640 .PP
14641 .RS 4
14642 If this option is set to
14643 \fByes\fR, then Samba will use TLS when possible in communication\&.
14644 .sp
14645 Default:
14646 \fI\fItls enabled\fR\fR\fI = \fR\fIyes\fR\fI \fR
14647 .RE
14648
14649 tls keyfile (G)
14650 .PP
14651 .RS 4
14652 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\&.
14653 .sp
14654 This path is relative to
14655 \m[blue]\fBprivate dir\fR\m[]
14656 if the path does not start with a /\&.
14657 .sp
14658 Default:
14659 \fI\fItls keyfile\fR\fR\fI = \fR\fItls/key\&.pem\fR\fI \fR
14660 .RE
14661
14662 tls priority (G)
14663 .PP
14664 .RS 4
14665 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\&.
14666 .sp
14667 The string is appended to the default priority list of GnuTLS\&.
14668 .sp
14669 The valid options are described in the
14670 GNUTLS Priority\-Strings documentation at http://gnutls\&.org/manual/html_node/Priority\-Strings\&.html
14671 .sp
14672 The SSL3\&.0 protocol will be disabled\&.
14673 .sp
14674 Default:
14675 \fI\fItls priority\fR\fR\fI = \fR\fINORMAL:\-VERS\-SSL3\&.0\fR\fI \fR
14676 .RE
14677
14678 tls trust system cas (G)
14679 .PP
14680 .RS 4
14681 With this option the system\*(Aqs default trusted CAs are used to trust SSL/TLS connections\&.
14682 .sp
14683 Please use this with care, as it really means trusting all CAs installed on the system!
14684 .sp
14685 Default:
14686 \fI\fItls trust system cas\fR\fR\fI = \fR\fIno\fR\fI \fR
14687 .RE
14688
14689 tls verify peer (G)
14690 .PP
14691 .RS 4
14692 This controls if and how strict the client will verify the peer\*(Aqs certificate and name\&. Possible values are (in increasing order):
14693 \fBno_check\fR,
14694 \fBca_only\fR,
14695 \fBca_and_name_if_available\fR,
14696 \fBca_and_name\fR
14697 and
14698 \fBas_strict_as_possible\fR\&.
14699 .sp
14700 When set to
14701 \fBno_check\fR
14702 the certificate is not verified at all, which allows trivial man in the middle attacks\&.
14703 .sp
14704 When set to
14705 \fBca_only\fR
14706 the certificate is verified to be signed from a ca specified in the
14707 \m[blue]\fBtls ca file\fR\m[]
14708 option\&. As alternative
14709 \m[blue]\fBtls ca directories\fR\m[]
14710 or
14711 \m[blue]\fBtls trust system cas\fR\m[]
14712 can be used\&. Providing at least one valid CA certificate is required\&. The certificate lifetime is also verified\&. If the
14713 \m[blue]\fBtls crl file\fR\m[]
14714 option is configured, the certificate is also verified against the ca crl\&.
14715 .sp
14716 When set to
14717 \fBca_and_name_if_available\fR
14718 all checks from
14719 \fBca_only\fR
14720 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\&.
14721 .sp
14722 When set to
14723 \fBca_and_name\fR
14724 all checks from
14725 \fBca_and_name_if_available\fR
14726 are performed\&. In addition the peer hostname needs to be provided and even an ip address is checked against the certificate\*(Aqs name\&.
14727 .sp
14728 When set to
14729 \fBas_strict_as_possible\fR
14730 all checks from
14731 \fBca_and_name\fR
14732 are performed\&. In addition the
14733 \m[blue]\fBtls crl file\fR\m[]
14734 needs to be configured\&. Future versions of Samba may implement additional checks\&.
14735 .sp
14736 Default:
14737 \fI\fItls verify peer\fR\fR\fI = \fR\fIas_strict_as_possible\fR\fI \fR
14738 .RE
14739
14740 unicode (G)
14741 .PP
14742 .RS 4
14743 Specifies whether the server and client should support unicode\&.
14744 .sp
14745 If this option is set to false, the use of ASCII will be forced\&.
14746 .sp
14747 Default:
14748 \fI\fIunicode\fR\fR\fI = \fR\fIyes\fR\fI \fR
14749 .RE
14750
14751 unix charset (G)
14752 .PP
14753 .RS 4
14754 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\&.
14755 .sp
14756 This is also the charset Samba will use when specifying arguments to scripts that it invokes\&.
14757 .sp
14758 Default:
14759 \fI\fIunix charset\fR\fR\fI = \fR\fIUTF\-8\fR\fI \fR
14760 .sp
14761 Example:
14762 \fI\fIunix charset\fR\fR\fI = \fR\fIASCII\fR\fI \fR
14763 .RE
14764
14765 unix password sync (G)
14766 .PP
14767 .RS 4
14768 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
14769 \fByes\fR
14770 the program specified in the
14771 \fIpasswd program\fR
14772 parameter is called
14773 \fIAS ROOT\fR
14774 \- 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)\&.
14775 .sp
14776 This option has no effect if
14777 samba
14778 is running as an active directory domain controller, in that case have a look at the
14779 \m[blue]\fBpassword hash gpg key ids\fR\m[]
14780 option and the
14781 samba\-tool user syncpasswords
14782 command\&.
14783 .sp
14784 Default:
14785 \fI\fIunix password sync\fR\fR\fI = \fR\fIno\fR\fI \fR
14786 .RE
14787
14788 use client driver (S)
14789 .PP
14790 .RS 4
14791 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
14792 disable spoolss = yes\&.
14793 .sp
14794 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)\&.
14795 .sp
14796 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\&.
14797 \fIThis parameter MUST not be enabled on a print share which has valid print driver installed on the Samba server\&.\fR
14798 .sp
14799 Default:
14800 \fI\fIuse client driver\fR\fR\fI = \fR\fIno\fR\fI \fR
14801 .RE
14802
14803 use mmap (G)
14804 .PP
14805 .RS 4
14806 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
14807 \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\&.
14808 .sp
14809 Default:
14810 \fI\fIuse mmap\fR\fR\fI = \fR\fIyes\fR\fI \fR
14811 .RE
14812
14813 username level (G)
14814 .PP
14815 .RS 4
14816 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\&.
14817 .sp
14818 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
14819 \fBAstrangeUser \fR\&.
14820 .sp
14821 This parameter is needed only on UNIX systems that have case sensitive usernames\&.
14822 .sp
14823 Default:
14824 \fI\fIusername level\fR\fR\fI = \fR\fI0\fR\fI \fR
14825 .sp
14826 Example:
14827 \fI\fIusername level\fR\fR\fI = \fR\fI5\fR\fI \fR
14828 .RE
14829
14830 username map (G)
14831 .PP
14832 .RS 4
14833 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\&.
14834 .sp
14835 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 =
14836 DOMAIN\efoo)\&.
14837 .sp
14838 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\&.
14839 .sp
14840 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\&.
14841 .sp
14842 If any line begins with a \*(Aq#\*(Aq or a \*(Aq;\*(Aq then it is ignored\&.
14843 .sp
14844 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\&.
14845 .sp
14846 For example to map from the name
14847 \fBadmin\fR
14848 or
14849 \fBadministrator\fR
14850 to the UNIX name
14851 \fB root\fR
14852 you would use:
14853 .sp
14854 .if n \{\
14855 .RS 4
14856 .\}
14857 .nf
14858 root = admin administrator
14859 .fi
14860 .if n \{\
14861 .RE
14862 .\}
14863 .sp
14864 Or to map anyone in the UNIX group
14865 \fBsystem\fR
14866 to the UNIX name
14867 \fBsys\fR
14868 you would use:
14869 .sp
14870 .if n \{\
14871 .RS 4
14872 .\}
14873 .nf
14874 sys = @system
14875 .fi
14876 .if n \{\
14877 .RE
14878 .\}
14879 .sp
14880 You can have as many mappings as you like in a username map file\&.
14881 .sp
14882 If your system supports the NIS NETGROUP option then the netgroup database is checked before the
14883 /etc/group
14884 database for matching groups\&.
14885 .sp
14886 You can map Windows usernames that have spaces in them by using double quotes around the name\&. For example:
14887 .sp
14888 .if n \{\
14889 .RS 4
14890 .\}
14891 .nf
14892 tridge = "Andrew Tridgell"
14893 .fi
14894 .if n \{\
14895 .RE
14896 .\}
14897 .sp
14898 would map the windows username "Andrew Tridgell" to the unix username "tridge"\&.
14899 .sp
14900 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:
14901 .sp
14902 .if n \{\
14903 .RS 4
14904 .\}
14905 .nf
14906 !sys = mary fred
14907 guest = *
14908 .fi
14909 .if n \{\
14910 .RE
14911 .\}
14912 .sp
14913 Note that the remapping is applied to all occurrences of usernames\&. Thus if you connect to \e\eserver\efred and
14914 \fBfred\fR
14915 is remapped to
14916 \fBmary\fR
14917 then you will actually be connecting to \e\eserver\emary and will need to supply a password suitable for
14918 \fBmary\fR
14919 not
14920 \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\&.
14921 .sp
14922 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\&.
14923 .sp
14924 Samba versions prior to 3\&.0\&.8 would only support reading the fully qualified username (e\&.g\&.:
14925 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\&.
14926 .sp
14927 The following functionality is obeyed in version 3\&.0\&.8 and later:
14928 .sp
14929 When performing local authentication, the username map is applied to the login name before attempting to authenticate the connection\&.
14930 .sp
14931 When relying upon a external domain controller for validating authentication requests, smbd will apply the username map to the fully qualified username (i\&.e\&.
14932 DOMAIN\euser) only after the user has been successfully authenticated\&.
14933 .sp
14934 An example of use is:
14935 .sp
14936 .if n \{\
14937 .RS 4
14938 .\}
14939 .nf
14940 username map = /usr/local/samba/lib/users\&.map
14941 .fi
14942 .if n \{\
14943 .RE
14944 .\}
14945 .sp
14946 Default:
14947 \fI\fIusername map\fR\fR\fI = \fR\fI # no username map\fR\fI \fR
14948 .RE
14949
14950 username map cache time (G)
14951 .PP
14952 .RS 4
14953 Mapping usernames with the
14954 \m[blue]\fBusername map\fR\m[]
14955 or
14956 \m[blue]\fBusername map script\fR\m[]
14957 features of Samba can be relatively expensive\&. During login of a user, the mapping is done several times\&. In particular, calling the
14958 \m[blue]\fBusername map script\fR\m[]
14959 can slow down logins if external databases have to be queried from the script being called\&.
14960 .sp
14961 The parameter
14962 \m[blue]\fBusername map cache time\fR\m[]
14963 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\&.
14964 .sp
14965 Default:
14966 \fI\fIusername map cache time\fR\fR\fI = \fR\fI0\fR\fI \fR
14967 .sp
14968 Example:
14969 \fI\fIusername map cache time\fR\fR\fI = \fR\fI60\fR\fI \fR
14970 .RE
14971
14972 username map script (G)
14973 .PP
14974 .RS 4
14975 This script is a mutually exclusive alternative to the
14976 \m[blue]\fBusername map\fR\m[]
14977 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\&.
14978 .sp
14979 Default:
14980 \fI\fIusername map script\fR\fR\fI = \fR\fI\fR\fI \fR
14981 .sp
14982 Example:
14983 \fI\fIusername map script\fR\fR\fI = \fR\fI/etc/samba/scripts/mapusers\&.sh\fR\fI \fR
14984 .RE
14985
14986 usershare allow guests (G)
14987 .PP
14988 .RS 4
14989 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
14990 \fIguest ok = yes\fR
14991 in a share definition\&. Due to its security sensitive nature, the default is set to off\&.
14992 .sp
14993 Default:
14994 \fI\fIusershare allow guests\fR\fR\fI = \fR\fIno\fR\fI \fR
14995 .RE
14996
14997 usershare max shares (G)
14998 .PP
14999 .RS 4
15000 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\&.
15001 .sp
15002 Default:
15003 \fI\fIusershare max shares\fR\fR\fI = \fR\fI0\fR\fI \fR
15004 .RE
15005
15006 usershare owner only (G)
15007 .PP
15008 .RS 4
15009 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\&.
15010 .sp
15011 Default:
15012 \fI\fIusershare owner only\fR\fR\fI = \fR\fIyes\fR\fI \fR
15013 .RE
15014
15015 usershare path (G)
15016 .PP
15017 .RS 4
15018 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\&.
15019 .sp
15020 For example, a valid usershare directory might be /usr/local/samba/lib/usershares, set up as follows\&.
15021 .sp
15022 .if n \{\
15023 .RS 4
15024 .\}
15025 .nf
15026 ls \-ld /usr/local/samba/lib/usershares/
15027 drwxrwx\-\-T 2 root power_users 4096 2006\-05\-05 12:27 /usr/local/samba/lib/usershares/
15028
15029 .fi
15030 .if n \{\
15031 .RE
15032 .\}
15033 .sp
15034 In this case, only members of the group "power_users" can create user defined shares\&.
15035 .sp
15036 Default:
15037 \fI\fIusershare path\fR\fR\fI = \fR\fI/var/lib/samba/usershares\fR\fI \fR
15038 .RE
15039
15040 usershare prefix allow list (G)
15041 .PP
15042 .RS 4
15043 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\&.
15044 .sp
15045 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\&.
15046 .sp
15047 Default:
15048 \fI\fIusershare prefix allow list\fR\fR\fI = \fR\fI\fR\fI \fR
15049 .sp
15050 Example:
15051 \fI\fIusershare prefix allow list\fR\fR\fI = \fR\fI/home /data /space\fR\fI \fR
15052 .RE
15053
15054 usershare prefix deny list (G)
15055 .PP
15056 .RS 4
15057 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\&.
15058 .sp
15059 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\&.
15060 .sp
15061 Default:
15062 \fI\fIusershare prefix deny list\fR\fR\fI = \fR\fI\fR\fI \fR
15063 .sp
15064 Example:
15065 \fI\fIusershare prefix deny list\fR\fR\fI = \fR\fI/etc /dev /private\fR\fI \fR
15066 .RE
15067
15068 usershare template share (G)
15069 .PP
15070 .RS 4
15071 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\&.
15072 .sp
15073 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\&.
15074 .sp
15075 Default:
15076 \fI\fIusershare template share\fR\fR\fI = \fR\fI\fR\fI \fR
15077 .sp
15078 Example:
15079 \fI\fIusershare template share\fR\fR\fI = \fR\fItemplate_share\fR\fI \fR
15080 .RE
15081
15082 use sendfile (S)
15083 .PP
15084 .RS 4
15085 If this parameter is
15086 \fByes\fR, and the
15087 \fBsendfile()\fR
15088 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)\&.
15089 .sp
15090 Default:
15091 \fI\fIuse sendfile\fR\fR\fI = \fR\fIno\fR\fI \fR
15092 .RE
15093
15094 utmp (G)
15095 .PP
15096 .RS 4
15097 This boolean parameter is only available if Samba has been configured and compiled with the option
15098 \-\-with\-utmp\&. If set to
15099 \fByes\fR
15100 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\&.
15101 .sp
15102 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\&.
15103 .sp
15104 Default:
15105 \fI\fIutmp\fR\fR\fI = \fR\fIno\fR\fI \fR
15106 .RE
15107
15108 utmp directory (G)
15109 .PP
15110 .RS 4
15111 This parameter is only available if Samba has been configured and compiled with the option
15112 \-\-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
15113 /var/run/utmp
15114 on Linux)\&.
15115 .sp
15116 Default:
15117 \fI\fIutmp directory\fR\fR\fI = \fR\fI # Determined automatically\fR\fI \fR
15118 .sp
15119 Example:
15120 \fI\fIutmp directory\fR\fR\fI = \fR\fI/var/run/utmp\fR\fI \fR
15121 .RE
15122
15123 \-valid (S)
15124 .PP
15125 .RS 4
15126 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\&.
15127 .sp
15128 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\&.
15129 .sp
15130 Default:
15131 \fI\fI\-valid\fR\fR\fI = \fR\fIyes\fR\fI \fR
15132 .RE
15133
15134 valid users (S)
15135 .PP
15136 .RS 4
15137 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
15138 \fIinvalid users\fR
15139 parameter\&.
15140 .sp
15141 If this is empty (the default) then any user can login\&. If a username is in both this list and the
15142 \fIinvalid users\fR
15143 list then access is denied for that user\&.
15144 .sp
15145 The current servicename is substituted for
15146 \fI%S\fR\&. This is useful in the [homes] section\&.
15147 .sp
15148 \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
15149 \fIlocal master\fR,
15150 \fIos level\fR,
15151 \fIdomain master\fR,
15152 \fIpreferred master\fR) this option will prevent workstations from being able to browse the network\&.
15153 .sp
15154 Default:
15155 \fI\fIvalid users\fR\fR\fI = \fR\fI # No valid users list (anyone can login) \fR\fI \fR
15156 .sp
15157 Example:
15158 \fI\fIvalid users\fR\fR\fI = \fR\fIgreg, @pcusers\fR\fI \fR
15159 .RE
15160
15161 veto files (S)
15162 .PP
15163 .RS 4
15164 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\&.
15165 .sp
15166 \m[blue]\fBveto files\fR\m[]
15167 can also be used as a parametric option where NAME in
15168 .sp
15169 veto files : NAME =
15170 .sp
15171 specifies a user or group name with the same syntax as
15172 \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\&.
15173 .sp
15174 Each filename must be a unix path, not a DOS path and must
15175 \fInot\fR
15176 include the unix directory separator \*(Aq/\*(Aq\&.
15177 .sp
15178 Note that the
15179 \m[blue]\fBcase sensitive\fR\m[]
15180 option is applicable in vetoing files\&.
15181 .sp
15182 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
15183 \fIfail\fR
15184 unless you also set the
15185 \m[blue]\fBdelete veto files\fR\m[]
15186 parameter to
15187 \fIyes\fR\&.
15188 .sp
15189 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\&.
15190 .sp
15191 Examples of use include:
15192 .sp
15193 .if n \{\
15194 .RS 4
15195 .\}
15196 .nf
15197 ; Veto any files containing the word Security,
15198 ; any ending in \&.tmp, and any directory containing the
15199 ; word root\&.
15200 veto files = /*Security*/*\&.tmp/*root*/
15201
15202 ; Veto some files for anyone and some files for specific users and groups
15203 veto files = /vetoforall1/
15204 veto files : USER = /vetotoforuser/
15205 veto files : GROUP = /vetoforgroup/
15206 veto files : UNIVERSITY\eAlumnis = /somefile\&.txt/
15207 veto files : john@university\&.org = /anotherfile\&.txt/
15208 veto files : S\-1\-5\-21\-123\-456\-789\-1000 = /secretfile\&.txt/
15209
15210 ; Veto the Apple specific files that a NetAtalk server
15211 ; creates\&.
15212 veto files = /\&.AppleDouble/\&.bin/\&.AppleDesktop/Network Trash Folder/
15213 .fi
15214 .if n \{\
15215 .RE
15216 .\}
15217 .sp
15218 Default:
15219 \fI\fIveto files\fR\fR\fI = \fR\fI # No files or directories are vetoed\fR\fI \fR
15220 .RE
15221
15222 veto oplock files (S)
15223 .PP
15224 .RS 4
15225 This parameter is only valid when the
15226 \m[blue]\fBoplocks\fR\m[]
15227 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
15228 \m[blue]\fBveto files\fR\m[]
15229 parameter\&.
15230 .sp
15231 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
15232 \&.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\&.
15233 .sp
15234 An example of use is:
15235 .sp
15236 .if n \{\
15237 .RS 4
15238 .\}
15239 .nf
15240 veto oplock files = /\&.*SEM/
15241 .fi
15242 .if n \{\
15243 .RE
15244 .\}
15245 .sp
15246 Default:
15247 \fI\fIveto oplock files\fR\fR\fI = \fR\fI # No files are vetoed for oplock grants\fR\fI \fR
15248 .RE
15249
15250 vfs mkdir use tmp name (S)
15251 .PP
15252 .RS 4
15253 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\&.
15254 .sp
15255 Other clients should not see the existence of the directory that is in progress of being created!
15256 .sp
15257 This option is an enumerated type that controls the usage of a temporary directory name\&. When this is set to
15258 \fByes\fR, the directory name will be prefixed with \*(Aq\&.::TMPNAME:D:$SERVERID:\*(Aq (where $SERVERID is a unique identifier for the current process)\&.
15259 .sp
15260 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
15261 \fBno\fR:
15262 \m[blue]\fBinherit acls\fR\m[],
15263 \m[blue]\fBinherit owner\fR\m[],
15264 \m[blue]\fBinherit permissions\fR\m[],
15265 \m[blue]\fBnt acl support\fR\m[]
15266 or
15267 \m[blue]\fBstore dos attributes\fR\m[]\&. Note on OpenBSD Auto (the default) is mapped to
15268 \fBno\fR, see
15269 https://bugzilla\&.samba\&.org/show_bug\&.cgi?id=15801\&.
15270 .sp
15271 A re\-export of an SMB/CIFS mount might one rare case where
15272 vfs mkdir use tmp name = no
15273 could be useful\&.
15274 .sp
15275 In most cases
15276 vfs mkdir use tmp name = Auto
15277 should be kept\&.
15278 .sp
15279 Default:
15280 \fI\fIvfs mkdir use tmp name\fR\fR\fI = \fR\fIAuto\fR\fI \fR
15281 .RE
15282
15283 vfs object
15284 .PP
15285 .RS 4
15286 This parameter is a synonym for
15287 vfs objects\&.
15288 .RE
15289
15290 vfs objects (S)
15291 .PP
15292 .RS 4
15293 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\&.
15294 .sp
15295 Default:
15296 \fI\fIvfs objects\fR\fR\fI = \fR\fI\fR\fI \fR
15297 .sp
15298 Example:
15299 \fI\fIvfs objects\fR\fR\fI = \fR\fIextd_audit recycle\fR\fI \fR
15300 .RE
15301
15302 volume (S)
15303 .PP
15304 .RS 4
15305 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\&.
15306 .sp
15307 Default:
15308 \fI\fIvolume\fR\fR\fI = \fR\fI # the name of the share\fR\fI \fR
15309 .RE
15310
15311 volume serial number (S)
15312 .PP
15313 .RS 4
15314 This allows to override the volume serial number (a 32bit value) reported for a share\&.
15315 .sp
15316 The special value
15317 \fI\-1\fR
15318 (default) stands for a unique number that is calculated for each share\&.
15319 .sp
15320 Default:
15321 \fI\fIvolume serial number\fR\fR\fI = \fR\fI\-1\fR\fI \fR
15322 .sp
15323 Example:
15324 \fI\fIvolume serial number\fR\fR\fI = \fR\fI0xabcdefgh\fR\fI \fR
15325 .RE
15326
15327 wide links (S)
15328 .PP
15329 .RS 4
15330 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\&.
15331 .sp
15332 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
15333 \m[blue]\fBunix extensions\fR\m[]
15334 option is on\&.
15335 .sp
15336 See the parameter
15337 \m[blue]\fBallow insecure wide links\fR\m[]
15338 if you wish to change this coupling between the two parameters\&.
15339 .sp
15340 Default:
15341 \fI\fIwide links\fR\fR\fI = \fR\fIno\fR\fI \fR
15342 .RE
15343
15344 winbind cache time (G)
15345 .PP
15346 .RS 4
15347 This parameter specifies the number of seconds the
15348 \fBwinbindd\fR(8)
15349 daemon will cache user and group information before querying a Windows NT server again\&.
15350 .sp
15351 This does not apply to authentication requests, these are always evaluated in real time unless the
15352 \m[blue]\fBwinbind offline logon\fR\m[]
15353 option has been enabled\&.
15354 .sp
15355 Default:
15356 \fI\fIwinbind cache time\fR\fR\fI = \fR\fI300\fR\fI \fR
15357 .RE
15358
15359 winbindd socket directory (G)
15360 .PP
15361 .RS 4
15362 This setting controls the location of the winbind daemon\*(Aqs socket\&.
15363 .sp
15364 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\&.
15365 .sp
15366 Default:
15367 \fI\fIwinbindd socket directory\fR\fR\fI = \fR\fI/run/samba/winbindd\fR\fI \fR
15368 .RE
15369
15370 winbind enum groups (G)
15371 .PP
15372 .RS 4
15373 On large installations using
15374 \fBwinbindd\fR(8)
15375 it may be necessary to suppress the enumeration of groups through the
15376 setgrent(),
15377 getgrent()
15378 and
15379 endgrent()
15380 group of system calls\&. If the
15381 \fIwinbind enum groups\fR
15382 parameter is
15383 \fBno\fR, calls to the
15384 getgrent()
15385 system call will not return any data\&.
15386 .if n \{\
15387 .sp
15388 .\}
15389 .RS 4
15390 .it 1 an-trap
15391 .nr an-no-space-flag 1
15392 .nr an-break-flag 1
15393 .br
15394 .ps +1
15395 \fBWarning\fR
15396 .ps -1
15397 .br
15398 Turning off group enumeration may cause some programs to behave oddly\&.
15399 .sp .5v
15400 .RE
15401 Default:
15402 \fI\fIwinbind enum groups\fR\fR\fI = \fR\fIno\fR\fI \fR
15403 .RE
15404
15405 winbind enum users (G)
15406 .PP
15407 .RS 4
15408 On large installations using
15409 \fBwinbindd\fR(8)
15410 it may be necessary to suppress the enumeration of users through the
15411 setpwent(),
15412 getpwent()
15413 and
15414 endpwent()
15415 group of system calls\&. If the
15416 \fIwinbind enum users\fR
15417 parameter is
15418 \fBno\fR, calls to the
15419 getpwent
15420 system call will not return any data\&.
15421 .if n \{\
15422 .sp
15423 .\}
15424 .RS 4
15425 .it 1 an-trap
15426 .nr an-no-space-flag 1
15427 .nr an-break-flag 1
15428 .br
15429 .ps +1
15430 \fBWarning\fR
15431 .ps -1
15432 .br
15433 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\&.
15434 .sp .5v
15435 .RE
15436 Default:
15437 \fI\fIwinbind enum users\fR\fR\fI = \fR\fIno\fR\fI \fR
15438 .RE
15439
15440 winbind expand groups (G)
15441 .PP
15442 .RS 4
15443 This option controls the maximum depth that winbindd will traverse when flattening nested group memberships of Windows domain groups\&. This is different from the
15444 \m[blue]\fBwinbind nested groups\fR\m[]
15445 option which implements the Windows NT4 model of local group nesting\&. The "winbind expand groups" parameter specifically applies to the membership of domain groups\&.
15446 .sp
15447 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\&.
15448 .sp
15449 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\&.
15450 .sp
15451 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\&.
15452 .sp
15453 Default:
15454 \fI\fIwinbind expand groups\fR\fR\fI = \fR\fI0\fR\fI \fR
15455 .RE
15456
15457 winbind:ignore domains (G)
15458 .PP
15459 .RS 4
15460 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\&.
15461 .sp
15462 Default:
15463 \fI\fIwinbind:ignore domains\fR\fR\fI = \fR\fI\fR\fI \fR
15464 .sp
15465 Example:
15466 \fI\fIwinbind:ignore domains\fR\fR\fI = \fR\fIDOMAIN1, DOMAIN2\fR\fI \fR
15467 .RE
15468
15469 winbind max clients (G)
15470 .PP
15471 .RS 4
15472 This parameter specifies the maximum number of clients the
15473 \fBwinbindd\fR(8)
15474 daemon can connect with\&. The parameter is not a hard limit\&. The
15475 \fBwinbindd\fR(8)
15476 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\&.
15477 .sp
15478 Default:
15479 \fI\fIwinbind max clients\fR\fR\fI = \fR\fI200\fR\fI \fR
15480 .RE
15481
15482 winbind max domain connections (G)
15483 .PP
15484 .RS 4
15485 This parameter specifies the maximum number of simultaneous connections that the
15486 \fBwinbindd\fR(8)
15487 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\&.
15488 .sp
15489 Note that if
15490 \m[blue]\fBwinbind offline logon\fR\m[]
15491 is set to
15492 \fBYes\fR, then only one DC connection is allowed per domain, regardless of this setting\&.
15493 .sp
15494 Default:
15495 \fI\fIwinbind max domain connections\fR\fR\fI = \fR\fI1\fR\fI \fR
15496 .sp
15497 Example:
15498 \fI\fIwinbind max domain connections\fR\fR\fI = \fR\fI10\fR\fI \fR
15499 .RE
15500
15501 winbind nested groups (G)
15502 .PP
15503 .RS 4
15504 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\&.
15505 .sp
15506 Default:
15507 \fI\fIwinbind nested groups\fR\fR\fI = \fR\fIyes\fR\fI \fR
15508 .RE
15509
15510 winbind normalize names (G)
15511 .PP
15512 .RS 4
15513 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\&.
15514 .sp
15515 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\&.
15516 .sp
15517 Default:
15518 \fI\fIwinbind normalize names\fR\fR\fI = \fR\fIno\fR\fI \fR
15519 .sp
15520 Example:
15521 \fI\fIwinbind normalize names\fR\fR\fI = \fR\fIyes\fR\fI \fR
15522 .RE
15523
15524 winbind nss info (G)
15525 .PP
15526 .RS 4
15527 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:
15528 .RS
15529 .sp
15530 .RS 4
15531 .ie n \{\
15532 \h'-04'\(bu\h'+03'\c
15533 .\}
15534 .el \{\
15535 .sp -1
15536 .IP \(bu 2.3
15537 .\}
15538 \fItemplate\fR
15539 \- The default, using the parameters of
15540 \fItemplate shell\fR
15541 and
15542 \fItemplate homedir\fR)
15543 .RE
15544 .sp
15545 .RS 4
15546 .ie n \{\
15547 \h'-04'\(bu\h'+03'\c
15548 .\}
15549 .el \{\
15550 .sp -1
15551 .IP \(bu 2.3
15552 .\}
15553 \fI<sfu | sfu20 | rfc2307 >\fR
15554 \- 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"\&.
15555 .sp
15556 Note that for the idmap backend
15557 idmap_ad
15558 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\&.
15559 .RE
15560 .sp
15561 .RE
15562 .sp
15563 Default:
15564 \fI\fIwinbind nss info\fR\fR\fI = \fR\fItemplate\fR\fI \fR
15565 .sp
15566 Example:
15567 \fI\fIwinbind nss info\fR\fR\fI = \fR\fIsfu\fR\fI \fR
15568 .RE
15569
15570 winbind offline logon (G)
15571 .PP
15572 .RS 4
15573 This parameter is designed to control whether Winbind should allow one to login with the
15574 \fIpam_winbind\fR
15575 module using Cached Credentials\&. If enabled, winbindd will store user credentials from successful logins encrypted in a local cache\&.
15576 .sp
15577 Default:
15578 \fI\fIwinbind offline logon\fR\fR\fI = \fR\fIno\fR\fI \fR
15579 .sp
15580 Example:
15581 \fI\fIwinbind offline logon\fR\fR\fI = \fR\fIyes\fR\fI \fR
15582 .RE
15583
15584 winbind reconnect delay (G)
15585 .PP
15586 .RS 4
15587 This parameter specifies the number of seconds the
15588 \fBwinbindd\fR(8)
15589 daemon will wait between attempts to contact a Domain controller for a domain that is determined to be down or not contactable\&.
15590 .sp
15591 Default:
15592 \fI\fIwinbind reconnect delay\fR\fR\fI = \fR\fI30\fR\fI \fR
15593 .RE
15594
15595 winbind refresh tickets (G)
15596 .PP
15597 .RS 4
15598 This parameter is designed to control whether Winbind should refresh Kerberos Tickets retrieved using the
15599 \fIpam_winbind\fR
15600 module\&.
15601 .sp
15602 Default:
15603 \fI\fIwinbind refresh tickets\fR\fR\fI = \fR\fIno\fR\fI \fR
15604 .sp
15605 Example:
15606 \fI\fIwinbind refresh tickets\fR\fR\fI = \fR\fIyes\fR\fI \fR
15607 .RE
15608
15609 winbind request timeout (G)
15610 .PP
15611 .RS 4
15612 This parameter specifies the number of seconds the
15613 \fBwinbindd\fR(8)
15614 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\&.
15615 .sp
15616 Default:
15617 \fI\fIwinbind request timeout\fR\fR\fI = \fR\fI60\fR\fI \fR
15618 .RE
15619
15620 winbind rpc only (G)
15621 .PP
15622 .RS 4
15623 Setting this parameter to
15624 yes
15625 forces winbindd to use RPC instead of LDAP to retrieve information from Domain Controllers\&.
15626 .sp
15627 Default:
15628 \fI\fIwinbind rpc only\fR\fR\fI = \fR\fIno\fR\fI \fR
15629 .RE
15630
15631 winbind scan trusted domains (G)
15632 .PP
15633 .RS 4
15634 This option only takes effect when the
15635 \m[blue]\fBsecurity\fR\m[]
15636 option is set to
15637 \fBdomain\fR
15638 or
15639 \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
15640 wbinfo \-\-trusted\-domains \-\-verbose\&. Setting it to yes matches the behaviour of Samba 4\&.7 and older\&.
15641 .sp
15642 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
15643 \fBautorid\fR,
15644 \fBtdb\fR
15645 or
15646 \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\&.
15647 .sp
15648 If you have a setup that doesn\*(Aqt require the global list, you should set
15649 \m[blue]\fBwinbind scan trusted domains = no\fR\m[]\&.
15650 .sp
15651 Default:
15652 \fI\fIwinbind scan trusted domains\fR\fR\fI = \fR\fIno\fR\fI \fR
15653 .RE
15654
15655 winbind sealed pipes (G)
15656 .PP
15657 .RS 4
15658 This option controls whether any requests from winbindd to domain controllers pipe will be sealed\&. Disabling sealing can be useful for debugging purposes\&.
15659 .sp
15660 The behavior can be controlled per netbios domain by using \*(Aqwinbind sealed pipes:NETBIOSDOMAIN = no\*(Aq as option\&.
15661 .sp
15662 Default:
15663 \fI\fIwinbind sealed pipes\fR\fR\fI = \fR\fIyes\fR\fI \fR
15664 .RE
15665
15666 winbind separator (G)
15667 .PP
15668 .RS 4
15669 This parameter allows an admin to define the character used when listing a username of the form of
15670 \fIDOMAIN \fR\e\fIuser\fR\&. This parameter is only applicable when using the
15671 pam_winbind\&.so
15672 and
15673 nss_winbind\&.so
15674 modules for UNIX services\&.
15675 .sp
15676 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\&.
15677 .sp
15678 Default:
15679 \fI\fIwinbind separator\fR\fR\fI = \fR\fI\e\fR\fI \fR
15680 .sp
15681 Example:
15682 \fI\fIwinbind separator\fR\fR\fI = \fR\fI+\fR\fI \fR
15683 .RE
15684
15685 winbind use default domain (G)
15686 .PP
15687 .RS 4
15688 This parameter specifies whether the
15689 \fBwinbindd\fR(8)
15690 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\&.
15691 .sp
15692 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\&.
15693 .sp
15694 Default:
15695 \fI\fIwinbind use default domain\fR\fR\fI = \fR\fIno\fR\fI \fR
15696 .sp
15697 Example:
15698 \fI\fIwinbind use default domain\fR\fR\fI = \fR\fIyes\fR\fI \fR
15699 .RE
15700
15701 winbind use krb5 enterprise principals (G)
15702 .PP
15703 .RS 4
15704 winbindd is able to get kerberos tickets for pam_winbind with krb5_auth or wbinfo \-K/\-\-krb5auth=\&.
15705 .sp
15706 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\&.
15707 .sp
15708 With
15709 \m[blue]\fBwinbind scan trusted domains = no\fR\m[]
15710 winbindd doesn\*(Aqt even get a complete picture of the topology\&.
15711 .sp
15712 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\&.
15713 .sp
15714 With
15715 \m[blue]\fBwinbind use krb5 enterprise principals = yes\fR\m[]
15716 winbindd enterprise principals will be used\&.
15717 .sp
15718 Default:
15719 \fI\fIwinbind use krb5 enterprise principals\fR\fR\fI = \fR\fIyes\fR\fI \fR
15720 .sp
15721 Example:
15722 \fI\fIwinbind use krb5 enterprise principals\fR\fR\fI = \fR\fIno\fR\fI \fR
15723 .RE
15724
15725 winbind varlink service (G)
15726 .PP
15727 .RS 4
15728 This setting controls whether
15729 \fBwinbind\fR(8)
15730 will listen for User/Group record lookup from
15731 \fBnss-systemd\fR(8)
15732 via Varlink, offering an alternative to nss_winbind\&.
15733 .sp
15734 For more information about User/Group record lookup via Varlink see https://systemd\&.io/USER_GROUP_API/ and
15735 \fBnss-systemd \fR(8)
15736 manpage\&.
15737 .sp
15738 .if n \{\
15739 .sp
15740 .\}
15741 .RS 4
15742 .it 1 an-trap
15743 .nr an-no-space-flag 1
15744 .nr an-break-flag 1
15745 .br
15746 .ps +1
15747 \fBWarning\fR
15748 .ps -1
15749 .br
15750 \fBSystemd\fR(1)
15751 versions prior 253 consider the default
15752 \m[blue]\fBwinbind separator\fR\m[]
15753 \*(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\&.
15754 .sp .5v
15755 .RE
15756 .sp
15757 .if n \{\
15758 .sp
15759 .\}
15760 .RS 4
15761 .it 1 an-trap
15762 .nr an-no-space-flag 1
15763 .nr an-break-flag 1
15764 .br
15765 .ps +1
15766 \fBWarning\fR
15767 .ps -1
15768 .br
15769 This setting has no effect in platforms or distributions without
15770 \fBsystemd\fR(1)\&.
15771 .sp .5v
15772 .RE
15773 .sp
15774 Default:
15775 \fI\fIwinbind varlink service\fR\fR\fI = \fR\fIno\fR\fI \fR
15776 .RE
15777
15778 winsdb:local_owner (G)
15779 .PP
15780 .RS 4
15781 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\&.
15782 .sp
15783 \fINo default\fR
15784 .RE
15785
15786 winsdb:dbnosync (G)
15787 .PP
15788 .RS 4
15789 This parameter disables fsync() after changes of the WINS database\&.
15790 .sp
15791 Default:
15792 \fI\fIwinsdb:dbnosync\fR\fR\fI = \fR\fIno\fR\fI \fR
15793 .RE
15794
15795 wins hook (G)
15796 .PP
15797 .RS 4
15798 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\&.
15799 .sp
15800 The wins hook parameter specifies the name of a script or executable that will be called as follows:
15801 .sp
15802 wins_hook operation name nametype ttl IP_list
15803 .RS
15804 .sp
15805 .RS 4
15806 .ie n \{\
15807 \h'-04'\(bu\h'+03'\c
15808 .\}
15809 .el \{\
15810 .sp -1
15811 .IP \(bu 2.3
15812 .\}
15813 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\&.
15814 .RE
15815 .sp
15816 .RS 4
15817 .ie n \{\
15818 \h'-04'\(bu\h'+03'\c
15819 .\}
15820 .el \{\
15821 .sp -1
15822 .IP \(bu 2.3
15823 .\}
15824 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\&.
15825 .RE
15826 .sp
15827 .RS 4
15828 .ie n \{\
15829 \h'-04'\(bu\h'+03'\c
15830 .\}
15831 .el \{\
15832 .sp -1
15833 .IP \(bu 2.3
15834 .\}
15835 The third argument is the NetBIOS name type as a 2 digit hexadecimal number\&.
15836 .RE
15837 .sp
15838 .RS 4
15839 .ie n \{\
15840 \h'-04'\(bu\h'+03'\c
15841 .\}
15842 .el \{\
15843 .sp -1
15844 .IP \(bu 2.3
15845 .\}
15846 The fourth argument is the TTL (time to live) for the name in seconds\&.
15847 .RE
15848 .sp
15849 .RS 4
15850 .ie n \{\
15851 \h'-04'\(bu\h'+03'\c
15852 .\}
15853 .el \{\
15854 .sp -1
15855 .IP \(bu 2.3
15856 .\}
15857 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\&.
15858 .RE
15859 .sp
15860 .RE
15861 An example script that calls the BIND dynamic DNS update program
15862 nsupdate
15863 is provided in the examples directory of the Samba source code\&.
15864 .sp
15865 \fINo default\fR
15866 .RE
15867
15868 wins proxy (G)
15869 .PP
15870 .RS 4
15871 This is a boolean that controls if
15872 \fBnmbd\fR(8)
15873 will respond to broadcast name queries on behalf of other hosts\&. You may need to set this to
15874 \fByes\fR
15875 for some older clients\&.
15876 .sp
15877 Default:
15878 \fI\fIwins proxy\fR\fR\fI = \fR\fIno\fR\fI \fR
15879 .RE
15880
15881 wins server (G)
15882 .PP
15883 .RS 4
15884 This specifies the IP address (or DNS name: IP address for preference) of the WINS server that
15885 \fBnmbd\fR(8)
15886 should register with\&. If you have a WINS server on your network then you should set this to the WINS server\*(Aqs IP\&.
15887 .sp
15888 You should point this at your WINS server if you have a multi\-subnetted network\&.
15889 .sp
15890 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\&.
15891 .if n \{\
15892 .sp
15893 .\}
15894 .RS 4
15895 .it 1 an-trap
15896 .nr an-no-space-flag 1
15897 .nr an-break-flag 1
15898 .br
15899 .ps +1
15900 \fBNote\fR
15901 .ps -1
15902 .br
15903 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\&.
15904 .sp .5v
15905 .RE
15906 See the chapter in the Samba3\-HOWTO on Network Browsing\&.
15907 .sp
15908 Default:
15909 \fI\fIwins server\fR\fR\fI = \fR\fI\fR\fI \fR
15910 .sp
15911 Example:
15912 \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
15913 .sp
15914 Example:
15915 \fI\fIwins server\fR\fR\fI = \fR\fI192\&.9\&.200\&.1 192\&.168\&.2\&.61\fR\fI \fR
15916 .RE
15917
15918 wins support (G)
15919 .PP
15920 .RS 4
15921 This boolean controls if the
15922 \fBnmbd\fR(8)
15923 process in Samba will act as a WINS server\&. You should not set this to
15924 \fByes\fR
15925 unless you have a multi\-subnetted network and you wish a particular
15926 nmbd
15927 to be your WINS server\&. Note that you should
15928 \fINEVER\fR
15929 set this to
15930 \fByes\fR
15931 on more than one machine in your network\&.
15932 .sp
15933 Default:
15934 \fI\fIwins support\fR\fR\fI = \fR\fIno\fR\fI \fR
15935 .RE
15936
15937 workgroup (G)
15938 .PP
15939 .RS 4
15940 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
15941 \m[blue]\fBsecurity = domain\fR\m[]
15942 setting\&.
15943 .sp
15944 Default:
15945 \fI\fIworkgroup\fR\fR\fI = \fR\fIWORKGROUP\fR\fI \fR
15946 .sp
15947 Example:
15948 \fI\fIworkgroup\fR\fR\fI = \fR\fIMYGROUP\fR\fI \fR
15949 .RE
15950
15951 wreplsrv:periodic_interval (G)
15952 .PP
15953 .RS 4
15954 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\&.
15955 .sp
15956 Default:
15957 \fI\fIwreplsrv:periodic_interval\fR\fR\fI = \fR\fI15\fR\fI \fR
15958 .RE
15959
15960 wreplsrv:propagate name releases (G)
15961 .PP
15962 .RS 4
15963 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\&.
15964 .sp
15965 Default:
15966 \fI\fIwreplsrv:propagate name releases\fR\fR\fI = \fR\fIno\fR\fI \fR
15967 .RE
15968
15969 wreplsrv:scavenging_interval (G)
15970 .PP
15971 .RS 4
15972 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\&.
15973 .sp
15974 \fINo default\fR
15975 .RE
15976
15977 wreplsrv:tombstone_extra_timeout (G)
15978 .PP
15979 .RS 4
15980 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\&.
15981 .sp
15982 Default:
15983 \fI\fIwreplsrv:tombstone_extra_timeout\fR\fR\fI = \fR\fI259200\fR\fI \fR
15984 .RE
15985
15986 wreplsrv:tombstone_interval (G)
15987 .PP
15988 .RS 4
15989 This is the interval in s till released records of the WINS server become tombstone\&. Defaults to 6 days\&.
15990 .sp
15991 Default:
15992 \fI\fIwreplsrv:tombstone_interval\fR\fR\fI = \fR\fI518400\fR\fI \fR
15993 .RE
15994
15995 wreplsrv:tombstone_timeout (G)
15996 .PP
15997 .RS 4
15998 This is the interval in s till tombstone records are deleted from the WINS database\&. Defaults to 1 day\&.
15999 .sp
16000 Default:
16001 \fI\fIwreplsrv:tombstone_timeout\fR\fR\fI = \fR\fI86400\fR\fI \fR
16002 .RE
16003
16004 wreplsrv:verify_interval (G)
16005 .PP
16006 .RS 4
16007 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\&.
16008 .sp
16009 Default:
16010 \fI\fIwreplsrv:verify_interval\fR\fR\fI = \fR\fI2073600\fR\fI \fR
16011 .RE
16012
16013 writable
16014 .PP
16015 .RS 4
16016 This parameter is a synonym for
16017 writeable\&.
16018 .RE
16019
16020 write ok
16021 .PP
16022 .RS 4
16023 This parameter is a synonym for
16024 writeable\&.
16025 .RE
16026
16027 writeable (S)
16028 .PP
16029 .RS 4
16030 Inverted synonym for
16031 \m[blue]\fBread only\fR\m[]\&.
16032 .sp
16033 Default:
16034 \fI\fIwriteable\fR\fR\fI = \fR\fIno\fR\fI \fR
16035 .RE
16036
16037 write list (S)
16038 .PP
16039 .RS 4
16040 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
16041 \m[blue]\fBread only\fR\m[]
16042 option is set to\&. The list can include group names using the @group syntax\&.
16043 .sp
16044 Note that if a user is in both the read list and the write list then they will be given write access\&.
16045 .sp
16046 Default:
16047 \fI\fIwrite list\fR\fR\fI = \fR\fI\fR\fI \fR
16048 .sp
16049 Example:
16050 \fI\fIwrite list\fR\fR\fI = \fR\fIadmin, root, @staff\fR\fI \fR
16051 .RE
16052
16053 write raw (G)
16054 .PP
16055 .RS 4
16056 This is ignored if
16057 \m[blue]\fBasync smb echo handler\fR\m[]
16058 is set, because this feature is incompatible with raw write SMB requests
16059 .sp
16060 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\&.
16061 .sp
16062 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\&.
16063 .sp
16064 In general this parameter should be viewed as a system tuning tool and left severely alone\&.
16065 .sp
16066 Default:
16067 \fI\fIwrite raw\fR\fR\fI = \fR\fIyes\fR\fI \fR
16068 .RE
16069
16070 wsp property file (G)
16071 .PP
16072 .RS 4
16073 \m[blue]\fBwsp property file\fR\m[]
16074 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\&.
16075 .PP
16076 Property Name
16077 .RS 4
16078 A property name e\&.g\&. System\&.ItemUrl\&.
16079 .RE
16080 .PP
16081 GUID
16082 .RS 4
16083 A guid that identifies the propertyset the property belongs to\&.
16084 .RE
16085 .PP
16086 prop ID
16087 .RS 4
16088 A number that together with the GUID uniquely identifies the property\&.
16089 .RE
16090 .PP
16091 inInverted Index
16092 .RS 4
16093 Set to TRUE is the property is indexed\&.
16094 .RE
16095 .PP
16096 isColumn
16097 .RS 4
16098 Set to TRUE if the property is one that can be returned in rows returned from WSP query\&.
16099 .RE
16100 .PP
16101 type
16102 .RS 4
16103 One of
16104 \fIBoolean\fR,\fIBuffer\fR,\fIByte\fR,\fIDateTime\fR,\fIDouble\fR,\fIInt32\fR,\fIString\fR,\fIUInt16\fR,\fIUInt32\fR,\fIUInt64\fR
16105 .RE
16106 .PP
16107 MaxSize
16108 .RS 4
16109 maximum size when stored\&.
16110 .RE
16111 .PP
16112 Vector Property
16113 .RS 4
16114 TRUE if this is a multivalue property\&.
16115 .RE
16116 .PP
16117 Description
16118 .RS 4
16119 Description of what the property is used for\&.
16120 .RE
16121 .sp
16122 Default:
16123 \fI\fIwsp property file\fR\fR\fI = \fR\fI\fR\fI \fR
16124 .RE
16125
16126 wtmp directory (G)
16127 .PP
16128 .RS 4
16129 This parameter is only available if Samba has been configured and compiled with the option
16130 \-\-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\&.
16131 .sp
16132 By default this is not set, meaning the system will use whatever utmp file the native system is set to use (usually
16133 /var/run/wtmp
16134 on Linux)\&.
16135 .sp
16136 Default:
16137 \fI\fIwtmp directory\fR\fR\fI = \fR\fI\fR\fI \fR
16138 .sp
16139 Example:
16140 \fI\fIwtmp directory\fR\fR\fI = \fR\fI/var/log/wtmp\fR\fI \fR
16141 .RE
16142 .SH "WARNINGS"
16143 .PP
16144 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\&.
16145 .PP
16146 On a similar note, many clients \- especially DOS clients \- limit service names to eight characters\&.
16147 \fBsmbd\fR(8)
16148 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\&.
16149 .PP
16150 Use of the
16151 [homes]
16152 and
16153 [printers]
16154 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\&.
16155 .SH "VERSION"
16156 .PP
16157 This man page is part of version 4\&.24\&.3\-Debian\-4\&.24\&.3+dfsg\-1 of the Samba suite\&.
16158 .SH "SEE ALSO"
16159 .PP
16160 \fBsamba\fR(7),
16161 \fBsmbpasswd\fR(8),
16162 \fBsmbd\fR(8),
16163 \fBnmbd\fR(8),
16164 \fBwinbindd\fR(8),
16165 \fBsamba\fR(8),
16166 \fBsamba-tool\fR(8),
16167 \fBsmbclient\fR(1),
16168 \fBnmblookup\fR(1),
16169 \fBtestparm\fR(1)\&.
16170 .SH "AUTHOR"
16171 .PP
16172 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\&.