Debian Codegraph @

upstream/mageia-cauldron/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/28/2026
6 .\" Manual: File Formats and Conventions
7 .\" Source: Samba 4.23.8
8 .\" Language: English
9 .\"
10 .TH "SMB\&.CONF" "5" "05/28/2026" "Samba 4\&.23\&.8" "File Formats and Conventions"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
30 .SH "NAME"
31 smb.conf \- The configuration file for the Samba suite
32 .SH "SYNOPSIS"
33 .PP
34 The
35 smb\&.conf
36 file is a configuration file for the Samba suite\&.
37 smb\&.conf
38 contains runtime configuration information for the Samba programs\&. The complete description of the file format and possible parameters held within are here for reference purposes\&.
39 .SH "HOW CONFIGURATION CHANGES ARE APPLIED"
40 .PP
41 The Samba suite includes a number of different programs\&. Some of them operate in a client mode, others are server daemons that provide various services to its clients\&. The
42 smb\&.conf
43 file is processed in the following way:
44 .RS
45 .sp
46 .RS 4
47 .ie n \{\
48 \h'-04'\(bu\h'+03'\c
49 .\}
50 .el \{\
51 .sp -1
52 .IP \(bu 2.3
53 .\}
54 The Samba suite\*(Aqs client applications read their configuration only once\&. Any changes made after start aren\*(Aqt reflected in the context of already running client code\&.
55 .RE
56 .sp
57 .RS 4
58 .ie n \{\
59 \h'-04'\(bu\h'+03'\c
60 .\}
61 .el \{\
62 .sp -1
63 .IP \(bu 2.3
64 .\}
65 The Samba suite\*(Aqs server daemons reload their configuration when requested\&. However, already active connections do not change their configuration\&. More detailed information can be found in
66 \fBsmbd\fR(8)
67 and
68 \fBwinbindd\fR(8)
69 manual pages\&.
70 .RE
71 .sp
72 .RE
73 .PP
74 To request Samba server daemons to refresh their configuration, please use
75 \fBsmbcontrol\fR(1)
76 utility\&.
77 .SH "FILE FORMAT"
78 .PP
79 The file consists of sections and parameters\&. A section begins with the name of the section in square brackets and continues until the next section begins\&. Sections contain parameters of the form:
80 .sp
81 .if n \{\
82 .RS 4
83 .\}
84 .nf
85 \fIname\fR = \fIvalue \fR
86 .fi
87 .if n \{\
88 .RE
89 .\}
90 .PP
91 The file is line\-based \- that is, each newline\-terminated line represents either a comment, a section name or a parameter\&.
92 .PP
93 Section and parameter names are not case sensitive\&.
94 .PP
95 Only the first equals sign in a parameter is significant\&. Whitespace before or after the first equals sign is discarded\&. Leading, trailing and internal whitespace in section and parameter names is irrelevant\&. Leading and trailing whitespace in a parameter value is discarded\&. Internal whitespace within a parameter value is retained verbatim\&.
96 .PP
97 Any line beginning with a semicolon (\(lq;\(rq) or a hash (\(lq#\(rq) character is ignored, as are lines containing only whitespace\&.
98 .PP
99 Any line ending in a
100 \(lq\e\(rq
101 is continued on the next line in the customary UNIX fashion\&.
102 .PP
103 The values following the equals sign in parameters are all either a string (no quotes needed) or a boolean, which may be given as yes/no, 1/0 or true/false\&. Case is not significant in boolean values, but is preserved in string values\&. Some items such as create masks are numeric\&.
104 .SH "SECTION DESCRIPTIONS"
105 .PP
106 Each section in the configuration file (except for the [global] section) describes a shared resource (known as a
107 \(lqshare\(rq)\&. The section name is the name of the shared resource and the parameters within the section define the shares attributes\&.
108 .PP
109 There are three special sections, [global], [homes] and [printers], which are described under
110 \fIspecial sections\fR\&. The following notes apply to ordinary section descriptions\&.
111 .PP
112 A share consists of a directory to which access is being given plus a description of the access rights which are granted to the user of the service\&. Some housekeeping options are also specifiable\&.
113 .PP
114 Sections are either file share services (used by the client as an extension of their native file systems) or printable services (used by the client to access print services on the host running the server)\&.
115 .PP
116 Sections may be designated
117 \fIguest\fR
118 services, in which case no password is required to access them\&. A specified UNIX
119 \fIguest account\fR
120 is used to define access privileges in this case\&.
121 .PP
122 Sections other than guest services will require a password to access them\&. The client provides the username\&. As older clients only provide passwords and not usernames, you may specify a list of usernames to check against the password using the
123 user =
124 option in the share definition\&. For modern clients such as Windows 95/98/ME/NT/2000, this should not be necessary\&.
125 .PP
126 The access rights granted by the server are masked by the access rights granted to the specified or guest UNIX user by the host system\&. The server does not grant more access than the host system grants\&.
127 .PP
128 The following sample section defines a file space share\&. The user has write access to the path
129 /home/bar\&. The share is accessed via the share name
130 foo:
131 .sp
132 .if n \{\
133 .RS 4
134 .\}
135 .nf
136 \fI[foo]\fR
137 \m[blue]\fBpath = /home/bar\fR\m[]
138 \m[blue]\fBread only = no\fR\m[]
139 .fi
140 .if n \{\
141 .RE
142 .\}
143 .PP
144 The following sample section defines a printable share\&. The share is read\-only, but printable\&. That is, the only write access permitted is via calls to open, write to and close a spool file\&. The
145 \fIguest ok\fR
146 parameter means access will be permitted as the default guest user (specified elsewhere):
147 .sp
148 .if n \{\
149 .RS 4
150 .\}
151 .nf
152 \fI[aprinter]\fR
153 \m[blue]\fBpath = /var/tmp\fR\m[]
154 \m[blue]\fBread only = yes\fR\m[]
155 \m[blue]\fBprintable = yes\fR\m[]
156 \m[blue]\fBguest ok = yes\fR\m[]
157 .fi
158 .if n \{\
159 .RE
160 .\}
161 .sp
162 .SH "SPECIAL SECTIONS"
163 .SS "The [global] section"
164 .PP
165 Parameters in this section apply to the server as a whole, or are defaults for sections that do not specifically define certain items\&. See the notes under PARAMETERS for more information\&.
166 .SS "The [homes] section"
167 .PP
168 If a section called [homes] is included in the configuration file, services connecting clients to their home directories can be created on the fly by the server\&.
169 .PP
170 When the connection request is made, the existing sections are scanned\&. If a match is found, it is used\&. If no match is found, the requested section name is treated as a username and looked up in the local password file\&. If the name exists and the correct password has been given, a share is created by cloning the [homes] section\&.
171 .PP
172 Some modifications are then made to the newly created share:
173 .RS
174 .sp
175 .RS 4
176 .ie n \{\
177 \h'-04'\(bu\h'+03'\c
178 .\}
179 .el \{\
180 .sp -1
181 .IP \(bu 2.3
182 .\}
183 The share name is changed from homes to the located username\&.
184 .RE
185 .sp
186 .RS 4
187 .ie n \{\
188 \h'-04'\(bu\h'+03'\c
189 .\}
190 .el \{\
191 .sp -1
192 .IP \(bu 2.3
193 .\}
194 If no path was given, the path is set to the user\*(Aqs home directory\&.
195 .RE
196 .sp
197 .RE
198 .PP
199 If you decide to use a
200 \fIpath =\fR
201 line in your [homes] section, it may be useful to use the %S macro\&. For example:
202 .sp
203 .if n \{\
204 .RS 4
205 .\}
206 .nf
207 \fBpath = /data/pchome/%S\fR
208 .fi
209 .if n \{\
210 .RE
211 .\}
212 .sp
213 is useful if you have different home directories for your PCs than for UNIX access\&.
214 .PP
215 This is a fast and simple way to give a large number of clients access to their home directories with a minimum of fuss\&.
216 .PP
217 A similar process occurs if the requested section name is
218 \(lqhomes\(rq, except that the share name is not changed to that of the requesting user\&. This method of using the [homes] section works well if different users share a client PC\&.
219 .PP
220 The [homes] section can specify all the parameters a normal service section can specify, though some make more sense than others\&. The following is a typical and suitable [homes] section:
221 .sp
222 .if n \{\
223 .RS 4
224 .\}
225 .nf
226 \fI[homes]\fR
227 \m[blue]\fBread only = no\fR\m[]
228 .fi
229 .if n \{\
230 .RE
231 .\}
232 .PP
233 An important point is that if guest access is specified in the [homes] section, all home directories will be visible to all clients
234 \fIwithout a password\fR\&. In the very unlikely event that this is actually desirable, it is wise to also specify
235 \fIread only access\fR\&.
236 .PP
237 The
238 \fIbrowseable\fR
239 flag for auto home directories will be inherited from the global browseable flag, not the [homes] browseable flag\&. This is useful as it means setting
240 \fIbrowseable = no\fR
241 in the [homes] section will hide the [homes] share but make any auto home directories visible\&.
242 .SS "The [printers] section"
243 .PP
244 This section works like [homes], but for printers\&.
245 .PP
246 If a [printers] section occurs in the configuration file, users are able to connect to any printer specified in the local host\*(Aqs printcap file\&.
247 .PP
248 When a connection request is made, the existing sections are scanned\&. If a match is found, it is used\&. If no match is found, but a [homes] section exists, it is used as described above\&. Otherwise, the requested section name is treated as a printer name and the appropriate printcap file is scanned to see if the requested section name is a valid printer share name\&. If a match is found, a new printer share is created by cloning the [printers] section\&.
249 .PP
250 A few modifications are then made to the newly created share:
251 .RS
252 .sp
253 .RS 4
254 .ie n \{\
255 \h'-04'\(bu\h'+03'\c
256 .\}
257 .el \{\
258 .sp -1
259 .IP \(bu 2.3
260 .\}
261 The share name is set to the located printer name
262 .RE
263 .sp
264 .RS 4
265 .ie n \{\
266 \h'-04'\(bu\h'+03'\c
267 .\}
268 .el \{\
269 .sp -1
270 .IP \(bu 2.3
271 .\}
272 If no printer name was given, the printer name is set to the located printer name
273 .RE
274 .sp
275 .RS 4
276 .ie n \{\
277 \h'-04'\(bu\h'+03'\c
278 .\}
279 .el \{\
280 .sp -1
281 .IP \(bu 2.3
282 .\}
283 If the share does not permit guest access and no username was given, the username is set to the located printer name\&.
284 .RE
285 .sp
286 .RE
287 .PP
288 The [printers] service MUST be printable \- if you specify otherwise, the server will refuse to load the configuration file\&.
289 .PP
290 Typically the path specified is that of a world\-writeable spool directory with the sticky bit set on it\&. A typical [printers] entry looks like this:
291 .sp
292 .if n \{\
293 .RS 4
294 .\}
295 .nf
296 \fI[printers]\fR
297 \m[blue]\fBpath = /var/tmp\fR\m[]
298 \m[blue]\fBguest ok = yes\fR\m[]
299 \m[blue]\fBprintable = yes\fR\m[]
300 .fi
301 .if n \{\
302 .RE
303 .\}
304 .PP
305 All aliases given for a printer in the printcap file are legitimate printer names as far as the server is concerned\&. If your printing subsystem doesn\*(Aqt work like that, you will have to set up a pseudo\-printcap\&. This is a file consisting of one or more lines like this:
306 .sp
307 .if n \{\
308 .RS 4
309 .\}
310 .nf
311 alias|alias|alias|alias\&.\&.\&.
312 .fi
313 .if n \{\
314 .RE
315 .\}
316 .PP
317 Each alias should be an acceptable printer name for your printing subsystem\&. In the [global] section, specify the new file as your printcap\&. The server will only recognize names found in your pseudo\-printcap, which of course can contain whatever aliases you like\&. The same technique could be used simply to limit access to a subset of your local printers\&.
318 .PP
319 An alias, by the way, is defined as any component of the first entry of a printcap record\&. Records are separated by newlines, components (if there are more than one) are separated by vertical bar symbols (|)\&.
320 .if n \{\
321 .sp
322 .\}
323 .RS 4
324 .it 1 an-trap
325 .nr an-no-space-flag 1
326 .nr an-break-flag 1
327 .br
328 .ps +1
329 \fBNote\fR
330 .ps -1
331 .br
332 .PP
333 On SYSV systems which use lpstat to determine what printers are defined on the system you may be able to use
334 printcap name = lpstat
335 to automatically obtain a list of printers\&. See the
336 printcap name
337 option for more details\&.
338 .sp .5v
339 .RE
340 .SH "USERSHARES"
341 .PP
342 Starting with Samba version 3\&.0\&.23 the capability for non\-root users to add, modify, and delete their own share definitions has been added\&. This capability is called
343 \fIusershares\fR
344 and is controlled by a set of parameters in the [global] section of the smb\&.conf\&. The relevant parameters are :
345 .PP
346 usershare allow guests
347 .RS 4
348 Controls if usershares can permit guest access\&.
349 .RE
350 .PP
351 usershare max shares
352 .RS 4
353 Maximum number of user defined shares allowed\&.
354 .RE
355 .PP
356 usershare owner only
357 .RS 4
358 If set only directories owned by the sharing user can be shared\&.
359 .RE
360 .PP
361 usershare path
362 .RS 4
363 Points to the directory containing the user defined share definitions\&. The filesystem permissions on this directory control who can create user defined shares\&.
364 .RE
365 .PP
366 usershare prefix allow list
367 .RS 4
368 Comma\-separated list of absolute pathnames restricting what directories can be shared\&. Only directories below the pathnames in this list are permitted\&.
369 .RE
370 .PP
371 usershare prefix deny list
372 .RS 4
373 Comma\-separated list of absolute pathnames restricting what directories can be shared\&. Directories below the pathnames in this list are prohibited\&.
374 .RE
375 .PP
376 usershare template share
377 .RS 4
378 Names a pre\-existing share used as a template for creating new usershares\&. All other share parameters not specified in the user defined share definition are copied from this named share\&.
379 .RE
380 .PP
381 To allow members of the UNIX group
382 foo
383 to create user defined shares, create the directory to contain the share definitions as follows:
384 .PP
385 Become root:
386 .sp
387 .if n \{\
388 .RS 4
389 .\}
390 .nf
391 mkdir /usr/local/samba/lib/usershares
392 chgrp foo /usr/local/samba/lib/usershares
393 chmod 1770 /usr/local/samba/lib/usershares
394 .fi
395 .if n \{\
396 .RE
397 .\}
398 .PP
399 Then add the parameters
400 .sp
401 .if n \{\
402 .RS 4
403 .\}
404 .nf
405 \m[blue]\fBusershare path = /usr/local/samba/lib/usershares\fR\m[]
406 \m[blue]\fBusershare max shares = 10\fR\m[] # (or the desired number of shares)
407 .fi
408 .if n \{\
409 .RE
410 .\}
411 .sp
412 to the global section of your
413 smb\&.conf\&. Members of the group foo may then manipulate the user defined shares using the following commands\&.
414 .PP
415 net usershare add sharename path [comment] [acl] [guest_ok=[y|n]]
416 .RS 4
417 To create or modify (overwrite) a user defined share\&.
418 .RE
419 .PP
420 net usershare delete sharename
421 .RS 4
422 To delete a user defined share\&.
423 .RE
424 .PP
425 net usershare list wildcard\-sharename
426 .RS 4
427 To list user defined shares\&.
428 .RE
429 .PP
430 net usershare info wildcard\-sharename
431 .RS 4
432 To print information about user defined shares\&.
433 .RE
434 .SH "PARAMETERS"
435 .PP
436 Parameters define the specific attributes of sections\&.
437 .PP
438 Some parameters are specific to the [global] section (e\&.g\&.,
439 \fIsecurity\fR)\&. Some parameters are usable in all sections (e\&.g\&.,
440 \fIcreate mask\fR)\&. All others are permissible only in normal sections\&. For the purposes of the following descriptions the [homes] and [printers] sections will be considered normal\&. The letter
441 \fIG\fR
442 in parentheses indicates that a parameter is specific to the [global] section\&. The letter
443 \fIS\fR
444 indicates that a parameter can be specified in a service specific section\&. All
445 \fIS\fR
446 parameters can also be specified in the [global] section \- in which case they will define the default behavior for all services\&.
447 .PP
448 Parameters are arranged here in alphabetical order \- this may not create best bedfellows, but at least you can find them! Where there are synonyms, the preferred synonym is described, others refer to the preferred synonym\&.
449 .SH "VARIABLE SUBSTITUTIONS"
450 .PP
451 Many of the strings that are settable in the config file can take substitutions\&. For example the option
452 \(lqpath = /tmp/%u\(rq
453 is interpreted as
454 \(lqpath = /tmp/john\(rq
455 if the user connected with the username john\&.
456 .PP
457 These substitutions are mostly noted in the descriptions below, but there are some general substitutions which apply whenever they might be relevant\&. These are:
458 .PP
459 %U
460 .RS 4
461 session username (the username that the client wanted, not necessarily the same as the one they got)\&.
462 .RE
463 .PP
464 %G
465 .RS 4
466 primary group name of %U\&.
467 .RE
468 .PP
469 %h
470 .RS 4
471 the Internet hostname that Samba is running on\&.
472 .RE
473 .PP
474 %m
475 .RS 4
476 the NetBIOS name of the client machine (very useful)\&.
477 .sp
478 This parameter is not available when Samba listens on port 445, as clients no longer send this information\&. If you use this macro in an include statement on a domain that has a Samba domain controller be sure to set in the [global] section
479 \fIserver smb transports = 139\fR\&. This will cause Samba to not listen on port 445 and will permit include functionality to function as it did with Samba 2\&.x\&.
480 .RE
481 .PP
482 %L
483 .RS 4
484 the NetBIOS name of the server\&. This allows you to change your config based on what the client calls you\&. Your server can have a
485 \(lqdual personality\(rq\&.
486 .RE
487 .PP
488 %M
489 .RS 4
490 the Internet name of the client machine\&.
491 .RE
492 .PP
493 %R
494 .RS 4
495 the selected protocol level after protocol negotiation\&. It can be one of CORE, COREPLUS, LANMAN1, LANMAN2, NT1, SMB2_02, SMB2_10, SMB3_00, SMB3_02, SMB3_11 or SMB2_FF\&.
496 .RE
497 .PP
498 %d
499 .RS 4
500 the process id of the current server process\&.
501 .RE
502 .PP
503 %a
504 .RS 4
505 The architecture of the remote machine\&. It currently recognizes Samba (\fBSamba\fR), the Linux CIFS file system (\fBCIFSFS\fR), OS/2, (\fBOS2\fR), Mac OS X (\fBOSX\fR), Windows for Workgroups (\fBWfWg\fR), Windows 9x/ME (\fBWin95\fR), Windows NT (\fBWinNT\fR), Windows 2000 (\fBWin2K\fR), Windows XP (\fBWinXP\fR), Windows XP 64\-bit(\fBWinXP64\fR), Windows 2003 including 2003R2 (\fBWin2K3\fR), and Windows Vista (\fBVista\fR)\&. Anything else will be known as
506 \fBUNKNOWN\fR\&.
507 .RE
508 .PP
509 %I
510 .RS 4
511 the IP address of the client machine\&.
512 .sp
513 Before 4\&.0\&.0 it could contain IPv4 mapped IPv6 addresses, now it only contains IPv4 or IPv6 addresses\&.
514 .RE
515 .PP
516 %J
517 .RS 4
518 the IP address of the client machine, colons/dots replaced by underscores\&.
519 .RE
520 .PP
521 %i
522 .RS 4
523 the local IP address to which a client connected\&.
524 .sp
525 Before 4\&.0\&.0 it could contain IPv4 mapped IPv6 addresses, now it only contains IPv4 or IPv6 addresses\&.
526 .RE
527 .PP
528 %j
529 .RS 4
530 the local IP address to which a client connected, colons/dots replaced by underscores\&.
531 .RE
532 .PP
533 %T
534 .RS 4
535 the current date and time\&.
536 .RE
537 .PP
538 %t
539 .RS 4
540 the current date and time in a minimal format without colons (YYYYYmmdd_HHMMSS)\&.
541 .RE
542 .PP
543 %D
544 .RS 4
545 name of the domain or workgroup of the current user\&.
546 .RE
547 .PP
548 %w
549 .RS 4
550 the winbind separator\&.
551 .RE
552 .PP
553 %$(\fIenvvar\fR)
554 .RS 4
555 the value of the environment variable
556 \fIenvar\fR\&.
557 .RE
558 .PP
559 The following substitutes apply only to some configuration options (only those that are used when a connection has been established):
560 .PP
561 %S
562 .RS 4
563 the name of the current service, if any\&.
564 .RE
565 .PP
566 %P
567 .RS 4
568 the root directory of the current service, if any\&.
569 .RE
570 .PP
571 %u
572 .RS 4
573 username of the current service, if any\&.
574 .RE
575 .PP
576 %g
577 .RS 4
578 primary group name of %u\&.
579 .RE
580 .PP
581 %H
582 .RS 4
583 the home directory of the user given by %u\&.
584 .RE
585 .PP
586 %N
587 .RS 4
588 This value is the same as %L\&.
589 .RE
590 .PP
591 There are some quite creative things that can be done with these substitutions and other
592 smb\&.conf
593 options\&.
594 .SH "NAME MANGLING"
595 .PP
596 Samba supports
597 name mangling
598 so that DOS and Windows clients can use files that don\*(Aqt conform to the 8\&.3 format\&. It can also be set to adjust the case of 8\&.3 format filenames\&.
599 .PP
600 There are several options that control the way mangling is performed, and they are grouped here rather than listed separately\&. For the defaults look at the output of the testparm program\&.
601 .PP
602 These options can be set separately for each service\&.
603 .PP
604 The options are:
605 .PP
606 case sensitive = yes/no/auto
607 .RS 4
608 controls whether filenames are case sensitive\&. If they aren\*(Aqt, Samba must do a filename search and match on passed names\&. The default setting of auto allows clients that support case sensitive filenames (Linux CIFSVFS and smbclient 3\&.0\&.5 and above currently) to tell the Samba server on a per\-packet basis that they wish to access the file system in a case\-sensitive manner (to support UNIX case sensitive semantics)\&. No Windows or DOS system supports case\-sensitive filename so setting this option to auto is the same as setting it to no for them\&. Default
609 \fIauto\fR\&.
610 .RE
611 .PP
612 default case = upper/lower
613 .RS 4
614 controls what the default case is for new filenames (ie\&. files that don\*(Aqt currently exist in the filesystem)\&. Default
615 \fIlower\fR\&. IMPORTANT NOTE: As part of the optimizations for directories containing large numbers of files, the following special case applies\&. If the options
616 \m[blue]\fBcase sensitive = yes\fR\m[],
617 \m[blue]\fBpreserve case = No\fR\m[], and
618 \m[blue]\fBshort preserve case = No\fR\m[]
619 are set, then the case of
620 \fIall\fR
621 incoming client filenames, not just new filenames, will be modified\&. See additional notes below\&.
622 .RE
623 .PP
624 preserve case = yes/no
625 .RS 4
626 controls whether new files (ie\&. files that don\*(Aqt currently exist in the filesystem) are created with the case that the client passes, or if they are forced to be the
627 default
628 case\&. Default
629 \fIyes\fR\&.
630 .RE
631 .PP
632 short preserve case = yes/no
633 .RS 4
634 controls if new files (ie\&. files that don\*(Aqt currently exist in the filesystem) which conform to 8\&.3 syntax, that is all in upper case and of suitable length, are created upper case, or if they are forced to be the
635 default
636 case\&. This option can be used with
637 preserve case = yes
638 to permit long filenames to retain their case, while short names are lowercased\&. Default
639 \fIyes\fR\&.
640 .RE
641 .PP
642 By default, Samba 3\&.0 has the same semantics as a Windows NT server, in that it is case insensitive but case preserving\&. As a special case for directories with large numbers of files, if the case options are set as follows, "case sensitive = yes", "case preserve = no", "short preserve case = no" then the "default case" option will be applied and will modify all filenames sent from the client when accessing this share\&.
643 .SH "REGISTRY\-BASED CONFIGURATION"
644 .PP
645 Starting with Samba version 3\&.2\&.0, the capability to store Samba configuration in the registry is available\&. The configuration is stored in the registry key
646 \fIHKLM\eSoftware\eSamba\esmbconf\fR\&. There are two levels of registry configuration:
647 .RS
648 .sp
649 .RS 4
650 .ie n \{\
651 \h'-04' 1.\h'+01'\c
652 .\}
653 .el \{\
654 .sp -1
655 .IP " 1." 4.2
656 .\}
657 Share definitions stored in registry are used\&. This is triggered by setting the global parameter
658 \fIregistry shares\fR
659 to
660 \(lqyes\(rq
661 in
662 \fIsmb\&.conf\fR\&.
663 .sp
664 The registry shares are loaded not at startup but on demand at runtime by
665 \fIsmbd\fR\&. Shares defined in
666 \fIsmb\&.conf\fR
667 take priority over shares of the same name defined in registry\&.
668 .RE
669 .sp
670 .RS 4
671 .ie n \{\
672 \h'-04' 2.\h'+01'\c
673 .\}
674 .el \{\
675 .sp -1
676 .IP " 2." 4.2
677 .\}
678 Global
679 \fIsmb\&.conf\fR
680 options stored in registry are used\&. This can be activated in two different ways:
681 .sp
682 Firstly, a registry only configuration is triggered by setting
683 \m[blue]\fBconfig backend = registry\fR\m[]
684 in the [global] section of
685 \fIsmb\&.conf\fR\&. This resets everything that has been read from config files to this point and reads the content of the global configuration section from the registry\&. This is the recommended method of using registry based configuration\&.
686 .sp
687 Secondly, a mixed configuration can be activated by a special new meaning of the parameter
688 \m[blue]\fBinclude = registry\fR\m[]
689 in the [global] section of
690 \fIsmb\&.conf\fR\&. This reads the global options from registry with the same priorities as for an include of a text file\&. This may be especially useful in cases where an initial configuration is needed to access the registry\&.
691 .sp
692 Activation of global registry options automatically activates registry shares\&. So in the registry only case, shares are loaded on demand only\&.
693 .RE
694 .sp
695 .RE
696 .PP
697 Note: To make registry\-based configurations foolproof at least to a certain extent, the use of
698 \fIlock directory\fR
699 and
700 \fIconfig backend\fR
701 inside the registry configuration has been disabled: Especially by changing the
702 \fIlock directory\fR
703 inside the registry configuration, one would create a broken setup where the daemons do not see the configuration they loaded once it is active\&.
704 .PP
705 The registry configuration can be accessed with tools like
706 \fIregedit\fR
707 or
708 \fInet (rpc) registry\fR
709 in the key
710 \fIHKLM\eSoftware\eSamba\esmbconf\fR\&. More conveniently, the
711 \fIconf\fR
712 subcommand of the
713 \fBnet\fR(8)
714 utility offers a dedicated interface to read and write the registry based configuration locally, i\&.e\&. directly accessing the database file, circumventing the server\&.
715 .SH "IDENTITY MAPPING CONSIDERATIONS"
716 .PP
717 In the SMB protocol, users, groups, and machines are represented by their security identifiers (SIDs)\&. On POSIX system Samba processes need to run under corresponding POSIX user identities and with supplemental POSIX groups to allow access to the files owned by those users and groups\&. The process of mapping SIDs to POSIX users and groups is called
718 \fIIDENTITY MAPPING\fR
719 or, in short,
720 \fIID MAPPING\fR\&.
721 .PP
722 Samba supports multiple ways to map SIDs to POSIX users and groups\&. The configuration is driven by the
723 \m[blue]\fBidmap config DOMAIN : OPTION\fR\m[]
724 option which allows one to specify identity mapping (idmap) options for each domain separately\&.
725 .PP
726 Identity mapping modules implement different strategies for mapping of SIDs to POSIX user and group identities\&. They are applicable to different use cases and scenarios\&. It is advised to read the documentation of the individual identity mapping modules before choosing a specific scenario to use\&. Each identity management module is documented in a separate manual page\&. The standard idmap backends are tdb (\fBidmap_tdb\fR(8)), tdb2 (\fBidmap_tdb2\fR(8)), ldap (\fBidmap_ldap\fR(8)), rid (\fBidmap_rid\fR(8)), hash (\fBidmap_hash\fR(8)), autorid (\fBidmap_autorid\fR(8)), ad (\fBidmap_ad\fR(8)), nss (\fBidmap_nss\fR(8)), and rfc2307 (\fBidmap_rfc2307\fR(8))\&.
727 .PP
728 Overall, ID mapping configuration should be decided carefully\&. Changes to the already deployed ID mapping configuration may create the risk of losing access to the data or disclosing the data to the wrong parties\&.
729 .PP
730 This example shows how to configure two domains with
731 \fBidmap_rid\fR(8), the principal domain and a trusted domain, leaving the default id mapping scheme at tdb\&.
732 .sp
733 .if n \{\
734 .RS 4
735 .\}
736 .nf
737 [global]
738 security = domain
739 workgroup = MAIN
740
741 idmap config * : backend = tdb
742 idmap config * : range = 1000000\-1999999
743
744 idmap config MAIN : backend = rid
745 idmap config MAIN : range = 5000000\-5999999
746
747 idmap config TRUSTED : backend = rid
748 idmap config TRUSTED : range = 6000000\-6999999
749 .fi
750 .if n \{\
751 .RE
752 .\}
753 .SH "EXPLANATION OF EACH PARAMETER"
754
755
756 abort shutdown script (G)
757 .PP
758 .RS 4
759 This a full path name to a script called by
760 \fBsmbd\fR(8)
761 that should stop a shutdown procedure issued by the
762 \m[blue]\fBshutdown script\fR\m[]\&.
763 .sp
764 If the connected user possesses the
765 \fBSeRemoteShutdownPrivilege\fR, right, this command will be run as root\&.
766 .sp
767 Default:
768 \fI\fIabort shutdown script\fR\fR\fI = \fR\fI""\fR\fI \fR
769 .sp
770 Example:
771 \fI\fIabort shutdown script\fR\fR\fI = \fR\fI/sbin/shutdown \-c\fR\fI \fR
772 .RE
773
774 access based share enum (S)
775 .PP
776 .RS 4
777 If this parameter is
778 \fByes\fR
779 for a service, then the share hosted by the service will only be visible to users who have read or write access to the share during share enumeration (for example net view \e\esambaserver)\&. The share ACLs which allow or deny the access to the share can be modified using for example the
780 sharesec
781 command or using the appropriate Windows tools\&. This has parallels to access based enumeration, the main difference being that only share permissions are evaluated, and security descriptors on files contained on the share are not used in computing enumeration access rights\&.
782 .sp
783 Default:
784 \fI\fIaccess based share enum\fR\fR\fI = \fR\fIno\fR\fI \fR
785 .RE
786
787 acl allow execute always (S)
788 .PP
789 .RS 4
790 This boolean parameter controls the behaviour of
791 \fBsmbd\fR(8)
792 when receiving a protocol request of "open for execution" from a Windows client\&. With Samba 3\&.6 and older, the execution right in the ACL was not checked, so a client could execute a file even if it did not have execute rights on the file\&. In Samba 4\&.0, this has been fixed, so that by default, i\&.e\&. when this parameter is set to "False", "open for execution" is now denied when execution permissions are not present\&.
793 .sp
794 If this parameter is set to "True", Samba does not check execute permissions on "open for execution", thus re\-establishing the behaviour of Samba 3\&.6\&. This can be useful to smoothen upgrades from older Samba versions to 4\&.0 and newer\&. This setting is not meant to be used as a permanent setting, but as a temporary relief: It is recommended to fix the permissions in the ACLs and reset this parameter to the default after a certain transition period\&.
795 .sp
796 Default:
797 \fI\fIacl allow execute always\fR\fR\fI = \fR\fIno\fR\fI \fR
798 .RE
799
800 acl check permissions (S)
801 .PP
802 .RS 4
803 Please note this parameter is now deprecated in Samba 3\&.6\&.2 and will be removed in a future version of Samba\&.
804 .sp
805 This boolean parameter controls what
806 \fBsmbd\fR(8)
807 does on receiving a protocol request of "open for delete" from a Windows client\&. If a Windows client doesn\*(Aqt have permissions to delete a file then they expect this to be denied at open time\&. POSIX systems normally only detect restrictions on delete by actually attempting to delete the file or directory\&. As Windows clients can (and do) "back out" a delete request by unsetting the "delete on close" bit Samba cannot delete the file immediately on "open for delete" request as we cannot restore such a deleted file\&. With this parameter set to true (the default) then smbd checks the file system permissions directly on "open for delete" and denies the request without actually deleting the file if the file system permissions would seem to deny it\&. This is not perfect, as it\*(Aqs possible a user could have deleted a file without Samba being able to check the permissions correctly, but it is close enough to Windows semantics for mostly correct behaviour\&. Samba will correctly check POSIX ACL semantics in this case\&.
808 .sp
809 If this parameter is set to "false" Samba doesn\*(Aqt check permissions on "open for delete" and allows the open\&. If the user doesn\*(Aqt have permission to delete the file this will only be discovered at close time, which is too late for the Windows user tools to display an error message to the user\&. The symptom of this is files that appear to have been deleted "magically" re\-appearing on a Windows explorer refresh\&. This is an extremely advanced protocol option which should not need to be changed\&. This parameter was introduced in its final form in 3\&.0\&.21, an earlier version with slightly different semantics was introduced in 3\&.0\&.20\&. That older version is not documented here\&.
810 .sp
811 Default:
812 \fI\fIacl check permissions\fR\fR\fI = \fR\fIyes\fR\fI \fR
813 .RE
814
815 acl claims evaluation (G)
816 .PP
817 .RS 4
818 This option controls the way Samba handles evaluation of security descriptors in Samba, with regards to Active Directory Claims\&. AD Claims, introduced with Windows 2012, are essentially administrator\-defined key\-value pairs that can be set both in Active Directory (communicated via the Kerberos PAC) and in the security descriptor themselves\&.
819 .sp
820 Active Directory claims are new with Samba 4\&.20\&. Because the claims are evaluated against a very flexible expression language within the security descriptor, this option provides a mechanism to disable this logic if required by the administrator\&.
821 .sp
822 This default behaviour is that claims evaluation is enabled in the AD DC only\&. Additionally, claims evaluation on the AD DC is only enabled if the DC functional level is 2012 or later\&. See
823 \m[blue]\fBad dc functional level\fR\m[]\&.
824 .sp
825 Possible values are :
826 .RS
827 .sp
828 .RS 4
829 .ie n \{\
830 \h'-04'\(bu\h'+03'\c
831 .\}
832 .el \{\
833 .sp -1
834 .IP \(bu 2.3
835 .\}
836 \fBAD DC only\fR: Enabled for the Samba AD DC (for DC functional level 2012 or higher)\&.
837 .RE
838 .sp
839 .RS 4
840 .ie n \{\
841 \h'-04'\(bu\h'+03'\c
842 .\}
843 .el \{\
844 .sp -1
845 .IP \(bu 2.3
846 .\}
847 \fBnever\fR: Disabled in all cases\&. This option disables some but not all of the Authentication Policies and Authentication Policy Silos features of the Windows 2012R2 functional level in the AD DC\&.
848 .RE
849 .sp
850 .RE
851 Default:
852 \fI\fIacl claims evaluation\fR\fR\fI = \fR\fIAD DC only\fR\fI \fR
853 .RE
854
855 acl flag inherited canonicalization (S)
856 .PP
857 .RS 4
858 This option controls the way Samba handles client requests setting the Security Descriptor of files and directories and the effect the operation has on the Security Descriptor flag "DACL auto\-inherited" (DI)\&. Generally, this flag is set on a file (or directory) upon creation if the parent directory has DI set and also has inheritable ACEs\&.
859 .sp
860 On the other hand when a Security Descriptor is explicitly set on a file, the DI flag is cleared, unless the flag "DACL Inheritance Required" (DR) is also set in the new Security Descriptor (fwiw, DR is never stored on disk)\&.
861 .sp
862 This is the default behaviour when this option is enabled (the default)\&. When setting this option to
863 no, the resulting value of the DI flag on\-disk is directly taken from the DI value of the to\-be\-set Security Descriptor\&. This can be used so dump tools like rsync that copy data blobs from xattrs that represent ACLs created by the acl_xattr VFS module will result in copies of the ACL that are identical to the source\&. Without this option, the copied ACLs would all lose the DI flag if set on the source\&.
864 .sp
865 Default:
866 \fI\fIacl flag inherited canonicalization\fR\fR\fI = \fR\fIyes\fR\fI \fR
867 .RE
868
869 acl group control (S)
870 .PP
871 .RS 4
872 In a POSIX filesystem, only the owner of a file or directory and the superuser can modify the permissions and ACLs on a file\&. If this parameter is set, then Samba overrides this restriction, and also allows the
873 \fIprimary group owner\fR
874 of a file or directory to modify the permissions and ACLs on that file\&.
875 .sp
876 On a Windows server, groups may be the owner of a file or directory \- thus allowing anyone in that group to modify the permissions on it\&. This allows the delegation of security controls on a point in the filesystem to the group owner of a directory and anything below it also owned by that group\&. This means there are multiple people with permissions to modify ACLs on a file or directory, easing manageability\&.
877 .sp
878 This parameter allows Samba to also permit delegation of the control over a point in the exported directory hierarchy in much the same way as Windows\&. This allows all members of a UNIX group to control the permissions on a file or directory they have group ownership on\&.
879 .sp
880 This parameter is best used with the
881 \m[blue]\fBinherit owner\fR\m[]
882 option and also on a share containing directories with the UNIX
883 \fIsetgid bit\fR
884 set on them, which causes new files and directories created within it to inherit the group ownership from the containing directory\&.
885 .sp
886 This parameter was deprecated in Samba 3\&.0\&.23, but re\-activated in Samba 3\&.0\&.31 and above, as it now only controls permission changes if the user is in the owning primary group\&. It is now no longer equivalent to the
887 \fIdos filemode\fR
888 option\&.
889 .sp
890 Default:
891 \fI\fIacl group control\fR\fR\fI = \fR\fIno\fR\fI \fR
892 .RE
893
894 acl map full control (S)
895 .PP
896 .RS 4
897 This boolean parameter controls whether
898 \fBsmbd\fR(8)
899 maps a POSIX ACE entry of "rwx" (read/write/execute), the maximum allowed POSIX permission set, into a Windows ACL of "FULL CONTROL"\&. If this parameter is set to true any POSIX ACE entry of "rwx" will be returned in a Windows ACL as "FULL CONTROL", is this parameter is set to false any POSIX ACE entry of "rwx" will be returned as the specific Windows ACL bits representing read, write and execute\&.
900 .sp
901 Default:
902 \fI\fIacl map full control\fR\fR\fI = \fR\fIyes\fR\fI \fR
903 .RE
904
905 ad dc functional level (G)
906 .PP
907 .RS 4
908 The value of the parameter (a string) is the Active Directory functional level that this Domain Controller will claim to support\&.
909 .sp
910 Possible values are :
911 .RS
912 .sp
913 .RS 4
914 .ie n \{\
915 \h'-04'\(bu\h'+03'\c
916 .\}
917 .el \{\
918 .sp -1
919 .IP \(bu 2.3
920 .\}
921 \fB2008_R2\fR: Similar to Windows 2008 R2 Functional Level
922 .RE
923 .sp
924 .RS 4
925 .ie n \{\
926 \h'-04'\(bu\h'+03'\c
927 .\}
928 .el \{\
929 .sp -1
930 .IP \(bu 2.3
931 .\}
932 \fB2012\fR: Similar to Windows 2012 Functional Level
933 .RE
934 .sp
935 .RS 4
936 .ie n \{\
937 \h'-04'\(bu\h'+03'\c
938 .\}
939 .el \{\
940 .sp -1
941 .IP \(bu 2.3
942 .\}
943 \fB2012_R2\fR: Similar to Windows 2012 R2 Functional Level
944 .RE
945 .sp
946 .RS 4
947 .ie n \{\
948 \h'-04'\(bu\h'+03'\c
949 .\}
950 .el \{\
951 .sp -1
952 .IP \(bu 2.3
953 .\}
954 \fB2016\fR: Similar to Windows 2016 Functional Level
955 .RE
956 .sp
957 .RE
958 Normally this option should not be set as Samba will operate per the released functionality of the Samba Active Directory Domain Controller\&.
959 .sp
960 However to access incomplete features in domain functional level 2016 it may be useful to set this value, prior to upgrading the domain functional level\&.
961 .sp
962 If this is set manually, the protection against mismatching features between domain controllers is reduced, so all domain controllers should be running the same version of Samba, to ensure that behaviour as seen by the client is the same no matter which DC is contacted\&.
963 .sp
964 Setting this to
965 \fB2016\fR
966 will allow raising the domain functional level with
967 samba\-tool domain level raise \-\-domain\-level=2016
968 and provide access to Samba\*(Aqs Kerberos Claims and Dynamic Access Control feature\&.
969 .if n \{\
970 .sp
971 .\}
972 .RS 4
973 .it 1 an-trap
974 .nr an-no-space-flag 1
975 .nr an-break-flag 1
976 .br
977 .ps +1
978 \fBWarning\fR
979 .ps -1
980 .br
981 The Samba\*(Aqs Kerberos Claims and Dynamic Access Control features enabled with
982 \fB2016\fR
983 are incomplete in Samba 4\&.19\&.
984 .sp .5v
985 .RE
986 Default:
987 \fI\fIad dc functional level\fR\fR\fI = \fR\fI2008_R2\fR\fI \fR
988 .sp
989 Example:
990 \fI\fIad dc functional level\fR\fR\fI = \fR\fI2016\fR\fI \fR
991 .RE
992
993 add group script (G)
994 .PP
995 .RS 4
996 This is the full pathname to a script that will be run
997 \fIAS ROOT\fR
998 by
999 \fBsmbd\fR(8)
1000 when a new group is requested\&. It will expand any
1001 \fI%g\fR
1002 to the group name passed\&. This script is only useful for installations using the Windows NT domain administration tools\&. The script is free to create a group with an arbitrary name to circumvent unix group name restrictions\&. In that case the script must print the numeric gid of the created group on stdout\&.
1003 .sp
1004 Default:
1005 \fI\fIadd group script\fR\fR\fI = \fR\fI\fR\fI \fR
1006 .sp
1007 Example:
1008 \fI\fIadd group script\fR\fR\fI = \fR\fI/usr/sbin/groupadd %g\fR\fI \fR
1009 .RE
1010
1011 additional dns hostnames (G)
1012 .PP
1013 .RS 4
1014 A list of additional DNS names by which this host can be identified
1015 .sp
1016 Default:
1017 \fI\fIadditional dns hostnames\fR\fR\fI = \fR\fI # empty string (no additional dns names)\fR\fI \fR
1018 .sp
1019 Example:
1020 \fI\fIadditional dns hostnames\fR\fR\fI = \fR\fI host2\&.example\&.com host3\&.other\&.com \fR\fI \fR
1021 .RE
1022
1023 add machine script (G)
1024 .PP
1025 .RS 4
1026 This is the full pathname to a script that will be run by
1027 \fBsmbd\fR(8)
1028 when a machine is added to Samba\*(Aqs domain and a Unix account matching the machine\*(Aqs name appended with a "$" does not already exist\&.
1029 .sp
1030 This option is very similar to the
1031 \m[blue]\fBadd user script\fR\m[], and likewise uses the %u substitution for the account name\&. Do not use the %m substitution\&.
1032 .sp
1033 Default:
1034 \fI\fIadd machine script\fR\fR\fI = \fR\fI\fR\fI \fR
1035 .sp
1036 Example:
1037 \fI\fIadd machine script\fR\fR\fI = \fR\fI/usr/sbin/adduser \-n \-g machines \-c Machine \-d /var/lib/nobody \-s /bin/false %u\fR\fI \fR
1038 .RE
1039
1040 addport command (G)
1041 .PP
1042 .RS 4
1043 Samba 3\&.0\&.23 introduced support for adding printer ports remotely using the Windows "Add Standard TCP/IP Port Wizard"\&. This option defines an external program to be executed when smbd receives a request to add a new Port to the system\&. The script is passed two parameters:
1044 .RS
1045 .sp
1046 .RS 4
1047 .ie n \{\
1048 \h'-04'\(bu\h'+03'\c
1049 .\}
1050 .el \{\
1051 .sp -1
1052 .IP \(bu 2.3
1053 .\}
1054 \fIport name\fR
1055 .RE
1056 .sp
1057 .RS 4
1058 .ie n \{\
1059 \h'-04'\(bu\h'+03'\c
1060 .\}
1061 .el \{\
1062 .sp -1
1063 .IP \(bu 2.3
1064 .\}
1065 \fIdevice URI\fR
1066 .RE
1067 .sp
1068 .RE
1069 The deviceURI is in the format of socket://<hostname>[:<portnumber>] or lpd://<hostname>/<queuename>\&.
1070 .sp
1071 Default:
1072 \fI\fIaddport command\fR\fR\fI = \fR\fI\fR\fI \fR
1073 .sp
1074 Example:
1075 \fI\fIaddport command\fR\fR\fI = \fR\fI/etc/samba/scripts/addport\&.sh\fR\fI \fR
1076 .RE
1077
1078 addprinter command (G)
1079 .PP
1080 .RS 4
1081 With the introduction of MS\-RPC based printing support for Windows NT/2000 clients in Samba 2\&.2, The MS Add Printer Wizard (APW) icon is now also available in the "Printers\&.\&.\&." folder displayed a share listing\&. The APW allows for printers to be add remotely to a Samba or Windows NT/2000 print server\&.
1082 .sp
1083 For a Samba host this means that the printer must be physically added to the underlying printing system\&. The
1084 \fIaddprinter command\fR
1085 defines a script to be run which will perform the necessary operations for adding the printer to the print system and to add the appropriate service definition to the
1086 smb\&.conf
1087 file in order that it can be shared by
1088 \fBsmbd\fR(8)\&.
1089 .sp
1090 The
1091 \fIaddprinter command\fR
1092 is automatically invoked with the following parameter (in order):
1093 .RS
1094 .sp
1095 .RS 4
1096 .ie n \{\
1097 \h'-04'\(bu\h'+03'\c
1098 .\}
1099 .el \{\
1100 .sp -1
1101 .IP \(bu 2.3
1102 .\}
1103 \fIprinter name\fR
1104 .RE
1105 .sp
1106 .RS 4
1107 .ie n \{\
1108 \h'-04'\(bu\h'+03'\c
1109 .\}
1110 .el \{\
1111 .sp -1
1112 .IP \(bu 2.3
1113 .\}
1114 \fIshare name\fR
1115 .RE
1116 .sp
1117 .RS 4
1118 .ie n \{\
1119 \h'-04'\(bu\h'+03'\c
1120 .\}
1121 .el \{\
1122 .sp -1
1123 .IP \(bu 2.3
1124 .\}
1125 \fIport name\fR
1126 .RE
1127 .sp
1128 .RS 4
1129 .ie n \{\
1130 \h'-04'\(bu\h'+03'\c
1131 .\}
1132 .el \{\
1133 .sp -1
1134 .IP \(bu 2.3
1135 .\}
1136 \fIdriver name\fR
1137 .RE
1138 .sp
1139 .RS 4
1140 .ie n \{\
1141 \h'-04'\(bu\h'+03'\c
1142 .\}
1143 .el \{\
1144 .sp -1
1145 .IP \(bu 2.3
1146 .\}
1147 \fIlocation\fR
1148 .RE
1149 .sp
1150 .RS 4
1151 .ie n \{\
1152 \h'-04'\(bu\h'+03'\c
1153 .\}
1154 .el \{\
1155 .sp -1
1156 .IP \(bu 2.3
1157 .\}
1158 \fIWindows 9x driver location\fR
1159 .RE
1160 .sp
1161 .RE
1162 All parameters are filled in from the PRINTER_INFO_2 structure sent by the Windows NT/2000 client with one exception\&. The "Windows 9x driver location" parameter is included for backwards compatibility only\&. The remaining fields in the structure are generated from answers to the APW questions\&.
1163 .sp
1164 Once the
1165 \fIaddprinter command\fR
1166 has been executed,
1167 smbd
1168 will reparse the
1169 smb\&.conf
1170 to determine if the share defined by the APW exists\&. If the sharename is still invalid, then
1171 smbd
1172 will return an ACCESS_DENIED error to the client\&.
1173 .sp
1174 The
1175 \fIaddprinter command\fR
1176 program can output a single line of text, which Samba will set as the port the new printer is connected to\&. If this line isn\*(Aqt output, Samba won\*(Aqt reload its printer shares\&.
1177 .sp
1178 Default:
1179 \fI\fIaddprinter command\fR\fR\fI = \fR\fI\fR\fI \fR
1180 .sp
1181 Example:
1182 \fI\fIaddprinter command\fR\fR\fI = \fR\fI/usr/bin/addprinter\fR\fI \fR
1183 .RE
1184
1185 add share command (G)
1186 .PP
1187 .RS 4
1188 Samba 2\&.2\&.0 introduced the ability to dynamically add and delete shares via the Windows NT 4\&.0 Server Manager\&. The
1189 \fIadd share command\fR
1190 is used to define an external program or script which will add a new service definition to
1191 smb\&.conf\&.
1192 .sp
1193 In order to successfully execute the
1194 \fIadd share command\fR,
1195 smbd
1196 requires that the administrator connects using a root account (i\&.e\&. uid == 0) or has the
1197 SeDiskOperatorPrivilege\&. Scripts defined in the
1198 \fIadd share command\fR
1199 parameter are executed as root\&.
1200 .sp
1201 When executed,
1202 smbd
1203 will automatically invoke the
1204 \fIadd share command\fR
1205 with five parameters\&.
1206 .RS
1207 .sp
1208 .RS 4
1209 .ie n \{\
1210 \h'-04'\(bu\h'+03'\c
1211 .\}
1212 .el \{\
1213 .sp -1
1214 .IP \(bu 2.3
1215 .\}
1216 \fIconfigFile\fR
1217 \- the location of the global
1218 smb\&.conf
1219 file\&.
1220 .RE
1221 .sp
1222 .RS 4
1223 .ie n \{\
1224 \h'-04'\(bu\h'+03'\c
1225 .\}
1226 .el \{\
1227 .sp -1
1228 .IP \(bu 2.3
1229 .\}
1230 \fIshareName\fR
1231 \- the name of the new share\&.
1232 .RE
1233 .sp
1234 .RS 4
1235 .ie n \{\
1236 \h'-04'\(bu\h'+03'\c
1237 .\}
1238 .el \{\
1239 .sp -1
1240 .IP \(bu 2.3
1241 .\}
1242 \fIpathName\fR
1243 \- path to an **existing** directory on disk\&.
1244 .RE
1245 .sp
1246 .RS 4
1247 .ie n \{\
1248 \h'-04'\(bu\h'+03'\c
1249 .\}
1250 .el \{\
1251 .sp -1
1252 .IP \(bu 2.3
1253 .\}
1254 \fIcomment\fR
1255 \- comment string to associate with the new share\&.
1256 .RE
1257 .sp
1258 .RS 4
1259 .ie n \{\
1260 \h'-04'\(bu\h'+03'\c
1261 .\}
1262 .el \{\
1263 .sp -1
1264 .IP \(bu 2.3
1265 .\}
1266 \fImax connections\fR
1267 Number of maximum simultaneous connections to this share\&.
1268 .RE
1269 .sp
1270 .RE
1271 This parameter is only used to add file shares\&. To add printer shares, see the
1272 \m[blue]\fBaddprinter command\fR\m[]\&.
1273 .sp
1274 Default:
1275 \fI\fIadd share command\fR\fR\fI = \fR\fI\fR\fI \fR
1276 .sp
1277 Example:
1278 \fI\fIadd share command\fR\fR\fI = \fR\fI/usr/local/bin/addshare\fR\fI \fR
1279 .RE
1280
1281 add user script (G)
1282 .PP
1283 .RS 4
1284 This is the full pathname to a script that will be run
1285 \fIAS ROOT\fR
1286 by
1287 \fBsmbd\fR(8)
1288 under special circumstances described below\&.
1289 .sp
1290 Normally, a Samba server requires that UNIX users are created for all users accessing files on this server\&. For sites that use Windows NT account databases as their primary user database creating these users and keeping the user list in sync with the Windows NT PDC is an onerous task\&. This option allows smbd to create the required UNIX users
1291 \fION DEMAND\fR
1292 when a user accesses the Samba server\&.
1293 .sp
1294 When the Windows user attempts to access the Samba server, at login (session setup in the SMB protocol) time,
1295 \fBsmbd\fR(8)
1296 contacts the
1297 \m[blue]\fBpassword server\fR\m[]
1298 and attempts to authenticate the given user with the given password\&. If the authentication succeeds then
1299 smbd
1300 attempts to find a UNIX user in the UNIX password database to map the Windows user into\&. If this lookup fails, and
1301 \m[blue]\fBadd user script\fR\m[]
1302 is set then
1303 smbd
1304 will call the specified script
1305 \fIAS ROOT\fR, expanding any
1306 \fI%u\fR
1307 argument to be the user name to create\&.
1308 .sp
1309 If this script successfully creates the user then
1310 smbd
1311 will continue on as though the UNIX user already existed\&. In this way, UNIX users are dynamically created to match existing Windows NT accounts\&.
1312 .sp
1313 See also
1314 \m[blue]\fBsecurity\fR\m[],
1315 \m[blue]\fBpassword server\fR\m[],
1316 \m[blue]\fBdelete user script\fR\m[]\&.
1317 .sp
1318 Default:
1319 \fI\fIadd user script\fR\fR\fI = \fR\fI\fR\fI \fR
1320 .sp
1321 Example:
1322 \fI\fIadd user script\fR\fR\fI = \fR\fI/usr/local/samba/bin/add_user %u\fR\fI \fR
1323 .RE
1324
1325 add user to group script (G)
1326 .PP
1327 .RS 4
1328 Full path to the script that will be called when a user is added to a group using the Windows NT domain administration tools\&. It will be run by
1329 \fBsmbd\fR(8)
1330 \fIAS ROOT\fR\&. Any
1331 \fI%g\fR
1332 will be replaced with the group name and any
1333 \fI%u\fR
1334 will be replaced with the user name\&.
1335 .sp
1336 Note that the
1337 adduser
1338 command used in the example below does not support the used syntax on all systems\&.
1339 .sp
1340 Default:
1341 \fI\fIadd user to group script\fR\fR\fI = \fR\fI\fR\fI \fR
1342 .sp
1343 Example:
1344 \fI\fIadd user to group script\fR\fR\fI = \fR\fI/usr/sbin/adduser %u %g\fR\fI \fR
1345 .RE
1346
1347 administrative share (S)
1348 .PP
1349 .RS 4
1350 If this parameter is set to
1351 \fByes\fR
1352 for a share, then the share will be an administrative share\&. The Administrative Shares are the default network shares created by all Windows NT\-based operating systems\&. These are shares like C$, D$ or ADMIN$\&. The type of these shares is STYPE_DISKTREE_HIDDEN\&.
1353 .sp
1354 See the section below on
1355 \m[blue]\fBsecurity\fR\m[]
1356 for more information about this option\&.
1357 .sp
1358 Default:
1359 \fI\fIadministrative share\fR\fR\fI = \fR\fIno\fR\fI \fR
1360 .RE
1361
1362 admin users (S)
1363 .PP
1364 .RS 4
1365 This is a list of users who will be granted administrative privileges on the share\&. This means that they will do all file operations as the super\-user (root)\&.
1366 .sp
1367 You should use this option very carefully, as any user in this list will be able to do anything they like on the share, irrespective of file permissions\&.
1368 .sp
1369 Default:
1370 \fI\fIadmin users\fR\fR\fI = \fR\fI\fR\fI \fR
1371 .sp
1372 Example:
1373 \fI\fIadmin users\fR\fR\fI = \fR\fIjason\fR\fI \fR
1374 .RE
1375
1376 afs share (S)
1377 .PP
1378 .RS 4
1379 This parameter controls whether special AFS features are enabled for this share\&. If enabled, it assumes that the directory exported via the
1380 \fIpath\fR
1381 parameter is a local AFS import\&. The special AFS features include the attempt to hand\-craft an AFS token if you enabled \-\-with\-fake\-kaserver in configure\&.
1382 .sp
1383 Default:
1384 \fI\fIafs share\fR\fR\fI = \fR\fIno\fR\fI \fR
1385 .RE
1386
1387 afs token lifetime (G)
1388 .PP
1389 .RS 4
1390 This parameter controls the lifetime of tokens that the AFS fake\-kaserver claims\&. In reality these never expire but this lifetime controls when the afs client will forget the token\&.
1391 .sp
1392 Set this parameter to 0 to get
1393 \fBNEVERDATE\fR\&.
1394 .sp
1395 Default:
1396 \fI\fIafs token lifetime\fR\fR\fI = \fR\fI604800\fR\fI \fR
1397 .RE
1398
1399 afs username map (G)
1400 .PP
1401 .RS 4
1402 If you are using the fake kaserver AFS feature, you might want to hand\-craft the usernames you are creating tokens for\&. For example this is necessary if you have users from several domain in your AFS Protection Database\&. One possible scheme to code users as DOMAIN+User as it is done by winbind with the + as a separator\&.
1403 .sp
1404 The mapped user name must contain the cell name to log into, so without setting this parameter there will be no token\&.
1405 .sp
1406 Default:
1407 \fI\fIafs username map\fR\fR\fI = \fR\fI\fR\fI \fR
1408 .sp
1409 Example:
1410 \fI\fIafs username map\fR\fR\fI = \fR\fI%u@afs\&.samba\&.org\fR\fI \fR
1411 .RE
1412
1413 aio max threads (G)
1414 .PP
1415 .RS 4
1416 The integer parameter specifies the maximum number of threads each smbd process will create when doing parallel asynchronous IO calls\&. If the number of outstanding calls is greater than this number the requests will not be refused but go onto a queue and will be scheduled in turn as outstanding requests complete\&.
1417 .sp
1418 Related command:
1419 \m[blue]\fBaio read size\fR\m[]
1420 .sp
1421 Related command:
1422 \m[blue]\fBaio write size\fR\m[]
1423 .sp
1424 Default:
1425 \fI\fIaio max threads\fR\fR\fI = \fR\fI100\fR\fI \fR
1426 .RE
1427
1428 aio read size (S)
1429 .PP
1430 .RS 4
1431 If this integer parameter is set to a non\-zero value, Samba will read from files asynchronously when the request size is bigger than this value\&. Note that it happens only for non\-chained and non\-chaining reads\&.
1432 .sp
1433 The only reasonable values for this parameter are 0 (no async I/O) and 1 (always do async I/O)\&.
1434 .sp
1435 Related command:
1436 \m[blue]\fBaio write size\fR\m[]
1437 .sp
1438 Default:
1439 \fI\fIaio read size\fR\fR\fI = \fR\fI1\fR\fI \fR
1440 .sp
1441 Example:
1442 \fI\fIaio read size\fR\fR\fI = \fR\fI0 # Always do reads synchronously \fR\fI \fR
1443 .RE
1444
1445 aio write behind (S)
1446 .PP
1447 .RS 4
1448 If Samba has been built with asynchronous I/O support, Samba will not wait until write requests are finished before returning the result to the client for files listed in this parameter\&. Instead, Samba will immediately return that the write request has been finished successfully, no matter if the operation will succeed or not\&. This might speed up clients without aio support, but is really dangerous, because data could be lost and files could be damaged\&.
1449 .sp
1450 The syntax is identical to the
1451 \m[blue]\fBveto files\fR\m[]
1452 parameter\&.
1453 .sp
1454 Default:
1455 \fI\fIaio write behind\fR\fR\fI = \fR\fI\fR\fI \fR
1456 .sp
1457 Example:
1458 \fI\fIaio write behind\fR\fR\fI = \fR\fI/*\&.tmp/\fR\fI \fR
1459 .RE
1460
1461 aio write size (S)
1462 .PP
1463 .RS 4
1464 If this integer parameter is set to a non\-zero value, Samba will write to files asynchronously when the request size is bigger than this value\&. Note that it happens only for non\-chained and non\-chaining writes\&.
1465 .sp
1466 The only reasonable values for this parameter are 0 (no async I/O) and 1 (always do async I/O)\&.
1467 .sp
1468 Compared to
1469 \m[blue]\fBaio read size\fR\m[]
1470 this parameter has a smaller effect, most writes should end up in the file system cache\&. Writes that require space allocation might benefit most from going asynchronous\&.
1471 .sp
1472 Related command:
1473 \m[blue]\fBaio read size\fR\m[]
1474 .sp
1475 Default:
1476 \fI\fIaio write size\fR\fR\fI = \fR\fI1\fR\fI \fR
1477 .sp
1478 Example:
1479 \fI\fIaio write size\fR\fR\fI = \fR\fI0 # Always do writes synchronously \fR\fI \fR
1480 .RE
1481
1482 algorithmic rid base (G)
1483 .PP
1484 .RS 4
1485 This determines how Samba will use its algorithmic mapping from uids/gid to the RIDs needed to construct NT Security Identifiers\&.
1486 .sp
1487 Setting this option to a larger value could be useful to sites transitioning from WinNT and Win2k, as existing user and group rids would otherwise clash with system users etc\&.
1488 .sp
1489 All UIDs and GIDs must be able to be resolved into SIDs for the correct operation of ACLs on the server\&. As such the algorithmic mapping can\*(Aqt be \*(Aqturned off\*(Aq, but pushing it \*(Aqout of the way\*(Aq should resolve the issues\&. Users and groups can then be assigned \*(Aqlow\*(Aq RIDs in arbitrary\-rid supporting backends\&.
1490 .sp
1491 Default:
1492 \fI\fIalgorithmic rid base\fR\fR\fI = \fR\fI1000\fR\fI \fR
1493 .sp
1494 Example:
1495 \fI\fIalgorithmic rid base\fR\fR\fI = \fR\fI100000\fR\fI \fR
1496 .RE
1497
1498 allocation roundup size (S)
1499 .PP
1500 .RS 4
1501 This parameter allows an administrator to tune the allocation size reported to Windows clients\&. This is only useful for old SMB1 clients because modern SMB dialects eliminated that bottleneck and have better performance by default\&. Using this parameter may cause difficulties for some applications, e\&.g\&. MS Visual Studio\&. If the MS Visual Studio compiler starts to crash with an internal error, set this parameter to zero for this share\&. Settings this parameter to a large value can also cause small files to allocate more space on the disk than needed\&.
1502 .sp
1503 This parameter is deprecated and will be removed in one of the next Samba releases\&.
1504 .sp
1505 The integer parameter specifies the roundup size in bytes\&.
1506 .sp
1507 Default:
1508 \fI\fIallocation roundup size\fR\fR\fI = \fR\fI0\fR\fI \fR
1509 .sp
1510 Example:
1511 \fI\fIallocation roundup size\fR\fR\fI = \fR\fI1048576 # (to set it to the former default of 1 MiB)\fR\fI \fR
1512 .RE
1513
1514 allow dcerpc auth level connect (G)
1515 .PP
1516 .RS 4
1517 This option controls whether DCERPC services are allowed to be used with DCERPC_AUTH_LEVEL_CONNECT, which provides authentication, but no per message integrity nor privacy protection\&.
1518 .sp
1519 Some interfaces like samr, lsarpc and netlogon have a hard\-coded default of
1520 \fBno\fR
1521 and epmapper, mgmt and rpcecho have a hard\-coded default of
1522 \fByes\fR\&.
1523 .sp
1524 The behavior can be overwritten per interface name (e\&.g\&. lsarpc, netlogon, samr, srvsvc, winreg, wkssvc \&.\&.\&.) by using \*(Aqallow dcerpc auth level connect:interface = yes\*(Aq as option\&.
1525 .sp
1526 This option is over\-ridden by the implementation specific restrictions\&. E\&.g\&. the drsuapi and backupkey protocols require DCERPC_AUTH_LEVEL_PRIVACY\&. The dnsserver protocol requires DCERPC_AUTH_LEVEL_INTEGRITY\&.
1527 .sp
1528 Default:
1529 \fI\fIallow dcerpc auth level connect\fR\fR\fI = \fR\fIno\fR\fI \fR
1530 .sp
1531 Example:
1532 \fI\fIallow dcerpc auth level connect\fR\fR\fI = \fR\fIyes\fR\fI \fR
1533 .RE
1534
1535 allow dns updates (G)
1536 .PP
1537 .RS 4
1538 This option determines what kind of updates to the DNS are allowed\&.
1539 .sp
1540 DNS updates can either be disallowed completely by setting it to
1541 \fBdisabled\fR, enabled over secure connections only by setting it to
1542 \fBsecure only\fR
1543 or allowed in all cases by setting it to
1544 \fBnonsecure\fR\&.
1545 .sp
1546 Default:
1547 \fI\fIallow dns updates\fR\fR\fI = \fR\fIsecure only\fR\fI \fR
1548 .sp
1549 Example:
1550 \fI\fIallow dns updates\fR\fR\fI = \fR\fIdisabled\fR\fI \fR
1551 .RE
1552
1553 allow insecure wide links (G)
1554 .PP
1555 .RS 4
1556 In normal operation the option
1557 \m[blue]\fBwide links\fR\m[]
1558 which allows the server to follow symlinks outside of a share path is automatically disabled when
1559 \m[blue]\fBunix extensions\fR\m[]
1560 are enabled on a Samba server\&. This is done for security purposes to prevent UNIX clients creating symlinks to areas of the server file system that the administrator does not wish to export\&.
1561 .sp
1562 Setting
1563 \m[blue]\fBallow insecure wide links\fR\m[]
1564 to true disables the link between these two parameters, removing this protection and allowing a site to configure the server to follow symlinks (by setting
1565 \m[blue]\fBwide links\fR\m[]
1566 to "true") even when
1567 \m[blue]\fBunix extensions\fR\m[]
1568 is turned on\&.
1569 .sp
1570 It is not recommended to enable this option unless you fully understand the implications of allowing the server to follow symbolic links created by UNIX clients\&. For most normal Samba configurations this would be considered a security hole and setting this parameter is not recommended\&.
1571 .sp
1572 This option was added at the request of sites who had deliberately set Samba up in this way and needed to continue supporting this functionality without having to patch the Samba code\&.
1573 .sp
1574 Default:
1575 \fI\fIallow insecure wide links\fR\fR\fI = \fR\fIno\fR\fI \fR
1576 .RE
1577
1578 allow nt4 crypto (G)
1579 .PP
1580 .RS 4
1581 This option is deprecated and will be removed in future, as it is a security problem if not set to "no" (which will be the hardcoded behavior in future)\&.
1582 .sp
1583 This option controls whether the netlogon server (currently only in \*(Aqactive directory domain controller\*(Aq mode), will reject clients which do not support NETLOGON_NEG_STRONG_KEYS nor NETLOGON_NEG_SUPPORTS_AES\&.
1584 .sp
1585 This option was added with Samba 4\&.2\&.0\&. It may lock out clients which worked fine with Samba versions up to 4\&.1\&.x\&. as the effective default was "yes" there, while it is "no" now\&.
1586 .sp
1587 If you have clients without RequireStrongKey = 1 in the registry, you may need to set "allow nt4 crypto = yes", until you have fixed all clients\&.
1588 .sp
1589 "allow nt4 crypto = yes" allows weak crypto to be negotiated, maybe via downgrade attacks\&.
1590 .sp
1591 \fIAvoid using this option!\fR
1592 Use explicit \*(Aq\m[blue]\fBallow nt4 crypto:COMPUTERACCOUNT = yes\fR\m[]\*(Aq instead! Which is available with the patches for
1593 CVE\-2022\-38023
1594 see
1595 https://bugzilla\&.samba\&.org/show_bug\&.cgi?id=15240
1596 .sp
1597 Samba will log an error in the log files at log level 0 if legacy a client is rejected or allowed without an explicit, \*(Aq\m[blue]\fBallow nt4 crypto:COMPUTERACCOUNT = yes\fR\m[]\*(Aq option for the client\&. The message will indicate the explicit \*(Aq\m[blue]\fBallow nt4 crypto:COMPUTERACCOUNT = yes\fR\m[]\*(Aq line to be added, if the legacy client software requires it\&. (The log level can be adjusted with \*(Aq\m[blue]\fBCVE_2022_38023:error_debug_level = 1\fR\m[]\*(Aq in order to complain only at a higher log level)\&.
1598 .sp
1599 This allows admins to use "yes" only for a short grace period, in order to collect the explicit \*(Aq\m[blue]\fBallow nt4 crypto:COMPUTERACCOUNT = yes\fR\m[]\*(Aq options\&.
1600 .sp
1601 This option is over\-ridden by the effective value of \*(Aqyes\*(Aq from the \*(Aq\m[blue]\fBserver reject md5 schannel:COMPUTERACCOUNT\fR\m[]\*(Aq, \*(Aq\m[blue]\fBreject md5 clients\fR\m[]\*(Aq, \*(Aq\m[blue]\fBserver reject aes schannel:COMPUTERACCOUNT\fR\m[]\*(Aq, and/or \*(Aq\m[blue]\fBserver reject aes schannel\fR\m[]\*(Aq options\&.
1602 .sp
1603 Default:
1604 \fI\fIallow nt4 crypto\fR\fR\fI = \fR\fIno\fR\fI \fR
1605 .RE
1606
1607 allow nt4 crypto:COMPUTERACCOUNT (G)
1608 .PP
1609 .RS 4
1610 If you still have legacy domain members which required \*(Aqallow nt4 crypto = yes\*(Aq, it is possible to specify an explicit exception per computer account by using \*(Aqallow nt4 crypto:COMPUTERACCOUNT = yes\*(Aq as option\&. Note that COMPUTERACCOUNT has to be the sAMAccountName value of the computer account (including the trailing \*(Aq$\*(Aq sign)\&.
1611 .sp
1612 Samba will log a complaint in the log files at log level 0 about the security problem if the option is set to "yes", but the related computer does not require it\&. (The log level can be adjusted with \*(Aq\m[blue]\fBCVE_2022_38023:warn_about_unused_debug_level = 1\fR\m[]\*(Aq in order to complain only at a higher log level)\&.
1613 .sp
1614 Samba will log a warning in the log files at log level 5, if a setting is still needed for the specified computer account\&.
1615 .sp
1616 See
1617 CVE\-2022\-38023,
1618 https://bugzilla\&.samba\&.org/show_bug\&.cgi?id=15240\&.
1619 .sp
1620 This option overrides the
1621 \m[blue]\fBallow nt4 crypto\fR\m[]
1622 option\&.
1623 .sp
1624 This option is over\-ridden by the effective value of \*(Aqyes\*(Aq from the \*(Aq\m[blue]\fBserver reject md5 schannel:COMPUTERACCOUNT\fR\m[]\*(Aq, \*(Aq\m[blue]\fBreject md5 clients\fR\m[]\*(Aq, \*(Aq\m[blue]\fBserver reject aes schannel:COMPUTERACCOUNT\fR\m[]\*(Aq and/or \*(Aq\m[blue]\fBserver reject aes schannel\fR\m[]\*(Aq options\&.
1625 .sp
1626 Which means \*(Aq\m[blue]\fBallow nt4 crypto:COMPUTERACCOUNT = yes\fR\m[]\*(Aq is only useful in combination with \*(Aq\m[blue]\fBserver reject md5 schannel:COMPUTERACCOUNT = no\fR\m[]\*(Aq and \*(Aq\m[blue]\fBserver reject aes schannel:COMPUTERACCOUNT = no\fR\m[]\*(Aq\&.
1627 .sp
1628 .if n \{\
1629 .RS 4
1630 .\}
1631 .nf
1632 allow nt4 crypto:LEGACYCOMPUTER1$ = yes
1633 server reject md5 schannel:LEGACYCOMPUTER1$ = no
1634 server reject aes schannel:LEGACYCOMPUTER1$ = no
1635 allow nt4 crypto:NASBOX$ = yes
1636 server reject md5 schannel:NASBOX$ = no
1637 server reject aes schannel:NASBOX$ = no
1638 allow nt4 crypto:LEGACYCOMPUTER2$ = yes
1639 server reject md5 schannel:LEGACYCOMPUTER2$ = no
1640 server reject aes schannel:LEGACYCOMPUTER2$ = no
1641
1642 .fi
1643 .if n \{\
1644 .RE
1645 .\}
1646 .sp
1647 \fINo default\fR
1648 .RE
1649
1650 allow trusted domains (G)
1651 .PP
1652 .RS 4
1653 This option only takes effect when the
1654 \m[blue]\fBsecurity\fR\m[]
1655 option is set to
1656 \fBserver\fR,
1657 \fBdomain\fR
1658 or
1659 \fBads\fR\&. If it is set to no, then attempts to connect to a resource from a domain or workgroup other than the one which smbd is running in will fail, even if that domain is trusted by the remote server doing the authentication\&.
1660 .sp
1661 This is useful if you only want your Samba server to serve resources to users in the domain it is a member of\&. As an example, suppose that there are two domains DOMA and DOMB\&. DOMB is trusted by DOMA, which contains the Samba server\&. Under normal circumstances, a user with an account in DOMB can then access the resources of a UNIX account with the same account name on the Samba server even if they do not have an account in DOMA\&. This can make implementing a security boundary difficult\&.
1662 .sp
1663 Default:
1664 \fI\fIallow trusted domains\fR\fR\fI = \fR\fIyes\fR\fI \fR
1665 .RE
1666
1667 allow unsafe cluster upgrade (G)
1668 .PP
1669 .RS 4
1670 If set to no (the default), smbd checks at startup if other smbd versions are running in the cluster and refuses to start if so\&. This is done to protect data corruption in internal data structures due to incompatible Samba versions running concurrently in the same cluster\&. Setting this parameter to
1671 yes
1672 disables this safety check\&.
1673 .sp
1674 Default:
1675 \fI\fIallow unsafe cluster upgrade\fR\fR\fI = \fR\fIno\fR\fI \fR
1676 .RE
1677
1678 apply group policies (G)
1679 .PP
1680 .RS 4
1681 This option controls whether winbind will execute the gpupdate command defined in
1682 \m[blue]\fBgpo update command\fR\m[]
1683 on the Group Policy update interval\&. The Group Policy update interval is defined as every 90 minutes, plus a random offset between 0 and 30 minutes\&. This applies Group Policy Machine polices to the client or KDC and machine policies to a server\&.
1684 .sp
1685 Default:
1686 \fI\fIapply group policies\fR\fR\fI = \fR\fIno\fR\fI \fR
1687 .sp
1688 Example:
1689 \fI\fIapply group policies\fR\fR\fI = \fR\fIyes\fR\fI \fR
1690 .RE
1691
1692 async dns timeout (G)
1693 .PP
1694 .RS 4
1695 The number of seconds the asynchronous DNS resolver code in Samba will wait for responses\&. Some of the Samba client library code uses internal asynchronous DNS resolution for A and AAAA records when trying to find Active Directory Domain controllers\&. This value prevents this name resolution code from waiting for DNS server timeouts\&.
1696 .sp
1697 The minimum value of this parameter is clamped at 1 second\&.
1698 .sp
1699 Default:
1700 \fI\fIasync dns timeout\fR\fR\fI = \fR\fI10\fR\fI \fR
1701 .sp
1702 Example:
1703 \fI\fIasync dns timeout\fR\fR\fI = \fR\fI20\fR\fI \fR
1704 .RE
1705
1706 async smb echo handler (G)
1707 .PP
1708 .RS 4
1709 This parameter specifies whether Samba should fork the async smb echo handler\&. It can be beneficial if your file system can block syscalls for a very long time\&. In some circumstances, it prolongs the timeout that Windows uses to determine whether a connection is dead\&. This parameter is only for SMB1\&. For SMB2 and above TCP keepalives can be used instead\&.
1710 .sp
1711 Default:
1712 \fI\fIasync smb echo handler\fR\fR\fI = \fR\fIno\fR\fI \fR
1713 .RE
1714
1715 auth event notification (G)
1716 .PP
1717 .RS 4
1718 When enabled, this option causes Samba (acting as an Active Directory Domain Controller) to stream authentication events across the internal message bus\&. Scripts built using Samba\*(Aqs python bindings can listen to these events by registering as the service
1719 auth_event\&.
1720 .sp
1721 This is
1722 \fInot\fR
1723 needed for the audit logging described in
1724 \m[blue]\fBlog level\fR\m[]\&.
1725 .sp
1726 Instead, this should instead be considered a developer option (it assists in the Samba testsuite) rather than a facility for external auditing, as message delivery is not guaranteed (a feature that the testsuite works around)\&.
1727 .sp
1728 The authentication events are also logged via the normal logging methods when the
1729 \m[blue]\fBlog level\fR\m[]
1730 is set appropriately, say to
1731 auth_json_audit:3\&.
1732 .sp
1733 Default:
1734 \fI\fIauth event notification\fR\fR\fI = \fR\fIno\fR\fI \fR
1735 .RE
1736
1737 preload
1738 .PP
1739 .RS 4
1740 This parameter is a synonym for
1741 auto services\&.
1742 .RE
1743
1744 auto services (G)
1745 .PP
1746 .RS 4
1747 This is a list of services that you want to be automatically added to the browse lists\&. This is most useful for homes and printers services that would otherwise not be visible\&.
1748 .sp
1749 Note that if you just want all printers in your printcap file loaded then the
1750 \m[blue]\fBload printers\fR\m[]
1751 option is easier\&.
1752 .sp
1753 Default:
1754 \fI\fIauto services\fR\fR\fI = \fR\fI\fR\fI \fR
1755 .sp
1756 Example:
1757 \fI\fIauto services\fR\fR\fI = \fR\fIfred lp colorlp\fR\fI \fR
1758 .RE
1759
1760 available (S)
1761 .PP
1762 .RS 4
1763 This parameter lets you "turn off" a service\&. If
1764 \fIavailable = no\fR, then
1765 \fIALL\fR
1766 attempts to connect to the service will fail\&. Such failures are logged\&.
1767 .sp
1768 Default:
1769 \fI\fIavailable\fR\fR\fI = \fR\fIyes\fR\fI \fR
1770 .RE
1771
1772 bind dns directory
1773 .PP
1774 .RS 4
1775 This parameter is a synonym for
1776 binddns dir\&.
1777 .RE
1778
1779 binddns dir (G)
1780 .PP
1781 .RS 4
1782 This parameters defines the directory samba will use to store the configuration files for bind, such as named\&.conf\&. NOTE: The bind dns directory needs to be on the same mount point as the private directory!
1783 .sp
1784 Default:
1785 \fI\fIbinddns dir\fR\fR\fI = \fR\fI/var/lib/samba/bind\-dns\fR\fI \fR
1786 .RE
1787
1788 bind interfaces only (G)
1789 .PP
1790 .RS 4
1791 This global parameter allows the Samba admin to limit what interfaces on a machine will serve SMB requests\&. It affects file service
1792 \fBsmbd\fR(8)
1793 and name service
1794 \fBnmbd\fR(8)
1795 in a slightly different ways\&.
1796 .sp
1797 For name service it causes
1798 nmbd
1799 to bind to ports 137 and 138 on the interfaces listed in the
1800 \m[blue]\fBinterfaces\fR\m[]
1801 parameter\&.
1802 nmbd
1803 also binds to the "all addresses" interface (0\&.0\&.0\&.0) on ports 137 and 138 for the purposes of reading broadcast messages\&. If this option is not set then
1804 nmbd
1805 will service name requests on all of these sockets\&. If
1806 \m[blue]\fBbind interfaces only\fR\m[]
1807 is set then
1808 nmbd
1809 will check the source address of any packets coming in on the broadcast sockets and discard any that don\*(Aqt match the broadcast addresses of the interfaces in the
1810 \m[blue]\fBinterfaces\fR\m[]
1811 parameter list\&. As unicast packets are received on the other sockets it allows
1812 nmbd
1813 to refuse to serve names to machines that send packets that arrive through any interfaces not listed in the
1814 \m[blue]\fBinterfaces\fR\m[]
1815 list\&. IP Source address spoofing does defeat this simple check, however, so it must not be used seriously as a security feature for
1816 nmbd\&.
1817 .sp
1818 For file service it causes
1819 \fBsmbd\fR(8)
1820 to bind only to the interface list given in the
1821 \m[blue]\fBinterfaces\fR\m[]
1822 parameter\&. This restricts the networks that
1823 smbd
1824 will serve, to packets coming in on those interfaces\&. Note that you should not use this parameter for machines that are serving PPP or other intermittent or non\-broadcast network interfaces as it will not cope with non\-permanent interfaces\&.
1825 .sp
1826 If
1827 \m[blue]\fBbind interfaces only\fR\m[]
1828 is set and the network address
1829 \fI127\&.0\&.0\&.1\fR
1830 is not added to the
1831 \m[blue]\fBinterfaces\fR\m[]
1832 parameter list
1833 \fBsmbpasswd\fR(8)
1834 may not work as expected due to the reasons covered below\&.
1835 .sp
1836 To change a users SMB password, the
1837 smbpasswd
1838 by default connects to the
1839 \fIlocalhost \- 127\&.0\&.0\&.1\fR
1840 address as an SMB client to issue the password change request\&. If
1841 \m[blue]\fBbind interfaces only\fR\m[]
1842 is set then unless the network address
1843 \fI127\&.0\&.0\&.1\fR
1844 is added to the
1845 \m[blue]\fBinterfaces\fR\m[]
1846 parameter list then
1847 smbpasswd
1848 will fail to connect in it\*(Aqs default mode\&.
1849 smbpasswd
1850 can be forced to use the primary IP interface of the local host by using its
1851 \fBsmbpasswd\fR(8)
1852 \fI\-r \fR\fI\fIremote machine\fR\fR
1853 parameter, with
1854 \fIremote machine\fR
1855 set to the IP name of the primary interface of the local host\&.
1856 .sp
1857 Default:
1858 \fI\fIbind interfaces only\fR\fR\fI = \fR\fIno\fR\fI \fR
1859 .RE
1860
1861 blocking locks (S)
1862 .PP
1863 .RS 4
1864 This parameter controls the behavior of
1865 \fBsmbd\fR(8)
1866 when given a request by a client to obtain a byte range lock on a region of an open file, and the request has a time limit associated with it\&.
1867 .sp
1868 If this parameter is set and the lock range requested cannot be immediately satisfied, samba will internally queue the lock request, and periodically attempt to obtain the lock until the timeout period expires\&.
1869 .sp
1870 If this parameter is set to
1871 \fBno\fR, then samba will behave as previous versions of Samba would and will fail the lock request immediately if the lock range cannot be obtained\&.
1872 .sp
1873 Default:
1874 \fI\fIblocking locks\fR\fR\fI = \fR\fIyes\fR\fI \fR
1875 .RE
1876
1877 block size (S)
1878 .PP
1879 .RS 4
1880 This parameter controls the behavior of
1881 \fBsmbd\fR(8)
1882 when reporting disk free sizes\&. By default, this reports a disk block size of 1024 bytes\&.
1883 .sp
1884 Changing this parameter may have some effect on the efficiency of client writes, this is not yet confirmed\&. This parameter was added to allow advanced administrators to change it (usually to a higher value) and test the effect it has on client write performance without re\-compiling the code\&. As this is an experimental option it may be removed in a future release\&.
1885 .sp
1886 Changing this option does not change the disk free reporting size, just the block size unit reported to the client\&.
1887 .sp
1888 Default:
1889 \fI\fIblock size\fR\fR\fI = \fR\fI1024\fR\fI \fR
1890 .sp
1891 Example:
1892 \fI\fIblock size\fR\fR\fI = \fR\fI4096\fR\fI \fR
1893 .RE
1894
1895 browsable
1896 .PP
1897 .RS 4
1898 This parameter is a synonym for
1899 browseable\&.
1900 .RE
1901
1902 browseable (S)
1903 .PP
1904 .RS 4
1905 This controls whether this share is seen in the list of available shares in a net view and in the browse list\&.
1906 .sp
1907 Default:
1908 \fI\fIbrowseable\fR\fR\fI = \fR\fIyes\fR\fI \fR
1909 .RE
1910
1911 browse list (G)
1912 .PP
1913 .RS 4
1914 This controls whether
1915 \fBsmbd\fR(8)
1916 will serve a browse list to a client doing a
1917 NetServerEnum
1918 call\&. Normally set to
1919 \fByes\fR\&. You should never need to change this\&.
1920 .sp
1921 Default:
1922 \fI\fIbrowse list\fR\fR\fI = \fR\fIyes\fR\fI \fR
1923 .RE
1924
1925 cache directory (G)
1926 .PP
1927 .RS 4
1928 Usually, most of the TDB files are stored in the
1929 \fIlock directory\fR\&. Since Samba 3\&.4\&.0, it is possible to differentiate between TDB files with persistent data and TDB files with non\-persistent data using the
1930 \fIstate directory\fR
1931 and the
1932 \fIcache directory\fR
1933 options\&.
1934 .sp
1935 This option specifies the directory for storing TDB files containing non\-persistent data that will be kept across service restarts\&. The directory should be placed on persistent storage, but the data can be safely deleted by an administrator\&.
1936 .sp
1937 Default:
1938 \fI\fIcache directory\fR\fR\fI = \fR\fI/var/lib/samba\fR\fI \fR
1939 .sp
1940 Example:
1941 \fI\fIcache directory\fR\fR\fI = \fR\fI/var/run/samba/locks/cache\fR\fI \fR
1942 .RE
1943
1944 casesignames
1945 .PP
1946 .RS 4
1947 This parameter is a synonym for
1948 case sensitive\&.
1949 .RE
1950
1951 case sensitive (S)
1952 .PP
1953 .RS 4
1954 See the discussion in the section
1955 name mangling\&.
1956 .sp
1957 Default:
1958 \fI\fIcase sensitive\fR\fR\fI = \fR\fIauto\fR\fI \fR
1959 .RE
1960
1961 change notify (G)
1962 .PP
1963 .RS 4
1964 This parameter specifies whether Samba should reply to a client\*(Aqs file change notify requests\&.
1965 .sp
1966 You should never need to change this parameter
1967 .sp
1968 Default:
1969 \fI\fIchange notify\fR\fR\fI = \fR\fIyes\fR\fI \fR
1970 .RE
1971
1972 change share command (G)
1973 .PP
1974 .RS 4
1975 Samba 2\&.2\&.0 introduced the ability to dynamically add and delete shares via the Windows NT 4\&.0 Server Manager\&. The
1976 \fIchange share command\fR
1977 is used to define an external program or script which will modify an existing service definition in
1978 smb\&.conf\&.
1979 .sp
1980 In order to successfully execute the
1981 \fIchange share command\fR,
1982 smbd
1983 requires that the administrator connects using a root account (i\&.e\&. uid == 0) or has the
1984 SeDiskOperatorPrivilege\&. Scripts defined in the
1985 \fIchange share command\fR
1986 parameter are executed as root\&.
1987 .sp
1988 When executed,
1989 smbd
1990 will automatically invoke the
1991 \fIchange share command\fR
1992 with six parameters\&.
1993 .RS
1994 .sp
1995 .RS 4
1996 .ie n \{\
1997 \h'-04'\(bu\h'+03'\c
1998 .\}
1999 .el \{\
2000 .sp -1
2001 .IP \(bu 2.3
2002 .\}
2003 \fIconfigFile\fR
2004 \- the location of the global
2005 smb\&.conf
2006 file\&.
2007 .RE
2008 .sp
2009 .RS 4
2010 .ie n \{\
2011 \h'-04'\(bu\h'+03'\c
2012 .\}
2013 .el \{\
2014 .sp -1
2015 .IP \(bu 2.3
2016 .\}
2017 \fIshareName\fR
2018 \- the name of the new share\&.
2019 .RE
2020 .sp
2021 .RS 4
2022 .ie n \{\
2023 \h'-04'\(bu\h'+03'\c
2024 .\}
2025 .el \{\
2026 .sp -1
2027 .IP \(bu 2.3
2028 .\}
2029 \fIpathName\fR
2030 \- path to an **existing** directory on disk\&.
2031 .RE
2032 .sp
2033 .RS 4
2034 .ie n \{\
2035 \h'-04'\(bu\h'+03'\c
2036 .\}
2037 .el \{\
2038 .sp -1
2039 .IP \(bu 2.3
2040 .\}
2041 \fIcomment\fR
2042 \- comment string to associate with the new share\&.
2043 .RE
2044 .sp
2045 .RS 4
2046 .ie n \{\
2047 \h'-04'\(bu\h'+03'\c
2048 .\}
2049 .el \{\
2050 .sp -1
2051 .IP \(bu 2.3
2052 .\}
2053 \fImax connections\fR
2054 Number of maximum simultaneous connections to this share\&.
2055 .RE
2056 .sp
2057 .RS 4
2058 .ie n \{\
2059 \h'-04'\(bu\h'+03'\c
2060 .\}
2061 .el \{\
2062 .sp -1
2063 .IP \(bu 2.3
2064 .\}
2065 \fICSC policy\fR
2066 \- client side caching policy in string form\&. Valid values are: manual, documents, programs, disable\&.
2067 .RE
2068 .sp
2069 .RE
2070 This parameter is only used to modify existing file share definitions\&. To modify printer shares, use the "Printers\&.\&.\&." folder as seen when browsing the Samba host\&.
2071 .sp
2072 Default:
2073 \fI\fIchange share command\fR\fR\fI = \fR\fI\fR\fI \fR
2074 .sp
2075 Example:
2076 \fI\fIchange share command\fR\fR\fI = \fR\fI/usr/local/bin/changeshare\fR\fI \fR
2077 .RE
2078
2079 check parent directory delete on close (S)
2080 .PP
2081 .RS 4
2082 A Windows SMB server prevents the client from creating files in a directory that has the delete\-on\-close flag set\&. By default Samba doesn\*(Aqt perform this check as this check is a quite expensive operation in Samba\&.
2083 .sp
2084 Default:
2085 \fI\fIcheck parent directory delete on close\fR\fR\fI = \fR\fIno\fR\fI \fR
2086 .RE
2087
2088 check password script (G)
2089 .PP
2090 .RS 4
2091 The name of a program that can be used to check password complexity\&. The password is sent to the program\*(Aqs standard input\&.
2092 .sp
2093 The program must return 0 on a good password, or any other value if the password is bad\&. In case the password is considered weak (the program does not return 0) the user will be notified and the password change will fail\&.
2094 .sp
2095 In Samba AD, this script will be run
2096 \fIAS ROOT\fR
2097 by
2098 \fBsamba\fR(8)
2099 without any substitutions\&.
2100 .sp
2101 Note that starting with Samba 4\&.11 the following environment variables are exported to the script:
2102 .RS
2103 .sp
2104 .RS 4
2105 .ie n \{\
2106 \h'-04'\(bu\h'+03'\c
2107 .\}
2108 .el \{\
2109 .sp -1
2110 .IP \(bu 2.3
2111 .\}
2112 SAMBA_CPS_ACCOUNT_NAME is always present and contains the sAMAccountName of user\&. It is the same as the \*(Aq%u\*(Aq substitutions in the non AD DC case\&.
2113 .RE
2114 .sp
2115 .RS 4
2116 .ie n \{\
2117 \h'-04'\(bu\h'+03'\c
2118 .\}
2119 .el \{\
2120 .sp -1
2121 .IP \(bu 2.3
2122 .\}
2123 SAMBA_CPS_USER_PRINCIPAL_NAME is optional in the AD DC case if the userPrincipalName is present\&.
2124 .RE
2125 .sp
2126 .RS 4
2127 .ie n \{\
2128 \h'-04'\(bu\h'+03'\c
2129 .\}
2130 .el \{\
2131 .sp -1
2132 .IP \(bu 2.3
2133 .\}
2134 SAMBA_CPS_FULL_NAME is optional if the displayName is present\&.
2135 .RE
2136 .sp
2137 .RE
2138 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\&.
2139 .sp
2140 Note: In the example directory is a sample program called
2141 crackcheck
2142 that uses cracklib to check the password quality\&.
2143 .sp
2144 Default:
2145 \fI\fIcheck password script\fR\fR\fI = \fR\fI # Disabled\fR\fI \fR
2146 .sp
2147 Example:
2148 \fI\fIcheck password script\fR\fR\fI = \fR\fI/usr/local/sbin/crackcheck\fR\fI \fR
2149 .RE
2150
2151 client ipc max protocol (G)
2152 .PP
2153 .RS 4
2154 The value of the parameter (a string) is the highest protocol level that will be supported for IPC$ connections as DCERPC transport\&.
2155 .sp
2156 Normally this option should not be set as the automatic negotiation phase in the SMB protocol takes care of choosing the appropriate protocol\&.
2157 .sp
2158 The value
2159 \fBdefault\fR
2160 refers to the latest supported protocol, currently
2161 \fBSMB3_11\fR\&.
2162 .sp
2163 See
2164 \m[blue]\fBclient max protocol\fR\m[]
2165 for a full list of available protocols\&. The values CORE, COREPLUS, LANMAN1, LANMAN2 are silently upgraded to NT1\&.
2166 .sp
2167 Default:
2168 \fI\fIclient ipc max protocol\fR\fR\fI = \fR\fIdefault\fR\fI \fR
2169 .sp
2170 Example:
2171 \fI\fIclient ipc max protocol\fR\fR\fI = \fR\fISMB2_10\fR\fI \fR
2172 .RE
2173
2174 client ipc min protocol (G)
2175 .PP
2176 .RS 4
2177 This setting controls the minimum protocol version that the will be attempted to use for IPC$ connections as DCERPC transport\&.
2178 .sp
2179 Normally this option should not be set as the automatic negotiation phase in the SMB protocol takes care of choosing the appropriate protocol\&.
2180 .sp
2181 The value
2182 \fBdefault\fR
2183 refers to the higher value of
2184 \fBNT1\fR
2185 and the effective value of
2186 \m[blue]\fBclient min protocol\fR\m[]\&.
2187 .sp
2188 See
2189 \m[blue]\fBclient max protocol\fR\m[]
2190 for a full list of available protocols\&. The values CORE, COREPLUS, LANMAN1, LANMAN2 are silently upgraded to NT1\&.
2191 .sp
2192 Default:
2193 \fI\fIclient ipc min protocol\fR\fR\fI = \fR\fIdefault\fR\fI \fR
2194 .sp
2195 Example:
2196 \fI\fIclient ipc min protocol\fR\fR\fI = \fR\fISMB3_11\fR\fI \fR
2197 .RE
2198
2199 client ipc signing (G)
2200 .PP
2201 .RS 4
2202 This controls whether the client is allowed or required to use SMB signing for IPC$ connections as DCERPC transport\&. Possible values are
2203 \fIdesired\fR,
2204 \fIrequired\fR
2205 and
2206 \fIdisabled\fR\&.
2207 .sp
2208 When set to required or default, SMB signing is mandatory\&.
2209 .sp
2210 When set to desired, SMB signing is offered, but not enforced and if set to disabled, SMB signing is not offered either\&.
2211 .sp
2212 Connections from winbindd to Active Directory Domain Controllers always enforce signing\&.
2213 .sp
2214 Default:
2215 \fI\fIclient ipc signing\fR\fR\fI = \fR\fIdefault\fR\fI \fR
2216 .RE
2217
2218 client lanman auth (G)
2219 .PP
2220 .RS 4
2221 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\&.
2222 .sp
2223 That is, in the future, the current default of
2224 client NTLMv2 auth = yes
2225 will be the enforced behaviour\&.
2226 .sp
2227 This parameter determines whether or not
2228 \fBsmbclient\fR(8)
2229 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\&.
2230 .sp
2231 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\&.
2232 .sp
2233 Disabling this option will also disable the
2234 client plaintext auth
2235 option\&.
2236 .sp
2237 Likewise, if the
2238 client ntlmv2 auth
2239 parameter is enabled, then only NTLMv2 logins will be attempted\&.
2240 .sp
2241 Default:
2242 \fI\fIclient lanman auth\fR\fR\fI = \fR\fIno\fR\fI \fR
2243 .RE
2244
2245 client ldap sasl wrapping (G)
2246 .PP
2247 .RS 4
2248 The
2249 \m[blue]\fBclient ldap sasl wrapping\fR\m[]
2250 defines whether ldap traffic will be signed or signed and encrypted (sealed)\&. Possible values are
2251 \fIplain\fR,
2252 \fIsign\fR
2253 and
2254 \fIseal\fR\&.
2255 .sp
2256 The values
2257 \fIsign\fR
2258 and
2259 \fIseal\fR
2260 are only available if Samba has been compiled against a modern OpenLDAP version (2\&.3\&.x or higher)\&.
2261 .sp
2262 This option is needed firstly to secure the privacy of administrative connections from
2263 samba\-tool, including in particular new or reset passwords for users\&. For this reason the default is
2264 \fIseal\fR\&.
2265 .sp
2266 Additionally,
2267 winbindd
2268 and the
2269 net
2270 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
2271 \fIsign\fR
2272 is required in practice\&.
2273 .sp
2274 The default value is
2275 \fIseal\fR\&. That implies synchronizing the time with the KDC in the case of using
2276 \fIKerberos\fR\&.
2277 .sp
2278 In order to force using LDAP (on port 389) with STARTTLS or LDAPS (on port 636), it is possible to use
2279 \fIstarttls\fR
2280 or
2281 \fIldaps\fR\&. In that case the NTLMSSP or Kerberos authentication using the TLS channel bindings in order to glue it to the connection\&.
2282 .sp
2283 Default:
2284 \fI\fIclient ldap sasl wrapping\fR\fR\fI = \fR\fIseal\fR\fI \fR
2285 .RE
2286
2287 client max protocol (G)
2288 .PP
2289 .RS 4
2290 The value of the parameter (a string) is the highest protocol level that will be supported by the client\&.
2291 .sp
2292 Possible values are :
2293 .RS
2294 .sp
2295 .RS 4
2296 .ie n \{\
2297 \h'-04'\(bu\h'+03'\c
2298 .\}
2299 .el \{\
2300 .sp -1
2301 .IP \(bu 2.3
2302 .\}
2303 \fBCORE\fR: Earliest version\&. No concept of user names\&.
2304 .RE
2305 .sp
2306 .RS 4
2307 .ie n \{\
2308 \h'-04'\(bu\h'+03'\c
2309 .\}
2310 .el \{\
2311 .sp -1
2312 .IP \(bu 2.3
2313 .\}
2314 \fBCOREPLUS\fR: Slight improvements on CORE for efficiency\&.
2315 .RE
2316 .sp
2317 .RS 4
2318 .ie n \{\
2319 \h'-04'\(bu\h'+03'\c
2320 .\}
2321 .el \{\
2322 .sp -1
2323 .IP \(bu 2.3
2324 .\}
2325 \fBLANMAN1\fR: First
2326 \fImodern\fR
2327 version of the protocol\&. Long filename support\&.
2328 .RE
2329 .sp
2330 .RS 4
2331 .ie n \{\
2332 \h'-04'\(bu\h'+03'\c
2333 .\}
2334 .el \{\
2335 .sp -1
2336 .IP \(bu 2.3
2337 .\}
2338 \fBLANMAN2\fR: Updates to Lanman1 protocol\&.
2339 .RE
2340 .sp
2341 .RS 4
2342 .ie n \{\
2343 \h'-04'\(bu\h'+03'\c
2344 .\}
2345 .el \{\
2346 .sp -1
2347 .IP \(bu 2.3
2348 .\}
2349 \fBNT1\fR: Current up to date version of the protocol\&. Used by Windows NT\&. Known as CIFS\&.
2350 .RE
2351 .sp
2352 .RS 4
2353 .ie n \{\
2354 \h'-04'\(bu\h'+03'\c
2355 .\}
2356 .el \{\
2357 .sp -1
2358 .IP \(bu 2.3
2359 .\}
2360 \fBSMB2\fR: Re\-implementation of the SMB protocol\&. Used by Windows Vista and later versions of Windows\&. SMB2 has sub protocols available\&.
2361 .RS
2362 .sp
2363 .RS 4
2364 .ie n \{\
2365 \h'-04'\(bu\h'+03'\c
2366 .\}
2367 .el \{\
2368 .sp -1
2369 .IP \(bu 2.3
2370 .\}
2371 \fBSMB2_02\fR: The earliest SMB2 version\&.
2372 .RE
2373 .sp
2374 .RS 4
2375 .ie n \{\
2376 \h'-04'\(bu\h'+03'\c
2377 .\}
2378 .el \{\
2379 .sp -1
2380 .IP \(bu 2.3
2381 .\}
2382 \fBSMB2_10\fR: Windows 7 SMB2 version\&.
2383 .RE
2384 .sp
2385 .RE
2386 By default SMB2 selects the SMB2_10 variant\&.
2387 .RE
2388 .sp
2389 .RS 4
2390 .ie n \{\
2391 \h'-04'\(bu\h'+03'\c
2392 .\}
2393 .el \{\
2394 .sp -1
2395 .IP \(bu 2.3
2396 .\}
2397 \fBSMB3\fR: The same as SMB2\&. Used by Windows 8\&. SMB3 has sub protocols available\&.
2398 .RS
2399 .sp
2400 .RS 4
2401 .ie n \{\
2402 \h'-04'\(bu\h'+03'\c
2403 .\}
2404 .el \{\
2405 .sp -1
2406 .IP \(bu 2.3
2407 .\}
2408 \fBSMB3_00\fR: Windows 8 SMB3 version\&.
2409 .RE
2410 .sp
2411 .RS 4
2412 .ie n \{\
2413 \h'-04'\(bu\h'+03'\c
2414 .\}
2415 .el \{\
2416 .sp -1
2417 .IP \(bu 2.3
2418 .\}
2419 \fBSMB3_02\fR: Windows 8\&.1 SMB3 version\&.
2420 .RE
2421 .sp
2422 .RS 4
2423 .ie n \{\
2424 \h'-04'\(bu\h'+03'\c
2425 .\}
2426 .el \{\
2427 .sp -1
2428 .IP \(bu 2.3
2429 .\}
2430 \fBSMB3_11\fR: Windows 10 SMB3 version\&.
2431 .RE
2432 .sp
2433 .RE
2434 By default SMB3 selects the SMB3_11 variant\&.
2435 .RE
2436 .sp
2437 .RE
2438 Normally this option should not be set as the automatic negotiation phase in the SMB protocol takes care of choosing the appropriate protocol\&.
2439 .sp
2440 The value
2441 \fBdefault\fR
2442 refers to
2443 \fBSMB3_11\fR\&.
2444 .sp
2445 IPC$ connections for DCERPC e\&.g\&. in winbindd, are handled by the
2446 \m[blue]\fBclient ipc max protocol\fR\m[]
2447 option\&.
2448 .sp
2449 Default:
2450 \fI\fIclient max protocol\fR\fR\fI = \fR\fIdefault\fR\fI \fR
2451 .sp
2452 Example:
2453 \fI\fIclient max protocol\fR\fR\fI = \fR\fILANMAN1\fR\fI \fR
2454 .RE
2455
2456 client min protocol (G)
2457 .PP
2458 .RS 4
2459 This setting controls the minimum protocol version that the client will attempt to use\&.
2460 .sp
2461 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\&.
2462 .sp
2463 See
2464 Related command: \m[blue]\fBclient max protocol\fR\m[]
2465 for a full list of available protocols\&.
2466 .sp
2467 IPC$ connections for DCERPC e\&.g\&. in winbindd, are handled by the
2468 \m[blue]\fBclient ipc min protocol\fR\m[]
2469 option\&.
2470 .sp
2471 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\&.
2472 .sp
2473 Default:
2474 \fI\fIclient min protocol\fR\fR\fI = \fR\fISMB2_02\fR\fI \fR
2475 .sp
2476 Example:
2477 \fI\fIclient min protocol\fR\fR\fI = \fR\fINT1\fR\fI \fR
2478 .RE
2479
2480 client netlogon ping protocol (G)
2481 .PP
2482 .RS 4
2483 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\&.
2484 .sp
2485 Possible values are :
2486 .RS
2487 .sp
2488 .RS 4
2489 .ie n \{\
2490 \h'-04'\(bu\h'+03'\c
2491 .\}
2492 .el \{\
2493 .sp -1
2494 .IP \(bu 2.3
2495 .\}
2496 \fBCLDAP\fR
2497 .RE
2498 .sp
2499 .RS 4
2500 .ie n \{\
2501 \h'-04'\(bu\h'+03'\c
2502 .\}
2503 .el \{\
2504 .sp -1
2505 .IP \(bu 2.3
2506 .\}
2507 \fBLDAP\fR
2508 .RE
2509 .sp
2510 .RS 4
2511 .ie n \{\
2512 \h'-04'\(bu\h'+03'\c
2513 .\}
2514 .el \{\
2515 .sp -1
2516 .IP \(bu 2.3
2517 .\}
2518 \fBLDAPS\fR
2519 .RE
2520 .sp
2521 .RS 4
2522 .ie n \{\
2523 \h'-04'\(bu\h'+03'\c
2524 .\}
2525 .el \{\
2526 .sp -1
2527 .IP \(bu 2.3
2528 .\}
2529 \fBSTARTTLS\fR
2530 .RE
2531 .sp
2532 .RE
2533 Default:
2534 \fI\fIclient netlogon ping protocol\fR\fR\fI = \fR\fICLDAP\fR\fI \fR
2535 .RE
2536
2537 client NTLMv2 auth (G)
2538 .PP
2539 .RS 4
2540 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\&.
2541 .sp
2542 That is, in the future, the current default of
2543 client NTLMv2 auth = yes
2544 will be the enforced behaviour\&.
2545 .sp
2546 This parameter determines whether or not
2547 \fBsmbclient\fR(8)
2548 will attempt to authenticate itself to servers using the NTLMv2 encrypted password response\&.
2549 .sp
2550 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
2551 .sp
2552 Similarly, if enabled, NTLMv1,
2553 client lanman auth
2554 and
2555 client plaintext auth
2556 authentication will be disabled\&. This also disables share\-level authentication\&.
2557 .sp
2558 If disabled, an NTLM response (and possibly a LANMAN response) will be sent by the client, depending on the value of
2559 client lanman auth\&.
2560 .sp
2561 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\&.
2562 .sp
2563 When
2564 \m[blue]\fBclient use spnego\fR\m[]
2565 is also set to
2566 \fByes\fR
2567 extended security (SPNEGO) is required in order to use NTLMv2 only within NTLMSSP\&. This behavior was introduced with the patches for CVE\-2016\-2111\&.
2568 .sp
2569 Default:
2570 \fI\fIclient NTLMv2 auth\fR\fR\fI = \fR\fIyes\fR\fI \fR
2571 .RE
2572
2573 client plaintext auth (G)
2574 .PP
2575 .RS 4
2576 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\&.
2577 .sp
2578 That is, in the future, the current default of
2579 client plaintext auth = no
2580 will be the enforced behaviour\&.
2581 .sp
2582 Specifies whether a client should send a plaintext password if the server does not support encrypted passwords\&.
2583 .sp
2584 Default:
2585 \fI\fIclient plaintext auth\fR\fR\fI = \fR\fIno\fR\fI \fR
2586 .RE
2587
2588 client protection (G)
2589 .PP
2590 .RS 4
2591 This parameter defines which protection Samba client tools should use by default\&.
2592 .sp
2593 Possible client settings are:
2594 .RS
2595 .sp
2596 .RS 4
2597 .ie n \{\
2598 \h'-04'\(bu\h'+03'\c
2599 .\}
2600 .el \{\
2601 .sp -1
2602 .IP \(bu 2.3
2603 .\}
2604 \fIdefault\fR
2605 \- Use the individual default values of the options:
2606 .RS
2607 .sp
2608 .RS 4
2609 .ie n \{\
2610 \h'-04'\(bu\h'+03'\c
2611 .\}
2612 .el \{\
2613 .sp -1
2614 .IP \(bu 2.3
2615 .\}
2616 \fIclient signing\fR
2617 .RE
2618 .sp
2619 .RS 4
2620 .ie n \{\
2621 \h'-04'\(bu\h'+03'\c
2622 .\}
2623 .el \{\
2624 .sp -1
2625 .IP \(bu 2.3
2626 .\}
2627 \fIclient smb encrypt\fR
2628 .RE
2629 .sp
2630 .RE
2631 .RE
2632 .sp
2633 .RS 4
2634 .ie n \{\
2635 \h'-04'\(bu\h'+03'\c
2636 .\}
2637 .el \{\
2638 .sp -1
2639 .IP \(bu 2.3
2640 .\}
2641 \fIplain\fR
2642 \- This will send everything just as plaintext, signing or encryption are turned off\&.
2643 .RE
2644 .sp
2645 .RS 4
2646 .ie n \{\
2647 \h'-04'\(bu\h'+03'\c
2648 .\}
2649 .el \{\
2650 .sp -1
2651 .IP \(bu 2.3
2652 .\}
2653 \fIsign\fR
2654 \- This will enable integrity checking\&.
2655 .RE
2656 .sp
2657 .RS 4
2658 .ie n \{\
2659 \h'-04'\(bu\h'+03'\c
2660 .\}
2661 .el \{\
2662 .sp -1
2663 .IP \(bu 2.3
2664 .\}
2665 \fIencrypt\fR
2666 \- This will enable integrity checks and force encryption for privacy\&.
2667 .RE
2668 .sp
2669 .RE
2670 Default:
2671 \fI\fIclient protection\fR\fR\fI = \fR\fIdefault\fR\fI \fR
2672 .RE
2673
2674 client schannel (G)
2675 .PP
2676 .RS 4
2677 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\&.
2678 .sp
2679 This controls whether the client offers or even demands the use of the netlogon schannel\&.
2680 \m[blue]\fBclient schannel = no\fR\m[]
2681 does not offer the schannel,
2682 \m[blue]\fBclient schannel = auto\fR\m[]
2683 offers the schannel but does not enforce it, and
2684 \m[blue]\fBclient schannel = yes\fR\m[]
2685 denies access if the server is not able to speak netlogon schannel\&.
2686 .sp
2687 Note that for active directory domains this is hardcoded to
2688 \m[blue]\fBclient schannel = yes\fR\m[]\&.
2689 .sp
2690 This option is over\-ridden by the
2691 \m[blue]\fBrequire strong key\fR\m[]
2692 option\&.
2693 .sp
2694 Default:
2695 \fI\fIclient schannel\fR\fR\fI = \fR\fIyes\fR\fI \fR
2696 .sp
2697 Example:
2698 \fI\fIclient schannel\fR\fR\fI = \fR\fIauto\fR\fI \fR
2699 .RE
2700
2701 client signing (G)
2702 .PP
2703 .RS 4
2704 This controls whether the client is allowed or required to use SMB signing\&. Possible values are
2705 \fIdesired\fR,
2706 \fIrequired\fR
2707 and
2708 \fIdisabled\fR\&.
2709 .sp
2710 When set to desired or default, SMB signing is offered, but not enforced\&.
2711 .sp
2712 When set to required, SMB signing is mandatory and if set to disabled, SMB signing is not offered either\&.
2713 .sp
2714 IPC$ connections for DCERPC e\&.g\&. in winbindd, are handled by the
2715 \m[blue]\fBclient ipc signing\fR\m[]
2716 option\&.
2717 .sp
2718 Default:
2719 \fI\fIclient signing\fR\fR\fI = \fR\fIdefault\fR\fI \fR
2720 .RE
2721
2722 client smb encrypt (G)
2723 .PP
2724 .RS 4
2725 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:
2726 .RS
2727 .sp
2728 .RS 4
2729 .ie n \{\
2730 \h'-04'\(bu\h'+03'\c
2731 .\}
2732 .el \{\
2733 .sp -1
2734 .IP \(bu 2.3
2735 .\}
2736 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\&.
2737 .RE
2738 .sp
2739 .RS 4
2740 .ie n \{\
2741 \h'-04'\(bu\h'+03'\c
2742 .\}
2743 .el \{\
2744 .sp -1
2745 .IP \(bu 2.3
2746 .\}
2747 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\&.
2748 .RE
2749 .sp
2750 .RE
2751 This parameter can be set globally\&. Possible values are
2752 \fIoff\fR,
2753 \fIif_required\fR,
2754 \fIdesired\fR, and
2755 \fIrequired\fR\&. A special value is
2756 \fIdefault\fR
2757 which is the implicit default setting of
2758 \fIif_required\fR\&.
2759 .PP
2760 \fIEffects for SMB1\fR
2761 .RS 4
2762 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\&.
2763 .sp
2764 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\&.
2765 .RE
2766 .PP
2767 \fIEffects for SMB3 and newer\fR
2768 .RS 4
2769 Native SMB transport encryption is available in SMB version 3\&.0 or newer\&. It is only used by Samba if
2770 \fIclient max protocol\fR
2771 is set to
2772 \fISMB3\fR
2773 or newer\&.
2774 .sp
2775 These features can be controlled with settings of
2776 \fIclient smb encrypt\fR
2777 as follows:
2778 .RS
2779 .sp
2780 .RS 4
2781 .ie n \{\
2782 \h'-04'\(bu\h'+03'\c
2783 .\}
2784 .el \{\
2785 .sp -1
2786 .IP \(bu 2.3
2787 .\}
2788 Leaving it as default, explicitly setting
2789 \fIdefault\fR, or setting it to
2790 \fIif_required\fR
2791 globally will enable negotiation of encryption but will not turn on data encryption globally\&.
2792 .RE
2793 .sp
2794 .RS 4
2795 .ie n \{\
2796 \h'-04'\(bu\h'+03'\c
2797 .\}
2798 .el \{\
2799 .sp -1
2800 .IP \(bu 2.3
2801 .\}
2802 Setting it to
2803 \fIdesired\fR
2804 globally will enable negotiation and will turn on data encryption on sessions and share connections for those servers that support it\&.
2805 .RE
2806 .sp
2807 .RS 4
2808 .ie n \{\
2809 \h'-04'\(bu\h'+03'\c
2810 .\}
2811 .el \{\
2812 .sp -1
2813 .IP \(bu 2.3
2814 .\}
2815 Setting it to
2816 \fIrequired\fR
2817 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\&.
2818 .RE
2819 .sp
2820 .RS 4
2821 .ie n \{\
2822 \h'-04'\(bu\h'+03'\c
2823 .\}
2824 .el \{\
2825 .sp -1
2826 .IP \(bu 2.3
2827 .\}
2828 Setting it to
2829 \fIoff\fR
2830 globally will completely disable the encryption feature for all connections\&.
2831 .RE
2832 .sp
2833 .RE
2834 .RE
2835 .sp
2836 Default:
2837 \fI\fIclient smb encrypt\fR\fR\fI = \fR\fIdefault\fR\fI \fR
2838 .RE
2839
2840 client smb3 encryption algorithms (G)
2841 .PP
2842 .RS 4
2843 This parameter specifies the availability and order of encryption algorithms which are available for negotiation in the SMB3_11 dialect\&.
2844 .sp
2845 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\&.
2846 .sp
2847 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\&.
2848 .sp
2849 Default:
2850 \fI\fIclient smb3 encryption algorithms\fR\fR\fI = \fR\fIAES\-128\-GCM, AES\-128\-CCM, AES\-256\-GCM, AES\-256\-CCM\fR\fI \fR
2851 .sp
2852 Example:
2853 \fI\fIclient smb3 encryption algorithms\fR\fR\fI = \fR\fIAES\-256\-GCM\fR\fI \fR
2854 .sp
2855 Example:
2856 \fI\fIclient smb3 encryption algorithms\fR\fR\fI = \fR\fI\-AES\-128\-GCM \-AES\-128\-CCM\fR\fI \fR
2857 .RE
2858
2859 client smb3 signing algorithms (G)
2860 .PP
2861 .RS 4
2862 This parameter specifies the availability and order of signing algorithms which are available for negotiation in the SMB3_11 dialect\&.
2863 .sp
2864 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\&.
2865 .sp
2866 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\&.
2867 .sp
2868 Default:
2869 \fI\fIclient smb3 signing algorithms\fR\fR\fI = \fR\fIAES\-128\-GMAC, AES\-128\-CMAC, HMAC\-SHA256\fR\fI \fR
2870 .sp
2871 Example:
2872 \fI\fIclient smb3 signing algorithms\fR\fR\fI = \fR\fIAES\-128\-CMAC, HMAC\-SHA256\fR\fI \fR
2873 .sp
2874 Example:
2875 \fI\fIclient smb3 signing algorithms\fR\fR\fI = \fR\fI\-AES\-128\-CMAC\fR\fI \fR
2876 .RE
2877
2878 client smb transports (G)
2879 .PP
2880 .RS 4
2881 Specifies which transports and ports the client should try to connect to for SMB traffic\&.
2882 .sp
2883 The order matters as they are tried in order with short delays for the fallbacks\&.
2884 .sp
2885 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\&.
2886 .sp
2887 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\&.
2888 .sp
2889 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:
2890 \m[blue]\fBtls enabled\fR\m[],
2891 \m[blue]\fBtls ca directories\fR\m[],
2892 \m[blue]\fBtls trust system cas\fR\m[],
2893 \m[blue]\fBtls cafile\fR\m[],
2894 \m[blue]\fBtls certfile\fR\m[],
2895 \m[blue]\fBtls keyfile\fR\m[]
2896 and
2897 \m[blue]\fBtls verify peer\fR\m[]\&.
2898 .sp
2899 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\&.
2900 .sp
2901 Numerical ports are handled as \*(Aqtcp\*(Aq except port \*(Aq139\*(Aq is handled as \*(Aqnbt\*(Aq\&.
2902 .sp
2903 Note that\*(Aqs currently a limit of 10 unique transports, all others will be ignored\&.
2904 .sp
2905 Default:
2906 \fI\fIclient smb transports\fR\fR\fI = \fR\fItcp, nbt\fR\fI \fR
2907 .sp
2908 Example:
2909 \fI\fIclient smb transports\fR\fR\fI = \fR\fI445\fR\fI \fR
2910 .sp
2911 Example:
2912 \fI\fIclient smb transports\fR\fR\fI = \fR\fItcp, tcp:1445\fR\fI \fR
2913 .sp
2914 Example:
2915 \fI\fIclient smb transports\fR\fR\fI = \fR\fI8000, nbt:1139\fR\fI \fR
2916 .sp
2917 Example:
2918 \fI\fIclient smb transports\fR\fR\fI = \fR\fItcp, quic, nbt\fR\fI \fR
2919 .sp
2920 Example:
2921 \fI\fIclient smb transports\fR\fR\fI = \fR\fI+quic\fR\fI \fR
2922 .RE
2923
2924 client use kerberos (G)
2925 .PP
2926 .RS 4
2927 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\&.
2928 .sp
2929 Possible option settings are:
2930 .RS
2931 .sp
2932 .RS 4
2933 .ie n \{\
2934 \h'-04'\(bu\h'+03'\c
2935 .\}
2936 .el \{\
2937 .sp -1
2938 .IP \(bu 2.3
2939 .\}
2940 \fIdesired\fR
2941 \- Kerberos authentication will be tried first and if it fails it automatically fallback to NTLM\&.
2942 .RE
2943 .sp
2944 .RS 4
2945 .ie n \{\
2946 \h'-04'\(bu\h'+03'\c
2947 .\}
2948 .el \{\
2949 .sp -1
2950 .IP \(bu 2.3
2951 .\}
2952 \fIrequired\fR
2953 \- Kerberos authentication will be required\&. There will be no fallback to NTLM or a different alternative\&.
2954 .RE
2955 .sp
2956 .RS 4
2957 .ie n \{\
2958 \h'-04'\(bu\h'+03'\c
2959 .\}
2960 .el \{\
2961 .sp -1
2962 .IP \(bu 2.3
2963 .\}
2964 \fIoff\fR
2965 \- Don\*(Aqt use Kerberos, use NTLM instead or another alternative\&.
2966 .RE
2967 .sp
2968 .RE
2969 In case that weak cryptography is not allowed (e\&.g\&. FIPS mode) the default will be forced to
2970 \fIrequired\fR\&.
2971 .sp
2972 Default:
2973 \fI\fIclient use kerberos\fR\fR\fI = \fR\fIdesired\fR\fI \fR
2974 .RE
2975
2976 client use krb5 netlogon (G)
2977 .PP
2978 .RS 4
2979 \fIThis option is experimental for now!\fR
2980 .sp
2981 This option controls whether winbindd (and other client tools) try to use ServerAuthenticateKerberos for the netlogon secure channel\&.
2982 .sp
2983 The behavior can be controlled per netbios domain by using \*(Aqclient use krb5 netlogon:NETBIOSDOMAIN = yes|no\*(Aq as option\&.
2984 .sp
2985 This option is over\-ridden by the
2986 \m[blue]\fBreject aes netlogon servers\fR\m[]
2987 option (if it is effectively on) and lets
2988 \m[blue]\fBclient use krb5 netlogon\fR\m[]
2989 be yes as well\&.
2990 .sp
2991 The \*(Aqdefault\*(Aq currently maps to \*(Aqno\*(Aq\&.
2992 .sp
2993 A meaning of \*(Aqauto\*(Aq depends on the used kerberos library and the trust/domain type\&.
2994 .sp
2995 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\&.
2996 .sp
2997 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\&.
2998 .sp
2999 \fI WARNING: This option is experimental in this Samba version (see VERSION section below) and should not be used in production! \fR
3000 .sp
3001 Default:
3002 \fI\fIclient use krb5 netlogon\fR\fR\fI = \fR\fIdefault\fR\fI \fR
3003 .sp
3004 Example:
3005 \fI\fIclient use krb5 netlogon\fR\fR\fI = \fR\fIno\fR\fI \fR
3006 .sp
3007 Example:
3008 \fI\fIclient use krb5 netlogon\fR\fR\fI = \fR\fIauto\fR\fI \fR
3009 .sp
3010 Example:
3011 \fI\fIclient use krb5 netlogon\fR\fR\fI = \fR\fIyes\fR\fI \fR
3012 .RE
3013
3014 client use spnego (G)
3015 .PP
3016 .RS 4
3017 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\&.
3018 .sp
3019 That is, in the future, the current default of
3020 client use spnego = yes
3021 will be the enforced behaviour\&.
3022 .sp
3023 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\&.
3024 .sp
3025 When
3026 \m[blue]\fBclient NTLMv2 auth\fR\m[]
3027 is also set to
3028 \fByes\fR
3029 extended security (SPNEGO) is required in order to use NTLMv2 only within NTLMSSP\&. This behavior was introduced with the patches for CVE\-2016\-2111\&.
3030 .sp
3031 Default:
3032 \fI\fIclient use spnego\fR\fR\fI = \fR\fIyes\fR\fI \fR
3033 .RE
3034
3035 cluster addresses (G)
3036 .PP
3037 .RS 4
3038 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
3039 \fInet ads dns register\fR
3040 is called with
3041 \m[blue]\fBclustering = yes\fR\m[]
3042 configured\&.
3043 .sp
3044 Default:
3045 \fI\fIcluster addresses\fR\fR\fI = \fR\fI\fR\fI \fR
3046 .sp
3047 Example:
3048 \fI\fIcluster addresses\fR\fR\fI = \fR\fI10\&.0\&.0\&.1 10\&.0\&.0\&.2 10\&.0\&.0\&.3\fR\fI \fR
3049 .RE
3050
3051 clustering (G)
3052 .PP
3053 .RS 4
3054 This parameter specifies whether Samba should contact ctdb for accessing its tdb files and use ctdb as a backend for its messaging backend\&.
3055 .sp
3056 Set this parameter to
3057 yes
3058 only if you have a cluster setup with ctdb running\&.
3059 .sp
3060 Default:
3061 \fI\fIclustering\fR\fR\fI = \fR\fIno\fR\fI \fR
3062 .RE
3063
3064 comment (S)
3065 .PP
3066 .RS 4
3067 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
3068 net view
3069 to list what shares are available\&.
3070 .sp
3071 If you want to set the string that is displayed next to the machine name then see the
3072 \m[blue]\fBserver string\fR\m[]
3073 parameter\&.
3074 .sp
3075 Default:
3076 \fI\fIcomment\fR\fR\fI = \fR\fI # No comment\fR\fI \fR
3077 .sp
3078 Example:
3079 \fI\fIcomment\fR\fR\fI = \fR\fIFred\*(Aqs Files\fR\fI \fR
3080 .RE
3081
3082 config backend (G)
3083 .PP
3084 .RS 4
3085 This controls the backend for storing the configuration\&. Possible values are
3086 \fIfile\fR
3087 (the default) and
3088 \fIregistry\fR\&. When
3089 \m[blue]\fBconfig backend = registry\fR\m[]
3090 is encountered while loading
3091 \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
3092 \fIregistry shares\fR
3093 is set to
3094 \fIyes\fR\&.
3095 .sp
3096 Note: This option can not be set inside the registry configuration itself\&.
3097 .sp
3098 Default:
3099 \fI\fIconfig backend\fR\fR\fI = \fR\fIfile\fR\fI \fR
3100 .sp
3101 Example:
3102 \fI\fIconfig backend\fR\fR\fI = \fR\fIregistry\fR\fI \fR
3103 .RE
3104
3105 config file (G)
3106 .PP
3107 .RS 4
3108 This allows you to override the config file to use, instead of the default (usually
3109 smb\&.conf)\&. There is a chicken and egg problem here as this option is set in the config file!
3110 .sp
3111 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\&.
3112 .sp
3113 This option takes the usual substitutions, which can be very useful\&.
3114 .sp
3115 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)\&.
3116 .sp
3117 \fINo default\fR
3118 .sp
3119 Example:
3120 \fI\fIconfig file\fR\fR\fI = \fR\fI/usr/local/samba/lib/smb\&.conf\&.%m\fR\fI \fR
3121 .RE
3122
3123 copy (S)
3124 .PP
3125 .RS 4
3126 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\&.
3127 .sp
3128 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\&.
3129 .sp
3130 Default:
3131 \fI\fIcopy\fR\fR\fI = \fR\fI\fR\fI \fR
3132 .sp
3133 Example:
3134 \fI\fIcopy\fR\fR\fI = \fR\fIotherservice\fR\fI \fR
3135 .RE
3136
3137 create krb5 conf (G)
3138 .PP
3139 .RS 4
3140 Setting this parameter to
3141 no
3142 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\&.
3143 .sp
3144 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\&.
3145 .sp
3146 Default:
3147 \fI\fIcreate krb5 conf\fR\fR\fI = \fR\fIyes\fR\fI \fR
3148 .RE
3149
3150 create mode
3151 .PP
3152 .RS 4
3153 This parameter is a synonym for
3154 create mask\&.
3155 .RE
3156
3157 create mask (S)
3158 .PP
3159 .RS 4
3160 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
3161 \fInot\fR
3162 set here will be removed from the modes set on a file when it is created\&.
3163 .sp
3164 The default value of this parameter removes the
3165 group
3166 and
3167 other
3168 write and execute bits from the UNIX modes\&.
3169 .sp
3170 Following this Samba will bit\-wise \*(AqOR\*(Aq the UNIX mode created from this parameter with the value of the
3171 \m[blue]\fBforce create mode\fR\m[]
3172 parameter which is set to 000 by default\&.
3173 .sp
3174 This parameter does not affect directory masks\&. See the parameter
3175 \m[blue]\fBdirectory mask\fR\m[]
3176 for details\&.
3177 .sp
3178 Default:
3179 \fI\fIcreate mask\fR\fR\fI = \fR\fI0744\fR\fI \fR
3180 .sp
3181 Example:
3182 \fI\fIcreate mask\fR\fR\fI = \fR\fI0775\fR\fI \fR
3183 .RE
3184
3185 csc policy (S)
3186 .PP
3187 .RS 4
3188 This stands for
3189 \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\&.
3190 .sp
3191 These values correspond to those used on Windows servers\&.
3192 .sp
3193 For example, shares containing roaming profiles can have offline caching disabled using
3194 \m[blue]\fBcsc policy = disable\fR\m[]\&.
3195 .sp
3196 Default:
3197 \fI\fIcsc policy\fR\fR\fI = \fR\fImanual\fR\fI \fR
3198 .sp
3199 Example:
3200 \fI\fIcsc policy\fR\fR\fI = \fR\fIprograms\fR\fI \fR
3201 .RE
3202
3203 ctdbd socket (G)
3204 .PP
3205 .RS 4
3206 In a test environment, this parameter can be used when
3207 clustering=yes
3208 to specify an alternate location for the CTDB Unix domain socket\&.
3209 .sp
3210 This parameter should not be set in production environments\&. If it is not set then the (correct) build\-time default is used\&.
3211 .sp
3212 Default:
3213 \fI\fIctdbd socket\fR\fR\fI = \fR\fI\fR\fI \fR
3214 .sp
3215 Example:
3216 \fI\fIctdbd socket\fR\fR\fI = \fR\fI/var/run/altctdb/ctdbd\&.socket\fR\fI \fR
3217 .RE
3218
3219 ctdb locktime warn threshold (G)
3220 .PP
3221 .RS 4
3222 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,
3223 \fIsmbd\fR
3224 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\&.
3225 .sp
3226 The default value of 0 disables this logging\&.
3227 .sp
3228 Default:
3229 \fI\fIctdb locktime warn threshold\fR\fR\fI = \fR\fI0\fR\fI \fR
3230 .RE
3231
3232 ctdb timeout (G)
3233 .PP
3234 .RS 4
3235 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
3236 \fIclustering=yes\fR\&.
3237 .sp
3238 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\&.
3239 .sp
3240 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\&.
3241 .sp
3242 Setting
3243 \fIctdb timeout\fR
3244 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\&.
3245 .sp
3246 Default:
3247 \fI\fIctdb timeout\fR\fR\fI = \fR\fI0\fR\fI \fR
3248 .RE
3249
3250 cups connection timeout (G)
3251 .PP
3252 .RS 4
3253 This parameter is only applicable if
3254 \m[blue]\fBprinting\fR\m[]
3255 is set to
3256 \fBcups\fR\&.
3257 .sp
3258 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\&.
3259 .sp
3260 Default:
3261 \fI\fIcups connection timeout\fR\fR\fI = \fR\fI30\fR\fI \fR
3262 .sp
3263 Example:
3264 \fI\fIcups connection timeout\fR\fR\fI = \fR\fI60\fR\fI \fR
3265 .RE
3266
3267 cups encrypt (G)
3268 .PP
3269 .RS 4
3270 This parameter is only applicable if
3271 \m[blue]\fBprinting\fR\m[]
3272 is set to
3273 \fBcups\fR
3274 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
3275 \fIauto\fR,
3276 \fIyes\fR
3277 and
3278 \fIno\fR
3279 .sp
3280 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\&.
3281 .sp
3282 Default:
3283 \fI\fIcups encrypt\fR\fR\fI = \fR\fIno\fR\fI \fR
3284 .RE
3285
3286 cups options (S)
3287 .PP
3288 .RS 4
3289 This parameter is only applicable if
3290 \m[blue]\fBprinting\fR\m[]
3291 is set to
3292 \fBcups\fR\&. Its value is a free form string of options passed directly to the cups library\&.
3293 .sp
3294 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\&.
3295 .sp
3296 You should set this parameter to
3297 \fBraw\fR
3298 if your CUPS server
3299 error_log
3300 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
3301 /etc/cups/mime\&.{convs,types}\&.
3302 .sp
3303 Default:
3304 \fI\fIcups options\fR\fR\fI = \fR\fI""\fR\fI \fR
3305 .sp
3306 Example:
3307 \fI\fIcups options\fR\fR\fI = \fR\fI"raw media=a4"\fR\fI \fR
3308 .RE
3309
3310 cups server (G)
3311 .PP
3312 .RS 4
3313 This parameter is only applicable if
3314 \m[blue]\fBprinting\fR\m[]
3315 is set to
3316 \fBcups\fR\&.
3317 .sp
3318 If set, this option overrides the ServerName option in the CUPS
3319 client\&.conf\&. This is necessary if you have virtual samba servers that connect to different CUPS daemons\&.
3320 .sp
3321 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\&.
3322 .sp
3323 Default:
3324 \fI\fIcups server\fR\fR\fI = \fR\fI""\fR\fI \fR
3325 .sp
3326 Example:
3327 \fI\fIcups server\fR\fR\fI = \fR\fImycupsserver\fR\fI \fR
3328 .sp
3329 Example:
3330 \fI\fIcups server\fR\fR\fI = \fR\fImycupsserver:1631\fR\fI \fR
3331 .RE
3332
3333 dcerpc endpoint servers (G)
3334 .PP
3335 .RS 4
3336 Specifies which DCE/RPC endpoint servers should be run\&.
3337 .sp
3338 Default:
3339 \fI\fIdcerpc endpoint servers\fR\fR\fI = \fR\fIepmapper, wkssvc, samr, netlogon, lsarpc, drsuapi, dssetup, unixinfo, browser, eventlog6, backupkey, dnsserver\fR\fI \fR
3340 .sp
3341 Example:
3342 \fI\fIdcerpc endpoint servers\fR\fR\fI = \fR\fIrpcecho\fR\fI \fR
3343 .RE
3344
3345 deadtime (G)
3346 .PP
3347 .RS 4
3348 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\&.
3349 .sp
3350 This is useful to stop a server\*(Aqs resources being exhausted by a large number of inactive connections\&.
3351 .sp
3352 Most clients have an auto\-reconnect feature when a connection is broken so in most cases this parameter should be transparent to users\&.
3353 .sp
3354 Using this parameter with a timeout of a few minutes is recommended for most systems\&.
3355 .sp
3356 A deadtime of zero indicates that no auto\-disconnection should be performed\&.
3357 .sp
3358 Default:
3359 \fI\fIdeadtime\fR\fR\fI = \fR\fI10080\fR\fI \fR
3360 .sp
3361 Example:
3362 \fI\fIdeadtime\fR\fR\fI = \fR\fI15\fR\fI \fR
3363 .RE
3364
3365 debug class (G)
3366 .PP
3367 .RS 4
3368 With this boolean parameter enabled, the debug class (DBGC_CLASS) will be displayed in the debug header\&.
3369 .sp
3370 For more information about currently available debug classes, see section about
3371 \m[blue]\fBlog level\fR\m[]\&.
3372 .sp
3373 Default:
3374 \fI\fIdebug class\fR\fR\fI = \fR\fIno\fR\fI \fR
3375 .RE
3376
3377 debug encryption (G)
3378 .PP
3379 .RS 4
3380 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\&.
3381 .sp
3382 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\&.
3383 .sp
3384 Default:
3385 \fI\fIdebug encryption\fR\fR\fI = \fR\fIno\fR\fI \fR
3386 .RE
3387
3388 debug hires timestamp (G)
3389 .PP
3390 .RS 4
3391 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\&.
3392 .sp
3393 Note that the parameter
3394 \m[blue]\fBdebug timestamp\fR\m[]
3395 or
3396 \m[blue]\fBdebug syslog format\fR\m[]
3397 must be on for this to have an effect\&.
3398 .sp
3399 Default:
3400 \fI\fIdebug hires timestamp\fR\fR\fI = \fR\fIyes\fR\fI \fR
3401 .RE
3402
3403 debug pid (G)
3404 .PP
3405 .RS 4
3406 When using only one log file for more then one forked
3407 \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\&.
3408 .sp
3409 Note that the parameter
3410 \m[blue]\fBdebug timestamp\fR\m[]
3411 must be on for this to have an effect\&.
3412 .sp
3413 Default:
3414 \fI\fIdebug pid\fR\fR\fI = \fR\fIno\fR\fI \fR
3415 .RE
3416
3417 debug prefix timestamp (G)
3418 .PP
3419 .RS 4
3420 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
3421 \m[blue]\fBdebug timestamp\fR\m[]
3422 parameter\&. This gives timestamps to the messages without adding an additional line\&.
3423 .sp
3424 Note that this parameter overrides the
3425 \m[blue]\fBdebug timestamp\fR\m[]
3426 parameter\&.
3427 .sp
3428 Default:
3429 \fI\fIdebug prefix timestamp\fR\fR\fI = \fR\fIno\fR\fI \fR
3430 .RE
3431
3432 debug syslog format (G)
3433 .PP
3434 .RS 4
3435 With this option enabled (\fByes\fR
3436 (alias
3437 \fBin_logs\fR) or
3438 \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\&.
3439 .sp
3440 The value
3441 \fBalways\fR
3442 produces this log format even to
3443 \fBSTDOUT\fR
3444 or
3445 \fBSTDERR\fR
3446 .sp
3447 The value
3448 \fBno\fR
3449 defers to other parameters and typically produces traditional two\-line Samba logs to log files\&.
3450 .sp
3451 If
3452 \m[blue]\fBdebug hires timestamp\fR\m[]
3453 is also enabled then an RFC5424 timestamp is used instead\&.
3454 .sp
3455 Default:
3456 \fI\fIdebug syslog format\fR\fR\fI = \fR\fIno\fR\fI \fR
3457 .RE
3458
3459 winbind debug traceid (G)
3460 .PP
3461 .RS 4
3462 With this boolean parameter enabled, the per request unique traceid will be displayed in the debug header for winbind processes\&.
3463 .sp
3464 Default:
3465 \fI\fIwinbind debug traceid\fR\fR\fI = \fR\fIyes\fR\fI \fR
3466 .RE
3467
3468 debug uid (G)
3469 .PP
3470 .RS 4
3471 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\&.
3472 .sp
3473 Note that the parameter
3474 \m[blue]\fBdebug timestamp\fR\m[]
3475 must be on for this to have an effect\&.
3476 .sp
3477 Default:
3478 \fI\fIdebug uid\fR\fR\fI = \fR\fIno\fR\fI \fR
3479 .RE
3480
3481 dedicated keytab file (G)
3482 .PP
3483 .RS 4
3484 Specifies the absolute path to the kerberos keytab file when
3485 \m[blue]\fBkerberos method\fR\m[]
3486 is set to "dedicated keytab"\&.
3487 .sp
3488 Default:
3489 \fI\fIdedicated keytab file\fR\fR\fI = \fR\fI\fR\fI \fR
3490 .sp
3491 Example:
3492 \fI\fIdedicated keytab file\fR\fR\fI = \fR\fI/usr/local/etc/krb5\&.keytab\fR\fI \fR
3493 .RE
3494
3495 default case (S)
3496 .PP
3497 .RS 4
3498 See the section on
3499 name mangling\&. Also note the
3500 \m[blue]\fBshort preserve case\fR\m[]
3501 parameter\&.
3502 .sp
3503 Default:
3504 \fI\fIdefault case\fR\fR\fI = \fR\fIlower\fR\fI \fR
3505 .RE
3506
3507 default devmode (S)
3508 .PP
3509 .RS 4
3510 This parameter is only applicable to
3511 \m[blue]\fBprintable\fR\m[]
3512 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\&.
3513 .sp
3514 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)\&.
3515 .sp
3516 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
3517 default devmode = yes
3518 will instruct smbd to generate a default one\&.
3519 .sp
3520 For more information on Windows NT/2k printing and Device Modes, see the
3521 MSDN documentation\&.
3522 .sp
3523 Default:
3524 \fI\fIdefault devmode\fR\fR\fI = \fR\fIyes\fR\fI \fR
3525 .RE
3526
3527 default
3528 .PP
3529 .RS 4
3530 This parameter is a synonym for
3531 default service\&.
3532 .RE
3533
3534 default service (G)
3535 .PP
3536 .RS 4
3537 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
3538 \fINOT\fR
3539 given in the parameter value (see example below)\&.
3540 .sp
3541 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\&.
3542 .sp
3543 Typically the default service would be a
3544 \m[blue]\fBguest ok\fR\m[],
3545 \m[blue]\fBread only\fR\m[]
3546 service\&.
3547 .sp
3548 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
3549 \fI%S\fR
3550 to make a wildcard service\&.
3551 .sp
3552 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\&.
3553 .sp
3554 Default:
3555 \fI\fIdefault service\fR\fR\fI = \fR\fI\fR\fI \fR
3556 .sp
3557 Example:
3558 \fI\fIdefault service\fR\fR\fI = \fR\fIpub\fR\fI \fR
3559 .RE
3560
3561 defer sharing violations (G)
3562 .PP
3563 .RS 4
3564 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\&.
3565 .sp
3566 UNIX by default does not have this behaviour\&.
3567 .sp
3568 There should be no reason to turn off this parameter, as it is designed to enable Samba to more correctly emulate Windows\&.
3569 .sp
3570 Default:
3571 \fI\fIdefer sharing violations\fR\fR\fI = \fR\fIyes\fR\fI \fR
3572 .RE
3573
3574 delete group script (G)
3575 .PP
3576 .RS 4
3577 This is the full pathname to a script that will be run
3578 \fIAS ROOT\fR
3579 by
3580 \fBsmbd\fR(8)
3581 when a group is requested to be deleted\&. It will expand any
3582 \fI%g\fR
3583 to the group name passed\&. This script is only useful for installations using the Windows NT domain administration tools\&.
3584 .sp
3585 Default:
3586 \fI\fIdelete group script\fR\fR\fI = \fR\fI\fR\fI \fR
3587 .RE
3588
3589 deleteprinter command (G)
3590 .PP
3591 .RS 4
3592 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\&.
3593 .sp
3594 For a Samba host this means that the printer must be physically deleted from the underlying printing system\&. The
3595 \m[blue]\fBdeleteprinter command\fR\m[]
3596 defines a script to be run which will perform the necessary operations for removing the printer from the print system and from
3597 smb\&.conf\&.
3598 .sp
3599 The
3600 \m[blue]\fBdeleteprinter command\fR\m[]
3601 is automatically called with only one parameter:
3602 \m[blue]\fBprinter name\fR\m[]\&.
3603 .sp
3604 Once the
3605 \m[blue]\fBdeleteprinter command\fR\m[]
3606 has been executed,
3607 smbd
3608 will reparse the
3609 smb\&.conf
3610 to check that the associated printer no longer exists\&. If the sharename is still valid, then
3611 smbd
3612 will return an ACCESS_DENIED error to the client\&.
3613 .sp
3614 Default:
3615 \fI\fIdeleteprinter command\fR\fR\fI = \fR\fI\fR\fI \fR
3616 .sp
3617 Example:
3618 \fI\fIdeleteprinter command\fR\fR\fI = \fR\fI/usr/bin/removeprinter\fR\fI \fR
3619 .RE
3620
3621 delete readonly (S)
3622 .PP
3623 .RS 4
3624 This parameter allows readonly files to be deleted\&. This is not normal DOS semantics, but is allowed by UNIX\&.
3625 .sp
3626 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\&.
3627 .sp
3628 Default:
3629 \fI\fIdelete readonly\fR\fR\fI = \fR\fIno\fR\fI \fR
3630 .RE
3631
3632 delete share command (G)
3633 .PP
3634 .RS 4
3635 Samba 2\&.2\&.0 introduced the ability to dynamically add and delete shares via the Windows NT 4\&.0 Server Manager\&. The
3636 \fIdelete share command\fR
3637 is used to define an external program or script which will remove an existing service definition from
3638 smb\&.conf\&.
3639 .sp
3640 In order to successfully execute the
3641 \fIdelete share command\fR,
3642 smbd
3643 requires that the administrator connects using a root account (i\&.e\&. uid == 0) or has the
3644 SeDiskOperatorPrivilege\&. Scripts defined in the
3645 \fIdelete share command\fR
3646 parameter are executed as root\&.
3647 .sp
3648 When executed,
3649 smbd
3650 will automatically invoke the
3651 \fIdelete share command\fR
3652 with two parameters\&.
3653 .RS
3654 .sp
3655 .RS 4
3656 .ie n \{\
3657 \h'-04'\(bu\h'+03'\c
3658 .\}
3659 .el \{\
3660 .sp -1
3661 .IP \(bu 2.3
3662 .\}
3663 \fIconfigFile\fR
3664 \- the location of the global
3665 smb\&.conf
3666 file\&.
3667 .RE
3668 .sp
3669 .RS 4
3670 .ie n \{\
3671 \h'-04'\(bu\h'+03'\c
3672 .\}
3673 .el \{\
3674 .sp -1
3675 .IP \(bu 2.3
3676 .\}
3677 \fIshareName\fR
3678 \- the name of the existing service\&.
3679 .RE
3680 .sp
3681 .RE
3682 This parameter is only used to remove file shares\&. To delete printer shares, see the
3683 \m[blue]\fBdeleteprinter command\fR\m[]\&.
3684 .sp
3685 Default:
3686 \fI\fIdelete share command\fR\fR\fI = \fR\fI\fR\fI \fR
3687 .sp
3688 Example:
3689 \fI\fIdelete share command\fR\fR\fI = \fR\fI/usr/local/bin/delshare\fR\fI \fR
3690 .RE
3691
3692 delete user from group script (G)
3693 .PP
3694 .RS 4
3695 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
3696 \fBsmbd\fR(8)
3697 \fIAS ROOT\fR\&. Any
3698 \fI%g\fR
3699 will be replaced with the group name and any
3700 \fI%u\fR
3701 will be replaced with the user name\&.
3702 .sp
3703 Default:
3704 \fI\fIdelete user from group script\fR\fR\fI = \fR\fI\fR\fI \fR
3705 .sp
3706 Example:
3707 \fI\fIdelete user from group script\fR\fR\fI = \fR\fI/usr/sbin/deluser %u %g\fR\fI \fR
3708 .RE
3709
3710 delete user script (G)
3711 .PP
3712 .RS 4
3713 This is the full pathname to a script that will be run by
3714 \fBsmbd\fR(8)
3715 when managing users with remote RPC (NT) tools\&.
3716 .sp
3717 This script is called when a remote client removes a user from the server, normally using \*(AqUser Manager for Domains\*(Aq or
3718 rpcclient\&.
3719 .sp
3720 This script should delete the given UNIX username\&.
3721 .sp
3722 Default:
3723 \fI\fIdelete user script\fR\fR\fI = \fR\fI\fR\fI \fR
3724 .sp
3725 Example:
3726 \fI\fIdelete user script\fR\fR\fI = \fR\fI/usr/local/samba/bin/del_user %u\fR\fI \fR
3727 .RE
3728
3729 delete veto files (S)
3730 .PP
3731 .RS 4
3732 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
3733 \m[blue]\fBveto files\fR\m[],
3734 \m[blue]\fBhide special files\fR\m[],
3735 \m[blue]\fBhide unreadable\fR\m[],
3736 \m[blue]\fBhide unwriteable files\fR\m[]
3737 options)\&. If this option is set to
3738 \fBno\fR
3739 (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\&.
3740 .sp
3741 If this option is set to
3742 \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\&.
3743 \&.AppleDouble)
3744 .sp
3745 Setting
3746 \m[blue]\fBdelete veto files = yes\fR\m[]
3747 allows these directories to be transparently deleted when the parent directory is deleted (so long as the user has permissions to do so)\&.
3748 .sp
3749 Default:
3750 \fI\fIdelete veto files\fR\fR\fI = \fR\fIno\fR\fI \fR
3751 .RE
3752
3753 dfree cache time (S)
3754 .PP
3755 .RS 4
3756 The
3757 \fIdfree cache time\fR
3758 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\&.
3759 .sp
3760 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
3761 \m[blue]\fBdfree command\fR\m[]
3762 scripts increasing the load\&.
3763 .sp
3764 By default this parameter is zero, meaning no caching will be done\&.
3765 .sp
3766 \fINo default\fR
3767 .sp
3768 Example:
3769 \fI\fIdfree cache time\fR\fR\fI = \fR\fI60\fR\fI \fR
3770 .RE
3771
3772 dfree command (S)
3773 .PP
3774 .RS 4
3775 The
3776 \fIdfree command\fR
3777 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\&.
3778 .sp
3779 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\&.
3780 .sp
3781 In Samba version 3\&.0\&.21 this parameter has been changed to be a per\-share parameter, and in addition the parameter
3782 \m[blue]\fBdfree cache time\fR\m[]
3783 was added to allow the output of this script to be cached for systems under heavy load\&.
3784 .sp
3785 The external program will be passed a single parameter indicating a directory in the filesystem being queried\&. This will typically consist of the string
3786 \&./\&. 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\&.
3787 .sp
3788 Note: Your script should
3789 \fINOT\fR
3790 be setuid or setgid and should be owned by (and writeable only by) root!
3791 .sp
3792 Where the script dfree (which must be made executable) could be:
3793 .sp
3794 .if n \{\
3795 .RS 4
3796 .\}
3797 .nf
3798
3799 #!/bin/sh
3800 df "$1" | tail \-1 | awk \*(Aq{print $(NF\-4),$(NF\-2)}\*(Aq
3801 .fi
3802 .if n \{\
3803 .RE
3804 .\}
3805 .sp
3806 or perhaps (on Sys V based systems):
3807 .sp
3808 .if n \{\
3809 .RS 4
3810 .\}
3811 .nf
3812
3813 #!/bin/sh
3814 /usr/bin/df \-k "$1" | tail \-1 | awk \*(Aq{print $3" "$5}\*(Aq
3815 .fi
3816 .if n \{\
3817 .RE
3818 .\}
3819 .sp
3820 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\&.
3821 .sp
3822 By default internal routines for determining the disk capacity and remaining space will be used\&.
3823 .sp
3824 \fINo default\fR
3825 .sp
3826 Example:
3827 \fI\fIdfree command\fR\fR\fI = \fR\fI/usr/local/samba/bin/dfree\fR\fI \fR
3828 .RE
3829
3830 dgram port (G)
3831 .PP
3832 .RS 4
3833 Specifies which ports the server should listen on for NetBIOS datagram traffic\&.
3834 .sp
3835 Default:
3836 \fI\fIdgram port\fR\fR\fI = \fR\fI138\fR\fI \fR
3837 .RE
3838
3839 directory mode
3840 .PP
3841 .RS 4
3842 This parameter is a synonym for
3843 directory mask\&.
3844 .RE
3845
3846 directory mask (S)
3847 .PP
3848 .RS 4
3849 This parameter is the octal modes which are used when converting DOS modes to UNIX modes when creating UNIX directories\&.
3850 .sp
3851 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
3852 \fInot\fR
3853 set here will be removed from the modes set on a directory when it is created\&.
3854 .sp
3855 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\&.
3856 .sp
3857 Following this Samba will bit\-wise \*(AqOR\*(Aq the UNIX mode created from this parameter with the value of the
3858 \m[blue]\fBforce directory mode\fR\m[]
3859 parameter\&. This parameter is set to 000 by default (i\&.e\&. no extra mode bits are added)\&.
3860 .sp
3861 Default:
3862 \fI\fIdirectory mask\fR\fR\fI = \fR\fI0755\fR\fI \fR
3863 .sp
3864 Example:
3865 \fI\fIdirectory mask\fR\fR\fI = \fR\fI0775\fR\fI \fR
3866 .RE
3867
3868 directory security mask (S)
3869 .PP
3870 .RS 4
3871 This parameter has been removed for Samba 4\&.0\&.0\&.
3872 .sp
3873 \fINo default\fR
3874 .RE
3875
3876 disable netbios (G)
3877 .PP
3878 .RS 4
3879 Enabling this parameter will disable netbios support in Samba\&. Netbios is the only available form of browsing in Windows versions prior to Windows 2000\&.
3880 .if n \{\
3881 .sp
3882 .\}
3883 .RS 4
3884 .it 1 an-trap
3885 .nr an-no-space-flag 1
3886 .nr an-break-flag 1
3887 .br
3888 .ps +1
3889 \fBNote\fR
3890 .ps -1
3891 .br
3892 Clients that only support netbios won\*(Aqt be able to see your samba server when netbios support is disabled\&.
3893 .sp .5v
3894 .RE
3895 Default:
3896 \fI\fIdisable netbios\fR\fR\fI = \fR\fIno\fR\fI \fR
3897 .RE
3898
3899 disable spoolss (G)
3900 .PP
3901 .RS 4
3902 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\&.
3903 \fIBe very careful about enabling this parameter\&.\fR
3904 .sp
3905 Default:
3906 \fI\fIdisable spoolss\fR\fR\fI = \fR\fIno\fR\fI \fR
3907 .RE
3908
3909 dmapi support (S)
3910 .PP
3911 .RS 4
3912 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\&.
3913 .sp
3914 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\&.
3915 .sp
3916 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\&.
3917 .sp
3918 Default:
3919 \fI\fIdmapi support\fR\fR\fI = \fR\fIno\fR\fI \fR
3920 .RE
3921
3922 dns hostname (G)
3923 .PP
3924 .RS 4
3925
3926 This value is used:
3927
3928 .RS
3929 .sp
3930 .RS 4
3931 .ie n \{\
3932 \h'-04'\(bu\h'+03'\c
3933 .\}
3934 .el \{\
3935 .sp -1
3936 .IP \(bu 2.3
3937 .\}
3938 to register DNS record with AD during a join or by calling
3939 .sp
3940 .if n \{\
3941 .RS 4
3942 .\}
3943 .nf
3944 net ads dns register
3945 .fi
3946 .if n \{\
3947 .RE
3948 .\}
3949 .RE
3950 .sp
3951 .RS 4
3952 .ie n \{\
3953 \h'-04'\(bu\h'+03'\c
3954 .\}
3955 .el \{\
3956 .sp -1
3957 .IP \(bu 2.3
3958 .\}
3959 during Kerberos authentication to create service principal names
3960 .RE
3961 .sp
3962 .RS 4
3963 .ie n \{\
3964 \h'-04'\(bu\h'+03'\c
3965 .\}
3966 .el \{\
3967 .sp -1
3968 .IP \(bu 2.3
3969 .\}
3970 during keytab creation \- see the
3971 \m[blue]\fBsync machine password to keytab\fR\m[]
3972 parameter
3973 .RE
3974 .sp
3975 .RE
3976 This is not supported in samba\-tool yet\&.
3977
3978 Default:
3979 \fI\fIdns hostname\fR\fR\fI = \fR\fI[netbios name]\&.[realm]\fR\fI \fR
3980 .sp
3981 Example:
3982 \fI\fIdns hostname\fR\fR\fI = \fR\fIclient\-hostname\&.example\&.com\fR\fI \fR
3983 .RE
3984
3985 dns forwarder (G)
3986 .PP
3987 .RS 4
3988 This option specifies the list of DNS servers that DNS requests will be forwarded to if they can not be handled by Samba itself\&.
3989 .sp
3990 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\&.
3991 .sp
3992 Default:
3993 \fI\fIdns forwarder\fR\fR\fI = \fR\fI\fR\fI \fR
3994 .sp
3995 Example:
3996 \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
3997 .RE
3998
3999 dns port (G)
4000 .PP
4001 .RS 4
4002 Specifies which ports the server should listen on for DNS traffic\&.
4003 .sp
4004 It makes possible to use another DNS server as a front and forward to Samba\&.
4005 .if n \{\
4006 .sp
4007 .\}
4008 .RS 4
4009 .it 1 an-trap
4010 .nr an-no-space-flag 1
4011 .nr an-break-flag 1
4012 .br
4013 .ps +1
4014 \fBWarning\fR
4015 .ps -1
4016 .br
4017 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\&.
4018 .sp .5v
4019 .RE
4020 Default:
4021 \fI\fIdns port\fR\fR\fI = \fR\fI53\fR\fI \fR
4022 .RE
4023
4024 dns proxy (G)
4025 .PP
4026 .RS 4
4027 Specifies that
4028 \fBnmbd\fR(8)
4029 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\&.
4030 .sp
4031 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\&.
4032 .sp
4033 nmbd
4034 spawns a second copy of itself to do the DNS name lookup requests, as doing a name lookup is a blocking action\&.
4035 .sp
4036 Default:
4037 \fI\fIdns proxy\fR\fR\fI = \fR\fIyes\fR\fI \fR
4038 .RE
4039
4040 dns update command (G)
4041 .PP
4042 .RS 4
4043 This option sets the command that is called when there are DNS updates\&. It should update the local machines DNS names using TSIG\-GSS\&.
4044 .sp
4045 Default:
4046 \fI\fIdns update command\fR\fR\fI = \fR\fI/home/iurt/rpmbuild/BUILD/samba\-4\&.23\&.8\-build/samba\-4\&.23\&.8/source4/scripting/bin/samba_dnsupdate\fR\fI \fR
4047 .sp
4048 Example:
4049 \fI\fIdns update command\fR\fR\fI = \fR\fI/usr/local/sbin/dnsupdate\fR\fI \fR
4050 .RE
4051
4052 dns zone scavenging (G)
4053 .PP
4054 .RS 4
4055 When enabled (the default is disabled) unused dynamic dns records are periodically removed\&.
4056 .if n \{\
4057 .sp
4058 .\}
4059 .RS 4
4060 .it 1 an-trap
4061 .nr an-no-space-flag 1
4062 .nr an-break-flag 1
4063 .br
4064 .ps +1
4065 \fBWarning\fR
4066 .ps -1
4067 .br
4068 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\&.
4069 .sp .5v
4070 .RE
4071 .if n \{\
4072 .sp
4073 .\}
4074 .RS 4
4075 .it 1 an-trap
4076 .nr an-no-space-flag 1
4077 .nr an-break-flag 1
4078 .br
4079 .ps +1
4080 \fBNote\fR
4081 .ps -1
4082 .br
4083 If one record for a DNS name is static (non\-aging) then no other record for that DNS name will be scavenged\&.
4084 .sp .5v
4085 .RE
4086 Default:
4087 \fI\fIdns zone scavenging\fR\fR\fI = \fR\fIno\fR\fI \fR
4088 .RE
4089
4090 dns zone transfer clients allow (G)
4091 .PP
4092 .RS 4
4093 This option specifies the list of IPs authorized to ask for dns zone transfer from bind DLZ module\&.
4094 .sp
4095 The IP list is comma and space separated and specified in the same syntax as used in
4096 \m[blue]\fBhosts allow\fR\m[], specifically including IP address, IP prefixes and IP address masks\&.
4097 .sp
4098 As this is a DNS server option, hostnames are naturally not permitted\&.
4099 .sp
4100 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
4101 \m[blue]\fBdns zone transfer clients deny\fR\m[]
4102 .sp
4103 Default:
4104 \fI\fIdns zone transfer clients allow\fR\fR\fI = \fR\fI\fR\fI \fR
4105 .sp
4106 Example:
4107 \fI\fIdns zone transfer clients allow\fR\fR\fI = \fR\fI192\&.168\&.0\&.1\fR\fI \fR
4108 .RE
4109
4110 dns zone transfer clients deny (G)
4111 .PP
4112 .RS 4
4113 This option specifies the list of IPs denied to ask for dns zone transfer from bind DLZ module\&.
4114 .sp
4115 The IP list is comma and space separated and specified in the same syntax as used in
4116 \m[blue]\fBhosts allow\fR\m[], specifically including IP address, IP prefixes and IP address masks\&.
4117 .sp
4118 As this is a DNS server option, hostnames are naturally not permitted\&.
4119 .sp
4120 If a client identified in this list sends a zone transfer request, it will always be denied, even if they are in
4121 \m[blue]\fBdns zone transfer clients allow\fR\m[]\&. This allows the definition of specific denied clients within an authorized subnet\&.
4122 .sp
4123 Default:
4124 \fI\fIdns zone transfer clients deny\fR\fR\fI = \fR\fI\fR\fI \fR
4125 .sp
4126 Example:
4127 \fI\fIdns zone transfer clients deny\fR\fR\fI = \fR\fI192\&.168\&.0\&.1\fR\fI \fR
4128 .RE
4129
4130 domain logons (G)
4131 .PP
4132 .RS 4
4133 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\&.
4134 .sp
4135 That is, in the future, the current default of
4136 domain logons = no
4137 will be the enforced behaviour\&.
4138 .sp
4139 If set to
4140 \fByes\fR, the Samba server will provide the netlogon service for Windows 9X network logons for the
4141 \m[blue]\fBworkgroup\fR\m[]
4142 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\&.
4143 .sp
4144 Default:
4145 \fI\fIdomain logons\fR\fR\fI = \fR\fIno\fR\fI \fR
4146 .RE
4147
4148 domain master (G)
4149 .PP
4150 .RS 4
4151 Tell
4152 \fBsmbd\fR(8)
4153 to enable WAN\-wide browse list collation\&. Setting this option causes
4154 nmbd
4155 to claim a special domain specific NetBIOS name that identifies it as a domain master browser for its given
4156 \m[blue]\fBworkgroup\fR\m[]\&. Local master browsers in the same
4157 \m[blue]\fBworkgroup\fR\m[]
4158 on broadcast\-isolated subnets will give this
4159 nmbd
4160 their local browse lists, and then ask
4161 \fBsmbd\fR(8)
4162 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\&.
4163 .sp
4164 Note that Windows NT Primary Domain Controllers expect to be able to claim this
4165 \m[blue]\fBworkgroup\fR\m[]
4166 specific special NetBIOS name that identifies them as domain master browsers for that
4167 \m[blue]\fBworkgroup\fR\m[]
4168 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
4169 nmbd
4170 claims the special name for a
4171 \m[blue]\fBworkgroup\fR\m[]
4172 before a Windows NT PDC is able to do so then cross subnet browsing will behave strangely and may fail\&.
4173 .sp
4174 If
4175 \m[blue]\fBdomain logons = yes\fR\m[], then the default behavior is to enable the
4176 \m[blue]\fBdomain master\fR\m[]
4177 parameter\&. If
4178 \m[blue]\fBdomain logons\fR\m[]
4179 is not enabled (the default setting), then neither will
4180 \m[blue]\fBdomain master\fR\m[]
4181 be enabled by default\&.
4182 .sp
4183 When
4184 \m[blue]\fBdomain logons = Yes\fR\m[]
4185 the default setting for this parameter is Yes, with the result that Samba will be a PDC\&. If
4186 \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\&.
4187 .sp
4188 Default:
4189 \fI\fIdomain master\fR\fR\fI = \fR\fIauto\fR\fI \fR
4190 .RE
4191
4192 dont descend (S)
4193 .PP
4194 .RS 4
4195 There are certain directories on some systems (e\&.g\&., the
4196 /proc
4197 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\&.
4198 .sp
4199 Note that Samba can be very fussy about the exact format of the "dont descend" entries\&. For example you may need
4200 \&./proc
4201 instead of just
4202 /proc\&. Experimentation is the best policy :\-)
4203 .sp
4204 Default:
4205 \fI\fIdont descend\fR\fR\fI = \fR\fI\fR\fI \fR
4206 .sp
4207 Example:
4208 \fI\fIdont descend\fR\fR\fI = \fR\fI/proc,/dev\fR\fI \fR
4209 .RE
4210
4211 dos charset (G)
4212 .PP
4213 .RS 4
4214 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\&.
4215 .sp
4216 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
4217 \fBtestparm\fR(1)
4218 to check the default on your system\&.
4219 .sp
4220 \fINo default\fR
4221 .RE
4222
4223 dos filemode (S)
4224 .PP
4225 .RS 4
4226 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\&.
4227 .sp
4228 Default:
4229 \fI\fIdos filemode\fR\fR\fI = \fR\fIno\fR\fI \fR
4230 .RE
4231
4232 dos filetime resolution (S)
4233 .PP
4234 .RS 4
4235 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
4236 \fBsmbd\fR(8)\&.
4237 .sp
4238 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\&.
4239 .sp
4240 Default:
4241 \fI\fIdos filetime resolution\fR\fR\fI = \fR\fIno\fR\fI \fR
4242 .RE
4243
4244 dos filetimes (S)
4245 .PP
4246 .RS 4
4247 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
4248 smbd
4249 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\&.
4250 .sp
4251 Default:
4252 \fI\fIdos filetimes\fR\fR\fI = \fR\fIyes\fR\fI \fR
4253 .RE
4254
4255 dsdb event notification (G)
4256 .PP
4257 .RS 4
4258 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
4259 dsdb_event\&.
4260 .sp
4261 This is
4262 \fInot\fR
4263 needed for the audit logging described in
4264 \m[blue]\fBlog level\fR\m[]\&.
4265 .sp
4266 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)\&.
4267 .sp
4268 The Samba database events are also logged via the normal logging methods when the
4269 \m[blue]\fBlog level\fR\m[]
4270 is set appropriately, say to
4271 dsdb_json_audit:5\&.
4272 .sp
4273 Default:
4274 \fI\fIdsdb event notification\fR\fR\fI = \fR\fIno\fR\fI \fR
4275 .RE
4276
4277 dsdb group change notification (G)
4278 .PP
4279 .RS 4
4280 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
4281 dsdb_group_event\&.
4282 .sp
4283 This is
4284 \fInot\fR
4285 needed for the audit logging described in
4286 \m[blue]\fBlog level\fR\m[]\&.
4287 .sp
4288 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)\&.
4289 .sp
4290 The Samba database events are also logged via the normal logging methods when the
4291 \m[blue]\fBlog level\fR\m[]
4292 is set appropriately, say to
4293 dsdb_group_json_audit:5\&.
4294 .sp
4295 Default:
4296 \fI\fIdsdb group change notification\fR\fR\fI = \fR\fIno\fR\fI \fR
4297 .RE
4298
4299 dsdb password event notification (G)
4300 .PP
4301 .RS 4
4302 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
4303 password_event\&.
4304 .sp
4305 This is
4306 \fInot\fR
4307 needed for the audit logging described in
4308 \m[blue]\fBlog level\fR\m[]\&.
4309 .sp
4310 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)\&.
4311 .sp
4312 The Samba database events are also logged via the normal logging methods when the
4313 \m[blue]\fBlog level\fR\m[]
4314 is set appropriately, say to
4315 dsdb_password_json_audit:5\&.
4316 .sp
4317 Default:
4318 \fI\fIdsdb password event notification\fR\fR\fI = \fR\fIno\fR\fI \fR
4319 .RE
4320
4321 durable handles (S)
4322 .PP
4323 .RS 4
4324 This boolean parameter controls whether Samba can grant SMB2 durable file handles on a share\&.
4325 .sp
4326 Note that durable handles are only enabled if
4327 \m[blue]\fBkernel oplocks = no\fR\m[],
4328 \m[blue]\fBkernel share modes = no\fR\m[], and
4329 \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\&.
4330 .sp
4331 Also note that, for the time being, durability is not granted for a handle that has the delete on close flag set\&.
4332 .sp
4333 Default:
4334 \fI\fIdurable handles\fR\fR\fI = \fR\fIyes\fR\fI \fR
4335 .RE
4336
4337 ea support (S)
4338 .PP
4339 .RS 4
4340 This boolean parameter controls whether
4341 \fBsmbd\fR(8)
4342 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:
4343 .RS
4344 .sp
4345 .RS 4
4346 .ie n \{\
4347 \h'-04'\(bu\h'+03'\c
4348 .\}
4349 .el \{\
4350 .sp -1
4351 .IP \(bu 2.3
4352 .\}
4353 Samba must have been built with extended attributes support\&.
4354 .RE
4355 .sp
4356 .RS 4
4357 .ie n \{\
4358 \h'-04'\(bu\h'+03'\c
4359 .\}
4360 .el \{\
4361 .sp -1
4362 .IP \(bu 2.3
4363 .\}
4364 The underlying filesystem exposed by the share must support extended attributes (e\&.g\&. the getfattr(1)
4365 / setfattr(1)
4366 utilities must work)\&.
4367 .RE
4368 .sp
4369 .RS 4
4370 .ie n \{\
4371 \h'-04'\(bu\h'+03'\c
4372 .\}
4373 .el \{\
4374 .sp -1
4375 .IP \(bu 2.3
4376 .\}
4377 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)\&.
4378 .RE
4379 .sp
4380 .RE
4381 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\&.
4382 .sp
4383 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\&.
4384 .sp
4385 Default:
4386 \fI\fIea support\fR\fR\fI = \fR\fIyes\fR\fI \fR
4387 .RE
4388
4389 elasticsearch:address (S)
4390 .PP
4391 .RS 4
4392 Specifies the name of the Elasticsearch server to use for Spotlight queries when using the Elasticsearch backend\&.
4393 .sp
4394 Default:
4395 \fI\fIelasticsearch:address\fR\fR\fI = \fR\fIlocalhost\fR\fI \fR
4396 .sp
4397 Example:
4398 \fI\fIelasticsearch:address\fR\fR\fI = \fR\fIneedle\&.haystack\&.samba\&.org\fR\fI \fR
4399 .RE
4400
4401 elasticsearch:default_fields (G)
4402 .PP
4403 .RS 4
4404 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\&.
4405 .sp
4406 This option expects a list of Elasticsearch attributes separated by comma where each attributes must be enclosed in double quotes\&.
4407 .sp
4408 Default:
4409 \fI\fIelasticsearch:default_fields\fR\fR\fI = \fR\fI"file\&.filename", "content"\fR\fI \fR
4410 .sp
4411 Example:
4412 \fI\fIelasticsearch:default_fields\fR\fR\fI = \fR\fI"foo", "bar"\fR\fI \fR
4413 .RE
4414
4415 elasticsearch:force substring search (G)
4416 .PP
4417 .RS 4
4418 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"\&.
4419 .sp
4420 Default:
4421 \fI\fIelasticsearch:force substring search\fR\fR\fI = \fR\fIno\fR\fI \fR
4422 .sp
4423 Example:
4424 \fI\fIelasticsearch:force substring search\fR\fR\fI = \fR\fIyes\fR\fI \fR
4425 .RE
4426
4427 elasticsearch:ignore unknown attribute (G)
4428 .PP
4429 .RS 4
4430 Ignore unknown Spotlight attributes in search queries\&. An example query using the unsupported attribute
4431 "kMDItemTopic"
4432 would be
4433 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\&.
4434 .sp
4435 Default:
4436 \fI\fIelasticsearch:ignore unknown attribute\fR\fR\fI = \fR\fIno\fR\fI \fR
4437 .sp
4438 Example:
4439 \fI\fIelasticsearch:ignore unknown attribute\fR\fR\fI = \fR\fIyes\fR\fI \fR
4440 .RE
4441
4442 elasticsearch:ignore unknown type (G)
4443 .PP
4444 .RS 4
4445 Ignore unknown Spotlight types in search queries\&. An example query using the unsupported type
4446 "public\&.calendar\-event"
4447 would be
4448 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\&.
4449 .sp
4450 Default:
4451 \fI\fIelasticsearch:ignore unknown type\fR\fR\fI = \fR\fIno\fR\fI \fR
4452 .sp
4453 Example:
4454 \fI\fIelasticsearch:ignore unknown type\fR\fR\fI = \fR\fIyes\fR\fI \fR
4455 .RE
4456
4457 elasticsearch:index (S)
4458 .PP
4459 .RS 4
4460 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\&.
4461 .sp
4462 Default:
4463 \fI\fIelasticsearch:index\fR\fR\fI = \fR\fI_all\fR\fI \fR
4464 .sp
4465 Example:
4466 \fI\fIelasticsearch:index\fR\fR\fI = \fR\fIspotlight\fR\fI \fR
4467 .RE
4468
4469 elasticsearch:mappings (G)
4470 .PP
4471 .RS 4
4472 Path to a file specifying metadata attribute mappings in JSON format\&. Use by the Elasticsearch backend of the Spotlight RPC service\&.
4473 .sp
4474 Default:
4475 \fI\fIelasticsearch:mappings\fR\fR\fI = \fR\fI/usr/share/samba/elasticsearch_mappings\&.json\fR\fI \fR
4476 .sp
4477 Example:
4478 \fI\fIelasticsearch:mappings\fR\fR\fI = \fR\fI/usr/share/foo/mymappings\&.json\fR\fI \fR
4479 .RE
4480
4481 elasticsearch:max results (S)
4482 .PP
4483 .RS 4
4484 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\&.
4485 .sp
4486 Default:
4487 \fI\fIelasticsearch:max results\fR\fR\fI = \fR\fI100\fR\fI \fR
4488 .sp
4489 Example:
4490 \fI\fIelasticsearch:max results\fR\fR\fI = \fR\fI10\fR\fI \fR
4491 .RE
4492
4493 elasticsearch:port (S)
4494 .PP
4495 .RS 4
4496 Specifies the TCP port of the Elasticsearch server to use for Spotlight queries when using the Elasticsearch backend\&.
4497 .sp
4498 Default:
4499 \fI\fIelasticsearch:port\fR\fR\fI = \fR\fI9200\fR\fI \fR
4500 .sp
4501 Example:
4502 \fI\fIelasticsearch:port\fR\fR\fI = \fR\fI9201\fR\fI \fR
4503 .RE
4504
4505 elasticsearch:use tls (S)
4506 .PP
4507 .RS 4
4508 Specifies whether to use HTTPS when talking to the Elasticsearch server used for Spotlight queries when using the Elasticsearch backend\&.
4509 .sp
4510 Default:
4511 \fI\fIelasticsearch:use tls\fR\fR\fI = \fR\fIno\fR\fI \fR
4512 .sp
4513 Example:
4514 \fI\fIelasticsearch:use tls\fR\fR\fI = \fR\fIyes\fR\fI \fR
4515 .RE
4516
4517 enable asu support (G)
4518 .PP
4519 .RS 4
4520 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\&.
4521 .sp
4522 Default:
4523 \fI\fIenable asu support\fR\fR\fI = \fR\fIno\fR\fI \fR
4524 .RE
4525
4526 enable core files (G)
4527 .PP
4528 .RS 4
4529 This parameter specifies whether core dumps should be written on internal exits\&. Normally set to
4530 \fByes\fR\&. You should never need to change this\&.
4531 .sp
4532 Default:
4533 \fI\fIenable core files\fR\fR\fI = \fR\fIyes\fR\fI \fR
4534 .sp
4535 Example:
4536 \fI\fIenable core files\fR\fR\fI = \fR\fIno\fR\fI \fR
4537 .RE
4538
4539 enable privileges (G)
4540 .PP
4541 .RS 4
4542 This deprecated parameter controls whether or not smbd will honor privileges assigned to specific SIDs via either
4543 net rpc rights
4544 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\&.
4545 .sp
4546 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\&.
4547 .sp
4548 Please read the extended description provided in the Samba HOWTO documentation\&.
4549 .sp
4550 Default:
4551 \fI\fIenable privileges\fR\fR\fI = \fR\fIyes\fR\fI \fR
4552 .RE
4553
4554 enable spoolss (G)
4555 .PP
4556 .RS 4
4557 Inverted synonym for
4558 \m[blue]\fBdisable spoolss\fR\m[]\&.
4559 .sp
4560 Default:
4561 \fI\fIenable spoolss\fR\fR\fI = \fR\fIyes\fR\fI \fR
4562 .RE
4563
4564 encrypt passwords (G)
4565 .PP
4566 .RS 4
4567 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\&.
4568 .sp
4569 That is, in the future, the current default of
4570 encrypt passwords = yes
4571 will be the enforced behaviour\&.
4572 .sp
4573 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\&.
4574 .sp
4575 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\&.
4576 .sp
4577 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\&.
4578 .sp
4579 In order for encrypted passwords to work correctly
4580 \fBsmbd\fR(8)
4581 must either have access to a local
4582 \fBsmbpasswd\fR(5)
4583 file (see the
4584 \fBsmbpasswd\fR(8)
4585 program for information on how to set up and maintain this file), or set the
4586 \m[blue]\fBsecurity = [domain|ads]\fR\m[]
4587 parameter which causes
4588 smbd
4589 to authenticate against another server\&.
4590 .sp
4591 Default:
4592 \fI\fIencrypt passwords\fR\fR\fI = \fR\fIyes\fR\fI \fR
4593 .RE
4594
4595 enhanced browsing (G)
4596 .PP
4597 .RS 4
4598 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\&.
4599 .sp
4600 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\&.
4601 .sp
4602 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\&.
4603 .sp
4604 In general you should leave this option enabled as it makes cross\-subnet browse propagation much more reliable\&.
4605 .sp
4606 Default:
4607 \fI\fIenhanced browsing\fR\fR\fI = \fR\fIyes\fR\fI \fR
4608 .RE
4609
4610 enumports command (G)
4611 .PP
4612 .RS 4
4613 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
4614 does not use a port name for anything) other than the default
4615 \fB"Samba Printer Port"\fR, you can define
4616 \fIenumports command\fR
4617 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\&.
4618 .sp
4619 Default:
4620 \fI\fIenumports command\fR\fR\fI = \fR\fI\fR\fI \fR
4621 .sp
4622 Example:
4623 \fI\fIenumports command\fR\fR\fI = \fR\fI/usr/bin/listports\fR\fI \fR
4624 .RE
4625
4626 eventlog list (G)
4627 .PP
4628 .RS 4
4629 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
4630 $(statedir)/eventlog\&.
4631 .sp
4632 The administrator must use an external process to parse the normal Unix logs such as
4633 /var/log/messages
4634 and write then entries to the eventlog tdb files\&. Refer to the eventlogadm(8) utility for how to write eventlog entries\&.
4635 .sp
4636 Default:
4637 \fI\fIeventlog list\fR\fR\fI = \fR\fI\fR\fI \fR
4638 .sp
4639 Example:
4640 \fI\fIeventlog list\fR\fR\fI = \fR\fISecurity Application Syslog Apache\fR\fI \fR
4641 .RE
4642
4643 fake directory create times (S)
4644 .PP
4645 .RS 4
4646 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\&.
4647 .sp
4648 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\&.
4649 .sp
4650 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\&.
4651 .sp
4652 Default:
4653 \fI\fIfake directory create times\fR\fR\fI = \fR\fIno\fR\fI \fR
4654 .RE
4655
4656 fake oplocks (S)
4657 .PP
4658 .RS 4
4659 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\&.
4660 .sp
4661 When you set
4662 fake oplocks = yes,
4663 \fBsmbd\fR(8)
4664 will always grant oplock requests no matter how many clients are using the file\&.
4665 .sp
4666 It is generally much better to use the real
4667 \m[blue]\fBoplocks\fR\m[]
4668 support rather than this parameter\&.
4669 .sp
4670 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!
4671 .sp
4672 Default:
4673 \fI\fIfake oplocks\fR\fR\fI = \fR\fIno\fR\fI \fR
4674 .RE
4675
4676 follow symlinks (S)
4677 .PP
4678 .RS 4
4679 This parameter allows the Samba administrator to stop
4680 \fBsmbd\fR(8)
4681 from following symbolic links in a particular share\&. Setting this parameter to
4682 \fBno\fR
4683 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
4684 /etc/passwd
4685 in their home directory for instance\&. However it will slow filename lookups down slightly\&.
4686 .sp
4687 This option is enabled (i\&.e\&.
4688 smbd
4689 will follow symbolic links) by default\&.
4690 .sp
4691 Default:
4692 \fI\fIfollow symlinks\fR\fR\fI = \fR\fIyes\fR\fI \fR
4693 .RE
4694
4695 smbd force process locks (S)
4696 .PP
4697 .RS 4
4698 This boolean option tells
4699 smbd
4700 whether to forcefully disable the use of Open File Description locks on Linux\&.
4701 .sp
4702 This option should not be changed from the default unless you know what you\*(Aqre doing\&.
4703 .sp
4704 Default:
4705 \fI\fIsmbd force process locks\fR\fR\fI = \fR\fIno\fR\fI \fR
4706 .RE
4707
4708 force create mode (S)
4709 .PP
4710 .RS 4
4711 This parameter specifies a set of UNIX mode bit permissions that will
4712 \fIalways\fR
4713 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
4714 \fIcreate mask\fR
4715 parameter is applied\&.
4716 .sp
4717 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\&.
4718 .sp
4719 Default:
4720 \fI\fIforce create mode\fR\fR\fI = \fR\fI0000\fR\fI \fR
4721 .sp
4722 Example:
4723 \fI\fIforce create mode\fR\fR\fI = \fR\fI0755\fR\fI \fR
4724 .RE
4725
4726 force directory mode (S)
4727 .PP
4728 .RS 4
4729 This parameter specifies a set of UNIX mode bit permissions that will
4730 \fIalways\fR
4731 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
4732 \fIdirectory mask\fR
4733 is applied\&.
4734 .sp
4735 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\&.
4736 .sp
4737 Default:
4738 \fI\fIforce directory mode\fR\fR\fI = \fR\fI0000\fR\fI \fR
4739 .sp
4740 Example:
4741 \fI\fIforce directory mode\fR\fR\fI = \fR\fI0755\fR\fI \fR
4742 .RE
4743
4744 force directory security mode (S)
4745 .PP
4746 .RS 4
4747 This parameter has been removed for Samba 4\&.0\&.0\&.
4748 .sp
4749 \fINo default\fR
4750 .RE
4751
4752 group
4753 .PP
4754 .RS 4
4755 This parameter is a synonym for
4756 force group\&.
4757 .RE
4758
4759 force group (S)
4760 .PP
4761 .RS 4
4762 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\&.
4763 .sp
4764 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
4765 force group = +sys
4766 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\&.
4767 .sp
4768 If the
4769 \m[blue]\fBforce user\fR\m[]
4770 parameter is also set the group specified in
4771 \fIforce group\fR
4772 will override the primary group set in
4773 \fIforce user\fR\&.
4774 .sp
4775 Default:
4776 \fI\fIforce group\fR\fR\fI = \fR\fI\fR\fI \fR
4777 .sp
4778 Example:
4779 \fI\fIforce group\fR\fR\fI = \fR\fIagroup\fR\fI \fR
4780 .RE
4781
4782 force printername (S)
4783 .PP
4784 .RS 4
4785 When printing from Windows NT (or later), each printer in
4786 smb\&.conf
4787 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
4788 \fIprinter name\fR
4789 option)\&.
4790 .sp
4791 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
4792 \fIforce printername = yes\fR\&.
4793 .sp
4794 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\&.
4795 .sp
4796 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\&.
4797 .sp
4798 Default:
4799 \fI\fIforce printername\fR\fR\fI = \fR\fIno\fR\fI \fR
4800 .RE
4801
4802 force security mode (S)
4803 .PP
4804 .RS 4
4805 This parameter has been removed for Samba 4\&.0\&.0\&.
4806 .sp
4807 \fINo default\fR
4808 .RE
4809
4810 force unknown acl user (S)
4811 .PP
4812 .RS 4
4813 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\&.
4814 .sp
4815 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\&.
4816 .sp
4817 Try using this parameter when XCOPY /O gives an ACCESS_DENIED error\&.
4818 .sp
4819 Default:
4820 \fI\fIforce unknown acl user\fR\fR\fI = \fR\fIno\fR\fI \fR
4821 .RE
4822
4823 force user (S)
4824 .PP
4825 .RS 4
4826 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\&.
4827 .sp
4828 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\&.
4829 .sp
4830 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)\&.
4831 .sp
4832 Default:
4833 \fI\fIforce user\fR\fR\fI = \fR\fI\fR\fI \fR
4834 .sp
4835 Example:
4836 \fI\fIforce user\fR\fR\fI = \fR\fIauser\fR\fI \fR
4837 .RE
4838
4839 fss: prune stale (G)
4840 .PP
4841 .RS 4
4842 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\&.
4843 .sp
4844 Default:
4845 \fI\fIfss: prune stale\fR\fR\fI = \fR\fIno\fR\fI \fR
4846 .sp
4847 Example:
4848 \fI\fIfss: prune stale\fR\fR\fI = \fR\fIyes\fR\fI \fR
4849 .RE
4850
4851 fss: sequence timeout (G)
4852 .PP
4853 .RS 4
4854 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\&.
4855 .sp
4856 Default:
4857 \fI\fIfss: sequence timeout\fR\fR\fI = \fR\fI180 or 1800, depending on operation\fR\fI \fR
4858 .sp
4859 Example:
4860 \fI\fIfss: sequence timeout\fR\fR\fI = \fR\fI0\fR\fI \fR
4861 .RE
4862
4863 fstype (S)
4864 .PP
4865 .RS 4
4866 This parameter allows the administrator to configure the string that specifies the type of filesystem a share is using that is reported by
4867 \fBsmbd\fR(8)
4868 when a client queries the filesystem type for a share\&. The default type is
4869 \fBNTFS\fR
4870 for compatibility with Windows NT but this can be changed to other strings such as
4871 \fBSamba\fR
4872 or
4873 \fBFAT\fR
4874 if required\&.
4875 .sp
4876 Default:
4877 \fI\fIfstype\fR\fR\fI = \fR\fINTFS\fR\fI \fR
4878 .sp
4879 Example:
4880 \fI\fIfstype\fR\fR\fI = \fR\fISamba\fR\fI \fR
4881 .RE
4882
4883 get quota command (G)
4884 .PP
4885 .RS 4
4886 The
4887 get quota command
4888 should only be used whenever there is no operating system API available from the OS that samba can use\&.
4889 .sp
4890 This option is only available Samba was compiled with quotas support\&.
4891 .sp
4892 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\&.
4893 .sp
4894 Such a script is being given 3 arguments:
4895 .RS
4896 .sp
4897 .RS 4
4898 .ie n \{\
4899 \h'-04'\(bu\h'+03'\c
4900 .\}
4901 .el \{\
4902 .sp -1
4903 .IP \(bu 2.3
4904 .\}
4905 directory
4906 .RE
4907 .sp
4908 .RS 4
4909 .ie n \{\
4910 \h'-04'\(bu\h'+03'\c
4911 .\}
4912 .el \{\
4913 .sp -1
4914 .IP \(bu 2.3
4915 .\}
4916 type of query
4917 .RE
4918 .sp
4919 .RS 4
4920 .ie n \{\
4921 \h'-04'\(bu\h'+03'\c
4922 .\}
4923 .el \{\
4924 .sp -1
4925 .IP \(bu 2.3
4926 .\}
4927 uid of user or gid of group
4928 .RE
4929 .sp
4930 .RE
4931 The directory is actually mostly just "\&." \- It needs to be treated relatively to the current working directory that the script can also query\&.
4932 .sp
4933 The type of query can be one of:
4934 .RS
4935 .sp
4936 .RS 4
4937 .ie n \{\
4938 \h'-04'\(bu\h'+03'\c
4939 .\}
4940 .el \{\
4941 .sp -1
4942 .IP \(bu 2.3
4943 .\}
4944 1 \- user quotas
4945 .RE
4946 .sp
4947 .RS 4
4948 .ie n \{\
4949 \h'-04'\(bu\h'+03'\c
4950 .\}
4951 .el \{\
4952 .sp -1
4953 .IP \(bu 2.3
4954 .\}
4955 2 \- user default quotas (uid = \-1)
4956 .RE
4957 .sp
4958 .RS 4
4959 .ie n \{\
4960 \h'-04'\(bu\h'+03'\c
4961 .\}
4962 .el \{\
4963 .sp -1
4964 .IP \(bu 2.3
4965 .\}
4966 3 \- group quotas
4967 .RE
4968 .sp
4969 .RS 4
4970 .ie n \{\
4971 \h'-04'\(bu\h'+03'\c
4972 .\}
4973 .el \{\
4974 .sp -1
4975 .IP \(bu 2.3
4976 .\}
4977 4 \- group default quotas (gid = \-1)
4978 .RE
4979 .sp
4980 .RE
4981 This script should print one line as output with spaces between the columns\&. The printed columns should be:
4982 .RS
4983 .sp
4984 .RS 4
4985 .ie n \{\
4986 \h'-04'\(bu\h'+03'\c
4987 .\}
4988 .el \{\
4989 .sp -1
4990 .IP \(bu 2.3
4991 .\}
4992 1 \- quota flags (0 = no quotas, 1 = quotas enabled, 2 = quotas enabled and enforced)
4993 .RE
4994 .sp
4995 .RS 4
4996 .ie n \{\
4997 \h'-04'\(bu\h'+03'\c
4998 .\}
4999 .el \{\
5000 .sp -1
5001 .IP \(bu 2.3
5002 .\}
5003 2 \- number of currently used blocks
5004 .RE
5005 .sp
5006 .RS 4
5007 .ie n \{\
5008 \h'-04'\(bu\h'+03'\c
5009 .\}
5010 .el \{\
5011 .sp -1
5012 .IP \(bu 2.3
5013 .\}
5014 3 \- the softlimit number of blocks
5015 .RE
5016 .sp
5017 .RS 4
5018 .ie n \{\
5019 \h'-04'\(bu\h'+03'\c
5020 .\}
5021 .el \{\
5022 .sp -1
5023 .IP \(bu 2.3
5024 .\}
5025 4 \- the hardlimit number of blocks
5026 .RE
5027 .sp
5028 .RS 4
5029 .ie n \{\
5030 \h'-04'\(bu\h'+03'\c
5031 .\}
5032 .el \{\
5033 .sp -1
5034 .IP \(bu 2.3
5035 .\}
5036 5 \- currently used number of inodes
5037 .RE
5038 .sp
5039 .RS 4
5040 .ie n \{\
5041 \h'-04'\(bu\h'+03'\c
5042 .\}
5043 .el \{\
5044 .sp -1
5045 .IP \(bu 2.3
5046 .\}
5047 6 \- the softlimit number of inodes
5048 .RE
5049 .sp
5050 .RS 4
5051 .ie n \{\
5052 \h'-04'\(bu\h'+03'\c
5053 .\}
5054 .el \{\
5055 .sp -1
5056 .IP \(bu 2.3
5057 .\}
5058 7 \- the hardlimit number of inodes
5059 .RE
5060 .sp
5061 .RS 4
5062 .ie n \{\
5063 \h'-04'\(bu\h'+03'\c
5064 .\}
5065 .el \{\
5066 .sp -1
5067 .IP \(bu 2.3
5068 .\}
5069 8 (optional) \- the number of bytes in a block(default is 1024)
5070 .RE
5071 .sp
5072 .RE
5073 Default:
5074 \fI\fIget quota command\fR\fR\fI = \fR\fI\fR\fI \fR
5075 .sp
5076 Example:
5077 \fI\fIget quota command\fR\fR\fI = \fR\fI/usr/local/sbin/query_quota\fR\fI \fR
5078 .RE
5079
5080 getwd cache (G)
5081 .PP
5082 .RS 4
5083 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
5084 \m[blue]\fBwide links\fR\m[]
5085 parameter is set to
5086 \fBno\fR\&.
5087 .sp
5088 Default:
5089 \fI\fIgetwd cache\fR\fR\fI = \fR\fIyes\fR\fI \fR
5090 .RE
5091
5092 gpo update command (G)
5093 .PP
5094 .RS 4
5095 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\&.
5096 .sp
5097 Default:
5098 \fI\fIgpo update command\fR\fR\fI = \fR\fI/home/iurt/rpmbuild/BUILD/samba\-4\&.23\&.8\-build/samba\-4\&.23\&.8/source4/scripting/bin/samba\-gpupdate\fR\fI \fR
5099 .sp
5100 Example:
5101 \fI\fIgpo update command\fR\fR\fI = \fR\fI/usr/local/sbin/gpoupdate\fR\fI \fR
5102 .RE
5103
5104 guest account (G)
5105 .PP
5106 .RS 4
5107 This is a username which will be used for access to services which are specified as
5108 \m[blue]\fBguest ok\fR\m[]
5109 (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\&.
5110 .sp
5111 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
5112 su \-
5113 command) and trying to print using the system print command such as
5114 lpr(1)
5115 or
5116 lp(1)\&.
5117 .sp
5118 This parameter does not accept % macros, because many parts of the system require this value to be constant for correct operation\&.
5119 .sp
5120 Default:
5121 \fI\fIguest account\fR\fR\fI = \fR\fInobody # default can be changed at compile\-time\fR\fI \fR
5122 .sp
5123 Example:
5124 \fI\fIguest account\fR\fR\fI = \fR\fIftp\fR\fI \fR
5125 .RE
5126
5127 public
5128 .PP
5129 .RS 4
5130 This parameter is a synonym for
5131 guest ok\&.
5132 .RE
5133
5134 guest ok (S)
5135 .PP
5136 .RS 4
5137 If this parameter is
5138 \fByes\fR
5139 for a service, then no password is required to connect to the service\&. Privileges will be those of the
5140 \m[blue]\fBguest account\fR\m[]\&.
5141 .sp
5142 This parameter nullifies the benefits of setting
5143 \m[blue]\fBrestrict anonymous = 2\fR\m[]
5144 .sp
5145 See the section below on
5146 \m[blue]\fBsecurity\fR\m[]
5147 for more information about this option\&.
5148 .sp
5149 Default:
5150 \fI\fIguest ok\fR\fR\fI = \fR\fIno\fR\fI \fR
5151 .RE
5152
5153 only guest
5154 .PP
5155 .RS 4
5156 This parameter is a synonym for
5157 guest only\&.
5158 .RE
5159
5160 guest only (S)
5161 .PP
5162 .RS 4
5163 If this parameter is
5164 \fByes\fR
5165 for a service, then only guest connections to the service are permitted\&. This parameter will have no effect if
5166 \m[blue]\fBguest ok\fR\m[]
5167 is not set for the service\&.
5168 .sp
5169 See the section below on
5170 \m[blue]\fBsecurity\fR\m[]
5171 for more information about this option\&.
5172 .sp
5173 Default:
5174 \fI\fIguest only\fR\fR\fI = \fR\fIno\fR\fI \fR
5175 .RE
5176
5177 hide dot files (S)
5178 .PP
5179 .RS 4
5180 This is a boolean parameter that controls whether files starting with a dot appear as hidden files\&.
5181 .sp
5182 Default:
5183 \fI\fIhide dot files\fR\fR\fI = \fR\fIyes\fR\fI \fR
5184 .RE
5185
5186 hide files (S)
5187 .PP
5188 .RS 4
5189 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\&.
5190 .sp
5191 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\&.
5192 .sp
5193 \m[blue]\fBhide files\fR\m[]
5194 can also be used as a parametric option where NAME in
5195 .sp
5196 hide files : NAME =
5197 .sp
5198 specifies a user or group name with the same syntax as
5199 \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\&.
5200 .sp
5201 Each entry must be a Unix path, not a DOS path and must not include the Unix directory separator \*(Aq/\*(Aq\&.
5202 .sp
5203 Note that the case sensitivity option is applicable in hiding files\&.
5204 .sp
5205 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\&.
5206 .sp
5207 The example shown above is based on files that the Macintosh SMB client (DAVE) available from
5208 Thursby
5209 creates for internal use, and also still hides all files beginning with a dot\&.
5210 .sp
5211 An example of us of this parameter is:
5212 .sp
5213 .if n \{\
5214 .RS 4
5215 .\}
5216 .nf
5217 hide files = /\&.*/DesktopFolderDB/TrashFor%m/resource\&.frk/
5218
5219 ; Hide some files for anyone and some files for specific users and groups
5220 hide files = /hideforall1/
5221 hide files : USER = /hidetoforuser/
5222 hide files : GROUP = /hideforgroup/
5223 hide files : UNIVERSITY\eAlumnis = /somefile\&.txt/
5224 hide files : john@university\&.org = /anotherfile\&.txt/
5225 hide files : S\-1\-5\-21\-123\-456\-789\-1000 = /secretfile\&.txt/
5226
5227 .fi
5228 .if n \{\
5229 .RE
5230 .\}
5231 .sp
5232 Default:
5233 \fI\fIhide files\fR\fR\fI = \fR\fI # no file are hidden\fR\fI \fR
5234 .RE
5235
5236 hide new files timeout (S)
5237 .PP
5238 .RS 4
5239 Setting this parameter to something but 0 hides files that have been modified less than N seconds ago\&.
5240 .sp
5241 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\&.
5242 .sp
5243 Default:
5244 \fI\fIhide new files timeout\fR\fR\fI = \fR\fI0\fR\fI \fR
5245 .RE
5246
5247 hide special files (S)
5248 .PP
5249 .RS 4
5250 This parameter prevents clients from seeing special files such as sockets, devices and fifo\*(Aqs in directory listings\&.
5251 .sp
5252 Default:
5253 \fI\fIhide special files\fR\fR\fI = \fR\fIno\fR\fI \fR
5254 .RE
5255
5256 hide unreadable (S)
5257 .PP
5258 .RS 4
5259 This parameter prevents clients from seeing the existence of files that cannot be read\&. Defaults to off\&.
5260 .sp
5261 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\&.
5262 .sp
5263 Default:
5264 \fI\fIhide unreadable\fR\fR\fI = \fR\fIno\fR\fI \fR
5265 .RE
5266
5267 hide unwriteable files (S)
5268 .PP
5269 .RS 4
5270 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\&.
5271 .sp
5272 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\&.
5273 .sp
5274 Default:
5275 \fI\fIhide unwriteable files\fR\fR\fI = \fR\fIno\fR\fI \fR
5276 .RE
5277
5278 himmelblaud hello enabled (G)
5279 .PP
5280 .RS 4
5281 This parameter controls Hello enrollment and authentication to Azure Entra ID\&. By default, it is disabled to prevent security risks, such as on hosts exposing the SSH port\&. Administrators should enable this setting only when Hello enrollment is appropriate for their environment\&.
5282 .sp
5283 Default:
5284 \fI\fIhimmelblaud hello enabled\fR\fR\fI = \fR\fIno\fR\fI \fR
5285 .sp
5286 Example:
5287 \fI\fIhimmelblaud hello enabled\fR\fR\fI = \fR\fIyes\fR\fI \fR
5288 .RE
5289
5290 himmelblaud hsm pin path (G)
5291 .PP
5292 .RS 4
5293 Specifies the file path where the HSM PIN is stored\&. This PIN is used for unlocking TPM objects required for Azure Entra ID authentication\&. The HSM PIN is critical for ensuring secure communication and authentication within the Himmelblaud daemon\&.
5294 .sp
5295 Default:
5296 \fI\fIhimmelblaud hsm pin path\fR\fR\fI = \fR\fI/var/lib/himmelblaud/hsm\-pin\fR\fI \fR
5297 .RE
5298
5299 himmelblaud sfa fallback (G)
5300 .PP
5301 .RS 4
5302 This parameter is designed to control whether Himmelblaud should fallback to Single Factor Authentication (SFA) if Multi\-Factor Authentication (MFA) isn\*(Aqt available\&. This normally is possible during a short window during which MFA enrollment is available to a new user\&.
5303 .sp
5304 Default:
5305 \fI\fIhimmelblaud sfa fallback\fR\fR\fI = \fR\fIno\fR\fI \fR
5306 .sp
5307 Example:
5308 \fI\fIhimmelblaud sfa fallback\fR\fR\fI = \fR\fIyes\fR\fI \fR
5309 .RE
5310
5311 honor change notify privilege (S)
5312 .PP
5313 .RS 4
5314 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\&.
5315 .sp
5316 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\&.
5317 .sp
5318 Default:
5319 \fI\fIhonor change notify privilege\fR\fR\fI = \fR\fIno\fR\fI \fR
5320 .RE
5321
5322 host msdfs (G)
5323 .PP
5324 .RS 4
5325 If set to
5326 \fByes\fR, Samba will act as a Dfs server, and allow Dfs\-aware clients to browse Dfs trees hosted on the server\&.
5327 .sp
5328 See also the
5329 \m[blue]\fBmsdfs root\fR\m[]
5330 share level parameter\&. For more information on setting up a Dfs tree on Samba, refer to the MSFDS chapter in the book Samba3\-HOWTO\&.
5331 .sp
5332 Default:
5333 \fI\fIhost msdfs\fR\fR\fI = \fR\fIyes\fR\fI \fR
5334 .RE
5335
5336 hostname lookups (G)
5337 .PP
5338 .RS 4
5339 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
5340 hosts deny
5341 and
5342 hosts allow\&.
5343 .sp
5344 Default:
5345 \fI\fIhostname lookups\fR\fR\fI = \fR\fIno\fR\fI \fR
5346 .sp
5347 Example:
5348 \fI\fIhostname lookups\fR\fR\fI = \fR\fIyes\fR\fI \fR
5349 .RE
5350
5351 allow hosts
5352 .PP
5353 .RS 4
5354 This parameter is a synonym for
5355 hosts allow\&.
5356 .RE
5357
5358 hosts allow (S)
5359 .PP
5360 .RS 4
5361 A synonym for this parameter is
5362 \m[blue]\fBallow hosts\fR\m[]\&.
5363 .sp
5364 This parameter is a comma, space, or tab delimited set of hosts which are permitted to access a service\&.
5365 .sp
5366 If specified in the [global] section then it will apply to all services, regardless of whether the individual service has a different setting\&.
5367 .sp
5368 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
5369 allow hosts = 150\&.203\&.5\&.\&. The full syntax of the list is described in the man page
5370 hosts_access(5)\&. Note that this man page may not be present on your system, so a brief description will be given here also\&.
5371 .sp
5372 Note that the localhost address 127\&.0\&.0\&.1 will always be allowed access unless specifically denied by a
5373 \m[blue]\fBhosts deny\fR\m[]
5374 option\&.
5375 .sp
5376 You can also specify hosts by network/netmask pairs and by netgroup names if your system supports netgroups\&. The
5377 \fIEXCEPT\fR
5378 keyword can also be used to limit a wildcard list\&. The following examples may provide some help:
5379 .sp
5380 Example 1: allow all IPs in 150\&.203\&.*\&.*; except one
5381 .sp
5382 hosts allow = 150\&.203\&. EXCEPT 150\&.203\&.6\&.66
5383 .sp
5384 Example 2: allow hosts that match the given network/netmask
5385 .sp
5386 hosts allow = 150\&.203\&.15\&.0/255\&.255\&.255\&.0
5387 .sp
5388 Example 3: allow a couple of hosts
5389 .sp
5390 hosts allow = lapland, arvidsjaur
5391 .sp
5392 Example 4: allow only hosts in NIS netgroup "foonet", but deny access from one particular host
5393 .sp
5394 hosts allow = @foonet
5395 .sp
5396 hosts deny = pirate
5397 .if n \{\
5398 .sp
5399 .\}
5400 .RS 4
5401 .it 1 an-trap
5402 .nr an-no-space-flag 1
5403 .nr an-break-flag 1
5404 .br
5405 .ps +1
5406 \fBNote\fR
5407 .ps -1
5408 .br
5409 Note that access still requires suitable user\-level passwords\&.
5410 .sp .5v
5411 .RE
5412 See
5413 \fBtestparm\fR(1)
5414 for a way of testing your host access to see if it does what you expect\&.
5415 .sp
5416 Default:
5417 \fI\fIhosts allow\fR\fR\fI = \fR\fI # none (i\&.e\&., all hosts permitted access)\fR\fI \fR
5418 .sp
5419 Example:
5420 \fI\fIhosts allow\fR\fR\fI = \fR\fI150\&.203\&.5\&. myhost\&.mynet\&.edu\&.au\fR\fI \fR
5421 .RE
5422
5423 deny hosts
5424 .PP
5425 .RS 4
5426 This parameter is a synonym for
5427 hosts deny\&.
5428 .RE
5429
5430 hosts deny (S)
5431 .PP
5432 .RS 4
5433 The opposite of
5434 \fIhosts allow\fR
5435 \- hosts listed here are
5436 \fINOT\fR
5437 permitted access to services unless the specific services have their own lists to override this one\&. Where the lists conflict, the
5438 \fIallow\fR
5439 list takes precedence\&.
5440 .sp
5441 In the event that it is necessary to deny all by default, use the keyword ALL (or the netmask
5442 0\&.0\&.0\&.0/0) and then explicitly specify to the
5443 \m[blue]\fBhosts allow = hosts allow\fR\m[]
5444 parameter those hosts that should be permitted access\&.
5445 .sp
5446 Default:
5447 \fI\fIhosts deny\fR\fR\fI = \fR\fI # none (i\&.e\&., no hosts specifically excluded)\fR\fI \fR
5448 .sp
5449 Example:
5450 \fI\fIhosts deny\fR\fR\fI = \fR\fI150\&.203\&.4\&. badhost\&.mynet\&.edu\&.au\fR\fI \fR
5451 .RE
5452
5453 idmap backend (G)
5454 .PP
5455 .RS 4
5456 The idmap backend provides a plugin interface for Winbind to use varying backends to store SID/uid/gid mapping tables\&.
5457 .sp
5458 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
5459 \m[blue]\fBidmap config * : backend\fR\m[]\&.
5460 .sp
5461 Default:
5462 \fI\fIidmap backend\fR\fR\fI = \fR\fItdb\fR\fI \fR
5463 .RE
5464
5465 idmap cache time (G)
5466 .PP
5467 .RS 4
5468 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\&.
5469 .sp
5470 Default:
5471 \fI\fIidmap cache time\fR\fR\fI = \fR\fI604800\fR\fI \fR
5472 .RE
5473
5474 idmap config DOMAIN : OPTION (G)
5475 .PP
5476 .RS 4
5477 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
5478 \m[blue]\fBidmap config\fR\m[]
5479 prefix\&. An idmap option consists of the
5480 \m[blue]\fBidmap config\fR\m[]
5481 prefix, followed by a domain name or the asterisk character (*), a colon, and the name of an idmap setting for the chosen domain\&.
5482 .sp
5483 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\&.
5484 .sp
5485 There are three general options available:
5486 .PP
5487 backend = backend_name
5488 .RS 4
5489 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\&.
5490 .sp
5491 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\&.
5492 .RE
5493 .PP
5494 range = low \- high
5495 .RS 4
5496 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\&.
5497 .sp
5498 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\&.
5499 .sp
5500 Note that the low value interacts with the
5501 \m[blue]\fBmin domain uid\fR\m[]
5502 option!
5503 .RE
5504 .PP
5505 read only = yes|no
5506 .RS 4
5507 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\&.
5508 .RE
5509 .sp
5510 The following example illustrates how to configure the
5511 \fBidmap_ad\fR(8)
5512 backend for the CORP domain and the
5513 \fBidmap_tdb\fR(8)
5514 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\&.
5515 .sp
5516 .if n \{\
5517 .RS 4
5518 .\}
5519 .nf
5520 idmap config * : backend = tdb
5521 idmap config * : range = 1000000\-1999999
5522
5523 idmap config CORP : backend = ad
5524 idmap config CORP : range = 1000\-999999
5525
5526 .fi
5527 .if n \{\
5528 .RE
5529 .\}
5530 .sp
5531 \fINo default\fR
5532 .RE
5533
5534 winbind gid
5535 .PP
5536 .RS 4
5537 This parameter is a synonym for
5538 idmap gid\&.
5539 .RE
5540
5541 idmap gid (G)
5542 .PP
5543 .RS 4
5544 The idmap gid parameter specifies the range of group ids for the default idmap configuration\&. It is now deprecated in favour of
5545 \m[blue]\fBidmap config * : range\fR\m[]\&.
5546 .sp
5547 See the
5548 \m[blue]\fBidmap config\fR\m[]
5549 option\&.
5550 .sp
5551 Default:
5552 \fI\fIidmap gid\fR\fR\fI = \fR\fI\fR\fI \fR
5553 .sp
5554 Example:
5555 \fI\fIidmap gid\fR\fR\fI = \fR\fI10000\-20000\fR\fI \fR
5556 .RE
5557
5558 idmap negative cache time (G)
5559 .PP
5560 .RS 4
5561 This parameter specifies the number of seconds that Winbind\*(Aqs idmap interface will cache negative SID/uid/gid query results\&.
5562 .sp
5563 Default:
5564 \fI\fIidmap negative cache time\fR\fR\fI = \fR\fI120\fR\fI \fR
5565 .RE
5566
5567 winbind uid
5568 .PP
5569 .RS 4
5570 This parameter is a synonym for
5571 idmap uid\&.
5572 .RE
5573
5574 idmap uid (G)
5575 .PP
5576 .RS 4
5577 The idmap uid parameter specifies the range of user ids for the default idmap configuration\&. It is now deprecated in favour of
5578 \m[blue]\fBidmap config * : range\fR\m[]\&.
5579 .sp
5580 See the
5581 \m[blue]\fBidmap config\fR\m[]
5582 option\&.
5583 .sp
5584 Default:
5585 \fI\fIidmap uid\fR\fR\fI = \fR\fI\fR\fI \fR
5586 .sp
5587 Example:
5588 \fI\fIidmap uid\fR\fR\fI = \fR\fI10000\-20000\fR\fI \fR
5589 .RE
5590
5591 include (S)
5592 .PP
5593 .RS 4
5594 This allows you to include one config file inside another\&. The file is included literally, as though typed in place\&.
5595 .sp
5596 It takes the standard substitutions, except
5597 \fI%u\fR,
5598 \fI%P\fR
5599 and
5600 \fI%S\fR\&.
5601 .sp
5602 The parameter
5603 \fIinclude = registry\fR
5604 has a special meaning: It does
5605 \fInot\fR
5606 include a file named
5607 \fIregistry\fR
5608 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\&.
5609 .sp
5610 Default:
5611 \fI\fIinclude\fR\fR\fI = \fR\fI\fR\fI \fR
5612 .sp
5613 Example:
5614 \fI\fIinclude\fR\fR\fI = \fR\fI/usr/local/samba/lib/admin_smb\&.conf\fR\fI \fR
5615 .RE
5616
5617 include system krb5 conf (G)
5618 .PP
5619 .RS 4
5620 Setting this parameter to
5621 no
5622 will prevent winbind to include the system /etc/krb5\&.conf file into the krb5\&.conf file it creates\&. See also
5623 \m[blue]\fBcreate krb5 conf\fR\m[]\&. This option only applies to Samba built with MIT Kerberos\&.
5624 .sp
5625 Default:
5626 \fI\fIinclude system krb5 conf\fR\fR\fI = \fR\fIyes\fR\fI \fR
5627 .RE
5628
5629 inherit acls (S)
5630 .PP
5631 .RS 4
5632 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\&.
5633 .sp
5634 Default:
5635 \fI\fIinherit acls\fR\fR\fI = \fR\fIno\fR\fI \fR
5636 .RE
5637
5638 inherit owner (S)
5639 .PP
5640 .RS 4
5641 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\&.
5642 .sp
5643 Valid options are:
5644 .RS
5645 .sp
5646 .RS 4
5647 .ie n \{\
5648 \h'-04'\(bu\h'+03'\c
5649 .\}
5650 .el \{\
5651 .sp -1
5652 .IP \(bu 2.3
5653 .\}
5654 \fBno\fR
5655 \- 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\&.
5656 .RE
5657 .sp
5658 .RS 4
5659 .ie n \{\
5660 \h'-04'\(bu\h'+03'\c
5661 .\}
5662 .el \{\
5663 .sp -1
5664 .IP \(bu 2.3
5665 .\}
5666 \fBwindows and unix\fR
5667 \- The Windows (SID) owner and the UNIX (uid) owner of new files and directories are set to the respective owner of the parent directory\&.
5668 .RE
5669 .sp
5670 .RS 4
5671 .ie n \{\
5672 \h'-04'\(bu\h'+03'\c
5673 .\}
5674 .el \{\
5675 .sp -1
5676 .IP \(bu 2.3
5677 .\}
5678 \fByes\fR
5679 \- a synonym for
5680 \fBwindows and unix\fR\&.
5681 .RE
5682 .sp
5683 .RS 4
5684 .ie n \{\
5685 \h'-04'\(bu\h'+03'\c
5686 .\}
5687 .el \{\
5688 .sp -1
5689 .IP \(bu 2.3
5690 .\}
5691 \fBunix only\fR
5692 \- Only the UNIX owner is set to the UNIX owner of the parent directory\&.
5693 .RE
5694 .sp
5695 .RE
5696 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\&.
5697 .sp
5698 The
5699 \fBunix only\fR
5700 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
5701 \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\&.
5702 .sp
5703 Default:
5704 \fI\fIinherit owner\fR\fR\fI = \fR\fIno\fR\fI \fR
5705 .RE
5706
5707 inherit permissions (S)
5708 .PP
5709 .RS 4
5710 The permissions on new files and directories are normally governed by
5711 \m[blue]\fBcreate mask\fR\m[],
5712 \m[blue]\fBdirectory mask\fR\m[],
5713 \m[blue]\fBforce create mode\fR\m[]
5714 and
5715 \m[blue]\fBforce directory mode\fR\m[]
5716 but the boolean inherit permissions parameter overrides this\&.
5717 .sp
5718 New directories inherit the mode of the parent directory, including bits such as setgid\&.
5719 .sp
5720 New files inherit their read/write bits from the parent directory\&. Their execute bits continue to be determined by
5721 \m[blue]\fBmap archive\fR\m[],
5722 \m[blue]\fBmap hidden\fR\m[]
5723 and
5724 \m[blue]\fBmap system\fR\m[]
5725 as usual\&.
5726 .sp
5727 Note that the setuid bit is
5728 \fInever\fR
5729 set via inheritance (the code explicitly prohibits this)\&.
5730 .sp
5731 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\&.
5732 .sp
5733 Default:
5734 \fI\fIinherit permissions\fR\fR\fI = \fR\fIno\fR\fI \fR
5735 .RE
5736
5737 init logon delay (G)
5738 .PP
5739 .RS 4
5740 This parameter specifies a delay in milliseconds for the hosts configured for delayed initial samlogon with
5741 \m[blue]\fBinit logon delayed hosts\fR\m[]\&.
5742 .sp
5743 Default:
5744 \fI\fIinit logon delay\fR\fR\fI = \fR\fI100\fR\fI \fR
5745 .RE
5746
5747 init logon delayed hosts (G)
5748 .PP
5749 .RS 4
5750 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)\&.
5751 .sp
5752 The length of the delay can be specified with the
5753 \m[blue]\fBinit logon delay\fR\m[]
5754 parameter\&.
5755 .sp
5756 Default:
5757 \fI\fIinit logon delayed hosts\fR\fR\fI = \fR\fI\fR\fI \fR
5758 .sp
5759 Example:
5760 \fI\fIinit logon delayed hosts\fR\fR\fI = \fR\fI150\&.203\&.5\&. myhost\&.mynet\&.de\fR\fI \fR
5761 .RE
5762
5763 interfaces (G)
5764 .PP
5765 .RS 4
5766 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\&.
5767 .sp
5768 The option takes a list of interface strings\&. Each string can be in any of the following forms:
5769 .RS
5770 .sp
5771 .RS 4
5772 .ie n \{\
5773 \h'-04'\(bu\h'+03'\c
5774 .\}
5775 .el \{\
5776 .sp -1
5777 .IP \(bu 2.3
5778 .\}
5779 a network interface name (such as eth0)\&. This may include shell\-like wildcards so eth* will match any interface starting with the substring "eth"
5780 .RE
5781 .sp
5782 .RS 4
5783 .ie n \{\
5784 \h'-04'\(bu\h'+03'\c
5785 .\}
5786 .el \{\
5787 .sp -1
5788 .IP \(bu 2.3
5789 .\}
5790 an IP address\&. In this case the netmask is determined from the list of interfaces obtained from the kernel
5791 .RE
5792 .sp
5793 .RS 4
5794 .ie n \{\
5795 \h'-04'\(bu\h'+03'\c
5796 .\}
5797 .el \{\
5798 .sp -1
5799 .IP \(bu 2.3
5800 .\}
5801 an IP/mask pair\&.
5802 .RE
5803 .sp
5804 .RS 4
5805 .ie n \{\
5806 \h'-04'\(bu\h'+03'\c
5807 .\}
5808 .el \{\
5809 .sp -1
5810 .IP \(bu 2.3
5811 .\}
5812 a broadcast/mask pair\&.
5813 .RE
5814 .sp
5815 .RE
5816 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\&.
5817 .sp
5818 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\&.
5819 .sp
5820 By default Samba enables all active interfaces that are broadcast capable except the loopback adaptor (IP address 127\&.0\&.0\&.1)\&.
5821 .sp
5822 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):
5823 .sp
5824 "interface[;key1=value1[,key2=value2[\&.\&.\&.]]]"
5825 .sp
5826 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\&.
5827 .sp
5828 The possible values for options are "dynamic" and "nodynamic"\&. Use this option in combination with setting
5829 \m[blue]\fBbind interfaces only\fR\m[]
5830 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)\&.
5831 .sp
5832 Note that dynamically opening/closing listening sockets is only available on some operating systems (currently Linux)\&.
5833 .sp
5834 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\&.
5835 .sp
5836 The other examples show how per interface extra parameters can be specified\&. Notice the possible usage of "," and ";", which makes the double quoting necessary\&.
5837 .sp
5838 Default:
5839 \fI\fIinterfaces\fR\fR\fI = \fR\fI\fR\fI \fR
5840 .sp
5841 Example:
5842 \fI\fIinterfaces\fR\fR\fI = \fR\fIeth0 192\&.168\&.2\&.10/24 192\&.168\&.3\&.10/255\&.255\&.255\&.0\fR\fI \fR
5843 .sp
5844 Example:
5845 \fI\fIinterfaces\fR\fR\fI = \fR\fIeth0, 192\&.168\&.2\&.10/24; 192\&.168\&.3\&.10/255\&.255\&.255\&.0\fR\fI \fR
5846 .sp
5847 Example:
5848 \fI\fIinterfaces\fR\fR\fI = \fR\fI"eth0;if_index=65,speed=1000000000,capability=RSS"\fR\fI \fR
5849 .sp
5850 Example:
5851 \fI\fIinterfaces\fR\fR\fI = \fR\fI"lo;speed=1000000000" "eth0;capability=RSS"\fR\fI \fR
5852 .sp
5853 Example:
5854 \fI\fIinterfaces\fR\fR\fI = \fR\fI"lo;speed=1000000000" , "eth0;capability=RSS"\fR\fI \fR
5855 .sp
5856 Example:
5857 \fI\fIinterfaces\fR\fR\fI = \fR\fI"eth0;capability=RSS" , "rdma1;capability=RDMA" ; "rdma2;capability=RSS,capability=RDMA"\fR\fI \fR
5858 .sp
5859 Example:
5860 \fI\fIinterfaces\fR\fR\fI = \fR\fI"eth0;options=dynamic"\fR\fI \fR
5861 .RE
5862
5863 invalid users (S)
5864 .PP
5865 .RS 4
5866 This is a list of users that should not be allowed to login to this service\&. This is really a
5867 \fIparanoid\fR
5868 check to absolutely ensure an improper setting does not breach your security\&.
5869 .sp
5870 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\&.
5871 .sp
5872 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
5873 \fI+&group\fR
5874 means check the UNIX group database, followed by the NIS netgroup database, and the value
5875 \fI&+group\fR
5876 means check the NIS netgroup database, followed by the UNIX group database (the same as the \*(Aq@\*(Aq prefix)\&.
5877 .sp
5878 The current servicename is substituted for
5879 \fI%S\fR\&. This is useful in the [homes] section\&.
5880 .sp
5881 Default:
5882 \fI\fIinvalid users\fR\fR\fI = \fR\fI # no invalid users\fR\fI \fR
5883 .sp
5884 Example:
5885 \fI\fIinvalid users\fR\fR\fI = \fR\fIroot fred admin @wheel\fR\fI \fR
5886 .RE
5887
5888 iprint server (G)
5889 .PP
5890 .RS 4
5891 This parameter is only applicable if
5892 \m[blue]\fBprinting\fR\m[]
5893 is set to
5894 \fBiprint\fR\&.
5895 .sp
5896 If set, this option overrides the ServerName option in the CUPS
5897 client\&.conf\&. This is necessary if you have virtual samba servers that connect to different CUPS daemons\&.
5898 .sp
5899 Default:
5900 \fI\fIiprint server\fR\fR\fI = \fR\fI""\fR\fI \fR
5901 .sp
5902 Example:
5903 \fI\fIiprint server\fR\fR\fI = \fR\fIMYCUPSSERVER\fR\fI \fR
5904 .RE
5905
5906 kdc default domain supported enctypes (G)
5907 .PP
5908 .RS 4
5909 Set the default value of
5910 \fBmsDS\-SupportedEncryptionTypes\fR
5911 for service accounts in Active Directory that are missing this value or where
5912 \fBmsDS\-SupportedEncryptionTypes\fR
5913 is set to 0\&.
5914 .sp
5915 This allows Samba administrators to match the configuration flexibility provided by the
5916 \fBHKEY_LOCAL_MACHINE\eSystem\eCurrentControlSet\eservices\eKDC\eDefaultDomainSupportedEncTypes\fR
5917 Registry Value on Windows\&.
5918 .sp
5919 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\&.
5920 .sp
5921 Specified values are ORed together bitwise, and those currently supported consist of:
5922 .RS
5923 .sp
5924 .RS 4
5925 .ie n \{\
5926 \h'-04'\(bu\h'+03'\c
5927 .\}
5928 .el \{\
5929 .sp -1
5930 .IP \(bu 2.3
5931 .\}
5932 \fBarcfour\-hmac\-md5\fR,
5933 \fBrc4\-hmac\fR,
5934 \fB0x4\fR, or
5935 \fB4\fR
5936 .sp
5937 Known on Windows as Kerberos RC4 encryption
5938 .RE
5939 .sp
5940 .RS 4
5941 .ie n \{\
5942 \h'-04'\(bu\h'+03'\c
5943 .\}
5944 .el \{\
5945 .sp -1
5946 .IP \(bu 2.3
5947 .\}
5948 \fBaes128\-cts\-hmac\-sha1\-96\fR,
5949 \fBaes128\-cts\fR,
5950 \fB0x8\fR, or
5951 \fB8\fR
5952 .sp
5953 Known on Windows as Kerberos AES 128 bit encryption
5954 .RE
5955 .sp
5956 .RS 4
5957 .ie n \{\
5958 \h'-04'\(bu\h'+03'\c
5959 .\}
5960 .el \{\
5961 .sp -1
5962 .IP \(bu 2.3
5963 .\}
5964 \fBaes256\-cts\-hmac\-sha1\-96\fR,
5965 \fBaes256\-cts\fR,
5966 \fB0x10\fR, or
5967 \fB16\fR
5968 .sp
5969 Known on Windows as Kerberos AES 256 bit encryption
5970 .RE
5971 .sp
5972 .RS 4
5973 .ie n \{\
5974 \h'-04'\(bu\h'+03'\c
5975 .\}
5976 .el \{\
5977 .sp -1
5978 .IP \(bu 2.3
5979 .\}
5980 \fBaes256\-cts\-hmac\-sha1\-96\-sk\fR,
5981 \fBaes256\-cts\-sk\fR,
5982 \fB0x20\fR, or
5983 \fB32\fR
5984 .sp
5985 Allow AES session keys\&. When this is set, it indicates to the KDC that AES session keys can be used, even when
5986 \fBaes256\-cts\fR
5987 and
5988 \fBaes128\-cts\fR
5989 are not set\&. This allows use of AES keys against hosts otherwise only configured with RC4 for ticket keys (which is the default)\&.
5990 .RE
5991 .sp
5992 .RE
5993 Default:
5994 \fI\fIkdc default domain supported enctypes\fR\fR\fI = \fR\fI0 # maps to what the software supports currently: arcfour\-hmac\-md5 aes256\-cts\-hmac\-sha1\-96\-sk\fR\fI \fR
5995 .RE
5996
5997 kdc enable fast (G)
5998 .PP
5999 .RS 4
6000 With the Samba 4\&.16 the embedded Heimdal KDC brings support for RFC6113 FAST, which wasn\*(Aqt available in older Samba versions\&.
6001 .sp
6002 This option is mostly for testing and currently only applies if the embedded Heimdal KDC is used\&.
6003 .sp
6004 Default:
6005 \fI\fIkdc enable fast\fR\fR\fI = \fR\fIyes\fR\fI \fR
6006 .RE
6007
6008 kdc force enable rc4 weak session keys (G)
6009 .PP
6010 .RS 4
6011 \fBRFC8429\fR
6012 declares that
6013 \fBrc4\-hmac\fR
6014 Kerberos ciphers are weak and there are known attacks on Active Directory use of this cipher suite\&.
6015 .sp
6016 However for compatibility with Microsoft Windows this option allows the KDC to assume that regardless of the value set in a service account\*(Aqs
6017 \fBmsDS\-SupportedEncryptionTypes\fR
6018 attribute that a
6019 \fBrc4\-hmac\fR
6020 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\&.
6021 .sp
6022 Default:
6023 \fI\fIkdc force enable rc4 weak session keys\fR\fR\fI = \fR\fIno\fR\fI \fR
6024 .RE
6025
6026 kdc supported enctypes (G)
6027 .PP
6028 .RS 4
6029 On an active directory domain controller, this is the list of supported encryption types for local running kdc\&.
6030 .sp
6031 This allows Samba administrators to remove support for weak/unused encryption types, similar the configuration flexibility provided by the
6032 \fBNetwork security: Configure encryption types allowed for Kerberos\fR
6033 GPO/Local Policies/Security Options Value, which results in the
6034 \fBHKEY_LOCAL_MACHINE\eSOFTWARE\eMicrosoft\eWindows\eCurrentVersion\ePolicies\eSystem\eKerberos\eParameters\eSupportedEncryptionTypes\fR
6035 Registry Value on Windows\&.
6036 .sp
6037 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\&.
6038 .sp
6039 Specified values are ORed together bitwise, and those currently supported consist of:
6040 .RS
6041 .sp
6042 .RS 4
6043 .ie n \{\
6044 \h'-04'\(bu\h'+03'\c
6045 .\}
6046 .el \{\
6047 .sp -1
6048 .IP \(bu 2.3
6049 .\}
6050 \fBarcfour\-hmac\-md5\fR,
6051 \fBrc4\-hmac\fR,
6052 \fB0x4\fR, or
6053 \fB4\fR
6054 .sp
6055 Known on Windows as Kerberos RC4 encryption
6056 .RE
6057 .sp
6058 .RS 4
6059 .ie n \{\
6060 \h'-04'\(bu\h'+03'\c
6061 .\}
6062 .el \{\
6063 .sp -1
6064 .IP \(bu 2.3
6065 .\}
6066 \fBaes128\-cts\-hmac\-sha1\-96\fR,
6067 \fBaes128\-cts\fR,
6068 \fB0x8\fR, or
6069 \fB8\fR
6070 .sp
6071 Known on Windows as Kerberos AES 128 bit encryption
6072 .RE
6073 .sp
6074 .RS 4
6075 .ie n \{\
6076 \h'-04'\(bu\h'+03'\c
6077 .\}
6078 .el \{\
6079 .sp -1
6080 .IP \(bu 2.3
6081 .\}
6082 \fBaes256\-cts\-hmac\-sha1\-96\fR,
6083 \fBaes256\-cts\fR,
6084 \fB0x10\fR, or
6085 \fB16\fR
6086 .sp
6087 Known on Windows as Kerberos AES 256 bit encryption
6088 .RE
6089 .sp
6090 .RE
6091 Default:
6092 \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
6093 .RE
6094
6095 keepalive (G)
6096 .PP
6097 .RS 4
6098 The value of the parameter (an integer) represents the number of seconds between
6099 \fIkeepalive\fR
6100 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\&.
6101 .sp
6102 Keepalives should, in general, not be needed if the socket has the SO_KEEPALIVE attribute set on it by default\&. (see
6103 \m[blue]\fBsocket options\fR\m[])\&. Basically you should only use this option if you strike difficulties\&.
6104 .sp
6105 Please note this option only applies to SMB1 client connections, and has no effect on SMB2 clients\&.
6106 .sp
6107 Default:
6108 \fI\fIkeepalive\fR\fR\fI = \fR\fI300\fR\fI \fR
6109 .sp
6110 Example:
6111 \fI\fIkeepalive\fR\fR\fI = \fR\fI600\fR\fI \fR
6112 .RE
6113
6114 kerberos encryption types (G)
6115 .PP
6116 .RS 4
6117 This parameter determines the encryption types to use when operating as a Kerberos client\&. Possible values are
6118 \fIall\fR,
6119 \fIstrong\fR, and
6120 \fIlegacy\fR\&.
6121 .sp
6122 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
6123 \fBwinbindd\fR(8)
6124 and
6125 \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\&.
6126 .sp
6127 When set to
6128 \fBall\fR, all active directory encryption types are allowed\&.
6129 .sp
6130 When set to
6131 \fBstrong\fR, only AES\-based encryption types are offered\&. This can be used in hardened environments to prevent downgrade attacks\&.
6132 .sp
6133 When set to
6134 \fBlegacy\fR, only RC4\-HMAC\-MD5 is allowed\&. AVOID using this option, because of
6135 CVE\-2022\-37966
6136 see
6137 https://bugzilla\&.samba\&.org/show_bug\&.cgi?id=15237\&.
6138 .sp
6139 Default:
6140 \fI\fIkerberos encryption types\fR\fR\fI = \fR\fIall\fR\fI \fR
6141 .RE
6142
6143 kerberos method (G)
6144 .PP
6145 .RS 4
6146 Controls how kerberos tickets are verified\&.
6147 .sp
6148 Valid options are:
6149 .RS
6150 .sp
6151 .RS 4
6152 .ie n \{\
6153 \h'-04'\(bu\h'+03'\c
6154 .\}
6155 .el \{\
6156 .sp -1
6157 .IP \(bu 2.3
6158 .\}
6159 secrets only \- use only the secrets\&.tdb for ticket verification (default)
6160 .RE
6161 .sp
6162 .RS 4
6163 .ie n \{\
6164 \h'-04'\(bu\h'+03'\c
6165 .\}
6166 .el \{\
6167 .sp -1
6168 .IP \(bu 2.3
6169 .\}
6170 system keytab \- use only the system keytab for ticket verification
6171 .RE
6172 .sp
6173 .RS 4
6174 .ie n \{\
6175 \h'-04'\(bu\h'+03'\c
6176 .\}
6177 .el \{\
6178 .sp -1
6179 .IP \(bu 2.3
6180 .\}
6181 dedicated keytab \- use a dedicated keytab for ticket verification
6182 .RE
6183 .sp
6184 .RS 4
6185 .ie n \{\
6186 \h'-04'\(bu\h'+03'\c
6187 .\}
6188 .el \{\
6189 .sp -1
6190 .IP \(bu 2.3
6191 .\}
6192 secrets and keytab \- use the secrets\&.tdb first, then the system keytab
6193 .RE
6194 .sp
6195 .RE
6196 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\&.
6197 .sp
6198 When the kerberos method is in "dedicated keytab" mode,
6199 \m[blue]\fBdedicated keytab file\fR\m[]
6200 must be set to specify the location of the keytab file\&.
6201 .sp
6202 Suggested configuration is to use the default value \*(Aqsecrets only\*(Aq together with the
6203 \m[blue]\fBsync machine password to keytab\fR\m[]
6204 option\&.
6205 .sp
6206 Default:
6207 \fI\fIkerberos method\fR\fR\fI = \fR\fIdefault\fR\fI \fR
6208 .RE
6209
6210 kernel change notify (G)
6211 .PP
6212 .RS 4
6213 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\&.
6214 .sp
6215 This parameter is only used when your kernel supports change notification to user programs using the inotify interface\&.
6216 .sp
6217 Default:
6218 \fI\fIkernel change notify\fR\fR\fI = \fR\fIyes\fR\fI \fR
6219 .RE
6220
6221 kernel oplocks (S)
6222 .PP
6223 .RS 4
6224 For UNIXes that support kernel based
6225 \m[blue]\fBoplocks\fR\m[]
6226 (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\&.
6227 .sp
6228 Kernel oplocks support allows Samba
6229 \fIoplocks \fR
6230 to be broken whenever a local UNIX process or NFS operation accesses a file that
6231 \fBsmbd\fR(8)
6232 has oplocked\&. This allows complete data consistency between SMB/CIFS, NFS and local file access (and is a
6233 \fIvery\fR
6234 cool feature :\-)\&.
6235 .sp
6236 If you do not need this interaction, you should disable the parameter on Linux to get Level II oplocks and the associated performance benefit\&.
6237 .sp
6238 This parameter defaults to
6239 \fBno\fR
6240 and is translated to a no\-op on systems that do not have the necessary kernel support\&.
6241 .sp
6242 Default:
6243 \fI\fIkernel oplocks\fR\fR\fI = \fR\fIno\fR\fI \fR
6244 .RE
6245
6246 kernel share modes (S)
6247 .PP
6248 .RS 4
6249 This parameter controls whether SMB share modes are translated into file system specific sharemode calls\&.
6250 .sp
6251 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\&.
6252 .sp
6253 Note that in order to use SMB2 durable file handles on a share, you have to turn kernel share modes off\&.
6254 .sp
6255 This parameter defaults to
6256 \fBno\fR\&. Setting it to
6257 \fByes\fR
6258 requires a file system module that supports file system sharemodes, otherwise attempts to access files will fail with a sharing violation\&.
6259 .sp
6260 Default:
6261 \fI\fIkernel share modes\fR\fR\fI = \fR\fIno\fR\fI \fR
6262 .RE
6263
6264 kpasswd port (G)
6265 .PP
6266 .RS 4
6267 Specifies which ports the Kerberos server should listen on for password changes\&.
6268 .sp
6269 Default:
6270 \fI\fIkpasswd port\fR\fR\fI = \fR\fI464\fR\fI \fR
6271 .RE
6272
6273 krb5 port (G)
6274 .PP
6275 .RS 4
6276 Specifies which port the KDC should listen on for Kerberos traffic\&.
6277 .sp
6278 Default:
6279 \fI\fIkrb5 port\fR\fR\fI = \fR\fI88\fR\fI \fR
6280 .RE
6281
6282 lanman auth (G)
6283 .PP
6284 .RS 4
6285 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\&.
6286 .sp
6287 That is, in the future, the current default of
6288 lanman auth = no
6289 will be the enforced behaviour\&.
6290 .sp
6291 This parameter determines whether or not
6292 \fBsmbd\fR(8)
6293 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\&.
6294 .sp
6295 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\&.
6296 .sp
6297 When this parameter is set to
6298 no
6299 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\&.
6300 .sp
6301 Unlike the
6302 \fIencrypt passwords\fR
6303 option, this parameter cannot alter client behaviour, and the LANMAN response will still be sent over the network\&. See the
6304 client lanman auth
6305 to disable this for Samba\*(Aqs clients (such as smbclient)
6306 .sp
6307 This parameter is overridden by
6308 \fIntlm auth\fR, so unless that it is also set to
6309 \fBntlmv1\-permitted\fR
6310 or
6311 \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\&.
6312 .sp
6313 \fIThis parameter has no impact on the Samba AD DC, LM authentication is always disabled and no LM password is ever stored\&.\fR
6314 .sp
6315 Default:
6316 \fI\fIlanman auth\fR\fR\fI = \fR\fIno\fR\fI \fR
6317 .RE
6318
6319 large readwrite (G)
6320 .PP
6321 .RS 4
6322 This parameter determines whether or not
6323 \fBsmbd\fR(8)
6324 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\&.
6325 .sp
6326 Default:
6327 \fI\fIlarge readwrite\fR\fR\fI = \fR\fIyes\fR\fI \fR
6328 .RE
6329
6330 ldap admin dn (G)
6331 .PP
6332 .RS 4
6333 The
6334 \m[blue]\fBldap admin dn\fR\m[]
6335 defines the Distinguished Name (DN) name used by Samba to contact the ldap server when retrieving user account information\&. The
6336 \m[blue]\fBldap admin dn\fR\m[]
6337 is used in conjunction with the admin dn password stored in the
6338 private/secrets\&.tdb
6339 file\&. See the
6340 \fBsmbpasswd\fR(8)
6341 man page for more information on how to accomplish this\&.
6342 .sp
6343 The
6344 \m[blue]\fBldap admin dn\fR\m[]
6345 requires a fully specified DN\&. The
6346 \m[blue]\fBldap suffix\fR\m[]
6347 is not appended to the
6348 \m[blue]\fBldap admin dn\fR\m[]\&.
6349 .sp
6350 \fINo default\fR
6351 .RE
6352
6353 ldap connection timeout (G)
6354 .PP
6355 .RS 4
6356 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\&.
6357 .sp
6358 This parameter is different from
6359 \m[blue]\fBldap timeout\fR\m[]
6360 which affects operations on LDAP servers using an existing connection and not establishing an initial connection\&.
6361 .sp
6362 Default:
6363 \fI\fIldap connection timeout\fR\fR\fI = \fR\fI2\fR\fI \fR
6364 .RE
6365
6366 ldap debug level (G)
6367 .PP
6368 .RS 4
6369 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
6370 \fBslapd.conf\fR(5)
6371 manpage\&. A typical useful value will be
6372 \fI1\fR
6373 for tracing function calls\&.
6374 .sp
6375 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
6376 \fIldap debug threshold\fR\&.
6377 .sp
6378 Default:
6379 \fI\fIldap debug level\fR\fR\fI = \fR\fI0\fR\fI \fR
6380 .sp
6381 Example:
6382 \fI\fIldap debug level\fR\fR\fI = \fR\fI1\fR\fI \fR
6383 .RE
6384
6385 ldap debug threshold (G)
6386 .PP
6387 .RS 4
6388 This parameter controls the Samba debug level at which the ldap library debug output is printed in the Samba logs\&. See the description of
6389 \fIldap debug level\fR
6390 for details\&.
6391 .sp
6392 Default:
6393 \fI\fIldap debug threshold\fR\fR\fI = \fR\fI10\fR\fI \fR
6394 .sp
6395 Example:
6396 \fI\fIldap debug threshold\fR\fR\fI = \fR\fI5\fR\fI \fR
6397 .RE
6398
6399 ldap delete dn (G)
6400 .PP
6401 .RS 4
6402 This parameter specifies whether a delete operation in the ldapsam deletes the complete entry or only the attributes specific to Samba\&.
6403 .sp
6404 Default:
6405 \fI\fIldap delete dn\fR\fR\fI = \fR\fIno\fR\fI \fR
6406 .RE
6407
6408 ldap deref (G)
6409 .PP
6410 .RS 4
6411 This option controls whether Samba should tell the LDAP library to use a certain alias dereferencing method\&. The default is
6412 \fIauto\fR, which means that the default setting of the ldap client library will be kept\&. Other possible values are
6413 \fInever\fR,
6414 \fIfinding\fR,
6415 \fIsearching\fR
6416 and
6417 \fIalways\fR\&. Grab your LDAP manual for more information\&.
6418 .sp
6419 Default:
6420 \fI\fIldap deref\fR\fR\fI = \fR\fIauto\fR\fI \fR
6421 .sp
6422 Example:
6423 \fI\fIldap deref\fR\fR\fI = \fR\fIsearching\fR\fI \fR
6424 .RE
6425
6426 ldap follow referral (G)
6427 .PP
6428 .RS 4
6429 This option controls whether to follow LDAP referrals or not when searching for entries in the LDAP database\&. Possible values are
6430 \fIon\fR
6431 to enable following referrals,
6432 \fIoff\fR
6433 to disable this, and
6434 \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)\&.
6435 .sp
6436 Default:
6437 \fI\fIldap follow referral\fR\fR\fI = \fR\fIauto\fR\fI \fR
6438 .sp
6439 Example:
6440 \fI\fIldap follow referral\fR\fR\fI = \fR\fIoff\fR\fI \fR
6441 .RE
6442
6443 ldap group suffix (G)
6444 .PP
6445 .RS 4
6446 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
6447 \m[blue]\fBldap suffix\fR\m[]
6448 will be used instead\&. The suffix string is prepended to the
6449 \m[blue]\fBldap suffix\fR\m[]
6450 string so use a partial DN\&.
6451 .sp
6452 Default:
6453 \fI\fIldap group suffix\fR\fR\fI = \fR\fI\fR\fI \fR
6454 .sp
6455 Example:
6456 \fI\fIldap group suffix\fR\fR\fI = \fR\fIou=Groups\fR\fI \fR
6457 .RE
6458
6459 ldap idmap suffix (G)
6460 .PP
6461 .RS 4
6462 This parameters specifies the suffix that is used when storing idmap mappings\&. If this parameter is unset, the value of
6463 \m[blue]\fBldap suffix\fR\m[]
6464 will be used instead\&. The suffix string is prepended to the
6465 \m[blue]\fBldap suffix\fR\m[]
6466 string so use a partial DN\&.
6467 .sp
6468 Default:
6469 \fI\fIldap idmap suffix\fR\fR\fI = \fR\fI\fR\fI \fR
6470 .sp
6471 Example:
6472 \fI\fIldap idmap suffix\fR\fR\fI = \fR\fIou=Idmap\fR\fI \fR
6473 .RE
6474
6475 ldap machine suffix (G)
6476 .PP
6477 .RS 4
6478 It specifies where machines should be added to the ldap tree\&. If this parameter is unset, the value of
6479 \m[blue]\fBldap suffix\fR\m[]
6480 will be used instead\&. The suffix string is prepended to the
6481 \m[blue]\fBldap suffix\fR\m[]
6482 string so use a partial DN\&.
6483 .sp
6484 Default:
6485 \fI\fIldap machine suffix\fR\fR\fI = \fR\fI\fR\fI \fR
6486 .sp
6487 Example:
6488 \fI\fIldap machine suffix\fR\fR\fI = \fR\fIou=Computers\fR\fI \fR
6489 .RE
6490
6491 ldap max anonymous request size (G)
6492 .PP
6493 .RS 4
6494 This parameter specifies the maximum permitted size (in bytes) for an LDAP request received on an anonymous connection\&.
6495 .sp
6496 If the request size exceeds this limit the request will be rejected\&.
6497 .sp
6498 Default:
6499 \fI\fIldap max anonymous request size\fR\fR\fI = \fR\fI256000\fR\fI \fR
6500 .sp
6501 Example:
6502 \fI\fIldap max anonymous request size\fR\fR\fI = \fR\fI500000\fR\fI \fR
6503 .RE
6504
6505 ldap max authenticated request size (G)
6506 .PP
6507 .RS 4
6508 This parameter specifies the maximum permitted size (in bytes) for an LDAP request received on an authenticated connection\&.
6509 .sp
6510 If the request size exceeds this limit the request will be rejected\&.
6511 .sp
6512 Default:
6513 \fI\fIldap max authenticated request size\fR\fR\fI = \fR\fI16777216\fR\fI \fR
6514 .sp
6515 Example:
6516 \fI\fIldap max authenticated request size\fR\fR\fI = \fR\fI4194304\fR\fI \fR
6517 .RE
6518
6519 ldap max search request size (G)
6520 .PP
6521 .RS 4
6522 This parameter specifies the maximum permitted size (in bytes) for an LDAP search request\&.
6523 .sp
6524 If the request size exceeds this limit the request will be rejected\&.
6525 .sp
6526 Default:
6527 \fI\fIldap max search request size\fR\fR\fI = \fR\fI256000\fR\fI \fR
6528 .sp
6529 Example:
6530 \fI\fIldap max search request size\fR\fR\fI = \fR\fI4194304\fR\fI \fR
6531 .RE
6532
6533 ldap page size (G)
6534 .PP
6535 .RS 4
6536 This parameter specifies the number of entries per page\&.
6537 .sp
6538 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\&.
6539 .sp
6540 Default:
6541 \fI\fIldap page size\fR\fR\fI = \fR\fI1000\fR\fI \fR
6542 .sp
6543 Example:
6544 \fI\fIldap page size\fR\fR\fI = \fR\fI512\fR\fI \fR
6545 .RE
6546
6547 ldap password sync
6548 .PP
6549 .RS 4
6550 This parameter is a synonym for
6551 ldap passwd sync\&.
6552 .RE
6553
6554 ldap passwd sync (G)
6555 .PP
6556 .RS 4
6557 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\&.
6558 .sp
6559 The
6560 \m[blue]\fBldap passwd sync\fR\m[]
6561 can be set to one of three values:
6562 .RS
6563 .sp
6564 .RS 4
6565 .ie n \{\
6566 \h'-04'\(bu\h'+03'\c
6567 .\}
6568 .el \{\
6569 .sp -1
6570 .IP \(bu 2.3
6571 .\}
6572 \fIYes\fR
6573 = Try to update the LDAP, NT and LM passwords and update the pwdLastSet time\&.
6574 .RE
6575 .sp
6576 .RS 4
6577 .ie n \{\
6578 \h'-04'\(bu\h'+03'\c
6579 .\}
6580 .el \{\
6581 .sp -1
6582 .IP \(bu 2.3
6583 .\}
6584 \fINo\fR
6585 = Update NT and LM passwords and update the pwdLastSet time\&.
6586 .RE
6587 .sp
6588 .RS 4
6589 .ie n \{\
6590 \h'-04'\(bu\h'+03'\c
6591 .\}
6592 .el \{\
6593 .sp -1
6594 .IP \(bu 2.3
6595 .\}
6596 \fIOnly\fR
6597 = Only update the LDAP password and let the LDAP server do the rest\&.
6598 .RE
6599 .sp
6600 .RE
6601 Default:
6602 \fI\fIldap passwd sync\fR\fR\fI = \fR\fIno\fR\fI \fR
6603 .RE
6604
6605 ldap replication sleep (G)
6606 .PP
6607 .RS 4
6608 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\&.
6609 .sp
6610 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\&.
6611 .sp
6612 The value is specified in milliseconds, the maximum value is 5000 (5 seconds)\&.
6613 .sp
6614 Default:
6615 \fI\fIldap replication sleep\fR\fR\fI = \fR\fI1000\fR\fI \fR
6616 .RE
6617
6618 ldapsam:editposix (G)
6619 .PP
6620 .RS 4
6621 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\&.
6622 .sp
6623 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
6624 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
6625 \m[blue]\fBldapsam:trusted = yes\fR\m[]
6626 option is usually sufficient to use
6627 \m[blue]\fBldapsam:editposix = yes\fR\m[]
6628 as well\&.
6629 .sp
6630 An example configuration can be the following:
6631 .sp
6632 .if n \{\
6633 .RS 4
6634 .\}
6635 .nf
6636 encrypt passwords = true
6637 passdb backend = ldapsam
6638
6639 ldapsam:trusted=yes
6640 ldapsam:editposix=yes
6641
6642 ldap admin dn = cn=admin,dc=samba,dc=org
6643 ldap delete dn = yes
6644 ldap group suffix = ou=groups
6645 ldap idmap suffix = ou=idmap
6646 ldap machine suffix = ou=computers
6647 ldap user suffix = ou=users
6648 ldap suffix = dc=samba,dc=org
6649
6650 idmap backend = ldap:"ldap://localhost"
6651
6652 idmap uid = 5000\-50000
6653 idmap gid = 5000\-50000
6654
6655 .fi
6656 .if n \{\
6657 .RE
6658 .\}
6659 .sp
6660 This configuration assumes a directory layout like described in the following ldif:
6661 .sp
6662 .if n \{\
6663 .RS 4
6664 .\}
6665 .nf
6666 dn: dc=samba,dc=org
6667 objectClass: top
6668 objectClass: dcObject
6669 objectClass: organization
6670 o: samba\&.org
6671 dc: samba
6672
6673 dn: cn=admin,dc=samba,dc=org
6674 objectClass: simpleSecurityObject
6675 objectClass: organizationalRole
6676 cn: admin
6677 description: LDAP administrator
6678 userPassword: secret
6679
6680 dn: ou=users,dc=samba,dc=org
6681 objectClass: top
6682 objectClass: organizationalUnit
6683 ou: users
6684
6685 dn: ou=groups,dc=samba,dc=org
6686 objectClass: top
6687 objectClass: organizationalUnit
6688 ou: groups
6689
6690 dn: ou=idmap,dc=samba,dc=org
6691 objectClass: top
6692 objectClass: organizationalUnit
6693 ou: idmap
6694
6695 dn: ou=computers,dc=samba,dc=org
6696 objectClass: top
6697 objectClass: organizationalUnit
6698 ou: computers
6699
6700 .fi
6701 .if n \{\
6702 .RE
6703 .\}
6704 .sp
6705 Default:
6706 \fI\fIldapsam:editposix\fR\fR\fI = \fR\fIno\fR\fI \fR
6707 .RE
6708
6709 ldapsam:trusted (G)
6710 .PP
6711 .RS 4
6712 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\&.
6713 .sp
6714 To make Samba scale well in large environments, the
6715 \m[blue]\fBldapsam:trusted = yes\fR\m[]
6716 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,
6717 \m[blue]\fBldapsam:trusted = yes\fR\m[]
6718 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\&.
6719 .sp
6720 Default:
6721 \fI\fIldapsam:trusted\fR\fR\fI = \fR\fIno\fR\fI \fR
6722 .RE
6723
6724 ldap server require strong auth (G)
6725 .PP
6726 .RS 4
6727 The
6728 \m[blue]\fBldap server require strong auth\fR\m[]
6729 defines whether the ldap server requires ldap traffic to be signed or signed and encrypted (sealed)\&. Possible values are
6730 \fIno\fR,
6731 \fIallow_sasl_without_tls_channel_bindings\fR
6732 and
6733 \fIyes\fR\&.
6734 .sp
6735 Windows has
6736 \fILdapEnforceChannelBinding\fR
6737 under
6738 \fIHKLM\eSYSTEM\eCurrentControlSet\eServices\eNTDS\eParameters\e\fR\&.
6739 .sp
6740 A value of
6741 \fIno\fR
6742 allows simple and sasl binds over all transports\&. This matches LdapEnforceChannelBinding=0\&.
6743 .sp
6744 A value of
6745 \fIallow_sasl_without_tls_channel_bindings\fR
6746 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
6747 \fIyes\fR
6748 is not possible\&. Unencrypted connections only allow sasl binds with sign or seal\&. This matches LdapEnforceChannelBinding=1\&.
6749 .sp
6750 Before support for tls channel bindings existed in Samba, a value of
6751 \fIallow_sasl_over_tls\fR
6752 was possible in order to allow sasl binds without tls channel bindings\&. This now misleading as a value of
6753 \fIyes\fR
6754 will now allow sasl binds with tls channel bindings\&. Configurations should be changed to
6755 \fIyes\fR
6756 instead or
6757 \fIallow_sasl_without_tls_channel_bindings\fR
6758 if really required\&. Currently
6759 \fIallow_sasl_over_tls\fR
6760 is just an alias of
6761 \fIallow_sasl_without_tls_channel_bindings\fR, but it will be removed in future versions\&.
6762 .sp
6763 A value of
6764 \fIyes\fR
6765 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\&.
6766 .sp
6767 Default:
6768 \fI\fIldap server require strong auth\fR\fR\fI = \fR\fIyes\fR\fI \fR
6769 .RE
6770
6771 ldap ssl (G)
6772 .PP
6773 .RS 4
6774 This option is used to define whether or not Samba should use SSL when connecting to the ldap server This is
6775 \fINOT\fR
6776 related to Samba\*(Aqs previous SSL support which was enabled by specifying the
6777 \-\-with\-ssl
6778 option to the
6779 configure
6780 script\&.
6781 .sp
6782 LDAP connections should be secured where possible\&. This may be done setting
6783 \fIeither\fR
6784 this parameter to
6785 \fIstart tls\fR
6786 \fIor\fR
6787 by specifying
6788 \fIldaps://\fR
6789 in the URL argument of
6790 \m[blue]\fBpassdb backend\fR\m[]\&.
6791 .sp
6792 The
6793 \m[blue]\fBldap ssl\fR\m[]
6794 can be set to one of two values:
6795 .RS
6796 .sp
6797 .RS 4
6798 .ie n \{\
6799 \h'-04'\(bu\h'+03'\c
6800 .\}
6801 .el \{\
6802 .sp -1
6803 .IP \(bu 2.3
6804 .\}
6805 \fIOff\fR
6806 = Never use SSL when querying the directory\&.
6807 .RE
6808 .sp
6809 .RS 4
6810 .ie n \{\
6811 \h'-04'\(bu\h'+03'\c
6812 .\}
6813 .el \{\
6814 .sp -1
6815 .IP \(bu 2.3
6816 .\}
6817 \fIstart tls\fR
6818 = Use the LDAPv3 StartTLS extended operation (RFC2830) for communicating with the directory server\&.
6819 .RE
6820 .sp
6821 .RE
6822 Please note that this parameter does only affect
6823 \fIrpc\fR
6824 methods\&.
6825 .sp
6826 Default:
6827 \fI\fIldap ssl\fR\fR\fI = \fR\fIstart tls\fR\fI \fR
6828 .RE
6829
6830 ldap suffix (G)
6831 .PP
6832 .RS 4
6833 Specifies the base for all ldap suffixes and for storing the sambaDomain object\&.
6834 .sp
6835 The ldap suffix will be appended to the values specified for the
6836 \m[blue]\fBldap user suffix\fR\m[],
6837 \m[blue]\fBldap group suffix\fR\m[],
6838 \m[blue]\fBldap machine suffix\fR\m[], and the
6839 \m[blue]\fBldap idmap suffix\fR\m[]\&. Each of these should be given only a DN relative to the
6840 \m[blue]\fBldap suffix\fR\m[]\&.
6841 .sp
6842 Default:
6843 \fI\fIldap suffix\fR\fR\fI = \fR\fI\fR\fI \fR
6844 .sp
6845 Example:
6846 \fI\fIldap suffix\fR\fR\fI = \fR\fIdc=samba,dc=org\fR\fI \fR
6847 .RE
6848
6849 ldap timeout (G)
6850 .PP
6851 .RS 4
6852 This parameter defines the number of seconds that Samba should use as timeout for LDAP operations\&.
6853 .sp
6854 Default:
6855 \fI\fIldap timeout\fR\fR\fI = \fR\fI15\fR\fI \fR
6856 .RE
6857
6858 ldap user suffix (G)
6859 .PP
6860 .RS 4
6861 This parameter specifies where users are added to the tree\&. If this parameter is unset, the value of
6862 \m[blue]\fBldap suffix\fR\m[]
6863 will be used instead\&. The suffix string is prepended to the
6864 \m[blue]\fBldap suffix\fR\m[]
6865 string so use a partial DN\&.
6866 .sp
6867 Default:
6868 \fI\fIldap user suffix\fR\fR\fI = \fR\fI\fR\fI \fR
6869 .sp
6870 Example:
6871 \fI\fIldap user suffix\fR\fR\fI = \fR\fIou=people\fR\fI \fR
6872 .RE
6873
6874 level2 oplocks (S)
6875 .PP
6876 .RS 4
6877 This parameter controls whether Samba supports level2 (read\-only) oplocks on a share\&.
6878 .sp
6879 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)\&.
6880 .sp
6881 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\&.
6882 .sp
6883 It is recommended that this parameter be turned on to speed access to shared executables\&.
6884 .sp
6885 For more discussions on level2 oplocks see the CIFS spec\&.
6886 .sp
6887 Currently, if
6888 \m[blue]\fBkernel oplocks\fR\m[]
6889 are supported then level2 oplocks are not granted (even if this parameter is set to
6890 \fByes\fR)\&. Note also, the
6891 \m[blue]\fBoplocks\fR\m[]
6892 parameter must be set to
6893 \fByes\fR
6894 on this share in order for this parameter to have any effect\&.
6895 .sp
6896 Default:
6897 \fI\fIlevel2 oplocks\fR\fR\fI = \fR\fIyes\fR\fI \fR
6898 .RE
6899
6900 lm announce (G)
6901 .PP
6902 .RS 4
6903 This parameter determines if
6904 \fBnmbd\fR(8)
6905 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,
6906 \fByes\fR,
6907 \fBno\fR, or
6908 \fBauto\fR\&. The default is
6909 \fBauto\fR\&. If set to
6910 \fBno\fR
6911 Samba will never produce these broadcasts\&. If set to
6912 \fByes\fR
6913 Samba will produce Lanman announce broadcasts at a frequency set by the parameter
6914 \m[blue]\fBlm interval\fR\m[]\&. If set to
6915 \fBauto\fR
6916 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
6917 \m[blue]\fBlm interval\fR\m[]\&.
6918 .sp
6919 Default:
6920 \fI\fIlm announce\fR\fR\fI = \fR\fIauto\fR\fI \fR
6921 .sp
6922 Example:
6923 \fI\fIlm announce\fR\fR\fI = \fR\fIyes\fR\fI \fR
6924 .RE
6925
6926 lm interval (G)
6927 .PP
6928 .RS 4
6929 If Samba is set to produce Lanman announce broadcasts needed by OS/2 clients (see the
6930 \m[blue]\fBlm announce\fR\m[]
6931 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
6932 \m[blue]\fBlm announce\fR\m[]
6933 parameter\&.
6934 .sp
6935 Default:
6936 \fI\fIlm interval\fR\fR\fI = \fR\fI60\fR\fI \fR
6937 .sp
6938 Example:
6939 \fI\fIlm interval\fR\fR\fI = \fR\fI120\fR\fI \fR
6940 .RE
6941
6942 load printers (G)
6943 .PP
6944 .RS 4
6945 A boolean variable that controls whether all printers in the printcap will be loaded for browsing by default\&. See the
6946 printers
6947 section for more details\&.
6948 .sp
6949 Default:
6950 \fI\fIload printers\fR\fR\fI = \fR\fIyes\fR\fI \fR
6951 .RE
6952
6953 local master (G)
6954 .PP
6955 .RS 4
6956 This option allows
6957 \fBnmbd\fR(8)
6958 to try and become a local master browser on a subnet\&. If set to
6959 \fBno\fR
6960 then
6961 nmbd
6962 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
6963 \fByes\fR\&. Setting this value to
6964 \fByes\fR
6965 doesn\*(Aqt mean that Samba will
6966 \fIbecome\fR
6967 the local master browser on a subnet, just that
6968 nmbd
6969 will
6970 \fIparticipate\fR
6971 in elections for local master browser\&.
6972 .sp
6973 Setting this value to
6974 \fBno\fR
6975 will cause
6976 nmbd
6977 \fInever\fR
6978 to become a local master browser\&.
6979 .sp
6980 Default:
6981 \fI\fIlocal master\fR\fR\fI = \fR\fIyes\fR\fI \fR
6982 .RE
6983
6984 lock dir
6985 .PP
6986 .RS 4
6987 This parameter is a synonym for
6988 lock directory\&.
6989 .RE
6990
6991 lock directory (G)
6992 .PP
6993 .RS 4
6994 This option specifies the directory where lock files will be placed\&. The lock files are used to implement the
6995 \m[blue]\fBmax connections\fR\m[]
6996 option\&.
6997 .sp
6998 Note: This option can not be set inside registry configurations\&.
6999 .sp
7000 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)
7001 .sp
7002 Default:
7003 \fI\fIlock directory\fR\fR\fI = \fR\fI/var/lib/samba/lock\fR\fI \fR
7004 .sp
7005 Example:
7006 \fI\fIlock directory\fR\fR\fI = \fR\fI/var/run/samba/locks\fR\fI \fR
7007 .RE
7008
7009 locking (S)
7010 .PP
7011 .RS 4
7012 This controls whether or not locking will be performed by the server in response to lock requests from the client\&.
7013 .sp
7014 If
7015 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\&.
7016 .sp
7017 If
7018 locking = yes, real locking will be performed by the server\&.
7019 .sp
7020 This option
7021 \fImay\fR
7022 be useful for read\-only filesystems which
7023 \fImay\fR
7024 not need locking (such as CDROM drives), although setting this parameter of
7025 \fBno\fR
7026 is not really recommended even in this case\&.
7027 .sp
7028 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\&.
7029 .sp
7030 Default:
7031 \fI\fIlocking\fR\fR\fI = \fR\fIyes\fR\fI \fR
7032 .RE
7033
7034 lock spin time (G)
7035 .PP
7036 .RS 4
7037 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
7038 lock spin count
7039 parameter is no longer used in Samba 3\&.0\&.24\&. You should not need to change the value of this parameter\&.
7040 .sp
7041 Default:
7042 \fI\fIlock spin time\fR\fR\fI = \fR\fI200\fR\fI \fR
7043 .RE
7044
7045 log file (G)
7046 .PP
7047 .RS 4
7048 This option allows you to override the name of the Samba log file (also known as the debug file)\&.
7049 .sp
7050 This option takes the standard substitutions, allowing you to have separate log files for each user or machine\&.
7051 .sp
7052 \fINo default\fR
7053 .sp
7054 Example:
7055 \fI\fIlog file\fR\fR\fI = \fR\fI/usr/local/samba/var/log\&.%m\fR\fI \fR
7056 .RE
7057
7058 logging (G)
7059 .PP
7060 .RS 4
7061 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]\&.
7062 .sp
7063 The \*(Aqoption\*(Aq parameter can be used to pass backend\-specific options\&.
7064 .sp
7065 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
7066 \m[blue]\fBlog level\fR\m[]
7067 determines overall log levels, while the log levels specified here define what is sent to the individual backends\&.
7068 .sp
7069 When
7070 \m[blue]\fBlogging\fR\m[]
7071 is set, it overrides the
7072 \m[blue]\fBsyslog\fR\m[]
7073 and
7074 \m[blue]\fBsyslog only\fR\m[]
7075 parameters\&.
7076 .sp
7077 Some backends are only available when Samba has been compiled with the additional libraries\&. The overall list of logging backends:
7078 .RS
7079 .sp
7080 .RS 4
7081 .ie n \{\
7082 \h'-04'\(bu\h'+03'\c
7083 .\}
7084 .el \{\
7085 .sp -1
7086 .IP \(bu 2.3
7087 .\}
7088 \fIsyslog\fR
7089 .RE
7090 .sp
7091 .RS 4
7092 .ie n \{\
7093 \h'-04'\(bu\h'+03'\c
7094 .\}
7095 .el \{\
7096 .sp -1
7097 .IP \(bu 2.3
7098 .\}
7099 \fIfile\fR
7100 .RE
7101 .sp
7102 .RS 4
7103 .ie n \{\
7104 \h'-04'\(bu\h'+03'\c
7105 .\}
7106 .el \{\
7107 .sp -1
7108 .IP \(bu 2.3
7109 .\}
7110 \fIsystemd\fR
7111 .RE
7112 .sp
7113 .RS 4
7114 .ie n \{\
7115 \h'-04'\(bu\h'+03'\c
7116 .\}
7117 .el \{\
7118 .sp -1
7119 .IP \(bu 2.3
7120 .\}
7121 \fIlttng\fR
7122 .RE
7123 .sp
7124 .RS 4
7125 .ie n \{\
7126 \h'-04'\(bu\h'+03'\c
7127 .\}
7128 .el \{\
7129 .sp -1
7130 .IP \(bu 2.3
7131 .\}
7132 \fIgpfs\fR
7133 .RE
7134 .sp
7135 .RS 4
7136 .ie n \{\
7137 \h'-04'\(bu\h'+03'\c
7138 .\}
7139 .el \{\
7140 .sp -1
7141 .IP \(bu 2.3
7142 .\}
7143 \fIringbuf\fR
7144 .RE
7145 .sp
7146 .RE
7147 The
7148 \fIringbuf\fR
7149 backend supports an optional size argument to change the buffer size used, the default is 1 MB:
7150 \fIringbuf:size=NBYTES\fR
7151 .sp
7152 Default:
7153 \fI\fIlogging\fR\fR\fI = \fR\fI\fR\fI \fR
7154 .sp
7155 Example:
7156 \fI\fIlogging\fR\fR\fI = \fR\fIsyslog@1 file\fR\fI \fR
7157 .RE
7158
7159 debuglevel
7160 .PP
7161 .RS 4
7162 This parameter is a synonym for
7163 log level\&.
7164 .RE
7165
7166 log level (G)
7167 .PP
7168 .RS 4
7169 The value of the parameter (a string) allows the debug level (logging level) to be specified in the
7170 smb\&.conf
7171 file\&.
7172 .sp
7173 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:
7174 .RS
7175 .sp
7176 .RS 4
7177 .ie n \{\
7178 \h'-04'\(bu\h'+03'\c
7179 .\}
7180 .el \{\
7181 .sp -1
7182 .IP \(bu 2.3
7183 .\}
7184 \fIall\fR
7185 .RE
7186 .sp
7187 .RS 4
7188 .ie n \{\
7189 \h'-04'\(bu\h'+03'\c
7190 .\}
7191 .el \{\
7192 .sp -1
7193 .IP \(bu 2.3
7194 .\}
7195 \fItdb\fR
7196 .RE
7197 .sp
7198 .RS 4
7199 .ie n \{\
7200 \h'-04'\(bu\h'+03'\c
7201 .\}
7202 .el \{\
7203 .sp -1
7204 .IP \(bu 2.3
7205 .\}
7206 \fIprintdrivers\fR
7207 .RE
7208 .sp
7209 .RS 4
7210 .ie n \{\
7211 \h'-04'\(bu\h'+03'\c
7212 .\}
7213 .el \{\
7214 .sp -1
7215 .IP \(bu 2.3
7216 .\}
7217 \fIlanman\fR
7218 .RE
7219 .sp
7220 .RS 4
7221 .ie n \{\
7222 \h'-04'\(bu\h'+03'\c
7223 .\}
7224 .el \{\
7225 .sp -1
7226 .IP \(bu 2.3
7227 .\}
7228 \fIsmb\fR
7229 .RE
7230 .sp
7231 .RS 4
7232 .ie n \{\
7233 \h'-04'\(bu\h'+03'\c
7234 .\}
7235 .el \{\
7236 .sp -1
7237 .IP \(bu 2.3
7238 .\}
7239 \fIrpc_parse\fR
7240 .RE
7241 .sp
7242 .RS 4
7243 .ie n \{\
7244 \h'-04'\(bu\h'+03'\c
7245 .\}
7246 .el \{\
7247 .sp -1
7248 .IP \(bu 2.3
7249 .\}
7250 \fIrpc_srv\fR
7251 .RE
7252 .sp
7253 .RS 4
7254 .ie n \{\
7255 \h'-04'\(bu\h'+03'\c
7256 .\}
7257 .el \{\
7258 .sp -1
7259 .IP \(bu 2.3
7260 .\}
7261 \fIrpc_cli\fR
7262 .RE
7263 .sp
7264 .RS 4
7265 .ie n \{\
7266 \h'-04'\(bu\h'+03'\c
7267 .\}
7268 .el \{\
7269 .sp -1
7270 .IP \(bu 2.3
7271 .\}
7272 \fIpassdb\fR
7273 .RE
7274 .sp
7275 .RS 4
7276 .ie n \{\
7277 \h'-04'\(bu\h'+03'\c
7278 .\}
7279 .el \{\
7280 .sp -1
7281 .IP \(bu 2.3
7282 .\}
7283 \fIsam\fR
7284 .RE
7285 .sp
7286 .RS 4
7287 .ie n \{\
7288 \h'-04'\(bu\h'+03'\c
7289 .\}
7290 .el \{\
7291 .sp -1
7292 .IP \(bu 2.3
7293 .\}
7294 \fIauth\fR
7295 .RE
7296 .sp
7297 .RS 4
7298 .ie n \{\
7299 \h'-04'\(bu\h'+03'\c
7300 .\}
7301 .el \{\
7302 .sp -1
7303 .IP \(bu 2.3
7304 .\}
7305 \fIwinbind\fR
7306 .RE
7307 .sp
7308 .RS 4
7309 .ie n \{\
7310 \h'-04'\(bu\h'+03'\c
7311 .\}
7312 .el \{\
7313 .sp -1
7314 .IP \(bu 2.3
7315 .\}
7316 \fIvfs\fR
7317 .RE
7318 .sp
7319 .RS 4
7320 .ie n \{\
7321 \h'-04'\(bu\h'+03'\c
7322 .\}
7323 .el \{\
7324 .sp -1
7325 .IP \(bu 2.3
7326 .\}
7327 \fIidmap\fR
7328 .RE
7329 .sp
7330 .RS 4
7331 .ie n \{\
7332 \h'-04'\(bu\h'+03'\c
7333 .\}
7334 .el \{\
7335 .sp -1
7336 .IP \(bu 2.3
7337 .\}
7338 \fIquota\fR
7339 .RE
7340 .sp
7341 .RS 4
7342 .ie n \{\
7343 \h'-04'\(bu\h'+03'\c
7344 .\}
7345 .el \{\
7346 .sp -1
7347 .IP \(bu 2.3
7348 .\}
7349 \fIacls\fR
7350 .RE
7351 .sp
7352 .RS 4
7353 .ie n \{\
7354 \h'-04'\(bu\h'+03'\c
7355 .\}
7356 .el \{\
7357 .sp -1
7358 .IP \(bu 2.3
7359 .\}
7360 \fIlocking\fR
7361 .RE
7362 .sp
7363 .RS 4
7364 .ie n \{\
7365 \h'-04'\(bu\h'+03'\c
7366 .\}
7367 .el \{\
7368 .sp -1
7369 .IP \(bu 2.3
7370 .\}
7371 \fImsdfs\fR
7372 .RE
7373 .sp
7374 .RS 4
7375 .ie n \{\
7376 \h'-04'\(bu\h'+03'\c
7377 .\}
7378 .el \{\
7379 .sp -1
7380 .IP \(bu 2.3
7381 .\}
7382 \fIdmapi\fR
7383 .RE
7384 .sp
7385 .RS 4
7386 .ie n \{\
7387 \h'-04'\(bu\h'+03'\c
7388 .\}
7389 .el \{\
7390 .sp -1
7391 .IP \(bu 2.3
7392 .\}
7393 \fIregistry\fR
7394 .RE
7395 .sp
7396 .RS 4
7397 .ie n \{\
7398 \h'-04'\(bu\h'+03'\c
7399 .\}
7400 .el \{\
7401 .sp -1
7402 .IP \(bu 2.3
7403 .\}
7404 \fIscavenger\fR
7405 .RE
7406 .sp
7407 .RS 4
7408 .ie n \{\
7409 \h'-04'\(bu\h'+03'\c
7410 .\}
7411 .el \{\
7412 .sp -1
7413 .IP \(bu 2.3
7414 .\}
7415 \fIdns\fR
7416 .RE
7417 .sp
7418 .RS 4
7419 .ie n \{\
7420 \h'-04'\(bu\h'+03'\c
7421 .\}
7422 .el \{\
7423 .sp -1
7424 .IP \(bu 2.3
7425 .\}
7426 \fIldb\fR
7427 .RE
7428 .sp
7429 .RS 4
7430 .ie n \{\
7431 \h'-04'\(bu\h'+03'\c
7432 .\}
7433 .el \{\
7434 .sp -1
7435 .IP \(bu 2.3
7436 .\}
7437 \fItevent\fR
7438 .RE
7439 .sp
7440 .RS 4
7441 .ie n \{\
7442 \h'-04'\(bu\h'+03'\c
7443 .\}
7444 .el \{\
7445 .sp -1
7446 .IP \(bu 2.3
7447 .\}
7448 \fIauth_audit\fR
7449 .RE
7450 .sp
7451 .RS 4
7452 .ie n \{\
7453 \h'-04'\(bu\h'+03'\c
7454 .\}
7455 .el \{\
7456 .sp -1
7457 .IP \(bu 2.3
7458 .\}
7459 \fIauth_json_audit\fR
7460 .RE
7461 .sp
7462 .RS 4
7463 .ie n \{\
7464 \h'-04'\(bu\h'+03'\c
7465 .\}
7466 .el \{\
7467 .sp -1
7468 .IP \(bu 2.3
7469 .\}
7470 \fIkerberos\fR
7471 .RE
7472 .sp
7473 .RS 4
7474 .ie n \{\
7475 \h'-04'\(bu\h'+03'\c
7476 .\}
7477 .el \{\
7478 .sp -1
7479 .IP \(bu 2.3
7480 .\}
7481 \fIdrs_repl\fR
7482 .RE
7483 .sp
7484 .RS 4
7485 .ie n \{\
7486 \h'-04'\(bu\h'+03'\c
7487 .\}
7488 .el \{\
7489 .sp -1
7490 .IP \(bu 2.3
7491 .\}
7492 \fIsmb2\fR
7493 .RE
7494 .sp
7495 .RS 4
7496 .ie n \{\
7497 \h'-04'\(bu\h'+03'\c
7498 .\}
7499 .el \{\
7500 .sp -1
7501 .IP \(bu 2.3
7502 .\}
7503 \fIsmb2_credits\fR
7504 .RE
7505 .sp
7506 .RS 4
7507 .ie n \{\
7508 \h'-04'\(bu\h'+03'\c
7509 .\}
7510 .el \{\
7511 .sp -1
7512 .IP \(bu 2.3
7513 .\}
7514 \fIdsdb_audit\fR
7515 .RE
7516 .sp
7517 .RS 4
7518 .ie n \{\
7519 \h'-04'\(bu\h'+03'\c
7520 .\}
7521 .el \{\
7522 .sp -1
7523 .IP \(bu 2.3
7524 .\}
7525 \fIdsdb_json_audit\fR
7526 .RE
7527 .sp
7528 .RS 4
7529 .ie n \{\
7530 \h'-04'\(bu\h'+03'\c
7531 .\}
7532 .el \{\
7533 .sp -1
7534 .IP \(bu 2.3
7535 .\}
7536 \fIdsdb_password_audit\fR
7537 .RE
7538 .sp
7539 .RS 4
7540 .ie n \{\
7541 \h'-04'\(bu\h'+03'\c
7542 .\}
7543 .el \{\
7544 .sp -1
7545 .IP \(bu 2.3
7546 .\}
7547 \fIdsdb_password_json_audit\fR
7548 .RE
7549 .sp
7550 .RS 4
7551 .ie n \{\
7552 \h'-04'\(bu\h'+03'\c
7553 .\}
7554 .el \{\
7555 .sp -1
7556 .IP \(bu 2.3
7557 .\}
7558 \fIdsdb_transaction_audit\fR
7559 .RE
7560 .sp
7561 .RS 4
7562 .ie n \{\
7563 \h'-04'\(bu\h'+03'\c
7564 .\}
7565 .el \{\
7566 .sp -1
7567 .IP \(bu 2.3
7568 .\}
7569 \fIdsdb_transaction_json_audit\fR
7570 .RE
7571 .sp
7572 .RS 4
7573 .ie n \{\
7574 \h'-04'\(bu\h'+03'\c
7575 .\}
7576 .el \{\
7577 .sp -1
7578 .IP \(bu 2.3
7579 .\}
7580 \fIdsdb_group_audit\fR
7581 .RE
7582 .sp
7583 .RS 4
7584 .ie n \{\
7585 \h'-04'\(bu\h'+03'\c
7586 .\}
7587 .el \{\
7588 .sp -1
7589 .IP \(bu 2.3
7590 .\}
7591 \fIdsdb_group_json_audit\fR
7592 .RE
7593 .sp
7594 .RS 4
7595 .ie n \{\
7596 \h'-04'\(bu\h'+03'\c
7597 .\}
7598 .el \{\
7599 .sp -1
7600 .IP \(bu 2.3
7601 .\}
7602 \fIldapsrv\fR
7603 .RE
7604 .sp
7605 .RE
7606 Various modules register dynamic debug classes at first usage:
7607 .RS
7608 .sp
7609 .RS 4
7610 .ie n \{\
7611 \h'-04'\(bu\h'+03'\c
7612 .\}
7613 .el \{\
7614 .sp -1
7615 .IP \(bu 2.3
7616 .\}
7617 \fIcatia\fR
7618 .RE
7619 .sp
7620 .RS 4
7621 .ie n \{\
7622 \h'-04'\(bu\h'+03'\c
7623 .\}
7624 .el \{\
7625 .sp -1
7626 .IP \(bu 2.3
7627 .\}
7628 \fIdfs_samba4\fR
7629 .RE
7630 .sp
7631 .RS 4
7632 .ie n \{\
7633 \h'-04'\(bu\h'+03'\c
7634 .\}
7635 .el \{\
7636 .sp -1
7637 .IP \(bu 2.3
7638 .\}
7639 \fIextd_audit\fR
7640 .RE
7641 .sp
7642 .RS 4
7643 .ie n \{\
7644 \h'-04'\(bu\h'+03'\c
7645 .\}
7646 .el \{\
7647 .sp -1
7648 .IP \(bu 2.3
7649 .\}
7650 \fIfileid\fR
7651 .RE
7652 .sp
7653 .RS 4
7654 .ie n \{\
7655 \h'-04'\(bu\h'+03'\c
7656 .\}
7657 .el \{\
7658 .sp -1
7659 .IP \(bu 2.3
7660 .\}
7661 \fIfruit\fR
7662 .RE
7663 .sp
7664 .RS 4
7665 .ie n \{\
7666 \h'-04'\(bu\h'+03'\c
7667 .\}
7668 .el \{\
7669 .sp -1
7670 .IP \(bu 2.3
7671 .\}
7672 \fIfull_audit\fR
7673 .RE
7674 .sp
7675 .RS 4
7676 .ie n \{\
7677 \h'-04'\(bu\h'+03'\c
7678 .\}
7679 .el \{\
7680 .sp -1
7681 .IP \(bu 2.3
7682 .\}
7683 \fImedia_harmony\fR
7684 .RE
7685 .sp
7686 .RS 4
7687 .ie n \{\
7688 \h'-04'\(bu\h'+03'\c
7689 .\}
7690 .el \{\
7691 .sp -1
7692 .IP \(bu 2.3
7693 .\}
7694 \fIpreopen\fR
7695 .RE
7696 .sp
7697 .RS 4
7698 .ie n \{\
7699 \h'-04'\(bu\h'+03'\c
7700 .\}
7701 .el \{\
7702 .sp -1
7703 .IP \(bu 2.3
7704 .\}
7705 \fIrecycle\fR
7706 .RE
7707 .sp
7708 .RS 4
7709 .ie n \{\
7710 \h'-04'\(bu\h'+03'\c
7711 .\}
7712 .el \{\
7713 .sp -1
7714 .IP \(bu 2.3
7715 .\}
7716 \fIshadow_copy\fR
7717 .RE
7718 .sp
7719 .RS 4
7720 .ie n \{\
7721 \h'-04'\(bu\h'+03'\c
7722 .\}
7723 .el \{\
7724 .sp -1
7725 .IP \(bu 2.3
7726 .\}
7727 \fIshadow_copy\fR
7728 .RE
7729 .sp
7730 .RS 4
7731 .ie n \{\
7732 \h'-04'\(bu\h'+03'\c
7733 .\}
7734 .el \{\
7735 .sp -1
7736 .IP \(bu 2.3
7737 .\}
7738 \fIunityed_media\fR
7739 .RE
7740 .sp
7741 .RS 4
7742 .ie n \{\
7743 \h'-04'\(bu\h'+03'\c
7744 .\}
7745 .el \{\
7746 .sp -1
7747 .IP \(bu 2.3
7748 .\}
7749 \fIvirusfilter\fR
7750 .RE
7751 .sp
7752 .RE
7753 To configure the logging for specific classes to go into a different file then
7754 \m[blue]\fBlog file\fR\m[], you can append
7755 \fI@PATH\fR
7756 to the class, eg
7757 \fIlog level = 1 full_audit:1@/var/log/audit\&.log\fR\&.
7758 .sp
7759 Authentication and authorization audit information is logged under the
7760 \fIauth_audit\fR, and if Samba was not compiled with \-\-without\-json, a JSON representation is logged under
7761 \fIauth_json_audit\fR\&.
7762 .sp
7763 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\&.
7764 .sp
7765 Log levels for
7766 \fIauth_audit\fR
7767 and
7768 \fIauth_audit_json\fR
7769 are:
7770 .RS
7771 .sp
7772 .RS 4
7773 .ie n \{\
7774 \h'-04'\(bu\h'+03'\c
7775 .\}
7776 .el \{\
7777 .sp -1
7778 .IP \(bu 2.3
7779 .\}
7780 2: Authentication Failure
7781 .RE
7782 .sp
7783 .RS 4
7784 .ie n \{\
7785 \h'-04'\(bu\h'+03'\c
7786 .\}
7787 .el \{\
7788 .sp -1
7789 .IP \(bu 2.3
7790 .\}
7791 3: Authentication Success
7792 .RE
7793 .sp
7794 .RS 4
7795 .ie n \{\
7796 \h'-04'\(bu\h'+03'\c
7797 .\}
7798 .el \{\
7799 .sp -1
7800 .IP \(bu 2.3
7801 .\}
7802 4: Authorization Success
7803 .RE
7804 .sp
7805 .RS 4
7806 .ie n \{\
7807 \h'-04'\(bu\h'+03'\c
7808 .\}
7809 .el \{\
7810 .sp -1
7811 .IP \(bu 2.3
7812 .\}
7813 5: Anonymous Authentication and Authorization Success
7814 .RE
7815 .sp
7816 .RE
7817 Changes to the AD DC
7818 sam\&.ldb
7819 database are logged under the
7820 \fIdsdb_audit\fR
7821 and a JSON representation is logged under
7822 \fIdsdb_json_audit\fR\&.
7823 .sp
7824 Group membership changes to the AD DC
7825 sam\&.ldb
7826 database are logged under the
7827 \fIdsdb_group_audit\fR
7828 and a JSON representation is logged under
7829 \fIdsdb_group_json_audit\fR\&.
7830 .sp
7831 Log levels for
7832 \fIdsdb_audit\fR,
7833 \fIdsdb_json_audit\fR,
7834 \fIdsdb_group_audit\fR,
7835 \fIdsdb_group_json_audit\fR
7836 and
7837 \fIdsdb_json_audit\fR
7838 are:
7839 .RS
7840 .sp
7841 .RS 4
7842 .ie n \{\
7843 \h'-04'\(bu\h'+03'\c
7844 .\}
7845 .el \{\
7846 .sp -1
7847 .IP \(bu 2.3
7848 .\}
7849 5: Database modifications
7850 .RE
7851 .sp
7852 .RS 4
7853 .ie n \{\
7854 \h'-04'\(bu\h'+03'\c
7855 .\}
7856 .el \{\
7857 .sp -1
7858 .IP \(bu 2.3
7859 .\}
7860 5: Replicated updates from another DC
7861 .RE
7862 .sp
7863 .RE
7864 Password changes and Password resets in the AD DC are logged under
7865 \fIdsdb_password_audit\fR
7866 and a JSON representation is logged under the
7867 \fIdsdb_password_json_audit\fR\&. Password changes will also appears as authentication events via
7868 \fIauth_audit\fR
7869 and
7870 \fIauth_audit_json\fR\&.
7871 .sp
7872 Log levels for
7873 \fIdsdb_password_audit\fR
7874 and
7875 \fIdsdb_password_json_audit\fR
7876 are:
7877 .RS
7878 .sp
7879 .RS 4
7880 .ie n \{\
7881 \h'-04'\(bu\h'+03'\c
7882 .\}
7883 .el \{\
7884 .sp -1
7885 .IP \(bu 2.3
7886 .\}
7887 5: Successful password changes and resets
7888 .RE
7889 .sp
7890 .RE
7891 Transaction rollbacks and prepare commit failures are logged under the
7892 \fIdsdb_transaction_audit\fR
7893 and a JSON representation is logged under the
7894 \fIdsdb_transaction_json_audit\fR\&.
7895 .sp
7896 Log levels for
7897 \fIdsdb_transaction_audit\fR
7898 and
7899 \fIdsdb_transaction_json\fR
7900 are:
7901 .RS
7902 .sp
7903 .RS 4
7904 .ie n \{\
7905 \h'-04'\(bu\h'+03'\c
7906 .\}
7907 .el \{\
7908 .sp -1
7909 .IP \(bu 2.3
7910 .\}
7911 5: Transaction failure (rollback)
7912 .RE
7913 .sp
7914 .RS 4
7915 .ie n \{\
7916 \h'-04'\(bu\h'+03'\c
7917 .\}
7918 .el \{\
7919 .sp -1
7920 .IP \(bu 2.3
7921 .\}
7922 10: Transaction success (commit)
7923 .RE
7924 .sp
7925 .RE
7926 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
7927 sam\&.ldb
7928 operations that have been rolled back, and so have not actually persisted\&.
7929 .if n \{\
7930 .sp
7931 .\}
7932 .RS 4
7933 .it 1 an-trap
7934 .nr an-no-space-flag 1
7935 .nr an-break-flag 1
7936 .br
7937 .ps +1
7938 \fBWarning\fR
7939 .ps -1
7940 .br
7941 Changes to
7942 sam\&.ldb
7943 made locally by the
7944 root
7945 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\&.
7946 .sp .5v
7947 .RE
7948 Default:
7949 \fI\fIlog level\fR\fR\fI = \fR\fI0\fR\fI \fR
7950 .sp
7951 Example:
7952 \fI\fIlog level\fR\fR\fI = \fR\fI3 passdb:5 auth:10 winbind:2\fR\fI \fR
7953 .sp
7954 Example:
7955 \fI\fIlog level\fR\fR\fI = \fR\fI1 full_audit:1@/var/log/audit\&.log winbind:2\fR\fI \fR
7956 .RE
7957
7958 log nt token command (G)
7959 .PP
7960 .RS 4
7961 This option can be set to a command that will be called when new nt tokens are created\&.
7962 .sp
7963 This is only useful for development purposes\&.
7964 .sp
7965 Default:
7966 \fI\fIlog nt token command\fR\fR\fI = \fR\fI\fR\fI \fR
7967 .RE
7968
7969 logon drive (G)
7970 .PP
7971 .RS 4
7972 This parameter specifies the local path to which the home directory will be connected (see
7973 \m[blue]\fBlogon home\fR\m[]) and is only used by NT Workstations\&.
7974 .sp
7975 Note that this option is only useful if Samba is set up as a logon server\&.
7976 .sp
7977 Default:
7978 \fI\fIlogon drive\fR\fR\fI = \fR\fI\fR\fI \fR
7979 .sp
7980 Example:
7981 \fI\fIlogon drive\fR\fR\fI = \fR\fIh:\fR\fI \fR
7982 .RE
7983
7984 logon home (G)
7985 .PP
7986 .RS 4
7987 This parameter specifies the home directory location when a Win95/98 or NT Workstation logs into a Samba PDC\&. It allows you to do
7988 .sp
7989 C:\e>\fBNET USE H: /HOME\fR
7990 .sp
7991 from a command prompt, for example\&.
7992 .sp
7993 This option takes the standard substitutions, allowing you to have separate logon scripts for each user or machine\&.
7994 .sp
7995 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:
7996 .sp
7997 logon home = \e\e%N\e%U\eprofile
7998 .sp
7999 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
8000 net use /home
8001 but use the whole string when dealing with profiles\&.
8002 .sp
8003 Note that in prior versions of Samba, the
8004 \m[blue]\fBlogon path\fR\m[]
8005 was returned rather than
8006 \fIlogon home\fR\&. This broke
8007 net use /home
8008 but allowed profiles outside the home directory\&. The current implementation is correct, and can be used for profiles if you use the above trick\&.
8009 .sp
8010 Disable this feature by setting
8011 \m[blue]\fBlogon home = ""\fR\m[]
8012 \- using the empty string\&.
8013 .sp
8014 This option is only useful if Samba is set up as a logon server\&.
8015 .sp
8016 Default:
8017 \fI\fIlogon home\fR\fR\fI = \fR\fI\e\e%N\e%U\fR\fI \fR
8018 .sp
8019 Example:
8020 \fI\fIlogon home\fR\fR\fI = \fR\fI\e\eremote_smb_server\e%U\fR\fI \fR
8021 .RE
8022
8023 logon path (G)
8024 .PP
8025 .RS 4
8026 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
8027 \m[blue]\fBlogon home\fR\m[]
8028 parameter\&.
8029 .sp
8030 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",
8031 desktop,
8032 start menu,
8033 network neighborhood,
8034 programs
8035 and other folders, and their contents, are loaded and displayed on your Windows NT client\&.
8036 .sp
8037 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
8038 \fIMAN\fRdatory profile)\&.
8039 .sp
8040 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)\&.
8041 .sp
8042 This option takes the standard substitutions, allowing you to have separate logon scripts for each user or machine\&.
8043 .if n \{\
8044 .sp
8045 .\}
8046 .RS 4
8047 .it 1 an-trap
8048 .nr an-no-space-flag 1
8049 .nr an-break-flag 1
8050 .br
8051 .ps +1
8052 \fBWarning\fR
8053 .ps -1
8054 .br
8055 Do not quote the value\&. Setting this as
8056 \(lq\e\e%N\eprofile\e%U\(rq
8057 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)\&.
8058 .sp .5v
8059 .RE
8060 Note that this option is only useful if Samba is set up as a domain controller\&.
8061 .sp
8062 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\&.
8063 .sp
8064 An example of use is:
8065 .sp
8066 .if n \{\
8067 .RS 4
8068 .\}
8069 .nf
8070 logon path = \e\ePROFILESERVER\ePROFILE\e%U
8071 .fi
8072 .if n \{\
8073 .RE
8074 .\}
8075 .sp
8076 In this example the use of roaming profiles is disabled (depending also on passdb settings):
8077 .sp
8078 .if n \{\
8079 .RS 4
8080 .\}
8081 .nf
8082 logon path =
8083 .fi
8084 .if n \{\
8085 .RE
8086 .\}
8087 .sp
8088 Default:
8089 \fI\fIlogon path\fR\fR\fI = \fR\fI\e\e%N\e%U\eprofile\fR\fI \fR
8090 .RE
8091
8092 logon script (G)
8093 .PP
8094 .RS 4
8095 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\&.
8096 .sp
8097 The script must be a relative path to the
8098 \fI[netlogon]\fR
8099 service\&. If the [netlogon] service specifies a
8100 \m[blue]\fBpath\fR\m[]
8101 of
8102 /usr/local/samba/netlogon, and
8103 \m[blue]\fBlogon script = STARTUP\&.BAT\fR\m[], then the file that will be downloaded is:
8104 .sp
8105 .if n \{\
8106 .RS 4
8107 .\}
8108 .nf
8109 /usr/local/samba/netlogon/STARTUP\&.BAT
8110 .fi
8111 .if n \{\
8112 .RE
8113 .\}
8114 .sp
8115 The contents of the batch file are entirely your choice\&. A suggested command would be to add
8116 NET TIME \e\eSERVER /SET /YES, to force every machine to synchronize clocks with the same time server\&. Another use would be to add
8117 NET USE U: \e\eSERVER\eUTILS
8118 for commonly used utilities, or
8119 .sp
8120 .if n \{\
8121 .RS 4
8122 .\}
8123 .nf
8124 \fBNET USE Q: \e\eSERVER\eISO9001_QA\fR
8125 .fi
8126 .if n \{\
8127 .RE
8128 .\}
8129 .sp
8130 for example\&.
8131 .sp
8132 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\&.
8133 .sp
8134 This option takes the standard substitutions, allowing you to have separate logon scripts for each user or machine\&.
8135 .sp
8136 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
8137 scriptPath
8138 is used instead\&. For configurations where
8139 \m[blue]\fBpassdb backend = ldapsam\fR\m[]
8140 is in use, this option only defines a default value in case LDAP attribute
8141 sambaLogonScript
8142 is missing\&.
8143 .sp
8144 Default:
8145 \fI\fIlogon script\fR\fR\fI = \fR\fI\fR\fI \fR
8146 .sp
8147 Example:
8148 \fI\fIlogon script\fR\fR\fI = \fR\fIscripts\e%U\&.bat\fR\fI \fR
8149 .RE
8150
8151 log writeable files on exit (G)
8152 .PP
8153 .RS 4
8154 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\&.
8155 .sp
8156 Default:
8157 \fI\fIlog writeable files on exit\fR\fR\fI = \fR\fIno\fR\fI \fR
8158 .RE
8159
8160 lppause command (S)
8161 .PP
8162 .RS 4
8163 This parameter specifies the command to be executed on the server host in order to stop printing or spooling a specific print job\&.
8164 .sp
8165 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\&.
8166 .sp
8167 If a
8168 \fI%p\fR
8169 is given then the printer name is put in its place\&. A
8170 \fI%j\fR
8171 is replaced with the job number (an integer)\&. On HPUX (see
8172 \fIprinting=hpux \fR), if the
8173 \fI\-p%p\fR
8174 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\&.
8175 .sp
8176 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\&.
8177 .sp
8178 Currently no default value is given to this string, unless the value of the
8179 \m[blue]\fBprinting\fR\m[]
8180 parameter is
8181 \fBSYSV\fR, in which case the default is :
8182 lp \-i %p\-%j \-H hold
8183 or if the value of the
8184 \fIprinting\fR
8185 parameter is
8186 \fBSOFTQ\fR, then the default is:
8187 qstat \-s \-j%j \-h\&.
8188 .sp
8189 Default:
8190 \fI\fIlppause command\fR\fR\fI = \fR\fI # determined by printing parameter\fR\fI \fR
8191 .sp
8192 Example:
8193 \fI\fIlppause command\fR\fR\fI = \fR\fI/usr/bin/lpalt %p\-%j \-p0\fR\fI \fR
8194 .RE
8195
8196 lpq cache time (G)
8197 .PP
8198 .RS 4
8199 This controls how long lpq info will be cached for to prevent the
8200 lpq
8201 command being called too often\&. A separate cache is kept for each variation of the
8202 lpq
8203 command used by the system, so if you use different
8204 lpq
8205 commands for different users then they won\*(Aqt share cache information\&.
8206 .sp
8207 The cache files are stored in
8208 /tmp/lpq\&.xxxx
8209 where xxxx is a hash of the
8210 lpq
8211 command in use\&.
8212 .sp
8213 The default is 30 seconds, meaning that the cached results of a previous identical
8214 lpq
8215 command will be used if the cached data is less than 30 seconds old\&. A large value may be advisable if your
8216 lpq
8217 command is very slow\&.
8218 .sp
8219 A value of 0 will disable caching completely\&.
8220 .sp
8221 Default:
8222 \fI\fIlpq cache time\fR\fR\fI = \fR\fI30\fR\fI \fR
8223 .sp
8224 Example:
8225 \fI\fIlpq cache time\fR\fR\fI = \fR\fI10\fR\fI \fR
8226 .RE
8227
8228 lpq command (S)
8229 .PP
8230 .RS 4
8231 This parameter specifies the command to be executed on the server host in order to obtain
8232 lpq\-style printer status information\&.
8233 .sp
8234 This command should be a program or script which takes a printer name as its only parameter and outputs printer status information\&.
8235 .sp
8236 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
8237 \fIprinting =\fR
8238 option\&.
8239 .sp
8240 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\&.
8241 .sp
8242 If a
8243 \fI%p\fR
8244 is given then the printer name is put in its place\&. Otherwise it is placed at the end of the command\&.
8245 .sp
8246 Note that it is good practice to include the absolute path in the
8247 \fIlpq command\fR
8248 as the
8249 \fB$PATH \fR
8250 may not be available to the server\&. When compiled with the CUPS libraries, no
8251 \fIlpq command\fR
8252 is needed because smbd will make a library call to obtain the print queue listing\&.
8253 .sp
8254 Default:
8255 \fI\fIlpq command\fR\fR\fI = \fR\fI # determined by printing parameter\fR\fI \fR
8256 .sp
8257 Example:
8258 \fI\fIlpq command\fR\fR\fI = \fR\fI/usr/bin/lpq \-P%p\fR\fI \fR
8259 .RE
8260
8261 lpresume command (S)
8262 .PP
8263 .RS 4
8264 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\&.
8265 .sp
8266 This command should be a program or script which takes a printer name and job number to resume the print job\&. See also the
8267 \m[blue]\fBlppause command\fR\m[]
8268 parameter\&.
8269 .sp
8270 If a
8271 \fI%p\fR
8272 is given then the printer name is put in its place\&. A
8273 \fI%j\fR
8274 is replaced with the job number (an integer)\&.
8275 .sp
8276 Note that it is good practice to include the absolute path in the
8277 \fIlpresume command\fR
8278 as the PATH may not be available to the server\&.
8279 .sp
8280 See also the
8281 \m[blue]\fBprinting\fR\m[]
8282 parameter\&.
8283 .sp
8284 Default: Currently no default value is given to this string, unless the value of the
8285 \fIprinting\fR
8286 parameter is
8287 \fBSYSV\fR, in which case the default is:
8288 .sp
8289 lp \-i %p\-%j \-H resume
8290 .sp
8291 or if the value of the
8292 \fIprinting\fR
8293 parameter is
8294 \fBSOFTQ\fR, then the default is:
8295 .sp
8296 qstat \-s \-j%j \-r
8297 .sp
8298 Default:
8299 \fI\fIlpresume command\fR\fR\fI = \fR\fI # determined by printing parameter\fR\fI \fR
8300 .sp
8301 Example:
8302 \fI\fIlpresume command\fR\fR\fI = \fR\fI/usr/bin/lpalt %p\-%j \-p2\fR\fI \fR
8303 .RE
8304
8305 lprm command (S)
8306 .PP
8307 .RS 4
8308 This parameter specifies the command to be executed on the server host in order to delete a print job\&.
8309 .sp
8310 This command should be a program or script which takes a printer name and job number, and deletes the print job\&.
8311 .sp
8312 If a
8313 \fI%p\fR
8314 is given then the printer name is put in its place\&. A
8315 \fI%j\fR
8316 is replaced with the job number (an integer)\&.
8317 .sp
8318 Note that it is good practice to include the absolute path in the
8319 \fIlprm command\fR
8320 as the PATH may not be available to the server\&.
8321 .sp
8322 Examples of use are:
8323 .sp
8324 .if n \{\
8325 .RS 4
8326 .\}
8327 .nf
8328 lprm command = /usr/bin/lprm \-P%p %j
8329
8330 or
8331
8332 lprm command = /usr/bin/cancel %p\-%j
8333 .fi
8334 .if n \{\
8335 .RE
8336 .\}
8337 .sp
8338 Default:
8339 \fI\fIlprm command\fR\fR\fI = \fR\fI # determined by printing parameter\fR\fI \fR
8340 .RE
8341
8342 lsa over netlogon (G)
8343 .PP
8344 .RS 4
8345 Setting this deprecated option will allow the RPC server in the AD DC to answer the LSARPC interface on the
8346 \epipe\enetlogon
8347 IPC pipe\&.
8348 .sp
8349 When enabled, this matches the behaviour of Microsoft\*(Aqs Windows, due to their internal implementation choices\&.
8350 .sp
8351 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\&.
8352 .sp
8353 Default:
8354 \fI\fIlsa over netlogon\fR\fR\fI = \fR\fIno\fR\fI \fR
8355 .RE
8356
8357 machine password timeout (G)
8358 .PP
8359 .RS 4
8360 If a Samba server is a member of a Windows NT or Active Directory Domain (see the
8361 \m[blue]\fBsecurity = domain\fR\m[]
8362 and
8363 \m[blue]\fBsecurity = ads\fR\m[]
8364 parameters), then periodically a running winbindd process will try and change the MACHINE ACCOUNT PASSWORD stored in the TDB called
8365 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\&.
8366 .sp
8367 See also
8368 \fBsmbpasswd\fR(8), and the
8369 \m[blue]\fBsecurity = domain\fR\m[]
8370 and
8371 \m[blue]\fBsecurity = ads\fR\m[]
8372 parameters\&.
8373 .sp
8374 Default:
8375 \fI\fImachine password timeout\fR\fR\fI = \fR\fI604800\fR\fI \fR
8376 .RE
8377
8378 magic output (S)
8379 .PP
8380 .RS 4
8381 This parameter specifies the name of a file which will contain output created by a magic script (see the
8382 \m[blue]\fBmagic script\fR\m[]
8383 parameter below)\&.
8384 .if n \{\
8385 .sp
8386 .\}
8387 .RS 4
8388 .it 1 an-trap
8389 .nr an-no-space-flag 1
8390 .nr an-break-flag 1
8391 .br
8392 .ps +1
8393 \fBWarning\fR
8394 .ps -1
8395 .br
8396 If two clients use the same
8397 \fImagic script \fR
8398 in the same directory the output file content is undefined\&.
8399 .sp .5v
8400 .RE
8401 Default:
8402 \fI\fImagic output\fR\fR\fI = \fR\fI # <magic script name>\&.out\fR\fI \fR
8403 .sp
8404 Example:
8405 \fI\fImagic output\fR\fR\fI = \fR\fImyfile\&.txt\fR\fI \fR
8406 .RE
8407
8408 magic script (S)
8409 .PP
8410 .RS 4
8411 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\&.
8412 .sp
8413 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\&.
8414 .sp
8415 If the script generates output, output will be sent to the file specified by the
8416 \m[blue]\fBmagic output\fR\m[]
8417 parameter (see above)\&.
8418 .sp
8419 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
8420 \fIas is\fR
8421 on the host, which for some hosts and some shells will require filtering at the DOS end\&.
8422 .sp
8423 Magic scripts are
8424 \fIEXPERIMENTAL\fR
8425 and should
8426 \fINOT\fR
8427 be relied upon\&.
8428 .sp
8429 Default:
8430 \fI\fImagic script\fR\fR\fI = \fR\fI\fR\fI \fR
8431 .sp
8432 Example:
8433 \fI\fImagic script\fR\fR\fI = \fR\fIuser\&.csh\fR\fI \fR
8434 .RE
8435
8436 mangled names (S)
8437 .PP
8438 .RS 4
8439 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\&.
8440 .sp
8441 See the section on
8442 name mangling
8443 for details on how to control the mangling process\&.
8444 .sp
8445 Possible option settings are
8446 .RS
8447 .sp
8448 .RS 4
8449 .ie n \{\
8450 \h'-04'\(bu\h'+03'\c
8451 .\}
8452 .el \{\
8453 .sp -1
8454 .IP \(bu 2.3
8455 .\}
8456 \fIyes\fR
8457 \- enables name mangling for all not DOS 8\&.3 conforming names\&.
8458 .RE
8459 .sp
8460 .RS 4
8461 .ie n \{\
8462 \h'-04'\(bu\h'+03'\c
8463 .\}
8464 .el \{\
8465 .sp -1
8466 .IP \(bu 2.3
8467 .\}
8468 \fIno\fR
8469 \- disables any name mangling\&.
8470 .RE
8471 .sp
8472 .RS 4
8473 .ie n \{\
8474 \h'-04'\(bu\h'+03'\c
8475 .\}
8476 .el \{\
8477 .sp -1
8478 .IP \(bu 2.3
8479 .\}
8480 \fIillegal (default)\fR
8481 \- does mangling for names with illegal NTFS characters\&. This is the most sensible setting for modern clients that don\*(Aqt use the shortname anymore\&.
8482 .RE
8483 .sp
8484 .RE
8485 If mangling is used then the mangling method is as follows:
8486 .RS
8487 .sp
8488 .RS 4
8489 .ie n \{\
8490 \h'-04'\(bu\h'+03'\c
8491 .\}
8492 .el \{\
8493 .sp -1
8494 .IP \(bu 2.3
8495 .\}
8496 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\&.
8497 .RE
8498 .sp
8499 .RS 4
8500 .ie n \{\
8501 \h'-04'\(bu\h'+03'\c
8502 .\}
8503 .el \{\
8504 .sp -1
8505 .IP \(bu 2.3
8506 .\}
8507 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\&.
8508 .sp
8509 Note that the character to use may be specified using the
8510 \m[blue]\fBmangling char\fR\m[]
8511 option, if you don\*(Aqt like \*(Aq~\*(Aq\&.
8512 .RE
8513 .sp
8514 .RS 4
8515 .ie n \{\
8516 \h'-04'\(bu\h'+03'\c
8517 .\}
8518 .el \{\
8519 .sp -1
8520 .IP \(bu 2.3
8521 .\}
8522 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)\&.
8523 .RE
8524 .sp
8525 .RE
8526 The two\-digit hash value consists of upper case alphanumeric characters\&.
8527 .sp
8528 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\&.
8529 .sp
8530 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\&.
8531 .sp
8532 Default:
8533 \fI\fImangled names\fR\fR\fI = \fR\fIillegal\fR\fI \fR
8534 .sp
8535 Example:
8536 \fI\fImangled names\fR\fR\fI = \fR\fIno\fR\fI \fR
8537 .RE
8538
8539 mangle prefix (G)
8540 .PP
8541 .RS 4
8542 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\&.
8543 .sp
8544 mangle prefix is effective only when mangling method is hash2\&.
8545 .sp
8546 Default:
8547 \fI\fImangle prefix\fR\fR\fI = \fR\fI1\fR\fI \fR
8548 .sp
8549 Example:
8550 \fI\fImangle prefix\fR\fR\fI = \fR\fI4\fR\fI \fR
8551 .RE
8552
8553 mangling char (S)
8554 .PP
8555 .RS 4
8556 This controls what character is used as the
8557 \fImagic\fR
8558 character in
8559 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\&.
8560 .sp
8561 Default:
8562 \fI\fImangling char\fR\fR\fI = \fR\fI~\fR\fI \fR
8563 .sp
8564 Example:
8565 \fI\fImangling char\fR\fR\fI = \fR\fI^\fR\fI \fR
8566 .RE
8567
8568 mangling method (G)
8569 .PP
8570 .RS 4
8571 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\&.
8572 .sp
8573 Default:
8574 \fI\fImangling method\fR\fR\fI = \fR\fIhash2\fR\fI \fR
8575 .sp
8576 Example:
8577 \fI\fImangling method\fR\fR\fI = \fR\fIhash\fR\fI \fR
8578 .RE
8579
8580 map acl inherit (S)
8581 .PP
8582 .RS 4
8583 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
8584 \fBsmbd\fR(8)
8585 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\&.
8586 .sp
8587 Default:
8588 \fI\fImap acl inherit\fR\fR\fI = \fR\fIno\fR\fI \fR
8589 .RE
8590
8591 map archive (S)
8592 .PP
8593 .RS 4
8594 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\&.\&.\&.
8595 .sp
8596 Note that this parameter will be ignored if the
8597 \m[blue]\fBstore dos attributes\fR\m[]
8598 parameter is set, as the DOS archive attribute will then be stored inside a UNIX extended attribute\&.
8599 .sp
8600 Note that this requires the
8601 \m[blue]\fBcreate mask\fR\m[]
8602 parameter to be set such that owner execute bit is not masked out (i\&.e\&. it must include 100)\&. See the parameter
8603 \m[blue]\fBcreate mask\fR\m[]
8604 for details\&.
8605 .sp
8606 Default:
8607 \fI\fImap archive\fR\fR\fI = \fR\fIyes\fR\fI \fR
8608 .RE
8609
8610 map hidden (S)
8611 .PP
8612 .RS 4
8613 This controls whether DOS style hidden files should be mapped to the UNIX world execute bit\&.
8614 .sp
8615 Note that this parameter will be ignored if the
8616 \m[blue]\fBstore dos attributes\fR\m[]
8617 parameter is set, as the DOS hidden attribute will then be stored inside a UNIX extended attribute\&.
8618 .sp
8619 Note that this requires the
8620 \m[blue]\fBcreate mask\fR\m[]
8621 to be set such that the world execute bit is not masked out (i\&.e\&. it must include 001)\&. See the parameter
8622 \m[blue]\fBcreate mask\fR\m[]
8623 for details\&.
8624 .sp
8625 Default:
8626 \fI\fImap hidden\fR\fR\fI = \fR\fIno\fR\fI \fR
8627 .RE
8628
8629 map readonly (S)
8630 .PP
8631 .RS 4
8632 This controls how the DOS read only attribute should be mapped from a UNIX filesystem\&.
8633 .sp
8634 This parameter can take three different values, which tell
8635 \fBsmbd\fR(8)
8636 how to display the read only attribute on files, where either
8637 \m[blue]\fBstore dos attributes\fR\m[]
8638 is set to
8639 \fBNo\fR, or no extended attribute is present\&. If
8640 \m[blue]\fBstore dos attributes\fR\m[]
8641 is set to
8642 \fByes\fR
8643 then this parameter is
8644 \fIignored\fR\&. This is a new parameter introduced in Samba version 3\&.0\&.21\&.
8645 .sp
8646 The three settings are :
8647 .RS
8648 .sp
8649 .RS 4
8650 .ie n \{\
8651 \h'-04'\(bu\h'+03'\c
8652 .\}
8653 .el \{\
8654 .sp -1
8655 .IP \(bu 2.3
8656 .\}
8657 \fBYes\fR
8658 \- 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\&.
8659 .RE
8660 .sp
8661 .RS 4
8662 .ie n \{\
8663 \h'-04'\(bu\h'+03'\c
8664 .\}
8665 .el \{\
8666 .sp -1
8667 .IP \(bu 2.3
8668 .\}
8669 \fBPermissions\fR
8670 \- The read only DOS attribute is mapped to the effective permissions of the connecting user, as evaluated by
8671 \fBsmbd\fR(8)
8672 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\&.
8673 .RE
8674 .sp
8675 .RS 4
8676 .ie n \{\
8677 \h'-04'\(bu\h'+03'\c
8678 .\}
8679 .el \{\
8680 .sp -1
8681 .IP \(bu 2.3
8682 .\}
8683 \fBNo\fR
8684 \- The read only DOS attribute is unaffected by permissions, and can only be set by the
8685 \m[blue]\fBstore dos attributes\fR\m[]
8686 method\&. This may be useful for exporting mounted CDs\&.
8687 .RE
8688 .sp
8689 .RE
8690 Note that this parameter will be ignored if the
8691 \m[blue]\fBstore dos attributes\fR\m[]
8692 parameter is set, as the DOS \*(Aqread\-only\*(Aq attribute will then be stored inside a UNIX extended attribute\&.
8693 .sp
8694 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
8695 \m[blue]\fBstore dos attributes\fR\m[]
8696 has been changed to
8697 \fBYes\fR
8698 in Samba release 4\&.9\&.0 and above\&.
8699 .sp
8700 Default:
8701 \fI\fImap readonly\fR\fR\fI = \fR\fIno\fR\fI \fR
8702 .RE
8703
8704 map system (S)
8705 .PP
8706 .RS 4
8707 This controls whether DOS style system files should be mapped to the UNIX group execute bit\&.
8708 .sp
8709 Note that this parameter will be ignored if the
8710 \m[blue]\fBstore dos attributes\fR\m[]
8711 parameter is set, as the DOS system attribute will then be stored inside a UNIX extended attribute\&.
8712 .sp
8713 Note that this requires the
8714 \m[blue]\fBcreate mask\fR\m[]
8715 to be set such that the group execute bit is not masked out (i\&.e\&. it must include 010)\&. See the parameter
8716 \m[blue]\fBcreate mask\fR\m[]
8717 for details\&.
8718 .sp
8719 Default:
8720 \fI\fImap system\fR\fR\fI = \fR\fIno\fR\fI \fR
8721 .RE
8722
8723 map to guest (G)
8724 .PP
8725 .RS 4
8726 This parameter can take four different values, which tell
8727 \fBsmbd\fR(8)
8728 what to do with user login requests that don\*(Aqt match a valid UNIX user in some way\&.
8729 .sp
8730 The four settings are :
8731 .RS
8732 .sp
8733 .RS 4
8734 .ie n \{\
8735 \h'-04'\(bu\h'+03'\c
8736 .\}
8737 .el \{\
8738 .sp -1
8739 .IP \(bu 2.3
8740 .\}
8741 \fBNever\fR
8742 \- Means user login requests with an invalid password are rejected\&. This is the default\&.
8743 .RE
8744 .sp
8745 .RS 4
8746 .ie n \{\
8747 \h'-04'\(bu\h'+03'\c
8748 .\}
8749 .el \{\
8750 .sp -1
8751 .IP \(bu 2.3
8752 .\}
8753 \fBBad User\fR
8754 \- 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
8755 \m[blue]\fBguest account\fR\m[]\&.
8756 .RE
8757 .sp
8758 .RS 4
8759 .ie n \{\
8760 \h'-04'\(bu\h'+03'\c
8761 .\}
8762 .el \{\
8763 .sp -1
8764 .IP \(bu 2.3
8765 .\}
8766 \fBBad Password\fR
8767 \- Means user logins with an invalid password are treated as a guest login and mapped into the
8768 \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
8769 \fIhate\fR
8770 you if you set the
8771 \fImap to guest\fR
8772 parameter this way :\-)\&.
8773 .RE
8774 .sp
8775 .RS 4
8776 .ie n \{\
8777 \h'-04'\(bu\h'+03'\c
8778 .\}
8779 .el \{\
8780 .sp -1
8781 .IP \(bu 2.3
8782 .\}
8783 \fBBad Uid\fR
8784 \- 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\&.
8785 .RE
8786 .sp
8787 .RE
8788 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
8789 \fInot\fR
8790 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\&.
8791 .sp
8792 Default:
8793 \fI\fImap to guest\fR\fR\fI = \fR\fINever\fR\fI \fR
8794 .sp
8795 Example:
8796 \fI\fImap to guest\fR\fR\fI = \fR\fIBad User\fR\fI \fR
8797 .RE
8798
8799 max connections (S)
8800 .PP
8801 .RS 4
8802 This option allows the number of simultaneous connections to a service to be limited\&. If
8803 \fImax connections\fR
8804 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\&.
8805 .sp
8806 Record lock files are used to implement this feature\&. The lock files will be stored in the directory specified by the
8807 \m[blue]\fBlock directory\fR\m[]
8808 option\&.
8809 .sp
8810 Default:
8811 \fI\fImax connections\fR\fR\fI = \fR\fI0\fR\fI \fR
8812 .sp
8813 Example:
8814 \fI\fImax connections\fR\fR\fI = \fR\fI10\fR\fI \fR
8815 .RE
8816
8817 max disk size (G)
8818 .PP
8819 .RS 4
8820 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\&.
8821 .sp
8822 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
8823 \fImax disk size\fR\&.
8824 .sp
8825 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\&.
8826 .sp
8827 A
8828 \fImax disk size\fR
8829 of 0 means no limit\&.
8830 .sp
8831 Default:
8832 \fI\fImax disk size\fR\fR\fI = \fR\fI0\fR\fI \fR
8833 .sp
8834 Example:
8835 \fI\fImax disk size\fR\fR\fI = \fR\fI1000\fR\fI \fR
8836 .RE
8837
8838 max log size (G)
8839 .PP
8840 .RS 4
8841 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
8842 \&.old
8843 extension\&.
8844 .sp
8845 A size of 0 means no limit\&.
8846 .sp
8847 Default:
8848 \fI\fImax log size\fR\fR\fI = \fR\fI5000\fR\fI \fR
8849 .sp
8850 Example:
8851 \fI\fImax log size\fR\fR\fI = \fR\fI1000\fR\fI \fR
8852 .RE
8853
8854 max mux (G)
8855 .PP
8856 .RS 4
8857 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\&.
8858 .sp
8859 Default:
8860 \fI\fImax mux\fR\fR\fI = \fR\fI50\fR\fI \fR
8861 .RE
8862
8863 max open files (G)
8864 .PP
8865 .RS 4
8866 This parameter limits the maximum number of open files that one
8867 \fBsmbd\fR(8)
8868 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\&.
8869 .sp
8870 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\&.
8871 .sp
8872 Default:
8873 \fI\fImax open files\fR\fR\fI = \fR\fI16384\fR\fI \fR
8874 .RE
8875
8876 max print jobs (S)
8877 .PP
8878 .RS 4
8879 This parameter limits the maximum number of jobs allowable in a Samba printer queue at any given moment\&. If this number is exceeded,
8880 \fBsmbd\fR(8)
8881 will remote "Out of Space" to the client\&.
8882 .sp
8883 Default:
8884 \fI\fImax print jobs\fR\fR\fI = \fR\fI1000\fR\fI \fR
8885 .sp
8886 Example:
8887 \fI\fImax print jobs\fR\fR\fI = \fR\fI5000\fR\fI \fR
8888 .RE
8889
8890 max reported print jobs (S)
8891 .PP
8892 .RS 4
8893 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\&.
8894 .sp
8895 Default:
8896 \fI\fImax reported print jobs\fR\fR\fI = \fR\fI0\fR\fI \fR
8897 .sp
8898 Example:
8899 \fI\fImax reported print jobs\fR\fR\fI = \fR\fI1000\fR\fI \fR
8900 .RE
8901
8902 max smbd processes (G)
8903 .PP
8904 .RS 4
8905 This parameter limits the maximum number of
8906 \fBsmbd\fR(8)
8907 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
8908 \fBsmbd\fR(8)
8909 associated with him or her to handle connections to all shares from a given host\&.
8910 .sp
8911 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\&.
8912 .sp
8913 Default:
8914 \fI\fImax smbd processes\fR\fR\fI = \fR\fI0\fR\fI \fR
8915 .sp
8916 Example:
8917 \fI\fImax smbd processes\fR\fR\fI = \fR\fI1000\fR\fI \fR
8918 .RE
8919
8920 max stat cache size (G)
8921 .PP
8922 .RS 4
8923 This parameter limits the size in memory of any
8924 \fIstat cache\fR
8925 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\&.
8926 .sp
8927 Default:
8928 \fI\fImax stat cache size\fR\fR\fI = \fR\fI512\fR\fI \fR
8929 .sp
8930 Example:
8931 \fI\fImax stat cache size\fR\fR\fI = \fR\fI100\fR\fI \fR
8932 .RE
8933
8934 max ttl (G)
8935 .PP
8936 .RS 4
8937 This option tells
8938 \fBnmbd\fR(8)
8939 what the default \*(Aqtime to live\*(Aq of NetBIOS names should be (in seconds) when
8940 nmbd
8941 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\&.
8942 .sp
8943 Default:
8944 \fI\fImax ttl\fR\fR\fI = \fR\fI259200\fR\fI \fR
8945 .RE
8946
8947 max wins ttl (G)
8948 .PP
8949 .RS 4
8950 This option tells
8951 \fBsmbd\fR(8)
8952 when acting as a WINS server (\m[blue]\fBwins support = yes\fR\m[]) what the maximum \*(Aqtime to live\*(Aq of NetBIOS names that
8953 nmbd
8954 will grant will be (in seconds)\&. You should never need to change this parameter\&. The default is 6 days (518400 seconds)\&.
8955 .sp
8956 Default:
8957 \fI\fImax wins ttl\fR\fR\fI = \fR\fI518400\fR\fI \fR
8958 .RE
8959
8960 max xmit (G)
8961 .PP
8962 .RS 4
8963 This option controls the maximum packet size that will be negotiated by Samba\*(Aqs
8964 \fBsmbd\fR(8)
8965 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\&.
8966 .sp
8967 Default:
8968 \fI\fImax xmit\fR\fR\fI = \fR\fI16644\fR\fI \fR
8969 .sp
8970 Example:
8971 \fI\fImax xmit\fR\fR\fI = \fR\fI8192\fR\fI \fR
8972 .RE
8973
8974 mdns name (G)
8975 .PP
8976 .RS 4
8977 This parameter controls the name that multicast DNS support advertises as its\*(Aq hostname\&.
8978 .sp
8979 The default is to use the NETBIOS name which is typically the hostname in all capital letters\&.
8980 .sp
8981 A setting of mdns will defer the hostname configuration to the MDNS library that is used\&.
8982 .sp
8983 Default:
8984 \fI\fImdns name\fR\fR\fI = \fR\fInetbios\fR\fI \fR
8985 .RE
8986
8987 message command (G)
8988 .PP
8989 .RS 4
8990 This specifies what command to run when the server receives a WinPopup style message\&.
8991 .sp
8992 This would normally be a command that would deliver the message somehow\&. How this is to be done is up to your imagination\&.
8993 .sp
8994 An example is:
8995 .sp
8996 .if n \{\
8997 .RS 4
8998 .\}
8999 .nf
9000 message command = csh \-c \*(Aqxedit %s;rm %s\*(Aq &
9001 .fi
9002 .if n \{\
9003 .RE
9004 .\}
9005 .sp
9006 This delivers the message using
9007 xedit, then removes it afterwards\&.
9008 \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)\&.
9009 .sp
9010 All messages are delivered as the global guest user\&. The command takes the standard substitutions, although
9011 \fI %u\fR
9012 won\*(Aqt work (\fI%U\fR
9013 may be better in this case)\&.
9014 .sp
9015 Apart from the standard substitutions, some additional ones apply\&. In particular:
9016 .RS
9017 .sp
9018 .RS 4
9019 .ie n \{\
9020 \h'-04'\(bu\h'+03'\c
9021 .\}
9022 .el \{\
9023 .sp -1
9024 .IP \(bu 2.3
9025 .\}
9026 \fI%s\fR
9027 = the filename containing the message\&.
9028 .RE
9029 .sp
9030 .RS 4
9031 .ie n \{\
9032 \h'-04'\(bu\h'+03'\c
9033 .\}
9034 .el \{\
9035 .sp -1
9036 .IP \(bu 2.3
9037 .\}
9038 \fI%t\fR
9039 = the destination that the message was sent to (probably the server name)\&.
9040 .RE
9041 .sp
9042 .RS 4
9043 .ie n \{\
9044 \h'-04'\(bu\h'+03'\c
9045 .\}
9046 .el \{\
9047 .sp -1
9048 .IP \(bu 2.3
9049 .\}
9050 \fI%f\fR
9051 = who the message is from\&.
9052 .RE
9053 .sp
9054 .RE
9055 You could make this command send mail, or whatever else takes your fancy\&. Please let us know of any really interesting ideas you have\&.
9056 .sp
9057 Here\*(Aqs a way of sending the messages as mail to root:
9058 .sp
9059 .if n \{\
9060 .RS 4
9061 .\}
9062 .nf
9063 message command = /bin/mail \-s \*(Aqmessage from %f on %m\*(Aq root < %s; rm %s
9064 .fi
9065 .if n \{\
9066 .RE
9067 .\}
9068 .sp
9069 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\&.
9070 .sp
9071 If you want to silently delete it then try:
9072 .sp
9073 .if n \{\
9074 .RS 4
9075 .\}
9076 .nf
9077 message command = rm %s
9078 .fi
9079 .if n \{\
9080 .RE
9081 .\}
9082 .sp
9083 Default:
9084 \fI\fImessage command\fR\fR\fI = \fR\fI\fR\fI \fR
9085 .sp
9086 Example:
9087 \fI\fImessage command\fR\fR\fI = \fR\fIcsh \-c \*(Aqxedit %s; rm %s\*(Aq &\fR\fI \fR
9088 .RE
9089
9090 min domain uid (G)
9091 .PP
9092 .RS 4
9093 The integer parameter specifies the minimum uid allowed when mapping a local account to a domain account\&.
9094 .sp
9095 Note that this option interacts with the configured
9096 \fIidmap ranges\fR!
9097 .sp
9098 Default:
9099 \fI\fImin domain uid\fR\fR\fI = \fR\fI1000\fR\fI \fR
9100 .RE
9101
9102 min print space (S)
9103 .PP
9104 .RS 4
9105 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\&.
9106 .sp
9107 Default:
9108 \fI\fImin print space\fR\fR\fI = \fR\fI0\fR\fI \fR
9109 .sp
9110 Example:
9111 \fI\fImin print space\fR\fR\fI = \fR\fI2000\fR\fI \fR
9112 .RE
9113
9114 min receivefile size (G)
9115 .PP
9116 .RS 4
9117 This option changes the behavior of
9118 \fBsmbd\fR(8)
9119 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\&.
9120 .sp
9121 Note this option will have NO EFFECT if set on a SMB signed connection\&.
9122 .sp
9123 The default is zero, which disables this option\&.
9124 .sp
9125 Default:
9126 \fI\fImin receivefile size\fR\fR\fI = \fR\fI0\fR\fI \fR
9127 .RE
9128
9129 min wins ttl (G)
9130 .PP
9131 .RS 4
9132 This option tells
9133 \fBnmbd\fR(8)
9134 when acting as a WINS server (\m[blue]\fBwins support = yes\fR\m[]) what the minimum \*(Aqtime to live\*(Aq of NetBIOS names that
9135 nmbd
9136 will grant will be (in seconds)\&. You should never need to change this parameter\&. The default is 6 hours (21600 seconds)\&.
9137 .sp
9138 Default:
9139 \fI\fImin wins ttl\fR\fR\fI = \fR\fI21600\fR\fI \fR
9140 .RE
9141
9142 mit kdc command (G)
9143 .PP
9144 .RS 4
9145 This option specifies the path to the MIT kdc binary\&.
9146 .sp
9147 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\&.
9148 .sp
9149 Default:
9150 \fI\fImit kdc command\fR\fR\fI = \fR\fI/usr/sbin/krb5kdc\fR\fI \fR
9151 .sp
9152 Example:
9153 \fI\fImit kdc command\fR\fR\fI = \fR\fI/opt/mit/sbin/krb5kdc\fR\fI \fR
9154 .RE
9155
9156 msdfs proxy (S)
9157 .PP
9158 .RS 4
9159 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\&.
9160 .sp
9161 Only Dfs roots can act as proxy shares\&. Take a look at the
9162 \m[blue]\fBmsdfs root\fR\m[]
9163 and
9164 \m[blue]\fBhost msdfs\fR\m[]
9165 options to find out how to set up a Dfs root share\&.
9166 .sp
9167 \fINo default\fR
9168 .sp
9169 Example:
9170 \fI\fImsdfs proxy\fR\fR\fI = \fR\fI\eotherserver\esomeshare,\eotherserver2\esomeshare\fR\fI \fR
9171 .RE
9172
9173 msdfs root (S)
9174 .PP
9175 .RS 4
9176 If set to
9177 \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
9178 msdfs:serverA\e\eshareA,serverB\e\eshareB
9179 and so on\&. For more information on setting up a Dfs tree on Samba, refer to the MSDFS chapter in the Samba3\-HOWTO book\&.
9180 .sp
9181 Default:
9182 \fI\fImsdfs root\fR\fR\fI = \fR\fIno\fR\fI \fR
9183 .RE
9184
9185 msdfs shuffle referrals (S)
9186 .PP
9187 .RS 4
9188 If set to
9189 \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\&.
9190 .sp
9191 Default:
9192 \fI\fImsdfs shuffle referrals\fR\fR\fI = \fR\fIno\fR\fI \fR
9193 .RE
9194
9195 multicast dns register (G)
9196 .PP
9197 .RS 4
9198 If compiled with proper support for it, Samba will announce itself with multicast DNS services like for example provided by the Avahi daemon\&.
9199 .sp
9200 This parameter allows disabling Samba to register itself\&.
9201 .sp
9202 Default:
9203 \fI\fImulticast dns register\fR\fR\fI = \fR\fIyes\fR\fI \fR
9204 .RE
9205
9206 name cache timeout (G)
9207 .PP
9208 .RS 4
9209 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\&.
9210 .sp
9211 Default:
9212 \fI\fIname cache timeout\fR\fR\fI = \fR\fI660\fR\fI \fR
9213 .sp
9214 Example:
9215 \fI\fIname cache timeout\fR\fR\fI = \fR\fI0\fR\fI \fR
9216 .RE
9217
9218 name resolve order (G)
9219 .PP
9220 .RS 4
9221 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\&.
9222 .sp
9223 The options are: "lmhosts", "host", "wins" and "bcast"\&. They cause names to be resolved as follows:
9224 .RS
9225 .sp
9226 .RS 4
9227 .ie n \{\
9228 \h'-04'\(bu\h'+03'\c
9229 .\}
9230 .el \{\
9231 .sp -1
9232 .IP \(bu 2.3
9233 .\}
9234 \fBlmhosts\fR
9235 : 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\&.
9236 .RE
9237 .sp
9238 .RS 4
9239 .ie n \{\
9240 \h'-04'\(bu\h'+03'\c
9241 .\}
9242 .el \{\
9243 .sp -1
9244 .IP \(bu 2.3
9245 .\}
9246 \fBhost\fR
9247 : Do a standard host name to IP address resolution, using the system
9248 /etc/hosts
9249 or DNS lookups\&. This method of name resolution is operating system depended for instance on IRIX or Solaris this may be controlled by the
9250 /etc/nsswitch\&.conf
9251 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\&.
9252 .RE
9253 .sp
9254 .RS 4
9255 .ie n \{\
9256 \h'-04'\(bu\h'+03'\c
9257 .\}
9258 .el \{\
9259 .sp -1
9260 .IP \(bu 2.3
9261 .\}
9262 \fBwins\fR
9263 : Query a name with the IP address listed in the
9264 \m[blue]\fBWINSSERVER\fR\m[]
9265 parameter\&. If no WINS server has been specified this method will be ignored\&.
9266 .RE
9267 .sp
9268 .RS 4
9269 .ie n \{\
9270 \h'-04'\(bu\h'+03'\c
9271 .\}
9272 .el \{\
9273 .sp -1
9274 .IP \(bu 2.3
9275 .\}
9276 \fBbcast\fR
9277 : Do a broadcast on each of the known local interfaces listed in the
9278 \m[blue]\fBinterfaces\fR\m[]
9279 parameter\&. This is the least reliable of the name resolution methods as it depends on the target host being on a locally connected subnet\&.
9280 .RE
9281 .sp
9282 .RE
9283 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\&.
9284 .sp
9285 When Samba is functioning in ADS security mode (security = ads) it is advised to use following settings for
9286 \fIname resolve order\fR:
9287 .sp
9288 name resolve order = wins bcast
9289 .sp
9290 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\&.
9291 .sp
9292 Default:
9293 \fI\fIname resolve order\fR\fR\fI = \fR\fIlmhosts wins host bcast\fR\fI \fR
9294 .sp
9295 Example:
9296 \fI\fIname resolve order\fR\fR\fI = \fR\fIlmhosts bcast host\fR\fI \fR
9297 .RE
9298
9299 socket address
9300 .PP
9301 .RS 4
9302 This parameter is a synonym for
9303 nbt client socket address\&.
9304 .RE
9305
9306 nbt client socket address (G)
9307 .PP
9308 .RS 4
9309 This option allows you to control what address Samba will send NBT client packets from, and process replies using, including in nmbd\&.
9310 .sp
9311 Setting this option should never be necessary on usual Samba servers running only one nmbd\&.
9312 .sp
9313 By default Samba will send UDP packets from the OS default address for the destination, and accept replies on 0\&.0\&.0\&.0\&.
9314 .sp
9315 This parameter is deprecated\&. See
9316 \m[blue]\fBbind interfaces only = Yes\fR\m[]
9317 and
9318 \m[blue]\fBinterfaces\fR\m[]
9319 for the previous behaviour of controlling the normal listening sockets\&.
9320 .sp
9321 Default:
9322 \fI\fInbt client socket address\fR\fR\fI = \fR\fI0\&.0\&.0\&.0\fR\fI \fR
9323 .sp
9324 Example:
9325 \fI\fInbt client socket address\fR\fR\fI = \fR\fI192\&.168\&.2\&.20\fR\fI \fR
9326 .RE
9327
9328 nbtd:wins_prepend1Bto1Cqueries (G)
9329 .PP
9330 .RS 4
9331 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)\&.
9332 .sp
9333 Default:
9334 \fI\fInbtd:wins_prepend1Bto1Cqueries\fR\fR\fI = \fR\fIyes\fR\fI \fR
9335 .RE
9336
9337 nbtd:wins_wins_randomize1Clist (G)
9338 .PP
9339 .RS 4
9340 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\&.
9341 .sp
9342 Default:
9343 \fI\fInbtd:wins_wins_randomize1Clist\fR\fR\fI = \fR\fIno\fR\fI \fR
9344 .RE
9345
9346 nbtd:wins_randomize1Clist_mask (G)
9347 .PP
9348 .RS 4
9349 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\&.
9350 .sp
9351 Default:
9352 \fI\fInbtd:wins_randomize1Clist_mask\fR\fR\fI = \fR\fI255\&.255\&.255\&.0\fR\fI \fR
9353 .RE
9354
9355 nbt port (G)
9356 .PP
9357 .RS 4
9358 Specifies which port the server should use for NetBIOS over IP name services traffic\&.
9359 .sp
9360 Default:
9361 \fI\fInbt port\fR\fR\fI = \fR\fI137\fR\fI \fR
9362 .RE
9363
9364 ncalrpc dir (G)
9365 .PP
9366 .RS 4
9367 This directory will hold a series of named pipes to allow RPC over inter\-process communication\&.
9368 .sp
9369 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
9370 .sp
9371 Default:
9372 \fI\fIncalrpc dir\fR\fR\fI = \fR\fI/run/samba/ncalrpc\fR\fI \fR
9373 .sp
9374 Example:
9375 \fI\fIncalrpc dir\fR\fR\fI = \fR\fI/var/run/samba/ncalrpc\fR\fI \fR
9376 .RE
9377
9378 netbios aliases (G)
9379 .PP
9380 .RS 4
9381 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\&.
9382 .sp
9383 Default:
9384 \fI\fInetbios aliases\fR\fR\fI = \fR\fI # empty string (no additional names)\fR\fI \fR
9385 .sp
9386 Example:
9387 \fI\fInetbios aliases\fR\fR\fI = \fR\fITEST TEST1 TEST2\fR\fI \fR
9388 .RE
9389
9390 netbios name (G)
9391 .PP
9392 .RS 4
9393 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\&.
9394 .sp
9395 Note that the maximum length for a NetBIOS name is 15 characters\&.
9396 .sp
9397 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
9398 PIPE\&. To avoid this problem, do not name your Samba server
9399 PIPE\&.
9400 .sp
9401 Default:
9402 \fI\fInetbios name\fR\fR\fI = \fR\fI # machine DNS name\fR\fI \fR
9403 .sp
9404 Example:
9405 \fI\fInetbios name\fR\fR\fI = \fR\fIMYNAME\fR\fI \fR
9406 .RE
9407
9408 netbios scope (G)
9409 .PP
9410 .RS 4
9411 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\&.
9412 .sp
9413 Default:
9414 \fI\fInetbios scope\fR\fR\fI = \fR\fI\fR\fI \fR
9415 .RE
9416
9417 neutralize nt4 emulation (G)
9418 .PP
9419 .RS 4
9420 This option controls whether winbindd sends the NETLOGON_NEG_NEUTRALIZE_NT4_EMULATION flag in order to bypass the NT4 emulation of a domain controller\&.
9421 .sp
9422 Typically you should not need set this\&. It can be useful for upgrades from NT4 to AD domains\&.
9423 .sp
9424 The behavior can be controlled per netbios domain by using \*(Aqneutralize nt4 emulation:NETBIOSDOMAIN = yes\*(Aq as option\&.
9425 .sp
9426 Default:
9427 \fI\fIneutralize nt4 emulation\fR\fR\fI = \fR\fIno\fR\fI \fR
9428 .RE
9429
9430 nmbd bind explicit broadcast (G)
9431 .PP
9432 .RS 4
9433 This option causes
9434 \fBnmbd\fR(8)
9435 to explicitly bind to the broadcast address of the local subnets\&. This is needed to make nmbd work correctly in combination with the
9436 \m[blue]\fBsocket address\fR\m[]
9437 option\&. You should not need to unset this option\&.
9438 .sp
9439 Default:
9440 \fI\fInmbd bind explicit broadcast\fR\fR\fI = \fR\fIyes\fR\fI \fR
9441 .RE
9442
9443 nsupdate command (G)
9444 .PP
9445 .RS 4
9446 This option sets the path to the
9447 nsupdate
9448 command which is used for GSS\-TSIG dynamic DNS updates\&.
9449 .sp
9450 Default:
9451 \fI\fInsupdate command\fR\fR\fI = \fR\fI/usr/bin/nsupdate \-g\fR\fI \fR
9452 .RE
9453
9454 nt hash store (G)
9455 .PP
9456 .RS 4
9457 This parameter determines whether or not
9458 \fBsamba\fR(8)
9459 will, as an AD DC, attempt to store the NT password hash used in NTLM and NTLMv2 authentication for users in this domain\&.
9460 .sp
9461 If so configured, the Samba Active Directory Domain Controller, will, except for trust accounts (computers, domain controllers and inter\-domain trusts) the
9462 \fINOT store the NT hash\fR
9463 for new and changed accounts in the sam\&.ldb database\&.
9464 .sp
9465 This avoids the storage of an unsalted hash for these user\-created passwords\&. As a consequence the
9466 \fBarcfour\-hmac\-md5\fR
9467 Kerberos key type is also unavailable in the KDC for these users \- thankfully
9468 \fImodern clients will select an AES based key instead\&.\fR
9469 .sp
9470 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\&.
9471 .sp
9472 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\&.
9473 .sp
9474 The available settings are:
9475 .RS
9476 .sp
9477 .RS 4
9478 .ie n \{\
9479 \h'-04'\(bu\h'+03'\c
9480 .\}
9481 .el \{\
9482 .sp -1
9483 .IP \(bu 2.3
9484 .\}
9485 \fBalways\fR
9486 \- Always store the NT hash (as machine accounts will also always store an NT hash, a hash will be stored for all accounts)\&.
9487 .sp
9488 This setting may be useful if
9489 \fIntlm auth\fR
9490 is set to
9491 \fBdisabled\fR
9492 for a trial period
9493 .RE
9494 .sp
9495 .RS 4
9496 .ie n \{\
9497 \h'-04'\(bu\h'+03'\c
9498 .\}
9499 .el \{\
9500 .sp -1
9501 .IP \(bu 2.3
9502 .\}
9503 \fBnever\fR
9504 \- Never store the NT hash for user accounts, only for machine accounts
9505 .RE
9506 .sp
9507 .RS 4
9508 .ie n \{\
9509 \h'-04'\(bu\h'+03'\c
9510 .\}
9511 .el \{\
9512 .sp -1
9513 .IP \(bu 2.3
9514 .\}
9515 \fBauto\fR
9516 \- Store an NT hash if
9517 \fIntlm auth\fR
9518 is not set to
9519 \fBdisabled\fR\&.
9520 .RE
9521 .sp
9522 .RE
9523 Default:
9524 \fI\fInt hash store\fR\fR\fI = \fR\fIalways\fR\fI \fR
9525 .RE
9526
9527 nt acl support (S)
9528 .PP
9529 .RS 4
9530 This boolean parameter controls whether
9531 \fBsmbd\fR(8)
9532 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\&.
9533 .sp
9534 Default:
9535 \fI\fInt acl support\fR\fR\fI = \fR\fIyes\fR\fI \fR
9536 .RE
9537
9538 ntlm auth (G)
9539 .PP
9540 .RS 4
9541 This parameter determines whether or not
9542 \fBsmbd\fR(8)
9543 will attempt to authenticate users using the NTLM encrypted password response for this local passdb (SAM or account database)\&.
9544 .sp
9545 If disabled, both NTLM and LanMan authentication against the local passdb is disabled\&.
9546 .sp
9547 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\&.
9548 .sp
9549 By default with
9550 ntlm auth
9551 set to
9552 \fBntlmv2\-only\fR
9553 only NTLMv2 logins will be permitted\&. All modern clients support NTLMv2 by default, but some older clients will require special configuration to use it\&.
9554 .sp
9555 The primary user of NTLMv1 is MSCHAPv2 for VPNs and 802\&.1x\&.
9556 .sp
9557 The available settings are:
9558 .RS
9559 .sp
9560 .RS 4
9561 .ie n \{\
9562 \h'-04'\(bu\h'+03'\c
9563 .\}
9564 .el \{\
9565 .sp -1
9566 .IP \(bu 2.3
9567 .\}
9568 \fBntlmv1\-permitted\fR
9569 (alias
9570 \fByes\fR) \- Allow NTLMv1 and above for all clients\&.
9571 .sp
9572 This is the required setting to enable the
9573 \fIlanman auth\fR
9574 parameter\&.
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 \fBntlmv2\-only\fR
9586 (alias
9587 \fBno\fR) \- Do not allow NTLMv1 to be used, but permit NTLMv2\&.
9588 .RE
9589 .sp
9590 .RS 4
9591 .ie n \{\
9592 \h'-04'\(bu\h'+03'\c
9593 .\}
9594 .el \{\
9595 .sp -1
9596 .IP \(bu 2.3
9597 .\}
9598 \fBmschapv2\-and\-ntlmv2\-only\fR
9599 \- Only allow NTLMv1 when the client promises that it is providing MSCHAPv2 authentication (such as the
9600 ntlm_auth
9601 tool)\&.
9602 .RE
9603 .sp
9604 .RS 4
9605 .ie n \{\
9606 \h'-04'\(bu\h'+03'\c
9607 .\}
9608 .el \{\
9609 .sp -1
9610 .IP \(bu 2.3
9611 .\}
9612 \fBdisabled\fR
9613 \- Do not accept NTLM (or LanMan) authentication of any level, nor permit NTLM password changes\&.
9614 .sp
9615 \fIWARNING:\fR
9616 Both Microsoft Windows and Samba
9617 \fIRead Only Domain Controllers\fR
9618 (RODCs) convert a plain\-text LDAP Simple Bind into an NTLMv2 authentication to forward to a full DC\&. Setting this option to
9619 \fBdisabled\fR
9620 will cause these forwarded authentications to fail\&.
9621 .sp
9622 Additionally, for Samba acting as an Active Directory Domain Controller, for user accounts, if
9623 \fInt hash store\fR
9624 is set to the default setting of
9625 \fBauto\fR, the
9626 \fINT hash will not be stored\fR
9627 in the sam\&.ldb database for new users and after a password change\&.
9628 .RE
9629 .sp
9630 .RE
9631 The default changed from
9632 \fByes\fR
9633 to
9634 \fBno\fR
9635 with Samba 4\&.5\&. The default changed again to
9636 \fBntlmv2\-only\fR
9637 with Samba 4\&.7, however the behaviour is unchanged\&.
9638 .sp
9639 Default:
9640 \fI\fIntlm auth\fR\fR\fI = \fR\fIntlmv2\-only\fR\fI \fR
9641 .RE
9642
9643 nt pipe support (G)
9644 .PP
9645 .RS 4
9646 This boolean parameter controls whether
9647 \fBsmbd\fR(8)
9648 will allow Windows NT clients to connect to the NT SMB specific
9649 \fBIPC$\fR
9650 pipes\&. This is a developer debugging option and can be left alone\&.
9651 .sp
9652 Default:
9653 \fI\fInt pipe support\fR\fR\fI = \fR\fIyes\fR\fI \fR
9654 .RE
9655
9656 ntp signd socket directory (G)
9657 .PP
9658 .RS 4
9659 This setting controls the location of the socket that the NTP daemon uses to communicate with Samba for signing packets\&.
9660 .sp
9661 If a non\-default path is specified here, then it is also necessary to make NTP aware of the new path using the
9662 \fBntpsigndsocket\fR
9663 directive in
9664 ntp\&.conf\&.
9665 .sp
9666 Default:
9667 \fI\fIntp signd socket directory\fR\fR\fI = \fR\fI/var/lib/samba/ntp_signd\fR\fI \fR
9668 .RE
9669
9670 nt status support (G)
9671 .PP
9672 .RS 4
9673 This boolean parameter controls whether
9674 \fBsmbd\fR(8)
9675 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
9676 \fBno\fR
9677 then Samba offers exactly the same DOS error codes that versions prior to Samba 2\&.2\&.3 reported\&.
9678 .sp
9679 You should not need to ever disable this parameter\&.
9680 .sp
9681 Default:
9682 \fI\fInt status support\fR\fR\fI = \fR\fIyes\fR\fI \fR
9683 .RE
9684
9685 ntvfs handler (S)
9686 .PP
9687 .RS 4
9688 This specifies the NTVFS handlers for this share\&.
9689 .RS
9690 .sp
9691 .RS 4
9692 .ie n \{\
9693 \h'-04'\(bu\h'+03'\c
9694 .\}
9695 .el \{\
9696 .sp -1
9697 .IP \(bu 2.3
9698 .\}
9699 unixuid: Sets up user credentials based on POSIX gid/uid\&.
9700 .RE
9701 .sp
9702 .RS 4
9703 .ie n \{\
9704 \h'-04'\(bu\h'+03'\c
9705 .\}
9706 .el \{\
9707 .sp -1
9708 .IP \(bu 2.3
9709 .\}
9710 cifs: Proxies a remote CIFS FS\&. Mainly useful for testing\&.
9711 .RE
9712 .sp
9713 .RS 4
9714 .ie n \{\
9715 \h'-04'\(bu\h'+03'\c
9716 .\}
9717 .el \{\
9718 .sp -1
9719 .IP \(bu 2.3
9720 .\}
9721 nbench: Filter module that saves data useful to the nbench benchmark suite\&.
9722 .RE
9723 .sp
9724 .RS 4
9725 .ie n \{\
9726 \h'-04'\(bu\h'+03'\c
9727 .\}
9728 .el \{\
9729 .sp -1
9730 .IP \(bu 2.3
9731 .\}
9732 ipc: Allows using SMB for inter process communication\&. Only used for the IPC$ share\&.
9733 .RE
9734 .sp
9735 .RS 4
9736 .ie n \{\
9737 \h'-04'\(bu\h'+03'\c
9738 .\}
9739 .el \{\
9740 .sp -1
9741 .IP \(bu 2.3
9742 .\}
9743 posix: Maps POSIX FS semantics to NT semantics
9744 .RE
9745 .sp
9746 .RS 4
9747 .ie n \{\
9748 \h'-04'\(bu\h'+03'\c
9749 .\}
9750 .el \{\
9751 .sp -1
9752 .IP \(bu 2.3
9753 .\}
9754 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\&.
9755 .RE
9756 .sp
9757 .RE
9758 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\&.
9759 .sp
9760 Default:
9761 \fI\fIntvfs handler\fR\fR\fI = \fR\fIunixuid, default\fR\fI \fR
9762 .RE
9763
9764 null passwords (G)
9765 .PP
9766 .RS 4
9767 Allow or disallow client access to accounts that have null passwords\&.
9768 .sp
9769 See also
9770 \fBsmbpasswd\fR(5)\&.
9771 .sp
9772 Default:
9773 \fI\fInull passwords\fR\fR\fI = \fR\fIno\fR\fI \fR
9774 .RE
9775
9776 obey pam restrictions (G)
9777 .PP
9778 .RS 4
9779 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
9780 \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\&.
9781 .sp
9782 Default:
9783 \fI\fIobey pam restrictions\fR\fR\fI = \fR\fIno\fR\fI \fR
9784 .RE
9785
9786 old password allowed period (G)
9787 .PP
9788 .RS 4
9789 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\&.
9790 .sp
9791 This parameter only applies when
9792 \m[blue]\fBserver role\fR\m[]
9793 is set to Active Directory Domain Controller\&.
9794 .sp
9795 Default:
9796 \fI\fIold password allowed period\fR\fR\fI = \fR\fI60\fR\fI \fR
9797 .RE
9798
9799 oplock break wait time (G)
9800 .PP
9801 .RS 4
9802 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\&.
9803 .if n \{\
9804 .sp
9805 .\}
9806 .RS 4
9807 .it 1 an-trap
9808 .nr an-no-space-flag 1
9809 .nr an-break-flag 1
9810 .br
9811 .ps +1
9812 \fBWarning\fR
9813 .ps -1
9814 .br
9815 DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ AND UNDERSTOOD THE SAMBA OPLOCK CODE\&.
9816 .sp .5v
9817 .RE
9818 Default:
9819 \fI\fIoplock break wait time\fR\fR\fI = \fR\fI0\fR\fI \fR
9820 .RE
9821
9822 oplocks (S)
9823 .PP
9824 .RS 4
9825 This boolean option tells
9826 smbd
9827 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)\&.
9828 .sp
9829 Oplocks may be selectively turned off on certain files with a share\&. See the
9830 \m[blue]\fBveto oplock files\fR\m[]
9831 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
9832 \m[blue]\fBkernel oplocks\fR\m[]
9833 parameter for details\&.
9834 .sp
9835 Default:
9836 \fI\fIoplocks\fR\fR\fI = \fR\fIyes\fR\fI \fR
9837 .RE
9838
9839 os2 driver map (G)
9840 .PP
9841 .RS 4
9842 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:
9843 .sp
9844 <nt driver name> = <os2 driver name>\&.<device name>
9845 .sp
9846 For example, a valid entry using the HP LaserJet 5 printer driver would appear as
9847 HP LaserJet 5L = LASERJET\&.HP LaserJet 5L\&.
9848 .sp
9849 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\&.
9850 .sp
9851 Default:
9852 \fI\fIos2 driver map\fR\fR\fI = \fR\fI\fR\fI \fR
9853 .RE
9854
9855 os level (G)
9856 .PP
9857 .RS 4
9858 This integer value controls what level Samba advertises itself as for browse elections\&. The value of this parameter determines whether
9859 \fBnmbd\fR(8)
9860 has a chance of becoming a local master browser for the
9861 \m[blue]\fBworkgroup\fR\m[]
9862 in the local broadcast area\&.
9863 .sp
9864 \fI Note:\fR
9865 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\&.
9866 \fINote:\fR
9867 The maximum value for this parameter is 255\&. If you use higher values, counting will start at 0!
9868 .sp
9869 Default:
9870 \fI\fIos level\fR\fR\fI = \fR\fI20\fR\fI \fR
9871 .sp
9872 Example:
9873 \fI\fIos level\fR\fR\fI = \fR\fI65\fR\fI \fR
9874 .RE
9875
9876 pam password change (G)
9877 .PP
9878 .RS 4
9879 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
9880 \m[blue]\fBpasswd program\fR\m[]\&. It should be possible to enable this without changing your
9881 \m[blue]\fBpasswd chat\fR\m[]
9882 parameter for most setups\&.
9883 .sp
9884 Default:
9885 \fI\fIpam password change\fR\fR\fI = \fR\fIno\fR\fI \fR
9886 .RE
9887
9888 panic action (G)
9889 .PP
9890 .RS 4
9891 This is a Samba developer option that allows a system command to be called when either
9892 \fBsmbd\fR(8)
9893 or
9894 \fBnmbd\fR(8)
9895 crashes\&. This is usually used to draw attention to the fact that a problem occurred\&.
9896 .sp
9897 Default:
9898 \fI\fIpanic action\fR\fR\fI = \fR\fI\fR\fI \fR
9899 .sp
9900 Example:
9901 \fI\fIpanic action\fR\fR\fI = \fR\fI/bin/sleep 90000\fR\fI \fR
9902 .RE
9903
9904 passdb backend (G)
9905 .PP
9906 .RS 4
9907 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\&.
9908 .sp
9909 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\&.
9910 .sp
9911 Available backends can include:
9912 .RS
9913 .sp
9914 .RS 4
9915 .ie n \{\
9916 \h'-04'\(bu\h'+03'\c
9917 .\}
9918 .el \{\
9919 .sp -1
9920 .IP \(bu 2.3
9921 .\}
9922 smbpasswd
9923 \- 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\&.
9924 .RE
9925 .sp
9926 .RS 4
9927 .ie n \{\
9928 \h'-04'\(bu\h'+03'\c
9929 .\}
9930 .el \{\
9931 .sp -1
9932 .IP \(bu 2.3
9933 .\}
9934 tdbsam
9935 \- The TDB based password storage backend\&. Takes a path to the TDB as an optional argument (defaults to passdb\&.tdb in the
9936 \m[blue]\fBprivate dir\fR\m[]
9937 directory\&.
9938 .RE
9939 .sp
9940 .RS 4
9941 .ie n \{\
9942 \h'-04'\(bu\h'+03'\c
9943 .\}
9944 .el \{\
9945 .sp -1
9946 .IP \(bu 2.3
9947 .\}
9948 ldapsam
9949 \- The LDAP based passdb backend\&. Takes an LDAP URL as an optional argument (defaults to
9950 ldap://localhost)
9951 .sp
9952 LDAP connections should be secured where possible\&. This may be done using either Start\-TLS (see
9953 \m[blue]\fBldap ssl\fR\m[]) or by specifying
9954 \fIldaps://\fR
9955 in the URL argument\&.
9956 .sp
9957 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\&.
9958 .RE
9959 .sp
9960 .RE
9961
9962 Examples of use are:
9963 .sp
9964 .if n \{\
9965 .RS 4
9966 .\}
9967 .nf
9968 passdb backend = tdbsam:/etc/samba/private/passdb\&.tdb
9969
9970 or multi server LDAP URL with OpenLDAP library:
9971
9972 passdb backend = ldapsam:"ldap://ldap\-1\&.example\&.com ldap://ldap\-2\&.example\&.com"
9973
9974 or multi server LDAP URL with Netscape based LDAP library:
9975
9976 passdb backend = ldapsam:"ldap://ldap\-1\&.example\&.com ldap\-2\&.example\&.com"
9977 .fi
9978 .if n \{\
9979 .RE
9980 .\}
9981 .sp
9982 Default:
9983 \fI\fIpassdb backend\fR\fR\fI = \fR\fItdbsam\fR\fI \fR
9984 .RE
9985
9986 passdb expand explicit (G)
9987 .PP
9988 .RS 4
9989 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\&.
9990 .sp
9991 Default:
9992 \fI\fIpassdb expand explicit\fR\fR\fI = \fR\fIno\fR\fI \fR
9993 .RE
9994
9995 passwd chat (G)
9996 .PP
9997 .RS 4
9998 This string controls the
9999 \fI"chat"\fR
10000 conversation that takes places between
10001 \fBsmbd\fR(8)
10002 and the local password changing program to change the user\*(Aqs password\&. The string describes a sequence of response\-receive pairs that
10003 \fBsmbd\fR(8)
10004 uses to determine what to send to the
10005 \m[blue]\fBpasswd program\fR\m[]
10006 and what to expect back\&. If the expected output is not received then the password is not changed\&.
10007 .sp
10008 This chat sequence is often quite site specific, depending on what local methods are used for password control\&.
10009 .sp
10010 Note that this parameter only is used if the
10011 \m[blue]\fBunix password sync\fR\m[]
10012 parameter is set to
10013 \fByes\fR\&. This sequence is then called
10014 \fIAS ROOT\fR
10015 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\&.
10016 .sp
10017 The string can contain the macro
10018 \fI%n\fR
10019 which is substituted for the new password\&. The old password (\fI%o\fR) is only available when
10020 \m[blue]\fBencrypt passwords\fR\m[]
10021 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\&.
10022 .sp
10023 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\&.
10024 .sp
10025 If the
10026 \m[blue]\fBpam password change\fR\m[]
10027 parameter is set to
10028 \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\&.
10029 .sp
10030 Default:
10031 \fI\fIpasswd chat\fR\fR\fI = \fR\fI*new*password* %n\en *new*password* %n\en *changed*\fR\fI \fR
10032 .sp
10033 Example:
10034 \fI\fIpasswd chat\fR\fR\fI = \fR\fI"*Enter NEW password*" %n\en "*Reenter NEW password*" %n\en "*Password changed*"\fR\fI \fR
10035 .RE
10036
10037 passwd chat debug (G)
10038 .PP
10039 .RS 4
10040 This boolean specifies if the passwd chat script parameter is run in
10041 \fIdebug\fR
10042 mode\&. In this mode the strings passed to and received from the passwd chat are printed in the
10043 \fBsmbd\fR(8)
10044 log with a
10045 \m[blue]\fBdebug level\fR\m[]
10046 of 100\&. This is a dangerous option as it will allow plaintext passwords to be seen in the
10047 smbd
10048 log\&. It is available to help Samba admins debug their
10049 \fIpasswd chat\fR
10050 scripts when calling the
10051 \fIpasswd program\fR
10052 and should be turned off after this has been done\&. This option has no effect if the
10053 \m[blue]\fBpam password change\fR\m[]
10054 parameter is set\&. This parameter is off by default\&.
10055 .sp
10056 Default:
10057 \fI\fIpasswd chat debug\fR\fR\fI = \fR\fIno\fR\fI \fR
10058 .RE
10059
10060 passwd chat timeout (G)
10061 .PP
10062 .RS 4
10063 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\&.
10064 .sp
10065 Default:
10066 \fI\fIpasswd chat timeout\fR\fR\fI = \fR\fI2\fR\fI \fR
10067 .RE
10068
10069 passwd program (G)
10070 .PP
10071 .RS 4
10072 The name of a program that can be used to set UNIX user passwords\&. Any occurrences of
10073 \fI%u\fR
10074 will be replaced with the user name\&. The user name is checked for existence before calling the password changing program\&.
10075 .sp
10076 Also note that many passwd programs insist in
10077 \fIreasonable \fR
10078 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\&.
10079 .sp
10080 \fINote\fR
10081 that if the
10082 \fIunix password sync\fR
10083 parameter is set to
10084 \fByes \fR
10085 then this program is called
10086 \fIAS ROOT\fR
10087 before the SMB password in the smbpasswd file is changed\&. If this UNIX password change fails, then
10088 smbd
10089 will fail to change the SMB password also (this is by design)\&.
10090 .sp
10091 If the
10092 \fIunix password sync\fR
10093 parameter is set this parameter
10094 \fIMUST USE ABSOLUTE PATHS\fR
10095 for
10096 \fIALL\fR
10097 programs called, and must be examined for security implications\&. Note that by default
10098 \fIunix password sync\fR
10099 is set to
10100 \fBno\fR\&.
10101 .sp
10102 Default:
10103 \fI\fIpasswd program\fR\fR\fI = \fR\fI\fR\fI \fR
10104 .sp
10105 Example:
10106 \fI\fIpasswd program\fR\fR\fI = \fR\fI/bin/passwd %u\fR\fI \fR
10107 .RE
10108
10109 password hash gpg key ids (G)
10110 .PP
10111 .RS 4
10112 If
10113 samba
10114 is running as an active directory domain controller, it is possible to store the cleartext password of accounts in a PGP/OpenGPG encrypted form\&.
10115 .sp
10116 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\&.
10117 .sp
10118 The value is stored as \*(AqPrimary:SambaGPG\*(Aq in the
10119 supplementalCredentials
10120 attribute\&.
10121 .sp
10122 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\&.
10123 .sp
10124 This option is only available if
10125 samba
10126 was compiled with
10127 gpgme
10128 support\&.
10129 .sp
10130 You may need to export the
10131 GNUPGHOME
10132 environment variable before starting
10133 samba\&.
10134 \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
10135 .sp
10136 Being able to restore the cleartext password helps, when they need to be imported into other authentication systems later (see
10137 samba\-tool user getpassword) or you want to keep the passwords in sync with another system, e\&.g\&. an OpenLDAP server (see
10138 samba\-tool user syncpasswords)\&.
10139 .sp
10140 While this option needs to be configured on all domain controllers, the
10141 samba\-tool user syncpasswords
10142 command should run on a single domain controller only (typically the PDC\-emulator)\&.
10143 .sp
10144 Default:
10145 \fI\fIpassword hash gpg key ids\fR\fR\fI = \fR\fI\fR\fI \fR
10146 .sp
10147 Example:
10148 \fI\fIpassword hash gpg key ids\fR\fR\fI = \fR\fI4952E40301FAB41A\fR\fI \fR
10149 .sp
10150 Example:
10151 \fI\fIpassword hash gpg key ids\fR\fR\fI = \fR\fIselftest@samba\&.example\&.com\fR\fI \fR
10152 .sp
10153 Example:
10154 \fI\fIpassword hash gpg key ids\fR\fR\fI = \fR\fIselftest@samba\&.example\&.com, 4952E40301FAB41A\fR\fI \fR
10155 .RE
10156
10157 password hash userPassword schemes (G)
10158 .PP
10159 .RS 4
10160 This parameter determines whether or not
10161 \fBsamba\fR(8)
10162 acting as an Active Directory Domain Controller will attempt to store additional passwords hash types for the user
10163 .sp
10164 The values are stored as \*(AqPrimary:userPassword\*(Aq in the
10165 supplementalCredentials
10166 attribute\&. The value of this option is a hash type\&.
10167 .sp
10168 The currently supported hash types are:
10169 .RS
10170 .sp
10171 .RS 4
10172 .ie n \{\
10173 \h'-04'\(bu\h'+03'\c
10174 .\}
10175 .el \{\
10176 .sp -1
10177 .IP \(bu 2.3
10178 .\}
10179 \fBCryptSHA256\fR
10180 .RE
10181 .sp
10182 .RS 4
10183 .ie n \{\
10184 \h'-04'\(bu\h'+03'\c
10185 .\}
10186 .el \{\
10187 .sp -1
10188 .IP \(bu 2.3
10189 .\}
10190 \fBCryptSHA512\fR
10191 .RE
10192 .sp
10193 .RE
10194 Multiple instances of a hash type may be computed and stored\&. The password hashes are calculated using the
10195 \fBcrypt\fR(3)
10196 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
10197 \fBcrypt\fR(3)
10198 are used\&.
10199 .sp
10200 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\&.
10201 .sp
10202 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
10203 samba\-tool user
10204 will ignore the stored hash values\&.
10205 .sp
10206 Being able to obtain the hashed password helps, when they need to be imported into other authentication systems later (see
10207 samba\-tool user getpassword) or you want to keep the passwords in sync with another system, e\&.g\&. an OpenLDAP server (see
10208 samba\-tool user syncpasswords)\&.
10209 .sp
10210 Related command:
10211 \m[blue]\fBunix password sync\fR\m[]
10212 .sp
10213 Default:
10214 \fI\fIpassword hash userPassword schemes\fR\fR\fI = \fR\fI\fR\fI \fR
10215 .sp
10216 Example:
10217 \fI\fIpassword hash userPassword schemes\fR\fR\fI = \fR\fICryptSHA256\fR\fI \fR
10218 .sp
10219 Example:
10220 \fI\fIpassword hash userPassword schemes\fR\fR\fI = \fR\fICryptSHA256 CryptSHA512\fR\fI \fR
10221 .sp
10222 Example:
10223 \fI\fIpassword hash userPassword schemes\fR\fR\fI = \fR\fICryptSHA256:rounds=5000 CryptSHA512:rounds=7000\fR\fI \fR
10224 .RE
10225
10226 password server (G)
10227 .PP
10228 .RS 4
10229 By specifying the name of a domain controller with this option, and using
10230 security = [ads|domain]
10231 it is possible to get Samba to do all its username/password validation using a specific remote server\&.
10232 .sp
10233 Ideally, this option
10234 \fIshould not\fR
10235 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\&.
10236 .sp
10237 \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
10238 \fIpassword server\fR
10239 option then
10240 smbd
10241 will try each in turn till it finds one that responds\&. This is useful in case your primary server goes down\&.
10242 .sp
10243 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\&.
10244 .sp
10245 If parameter is a name, it is looked up using the parameter
10246 \m[blue]\fBname resolve order\fR\m[]
10247 and so may resolved by any method and order described in that parameter\&.
10248 .sp
10249 Default:
10250 \fI\fIpassword server\fR\fR\fI = \fR\fI*\fR\fI \fR
10251 .sp
10252 Example:
10253 \fI\fIpassword server\fR\fR\fI = \fR\fINT\-PDC, NT\-BDC1, NT\-BDC2, *\fR\fI \fR
10254 .sp
10255 Example:
10256 \fI\fIpassword server\fR\fR\fI = \fR\fIwindc\&.mydomain\&.com:389 192\&.168\&.1\&.101 *\fR\fI \fR
10257 .RE
10258
10259 directory
10260 .PP
10261 .RS 4
10262 This parameter is a synonym for
10263 path\&.
10264 .RE
10265
10266 path (S)
10267 .PP
10268 .RS 4
10269 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\&.
10270 .sp
10271 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\&.
10272 .sp
10273 Any occurrences of
10274 \fI%u\fR
10275 in the path will be replaced with the UNIX username that the client is using on this connection\&. Any occurrences of
10276 \fI%m\fR
10277 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\&.
10278 .sp
10279 Note that this path will be based on
10280 \m[blue]\fBroot dir\fR\m[]
10281 if one was specified\&.
10282 .sp
10283 Default:
10284 \fI\fIpath\fR\fR\fI = \fR\fI\fR\fI \fR
10285 .sp
10286 Example:
10287 \fI\fIpath\fR\fR\fI = \fR\fI/home/fred\fR\fI \fR
10288 .RE
10289
10290 perfcount module (G)
10291 .PP
10292 .RS 4
10293 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\&.
10294 .sp
10295 \fINo default\fR
10296 .RE
10297
10298 pid directory (G)
10299 .PP
10300 .RS 4
10301 This option specifies the directory where pid files will be placed\&.
10302 .sp
10303 Default:
10304 \fI\fIpid directory\fR\fR\fI = \fR\fI/run\fR\fI \fR
10305 .sp
10306 Example:
10307 \fI\fIpid directory\fR\fR\fI = \fR\fI/var/run/\fR\fI \fR
10308 .RE
10309
10310 posix locking (S)
10311 .PP
10312 .RS 4
10313 The
10314 \fBsmbd\fR(8)
10315 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\&.
10316 .sp
10317 Default:
10318 \fI\fIposix locking\fR\fR\fI = \fR\fIyes\fR\fI \fR
10319 .RE
10320
10321 postexec (S)
10322 .PP
10323 .RS 4
10324 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\&.
10325 .sp
10326 An interesting example may be to unmount server resources:
10327 .sp
10328 postexec = /etc/umount /cdrom
10329 .sp
10330 Default:
10331 \fI\fIpostexec\fR\fR\fI = \fR\fI\fR\fI \fR
10332 .sp
10333 Example:
10334 \fI\fIpostexec\fR\fR\fI = \fR\fIecho \e"%u disconnected from %S from %m (%I)\e" >> /tmp/log\fR\fI \fR
10335 .RE
10336
10337 exec
10338 .PP
10339 .RS 4
10340 This parameter is a synonym for
10341 preexec\&.
10342 .RE
10343
10344 preexec (S)
10345 .PP
10346 .RS 4
10347 This option specifies a command to be run whenever the service is connected to\&. It takes the usual substitutions\&.
10348 .sp
10349 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:
10350 .sp
10351 preexec = csh \-c \*(Aqecho \e"Welcome to %S!\e" | /usr/local/samba/bin/smbclient \-M %m \-I %I\*(Aq &
10352 .sp
10353 Of course, this could get annoying after a while :\-)
10354 .sp
10355 See also
10356 \m[blue]\fBpreexec close\fR\m[]
10357 and
10358 \m[blue]\fBpostexec\fR\m[]\&.
10359 .sp
10360 Default:
10361 \fI\fIpreexec\fR\fR\fI = \fR\fI\fR\fI \fR
10362 .sp
10363 Example:
10364 \fI\fIpreexec\fR\fR\fI = \fR\fIecho \e"%u connected to %S from %m (%I)\e" >> /tmp/log\fR\fI \fR
10365 .RE
10366
10367 preexec close (S)
10368 .PP
10369 .RS 4
10370 This boolean option controls whether a non\-zero return code from
10371 \m[blue]\fBpreexec\fR\m[]
10372 should close the service being connected to\&.
10373 .sp
10374 Default:
10375 \fI\fIpreexec close\fR\fR\fI = \fR\fIno\fR\fI \fR
10376 .RE
10377
10378 prefered master
10379 .PP
10380 .RS 4
10381 This parameter is a synonym for
10382 preferred master\&.
10383 .RE
10384
10385 preferred master (G)
10386 .PP
10387 .RS 4
10388 This boolean parameter controls if
10389 \fBnmbd\fR(8)
10390 is a preferred master browser for its workgroup\&.
10391 .sp
10392 If this is set to
10393 \fByes\fR, on startup,
10394 nmbd
10395 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
10396 \m[blue]\fBdomain master = yes\fR\m[], so that
10397 nmbd
10398 can guarantee becoming a domain master\&.
10399 .sp
10400 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\&.
10401 .sp
10402 Default:
10403 \fI\fIpreferred master\fR\fR\fI = \fR\fIauto\fR\fI \fR
10404 .RE
10405
10406 prefork backoff increment (G)
10407 .PP
10408 .RS 4
10409 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"\&.
10410 .sp
10411 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\&.
10412 .sp
10413 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
10414 .sp
10415 Default:
10416 \fI\fIprefork backoff increment\fR\fR\fI = \fR\fI10\fR\fI \fR
10417 .RE
10418
10419 prefork children (G)
10420 .PP
10421 .RS 4
10422 This option controls the number of worker processes that are started for each service when prefork process model is enabled (see
10423 \fBsamba\fR(8)
10424 \-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\&.
10425 .sp
10426 This should be set to a small multiple of the number of CPU\*(Aqs available on the server
10427 .sp
10428 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\&.
10429 .sp
10430 Default:
10431 \fI\fIprefork children\fR\fR\fI = \fR\fI4\fR\fI \fR
10432 .RE
10433
10434 prefork maximum backoff (G)
10435 .PP
10436 .RS 4
10437 This option controls the maximum delay before a failed pre\-fork process is restarted\&.
10438 .sp
10439 Default:
10440 \fI\fIprefork maximum backoff\fR\fR\fI = \fR\fI120\fR\fI \fR
10441 .RE
10442
10443 preload modules (G)
10444 .PP
10445 .RS 4
10446 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\&.
10447 .sp
10448 Default:
10449 \fI\fIpreload modules\fR\fR\fI = \fR\fI\fR\fI \fR
10450 .sp
10451 Example:
10452 \fI\fIpreload modules\fR\fR\fI = \fR\fI/usr/lib/samba/passdb/mysql\&.so\fR\fI \fR
10453 .RE
10454
10455 preserve case (S)
10456 .PP
10457 .RS 4
10458 This controls if new filenames are created with the case that the client passes, or if they are forced to be the
10459 \m[blue]\fBdefault case\fR\m[]\&.
10460 .sp
10461 See the section on
10462 NAME MANGLING
10463 for a fuller discussion\&.
10464 .sp
10465 Default:
10466 \fI\fIpreserve case\fR\fR\fI = \fR\fIyes\fR\fI \fR
10467 .RE
10468
10469 print ok
10470 .PP
10471 .RS 4
10472 This parameter is a synonym for
10473 printable\&.
10474 .RE
10475
10476 printable (S)
10477 .PP
10478 .RS 4
10479 If this parameter is
10480 \fByes\fR, then clients may open, write to and submit spool files on the directory specified for the service\&.
10481 .sp
10482 Note that a printable service will ALWAYS allow writing to the service path (user privileges permitting) via the spooling of print data\&. The
10483 \m[blue]\fBread only\fR\m[]
10484 parameter controls only non\-printing access to the resource\&.
10485 .sp
10486 Default:
10487 \fI\fIprintable\fR\fR\fI = \fR\fIno\fR\fI \fR
10488 .RE
10489
10490 printcap cache time (G)
10491 .PP
10492 .RS 4
10493 This option specifies the number of seconds before the printing subsystem is again asked for the known printers\&.
10494 .sp
10495 Setting this parameter to 0 disables any rescanning for new or removed printers after the initial startup\&.
10496 .sp
10497 Default:
10498 \fI\fIprintcap cache time\fR\fR\fI = \fR\fI750\fR\fI \fR
10499 .sp
10500 Example:
10501 \fI\fIprintcap cache time\fR\fR\fI = \fR\fI600\fR\fI \fR
10502 .RE
10503
10504 printcap
10505 .PP
10506 .RS 4
10507 This parameter is a synonym for
10508 printcap name\&.
10509 .RE
10510
10511 printcap name (G)
10512 .PP
10513 .RS 4
10514 This parameter may be used to override the compiled\-in default printcap name used by the server (usually
10515 /etc/printcap)\&. See the discussion of the
10516 [printers]
10517 section above for reasons why you might want to do this\&.
10518 .sp
10519 To use the CUPS printing interface set
10520 printcap name = cups\&. This should be supplemented by an additional setting
10521 \m[blue]\fBprinting = cups\fR\m[]
10522 in the [global] section\&.
10523 printcap name = cups
10524 will use the "dummy" printcap created by CUPS, as specified in your CUPS configuration file\&.
10525 .sp
10526 On System V systems that use
10527 lpstat
10528 to list available printers you can use
10529 printcap name = lpstat
10530 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
10531 \fI printcap name\fR
10532 is set to
10533 lpstat
10534 on these systems then Samba will launch
10535 lpstat \-v
10536 and attempt to parse the output to obtain a printer list\&.
10537 .sp
10538 A minimal printcap file would look something like this:
10539 .sp
10540 .if n \{\
10541 .RS 4
10542 .\}
10543 .nf
10544 print1|My Printer 1
10545 print2|My Printer 2
10546 print3|My Printer 3
10547 print4|My Printer 4
10548 print5|My Printer 5
10549 .fi
10550 .if n \{\
10551 .RE
10552 .\}
10553 .sp
10554 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\&.
10555 .if n \{\
10556 .sp
10557 .\}
10558 .RS 4
10559 .it 1 an-trap
10560 .nr an-no-space-flag 1
10561 .nr an-break-flag 1
10562 .br
10563 .ps +1
10564 \fBNote\fR
10565 .ps -1
10566 .br
10567 Under AIX the default printcap name is
10568 /etc/qconfig\&. Samba will assume the file is in AIX
10569 qconfig
10570 format if the string
10571 qconfig
10572 appears in the printcap filename\&.
10573 .sp .5v
10574 .RE
10575 Default:
10576 \fI\fIprintcap name\fR\fR\fI = \fR\fI/etc/printcap\fR\fI \fR
10577 .sp
10578 Example:
10579 \fI\fIprintcap name\fR\fR\fI = \fR\fI/etc/myprintcap\fR\fI \fR
10580 .RE
10581
10582 print command (S)
10583 .PP
10584 .RS 4
10585 After a print job has finished spooling to a service, this command will be used via a
10586 system()
10587 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\&.
10588 .sp
10589 The print command is simply a text string\&. It will be used verbatim after macro substitutions have been made:
10590 .sp
10591 %s, %f \- the path to the spool file name
10592 .sp
10593 %p \- the appropriate printer name
10594 .sp
10595 %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\&.
10596 .sp
10597 %c \- The number of printed pages of the spooled job (if known)\&.
10598 .sp
10599 %z \- the size of the spooled print job (in bytes)
10600 .sp
10601 The print command
10602 \fIMUST\fR
10603 contain at least one occurrence of
10604 \fI%s\fR
10605 or
10606 \fI%f \fR
10607 \- the
10608 \fI%p\fR
10609 is optional\&. At the time a job is submitted, if no printer name is supplied the
10610 \fI%p \fR
10611 will be silently removed from the printer command\&.
10612 .sp
10613 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\&.
10614 .sp
10615 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\&.
10616 .sp
10617 Note that printing may fail on some UNIXes from the
10618 \fBnobody\fR
10619 account\&. If this happens then create an alternative guest account that can print and set the
10620 \m[blue]\fBguest account\fR\m[]
10621 in the [global] section\&.
10622 .sp
10623 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\&.
10624 .sp
10625 print command = echo Printing %s >> /tmp/print\&.log; lpr \-P %p %s; rm %s
10626 .sp
10627 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
10628 \m[blue]\fBprinting\fR\m[]
10629 parameter\&.
10630 .sp
10631 Default: For
10632 printing = BSD, AIX, QNX, LPRNG or PLP :
10633 .sp
10634 print command = lpr \-r \-P%p %s
10635 .sp
10636 For
10637 printing = SYSV or HPUX :
10638 .sp
10639 print command = lp \-c \-d%p %s; rm %s
10640 .sp
10641 For
10642 printing = SOFTQ :
10643 .sp
10644 print command = lp \-d%p \-s %s; rm %s
10645 .sp
10646 For printing = CUPS : If SAMBA is compiled against libcups, then
10647 \m[blue]\fBprintcap = cups\fR\m[]
10648 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
10649 lp \-c \-d%p \-oraw; rm %s\&. With
10650 printing = cups, and if SAMBA is compiled against libcups, any manually set print command will be ignored\&.
10651 .sp
10652 \fINo default\fR
10653 .sp
10654 Example:
10655 \fI\fIprint command\fR\fR\fI = \fR\fI/usr/local/samba/bin/myprintscript %p %s\fR\fI \fR
10656 .RE
10657
10658 printer
10659 .PP
10660 .RS 4
10661 This parameter is a synonym for
10662 printer name\&.
10663 .RE
10664
10665 printer name (S)
10666 .PP
10667 .RS 4
10668 This parameter specifies the name of the printer to which print jobs spooled through a printable service will be sent\&.
10669 .sp
10670 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\&.
10671 .sp
10672 The default value of the
10673 \m[blue]\fBprinter name\fR\m[]
10674 may be
10675 lp
10676 on many systems\&.
10677 .sp
10678 Default:
10679 \fI\fIprinter name\fR\fR\fI = \fR\fI\fR\fI \fR
10680 .sp
10681 Example:
10682 \fI\fIprinter name\fR\fR\fI = \fR\fIlaserwriter\fR\fI \fR
10683 .RE
10684
10685 printing (S)
10686 .PP
10687 .RS 4
10688 This parameters controls how printer status information is interpreted on your system\&. It also affects the default values for the
10689 \fIprint command\fR,
10690 \fIlpq command\fR,
10691 \fIlppause command \fR,
10692 \fIlpresume command\fR, and
10693 \fIlprm command\fR
10694 if specified in the [global] section\&.
10695 .sp
10696 Currently nine printing styles are supported\&. They are
10697 \fBBSD\fR,
10698 \fBAIX\fR,
10699 \fBLPRNG\fR,
10700 \fBPLP\fR,
10701 \fBSYSV\fR,
10702 \fBHPUX\fR,
10703 \fBQNX\fR,
10704 \fBSOFTQ\fR,
10705 \fBCUPS\fR
10706 and
10707 \fBIPRINT\fR\&.
10708 .sp
10709 Be aware that CUPS and IPRINT are only available if the CUPS development library was available at the time Samba was compiled or packaged\&.
10710 .sp
10711 To see what the defaults are for the other print commands when using the various options use the
10712 \fBtestparm\fR(1)
10713 program\&.
10714 .sp
10715 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
10716 \fIprinting\fR
10717 option since it will reset the printing commands to default values\&.
10718 .sp
10719 See also the discussion in the
10720 [printers]
10721 section\&.
10722 .sp
10723 See
10724 testparm \-v\&.
10725 for the default value on your system
10726 .sp
10727 Default:
10728 \fI\fIprinting\fR\fR\fI = \fR\fI # Depends on the operating system\fR\fI \fR
10729 .RE
10730
10731 printjob username (S)
10732 .PP
10733 .RS 4
10734 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\&.
10735 .sp
10736 Default:
10737 \fI\fIprintjob username\fR\fR\fI = \fR\fI%U\fR\fI \fR
10738 .sp
10739 Example:
10740 \fI\fIprintjob username\fR\fR\fI = \fR\fI%D\e%U\fR\fI \fR
10741 .RE
10742
10743 print notify backchannel (S)
10744 .PP
10745 .RS 4
10746 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\&.
10747 .sp
10748 Default:
10749 \fI\fIprint notify backchannel\fR\fR\fI = \fR\fIno\fR\fI \fR
10750 .RE
10751
10752 private directory
10753 .PP
10754 .RS 4
10755 This parameter is a synonym for
10756 private dir\&.
10757 .RE
10758
10759 private dir (G)
10760 .PP
10761 .RS 4
10762 This parameters defines the directory smbd will use for storing such files as
10763 smbpasswd
10764 and
10765 secrets\&.tdb\&.
10766 .sp
10767 Default:
10768 \fI\fIprivate dir\fR\fR\fI = \fR\fI/var/lib/samba/private\fR\fI \fR
10769 .RE
10770
10771 queuepause command (S)
10772 .PP
10773 .RS 4
10774 This parameter specifies the command to be executed on the server host in order to pause the printer queue\&.
10775 .sp
10776 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\&.
10777 .sp
10778 This command is not supported by Windows for Workgroups, but can be issued from the Printers window under Windows 95 and NT\&.
10779 .sp
10780 If a
10781 \fI%p\fR
10782 is given then the printer name is put in its place\&. Otherwise it is placed at the end of the command\&.
10783 .sp
10784 Note that it is good practice to include the absolute path in the command as the PATH may not be available to the server\&.
10785 .sp
10786 Default:
10787 \fI\fIqueuepause command\fR\fR\fI = \fR\fI # determined by printing parameter\fR\fI \fR
10788 .sp
10789 Example:
10790 \fI\fIqueuepause command\fR\fR\fI = \fR\fIdisable %p\fR\fI \fR
10791 .RE
10792
10793 queueresume command (S)
10794 .PP
10795 .RS 4
10796 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[])\&.
10797 .sp
10798 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\&.
10799 .sp
10800 This command is not supported by Windows for Workgroups, but can be issued from the Printers window under Windows 95 and NT\&.
10801 .sp
10802 If a
10803 \fI%p\fR
10804 is given then the printer name is put in its place\&. Otherwise it is placed at the end of the command\&.
10805 .sp
10806 Note that it is good practice to include the absolute path in the command as the PATH may not be available to the server\&.
10807 .sp
10808 Default:
10809 \fI\fIqueueresume command\fR\fR\fI = \fR\fI # determined by printing parameter\fR\fI \fR
10810 .sp
10811 Example:
10812 \fI\fIqueueresume command\fR\fR\fI = \fR\fIenable %p\fR\fI \fR
10813 .RE
10814
10815 raw NTLMv2 auth (G)
10816 .PP
10817 .RS 4
10818 This parameter has been deprecated since Samba 4\&.13 and support for NTLMv2 authentication without NTLMSSP will be removed in a future Samba release\&.
10819 .sp
10820 That is, in the future, the current default of
10821 raw NTLMv2 auth = no
10822 will be the enforced behaviour\&.
10823 .sp
10824 This parameter determines whether or not
10825 \fBsmbd\fR(8)
10826 will allow SMB1 clients without extended security (without SPNEGO) to use NTLMv2 authentication\&.
10827 .sp
10828 If this option,
10829 lanman auth
10830 and
10831 ntlm auth
10832 are all disabled, then only clients with SPNEGO support will be permitted\&. That means NTLMv2 is only supported within NTLMSSP\&.
10833 .sp
10834 Default:
10835 \fI\fIraw NTLMv2 auth\fR\fR\fI = \fR\fIno\fR\fI \fR
10836 .RE
10837
10838 read list (S)
10839 .PP
10840 .RS 4
10841 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
10842 \m[blue]\fBread only\fR\m[]
10843 option is set to\&. The list can include group names using the syntax described in the
10844 \m[blue]\fBinvalid users\fR\m[]
10845 parameter\&.
10846 .sp
10847 Default:
10848 \fI\fIread list\fR\fR\fI = \fR\fI\fR\fI \fR
10849 .sp
10850 Example:
10851 \fI\fIread list\fR\fR\fI = \fR\fImary, @students\fR\fI \fR
10852 .RE
10853
10854 read only (S)
10855 .PP
10856 .RS 4
10857 An inverted synonym is
10858 \m[blue]\fBwriteable\fR\m[]\&.
10859 .sp
10860 If this parameter is
10861 \fByes\fR, then users of a service may not create or modify files in the service\*(Aqs directory\&.
10862 .sp
10863 Note that a printable service (printable = yes) will
10864 \fIALWAYS\fR
10865 allow writing to the directory (user privileges permitting), but only via spooling operations\&.
10866 .sp
10867 Default:
10868 \fI\fIread only\fR\fR\fI = \fR\fIyes\fR\fI \fR
10869 .RE
10870
10871 read raw (G)
10872 .PP
10873 .RS 4
10874 This is ignored if
10875 \m[blue]\fBasync smb echo handler\fR\m[]
10876 is set, because this feature is incompatible with raw read SMB requests
10877 .sp
10878 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\&.
10879 .sp
10880 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\&.
10881 .sp
10882 In general this parameter should be viewed as a system tuning tool and left severely alone\&.
10883 .sp
10884 Default:
10885 \fI\fIread raw\fR\fR\fI = \fR\fIyes\fR\fI \fR
10886 .RE
10887
10888 realm (G)
10889 .PP
10890 .RS 4
10891 This option specifies the kerberos realm to use\&. The realm is used as the ADS equivalent of the NT4
10892 domain\&. It is usually set to the DNS name of the kerberos server\&.
10893 .sp
10894 Default:
10895 \fI\fIrealm\fR\fR\fI = \fR\fI\fR\fI \fR
10896 .sp
10897 Example:
10898 \fI\fIrealm\fR\fR\fI = \fR\fImysambabox\&.mycompany\&.com\fR\fI \fR
10899 .RE
10900
10901 registry shares (G)
10902 .PP
10903 .RS 4
10904 This turns on or off support for share definitions read from registry\&. Shares defined in
10905 \fIsmb\&.conf\fR
10906 take precedence over shares with the same name defined in registry\&. See the section on registry\-based configuration for details\&.
10907 .sp
10908 Note that this parameter defaults to
10909 \fIno\fR, but it is set to
10910 \fIyes\fR
10911 when
10912 \fIconfig backend\fR
10913 is set to
10914 \fIregistry\fR\&.
10915 .sp
10916 Default:
10917 \fI\fIregistry shares\fR\fR\fI = \fR\fIno\fR\fI \fR
10918 .sp
10919 Example:
10920 \fI\fIregistry shares\fR\fR\fI = \fR\fIyes\fR\fI \fR
10921 .RE
10922
10923 reject aes netlogon servers (G)
10924 .PP
10925 .RS 4
10926 This option controls whether winbindd requires support for ServerAuthenticateKerberos support for the netlogon secure channel\&.
10927 .sp
10928 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\&.
10929 .sp
10930 The following flags will be required: NETLOGON_NEG_PASSWORD_SET2, NETLOGON_NEG_SUPPORTS_KERBEROS_AUTH and NETLOGON_NEG_AUTHENTICATED_RPC\&.
10931 .sp
10932 You can set this to yes if all domain controllers support ServerAuthenticateKerberos\&. This will prevent downgrade attacks\&.
10933 .sp
10934 The behavior can be controlled per netbios domain by using \*(Aqreject aes netlogon servers:NETBIOSDOMAIN = no\*(Aq as option\&.
10935 .sp
10936 This option overrides the
10937 \m[blue]\fBreject md5 servers\fR\m[]
10938 option\&.
10939 .sp
10940 This option overrides the
10941 \m[blue]\fBclient use krb5 netlogon\fR\m[]
10942 option (if it is effectively off)\&.
10943 .sp
10944 Default:
10945 \fI\fIreject aes netlogon servers\fR\fR\fI = \fR\fIno\fR\fI \fR
10946 .RE
10947
10948 reject md5 clients (G)
10949 .PP
10950 .RS 4
10951 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)\&.
10952 .sp
10953 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\&.
10954 .sp
10955 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
10956 https://www\&.samba\&.org/samba/security/CVE\-2022\-38023\&.html
10957 for more details\&.
10958 .sp
10959 The default changed from \*(Aqno\*(Aq to \*(Aqyes\*(Aq, with the patches for
10960 CVE\-2022\-38023
10961 see
10962 https://bugzilla\&.samba\&.org/show_bug\&.cgi?id=15240\&.
10963 .sp
10964 \fIAvoid using this option!\fR
10965 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
10966 CVE\-2022\-38023
10967 see
10968 https://bugzilla\&.samba\&.org/show_bug\&.cgi?id=15240\&.
10969 .sp
10970 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)\&.
10971 .sp
10972 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\&.
10973 .sp
10974 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\&.
10975 .sp
10976 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\&.
10977 .sp
10978 Default:
10979 \fI\fIreject md5 clients\fR\fR\fI = \fR\fIyes\fR\fI \fR
10980 .RE
10981
10982 server reject md5 schannel:COMPUTERACCOUNT (G)
10983 .PP
10984 .RS 4
10985 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)\&.
10986 .sp
10987 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)\&.
10988 .sp
10989 Samba will log a warning in the log files at log level 5 if a setting is still needed for the specified computer account\&.
10990 .sp
10991 See
10992 CVE\-2022\-38023,
10993 https://bugzilla\&.samba\&.org/show_bug\&.cgi?id=15240\&.
10994 .sp
10995 This option overrides the
10996 \m[blue]\fBreject md5 clients\fR\m[]
10997 option\&.
10998 .sp
10999 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\&.
11000 .sp
11001 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\&.
11002 .sp
11003 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\&.
11004 .sp
11005 .if n \{\
11006 .RS 4
11007 .\}
11008 .nf
11009 server reject md5 schannel:LEGACYCOMPUTER1$ = no
11010 server reject aes schannel:LEGACYCOMPUTER1$ = no
11011 server reject md5 schannel:NASBOX$ = no
11012 server reject aes schannel:NASBOX$ = no
11013 server reject md5 schannel:LEGACYCOMPUTER2$ = no
11014 server reject aes schannel:LEGACYCOMPUTER2$ = no
11015
11016 .fi
11017 .if n \{\
11018 .RE
11019 .\}
11020 .sp
11021 \fINo default\fR
11022 .RE
11023
11024 reject md5 servers (G)
11025 .PP
11026 .RS 4
11027 This option controls whether winbindd requires support for aes support for the netlogon secure channel\&.
11028 .sp
11029 The following flags will be required NETLOGON_NEG_ARCFOUR, NETLOGON_NEG_SUPPORTS_AES, NETLOGON_NEG_PASSWORD_SET2 and NETLOGON_NEG_AUTHENTICATED_RPC\&.
11030 .sp
11031 You can set this to yes if all domain controllers support aes\&. This will prevent downgrade attacks\&.
11032 .sp
11033 The behavior can be controlled per netbios domain by using \*(Aqreject md5 servers:NETBIOSDOMAIN = no\*(Aq as option\&.
11034 .sp
11035 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
11036 .sp
11037 This option is over\-ridden by the
11038 \m[blue]\fBreject aes netlogon servers\fR\m[]
11039 option\&.
11040 .sp
11041 This option overrides the
11042 \m[blue]\fBrequire strong key\fR\m[]
11043 option\&.
11044 .sp
11045 Default:
11046 \fI\fIreject md5 servers\fR\fR\fI = \fR\fIyes\fR\fI \fR
11047 .RE
11048
11049 remote announce (G)
11050 .PP
11051 .RS 4
11052 This option allows you to setup
11053 \fBnmbd\fR(8)
11054 to periodically announce itself to arbitrary IP addresses with an arbitrary workgroup name\&.
11055 .sp
11056 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\&.
11057 .sp
11058 For example:
11059 .sp
11060 .if n \{\
11061 .RS 4
11062 .\}
11063 .nf
11064 remote announce = 192\&.168\&.2\&.255/SERVERS 192\&.168\&.4\&.255/STAFF
11065 .fi
11066 .if n \{\
11067 .RE
11068 .\}
11069 .sp
11070 the above line would cause
11071 nmbd
11072 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
11073 \m[blue]\fBworkgroup\fR\m[]
11074 parameter is used instead\&.
11075 .sp
11076 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\&.
11077 .sp
11078 See the chapter on Network Browsing in the Samba\-HOWTO book\&.
11079 .sp
11080 Default:
11081 \fI\fIremote announce\fR\fR\fI = \fR\fI\fR\fI \fR
11082 .RE
11083
11084 remote browse sync (G)
11085 .PP
11086 .RS 4
11087 This option allows you to setup
11088 \fBnmbd\fR(8)
11089 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\&.
11090 .sp
11091 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\&.
11092 .sp
11093 For example:
11094 .sp
11095 .if n \{\
11096 .RS 4
11097 .\}
11098 .nf
11099 \fIremote browse sync = 192\&.168\&.2\&.255 192\&.168\&.4\&.255\fR
11100 .fi
11101 .if n \{\
11102 .RE
11103 .\}
11104 .sp
11105 the above line would cause
11106 nmbd
11107 to request the master browser on the specified subnets or addresses to synchronize their browse lists with the local server\&.
11108 .sp
11109 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\&.
11110 .sp
11111 The
11112 \m[blue]\fBremote browse sync\fR\m[]
11113 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\&.
11114 .sp
11115 Default:
11116 \fI\fIremote browse sync\fR\fR\fI = \fR\fI\fR\fI \fR
11117 .RE
11118
11119 rename user script (G)
11120 .PP
11121 .RS 4
11122 This is the full pathname to a script that will be run as root by
11123 \fBsmbd\fR(8)
11124 under special circumstances described below\&.
11125 .sp
11126 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,
11127 %uold
11128 and
11129 %unew, will be substituted with the old and new usernames, respectively\&. The script should return 0 upon successful completion, and nonzero otherwise\&.
11130 .if n \{\
11131 .sp
11132 .\}
11133 .RS 4
11134 .it 1 an-trap
11135 .nr an-no-space-flag 1
11136 .nr an-break-flag 1
11137 .br
11138 .ps +1
11139 \fBNote\fR
11140 .ps -1
11141 .br
11142 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\&.
11143 .sp .5v
11144 .RE
11145 Default:
11146 \fI\fIrename user script\fR\fR\fI = \fR\fI\fR\fI \fR
11147 .RE
11148
11149 require strong key (G)
11150 .PP
11151 .RS 4
11152 This option controls whether winbindd requires support for md5 strong key support for the netlogon secure channel\&.
11153 .sp
11154 The following flags will be required NETLOGON_NEG_STRONG_KEYS, NETLOGON_NEG_ARCFOUR and NETLOGON_NEG_AUTHENTICATED_RPC\&.
11155 .sp
11156 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\&.
11157 .sp
11158 The behavior can be controlled per netbios domain by using \*(Aqrequire strong key:NETBIOSDOMAIN = no\*(Aq as option\&.
11159 .sp
11160 Note for active directory domain this option is hardcoded to \*(Aqyes\*(Aq
11161 .sp
11162 This option is over\-ridden by the
11163 \m[blue]\fBreject md5 servers\fR\m[]
11164 option\&.
11165 .sp
11166 This option overrides the
11167 \m[blue]\fBclient schannel\fR\m[]
11168 option\&.
11169 .sp
11170 Default:
11171 \fI\fIrequire strong key\fR\fR\fI = \fR\fIyes\fR\fI \fR
11172 .RE
11173
11174 reset on zero vc (G)
11175 .PP
11176 .RS 4
11177 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\&.
11178 .sp
11179 Default:
11180 \fI\fIreset on zero vc\fR\fR\fI = \fR\fIno\fR\fI \fR
11181 .RE
11182
11183 restrict anonymous (G)
11184 .PP
11185 .RS 4
11186 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:
11187 .sp
11188 .if n \{\
11189 .RS 4
11190 .\}
11191 .nf
11192 HKEY_LOCAL_MACHINE\eSYSTEM\eCurrentControlSet\eControl\eLsa\eRestrictAnonymous
11193
11194 .fi
11195 .if n \{\
11196 .RE
11197 .\}
11198 .sp
11199 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\&.
11200 .sp
11201 Setting
11202 \m[blue]\fBrestrict anonymous = 1\fR\m[]
11203 will disable anonymous SAMR access\&.
11204 .sp
11205 Setting
11206 \m[blue]\fBrestrict anonymous = 2\fR\m[]
11207 will, in addition to restricting SAMR access, disallow anonymous connections to the IPC$ share in general\&. Setting
11208 \m[blue]\fBguest ok = yes\fR\m[]
11209 on any share will remove the security advantage\&.
11210 .sp
11211 Default:
11212 \fI\fIrestrict anonymous\fR\fR\fI = \fR\fI0\fR\fI \fR
11213 .RE
11214
11215 root
11216 .PP
11217 .RS 4
11218 This parameter is a synonym for
11219 root directory\&.
11220 .RE
11221
11222 root dir
11223 .PP
11224 .RS 4
11225 This parameter is a synonym for
11226 root directory\&.
11227 .RE
11228
11229 root directory (G)
11230 .PP
11231 .RS 4
11232 The server will
11233 chroot()
11234 (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
11235 \m[blue]\fBwide links\fR\m[]
11236 parameter)\&.
11237 .sp
11238 Adding a
11239 \fIroot directory\fR
11240 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
11241 \fIroot directory\fR
11242 option,
11243 \fIincluding\fR
11244 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
11245 \fIroot directory\fR
11246 tree\&. In particular you will need to mirror
11247 /etc/passwd
11248 (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\&.
11249 .sp
11250 Default:
11251 \fI\fIroot directory\fR\fR\fI = \fR\fI\fR\fI \fR
11252 .sp
11253 Example:
11254 \fI\fIroot directory\fR\fR\fI = \fR\fI/homes/smb\fR\fI \fR
11255 .RE
11256
11257 root postexec (S)
11258 .PP
11259 .RS 4
11260 This is the same as the
11261 \fIpostexec\fR
11262 parameter except that the command is run as root\&. This is useful for unmounting filesystems (such as CDROMs) after a connection is closed\&.
11263 .sp
11264 Default:
11265 \fI\fIroot postexec\fR\fR\fI = \fR\fI\fR\fI \fR
11266 .RE
11267
11268 root preexec (S)
11269 .PP
11270 .RS 4
11271 This is the same as the
11272 \fIpreexec\fR
11273 parameter except that the command is run as root\&. This is useful for mounting filesystems (such as CDROMs) when a connection is opened\&.
11274 .sp
11275 Default:
11276 \fI\fIroot preexec\fR\fR\fI = \fR\fI\fR\fI \fR
11277 .RE
11278
11279 root preexec close (S)
11280 .PP
11281 .RS 4
11282 This is the same as the
11283 \fIpreexec close \fR
11284 parameter except that the command is run as root\&.
11285 .sp
11286 Default:
11287 \fI\fIroot preexec close\fR\fR\fI = \fR\fIno\fR\fI \fR
11288 .RE
11289
11290 rpc big endian (G)
11291 .PP
11292 .RS 4
11293 Setting this option will force the RPC client and server to transfer data in big endian\&.
11294 .sp
11295 If it is disabled, data will be transferred in little endian\&.
11296 .sp
11297 The behaviour is independent of the endianness of the host machine\&.
11298 .sp
11299 Default:
11300 \fI\fIrpc big endian\fR\fR\fI = \fR\fIno\fR\fI \fR
11301 .RE
11302
11303 rpc server dynamic port range (G)
11304 .PP
11305 .RS 4
11306 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\&.
11307 .sp
11308 This applies to RPC servers in all server roles\&.
11309 .sp
11310 Default:
11311 \fI\fIrpc server dynamic port range\fR\fR\fI = \fR\fI49152\-65535\fR\fI \fR
11312 .RE
11313
11314 rpc server port (G)
11315 .PP
11316 .RS 4
11317 Specifies which port the server should listen on for DCE/RPC over TCP/IP traffic\&.
11318 .sp
11319 This controls the default port for all protocols, except for NETLOGON\&.
11320 .sp
11321 If unset, the first available port from
11322 \m[blue]\fBrpc server dynamic port range\fR\m[]
11323 is used, e\&.g\&. 49152\&.
11324 .sp
11325 The NETLOGON server will use the next available port, e\&.g\&. 49153\&. To change this port use (eg) rpc server port:netlogon = 4000\&.
11326 .sp
11327 Furthermore, all RPC servers can have the port they use specified independenty, with (for example) rpc server port:drsuapi = 5000\&.
11328 .sp
11329 This option applies currently only when
11330 \fBsamba\fR(8)
11331 runs as an active directory domain controller\&.
11332 .sp
11333 The default value 0 causes Samba to select the first available port from
11334 \m[blue]\fBrpc server dynamic port range\fR\m[]\&.
11335 .sp
11336 Default:
11337 \fI\fIrpc server port\fR\fR\fI = \fR\fI0\fR\fI \fR
11338 .RE
11339
11340 rpc start on demand helpers (G)
11341 .PP
11342 .RS 4
11343 This global parameter determines if
11344 samba\-dcerpcd
11345 should be started on demand to service named pipe (np) DCE\-RPC requests from
11346 smbd
11347 or
11348 winbindd\&. This is the normal case where no startup scripts have been modified to start
11349 samba\-dcerpcd
11350 as a daemon\&.
11351 .sp
11352 If
11353 samba\-dcerpcd
11354 is started as a daemon or via a system service manager such as systemd, this parameter MUST be set to "no", otherwise
11355 samba\-dcerpcd
11356 will fail to start\&.
11357 .sp
11358 Default:
11359 \fI\fIrpc start on demand helpers\fR\fR\fI = \fR\fIyes\fR\fI \fR
11360 .RE
11361
11362 samba kcc command (G)
11363 .PP
11364 .RS 4
11365 This option specifies the path to the Samba KCC command\&. This script is used for replication topology replication\&.
11366 .sp
11367 It should not be necessary to modify this option except for testing purposes or if the
11368 samba_kcc
11369 was installed in a non\-default location\&.
11370 .sp
11371 Default:
11372 \fI\fIsamba kcc command\fR\fR\fI = \fR\fI/home/iurt/rpmbuild/BUILD/samba\-4\&.23\&.8\-build/samba\-4\&.23\&.8/source4/scripting/bin/samba_kcc\fR\fI \fR
11373 .sp
11374 Example:
11375 \fI\fIsamba kcc command\fR\fR\fI = \fR\fI/usr/local/bin/kcc\fR\fI \fR
11376 .RE
11377
11378 security (G)
11379 .PP
11380 .RS 4
11381 This option affects how clients respond to Samba and is one of the most important settings in the
11382 smb\&.conf
11383 file\&.
11384 .sp
11385 Unless
11386 \m[blue]\fBserver role\fR\m[]
11387 is specified, the default is
11388 security = user, as this is the most common setting, used for a standalone file server or a DC\&.
11389 .sp
11390 The alternatives to
11391 security = user
11392 are
11393 security = ads
11394 or
11395 security = domain, which support joining Samba to a Windows domain
11396 .sp
11397 You should use
11398 security = user
11399 and
11400 \m[blue]\fBmap to guest\fR\m[]
11401 if you want to mainly setup shares without a password (guest shares)\&. This is commonly used for a shared printer server\&.
11402 .sp
11403 The different settings will now be explained\&.
11404 .sp
11405 \fISECURITY = AUTO\fR
11406 .sp
11407 This is the default security setting in Samba, and causes Samba to consult the
11408 \m[blue]\fBserver role\fR\m[]
11409 parameter (if set) to determine the security mode\&.
11410 .sp
11411 \fISECURITY = USER\fR
11412 .sp
11413 If
11414 \m[blue]\fBserver role\fR\m[]
11415 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
11416 \m[blue]\fBusername map\fR\m[]
11417 parameter)\&. Encrypted passwords (see the
11418 \m[blue]\fBencrypt passwords\fR\m[]
11419 parameter) can also be used in this security mode\&. Parameters such as
11420 \m[blue]\fBforce user\fR\m[]
11421 and
11422 \m[blue]\fBguest only\fR\m[]
11423 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\&.
11424 .sp
11425 \fINote\fR
11426 that the name of the resource being requested is
11427 \fInot\fR
11428 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
11429 \m[blue]\fBguest account\fR\m[]\&. See the
11430 \m[blue]\fBmap to guest\fR\m[]
11431 parameter for details on doing this\&.
11432 .sp
11433 \fISECURITY = DOMAIN\fR
11434 .sp
11435 This mode will only work correctly if
11436 \fBnet\fR(8)
11437 has been used to add this machine into a Windows NT Domain\&. It expects the
11438 \m[blue]\fBencrypt passwords\fR\m[]
11439 parameter to be set to
11440 \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\&.
11441 .sp
11442 \fINote\fR
11443 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\&.
11444 .sp
11445 \fINote\fR
11446 that from the client\*(Aqs point of view
11447 security = domain
11448 is the same as
11449 security = user\&. It only affects how the server deals with the authentication, it does not in any way affect what the client sees\&.
11450 .sp
11451 \fINote\fR
11452 that the name of the resource being requested is
11453 \fInot\fR
11454 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
11455 \m[blue]\fBguest account\fR\m[]\&. See the
11456 \m[blue]\fBmap to guest\fR\m[]
11457 parameter for details on doing this\&.
11458 .sp
11459 See also the
11460 \m[blue]\fBpassword server\fR\m[]
11461 parameter and the
11462 \m[blue]\fBencrypt passwords\fR\m[]
11463 parameter\&.
11464 .sp
11465 \fISECURITY = ADS\fR
11466 .sp
11467 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\&.
11468 .sp
11469 Note that this mode does NOT make Samba operate as a Active Directory Domain Controller\&.
11470 .sp
11471 Note that this forces
11472 \m[blue]\fBrequire strong key = yes\fR\m[]
11473 and
11474 \m[blue]\fBclient schannel = yes\fR\m[]
11475 for the primary domain\&.
11476 .sp
11477 Read the chapter about Domain Membership in the HOWTO for details\&.
11478 .sp
11479 Default:
11480 \fI\fIsecurity\fR\fR\fI = \fR\fIAUTO\fR\fI \fR
11481 .sp
11482 Example:
11483 \fI\fIsecurity\fR\fR\fI = \fR\fIDOMAIN\fR\fI \fR
11484 .RE
11485
11486 security mask (S)
11487 .PP
11488 .RS 4
11489 This parameter has been removed for Samba 4\&.0\&.0\&.
11490 .sp
11491 \fINo default\fR
11492 .RE
11493
11494 server addresses (S)
11495 .PP
11496 .RS 4
11497 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\&.
11498 .sp
11499 An empty list means to offer a share on all interfaces\&.
11500 .sp
11501 Default:
11502 \fI\fIserver addresses\fR\fR\fI = \fR\fI\fR\fI \fR
11503 .RE
11504
11505 max protocol
11506 .PP
11507 .RS 4
11508 This parameter is a synonym for
11509 server max protocol\&.
11510 .RE
11511
11512 protocol
11513 .PP
11514 .RS 4
11515 This parameter is a synonym for
11516 server max protocol\&.
11517 .RE
11518
11519 server max protocol (G)
11520 .PP
11521 .RS 4
11522 The value of the parameter (a string) is the highest protocol level that will be supported by the server\&.
11523 .sp
11524 Possible values are :
11525 .RS
11526 .sp
11527 .RS 4
11528 .ie n \{\
11529 \h'-04'\(bu\h'+03'\c
11530 .\}
11531 .el \{\
11532 .sp -1
11533 .IP \(bu 2.3
11534 .\}
11535 \fBLANMAN1\fR: First
11536 \fImodern\fR
11537 version of the protocol\&. Long filename support\&.
11538 .RE
11539 .sp
11540 .RS 4
11541 .ie n \{\
11542 \h'-04'\(bu\h'+03'\c
11543 .\}
11544 .el \{\
11545 .sp -1
11546 .IP \(bu 2.3
11547 .\}
11548 \fBLANMAN2\fR: Updates to Lanman1 protocol\&.
11549 .RE
11550 .sp
11551 .RS 4
11552 .ie n \{\
11553 \h'-04'\(bu\h'+03'\c
11554 .\}
11555 .el \{\
11556 .sp -1
11557 .IP \(bu 2.3
11558 .\}
11559 \fBNT1\fR: Current up to date version of the protocol\&. Used by Windows NT\&. Known as CIFS\&.
11560 .RE
11561 .sp
11562 .RS 4
11563 .ie n \{\
11564 \h'-04'\(bu\h'+03'\c
11565 .\}
11566 .el \{\
11567 .sp -1
11568 .IP \(bu 2.3
11569 .\}
11570 \fBSMB2\fR: Re\-implementation of the SMB protocol\&. Used by Windows Vista and later versions of Windows\&. SMB2 has sub protocols available\&.
11571 .RS
11572 .sp
11573 .RS 4
11574 .ie n \{\
11575 \h'-04'\(bu\h'+03'\c
11576 .\}
11577 .el \{\
11578 .sp -1
11579 .IP \(bu 2.3
11580 .\}
11581 \fBSMB2_02\fR: The earliest SMB2 version\&.
11582 .RE
11583 .sp
11584 .RS 4
11585 .ie n \{\
11586 \h'-04'\(bu\h'+03'\c
11587 .\}
11588 .el \{\
11589 .sp -1
11590 .IP \(bu 2.3
11591 .\}
11592 \fBSMB2_10\fR: Windows 7 SMB2 version\&.
11593 .RE
11594 .sp
11595 .RE
11596 By default SMB2 selects the SMB2_10 variant\&.
11597 .RE
11598 .sp
11599 .RS 4
11600 .ie n \{\
11601 \h'-04'\(bu\h'+03'\c
11602 .\}
11603 .el \{\
11604 .sp -1
11605 .IP \(bu 2.3
11606 .\}
11607 \fBSMB3\fR: The same as SMB2\&. Used by Windows 8\&. SMB3 has sub protocols available\&.
11608 .RS
11609 .sp
11610 .RS 4
11611 .ie n \{\
11612 \h'-04'\(bu\h'+03'\c
11613 .\}
11614 .el \{\
11615 .sp -1
11616 .IP \(bu 2.3
11617 .\}
11618 \fBSMB3_00\fR: Windows 8 SMB3 version\&.
11619 .RE
11620 .sp
11621 .RS 4
11622 .ie n \{\
11623 \h'-04'\(bu\h'+03'\c
11624 .\}
11625 .el \{\
11626 .sp -1
11627 .IP \(bu 2.3
11628 .\}
11629 \fBSMB3_02\fR: Windows 8\&.1 SMB3 version\&.
11630 .RE
11631 .sp
11632 .RS 4
11633 .ie n \{\
11634 \h'-04'\(bu\h'+03'\c
11635 .\}
11636 .el \{\
11637 .sp -1
11638 .IP \(bu 2.3
11639 .\}
11640 \fBSMB3_11\fR: Windows 10 SMB3 version\&.
11641 .RE
11642 .sp
11643 .RE
11644 By default SMB3 selects the SMB3_11 variant\&.
11645 .RE
11646 .sp
11647 .RE
11648 Normally this option should not be set as the automatic negotiation phase in the SMB protocol takes care of choosing the appropriate protocol\&.
11649 .sp
11650 Default:
11651 \fI\fIserver max protocol\fR\fR\fI = \fR\fISMB3\fR\fI \fR
11652 .sp
11653 Example:
11654 \fI\fIserver max protocol\fR\fR\fI = \fR\fILANMAN1\fR\fI \fR
11655 .RE
11656
11657 min protocol
11658 .PP
11659 .RS 4
11660 This parameter is a synonym for
11661 server min protocol\&.
11662 .RE
11663
11664 server min protocol (G)
11665 .PP
11666 .RS 4
11667 This setting controls the minimum protocol version that the server will allow the client to use\&.
11668 .sp
11669 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\&.
11670 .sp
11671 See
11672 Related command: \m[blue]\fBserver max protocol\fR\m[]
11673 for a full list of available protocols\&.
11674 .sp
11675 Default:
11676 \fI\fIserver min protocol\fR\fR\fI = \fR\fISMB2_02\fR\fI \fR
11677 .sp
11678 Example:
11679 \fI\fIserver min protocol\fR\fR\fI = \fR\fINT1\fR\fI \fR
11680 .RE
11681
11682 server multi channel support (G)
11683 .PP
11684 .RS 4
11685 This boolean parameter controls whether
11686 \fBsmbd\fR(8)
11687 will support SMB3 multi\-channel\&.
11688 .sp
11689 This parameter was added with version 4\&.4\&.
11690 .sp
11691 Note that this feature was still considered experimental up to 4\&.14\&.
11692 .sp
11693 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
11694 \fBforce:server multi channel support=yes\fR
11695 in addition\&.
11696 .sp
11697 This option is enabled by default starting with to 4\&.15 (on Linux and FreeBSD)\&.
11698 .sp
11699 Default:
11700 \fI\fIserver multi channel support\fR\fR\fI = \fR\fIyes\fR\fI \fR
11701 .RE
11702
11703 server reject aes schannel (G)
11704 .PP
11705 .RS 4
11706 \fIThis option is experimental for now!\fR
11707 .sp
11708 This option controls whether the netlogon server (currently only in \*(Aqactive directory domain controller\*(Aq mode), will reject clients which do not support ServerAuthenticateKerberos\&.
11709 .sp
11710 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\&.
11711 .sp
11712 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\&.
11713 .sp
11714 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)\&.
11715 .sp
11716 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
11717 .sp
11718 Admins can use \*(Aq\m[blue]\fBserver reject aes schannel:COMPUTERACCOUNT = no/yes\fR\m[]\*(Aq options in order to have more control
11719 .sp
11720 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\&.
11721 .sp
11722 This option interacts with the \*(Aq\m[blue]\fBserver support krb5 netlogon\fR\m[]\*(Aq option\&.
11723 .sp
11724 For now \*(Aq\m[blue]\fBserver reject aes schannel\fR\m[]\*(Aq is EXPERIMENTAL and should not be configured explicitly\&.
11725 .sp
11726 Default:
11727 \fI\fIserver reject aes schannel\fR\fR\fI = \fR\fIno\fR\fI \fR
11728 .sp
11729 Example:
11730 \fI\fIserver reject aes schannel\fR\fR\fI = \fR\fIyes\fR\fI \fR
11731 .RE
11732
11733 server reject aes schannel:COMPUTERACCOUNT (G)
11734 .PP
11735 .RS 4
11736 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)\&.
11737 .sp
11738 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\&.
11739 .sp
11740 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)\&.
11741 .sp
11742 Samba will log a warning in the log files at log level 5 if a setting is still needed for the specified computer account\&.
11743 .sp
11744 This option overrides the
11745 \m[blue]\fBserver reject aes schannel\fR\m[]
11746 option\&.
11747 .sp
11748 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\&.
11749 .sp
11750 .if n \{\
11751 .RS 4
11752 .\}
11753 .nf
11754 server reject aes schannel:LEGACYCOMPUTER1$ = no
11755 server reject aes schannel:NASBOX$ = no
11756 server reject aes schannel:LEGACYCOMPUTER2$ = no
11757 server reject aes schannel:HIGHPRIVACYSRV$ = yes
11758
11759 .fi
11760 .if n \{\
11761 .RE
11762 .\}
11763 .sp
11764 \fINo default\fR
11765 .RE
11766
11767 server role (G)
11768 .PP
11769 .RS 4
11770 This option determines the basic operating mode of a Samba server and is one of the most important settings in the
11771 smb\&.conf
11772 file\&.
11773 .sp
11774 The default is
11775 server role = auto, as causes Samba to operate according to the
11776 \m[blue]\fBsecurity\fR\m[]
11777 setting, or if not specified as a simple file server that is not connected to any domain\&.
11778 .sp
11779 The alternatives are
11780 server role = standalone
11781 or
11782 server role = member server, which support joining Samba to a Windows domain, along with
11783 server role = domain controller, which run Samba as a Windows domain controller\&.
11784 .sp
11785 You should use
11786 server role = standalone
11787 and
11788 \m[blue]\fBmap to guest\fR\m[]
11789 if you want to mainly setup shares without a password (guest shares)\&. This is commonly used for a shared printer server\&.
11790 .sp
11791 \fISERVER ROLE = AUTO\fR
11792 .sp
11793 This is the default server role in Samba, and causes Samba to consult the
11794 \m[blue]\fBsecurity\fR\m[]
11795 parameter (if set) to determine the server role, giving compatible behaviours to previous Samba versions\&.
11796 .sp
11797 \fISERVER ROLE = STANDALONE\fR
11798 .sp
11799 If
11800 \m[blue]\fBsecurity\fR\m[]
11801 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
11802 \m[blue]\fBusername map\fR\m[]
11803 parameter) stored on this machine\&. Encrypted passwords (see the
11804 \m[blue]\fBencrypt passwords\fR\m[]
11805 parameter) are by default used in this security mode\&. Parameters such as
11806 \m[blue]\fBforce user\fR\m[]
11807 and
11808 \m[blue]\fBguest only\fR\m[]
11809 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\&.
11810 .sp
11811 \fISERVER ROLE = MEMBER SERVER\fR
11812 .sp
11813 This mode will only work correctly if
11814 \fBnet\fR(8)
11815 has been used to add this machine into a Windows Domain\&. It expects the
11816 \m[blue]\fBencrypt passwords\fR\m[]
11817 parameter to be set to
11818 \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\&.
11819 .sp
11820 \fINote\fR
11821 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\&.
11822 .sp
11823 \fISERVER ROLE = CLASSIC PRIMARY DOMAIN CONTROLLER\fR
11824 .sp
11825 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)\&.
11826 .sp
11827 \fISERVER ROLE = CLASSIC BACKUP DOMAIN CONTROLLER\fR
11828 .sp
11829 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\&.
11830 .sp
11831 \fISERVER ROLE = ACTIVE DIRECTORY DOMAIN CONTROLLER\fR
11832 .sp
11833 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
11834 Samba4 HOWTO
11835 .sp
11836 \fISERVER ROLE = IPA PRIMARY DOMAIN CONTROLLER\fR
11837 .sp
11838 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\&.
11839 .sp
11840 Default:
11841 \fI\fIserver role\fR\fR\fI = \fR\fIAUTO\fR\fI \fR
11842 .sp
11843 Example:
11844 \fI\fIserver role\fR\fR\fI = \fR\fIACTIVE DIRECTORY DOMAIN CONTROLLER\fR\fI \fR
11845 .RE
11846
11847 server schannel (G)
11848 .PP
11849 .RS 4
11850 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)\&.
11851 .sp
11852 \fIAvoid using this option!\fR
11853 Use explicit \*(Aq\m[blue]\fBserver require schannel:COMPUTERACCOUNT = no\fR\m[]\*(Aq instead!
11854 .sp
11855 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)\&.
11856 .sp
11857 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\&.
11858 .sp
11859 See
11860 CVE\-2020\-1472(ZeroLogon),
11861 https://bugzilla\&.samba\&.org/show_bug\&.cgi?id=14497\&.
11862 .sp
11863 This option is over\-ridden by the
11864 \m[blue]\fBserver require schannel:COMPUTERACCOUNT\fR\m[]
11865 option\&.
11866 .sp
11867 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\&.
11868 .sp
11869 Default:
11870 \fI\fIserver schannel\fR\fR\fI = \fR\fIyes\fR\fI \fR
11871 .RE
11872
11873 server require schannel:COMPUTERACCOUNT (G)
11874 .PP
11875 .RS 4
11876 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)\&.
11877 .sp
11878 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)\&.
11879 .sp
11880 Samba will warn in the log files at log level 5, if a setting is still needed for the specified computer account\&.
11881 .sp
11882 See
11883 CVE\-2020\-1472(ZeroLogon),
11884 https://bugzilla\&.samba\&.org/show_bug\&.cgi?id=14497\&.
11885 .sp
11886 This option overrides the
11887 \m[blue]\fBserver schannel\fR\m[]
11888 option\&.
11889 .sp
11890 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\&.
11891 .sp
11892 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
11893 .sp
11894 .if n \{\
11895 .RS 4
11896 .\}
11897 .nf
11898 server require schannel:LEGACYCOMPUTER1$ = no
11899 server require schannel seal:LEGACYCOMPUTER1$ = no
11900 server require schannel:NASBOX$ = no
11901 server require schannel seal:NASBOX$ = no
11902 server require schannel:LEGACYCOMPUTER2$ = no
11903 server require schannel seal:LEGACYCOMPUTER2$ = no
11904
11905 .fi
11906 .if n \{\
11907 .RE
11908 .\}
11909 .sp
11910 \fINo default\fR
11911 .RE
11912
11913 server schannel require seal (G)
11914 .PP
11915 .RS 4
11916 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)\&.
11917 .sp
11918 This option controls whether the netlogon server, will reject the usage of netlogon secure channel without privacy/enryption\&.
11919 .sp
11920 The option is modelled after the registry key available on Windows\&.
11921 .sp
11922 .if n \{\
11923 .RS 4
11924 .\}
11925 .nf
11926 HKEY_LOCAL_MACHINE\eSYSTEM\eCurrentControlSet\eServices\eNetlogon\eParameters\eRequireSeal=2
11927
11928 .fi
11929 .if n \{\
11930 .RE
11931 .\}
11932 .sp
11933 \fIAvoid using this option!\fR
11934 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
11935 CVE\-2022\-38023
11936 see
11937 https://bugzilla\&.samba\&.org/show_bug\&.cgi?id=15240\&.
11938 .sp
11939 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)\&.
11940 .sp
11941 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\&.
11942 .sp
11943 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\&.
11944 .sp
11945 This option is over\-ridden by the
11946 \m[blue]\fBserver schannel require seal:COMPUTERACCOUNT\fR\m[]
11947 option\&.
11948 .sp
11949 Default:
11950 \fI\fIserver schannel require seal\fR\fR\fI = \fR\fIyes\fR\fI \fR
11951 .RE
11952
11953 server schannel require seal:COMPUTERACCOUNT (G)
11954 .PP
11955 .RS 4
11956 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)\&.
11957 .sp
11958 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)\&.
11959 .sp
11960 Samba will warn in the log files at log level 5, if a setting is still needed for the specified computer account\&.
11961 .sp
11962 See
11963 CVE\-2022\-38023,
11964 https://bugzilla\&.samba\&.org/show_bug\&.cgi?id=15240\&.
11965 .sp
11966 This option overrides the \*(Aq\m[blue]\fBserver schannel require seal\fR\m[]\*(Aq option\&.
11967 .sp
11968 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\&.
11969 .sp
11970 .if n \{\
11971 .RS 4
11972 .\}
11973 .nf
11974 server require schannel seal:LEGACYCOMPUTER1$ = no
11975 server require schannel seal:NASBOX$ = no
11976 server require schannel seal:LEGACYCOMPUTER2$ = no
11977
11978 .fi
11979 .if n \{\
11980 .RE
11981 .\}
11982 .sp
11983 \fINo default\fR
11984 .RE
11985
11986 server services (G)
11987 .PP
11988 .RS 4
11989 This option contains the services that the Samba daemon will run\&.
11990 .sp
11991 An entry in the
11992 smb\&.conf
11993 file can either override the previous value completely or entries can be removed from or added to it by prefixing them with
11994 \fB+\fR
11995 or
11996 \fB\-\fR\&.
11997 .sp
11998 Default:
11999 \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
12000 .sp
12001 Example:
12002 \fI\fIserver services\fR\fR\fI = \fR\fI\-s3fs, +smb\fR\fI \fR
12003 .RE
12004
12005 server signing (G)
12006 .PP
12007 .RS 4
12008 This controls whether the client is allowed or required to use SMB1 and SMB2 signing\&. Possible values are
12009 \fIdefault\fR,
12010 \fIauto\fR,
12011 \fImandatory\fR
12012 and
12013 \fIdisabled\fR\&.
12014 .sp
12015 By default, and when smb signing is set to
12016 \fIdefault\fR, smb signing is required when
12017 \m[blue]\fBserver role\fR\m[]
12018 is
12019 \fIactive directory domain controller\fR
12020 and disabled otherwise\&.
12021 .sp
12022 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\&.
12023 .sp
12024 For the SMB2 protocol, by design, signing cannot be disabled\&. In the case where SMB2 is negotiated, if this parameter is set to
12025 \fIdisabled\fR, it will be treated as
12026 \fIauto\fR\&. Setting it to
12027 \fImandatory\fR
12028 will still require SMB2 clients to use signing\&.
12029 .sp
12030 Default:
12031 \fI\fIserver signing\fR\fR\fI = \fR\fIdefault\fR\fI \fR
12032 .RE
12033
12034 server smb encrypt (S)
12035 .PP
12036 .RS 4
12037 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:
12038 .RS
12039 .sp
12040 .RS 4
12041 .ie n \{\
12042 \h'-04'\(bu\h'+03'\c
12043 .\}
12044 .el \{\
12045 .sp -1
12046 .IP \(bu 2.3
12047 .\}
12048 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\&.
12049 .RE
12050 .sp
12051 .RS 4
12052 .ie n \{\
12053 \h'-04'\(bu\h'+03'\c
12054 .\}
12055 .el \{\
12056 .sp -1
12057 .IP \(bu 2.3
12058 .\}
12059 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\&.
12060 .RE
12061 .sp
12062 .RE
12063 This parameter can be set globally and on a per\-share bases\&. Possible values are
12064 \fIoff\fR,
12065 \fIif_required\fR,
12066 \fIdesired\fR, and
12067 \fIrequired\fR\&. A special value is
12068 \fIdefault\fR
12069 which is the implicit default setting of
12070 \fIif_required\fR\&.
12071 .PP
12072 \fIEffects for SMB1\fR
12073 .RS 4
12074 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\&.
12075 .sp
12076 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
12077 \fImust\fR
12078 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\&.
12079 .sp
12080 If SMB encryption is selected, Windows style SMB signing (see the
12081 \m[blue]\fBserver signing\fR\m[]
12082 option) is no longer necessary, as the GSSAPI flags use select both signing and sealing of the data\&.
12083 .sp
12084 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\&.
12085 .RE
12086 .PP
12087 \fIEffects for SMB2 and newer\fR
12088 .RS 4
12089 Native SMB transport encryption is available in SMB version 3\&.0 or newer\&. It is only offered by Samba if
12090 \fIserver max protocol\fR
12091 is set to
12092 \fISMB3\fR
12093 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\&.
12094 .sp
12095 The protocol implementation offers various options:
12096 .RS
12097 .sp
12098 .RS 4
12099 .ie n \{\
12100 \h'-04'\(bu\h'+03'\c
12101 .\}
12102 .el \{\
12103 .sp -1
12104 .IP \(bu 2.3
12105 .\}
12106 The capability to perform SMB encryption can be negotiated during protocol negotiation\&.
12107 .RE
12108 .sp
12109 .RS 4
12110 .ie n \{\
12111 \h'-04'\(bu\h'+03'\c
12112 .\}
12113 .el \{\
12114 .sp -1
12115 .IP \(bu 2.3
12116 .\}
12117 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\&.
12118 .RE
12119 .sp
12120 .RS 4
12121 .ie n \{\
12122 \h'-04'\(bu\h'+03'\c
12123 .\}
12124 .el \{\
12125 .sp -1
12126 .IP \(bu 2.3
12127 .\}
12128 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\&.
12129 .RE
12130 .sp
12131 .RS 4
12132 .ie n \{\
12133 \h'-04'\(bu\h'+03'\c
12134 .\}
12135 .el \{\
12136 .sp -1
12137 .IP \(bu 2.3
12138 .\}
12139 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\&.
12140 .RE
12141 .sp
12142 .RE
12143 These features can be controlled with settings of
12144 \fIserver smb encrypt\fR
12145 as follows:
12146 .RS
12147 .sp
12148 .RS 4
12149 .ie n \{\
12150 \h'-04'\(bu\h'+03'\c
12151 .\}
12152 .el \{\
12153 .sp -1
12154 .IP \(bu 2.3
12155 .\}
12156 Leaving it as default, explicitly setting
12157 \fIdefault\fR, or setting it to
12158 \fIif_required\fR
12159 globally will enable negotiation of encryption but will not turn on data encryption globally or per share\&.
12160 .RE
12161 .sp
12162 .RS 4
12163 .ie n \{\
12164 \h'-04'\(bu\h'+03'\c
12165 .\}
12166 .el \{\
12167 .sp -1
12168 .IP \(bu 2.3
12169 .\}
12170 Setting it to
12171 \fIdesired\fR
12172 globally will enable negotiation and will turn on data encryption on sessions and share connections for those clients that support it\&.
12173 .RE
12174 .sp
12175 .RS 4
12176 .ie n \{\
12177 \h'-04'\(bu\h'+03'\c
12178 .\}
12179 .el \{\
12180 .sp -1
12181 .IP \(bu 2.3
12182 .\}
12183 Setting it to
12184 \fIrequired\fR
12185 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\&.
12186 .RE
12187 .sp
12188 .RS 4
12189 .ie n \{\
12190 \h'-04'\(bu\h'+03'\c
12191 .\}
12192 .el \{\
12193 .sp -1
12194 .IP \(bu 2.3
12195 .\}
12196 Setting it to
12197 \fIoff\fR
12198 globally will completely disable the encryption feature for all connections\&. Setting
12199 \fIserver smb encrypt = required\fR
12200 for individual shares (while it\*(Aqs globally off) will deny access to this shares for all clients\&.
12201 .RE
12202 .sp
12203 .RS 4
12204 .ie n \{\
12205 \h'-04'\(bu\h'+03'\c
12206 .\}
12207 .el \{\
12208 .sp -1
12209 .IP \(bu 2.3
12210 .\}
12211 Setting it to
12212 \fIdesired\fR
12213 on a share will turn on data encryption for this share for clients that support encryption if negotiation has been enabled globally\&.
12214 .RE
12215 .sp
12216 .RS 4
12217 .ie n \{\
12218 \h'-04'\(bu\h'+03'\c
12219 .\}
12220 .el \{\
12221 .sp -1
12222 .IP \(bu 2.3
12223 .\}
12224 Setting it to
12225 \fIrequired\fR
12226 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\&.
12227 .sp
12228 Note that this allows per\-share enforcing to be controlled in Samba differently from Windows: In Windows,
12229 \fIRejectUnencryptedAccess\fR
12230 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
12231 \fIserver smb encrypt\fR
12232 to
12233 \fIif_required\fR, and then set all shares that should be encrypted to
12234 \fIrequired\fR\&. Additionally, it is possible in Samba to have some shares with encryption
12235 \fIrequired\fR
12236 and some other shares with encryption only
12237 \fIdesired\fR, which is not possible in Windows\&.
12238 .RE
12239 .sp
12240 .RS 4
12241 .ie n \{\
12242 \h'-04'\(bu\h'+03'\c
12243 .\}
12244 .el \{\
12245 .sp -1
12246 .IP \(bu 2.3
12247 .\}
12248 Setting it to
12249 \fIoff\fR
12250 or
12251 \fIif_required\fR
12252 for a share has no effect\&.
12253 .RE
12254 .sp
12255 .RE
12256 .RE
12257 .sp
12258 Default:
12259 \fI\fIserver smb encrypt\fR\fR\fI = \fR\fIdefault\fR\fI \fR
12260 .RE
12261
12262 server smb3 encryption algorithms (G)
12263 .PP
12264 .RS 4
12265 This parameter specifies the availability and order of encryption algorithms which are available for negotiation in the SMB3_11 dialect\&.
12266 .sp
12267 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\&.
12268 .sp
12269 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\&.
12270 .sp
12271 Default:
12272 \fI\fIserver smb3 encryption algorithms\fR\fR\fI = \fR\fIAES\-128\-GCM, AES\-128\-CCM, AES\-256\-GCM, AES\-256\-CCM\fR\fI \fR
12273 .sp
12274 Example:
12275 \fI\fIserver smb3 encryption algorithms\fR\fR\fI = \fR\fIAES\-256\-GCM\fR\fI \fR
12276 .sp
12277 Example:
12278 \fI\fIserver smb3 encryption algorithms\fR\fR\fI = \fR\fI\-AES\-128\-GCM \-AES\-128\-CCM\fR\fI \fR
12279 .RE
12280
12281 server smb3 signing algorithms (G)
12282 .PP
12283 .RS 4
12284 This parameter specifies the availability and order of signing algorithms which are available for negotiation in the SMB3_11 dialect\&.
12285 .sp
12286 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\&.
12287 .sp
12288 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\&.
12289 .sp
12290 Default:
12291 \fI\fIserver smb3 signing algorithms\fR\fR\fI = \fR\fIAES\-128\-GMAC, AES\-128\-CMAC, HMAC\-SHA256\fR\fI \fR
12292 .sp
12293 Example:
12294 \fI\fIserver smb3 signing algorithms\fR\fR\fI = \fR\fIAES\-128\-CMAC, HMAC\-SHA256\fR\fI \fR
12295 .sp
12296 Example:
12297 \fI\fIserver smb3 signing algorithms\fR\fR\fI = \fR\fI\-AES\-128\-CMAC\fR\fI \fR
12298 .RE
12299
12300 server smb transports (G)
12301 .PP
12302 .RS 4
12303 Specifies which transports and ports the server should listen on for SMB traffic\&.
12304 .sp
12305 The order matters only for mDNS registrations, the first \*(Aqtcp\*(Aq or \*(Aqnbt\*(Aq port is used for that\&.
12306 .sp
12307 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\&.
12308 .sp
12309 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\&.
12310 .sp
12311 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:
12312 \m[blue]\fBtls enabled\fR\m[],
12313 \m[blue]\fBtls cafile\fR\m[],
12314 \m[blue]\fBtls certfile\fR\m[]
12315 and
12316 \m[blue]\fBtls keyfile\fR\m[]\&. If the files pointed to by
12317 \m[blue]\fBtls cafile\fR\m[],
12318 \m[blue]\fBtls certfile\fR\m[]
12319 and
12320 \m[blue]\fBtls keyfile\fR\m[]
12321 all do not exist, a self\-signed tls certificate is generated automatically at startup\&.
12322 .sp
12323 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\&.
12324 .sp
12325 Numerical ports are handled as \*(Aqtcp\*(Aq except port \*(Aq139\*(Aq is handled as \*(Aqnbt\*(Aq\&.
12326 .sp
12327 Note that\*(Aqs currently a limit of 10 unique transports, all others will be ignored\&.
12328 .sp
12329 Default:
12330 \fI\fIserver smb transports\fR\fR\fI = \fR\fItcp, nbt\fR\fI \fR
12331 .sp
12332 Example:
12333 \fI\fIserver smb transports\fR\fR\fI = \fR\fI445\fR\fI \fR
12334 .sp
12335 Example:
12336 \fI\fIserver smb transports\fR\fR\fI = \fR\fItcp, tcp:1445\fR\fI \fR
12337 .sp
12338 Example:
12339 \fI\fIserver smb transports\fR\fR\fI = \fR\fI8000, nbt:1139\fR\fI \fR
12340 .sp
12341 Example:
12342 \fI\fIserver smb transports\fR\fR\fI = \fR\fItcp, quic, nbt\fR\fI \fR
12343 .sp
12344 Example:
12345 \fI\fIserver smb transports\fR\fR\fI = \fR\fI+quic\fR\fI \fR
12346 .RE
12347
12348 smb ports (G)
12349 .PP
12350 .RS 4
12351 This is a synonym for
12352 \m[blue]\fBserver smb transports\fR\m[]\&.
12353 .sp
12354 \fINo default\fR
12355 .RE
12356
12357 server string (G)
12358 .PP
12359 .RS 4
12360 This controls what string will show up in the printer comment box in print manager and next to the IPC connection in
12361 net view\&. It can be any string that you wish to show to your users\&.
12362 .sp
12363 It also sets what will appear in browse lists next to the machine name\&.
12364 .sp
12365 A
12366 \fI%v\fR
12367 will be replaced with the Samba version number\&.
12368 .sp
12369 A
12370 \fI%h\fR
12371 will be replaced with the hostname\&.
12372 .sp
12373 Default:
12374 \fI\fIserver string\fR\fR\fI = \fR\fISamba %v\fR\fI \fR
12375 .sp
12376 Example:
12377 \fI\fIserver string\fR\fR\fI = \fR\fIUniversity of GNUs Samba Server\fR\fI \fR
12378 .RE
12379
12380 server support krb5 netlogon (G)
12381 .PP
12382 .RS 4
12383 \fIThis option is experimental for now!\fR
12384 .sp
12385 This option controls whether the netlogon server (currently only in \*(Aqactive directory domain controller\*(Aq mode), will provide support for ServerAuthenticateKerberos\&.
12386 .sp
12387 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\&.
12388 .sp
12389 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\&.
12390 .sp
12391 Default:
12392 \fI\fIserver support krb5 netlogon\fR\fR\fI = \fR\fIno\fR\fI \fR
12393 .sp
12394 Example:
12395 \fI\fIserver support krb5 netlogon\fR\fR\fI = \fR\fIyes\fR\fI \fR
12396 .RE
12397
12398 set primary group script (G)
12399 .PP
12400 .RS 4
12401 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
12402 net rpc vampire\&.
12403 \fI%u\fR
12404 will be replaced with the user whose primary group is to be set\&.
12405 \fI%g\fR
12406 will be replaced with the group to set\&.
12407 .sp
12408 Default:
12409 \fI\fIset primary group script\fR\fR\fI = \fR\fI\fR\fI \fR
12410 .sp
12411 Example:
12412 \fI\fIset primary group script\fR\fR\fI = \fR\fI/usr/sbin/usermod \-g \*(Aq%g\*(Aq \*(Aq%u\*(Aq\fR\fI \fR
12413 .RE
12414
12415 set quota command (G)
12416 .PP
12417 .RS 4
12418 The
12419 set quota command
12420 should only be used whenever there is no operating system API available from the OS that samba can use\&.
12421 .sp
12422 This option is only available if Samba was compiled with quota support\&.
12423 .sp
12424 This parameter should specify the path to a script that can set quota for the specified arguments\&.
12425 .sp
12426 The specified script should take the following arguments:
12427 .RS
12428 .sp
12429 .RS 4
12430 .ie n \{\
12431 \h'-04'\(bu\h'+03'\c
12432 .\}
12433 .el \{\
12434 .sp -1
12435 .IP \(bu 2.3
12436 .\}
12437 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\&.
12438 .RE
12439 .sp
12440 .RS 4
12441 .ie n \{\
12442 \h'-04'\(bu\h'+03'\c
12443 .\}
12444 .el \{\
12445 .sp -1
12446 .IP \(bu 2.3
12447 .\}
12448 2 \- quota type
12449 .RS
12450 .sp
12451 .RS 4
12452 .ie n \{\
12453 \h'-04'\(bu\h'+03'\c
12454 .\}
12455 .el \{\
12456 .sp -1
12457 .IP \(bu 2.3
12458 .\}
12459 1 \- user quotas
12460 .RE
12461 .sp
12462 .RS 4
12463 .ie n \{\
12464 \h'-04'\(bu\h'+03'\c
12465 .\}
12466 .el \{\
12467 .sp -1
12468 .IP \(bu 2.3
12469 .\}
12470 2 \- user default quotas (uid = \-1)
12471 .RE
12472 .sp
12473 .RS 4
12474 .ie n \{\
12475 \h'-04'\(bu\h'+03'\c
12476 .\}
12477 .el \{\
12478 .sp -1
12479 .IP \(bu 2.3
12480 .\}
12481 3 \- group quotas
12482 .RE
12483 .sp
12484 .RS 4
12485 .ie n \{\
12486 \h'-04'\(bu\h'+03'\c
12487 .\}
12488 .el \{\
12489 .sp -1
12490 .IP \(bu 2.3
12491 .\}
12492 4 \- group default quotas (gid = \-1)
12493 .RE
12494 .sp
12495 .RE
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 3 \- id (uid for user, gid for group, \-1 if N/A)
12507 .RE
12508 .sp
12509 .RS 4
12510 .ie n \{\
12511 \h'-04'\(bu\h'+03'\c
12512 .\}
12513 .el \{\
12514 .sp -1
12515 .IP \(bu 2.3
12516 .\}
12517 4 \- quota state (0 = disable, 1 = enable, 2 = enable and enforce)
12518 .RE
12519 .sp
12520 .RS 4
12521 .ie n \{\
12522 \h'-04'\(bu\h'+03'\c
12523 .\}
12524 .el \{\
12525 .sp -1
12526 .IP \(bu 2.3
12527 .\}
12528 5 \- block softlimit
12529 .RE
12530 .sp
12531 .RS 4
12532 .ie n \{\
12533 \h'-04'\(bu\h'+03'\c
12534 .\}
12535 .el \{\
12536 .sp -1
12537 .IP \(bu 2.3
12538 .\}
12539 6 \- block hardlimit
12540 .RE
12541 .sp
12542 .RS 4
12543 .ie n \{\
12544 \h'-04'\(bu\h'+03'\c
12545 .\}
12546 .el \{\
12547 .sp -1
12548 .IP \(bu 2.3
12549 .\}
12550 7 \- inode softlimit
12551 .RE
12552 .sp
12553 .RS 4
12554 .ie n \{\
12555 \h'-04'\(bu\h'+03'\c
12556 .\}
12557 .el \{\
12558 .sp -1
12559 .IP \(bu 2.3
12560 .\}
12561 8 \- inode hardlimit
12562 .RE
12563 .sp
12564 .RS 4
12565 .ie n \{\
12566 \h'-04'\(bu\h'+03'\c
12567 .\}
12568 .el \{\
12569 .sp -1
12570 .IP \(bu 2.3
12571 .\}
12572 9(optional) \- block size, defaults to 1024
12573 .RE
12574 .sp
12575 .RE
12576 The script should output at least one line of data on success\&. And nothing on failure\&.
12577 .sp
12578 Default:
12579 \fI\fIset quota command\fR\fR\fI = \fR\fI\fR\fI \fR
12580 .sp
12581 Example:
12582 \fI\fIset quota command\fR\fR\fI = \fR\fI/usr/local/sbin/set_quota\fR\fI \fR
12583 .RE
12584
12585 share:fake_fscaps (S)
12586 .PP
12587 .RS 4
12588 This is needed to support some special applications that makes use of filesystem specific features like sparse files or block reflink copy\&.
12589 .sp
12590 With
12591 \m[blue]\fBshare:fake_fscaps = 64\fR\m[]
12592 the SPARSE_FILES (0x40) file system capability flag is set\&.
12593 .sp
12594 With
12595 \m[blue]\fBshare:fake_fscaps = 134217728\fR\m[]
12596 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\&.
12597 .sp
12598 The complete list can be found in MS\-FSCC 2\&.5\&.1 FileFsAttributeInformation\&. Note that only decimal values can be used in the configuration\&.
12599 .sp
12600 Default:
12601 \fI\fIshare:fake_fscaps\fR\fR\fI = \fR\fI0\fR\fI \fR
12602 .RE
12603
12604 short preserve case (S)
12605 .PP
12606 .RS 4
12607 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
12608 \m[blue]\fBdefault case\fR\m[]\&. This option can be use with
12609 \m[blue]\fBpreserve case = yes\fR\m[]
12610 to permit long filenames to retain their case, while short names are lowered\&.
12611 .sp
12612 See the section on
12613 NAME MANGLING\&.
12614 .sp
12615 Default:
12616 \fI\fIshort preserve case\fR\fR\fI = \fR\fIyes\fR\fI \fR
12617 .RE
12618
12619 show add printer wizard (G)
12620 .PP
12621 .RS 4
12622 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\&.
12623 .sp
12624 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\&.
12625 .sp
12626 Disabling the
12627 \fIshow add printer wizard\fR
12628 parameter will always cause the OpenPrinterEx() on the server to fail\&. Thus the APW icon will never be displayed\&.
12629 .if n \{\
12630 .sp
12631 .\}
12632 .RS 4
12633 .it 1 an-trap
12634 .nr an-no-space-flag 1
12635 .nr an-break-flag 1
12636 .br
12637 .ps +1
12638 \fBNote\fR
12639 .ps -1
12640 .br
12641 This does not prevent the same user from having administrative privilege on an individual printer\&.
12642 .sp .5v
12643 .RE
12644 Default:
12645 \fI\fIshow add printer wizard\fR\fR\fI = \fR\fIyes\fR\fI \fR
12646 .RE
12647
12648 shutdown script (G)
12649 .PP
12650 .RS 4
12651 This a full path name to a script called by
12652 \fBsmbd\fR(8)
12653 that should start a shutdown procedure\&.
12654 .sp
12655 If the connected user possesses the
12656 \fBSeRemoteShutdownPrivilege\fR, right, this command will be run as root\&.
12657 .sp
12658 The %z %t %r %f variables are expanded as follows:
12659 .RS
12660 .sp
12661 .RS 4
12662 .ie n \{\
12663 \h'-04'\(bu\h'+03'\c
12664 .\}
12665 .el \{\
12666 .sp -1
12667 .IP \(bu 2.3
12668 .\}
12669 \fI%z\fR
12670 will be substituted with the shutdown message sent to the server\&.
12671 .RE
12672 .sp
12673 .RS 4
12674 .ie n \{\
12675 \h'-04'\(bu\h'+03'\c
12676 .\}
12677 .el \{\
12678 .sp -1
12679 .IP \(bu 2.3
12680 .\}
12681 \fI%t\fR
12682 will be substituted with the number of seconds to wait before effectively starting the shutdown procedure\&.
12683 .RE
12684 .sp
12685 .RS 4
12686 .ie n \{\
12687 \h'-04'\(bu\h'+03'\c
12688 .\}
12689 .el \{\
12690 .sp -1
12691 .IP \(bu 2.3
12692 .\}
12693 \fI%r\fR
12694 will be substituted with the switch
12695 \fI\-r\fR\&. It means reboot after shutdown for NT\&.
12696 .RE
12697 .sp
12698 .RS 4
12699 .ie n \{\
12700 \h'-04'\(bu\h'+03'\c
12701 .\}
12702 .el \{\
12703 .sp -1
12704 .IP \(bu 2.3
12705 .\}
12706 \fI%f\fR
12707 will be substituted with the switch
12708 \fI\-f\fR\&. It means force the shutdown even if applications do not respond for NT\&.
12709 .RE
12710 .sp
12711 .RE
12712 Shutdown script example:
12713 .sp
12714 .if n \{\
12715 .RS 4
12716 .\}
12717 .nf
12718 #!/bin/bash
12719
12720 time=$2
12721 let time="${time} / 60"
12722 let time="${time} + 1"
12723
12724 /sbin/shutdown $3 $4 +$time $1 &
12725
12726 .fi
12727 .if n \{\
12728 .RE
12729 .\}
12730 .sp
12731 Shutdown does not return so we need to launch it in background\&.
12732 .sp
12733 Default:
12734 \fI\fIshutdown script\fR\fR\fI = \fR\fI\fR\fI \fR
12735 .sp
12736 Example:
12737 \fI\fIshutdown script\fR\fR\fI = \fR\fI/usr/local/samba/sbin/shutdown %m %t %r %f\fR\fI \fR
12738 .RE
12739
12740 unix extensions
12741 .PP
12742 .RS 4
12743 This parameter is a synonym for
12744 smb1 unix extensions\&.
12745 .RE
12746
12747 smb1 unix extensions (G)
12748 .PP
12749 .RS 4
12750 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\&.
12751 .sp
12752 Note if this parameter is turned on, the
12753 \m[blue]\fBwide links\fR\m[]
12754 parameter will automatically be disabled\&.
12755 .sp
12756 See the parameter
12757 \m[blue]\fBallow insecure wide links\fR\m[]
12758 if you wish to change this coupling between the two parameters\&.
12759 .sp
12760 Default:
12761 \fI\fIsmb1 unix extensions\fR\fR\fI = \fR\fIyes\fR\fI \fR
12762 .RE
12763
12764 smb2 disable lock sequence checking (G)
12765 .PP
12766 .RS 4
12767 This boolean parameter controls whether
12768 \fBsmbd\fR(8)
12769 will disable lock sequence checking even for multi\-channel connections as well as durable handles\&.
12770 .sp
12771 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\&.
12772 .sp
12773 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]\&.
12774 .sp
12775 By default Samba behaves according to the specification and implements lock sequence checking when multi\-channel is used\&.
12776 .sp
12777 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\&.
12778 .sp
12779 Note: it\*(Aqs likely that this option will be removed again if future Windows versions change their behavior\&.
12780 .sp
12781 Note: Samba does not implement Open\&.IsResilient and Open\&.IsPersistent yet\&.
12782 .sp
12783 Default:
12784 \fI\fIsmb2 disable lock sequence checking\fR\fR\fI = \fR\fIno\fR\fI \fR
12785 .sp
12786 Example:
12787 \fI\fIsmb2 disable lock sequence checking\fR\fR\fI = \fR\fIyes\fR\fI \fR
12788 .RE
12789
12790 smb2 disable oplock break retry (G)
12791 .PP
12792 .RS 4
12793 This boolean parameter controls whether
12794 \fBsmbd\fR(8)
12795 will trigger smb2 oplock break notification retries when using
12796 \m[blue]\fBserver multi channel support = yes\fR\m[]\&.
12797 .sp
12798 The [MS\-SMB2] specification documents that a server should send smb2 oplock break notification retries on all available channel to the given client\&.
12799 .sp
12800 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]\&.
12801 .sp
12802 By default Samba behaves according to the specification and send smb2 oplock break notification retries\&.
12803 .sp
12804 Warning: Only enable this option if existing clients can\*(Aqt handle possible retries and it turns out that the Windows Server behavior is required\&.
12805 .sp
12806 Note: it\*(Aqs likely that this option gets removed again if future Windows versions change their behavior\&.
12807 .sp
12808 Note: this only applies to oplocks and not SMB2 leases\&.
12809 .sp
12810 Default:
12811 \fI\fIsmb2 disable oplock break retry\fR\fR\fI = \fR\fIno\fR\fI \fR
12812 .sp
12813 Example:
12814 \fI\fIsmb2 disable oplock break retry\fR\fR\fI = \fR\fIyes\fR\fI \fR
12815 .RE
12816
12817 smb2 leases (G)
12818 .PP
12819 .RS 4
12820 This boolean option tells
12821 smbd
12822 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\&.
12823 .sp
12824 This is only available with
12825 \m[blue]\fBoplocks = yes\fR\m[]
12826 and
12827 \m[blue]\fBkernel oplocks = no\fR\m[]\&.
12828 .sp
12829 Default:
12830 \fI\fIsmb2 leases\fR\fR\fI = \fR\fIyes\fR\fI \fR
12831 .RE
12832
12833 smb2 max credits (G)
12834 .PP
12835 .RS 4
12836 This option controls the maximum number of outstanding simultaneous SMB2 operations that Samba tells the client it will allow\&. This is similar to the
12837 \m[blue]\fBmax mux\fR\m[]
12838 parameter for SMB1\&. You should never need to set this parameter\&.
12839 .sp
12840 The default is 8192 credits, which is the same as a Windows 2008R2 SMB2 server\&.
12841 .sp
12842 Default:
12843 \fI\fIsmb2 max credits\fR\fR\fI = \fR\fI8192\fR\fI \fR
12844 .RE
12845
12846 smb2 max read (G)
12847 .PP
12848 .RS 4
12849 This option specifies the protocol value that
12850 \fBsmbd\fR(8)
12851 will return to a client, informing the client of the largest size that may be returned by a single SMB2 read call\&.
12852 .sp
12853 The maximum is 8388608 bytes (8MiB), which is the same as a Windows Server 2012 r2\&.
12854 .sp
12855 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)\&.
12856 .sp
12857 Default:
12858 \fI\fIsmb2 max read\fR\fR\fI = \fR\fI8388608\fR\fI \fR
12859 .RE
12860
12861 smb2 max trans (G)
12862 .PP
12863 .RS 4
12864 This option specifies the protocol value that
12865 \fBsmbd\fR(8)
12866 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\&.
12867 .sp
12868 The maximum is 8388608 bytes (8MiB), which is the same as a Windows Server 2012 r2\&.
12869 .sp
12870 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)\&.
12871 .sp
12872 Default:
12873 \fI\fIsmb2 max trans\fR\fR\fI = \fR\fI8388608\fR\fI \fR
12874 .RE
12875
12876 smb2 max write (G)
12877 .PP
12878 .RS 4
12879 This option specifies the protocol value that
12880 \fBsmbd\fR(8)
12881 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\&.
12882 .sp
12883 The maximum is 8388608 bytes (8MiB), which is the same as a Windows Server 2012 r2\&.
12884 .sp
12885 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)\&.
12886 .sp
12887 Default:
12888 \fI\fIsmb2 max write\fR\fR\fI = \fR\fI8388608\fR\fI \fR
12889 .RE
12890
12891 smb3 directory leases (G)
12892 .PP
12893 .RS 4
12894 This is an enumerated type that controls
12895 smbd
12896 whether SMB3 directory leases are enabled\&. Directory Leasing is an SMB3\-only feature which allows clients to cache directories\&.
12897 .sp
12898 Possible values for
12899 \m[blue]\fBsmb3 directory leases\fR\m[]
12900 are
12901 \fByes\fR,
12902 \fBno\fR
12903 and
12904 \fBauto\fR,
12905 \fBauto\fR
12906 being the default\&.
12907 .sp
12908 When set to
12909 \fBauto\fR, the effective value depends on the option
12910 \m[blue]\fBclustering\fR\m[]\&. If
12911 \m[blue]\fBclustering\fR\m[]
12912 is enabled,
12913 \m[blue]\fBsmb3 directory leases\fR\m[]
12914 are disabled and the other way around\&.
12915 .sp
12916 \m[blue]\fBsmb3 directory leases\fR\m[]
12917 are only available with
12918 \m[blue]\fBsmb2 leases = yes\fR\m[],
12919 \m[blue]\fBoplocks = yes\fR\m[]
12920 and
12921 \m[blue]\fBkernel oplocks = no\fR\m[]\&.
12922 .sp
12923 Enabling
12924 \m[blue]\fBsmb3 directory leases\fR\m[]
12925 implicitly enables
12926 \m[blue]\fBstrict rename\fR\m[]\&.
12927 .sp
12928 Default:
12929 \fI\fIsmb3 directory leases\fR\fR\fI = \fR\fIauto\fR\fI \fR
12930 .RE
12931
12932 smb3 share cap:CONTINUOUS AVAILABILITY (S)
12933 .PP
12934 .RS 4
12935 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)\&.
12936 .sp
12937 Note: this option only applies to disk shares\&.
12938 .sp
12939 In a ctdb cluster shares are continuously available, but windows clients mix this with the global persistent handles support\&.
12940 .sp
12941 Persistent handles are requested if SMB2_SHARE_CAP_CONTINUOUS_AVAILABILITY is present even without SMB2_CAP_PERSISTENT_HANDLES\&.
12942 .sp
12943 And SMB2_SHARE_CAP_CONTINUOUS_AVAILABILITY is required for SMB2_SHARE_CAP_CLUSTER to have an effect\&.
12944 .sp
12945 So we better don\*(Aqt announce this by default until we support persistent handles\&.
12946 .sp
12947 The
12948 \m[blue]\fBsmb3 share cap:CONTINUOUS AVAILABILITY\fR\m[]
12949 option can be used to force the announcement of SMB2_SHARE_CAP_CONTINUOUS_AVAILABILITY\&.
12950 .sp
12951 Warning: only use this if you know what you are doing!
12952 .sp
12953 .if n \{\
12954 .RS 4
12955 .\}
12956 .nf
12957 smb3 share cap:CONTINUOUS AVAILABILITY = yes
12958
12959 .fi
12960 .if n \{\
12961 .RE
12962 .\}
12963 .sp
12964 \fINo default\fR
12965 .RE
12966
12967 smb3 share cap:SCALE OUT (S)
12968 .PP
12969 .RS 4
12970 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\&.
12971 .sp
12972 Note: this option only applies to disk shares\&.
12973 .sp
12974 In a ctdb cluster we have multiple active nodes, so we announce SMB2_SHARE_CAP_SCALEOUT in a cluster\&.
12975 .sp
12976 The
12977 \m[blue]\fBsmb3 share cap:SCALE OUT\fR\m[]
12978 option can be used to disable the announcement of SMB2_SHARE_CAP_SCALEOUT, even if
12979 \m[blue]\fBclustering\fR\m[]
12980 is yes\&.
12981 .sp
12982 .if n \{\
12983 .RS 4
12984 .\}
12985 .nf
12986 clustering = yes
12987 smb3 share cap: SCALE OUT = no
12988
12989 .fi
12990 .if n \{\
12991 .RE
12992 .\}
12993 .sp
12994 \fINo default\fR
12995 .RE
12996
12997 smb3 share cap:CLUSTER (S)
12998 .PP
12999 .RS 4
13000 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\&.
13001 .sp
13002 Note: this option only applies to disk shares\&.
13003 .sp
13004 rpcd_witness is only active if
13005 \fBsamba-dcerpcd\fR(8)
13006 is not started as on demand helper and only in a ctdb cluster\&.
13007 .sp
13008 So we announce SMB2_SHARE_CAP_CLUSTER only if
13009 \m[blue]\fBclustering\fR\m[]
13010 is yes and
13011 \m[blue]\fBrpc start on demand helpers\fR\m[]
13012 is no\&.
13013 .sp
13014 The
13015 \m[blue]\fBsmb3 share cap:SCALE OUT\fR\m[]
13016 option can be used to control the announcement of SMB2_SHARE_CAP_CLUSTER independent of
13017 \m[blue]\fBclustering\fR\m[]
13018 and
13019 \m[blue]\fBrpc start on demand helpers\fR\m[]\&.
13020 .sp
13021 Example to disable the announcement of SMB2_SHARE_CAP_CLUSTER:
13022 .sp
13023 .if n \{\
13024 .RS 4
13025 .\}
13026 .nf
13027 clustering = yes
13028 rpc start on demand helpers = no
13029 smb3 share cap: CLUSTER = no
13030
13031 .fi
13032 .if n \{\
13033 .RE
13034 .\}
13035 .sp
13036 Example to force the announcement of SMB2_SHARE_CAP_CLUSTER:
13037 .sp
13038 .if n \{\
13039 .RS 4
13040 .\}
13041 .nf
13042 smb3 share cap: CLUSTER = yes
13043
13044 .fi
13045 .if n \{\
13046 .RE
13047 .\}
13048 .sp
13049 Example to let Windows clients use the witness service, see
13050 \m[blue]\fBsmb3 share cap:CONTINUOUS AVAILABILITY\fR\m[]
13051 option and USE AT YOUR OWN RISK!:
13052 .sp
13053 .if n \{\
13054 .RS 4
13055 .\}
13056 .nf
13057 clustering = yes
13058 rpc start on demand helpers = no
13059 # This is the default with the above:
13060 # smb3 share cap: CLUSTER = yes
13061 #
13062 # Use at you own risk!
13063 smb3 share cap: CONTINUOUS AVAILABILITY = yes
13064
13065 .fi
13066 .if n \{\
13067 .RE
13068 .\}
13069 .sp
13070 \fINo default\fR
13071 .RE
13072
13073 smb3 share cap:ASYMMETRIC (S)
13074 .PP
13075 .RS 4
13076 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
13077 net witness share\-move
13078 can be used to control the node usage\&.
13079 .sp
13080 Note: this option only applies to disk shares\&.
13081 .sp
13082 Shares in a ctdb cluster are symmetric by design, so we don\*(Aqt announce SMB2_SHARE_CAP_ASYMMETRIC by default\&.
13083 .sp
13084 The
13085 \m[blue]\fBsmb3 share cap:ASYMMETRIC\fR\m[]
13086 option can be used to force the announcement of SMB2_SHARE_CAP_ASYMMETRIC\&.
13087 .sp
13088 Example to force the announcement of SMB2_SHARE_CAP_ASYMMETRIC:
13089 .sp
13090 .if n \{\
13091 .RS 4
13092 .\}
13093 .nf
13094 smb3 share cap: ASYMMETRIC = yes
13095
13096 .fi
13097 .if n \{\
13098 .RE
13099 .\}
13100 .sp
13101 Example to let Windows clients use the witness service, see
13102 \m[blue]\fBsmb3 share cap:CONTINUOUS AVAILABILITY\fR\m[]
13103 option and USE AT YOUR OWN RISK!:
13104 .sp
13105 .if n \{\
13106 .RS 4
13107 .\}
13108 .nf
13109 clustering = yes
13110 rpc start on demand helpers = no
13111 # This is the default with the above:
13112 # smb3 share cap: CLUSTER = yes
13113 #
13114 # Use at you own risk!
13115 smb3 share cap: CONTINUOUS AVAILABILITY = yes
13116 smb3 share cap: ASYMMETRIC = yes
13117
13118 .fi
13119 .if n \{\
13120 .RE
13121 .\}
13122 .sp
13123 \fINo default\fR
13124 .RE
13125
13126 smb3 unix extensions (S)
13127 .PP
13128 .RS 4
13129 Support for SMB 3\&.1\&.1 Unix Extensions\&.
13130 .sp
13131 Default:
13132 \fI\fIsmb3 unix extensions\fR\fR\fI = \fR\fIyes\fR\fI \fR
13133 .RE
13134
13135 smbd async dosmode (S)
13136 .PP
13137 .RS 4
13138 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\&.
13139 .sp
13140 Default:
13141 \fI\fIsmbd async dosmode\fR\fR\fI = \fR\fIno\fR\fI \fR
13142 .RE
13143
13144 smbd getinfo ask sharemode (S)
13145 .PP
13146 .RS 4
13147 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\&.
13148 .sp
13149 Default:
13150 \fI\fIsmbd getinfo ask sharemode\fR\fR\fI = \fR\fIyes\fR\fI \fR
13151 .RE
13152
13153 smbd max async dosmode (S)
13154 .PP
13155 .RS 4
13156 This parameter controls how many async operations to fetch the DOS attributes the fileserver will queue when doing directory listings\&.
13157 .sp
13158 Default:
13159 \fI\fIsmbd max async dosmode\fR\fR\fI = \fR\fIaio max threads * 2\fR\fI \fR
13160 .RE
13161
13162 smbd max xattr size (S)
13163 .PP
13164 .RS 4
13165 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\&.
13166 .sp
13167 Default:
13168 \fI\fIsmbd max xattr size\fR\fR\fI = \fR\fI65536\fR\fI \fR
13169 .RE
13170
13171 smbd profiling share (S)
13172 .PP
13173 .RS 4
13174 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
13175 \m[blue]\fBsmbd profiling level\fR\m[]
13176 is enabled\&.
13177 .sp
13178 Default:
13179 \fI\fIsmbd profiling share\fR\fR\fI = \fR\fIno\fR\fI \fR
13180 .RE
13181
13182 smbd profiling level (G)
13183 .PP
13184 .RS 4
13185 This parameter allows the administrator to enable profiling support\&.
13186 .sp
13187 Possible values are
13188 \fBoff\fR,
13189 \fBcount\fR
13190 and
13191 \fBon\fR\&.
13192 .sp
13193 Default:
13194 \fI\fIsmbd profiling level\fR\fR\fI = \fR\fIoff\fR\fI \fR
13195 .sp
13196 Example:
13197 \fI\fIsmbd profiling level\fR\fR\fI = \fR\fIon\fR\fI \fR
13198 .RE
13199
13200 smbd search ask sharemode (S)
13201 .PP
13202 .RS 4
13203 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\&.
13204 .sp
13205 Default:
13206 \fI\fIsmbd search ask sharemode\fR\fR\fI = \fR\fIyes\fR\fI \fR
13207 .RE
13208
13209 smb encrypt (S)
13210 .PP
13211 .RS 4
13212 This is a synonym for
13213 \m[blue]\fBserver smb encrypt\fR\m[]\&.
13214 .sp
13215 Default:
13216 \fI\fIsmb encrypt\fR\fR\fI = \fR\fIdefault\fR\fI \fR
13217 .RE
13218
13219 smb passwd file (G)
13220 .PP
13221 .RS 4
13222 This option sets the path to the encrypted smbpasswd file\&. By default the path to the smbpasswd file is compiled into Samba\&.
13223 .sp
13224 An example of use is:
13225 .sp
13226 .if n \{\
13227 .RS 4
13228 .\}
13229 .nf
13230 smb passwd file = /etc/samba/smbpasswd
13231 .fi
13232 .if n \{\
13233 .RE
13234 .\}
13235 .sp
13236 Default:
13237 \fI\fIsmb passwd file\fR\fR\fI = \fR\fI/var/lib/samba/private/smbpasswd\fR\fI \fR
13238 .RE
13239
13240 socket options (G)
13241 .PP
13242 .RS 4
13243 .if n \{\
13244 .sp
13245 .\}
13246 .RS 4
13247 .it 1 an-trap
13248 .nr an-no-space-flag 1
13249 .nr an-break-flag 1
13250 .br
13251 .ps +1
13252 \fBWarning\fR
13253 .ps -1
13254 .br
13255 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\&.
13256 .sp
13257 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
13258 \fItest\fR
13259 the effect before making any large changes\&.
13260 .sp .5v
13261 .RE
13262 .sp
13263 This option allows you to set socket options to be used when talking with the client\&.
13264 .sp
13265 Socket options are controls on the networking layer of the operating systems which allow the connection to be tuned\&.
13266 .sp
13267 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
13268 man setsockopt
13269 will help)\&.
13270 .sp
13271 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
13272 samba\-technical@lists\&.samba\&.org\&.
13273 .sp
13274 Any of the supported socket options may be combined in any way you like, as long as your OS allows it\&.
13275 .sp
13276 This is the list of socket options currently settable using this option:
13277 .RS
13278 .sp
13279 .RS 4
13280 .ie n \{\
13281 \h'-04'\(bu\h'+03'\c
13282 .\}
13283 .el \{\
13284 .sp -1
13285 .IP \(bu 2.3
13286 .\}
13287 SO_KEEPALIVE
13288 .RE
13289 .sp
13290 .RS 4
13291 .ie n \{\
13292 \h'-04'\(bu\h'+03'\c
13293 .\}
13294 .el \{\
13295 .sp -1
13296 .IP \(bu 2.3
13297 .\}
13298 SO_REUSEADDR
13299 .RE
13300 .sp
13301 .RS 4
13302 .ie n \{\
13303 \h'-04'\(bu\h'+03'\c
13304 .\}
13305 .el \{\
13306 .sp -1
13307 .IP \(bu 2.3
13308 .\}
13309 SO_BROADCAST
13310 .RE
13311 .sp
13312 .RS 4
13313 .ie n \{\
13314 \h'-04'\(bu\h'+03'\c
13315 .\}
13316 .el \{\
13317 .sp -1
13318 .IP \(bu 2.3
13319 .\}
13320 TCP_NODELAY
13321 .RE
13322 .sp
13323 .RS 4
13324 .ie n \{\
13325 \h'-04'\(bu\h'+03'\c
13326 .\}
13327 .el \{\
13328 .sp -1
13329 .IP \(bu 2.3
13330 .\}
13331 TCP_KEEPCNT *
13332 .RE
13333 .sp
13334 .RS 4
13335 .ie n \{\
13336 \h'-04'\(bu\h'+03'\c
13337 .\}
13338 .el \{\
13339 .sp -1
13340 .IP \(bu 2.3
13341 .\}
13342 TCP_KEEPIDLE *
13343 .RE
13344 .sp
13345 .RS 4
13346 .ie n \{\
13347 \h'-04'\(bu\h'+03'\c
13348 .\}
13349 .el \{\
13350 .sp -1
13351 .IP \(bu 2.3
13352 .\}
13353 TCP_KEEPINTVL *
13354 .RE
13355 .sp
13356 .RS 4
13357 .ie n \{\
13358 \h'-04'\(bu\h'+03'\c
13359 .\}
13360 .el \{\
13361 .sp -1
13362 .IP \(bu 2.3
13363 .\}
13364 IPTOS_LOWDELAY
13365 .RE
13366 .sp
13367 .RS 4
13368 .ie n \{\
13369 \h'-04'\(bu\h'+03'\c
13370 .\}
13371 .el \{\
13372 .sp -1
13373 .IP \(bu 2.3
13374 .\}
13375 IPTOS_THROUGHPUT
13376 .RE
13377 .sp
13378 .RS 4
13379 .ie n \{\
13380 \h'-04'\(bu\h'+03'\c
13381 .\}
13382 .el \{\
13383 .sp -1
13384 .IP \(bu 2.3
13385 .\}
13386 SO_REUSEPORT
13387 .RE
13388 .sp
13389 .RS 4
13390 .ie n \{\
13391 \h'-04'\(bu\h'+03'\c
13392 .\}
13393 .el \{\
13394 .sp -1
13395 .IP \(bu 2.3
13396 .\}
13397 SO_SNDBUF *
13398 .RE
13399 .sp
13400 .RS 4
13401 .ie n \{\
13402 \h'-04'\(bu\h'+03'\c
13403 .\}
13404 .el \{\
13405 .sp -1
13406 .IP \(bu 2.3
13407 .\}
13408 SO_RCVBUF *
13409 .RE
13410 .sp
13411 .RS 4
13412 .ie n \{\
13413 \h'-04'\(bu\h'+03'\c
13414 .\}
13415 .el \{\
13416 .sp -1
13417 .IP \(bu 2.3
13418 .\}
13419 SO_SNDLOWAT *
13420 .RE
13421 .sp
13422 .RS 4
13423 .ie n \{\
13424 \h'-04'\(bu\h'+03'\c
13425 .\}
13426 .el \{\
13427 .sp -1
13428 .IP \(bu 2.3
13429 .\}
13430 SO_RCVLOWAT *
13431 .RE
13432 .sp
13433 .RS 4
13434 .ie n \{\
13435 \h'-04'\(bu\h'+03'\c
13436 .\}
13437 .el \{\
13438 .sp -1
13439 .IP \(bu 2.3
13440 .\}
13441 SO_SNDTIMEO *
13442 .RE
13443 .sp
13444 .RS 4
13445 .ie n \{\
13446 \h'-04'\(bu\h'+03'\c
13447 .\}
13448 .el \{\
13449 .sp -1
13450 .IP \(bu 2.3
13451 .\}
13452 SO_RCVTIMEO *
13453 .RE
13454 .sp
13455 .RS 4
13456 .ie n \{\
13457 \h'-04'\(bu\h'+03'\c
13458 .\}
13459 .el \{\
13460 .sp -1
13461 .IP \(bu 2.3
13462 .\}
13463 TCP_FASTACK *
13464 .RE
13465 .sp
13466 .RS 4
13467 .ie n \{\
13468 \h'-04'\(bu\h'+03'\c
13469 .\}
13470 .el \{\
13471 .sp -1
13472 .IP \(bu 2.3
13473 .\}
13474 TCP_QUICKACK
13475 .RE
13476 .sp
13477 .RS 4
13478 .ie n \{\
13479 \h'-04'\(bu\h'+03'\c
13480 .\}
13481 .el \{\
13482 .sp -1
13483 .IP \(bu 2.3
13484 .\}
13485 TCP_NODELAYACK
13486 .RE
13487 .sp
13488 .RS 4
13489 .ie n \{\
13490 \h'-04'\(bu\h'+03'\c
13491 .\}
13492 .el \{\
13493 .sp -1
13494 .IP \(bu 2.3
13495 .\}
13496 TCP_KEEPALIVE_THRESHOLD *
13497 .RE
13498 .sp
13499 .RS 4
13500 .ie n \{\
13501 \h'-04'\(bu\h'+03'\c
13502 .\}
13503 .el \{\
13504 .sp -1
13505 .IP \(bu 2.3
13506 .\}
13507 TCP_KEEPALIVE_ABORT_THRESHOLD *
13508 .RE
13509 .sp
13510 .RS 4
13511 .ie n \{\
13512 \h'-04'\(bu\h'+03'\c
13513 .\}
13514 .el \{\
13515 .sp -1
13516 .IP \(bu 2.3
13517 .\}
13518 TCP_DEFER_ACCEPT *
13519 .RE
13520 .sp
13521 .RS 4
13522 .ie n \{\
13523 \h'-04'\(bu\h'+03'\c
13524 .\}
13525 .el \{\
13526 .sp -1
13527 .IP \(bu 2.3
13528 .\}
13529 TCP_USER_TIMEOUT *
13530 .RE
13531 .sp
13532 .RE
13533 Those marked with a
13534 \fI\*(Aq*\*(Aq\fR
13535 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\&.
13536 .sp
13537 To specify an argument use the syntax SOME_OPTION = VALUE for example
13538 SO_SNDBUF = 8192\&. Note that you must not have any spaces before or after the = sign\&.
13539 .sp
13540 If you are on a local network then a sensible option might be:
13541 .sp
13542 socket options = IPTOS_LOWDELAY
13543 .sp
13544 If you have a local network then you could try:
13545 .sp
13546 socket options = IPTOS_LOWDELAY TCP_NODELAY
13547 .sp
13548 If you are on a wide area network then perhaps try setting IPTOS_THROUGHPUT\&.
13549 .sp
13550 Note that several of the options may cause your Samba server to fail completely\&. Use these options with caution!
13551 .sp
13552 Default:
13553 \fI\fIsocket options\fR\fR\fI = \fR\fITCP_NODELAY\fR\fI \fR
13554 .sp
13555 Example:
13556 \fI\fIsocket options\fR\fR\fI = \fR\fIIPTOS_LOWDELAY\fR\fI \fR
13557 .RE
13558
13559 spn update command (G)
13560 .PP
13561 .RS 4
13562 This option sets the command that for updating servicePrincipalName names from
13563 spn_update_list\&.
13564 .sp
13565 Default:
13566 \fI\fIspn update command\fR\fR\fI = \fR\fI/home/iurt/rpmbuild/BUILD/samba\-4\&.23\&.8\-build/samba\-4\&.23\&.8/source4/scripting/bin/samba_spnupdate\fR\fI \fR
13567 .sp
13568 Example:
13569 \fI\fIspn update command\fR\fR\fI = \fR\fI/usr/local/sbin/spnupdate\fR\fI \fR
13570 .RE
13571
13572 spoolss: architecture (G)
13573 .PP
13574 .RS 4
13575 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\&.
13576 .sp
13577 Default:
13578 \fI\fIspoolss: architecture\fR\fR\fI = \fR\fIWindows x64\fR\fI \fR
13579 .sp
13580 Example:
13581 \fI\fIspoolss: architecture\fR\fR\fI = \fR\fIWindows NT x86\fR\fI \fR
13582 .RE
13583
13584 spoolss: os_major (G)
13585 .PP
13586 .RS 4
13587 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)\&.
13588 .sp
13589 Default:
13590 \fI\fIspoolss: os_major\fR\fR\fI = \fR\fI5\fR\fI \fR
13591 .sp
13592 Example:
13593 \fI\fIspoolss: os_major\fR\fR\fI = \fR\fI6\fR\fI \fR
13594 .RE
13595
13596 spoolss: os_minor (G)
13597 .PP
13598 .RS 4
13599 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)\&.
13600 .sp
13601 Default:
13602 \fI\fIspoolss: os_minor\fR\fR\fI = \fR\fI0\fR\fI \fR
13603 .sp
13604 Example:
13605 \fI\fIspoolss: os_minor\fR\fR\fI = \fR\fI1\fR\fI \fR
13606 .RE
13607
13608 spoolss: os_build (G)
13609 .PP
13610 .RS 4
13611 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)\&.
13612 .sp
13613 Default:
13614 \fI\fIspoolss: os_build\fR\fR\fI = \fR\fI2195\fR\fI \fR
13615 .sp
13616 Example:
13617 \fI\fIspoolss: os_build\fR\fR\fI = \fR\fI7601\fR\fI \fR
13618 .RE
13619
13620 spoolss_client: os_major (G)
13621 .PP
13622 .RS 4
13623 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)\&.
13624 .sp
13625 Default:
13626 \fI\fIspoolss_client: os_major\fR\fR\fI = \fR\fI6\fR\fI \fR
13627 .RE
13628
13629 spoolss_client: os_minor (G)
13630 .PP
13631 .RS 4
13632 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)\&.
13633 .sp
13634 Default:
13635 \fI\fIspoolss_client: os_minor\fR\fR\fI = \fR\fI1\fR\fI \fR
13636 .RE
13637
13638 spoolss_client: os_build (G)
13639 .PP
13640 .RS 4
13641 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)\&.
13642 .sp
13643 Default:
13644 \fI\fIspoolss_client: os_build\fR\fR\fI = \fR\fI7007\fR\fI \fR
13645 .RE
13646
13647 spotlight (S)
13648 .PP
13649 .RS 4
13650 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\&.
13651 .sp
13652 Spotlight has several prerequisites:
13653 .RS
13654 .sp
13655 .RS 4
13656 .ie n \{\
13657 \h'-04'\(bu\h'+03'\c
13658 .\}
13659 .el \{\
13660 .sp -1
13661 .IP \(bu 2.3
13662 .\}
13663 Samba must be configured and built with Spotlight support\&.
13664 .RE
13665 .sp
13666 .RS 4
13667 .ie n \{\
13668 \h'-04'\(bu\h'+03'\c
13669 .\}
13670 .el \{\
13671 .sp -1
13672 .IP \(bu 2.3
13673 .\}
13674 Tracker integration must be setup and the share must be indexed by Tracker\&.
13675 .RE
13676 .sp
13677 .RE
13678 For a detailed set of instructions please see
13679 https://wiki\&.samba\&.org/index\&.php/Spotlight\&.
13680 .sp
13681 Default:
13682 \fI\fIspotlight\fR\fR\fI = \fR\fIno\fR\fI \fR
13683 .RE
13684
13685 spotlight backend (S)
13686 .PP
13687 .RS 4
13688 Spotlight search backend\&. Available backends:
13689 .RS
13690 .sp
13691 .RS 4
13692 .ie n \{\
13693 \h'-04'\(bu\h'+03'\c
13694 .\}
13695 .el \{\
13696 .sp -1
13697 .IP \(bu 2.3
13698 .\}
13699 \fBnoindex\fR
13700 \- a backend that returns no results\&.
13701 .RE
13702 .sp
13703 .RE
13704 .RS
13705 .sp
13706 .RS 4
13707 .ie n \{\
13708 \h'-04'\(bu\h'+03'\c
13709 .\}
13710 .el \{\
13711 .sp -1
13712 .IP \(bu 2.3
13713 .\}
13714 \fBtracker\fR
13715 \- Gnome Tracker\&.
13716 .RE
13717 .sp
13718 .RS 4
13719 .ie n \{\
13720 \h'-04'\(bu\h'+03'\c
13721 .\}
13722 .el \{\
13723 .sp -1
13724 .IP \(bu 2.3
13725 .\}
13726 \fBelasticsearch\fR
13727 \- a backend that uses JSON and REST over HTTP(s) to query an Elasticsearch server\&.
13728 .RE
13729 .sp
13730 .RE
13731 .sp
13732 Default:
13733 \fI\fIspotlight backend\fR\fR\fI = \fR\fInoindex\fR\fI \fR
13734 .RE
13735
13736 stat cache (G)
13737 .PP
13738 .RS 4
13739 This parameter determines if
13740 \fBsmbd\fR(8)
13741 will use a cache in order to speed up case insensitive name mappings\&. You should never need to change this parameter\&.
13742 .sp
13743 Default:
13744 \fI\fIstat cache\fR\fR\fI = \fR\fIyes\fR\fI \fR
13745 .RE
13746
13747 state directory (G)
13748 .PP
13749 .RS 4
13750 Usually, most of the TDB files are stored in the
13751 \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
13752 \fIstate directory\fR
13753 and the
13754 \fIcache directory\fR
13755 options\&.
13756 .sp
13757 This option specifies the directory where TDB files containing important persistent data will be stored\&.
13758 .sp
13759 Default:
13760 \fI\fIstate directory\fR\fR\fI = \fR\fI/var/lib/samba\fR\fI \fR
13761 .sp
13762 Example:
13763 \fI\fIstate directory\fR\fR\fI = \fR\fI/var/run/samba/locks/state\fR\fI \fR
13764 .RE
13765
13766 store dos attributes (S)
13767 .PP
13768 .RS 4
13769 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
13770 \m[blue]\fBmap hidden\fR\m[]
13771 and
13772 \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
13773 \m[blue]\fBmap hidden\fR\m[],
13774 \m[blue]\fBmap system\fR\m[],
13775 \m[blue]\fBmap archive\fR\m[]
13776 and
13777 \m[blue]\fBmap readonly\fR\m[]
13778 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\&.
13779 .sp
13780 Default:
13781 \fI\fIstore dos attributes\fR\fR\fI = \fR\fIyes\fR\fI \fR
13782 .RE
13783
13784 strict allocate (S)
13785 .PP
13786 .RS 4
13787 This is a boolean that controls the handling of disk space allocation in the server\&. When this is set to
13788 \fByes\fR
13789 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\&.
13790 .sp
13791 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\&.
13792 .sp
13793 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\&.
13794 .sp
13795 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\&.
13796 .sp
13797 Default:
13798 \fI\fIstrict allocate\fR\fR\fI = \fR\fIno\fR\fI \fR
13799 .RE
13800
13801 strict locking (S)
13802 .PP
13803 .RS 4
13804 This is an enumerated type that controls the handling of file locking in the server\&. When this is set to
13805 \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\&.
13806 .sp
13807 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\&.
13808 .sp
13809 When strict locking is disabled, the server performs file lock checks only when the client explicitly asks for them\&.
13810 .sp
13811 Well\-behaved clients always ask for lock checks when it is important\&. So in the vast majority of cases,
13812 strict locking = Auto
13813 or
13814 strict locking = no
13815 is acceptable\&.
13816 .sp
13817 Default:
13818 \fI\fIstrict locking\fR\fR\fI = \fR\fIAuto\fR\fI \fR
13819 .RE
13820
13821 strict rename (S)
13822 .PP
13823 .RS 4
13824 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\&.
13825 .sp
13826 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\&.
13827 .sp
13828 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\&.
13829 .sp
13830 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\&.
13831 .sp
13832 If the client has requested UNIX extensions (POSIX pathnames) then renames are always allowed and this parameter has no effect\&.
13833 .sp
13834 Enabling
13835 \m[blue]\fBsmb3 directory leases\fR\m[]
13836 implicitly enables
13837 \m[blue]\fBstrict rename\fR\m[]\&.
13838 .sp
13839 Default:
13840 \fI\fIstrict rename\fR\fR\fI = \fR\fIno\fR\fI \fR
13841 .RE
13842
13843 strict sync (S)
13844 .PP
13845 .RS 4
13846 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
13847 \fByes\fR, which is the default, then Windows applications can force the smbd server to synchronize unwritten data onto the disk\&. If set to
13848 \fBno\fR
13849 then smbd will ignore client requests to synchronize unwritten data onto stable storage on disk\&.
13850 .sp
13851 In Samba 4\&.7\&.0, the default for this parameter changed from
13852 \fBno\fR
13853 to
13854 \fByes\fR
13855 to better match the expectations of SMB2/3 clients and improve application safety when running against smbd\&.
13856 .sp
13857 The flush request from SMB2/3 clients is handled asynchronously inside smbd, so leaving the parameter as the default value of
13858 \fByes\fR
13859 does not block the processing of other requests to the smbd process\&.
13860 .sp
13861 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
13862 \fBno\fR
13863 means that
13864 \fBsmbd\fR(8)
13865 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\&.
13866 .sp
13867 Default:
13868 \fI\fIstrict sync\fR\fR\fI = \fR\fIyes\fR\fI \fR
13869 .RE
13870
13871 svcctl list (G)
13872 .PP
13873 .RS 4
13874 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\&.
13875 .sp
13876 The administrator must create a directory name
13877 svcctl
13878 in Samba\*(Aqs $(libdir) and create symbolic links to the init scripts in
13879 /etc/init\&.d/\&. The name of the links must match the names given as part of the
13880 \fIsvcctl list\fR\&.
13881 .sp
13882 Default:
13883 \fI\fIsvcctl list\fR\fR\fI = \fR\fI\fR\fI \fR
13884 .sp
13885 Example:
13886 \fI\fIsvcctl list\fR\fR\fI = \fR\fIcups postfix portmap httpd\fR\fI \fR
13887 .RE
13888
13889 sync always (S)
13890 .PP
13891 .RS 4
13892 This is a boolean parameter that controls whether writes will always be written to stable storage before the write call returns\&. If this is
13893 \fBno\fR
13894 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
13895 \fByes\fR
13896 then every write will be followed by a
13897 fsync()
13898 call to ensure the data is written to disk\&. Note that the
13899 \fIstrict sync\fR
13900 parameter must be set to
13901 \fByes\fR
13902 in order for this parameter to have any effect\&.
13903 .sp
13904 Default:
13905 \fI\fIsync always\fR\fR\fI = \fR\fIno\fR\fI \fR
13906 .RE
13907
13908 sync machine password script (G)
13909 .PP
13910 .RS 4
13911 This is the full pathname to a script that will be run by
13912 \fBwinbindd\fR(8)
13913 when a machine account password is updated\&.
13914 .sp
13915 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
13916 \fB46\&.update\-keytabs\&.script\fR
13917 in ctdb, it re\-creates the keytab during the ctdb recovered event:
13918 .sp
13919 .if n \{\
13920 .RS 4
13921 .\}
13922 .nf
13923 onnode all ctdb event script enable legacy 46\&.update\-keytabs\&.script
13924
13925 .fi
13926 .if n \{\
13927 .RE
13928 .\}
13929 .sp
13930 Default:
13931 \fI\fIsync machine password script\fR\fR\fI = \fR\fI\fR\fI \fR
13932 .sp
13933 Example:
13934 \fI\fIsync machine password script\fR\fR\fI = \fR\fI/usr/share/ctdb/scripts/winbind_ctdb_updatekeytab\&.sh\fR\fI \fR
13935 .RE
13936
13937 sync machine password to keytab (G)
13938 .PP
13939 .RS 4
13940 This option allows you to describe what keytabs and how should be updated when machine account is changed via one of these commands
13941 .sp
13942 .if n \{\
13943 .RS 4
13944 .\}
13945 .nf
13946 wbinfo \-\-change\-secret
13947 rpcclient \-\-machine\-pass \-c change_trust_pw
13948 net rpc changetrustpw
13949 net ads changetrustpw
13950 .fi
13951 .if n \{\
13952 .RE
13953 .\}
13954 .sp
13955 or by winbindd doing regular updates (see
13956 \m[blue]\fBmachine password timeout\fR\m[])
13957 .sp
13958 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:
13959 .sp
13960 .if n \{\
13961 .RS 4
13962 .\}
13963 .nf
13964 absolute_path_to_keytab:spn_spec[:spn_spec]*[:sync_etypes][:sync_kvno][:netbios_aliases][:additional_dns_hostnames][:machine_password]
13965 .fi
13966 .if n \{\
13967 .RE
13968 .\}
13969 .sp
13970 spn_spec can be specified multiple times (separated using \*(Aq:\*(Aq) and each spn_spec can have exactly one of these forms:
13971 .sp
13972 .if n \{\
13973 .RS 4
13974 .\}
13975 .nf
13976 account_name
13977 sync_account_name
13978 sync_upn
13979 sync_spns
13980 spn_prefixes=value1[,value2[\&.\&.\&.]]
13981 spns=value1[,value2[\&.\&.\&.]]
13982 .fi
13983 .if n \{\
13984 .RE
13985 .\}
13986 .sp
13987 Every keytab contains principals according the specification below:
13988 .sp
13989 .if n \{\
13990 .RS 4
13991 .\}
13992 .nf
13993 account_name \- COMPUTER$@REALM
13994 sync_account_name \- uses attribute "sAMAccountName" from AD
13995 sync_upn \- uses attribute "userPrincipalName" (if exists in AD)
13996 sync_spns \- uses attribute "servicePrincipalName" (if exists in AD)
13997 spn_prefixes \- creates these two principals from each prefix\&. e\&.g\&.:
13998 prefix/\m[blue]\fBnetbios name\fR\m[]@REALM
13999 prefix/\m[blue]\fBdns hostname\fR\m[]@REALM
14000 with :netbios_aliases for each netbiosalias in \m[blue]\fBnetbios aliases\fR\m[]
14001 prefix/netbiosalias@REALM
14002 prefix/netbiosalias\&.dnsdomain@REALM
14003 with :additional_dns_hostnames for each additionaldnshostname in \m[blue]\fBadditional dns hostnames\fR\m[]
14004 prefix/additionaldnshostname@REALM
14005 \- \*(Aqhost\*(Aq principal should be created using specifier spn_prefixes
14006 spns \- creates only the principals defined in the list
14007 .fi
14008 .if n \{\
14009 .RE
14010 .\}
14011 .sp
14012 \*(Aqaccount_name\*(Aq and \*(Aqsync_account_name\*(Aq are the same, just the source differs (secrets\&.tdb vs\&. AD)\&.
14013 .sp
14014 Options:
14015 .sp
14016 .if n \{\
14017 .RS 4
14018 .\}
14019 .nf
14020 sync_etypes \- attribute "msDS\-SupportedEncryptionTypes" is read from AD and is used to find the highest common enc type for AD and KRB5 lib\&.
14021 sync_kvno \- attribute "msDS\-KeyVersionNumber" from AD is used to set KVNO\&. If this option is missing, KVNO is set to \-1\&.
14022 netbios_aliases \- evaluated only for spn_prefixes (see details above)\&.
14023 additional_dns_hostnames \- evaluated only for spn_prefixes (see details above)\&.
14024 machine_password \- mandatory, if missing the entry is ignored\&. For future use\&.
14025 .fi
14026 .if n \{\
14027 .RE
14028 .\}
14029 .sp
14030 Example:
14031 .sp
14032 .if n \{\
14033 .RS 4
14034 .\}
14035 .nf
14036 "/path/to/keytab0:account_name:machine_password",
14037 "/path/to/keytab1:account_name:sync_etypes:sync_kvno:machine_password",
14038 "/path/to/keytab2:sync_spns:machine_password",
14039 "/path/to/keytab3:sync_spns:sync_kvno:machine_password",
14040 "/path/to/keytab4:spn_prefixes=imap,smtp:machine_password",
14041 "/path/to/keytab5:spn_prefixes=imap,smtp:netbios_aliases:additional_dns_hostnames:sync_kvno:machine_password",
14042 "/path/to/keytab6:spns=wurst/brot@REALM:machine_password",
14043 "/path/to/keytab7:spns=wurst/brot@REALM,wurst2/brot@REALM:sync_kvno:machine_password",
14044 "/path/to/keytab8:sync_account_name:sync_upn:sync_spns:spn_prefixes=host,cifs,http:spns=wurst/brot@REALM:sync_kvno:machine_password"
14045 .fi
14046 .if n \{\
14047 .RE
14048 .\}
14049 .sp
14050 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\&.
14051 .sp
14052 If no value is present and
14053 \m[blue]\fBkerberos method\fR\m[]
14054 is different from \*(Aqsecrets only\*(Aq, the behavior differs between winbind and net utility:
14055 .RS
14056 .sp
14057 .RS 4
14058 .ie n \{\
14059 \h'-04'\(bu\h'+03'\c
14060 .\}
14061 .el \{\
14062 .sp -1
14063 .IP \(bu 2.3
14064 .\}
14065 \fBwinbind\fR
14066 uses value
14067 .sp
14068 .if n \{\
14069 .RS 4
14070 .\}
14071 .nf
14072 /path/to/keytab:host:account_name:sync_spns:sync_kvno:machine_password
14073 .fi
14074 .if n \{\
14075 .RE
14076 .\}
14077 .sp
14078 where the path to the keytab is obtained either from the krb5 library or from
14079 \m[blue]\fBdedicated keytab file\fR\m[]\&.
14080 .RE
14081 .sp
14082 .RS 4
14083 .ie n \{\
14084 \h'-04'\(bu\h'+03'\c
14085 .\}
14086 .el \{\
14087 .sp -1
14088 .IP \(bu 2.3
14089 .\}
14090 \fBnet changesecretpw \-f\fR
14091 command uses the default \*(Aqdisabled\*(Aq value\&.
14092 .RE
14093 .sp
14094 .RS 4
14095 .ie n \{\
14096 \h'-04'\(bu\h'+03'\c
14097 .\}
14098 .el \{\
14099 .sp -1
14100 .IP \(bu 2.3
14101 .\}
14102 No other
14103 \fBnet\fR
14104 subcommands use the \*(Aqdisabled\*(Aq value\&.
14105 .RE
14106 .sp
14107 .RE
14108 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\&.
14109 .sp
14110 Suggested configuration is together with
14111 \m[blue]\fBkerberos method\fR\m[]
14112 set to the default value \*(Aqsecrets only\*(Aq\&.
14113 .sp
14114 In clustered environments it is recommended to set
14115 \m[blue]\fBsync machine password script\fR\m[]
14116 to update the machine password on all nodes\&.
14117 .sp
14118 \fINo default\fR
14119 .RE
14120
14121 syslog (G)
14122 .PP
14123 .RS 4
14124 This parameter maps how Samba debug messages are logged onto the system syslog logging levels\&. Samba debug level zero maps onto syslog
14125 \fBLOG_ERR\fR, debug level one maps onto
14126 \fBLOG_WARNING\fR, debug level two maps onto
14127 \fBLOG_NOTICE\fR, debug level three maps onto LOG_INFO\&. All higher levels are mapped to
14128 \fBLOG_DEBUG\fR\&.
14129 .sp
14130 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
14131 \fIsyslog only\fR
14132 is enabled\&.
14133 .sp
14134 The
14135 \m[blue]\fBlogging\fR\m[]
14136 parameter should be used instead\&. When
14137 \m[blue]\fBlogging\fR\m[]
14138 is set, it overrides the
14139 \m[blue]\fBsyslog\fR\m[]
14140 parameter\&.
14141 .sp
14142 Default:
14143 \fI\fIsyslog\fR\fR\fI = \fR\fI1\fR\fI \fR
14144 .RE
14145
14146 syslog only (G)
14147 .PP
14148 .RS 4
14149 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
14150 \fIsyslog only\fR
14151 is enabled\&.
14152 .sp
14153 The
14154 \m[blue]\fBlogging\fR\m[]
14155 parameter should be used instead\&. When
14156 \m[blue]\fBlogging\fR\m[]
14157 is set, it overrides the
14158 \m[blue]\fBsyslog only\fR\m[]
14159 parameter\&.
14160 .sp
14161 Default:
14162 \fI\fIsyslog only\fR\fR\fI = \fR\fIno\fR\fI \fR
14163 .RE
14164
14165 template homedir (G)
14166 .PP
14167 .RS 4
14168 When filling out the user information for a Windows NT user, the
14169 \fBwinbindd\fR(8)
14170 daemon uses this parameter to fill in the home directory for that user\&. If the string
14171 \fI%D\fR
14172 is present it is substituted with the user\*(Aqs Windows NT domain name\&. If the string
14173 \fI%U\fR
14174 is present it is substituted with the user\*(Aqs Windows NT user name\&.
14175 .sp
14176 Default:
14177 \fI\fItemplate homedir\fR\fR\fI = \fR\fI/home/%D/%U\fR\fI \fR
14178 .RE
14179
14180 template shell (G)
14181 .PP
14182 .RS 4
14183 When filling out the user information for a Windows NT user, the
14184 \fBwinbindd\fR(8)
14185 daemon uses this parameter to fill in the login shell for that user\&.
14186 .sp
14187 Default:
14188 \fI\fItemplate shell\fR\fR\fI = \fR\fI/bin/false\fR\fI \fR
14189 .RE
14190
14191 time server (G)
14192 .PP
14193 .RS 4
14194 This parameter determines if
14195 \fBnmbd\fR(8)
14196 advertises itself as a time server to Windows clients\&.
14197 .sp
14198 Default:
14199 \fI\fItime server\fR\fR\fI = \fR\fIno\fR\fI \fR
14200 .RE
14201
14202 debug timestamp
14203 .PP
14204 .RS 4
14205 This parameter is a synonym for
14206 timestamp logs\&.
14207 .RE
14208
14209 timestamp logs (G)
14210 .PP
14211 .RS 4
14212 Samba debug log messages are timestamped by default\&. If you are running at a high
14213 \m[blue]\fBdebug level\fR\m[]
14214 these timestamps can be distracting\&. This boolean parameter allows timestamping to be turned off\&.
14215 .sp
14216 Default:
14217 \fI\fItimestamp logs\fR\fR\fI = \fR\fIyes\fR\fI \fR
14218 .RE
14219
14220 tls ca directories (G)
14221 .PP
14222 .RS 4
14223 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\&.
14224 .sp
14225 \fINo default\fR
14226 .RE
14227
14228 tls cafile (G)
14229 .PP
14230 .RS 4
14231 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\&.
14232 .sp
14233 This path is relative to
14234 \m[blue]\fBprivate dir\fR\m[]
14235 if the path does not start with a /\&.
14236 .sp
14237 Default:
14238 \fI\fItls cafile\fR\fR\fI = \fR\fItls/ca\&.pem\fR\fI \fR
14239 .RE
14240
14241 tls certfile (G)
14242 .PP
14243 .RS 4
14244 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\&.
14245 .sp
14246 This path is relative to
14247 \m[blue]\fBprivate dir\fR\m[]
14248 if the path does not start with a /\&.
14249 .sp
14250 Default:
14251 \fI\fItls certfile\fR\fR\fI = \fR\fItls/cert\&.pem\fR\fI \fR
14252 .RE
14253
14254 tls crlfile (G)
14255 .PP
14256 .RS 4
14257 This option can be set to a file containing a certificate revocation list (CRL)\&.
14258 .sp
14259 This path is relative to
14260 \m[blue]\fBprivate dir\fR\m[]
14261 if the path does not start with a /\&.
14262 .sp
14263 Default:
14264 \fI\fItls crlfile\fR\fR\fI = \fR\fI\fR\fI \fR
14265 .RE
14266
14267 tls dh params file (G)
14268 .PP
14269 .RS 4
14270 This option can be set to a file with Diffie\-Hellman parameters which will be used with DH ciphers\&.
14271 .sp
14272 This path is relative to
14273 \m[blue]\fBprivate dir\fR\m[]
14274 if the path does not start with a /\&.
14275 .sp
14276 Default:
14277 \fI\fItls dh params file\fR\fR\fI = \fR\fI\fR\fI \fR
14278 .RE
14279
14280 tls enabled (G)
14281 .PP
14282 .RS 4
14283 If this option is set to
14284 \fByes\fR, then Samba will use TLS when possible in communication\&.
14285 .sp
14286 Default:
14287 \fI\fItls enabled\fR\fR\fI = \fR\fIyes\fR\fI \fR
14288 .RE
14289
14290 tls keyfile (G)
14291 .PP
14292 .RS 4
14293 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\&.
14294 .sp
14295 This path is relative to
14296 \m[blue]\fBprivate dir\fR\m[]
14297 if the path does not start with a /\&.
14298 .sp
14299 Default:
14300 \fI\fItls keyfile\fR\fR\fI = \fR\fItls/key\&.pem\fR\fI \fR
14301 .RE
14302
14303 tls priority (G)
14304 .PP
14305 .RS 4
14306 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\&.
14307 .sp
14308 The string is appended to the default priority list of GnuTLS\&.
14309 .sp
14310 The valid options are described in the
14311 GNUTLS Priority\-Strings documentation at http://gnutls\&.org/manual/html_node/Priority\-Strings\&.html
14312 .sp
14313 The SSL3\&.0 protocol will be disabled\&.
14314 .sp
14315 Default:
14316 \fI\fItls priority\fR\fR\fI = \fR\fINORMAL:\-VERS\-SSL3\&.0\fR\fI \fR
14317 .RE
14318
14319 tls trust system cas (G)
14320 .PP
14321 .RS 4
14322 With this option the system\*(Aqs default trusted CAs are used to trust SSL/TLS connections\&.
14323 .sp
14324 Please use this with care, as it really means trusting all CAs installed on the system!
14325 .sp
14326 Default:
14327 \fI\fItls trust system cas\fR\fR\fI = \fR\fIno\fR\fI \fR
14328 .RE
14329
14330 tls verify peer (G)
14331 .PP
14332 .RS 4
14333 This controls if and how strict the client will verify the peer\*(Aqs certificate and name\&. Possible values are (in increasing order):
14334 \fBno_check\fR,
14335 \fBca_only\fR,
14336 \fBca_and_name_if_available\fR,
14337 \fBca_and_name\fR
14338 and
14339 \fBas_strict_as_possible\fR\&.
14340 .sp
14341 When set to
14342 \fBno_check\fR
14343 the certificate is not verified at all, which allows trivial man in the middle attacks\&.
14344 .sp
14345 When set to
14346 \fBca_only\fR
14347 the certificate is verified to be signed from a ca specified in the
14348 \m[blue]\fBtls ca file\fR\m[]
14349 option\&. As alternative
14350 \m[blue]\fBtls ca directories\fR\m[]
14351 or
14352 \m[blue]\fBtls trust system cas\fR\m[]
14353 can be used\&. Providing at least one valid CA certificate is required\&. The certificate lifetime is also verified\&. If the
14354 \m[blue]\fBtls crl file\fR\m[]
14355 option is configured, the certificate is also verified against the ca crl\&.
14356 .sp
14357 When set to
14358 \fBca_and_name_if_available\fR
14359 all checks from
14360 \fBca_only\fR
14361 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\&.
14362 .sp
14363 When set to
14364 \fBca_and_name\fR
14365 all checks from
14366 \fBca_and_name_if_available\fR
14367 are performed\&. In addition the peer hostname needs to be provided and even an ip address is checked against the certificate\*(Aqs name\&.
14368 .sp
14369 When set to
14370 \fBas_strict_as_possible\fR
14371 all checks from
14372 \fBca_and_name\fR
14373 are performed\&. In addition the
14374 \m[blue]\fBtls crl file\fR\m[]
14375 needs to be configured\&. Future versions of Samba may implement additional checks\&.
14376 .sp
14377 Default:
14378 \fI\fItls verify peer\fR\fR\fI = \fR\fIas_strict_as_possible\fR\fI \fR
14379 .RE
14380
14381 unicode (G)
14382 .PP
14383 .RS 4
14384 Specifies whether the server and client should support unicode\&.
14385 .sp
14386 If this option is set to false, the use of ASCII will be forced\&.
14387 .sp
14388 Default:
14389 \fI\fIunicode\fR\fR\fI = \fR\fIyes\fR\fI \fR
14390 .RE
14391
14392 unix charset (G)
14393 .PP
14394 .RS 4
14395 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\&.
14396 .sp
14397 This is also the charset Samba will use when specifying arguments to scripts that it invokes\&.
14398 .sp
14399 Default:
14400 \fI\fIunix charset\fR\fR\fI = \fR\fIUTF\-8\fR\fI \fR
14401 .sp
14402 Example:
14403 \fI\fIunix charset\fR\fR\fI = \fR\fIASCII\fR\fI \fR
14404 .RE
14405
14406 unix password sync (G)
14407 .PP
14408 .RS 4
14409 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
14410 \fByes\fR
14411 the program specified in the
14412 \fIpasswd program\fR
14413 parameter is called
14414 \fIAS ROOT\fR
14415 \- 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)\&.
14416 .sp
14417 This option has no effect if
14418 samba
14419 is running as an active directory domain controller, in that case have a look at the
14420 \m[blue]\fBpassword hash gpg key ids\fR\m[]
14421 option and the
14422 samba\-tool user syncpasswords
14423 command\&.
14424 .sp
14425 Default:
14426 \fI\fIunix password sync\fR\fR\fI = \fR\fIno\fR\fI \fR
14427 .RE
14428
14429 use client driver (S)
14430 .PP
14431 .RS 4
14432 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
14433 disable spoolss = yes\&.
14434 .sp
14435 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)\&.
14436 .sp
14437 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\&.
14438 \fIThis parameter MUST not be enabled on a print share which has valid print driver installed on the Samba server\&.\fR
14439 .sp
14440 Default:
14441 \fI\fIuse client driver\fR\fR\fI = \fR\fIno\fR\fI \fR
14442 .RE
14443
14444 use mmap (G)
14445 .PP
14446 .RS 4
14447 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
14448 \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\&.
14449 .sp
14450 Default:
14451 \fI\fIuse mmap\fR\fR\fI = \fR\fIyes\fR\fI \fR
14452 .RE
14453
14454 username level (G)
14455 .PP
14456 .RS 4
14457 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\&.
14458 .sp
14459 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
14460 \fBAstrangeUser \fR\&.
14461 .sp
14462 This parameter is needed only on UNIX systems that have case sensitive usernames\&.
14463 .sp
14464 Default:
14465 \fI\fIusername level\fR\fR\fI = \fR\fI0\fR\fI \fR
14466 .sp
14467 Example:
14468 \fI\fIusername level\fR\fR\fI = \fR\fI5\fR\fI \fR
14469 .RE
14470
14471 username map (G)
14472 .PP
14473 .RS 4
14474 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\&.
14475 .sp
14476 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 =
14477 DOMAIN\efoo)\&.
14478 .sp
14479 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\&.
14480 .sp
14481 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\&.
14482 .sp
14483 If any line begins with a \*(Aq#\*(Aq or a \*(Aq;\*(Aq then it is ignored\&.
14484 .sp
14485 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\&.
14486 .sp
14487 For example to map from the name
14488 \fBadmin\fR
14489 or
14490 \fBadministrator\fR
14491 to the UNIX name
14492 \fB root\fR
14493 you would use:
14494 .sp
14495 .if n \{\
14496 .RS 4
14497 .\}
14498 .nf
14499 root = admin administrator
14500 .fi
14501 .if n \{\
14502 .RE
14503 .\}
14504 .sp
14505 Or to map anyone in the UNIX group
14506 \fBsystem\fR
14507 to the UNIX name
14508 \fBsys\fR
14509 you would use:
14510 .sp
14511 .if n \{\
14512 .RS 4
14513 .\}
14514 .nf
14515 sys = @system
14516 .fi
14517 .if n \{\
14518 .RE
14519 .\}
14520 .sp
14521 You can have as many mappings as you like in a username map file\&.
14522 .sp
14523 If your system supports the NIS NETGROUP option then the netgroup database is checked before the
14524 /etc/group
14525 database for matching groups\&.
14526 .sp
14527 You can map Windows usernames that have spaces in them by using double quotes around the name\&. For example:
14528 .sp
14529 .if n \{\
14530 .RS 4
14531 .\}
14532 .nf
14533 tridge = "Andrew Tridgell"
14534 .fi
14535 .if n \{\
14536 .RE
14537 .\}
14538 .sp
14539 would map the windows username "Andrew Tridgell" to the unix username "tridge"\&.
14540 .sp
14541 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:
14542 .sp
14543 .if n \{\
14544 .RS 4
14545 .\}
14546 .nf
14547 !sys = mary fred
14548 guest = *
14549 .fi
14550 .if n \{\
14551 .RE
14552 .\}
14553 .sp
14554 Note that the remapping is applied to all occurrences of usernames\&. Thus if you connect to \e\eserver\efred and
14555 \fBfred\fR
14556 is remapped to
14557 \fBmary\fR
14558 then you will actually be connecting to \e\eserver\emary and will need to supply a password suitable for
14559 \fBmary\fR
14560 not
14561 \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\&.
14562 .sp
14563 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\&.
14564 .sp
14565 Samba versions prior to 3\&.0\&.8 would only support reading the fully qualified username (e\&.g\&.:
14566 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\&.
14567 .sp
14568 The following functionality is obeyed in version 3\&.0\&.8 and later:
14569 .sp
14570 When performing local authentication, the username map is applied to the login name before attempting to authenticate the connection\&.
14571 .sp
14572 When relying upon a external domain controller for validating authentication requests, smbd will apply the username map to the fully qualified username (i\&.e\&.
14573 DOMAIN\euser) only after the user has been successfully authenticated\&.
14574 .sp
14575 An example of use is:
14576 .sp
14577 .if n \{\
14578 .RS 4
14579 .\}
14580 .nf
14581 username map = /usr/local/samba/lib/users\&.map
14582 .fi
14583 .if n \{\
14584 .RE
14585 .\}
14586 .sp
14587 Default:
14588 \fI\fIusername map\fR\fR\fI = \fR\fI # no username map\fR\fI \fR
14589 .RE
14590
14591 username map cache time (G)
14592 .PP
14593 .RS 4
14594 Mapping usernames with the
14595 \m[blue]\fBusername map\fR\m[]
14596 or
14597 \m[blue]\fBusername map script\fR\m[]
14598 features of Samba can be relatively expensive\&. During login of a user, the mapping is done several times\&. In particular, calling the
14599 \m[blue]\fBusername map script\fR\m[]
14600 can slow down logins if external databases have to be queried from the script being called\&.
14601 .sp
14602 The parameter
14603 \m[blue]\fBusername map cache time\fR\m[]
14604 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\&.
14605 .sp
14606 Default:
14607 \fI\fIusername map cache time\fR\fR\fI = \fR\fI0\fR\fI \fR
14608 .sp
14609 Example:
14610 \fI\fIusername map cache time\fR\fR\fI = \fR\fI60\fR\fI \fR
14611 .RE
14612
14613 username map script (G)
14614 .PP
14615 .RS 4
14616 This script is a mutually exclusive alternative to the
14617 \m[blue]\fBusername map\fR\m[]
14618 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\&.
14619 .sp
14620 Default:
14621 \fI\fIusername map script\fR\fR\fI = \fR\fI\fR\fI \fR
14622 .sp
14623 Example:
14624 \fI\fIusername map script\fR\fR\fI = \fR\fI/etc/samba/scripts/mapusers\&.sh\fR\fI \fR
14625 .RE
14626
14627 usershare allow guests (G)
14628 .PP
14629 .RS 4
14630 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
14631 \fIguest ok = yes\fR
14632 in a share definition\&. Due to its security sensitive nature, the default is set to off\&.
14633 .sp
14634 Default:
14635 \fI\fIusershare allow guests\fR\fR\fI = \fR\fIno\fR\fI \fR
14636 .RE
14637
14638 usershare max shares (G)
14639 .PP
14640 .RS 4
14641 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\&.
14642 .sp
14643 Default:
14644 \fI\fIusershare max shares\fR\fR\fI = \fR\fI0\fR\fI \fR
14645 .RE
14646
14647 usershare owner only (G)
14648 .PP
14649 .RS 4
14650 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\&.
14651 .sp
14652 Default:
14653 \fI\fIusershare owner only\fR\fR\fI = \fR\fIyes\fR\fI \fR
14654 .RE
14655
14656 usershare path (G)
14657 .PP
14658 .RS 4
14659 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\&.
14660 .sp
14661 For example, a valid usershare directory might be /usr/local/samba/lib/usershares, set up as follows\&.
14662 .sp
14663 .if n \{\
14664 .RS 4
14665 .\}
14666 .nf
14667 ls \-ld /usr/local/samba/lib/usershares/
14668 drwxrwx\-\-T 2 root power_users 4096 2006\-05\-05 12:27 /usr/local/samba/lib/usershares/
14669
14670 .fi
14671 .if n \{\
14672 .RE
14673 .\}
14674 .sp
14675 In this case, only members of the group "power_users" can create user defined shares\&.
14676 .sp
14677 Default:
14678 \fI\fIusershare path\fR\fR\fI = \fR\fI/var/lib/samba/usershares\fR\fI \fR
14679 .RE
14680
14681 usershare prefix allow list (G)
14682 .PP
14683 .RS 4
14684 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\&.
14685 .sp
14686 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\&.
14687 .sp
14688 Default:
14689 \fI\fIusershare prefix allow list\fR\fR\fI = \fR\fI\fR\fI \fR
14690 .sp
14691 Example:
14692 \fI\fIusershare prefix allow list\fR\fR\fI = \fR\fI/home /data /space\fR\fI \fR
14693 .RE
14694
14695 usershare prefix deny list (G)
14696 .PP
14697 .RS 4
14698 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\&.
14699 .sp
14700 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\&.
14701 .sp
14702 Default:
14703 \fI\fIusershare prefix deny list\fR\fR\fI = \fR\fI\fR\fI \fR
14704 .sp
14705 Example:
14706 \fI\fIusershare prefix deny list\fR\fR\fI = \fR\fI/etc /dev /private\fR\fI \fR
14707 .RE
14708
14709 usershare template share (G)
14710 .PP
14711 .RS 4
14712 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\&.
14713 .sp
14714 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\&.
14715 .sp
14716 Default:
14717 \fI\fIusershare template share\fR\fR\fI = \fR\fI\fR\fI \fR
14718 .sp
14719 Example:
14720 \fI\fIusershare template share\fR\fR\fI = \fR\fItemplate_share\fR\fI \fR
14721 .RE
14722
14723 use sendfile (S)
14724 .PP
14725 .RS 4
14726 If this parameter is
14727 \fByes\fR, and the
14728 \fBsendfile()\fR
14729 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)\&.
14730 .sp
14731 Default:
14732 \fI\fIuse sendfile\fR\fR\fI = \fR\fIno\fR\fI \fR
14733 .RE
14734
14735 utmp (G)
14736 .PP
14737 .RS 4
14738 This boolean parameter is only available if Samba has been configured and compiled with the option
14739 \-\-with\-utmp\&. If set to
14740 \fByes\fR
14741 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\&.
14742 .sp
14743 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\&.
14744 .sp
14745 Default:
14746 \fI\fIutmp\fR\fR\fI = \fR\fIno\fR\fI \fR
14747 .RE
14748
14749 utmp directory (G)
14750 .PP
14751 .RS 4
14752 This parameter is only available if Samba has been configured and compiled with the option
14753 \-\-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
14754 /var/run/utmp
14755 on Linux)\&.
14756 .sp
14757 Default:
14758 \fI\fIutmp directory\fR\fR\fI = \fR\fI # Determined automatically\fR\fI \fR
14759 .sp
14760 Example:
14761 \fI\fIutmp directory\fR\fR\fI = \fR\fI/var/run/utmp\fR\fI \fR
14762 .RE
14763
14764 \-valid (S)
14765 .PP
14766 .RS 4
14767 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\&.
14768 .sp
14769 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\&.
14770 .sp
14771 Default:
14772 \fI\fI\-valid\fR\fR\fI = \fR\fIyes\fR\fI \fR
14773 .RE
14774
14775 valid users (S)
14776 .PP
14777 .RS 4
14778 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
14779 \fIinvalid users\fR
14780 parameter\&.
14781 .sp
14782 If this is empty (the default) then any user can login\&. If a username is in both this list and the
14783 \fIinvalid users\fR
14784 list then access is denied for that user\&.
14785 .sp
14786 The current servicename is substituted for
14787 \fI%S\fR\&. This is useful in the [homes] section\&.
14788 .sp
14789 \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
14790 \fIlocal master\fR,
14791 \fIos level\fR,
14792 \fIdomain master\fR,
14793 \fIpreferred master\fR) this option will prevent workstations from being able to browse the network\&.
14794 .sp
14795 Default:
14796 \fI\fIvalid users\fR\fR\fI = \fR\fI # No valid users list (anyone can login) \fR\fI \fR
14797 .sp
14798 Example:
14799 \fI\fIvalid users\fR\fR\fI = \fR\fIgreg, @pcusers\fR\fI \fR
14800 .RE
14801
14802 veto files (S)
14803 .PP
14804 .RS 4
14805 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\&.
14806 .sp
14807 \m[blue]\fBveto files\fR\m[]
14808 can also be used as a parametric option where NAME in
14809 .sp
14810 veto files : NAME =
14811 .sp
14812 specifies a user or group name with the same syntax as
14813 \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\&.
14814 .sp
14815 Each filename must be a unix path, not a DOS path and must
14816 \fInot\fR
14817 include the unix directory separator \*(Aq/\*(Aq\&.
14818 .sp
14819 Note that the
14820 \m[blue]\fBcase sensitive\fR\m[]
14821 option is applicable in vetoing files\&.
14822 .sp
14823 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
14824 \fIfail\fR
14825 unless you also set the
14826 \m[blue]\fBdelete veto files\fR\m[]
14827 parameter to
14828 \fIyes\fR\&.
14829 .sp
14830 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\&.
14831 .sp
14832 Examples of use include:
14833 .sp
14834 .if n \{\
14835 .RS 4
14836 .\}
14837 .nf
14838 ; Veto any files containing the word Security,
14839 ; any ending in \&.tmp, and any directory containing the
14840 ; word root\&.
14841 veto files = /*Security*/*\&.tmp/*root*/
14842
14843 ; Veto some files for anyone and some files for specific users and groups
14844 veto files = /vetoforall1/
14845 veto files : USER = /vetotoforuser/
14846 veto files : GROUP = /vetoforgroup/
14847 veto files : UNIVERSITY\eAlumnis = /somefile\&.txt/
14848 veto files : john@university\&.org = /anotherfile\&.txt/
14849 veto files : S\-1\-5\-21\-123\-456\-789\-1000 = /secretfile\&.txt/
14850
14851 ; Veto the Apple specific files that a NetAtalk server
14852 ; creates\&.
14853 veto files = /\&.AppleDouble/\&.bin/\&.AppleDesktop/Network Trash Folder/
14854 .fi
14855 .if n \{\
14856 .RE
14857 .\}
14858 .sp
14859 Default:
14860 \fI\fIveto files\fR\fR\fI = \fR\fI # No files or directories are vetoed\fR\fI \fR
14861 .RE
14862
14863 veto oplock files (S)
14864 .PP
14865 .RS 4
14866 This parameter is only valid when the
14867 \m[blue]\fBoplocks\fR\m[]
14868 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
14869 \m[blue]\fBveto files\fR\m[]
14870 parameter\&.
14871 .sp
14872 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
14873 \&.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\&.
14874 .sp
14875 An example of use is:
14876 .sp
14877 .if n \{\
14878 .RS 4
14879 .\}
14880 .nf
14881 veto oplock files = /\&.*SEM/
14882 .fi
14883 .if n \{\
14884 .RE
14885 .\}
14886 .sp
14887 Default:
14888 \fI\fIveto oplock files\fR\fR\fI = \fR\fI # No files are vetoed for oplock grants\fR\fI \fR
14889 .RE
14890
14891 vfs mkdir use tmp name (S)
14892 .PP
14893 .RS 4
14894 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\&.
14895 .sp
14896 Other clients should not see the existence of the directory that is in progress of being created!
14897 .sp
14898 This option is an enumerated type that controls the usage of a temporary directory name\&. When this is set to
14899 \fByes\fR, the directory name will be prefixed with \*(Aq\&.::TMPNAME:D:$SERVERID:\*(Aq (where $SERVERID is a unique identifier for the current process)\&.
14900 .sp
14901 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
14902 \fBno\fR:
14903 \m[blue]\fBinherit acls\fR\m[],
14904 \m[blue]\fBinherit owner\fR\m[],
14905 \m[blue]\fBinherit permissions\fR\m[],
14906 \m[blue]\fBnt acl support\fR\m[]
14907 or
14908 \m[blue]\fBstore dos attributes\fR\m[]\&. Note on OpenBSD Auto (the default) is mapped to
14909 \fBno\fR, see
14910 https://bugzilla\&.samba\&.org/show_bug\&.cgi?id=15801\&.
14911 .sp
14912 A re\-export of an SMB/CIFS mount might one rare case where
14913 vfs mkdir use tmp name = no
14914 could be useful\&.
14915 .sp
14916 In most cases
14917 vfs mkdir use tmp name = Auto
14918 should be kept\&.
14919 .sp
14920 Default:
14921 \fI\fIvfs mkdir use tmp name\fR\fR\fI = \fR\fIAuto\fR\fI \fR
14922 .RE
14923
14924 vfs object
14925 .PP
14926 .RS 4
14927 This parameter is a synonym for
14928 vfs objects\&.
14929 .RE
14930
14931 vfs objects (S)
14932 .PP
14933 .RS 4
14934 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\&.
14935 .sp
14936 Default:
14937 \fI\fIvfs objects\fR\fR\fI = \fR\fI\fR\fI \fR
14938 .sp
14939 Example:
14940 \fI\fIvfs objects\fR\fR\fI = \fR\fIextd_audit recycle\fR\fI \fR
14941 .RE
14942
14943 volume (S)
14944 .PP
14945 .RS 4
14946 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\&.
14947 .sp
14948 Default:
14949 \fI\fIvolume\fR\fR\fI = \fR\fI # the name of the share\fR\fI \fR
14950 .RE
14951
14952 volume serial number (S)
14953 .PP
14954 .RS 4
14955 This allows to override the volume serial number (a 32bit value) reported for a share\&.
14956 .sp
14957 The special value
14958 \fI\-1\fR
14959 (default) stands for a unique number that is calculated for each share\&.
14960 .sp
14961 Default:
14962 \fI\fIvolume serial number\fR\fR\fI = \fR\fI\-1\fR\fI \fR
14963 .sp
14964 Example:
14965 \fI\fIvolume serial number\fR\fR\fI = \fR\fI0xabcdefgh\fR\fI \fR
14966 .RE
14967
14968 wide links (S)
14969 .PP
14970 .RS 4
14971 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\&.
14972 .sp
14973 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
14974 \m[blue]\fBunix extensions\fR\m[]
14975 option is on\&.
14976 .sp
14977 See the parameter
14978 \m[blue]\fBallow insecure wide links\fR\m[]
14979 if you wish to change this coupling between the two parameters\&.
14980 .sp
14981 Default:
14982 \fI\fIwide links\fR\fR\fI = \fR\fIno\fR\fI \fR
14983 .RE
14984
14985 winbind cache time (G)
14986 .PP
14987 .RS 4
14988 This parameter specifies the number of seconds the
14989 \fBwinbindd\fR(8)
14990 daemon will cache user and group information before querying a Windows NT server again\&.
14991 .sp
14992 This does not apply to authentication requests, these are always evaluated in real time unless the
14993 \m[blue]\fBwinbind offline logon\fR\m[]
14994 option has been enabled\&.
14995 .sp
14996 Default:
14997 \fI\fIwinbind cache time\fR\fR\fI = \fR\fI300\fR\fI \fR
14998 .RE
14999
15000 winbindd socket directory (G)
15001 .PP
15002 .RS 4
15003 This setting controls the location of the winbind daemon\*(Aqs socket\&.
15004 .sp
15005 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\&.
15006 .sp
15007 Default:
15008 \fI\fIwinbindd socket directory\fR\fR\fI = \fR\fI/run/samba/winbindd\fR\fI \fR
15009 .RE
15010
15011 winbind enum groups (G)
15012 .PP
15013 .RS 4
15014 On large installations using
15015 \fBwinbindd\fR(8)
15016 it may be necessary to suppress the enumeration of groups through the
15017 setgrent(),
15018 getgrent()
15019 and
15020 endgrent()
15021 group of system calls\&. If the
15022 \fIwinbind enum groups\fR
15023 parameter is
15024 \fBno\fR, calls to the
15025 getgrent()
15026 system call will not return any data\&.
15027 .if n \{\
15028 .sp
15029 .\}
15030 .RS 4
15031 .it 1 an-trap
15032 .nr an-no-space-flag 1
15033 .nr an-break-flag 1
15034 .br
15035 .ps +1
15036 \fBWarning\fR
15037 .ps -1
15038 .br
15039 Turning off group enumeration may cause some programs to behave oddly\&.
15040 .sp .5v
15041 .RE
15042 Default:
15043 \fI\fIwinbind enum groups\fR\fR\fI = \fR\fIno\fR\fI \fR
15044 .RE
15045
15046 winbind enum users (G)
15047 .PP
15048 .RS 4
15049 On large installations using
15050 \fBwinbindd\fR(8)
15051 it may be necessary to suppress the enumeration of users through the
15052 setpwent(),
15053 getpwent()
15054 and
15055 endpwent()
15056 group of system calls\&. If the
15057 \fIwinbind enum users\fR
15058 parameter is
15059 \fBno\fR, calls to the
15060 getpwent
15061 system call will not return any data\&.
15062 .if n \{\
15063 .sp
15064 .\}
15065 .RS 4
15066 .it 1 an-trap
15067 .nr an-no-space-flag 1
15068 .nr an-break-flag 1
15069 .br
15070 .ps +1
15071 \fBWarning\fR
15072 .ps -1
15073 .br
15074 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\&.
15075 .sp .5v
15076 .RE
15077 Default:
15078 \fI\fIwinbind enum users\fR\fR\fI = \fR\fIno\fR\fI \fR
15079 .RE
15080
15081 winbind expand groups (G)
15082 .PP
15083 .RS 4
15084 This option controls the maximum depth that winbindd will traverse when flattening nested group memberships of Windows domain groups\&. This is different from the
15085 \m[blue]\fBwinbind nested groups\fR\m[]
15086 option which implements the Windows NT4 model of local group nesting\&. The "winbind expand groups" parameter specifically applies to the membership of domain groups\&.
15087 .sp
15088 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\&.
15089 .sp
15090 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\&.
15091 .sp
15092 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\&.
15093 .sp
15094 Default:
15095 \fI\fIwinbind expand groups\fR\fR\fI = \fR\fI0\fR\fI \fR
15096 .RE
15097
15098 winbind:ignore domains (G)
15099 .PP
15100 .RS 4
15101 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\&.
15102 .sp
15103 Default:
15104 \fI\fIwinbind:ignore domains\fR\fR\fI = \fR\fI\fR\fI \fR
15105 .sp
15106 Example:
15107 \fI\fIwinbind:ignore domains\fR\fR\fI = \fR\fIDOMAIN1, DOMAIN2\fR\fI \fR
15108 .RE
15109
15110 winbind max clients (G)
15111 .PP
15112 .RS 4
15113 This parameter specifies the maximum number of clients the
15114 \fBwinbindd\fR(8)
15115 daemon can connect with\&. The parameter is not a hard limit\&. The
15116 \fBwinbindd\fR(8)
15117 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\&.
15118 .sp
15119 Default:
15120 \fI\fIwinbind max clients\fR\fR\fI = \fR\fI200\fR\fI \fR
15121 .RE
15122
15123 winbind max domain connections (G)
15124 .PP
15125 .RS 4
15126 This parameter specifies the maximum number of simultaneous connections that the
15127 \fBwinbindd\fR(8)
15128 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\&.
15129 .sp
15130 Note that if
15131 \m[blue]\fBwinbind offline logon\fR\m[]
15132 is set to
15133 \fBYes\fR, then only one DC connection is allowed per domain, regardless of this setting\&.
15134 .sp
15135 Default:
15136 \fI\fIwinbind max domain connections\fR\fR\fI = \fR\fI1\fR\fI \fR
15137 .sp
15138 Example:
15139 \fI\fIwinbind max domain connections\fR\fR\fI = \fR\fI10\fR\fI \fR
15140 .RE
15141
15142 winbind nested groups (G)
15143 .PP
15144 .RS 4
15145 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\&.
15146 .sp
15147 Default:
15148 \fI\fIwinbind nested groups\fR\fR\fI = \fR\fIyes\fR\fI \fR
15149 .RE
15150
15151 winbind normalize names (G)
15152 .PP
15153 .RS 4
15154 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\&.
15155 .sp
15156 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\&.
15157 .sp
15158 Default:
15159 \fI\fIwinbind normalize names\fR\fR\fI = \fR\fIno\fR\fI \fR
15160 .sp
15161 Example:
15162 \fI\fIwinbind normalize names\fR\fR\fI = \fR\fIyes\fR\fI \fR
15163 .RE
15164
15165 winbind nss info (G)
15166 .PP
15167 .RS 4
15168 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:
15169 .RS
15170 .sp
15171 .RS 4
15172 .ie n \{\
15173 \h'-04'\(bu\h'+03'\c
15174 .\}
15175 .el \{\
15176 .sp -1
15177 .IP \(bu 2.3
15178 .\}
15179 \fItemplate\fR
15180 \- The default, using the parameters of
15181 \fItemplate shell\fR
15182 and
15183 \fItemplate homedir\fR)
15184 .RE
15185 .sp
15186 .RS 4
15187 .ie n \{\
15188 \h'-04'\(bu\h'+03'\c
15189 .\}
15190 .el \{\
15191 .sp -1
15192 .IP \(bu 2.3
15193 .\}
15194 \fI<sfu | sfu20 | rfc2307 >\fR
15195 \- 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"\&.
15196 .sp
15197 Note that for the idmap backend
15198 idmap_ad
15199 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\&.
15200 .RE
15201 .sp
15202 .RE
15203 .sp
15204 Default:
15205 \fI\fIwinbind nss info\fR\fR\fI = \fR\fItemplate\fR\fI \fR
15206 .sp
15207 Example:
15208 \fI\fIwinbind nss info\fR\fR\fI = \fR\fIsfu\fR\fI \fR
15209 .RE
15210
15211 winbind offline logon (G)
15212 .PP
15213 .RS 4
15214 This parameter is designed to control whether Winbind should allow one to login with the
15215 \fIpam_winbind\fR
15216 module using Cached Credentials\&. If enabled, winbindd will store user credentials from successful logins encrypted in a local cache\&.
15217 .sp
15218 Default:
15219 \fI\fIwinbind offline logon\fR\fR\fI = \fR\fIno\fR\fI \fR
15220 .sp
15221 Example:
15222 \fI\fIwinbind offline logon\fR\fR\fI = \fR\fIyes\fR\fI \fR
15223 .RE
15224
15225 winbind reconnect delay (G)
15226 .PP
15227 .RS 4
15228 This parameter specifies the number of seconds the
15229 \fBwinbindd\fR(8)
15230 daemon will wait between attempts to contact a Domain controller for a domain that is determined to be down or not contactable\&.
15231 .sp
15232 Default:
15233 \fI\fIwinbind reconnect delay\fR\fR\fI = \fR\fI30\fR\fI \fR
15234 .RE
15235
15236 winbind refresh tickets (G)
15237 .PP
15238 .RS 4
15239 This parameter is designed to control whether Winbind should refresh Kerberos Tickets retrieved using the
15240 \fIpam_winbind\fR
15241 module\&.
15242 .sp
15243 Default:
15244 \fI\fIwinbind refresh tickets\fR\fR\fI = \fR\fIno\fR\fI \fR
15245 .sp
15246 Example:
15247 \fI\fIwinbind refresh tickets\fR\fR\fI = \fR\fIyes\fR\fI \fR
15248 .RE
15249
15250 winbind request timeout (G)
15251 .PP
15252 .RS 4
15253 This parameter specifies the number of seconds the
15254 \fBwinbindd\fR(8)
15255 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\&.
15256 .sp
15257 Default:
15258 \fI\fIwinbind request timeout\fR\fR\fI = \fR\fI60\fR\fI \fR
15259 .RE
15260
15261 winbind rpc only (G)
15262 .PP
15263 .RS 4
15264 Setting this parameter to
15265 yes
15266 forces winbindd to use RPC instead of LDAP to retrieve information from Domain Controllers\&.
15267 .sp
15268 Default:
15269 \fI\fIwinbind rpc only\fR\fR\fI = \fR\fIno\fR\fI \fR
15270 .RE
15271
15272 winbind scan trusted domains (G)
15273 .PP
15274 .RS 4
15275 This option only takes effect when the
15276 \m[blue]\fBsecurity\fR\m[]
15277 option is set to
15278 \fBdomain\fR
15279 or
15280 \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
15281 wbinfo \-\-trusted\-domains \-\-verbose\&. Setting it to yes matches the behaviour of Samba 4\&.7 and older\&.
15282 .sp
15283 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
15284 \fBautorid\fR,
15285 \fBtdb\fR
15286 or
15287 \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\&.
15288 .sp
15289 If you have a setup that doesn\*(Aqt require the global list, you should set
15290 \m[blue]\fBwinbind scan trusted domains = no\fR\m[]\&.
15291 .sp
15292 Default:
15293 \fI\fIwinbind scan trusted domains\fR\fR\fI = \fR\fIno\fR\fI \fR
15294 .RE
15295
15296 winbind sealed pipes (G)
15297 .PP
15298 .RS 4
15299 This option controls whether any requests from winbindd to domain controllers pipe will be sealed\&. Disabling sealing can be useful for debugging purposes\&.
15300 .sp
15301 The behavior can be controlled per netbios domain by using \*(Aqwinbind sealed pipes:NETBIOSDOMAIN = no\*(Aq as option\&.
15302 .sp
15303 Default:
15304 \fI\fIwinbind sealed pipes\fR\fR\fI = \fR\fIyes\fR\fI \fR
15305 .RE
15306
15307 winbind separator (G)
15308 .PP
15309 .RS 4
15310 This parameter allows an admin to define the character used when listing a username of the form of
15311 \fIDOMAIN \fR\e\fIuser\fR\&. This parameter is only applicable when using the
15312 pam_winbind\&.so
15313 and
15314 nss_winbind\&.so
15315 modules for UNIX services\&.
15316 .sp
15317 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\&.
15318 .sp
15319 Default:
15320 \fI\fIwinbind separator\fR\fR\fI = \fR\fI\e\fR\fI \fR
15321 .sp
15322 Example:
15323 \fI\fIwinbind separator\fR\fR\fI = \fR\fI+\fR\fI \fR
15324 .RE
15325
15326 winbind use default domain (G)
15327 .PP
15328 .RS 4
15329 This parameter specifies whether the
15330 \fBwinbindd\fR(8)
15331 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\&.
15332 .sp
15333 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\&.
15334 .sp
15335 Default:
15336 \fI\fIwinbind use default domain\fR\fR\fI = \fR\fIno\fR\fI \fR
15337 .sp
15338 Example:
15339 \fI\fIwinbind use default domain\fR\fR\fI = \fR\fIyes\fR\fI \fR
15340 .RE
15341
15342 winbind use krb5 enterprise principals (G)
15343 .PP
15344 .RS 4
15345 winbindd is able to get kerberos tickets for pam_winbind with krb5_auth or wbinfo \-K/\-\-krb5auth=\&.
15346 .sp
15347 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\&.
15348 .sp
15349 With
15350 \m[blue]\fBwinbind scan trusted domains = no\fR\m[]
15351 winbindd doesn\*(Aqt even get a complete picture of the topology\&.
15352 .sp
15353 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\&.
15354 .sp
15355 With
15356 \m[blue]\fBwinbind use krb5 enterprise principals = yes\fR\m[]
15357 winbindd enterprise principals will be used\&.
15358 .sp
15359 Default:
15360 \fI\fIwinbind use krb5 enterprise principals\fR\fR\fI = \fR\fIyes\fR\fI \fR
15361 .sp
15362 Example:
15363 \fI\fIwinbind use krb5 enterprise principals\fR\fR\fI = \fR\fIno\fR\fI \fR
15364 .RE
15365
15366 winbind varlink service (G)
15367 .PP
15368 .RS 4
15369 This setting controls whether
15370 \fBwinbind\fR(8)
15371 will listen for User/Group record lookup from
15372 \fBnss-systemd\fR(8)
15373 via Varlink, offering an alternative to nss_winbind\&.
15374 .sp
15375 For more information about User/Group record lookup via Varlink see https://systemd\&.io/USER_GROUP_API/ and
15376 \fBnss-systemd \fR(8)
15377 manpage\&.
15378 .sp
15379 .if n \{\
15380 .sp
15381 .\}
15382 .RS 4
15383 .it 1 an-trap
15384 .nr an-no-space-flag 1
15385 .nr an-break-flag 1
15386 .br
15387 .ps +1
15388 \fBWarning\fR
15389 .ps -1
15390 .br
15391 \fBSystemd\fR(1)
15392 versions prior 253 consider the default
15393 \m[blue]\fBwinbind separator\fR\m[]
15394 \*(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\&.
15395 .sp .5v
15396 .RE
15397 .sp
15398 .if n \{\
15399 .sp
15400 .\}
15401 .RS 4
15402 .it 1 an-trap
15403 .nr an-no-space-flag 1
15404 .nr an-break-flag 1
15405 .br
15406 .ps +1
15407 \fBWarning\fR
15408 .ps -1
15409 .br
15410 This setting has no effect in platforms or distributions without
15411 \fBsystemd\fR(1)\&.
15412 .sp .5v
15413 .RE
15414 .sp
15415 Default:
15416 \fI\fIwinbind varlink service\fR\fR\fI = \fR\fIno\fR\fI \fR
15417 .RE
15418
15419 winsdb:local_owner (G)
15420 .PP
15421 .RS 4
15422 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\&.
15423 .sp
15424 \fINo default\fR
15425 .RE
15426
15427 winsdb:dbnosync (G)
15428 .PP
15429 .RS 4
15430 This parameter disables fsync() after changes of the WINS database\&.
15431 .sp
15432 Default:
15433 \fI\fIwinsdb:dbnosync\fR\fR\fI = \fR\fIno\fR\fI \fR
15434 .RE
15435
15436 wins hook (G)
15437 .PP
15438 .RS 4
15439 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\&.
15440 .sp
15441 The wins hook parameter specifies the name of a script or executable that will be called as follows:
15442 .sp
15443 wins_hook operation name nametype ttl IP_list
15444 .RS
15445 .sp
15446 .RS 4
15447 .ie n \{\
15448 \h'-04'\(bu\h'+03'\c
15449 .\}
15450 .el \{\
15451 .sp -1
15452 .IP \(bu 2.3
15453 .\}
15454 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\&.
15455 .RE
15456 .sp
15457 .RS 4
15458 .ie n \{\
15459 \h'-04'\(bu\h'+03'\c
15460 .\}
15461 .el \{\
15462 .sp -1
15463 .IP \(bu 2.3
15464 .\}
15465 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\&.
15466 .RE
15467 .sp
15468 .RS 4
15469 .ie n \{\
15470 \h'-04'\(bu\h'+03'\c
15471 .\}
15472 .el \{\
15473 .sp -1
15474 .IP \(bu 2.3
15475 .\}
15476 The third argument is the NetBIOS name type as a 2 digit hexadecimal number\&.
15477 .RE
15478 .sp
15479 .RS 4
15480 .ie n \{\
15481 \h'-04'\(bu\h'+03'\c
15482 .\}
15483 .el \{\
15484 .sp -1
15485 .IP \(bu 2.3
15486 .\}
15487 The fourth argument is the TTL (time to live) for the name in seconds\&.
15488 .RE
15489 .sp
15490 .RS 4
15491 .ie n \{\
15492 \h'-04'\(bu\h'+03'\c
15493 .\}
15494 .el \{\
15495 .sp -1
15496 .IP \(bu 2.3
15497 .\}
15498 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\&.
15499 .RE
15500 .sp
15501 .RE
15502 An example script that calls the BIND dynamic DNS update program
15503 nsupdate
15504 is provided in the examples directory of the Samba source code\&.
15505 .sp
15506 \fINo default\fR
15507 .RE
15508
15509 wins proxy (G)
15510 .PP
15511 .RS 4
15512 This is a boolean that controls if
15513 \fBnmbd\fR(8)
15514 will respond to broadcast name queries on behalf of other hosts\&. You may need to set this to
15515 \fByes\fR
15516 for some older clients\&.
15517 .sp
15518 Default:
15519 \fI\fIwins proxy\fR\fR\fI = \fR\fIno\fR\fI \fR
15520 .RE
15521
15522 wins server (G)
15523 .PP
15524 .RS 4
15525 This specifies the IP address (or DNS name: IP address for preference) of the WINS server that
15526 \fBnmbd\fR(8)
15527 should register with\&. If you have a WINS server on your network then you should set this to the WINS server\*(Aqs IP\&.
15528 .sp
15529 You should point this at your WINS server if you have a multi\-subnetted network\&.
15530 .sp
15531 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\&.
15532 .if n \{\
15533 .sp
15534 .\}
15535 .RS 4
15536 .it 1 an-trap
15537 .nr an-no-space-flag 1
15538 .nr an-break-flag 1
15539 .br
15540 .ps +1
15541 \fBNote\fR
15542 .ps -1
15543 .br
15544 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\&.
15545 .sp .5v
15546 .RE
15547 See the chapter in the Samba3\-HOWTO on Network Browsing\&.
15548 .sp
15549 Default:
15550 \fI\fIwins server\fR\fR\fI = \fR\fI\fR\fI \fR
15551 .sp
15552 Example:
15553 \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
15554 .sp
15555 Example:
15556 \fI\fIwins server\fR\fR\fI = \fR\fI192\&.9\&.200\&.1 192\&.168\&.2\&.61\fR\fI \fR
15557 .RE
15558
15559 wins support (G)
15560 .PP
15561 .RS 4
15562 This boolean controls if the
15563 \fBnmbd\fR(8)
15564 process in Samba will act as a WINS server\&. You should not set this to
15565 \fByes\fR
15566 unless you have a multi\-subnetted network and you wish a particular
15567 nmbd
15568 to be your WINS server\&. Note that you should
15569 \fINEVER\fR
15570 set this to
15571 \fByes\fR
15572 on more than one machine in your network\&.
15573 .sp
15574 Default:
15575 \fI\fIwins support\fR\fR\fI = \fR\fIno\fR\fI \fR
15576 .RE
15577
15578 workgroup (G)
15579 .PP
15580 .RS 4
15581 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
15582 \m[blue]\fBsecurity = domain\fR\m[]
15583 setting\&.
15584 .sp
15585 Default:
15586 \fI\fIworkgroup\fR\fR\fI = \fR\fIWORKGROUP\fR\fI \fR
15587 .sp
15588 Example:
15589 \fI\fIworkgroup\fR\fR\fI = \fR\fIMYGROUP\fR\fI \fR
15590 .RE
15591
15592 wreplsrv:periodic_interval (G)
15593 .PP
15594 .RS 4
15595 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\&.
15596 .sp
15597 Default:
15598 \fI\fIwreplsrv:periodic_interval\fR\fR\fI = \fR\fI15\fR\fI \fR
15599 .RE
15600
15601 wreplsrv:propagate name releases (G)
15602 .PP
15603 .RS 4
15604 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\&.
15605 .sp
15606 Default:
15607 \fI\fIwreplsrv:propagate name releases\fR\fR\fI = \fR\fIno\fR\fI \fR
15608 .RE
15609
15610 wreplsrv:scavenging_interval (G)
15611 .PP
15612 .RS 4
15613 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\&.
15614 .sp
15615 \fINo default\fR
15616 .RE
15617
15618 wreplsrv:tombstone_extra_timeout (G)
15619 .PP
15620 .RS 4
15621 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\&.
15622 .sp
15623 Default:
15624 \fI\fIwreplsrv:tombstone_extra_timeout\fR\fR\fI = \fR\fI259200\fR\fI \fR
15625 .RE
15626
15627 wreplsrv:tombstone_interval (G)
15628 .PP
15629 .RS 4
15630 This is the interval in s till released records of the WINS server become tombstone\&. Defaults to 6 days\&.
15631 .sp
15632 Default:
15633 \fI\fIwreplsrv:tombstone_interval\fR\fR\fI = \fR\fI518400\fR\fI \fR
15634 .RE
15635
15636 wreplsrv:tombstone_timeout (G)
15637 .PP
15638 .RS 4
15639 This is the interval in s till tombstone records are deleted from the WINS database\&. Defaults to 1 day\&.
15640 .sp
15641 Default:
15642 \fI\fIwreplsrv:tombstone_timeout\fR\fR\fI = \fR\fI86400\fR\fI \fR
15643 .RE
15644
15645 wreplsrv:verify_interval (G)
15646 .PP
15647 .RS 4
15648 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\&.
15649 .sp
15650 Default:
15651 \fI\fIwreplsrv:verify_interval\fR\fR\fI = \fR\fI2073600\fR\fI \fR
15652 .RE
15653
15654 writable
15655 .PP
15656 .RS 4
15657 This parameter is a synonym for
15658 writeable\&.
15659 .RE
15660
15661 write ok
15662 .PP
15663 .RS 4
15664 This parameter is a synonym for
15665 writeable\&.
15666 .RE
15667
15668 writeable (S)
15669 .PP
15670 .RS 4
15671 Inverted synonym for
15672 \m[blue]\fBread only\fR\m[]\&.
15673 .sp
15674 Default:
15675 \fI\fIwriteable\fR\fR\fI = \fR\fIno\fR\fI \fR
15676 .RE
15677
15678 write list (S)
15679 .PP
15680 .RS 4
15681 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
15682 \m[blue]\fBread only\fR\m[]
15683 option is set to\&. The list can include group names using the @group syntax\&.
15684 .sp
15685 Note that if a user is in both the read list and the write list then they will be given write access\&.
15686 .sp
15687 Default:
15688 \fI\fIwrite list\fR\fR\fI = \fR\fI\fR\fI \fR
15689 .sp
15690 Example:
15691 \fI\fIwrite list\fR\fR\fI = \fR\fIadmin, root, @staff\fR\fI \fR
15692 .RE
15693
15694 write raw (G)
15695 .PP
15696 .RS 4
15697 This is ignored if
15698 \m[blue]\fBasync smb echo handler\fR\m[]
15699 is set, because this feature is incompatible with raw write SMB requests
15700 .sp
15701 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\&.
15702 .sp
15703 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\&.
15704 .sp
15705 In general this parameter should be viewed as a system tuning tool and left severely alone\&.
15706 .sp
15707 Default:
15708 \fI\fIwrite raw\fR\fR\fI = \fR\fIyes\fR\fI \fR
15709 .RE
15710
15711 wsp property file (G)
15712 .PP
15713 .RS 4
15714 \m[blue]\fBwsp property file\fR\m[]
15715 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\&.
15716 .PP
15717 Property Name
15718 .RS 4
15719 A property name e\&.g\&. System\&.ItemUrl\&.
15720 .RE
15721 .PP
15722 GUID
15723 .RS 4
15724 A guid that identifies the propertyset the property belongs to\&.
15725 .RE
15726 .PP
15727 prop ID
15728 .RS 4
15729 A number that together with the GUID uniquely identifies the property\&.
15730 .RE
15731 .PP
15732 inInverted Index
15733 .RS 4
15734 Set to TRUE is the property is indexed\&.
15735 .RE
15736 .PP
15737 isColumn
15738 .RS 4
15739 Set to TRUE if the property is one that can be returned in rows returned from WSP query\&.
15740 .RE
15741 .PP
15742 type
15743 .RS 4
15744 One of
15745 \fIBoolean\fR,\fIBuffer\fR,\fIByte\fR,\fIDateTime\fR,\fIDouble\fR,\fIInt32\fR,\fIString\fR,\fIUInt16\fR,\fIUInt32\fR,\fIUInt64\fR
15746 .RE
15747 .PP
15748 MaxSize
15749 .RS 4
15750 maximum size when stored\&.
15751 .RE
15752 .PP
15753 Vector Property
15754 .RS 4
15755 TRUE if this is a multivalue property\&.
15756 .RE
15757 .PP
15758 Description
15759 .RS 4
15760 Description of what the property is used for\&.
15761 .RE
15762 .sp
15763 Default:
15764 \fI\fIwsp property file\fR\fR\fI = \fR\fI\fR\fI \fR
15765 .RE
15766
15767 wtmp directory (G)
15768 .PP
15769 .RS 4
15770 This parameter is only available if Samba has been configured and compiled with the option
15771 \-\-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\&.
15772 .sp
15773 By default this is not set, meaning the system will use whatever utmp file the native system is set to use (usually
15774 /var/run/wtmp
15775 on Linux)\&.
15776 .sp
15777 Default:
15778 \fI\fIwtmp directory\fR\fR\fI = \fR\fI\fR\fI \fR
15779 .sp
15780 Example:
15781 \fI\fIwtmp directory\fR\fR\fI = \fR\fI/var/log/wtmp\fR\fI \fR
15782 .RE
15783 .SH "WARNINGS"
15784 .PP
15785 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\&.
15786 .PP
15787 On a similar note, many clients \- especially DOS clients \- limit service names to eight characters\&.
15788 \fBsmbd\fR(8)
15789 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\&.
15790 .PP
15791 Use of the
15792 [homes]
15793 and
15794 [printers]
15795 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\&.
15796 .SH "VERSION"
15797 .PP
15798 This man page is part of version 4\&.23\&.8 of the Samba suite\&.
15799 .SH "SEE ALSO"
15800 .PP
15801 \fBsamba\fR(7),
15802 \fBsmbpasswd\fR(8),
15803 \fBsmbd\fR(8),
15804 \fBnmbd\fR(8),
15805 \fBwinbindd\fR(8),
15806 \fBsamba\fR(8),
15807 \fBsamba-tool\fR(8),
15808 \fBsmbclient\fR(1),
15809 \fBnmblookup\fR(1),
15810 \fBtestparm\fR(1)\&.
15811 .SH "AUTHOR"
15812 .PP
15813 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\&.