1SMB.CONF(5) File Formats and Conventions SMB.CONF(5)
2
3
4
6 smb.conf - The configuration file for the Samba suite
7
9 The smb.conf file is a configuration file for the Samba suite.
10 smb.conf contains runtime configuration information for the Samba
11 programs. The complete description of the file format and possible
12 parameters held within are here for reference purposes.
13
15 The Samba suite includes a number of different programs. Some of them
16 operate in a client mode, others are server daemons that provide
17 various services to its clients. The smb.conf file is processed in the
18 following way:
19
20 · The Samba suite's client applications read their
21 configuration only once. Any changes made after start aren't
22 reflected in the context of already running client code.
23
24 · The Samba suite's server daemons reload their configuration
25 when requested. However, already active connections do not
26 change their configuration. More detailed information can be
27 found in smbd(8) and winbindd(8) manual pages.
28
29
30 To request Samba server daemons to refresh their configuration, please
31 use smbcontrol(1) utility.
32
34 The file consists of sections and parameters. A section begins with the
35 name of the section in square brackets and continues until the next
36 section begins. Sections contain parameters of the form:
37
38 name = value
39
40 The file is line-based - that is, each newline-terminated line
41 represents either a comment, a section name or a parameter.
42
43 Section and parameter names are not case sensitive.
44
45 Only the first equals sign in a parameter is significant. Whitespace
46 before or after the first equals sign is discarded. Leading, trailing
47 and internal whitespace in section and parameter names is irrelevant.
48 Leading and trailing whitespace in a parameter value is discarded.
49 Internal whitespace within a parameter value is retained verbatim.
50
51 Any line beginning with a semicolon (“;”) or a hash (“#”) character is
52 ignored, as are lines containing only whitespace.
53
54 Any line ending in a “\” is continued on the next line in the customary
55 UNIX fashion.
56
57 The values following the equals sign in parameters are all either a
58 string (no quotes needed) or a boolean, which may be given as yes/no,
59 1/0 or true/false. Case is not significant in boolean values, but is
60 preserved in string values. Some items such as create masks are
61 numeric.
62
64 Each section in the configuration file (except for the [global]
65 section) describes a shared resource (known as a “share”). The section
66 name is the name of the shared resource and the parameters within the
67 section define the shares attributes.
68
69 There are three special sections, [global], [homes] and [printers],
70 which are described under special sections. The following notes apply
71 to ordinary section descriptions.
72
73 A share consists of a directory to which access is being given plus a
74 description of the access rights which are granted to the user of the
75 service. Some housekeeping options are also specifiable.
76
77 Sections are either file share services (used by the client as an
78 extension of their native file systems) or printable services (used by
79 the client to access print services on the host running the server).
80
81 Sections may be designated guest services, in which case no password is
82 required to access them. A specified UNIX guest account is used to
83 define access privileges in this case.
84
85 Sections other than guest services will require a password to access
86 them. The client provides the username. As older clients only provide
87 passwords and not usernames, you may specify a list of usernames to
88 check against the password using the user = option in the share
89 definition. For modern clients such as Windows 95/98/ME/NT/2000, this
90 should not be necessary.
91
92 The access rights granted by the server are masked by the access rights
93 granted to the specified or guest UNIX user by the host system. The
94 server does not grant more access than the host system grants.
95
96 The following sample section defines a file space share. The user has
97 write access to the path /home/bar. The share is accessed via the share
98 name foo:
99
100 [foo]
101 path = /home/bar
102 read only = no
103
104 The following sample section defines a printable share. The share is
105 read-only, but printable. That is, the only write access permitted is
106 via calls to open, write to and close a spool file. The guest ok
107 parameter means access will be permitted as the default guest user
108 (specified elsewhere):
109
110 [aprinter]
111 path = /usr/spool/public
112 read only = yes
113 printable = yes
114 guest ok = yes
115
116
118 The [global] section
119 Parameters in this section apply to the server as a whole, or are
120 defaults for sections that do not specifically define certain items.
121 See the notes under PARAMETERS for more information.
122
123 The [homes] section
124 If a section called [homes] is included in the configuration file,
125 services connecting clients to their home directories can be created on
126 the fly by the server.
127
128 When the connection request is made, the existing sections are scanned.
129 If a match is found, it is used. If no match is found, the requested
130 section name is treated as a username and looked up in the local
131 password file. If the name exists and the correct password has been
132 given, a share is created by cloning the [homes] section.
133
134 Some modifications are then made to the newly created share:
135
136 · The share name is changed from homes to the located
137 username.
138
139 · If no path was given, the path is set to the user's home
140 directory.
141
142
143 If you decide to use a path = line in your [homes] section, it may be
144 useful to use the %S macro. For example:
145
146 path = /data/pchome/%S
147
148 is useful if you have different home directories for your PCs than for
149 UNIX access.
150
151 This is a fast and simple way to give a large number of clients access
152 to their home directories with a minimum of fuss.
153
154 A similar process occurs if the requested section name is “homes”,
155 except that the share name is not changed to that of the requesting
156 user. This method of using the [homes] section works well if different
157 users share a client PC.
158
159 The [homes] section can specify all the parameters a normal service
160 section can specify, though some make more sense than others. The
161 following is a typical and suitable [homes] section:
162
163 [homes]
164 read only = no
165
166 An important point is that if guest access is specified in the [homes]
167 section, all home directories will be visible to all clients without a
168 password. In the very unlikely event that this is actually desirable,
169 it is wise to also specify read only access.
170
171 The browseable flag for auto home directories will be inherited from
172 the global browseable flag, not the [homes] browseable flag. This is
173 useful as it means setting browseable = no in the [homes] section will
174 hide the [homes] share but make any auto home directories visible.
175
176 The [printers] section
177 This section works like [homes], but for printers.
178
179 If a [printers] section occurs in the configuration file, users are
180 able to connect to any printer specified in the local host's printcap
181 file.
182
183 When a connection request is made, the existing sections are scanned.
184 If a match is found, it is used. If no match is found, but a [homes]
185 section exists, it is used as described above. Otherwise, the requested
186 section name is treated as a printer name and the appropriate printcap
187 file is scanned to see if the requested section name is a valid printer
188 share name. If a match is found, a new printer share is created by
189 cloning the [printers] section.
190
191 A few modifications are then made to the newly created share:
192
193 · The share name is set to the located printer name
194
195 · If no printer name was given, the printer name is set to the
196 located printer name
197
198 · If the share does not permit guest access and no username
199 was given, the username is set to the located printer name.
200
201
202 The [printers] service MUST be printable - if you specify otherwise,
203 the server will refuse to load the configuration file.
204
205 Typically the path specified is that of a world-writeable spool
206 directory with the sticky bit set on it. A typical [printers] entry
207 looks like this:
208
209 [printers]
210 path = /usr/spool/public
211 guest ok = yes
212 printable = yes
213
214 All aliases given for a printer in the printcap file are legitimate
215 printer names as far as the server is concerned. If your printing
216 subsystem doesn't work like that, you will have to set up a
217 pseudo-printcap. This is a file consisting of one or more lines like
218 this:
219
220 alias|alias|alias|alias...
221
222 Each alias should be an acceptable printer name for your printing
223 subsystem. In the [global] section, specify the new file as your
224 printcap. The server will only recognize names found in your
225 pseudo-printcap, which of course can contain whatever aliases you like.
226 The same technique could be used simply to limit access to a subset of
227 your local printers.
228
229 An alias, by the way, is defined as any component of the first entry of
230 a printcap record. Records are separated by newlines, components (if
231 there are more than one) are separated by vertical bar symbols (|).
232
233 Note
234 On SYSV systems which use lpstat to determine what printers are
235 defined on the system you may be able to use printcap name = lpstat
236 to automatically obtain a list of printers. See the printcap name
237 option for more details.
238
240 Starting with Samba version 3.0.23 the capability for non-root users to
241 add, modify, and delete their own share definitions has been added.
242 This capability is called usershares and is controlled by a set of
243 parameters in the [global] section of the smb.conf. The relevant
244 parameters are :
245
246 usershare allow guests
247 Controls if usershares can permit guest access.
248
249 usershare max shares
250 Maximum number of user defined shares allowed.
251
252 usershare owner only
253 If set only directories owned by the sharing user can be shared.
254
255 usershare path
256 Points to the directory containing the user defined share
257 definitions. The filesystem permissions on this directory control
258 who can create user defined shares.
259
260 usershare prefix allow list
261 Comma-separated list of absolute pathnames restricting what
262 directories can be shared. Only directories below the pathnames in
263 this list are permitted.
264
265 usershare prefix deny list
266 Comma-separated list of absolute pathnames restricting what
267 directories can be shared. Directories below the pathnames in this
268 list are prohibited.
269
270 usershare template share
271 Names a pre-existing share used as a template for creating new
272 usershares. All other share parameters not specified in the user
273 defined share definition are copied from this named share.
274
275 To allow members of the UNIX group foo to create user defined shares,
276 create the directory to contain the share definitions as follows:
277
278 Become root:
279
280 mkdir /usr/local/samba/lib/usershares
281 chgrp foo /usr/local/samba/lib/usershares
282 chmod 1770 /usr/local/samba/lib/usershares
283
284 Then add the parameters
285
286 usershare path = /usr/local/samba/lib/usershares
287 usershare max shares = 10 # (or the desired number of shares)
288
289 to the global section of your smb.conf. Members of the group foo may
290 then manipulate the user defined shares using the following commands.
291
292 net usershare add sharename path [comment] [acl] [guest_ok=[y|n]]
293 To create or modify (overwrite) a user defined share.
294
295 net usershare delete sharename
296 To delete a user defined share.
297
298 net usershare list wildcard-sharename
299 To list user defined shares.
300
301 net usershare info wildcard-sharename
302 To print information about user defined shares.
303
305 Parameters define the specific attributes of sections.
306
307 Some parameters are specific to the [global] section (e.g., security).
308 Some parameters are usable in all sections (e.g., create mask). All
309 others are permissible only in normal sections. For the purposes of the
310 following descriptions the [homes] and [printers] sections will be
311 considered normal. The letter G in parentheses indicates that a
312 parameter is specific to the [global] section. The letter S indicates
313 that a parameter can be specified in a service specific section. All S
314 parameters can also be specified in the [global] section - in which
315 case they will define the default behavior for all services.
316
317 Parameters are arranged here in alphabetical order - this may not
318 create best bedfellows, but at least you can find them! Where there are
319 synonyms, the preferred synonym is described, others refer to the
320 preferred synonym.
321
323 Many of the strings that are settable in the config file can take
324 substitutions. For example the option “path = /tmp/%u” is interpreted
325 as “path = /tmp/john” if the user connected with the username john.
326
327 These substitutions are mostly noted in the descriptions below, but
328 there are some general substitutions which apply whenever they might be
329 relevant. These are:
330
331 %U
332 session username (the username that the client wanted, not
333 necessarily the same as the one they got).
334
335 %G
336 primary group name of %U.
337
338 %h
339 the Internet hostname that Samba is running on.
340
341 %m
342 the NetBIOS name of the client machine (very useful).
343
344 This parameter is not available when Samba listens on port 445, as
345 clients no longer send this information. If you use this macro in
346 an include statement on a domain that has a Samba domain controller
347 be sure to set in the [global] section smb ports = 139. This will
348 cause Samba to not listen on port 445 and will permit include
349 functionality to function as it did with Samba 2.x.
350
351 %L
352 the NetBIOS name of the server. This allows you to change your
353 config based on what the client calls you. Your server can have a
354 “dual personality”.
355
356 %M
357 the Internet name of the client machine.
358
359 %R
360 the selected protocol level after protocol negotiation. It can be
361 one of CORE, COREPLUS, LANMAN1, LANMAN2, NT1, SMB2_02, SMB2_10,
362 SMB2_22, SMB2_24, SMB3_00, SMB3_02, SMB3_10, SMB3_11 or SMB2_FF.
363
364 %d
365 the process id of the current server process.
366
367 %a
368 The architecture of the remote machine. It currently recognizes
369 Samba (Samba), the Linux CIFS file system (CIFSFS), OS/2, (OS2),
370 Mac OS X (OSX), Windows for Workgroups (WfWg), Windows 9x/ME
371 (Win95), Windows NT (WinNT), Windows 2000 (Win2K), Windows XP
372 (WinXP), Windows XP 64-bit(WinXP64), Windows 2003 including 2003R2
373 (Win2K3), and Windows Vista (Vista). Anything else will be known as
374 UNKNOWN.
375
376 %I
377 the IP address of the client machine.
378
379 Before 4.0.0 it could contain IPv4 mapped IPv6 addresses, now it
380 only contains IPv4 or IPv6 addresses.
381
382 %J
383 the IP address of the client machine, colons/dots replaced by
384 underscores.
385
386 %i
387 the local IP address to which a client connected.
388
389 Before 4.0.0 it could contain IPv4 mapped IPv6 addresses, now it
390 only contains IPv4 or IPv6 addresses.
391
392 %j
393 the local IP address to which a client connected, colons/dots
394 replaced by underscores.
395
396 %T
397 the current date and time.
398
399 %t
400 the current date and time in a minimal format without colons
401 (YYYYYmmdd_HHMMSS).
402
403 %D
404 name of the domain or workgroup of the current user.
405
406 %w
407 the winbind separator.
408
409 %$(envvar)
410 the value of the environment variable envar.
411
412 The following substitutes apply only to some configuration options
413 (only those that are used when a connection has been established):
414
415 %S
416 the name of the current service, if any.
417
418 %P
419 the root directory of the current service, if any.
420
421 %u
422 username of the current service, if any.
423
424 %g
425 primary group name of %u.
426
427 %H
428 the home directory of the user given by %u.
429
430 %N
431 the name of your NIS home directory server. This is obtained from
432 your NIS auto.map entry. If you have not compiled Samba with the
433 --with-automount option, this value will be the same as %L.
434
435 %p
436 the path of the service's home directory, obtained from your NIS
437 auto.map entry. The NIS auto.map entry is split up as %N:%p.
438
439 There are some quite creative things that can be done with these
440 substitutions and other smb.conf options.
441
443 Samba supports name mangling so that DOS and Windows clients can use
444 files that don't conform to the 8.3 format. It can also be set to
445 adjust the case of 8.3 format filenames.
446
447 There are several options that control the way mangling is performed,
448 and they are grouped here rather than listed separately. For the
449 defaults look at the output of the testparm program.
450
451 These options can be set separately for each service.
452
453 The options are:
454
455 case sensitive = yes/no/auto
456 controls whether filenames are case sensitive. If they aren't,
457 Samba must do a filename search and match on passed names. The
458 default setting of auto allows clients that support case sensitive
459 filenames (Linux CIFSVFS and smbclient 3.0.5 and above currently)
460 to tell the Samba server on a per-packet basis that they wish to
461 access the file system in a case-sensitive manner (to support UNIX
462 case sensitive semantics). No Windows or DOS system supports
463 case-sensitive filename so setting this option to auto is that same
464 as setting it to no for them. Default auto.
465
466 default case = upper/lower
467 controls what the default case is for new filenames (ie. files that
468 don't currently exist in the filesystem). Default lower. IMPORTANT
469 NOTE: As part of the optimizations for directories containing large
470 numbers of files, the following special case applies. If the
471 options case sensitive = yes, preserve case = No, and short
472 preserve case = No are set, then the case of all incoming client
473 filenames, not just new filenames, will be modified. See additional
474 notes below.
475
476 preserve case = yes/no
477 controls whether new files (ie. files that don't currently exist in
478 the filesystem) are created with the case that the client passes,
479 or if they are forced to be the default case. Default yes.
480
481 short preserve case = yes/no
482 controls if new files (ie. files that don't currently exist in the
483 filesystem) which conform to 8.3 syntax, that is all in upper case
484 and of suitable length, are created upper case, or if they are
485 forced to be the default case. This option can be used with
486 preserve case = yes to permit long filenames to retain their case,
487 while short names are lowercased. Default yes.
488
489 By default, Samba 3.0 has the same semantics as a Windows NT server, in
490 that it is case insensitive but case preserving. As a special case for
491 directories with large numbers of files, if the case options are set as
492 follows, "case sensitive = yes", "case preserve = no", "short preserve
493 case = no" then the "default case" option will be applied and will
494 modify all filenames sent from the client when accessing this share.
495
497 Starting with Samba version 3.2.0, the capability to store Samba
498 configuration in the registry is available. The configuration is stored
499 in the registry key HKLM\Software\Samba\smbconf. There are two levels
500 of registry configuration:
501
502 1. Share definitions stored in registry are used. This is
503 triggered by setting the global parameter registry shares to
504 “yes” in smb.conf.
505
506 The registry shares are loaded not at startup but on demand
507 at runtime by smbd. Shares defined in smb.conf take priority
508 over shares of the same name defined in registry.
509
510 2. Global smb.conf options stored in registry are used. This
511 can be activated in two different ways:
512
513 Firstly, a registry only configuration is triggered by
514 setting config backend = registry in the [global] section of
515 smb.conf. This resets everything that has been read from
516 config files to this point and reads the content of the
517 global configuration section from the registry. This is the
518 recommended method of using registry based configuration.
519
520 Secondly, a mixed configuration can be activated by a
521 special new meaning of the parameter include = registry in
522 the [global] section of smb.conf. This reads the global
523 options from registry with the same priorities as for an
524 include of a text file. This may be especially useful in
525 cases where an initial configuration is needed to access the
526 registry.
527
528 Activation of global registry options automatically
529 activates registry shares. So in the registry only case,
530 shares are loaded on demand only.
531
532
533 Note: To make registry-based configurations foolproof at least to a
534 certain extent, the use of lock directory and config backend inside the
535 registry configuration has been disabled: Especially by changing the
536 lock directory inside the registry configuration, one would create a
537 broken setup where the daemons do not see the configuration they loaded
538 once it is active.
539
540 The registry configuration can be accessed with tools like regedit or
541 net (rpc) registry in the key HKLM\Software\Samba\smbconf. More
542 conveniently, the conf subcommand of the net(8) utility offers a
543 dedicated interface to read and write the registry based configuration
544 locally, i.e. directly accessing the database file, circumventing the
545 server.
546
548 In the SMB protocol, users, groups, and machines are represented by
549 their security identifiers (SIDs). On POSIX system Samba processes need
550 to run under corresponding POSIX user identities and with supplemental
551 POSIX groups to allow access to the files owned by those users and
552 groups. The process of mapping SIDs to POSIX users and groups is called
553 IDENTITY MAPPING or, in short, ID MAPPING.
554
555 Samba supports multiple ways to map SIDs to POSIX users and groups. The
556 configuration is driven by the idmap config DOMAIN : OPTION option
557 which allows one to specify identity mapping (idmap) options for each
558 domain separately.
559
560 Identity mapping modules implement different strategies for mapping of
561 SIDs to POSIX user and group identities. They are applicable to
562 different use cases and scenarios. It is advised to read the
563 documentation of the individual identity mapping modules before
564 choosing a specific scenario to use. Each identity management module is
565 documented in a separate manual page. The standard idmap backends are
566 tdb (idmap_tdb(8)), tdb2 (idmap_tdb2(8)), ldap (idmap_ldap(8)), rid
567 (idmap_rid(8)), hash (idmap_hash(8)), autorid (idmap_autorid(8)), ad
568 (idmap_ad(8)), nss (idmap_nss(8)), and rfc2307 (idmap_rfc2307(8)).
569
570 Overall, ID mapping configuration should be decided carefully. Changes
571 to the already deployed ID mapping configuration may create the risk of
572 losing access to the data or disclosing the data to the wrong parties.
573
574 This example shows how to configure two domains with idmap_rid(8), the
575 principal domain and a trusted domain, leaving the default id mapping
576 scheme at tdb.
577
578 [global]
579 security = domain
580 workgroup = MAIN
581
582 idmap config * : backend = tdb
583 idmap config * : range = 1000000-1999999
584
585 idmap config MAIN : backend = rid
586 idmap config MAIN : range = 5000000-5999999
587
588 idmap config TRUSTED : backend = rid
589 idmap config TRUSTED : range = 6000000-6999999
590
591
593 abort shutdown script (G)
594
595 This a full path name to a script called by smbd(8) that should
596 stop a shutdown procedure issued by the shutdown script.
597
598 If the connected user possesses the SeRemoteShutdownPrivilege,
599 right, this command will be run as root.
600
601 Default: abort shutdown script = ""
602
603 Example: abort shutdown script = /sbin/shutdown -c
604
605 access based share enum (S)
606
607 If this parameter is yes for a service, then the share hosted by
608 the service will only be visible to users who have read or write
609 access to the share during share enumeration (for example net view
610 \\sambaserver). The share ACLs which allow or deny the access to
611 the share can be modified using for example the sharesec command or
612 using the appropriate Windows tools. This has parallels to access
613 based enumeration, the main difference being that only share
614 permissions are evaluated, and security descriptors on files
615 contained on the share are not used in computing enumeration access
616 rights.
617
618 Default: access based share enum = no
619
620 acl allow execute always (S)
621
622 This boolean parameter controls the behaviour of smbd(8) when
623 receiving a protocol request of "open for execution" from a Windows
624 client. With Samba 3.6 and older, the execution right in the ACL
625 was not checked, so a client could execute a file even if it did
626 not have execute rights on the file. In Samba 4.0, this has been
627 fixed, so that by default, i.e. when this parameter is set to
628 "False", "open for execution" is now denied when execution
629 permissions are not present.
630
631 If this parameter is set to "True", Samba does not check execute
632 permissions on "open for execution", thus re-establishing the
633 behaviour of Samba 3.6. This can be useful to smoothen upgrades
634 from older Samba versions to 4.0 and newer. This setting is not
635 meant to be used as a permanent setting, but as a temporary relief:
636 It is recommended to fix the permissions in the ACLs and reset this
637 parameter to the default after a certain transition period.
638
639 Default: acl allow execute always = no
640
641 acl check permissions (S)
642
643 Please note this parameter is now deprecated in Samba 3.6.2 and
644 will be removed in a future version of Samba.
645
646 This boolean parameter controls what smbd(8) does on receiving a
647 protocol request of "open for delete" from a Windows client. If a
648 Windows client doesn't have permissions to delete a file then they
649 expect this to be denied at open time. POSIX systems normally only
650 detect restrictions on delete by actually attempting to delete the
651 file or directory. As Windows clients can (and do) "back out" a
652 delete request by unsetting the "delete on close" bit Samba cannot
653 delete the file immediately on "open for delete" request as we
654 cannot restore such a deleted file. With this parameter set to true
655 (the default) then smbd checks the file system permissions directly
656 on "open for delete" and denies the request without actually
657 deleting the file if the file system permissions would seem to deny
658 it. This is not perfect, as it's possible a user could have deleted
659 a file without Samba being able to check the permissions correctly,
660 but it is close enough to Windows semantics for mostly correct
661 behaviour. Samba will correctly check POSIX ACL semantics in this
662 case.
663
664 If this parameter is set to "false" Samba doesn't check permissions
665 on "open for delete" and allows the open. If the user doesn't have
666 permission to delete the file this will only be discovered at close
667 time, which is too late for the Windows user tools to display an
668 error message to the user. The symptom of this is files that appear
669 to have been deleted "magically" re-appearing on a Windows explorer
670 refresh. This is an extremely advanced protocol option which should
671 not need to be changed. This parameter was introduced in its final
672 form in 3.0.21, an earlier version with slightly different
673 semantics was introduced in 3.0.20. That older version is not
674 documented here.
675
676 Default: acl check permissions = yes
677
678 acl group control (S)
679
680 In a POSIX filesystem, only the owner of a file or directory and
681 the superuser can modify the permissions and ACLs on a file. If
682 this parameter is set, then Samba overrides this restriction, and
683 also allows the primary group owner of a file or directory to
684 modify the permissions and ACLs on that file.
685
686 On a Windows server, groups may be the owner of a file or directory
687 - thus allowing anyone in that group to modify the permissions on
688 it. This allows the delegation of security controls on a point in
689 the filesystem to the group owner of a directory and anything below
690 it also owned by that group. This means there are multiple people
691 with permissions to modify ACLs on a file or directory, easing
692 manageability.
693
694 This parameter allows Samba to also permit delegation of the
695 control over a point in the exported directory hierarchy in much
696 the same way as Windows. This allows all members of a UNIX group to
697 control the permissions on a file or directory they have group
698 ownership on.
699
700 This parameter is best used with the inherit owner option and also
701 on a share containing directories with the UNIX setgid bit set on
702 them, which causes new files and directories created within it to
703 inherit the group ownership from the containing directory.
704
705 This parameter was deprecated in Samba 3.0.23, but re-activated in
706 Samba 3.0.31 and above, as it now only controls permission changes
707 if the user is in the owning primary group. It is now no longer
708 equivalent to the dos filemode option.
709
710 Default: acl group control = no
711
712 acl map full control (S)
713
714 This boolean parameter controls whether smbd(8) maps a POSIX ACE
715 entry of "rwx" (read/write/execute), the maximum allowed POSIX
716 permission set, into a Windows ACL of "FULL CONTROL". If this
717 parameter is set to true any POSIX ACE entry of "rwx" will be
718 returned in a Windows ACL as "FULL CONTROL", is this parameter is
719 set to false any POSIX ACE entry of "rwx" will be returned as the
720 specific Windows ACL bits representing read, write and execute.
721
722 Default: acl map full control = yes
723
724 add group script (G)
725
726 This is the full pathname to a script that will be run AS ROOT by
727 smbd(8) when a new group is requested. It will expand any %g to the
728 group name passed. This script is only useful for installations
729 using the Windows NT domain administration tools. The script is
730 free to create a group with an arbitrary name to circumvent unix
731 group name restrictions. In that case the script must print the
732 numeric gid of the created group on stdout.
733
734 Default: add group script =
735
736 Example: add group script = /usr/sbin/groupadd %g
737
738 additional dns hostnames (G)
739
740 A list of additional DNS names by which this host can be identified
741
742 Default: additional dns hostnames = # empty string (no additional
743 dns names)
744
745 Example: additional dns hostnames = host2.example.com
746 host3.other.com
747
748 add machine script (G)
749
750 This is the full pathname to a script that will be run by smbd(8)
751 when a machine is added to Samba's domain and a Unix account
752 matching the machine's name appended with a "$" does not already
753 exist.
754
755 This option is very similar to the add user script, and likewise
756 uses the %u substitution for the account name. Do not use the %m
757 substitution.
758
759 Default: add machine script =
760
761 Example: add machine script = /usr/sbin/adduser -n -g machines -c
762 Machine -d /var/lib/nobody -s /bin/false %u
763
764 addport command (G)
765
766 Samba 3.0.23 introduced support for adding printer ports remotely
767 using the Windows "Add Standard TCP/IP Port Wizard". This option
768 defines an external program to be executed when smbd receives a
769 request to add a new Port to the system. The script is passed two
770 parameters:
771
772 · port name
773
774 · device URI
775
776 The deviceURI is in the format of
777 socket://<hostname>[:<portnumber>] or lpd://<hostname>/<queuename>.
778
779 Default: addport command =
780
781 Example: addport command = /etc/samba/scripts/addport.sh
782
783 addprinter command (G)
784
785 With the introduction of MS-RPC based printing support for Windows
786 NT/2000 clients in Samba 2.2, The MS Add Printer Wizard (APW) icon
787 is now also available in the "Printers..." folder displayed a share
788 listing. The APW allows for printers to be add remotely to a Samba
789 or Windows NT/2000 print server.
790
791 For a Samba host this means that the printer must be physically
792 added to the underlying printing system. The addprinter command
793 defines a script to be run which will perform the necessary
794 operations for adding the printer to the print system and to add
795 the appropriate service definition to the smb.conf file in order
796 that it can be shared by smbd(8).
797
798 The addprinter command is automatically invoked with the following
799 parameter (in order):
800
801 · printer name
802
803 · share name
804
805 · port name
806
807 · driver name
808
809 · location
810
811 · Windows 9x driver location
812
813 All parameters are filled in from the PRINTER_INFO_2 structure sent
814 by the Windows NT/2000 client with one exception. The "Windows 9x
815 driver location" parameter is included for backwards compatibility
816 only. The remaining fields in the structure are generated from
817 answers to the APW questions.
818
819 Once the addprinter command has been executed, smbd will reparse
820 the smb.conf to determine if the share defined by the APW exists.
821 If the sharename is still invalid, then smbd will return an
822 ACCESS_DENIED error to the client.
823
824 The addprinter command program can output a single line of text,
825 which Samba will set as the port the new printer is connected to.
826 If this line isn't output, Samba won't reload its printer shares.
827
828 Default: addprinter command =
829
830 Example: addprinter command = /usr/bin/addprinter
831
832 add share command (G)
833
834 Samba 2.2.0 introduced the ability to dynamically add and delete
835 shares via the Windows NT 4.0 Server Manager. The add share command
836 is used to define an external program or script which will add a
837 new service definition to smb.conf.
838
839 In order to successfully execute the add share command, smbd
840 requires that the administrator connects using a root account (i.e.
841 uid == 0) or has the SeDiskOperatorPrivilege. Scripts defined in
842 the add share command parameter are executed as root.
843
844 When executed, smbd will automatically invoke the add share command
845 with five parameters.
846
847 · configFile - the location of the global smb.conf file.
848
849 · shareName - the name of the new share.
850
851 · pathName - path to an **existing** directory on disk.
852
853 · comment - comment string to associate with the new
854 share.
855
856 · max connections Number of maximum simultaneous
857 connections to this share.
858
859 This parameter is only used to add file shares. To add printer
860 shares, see the addprinter command.
861
862 Default: add share command =
863
864 Example: add share command = /usr/local/bin/addshare
865
866 add user script (G)
867
868 This is the full pathname to a script that will be run AS ROOT by
869 smbd(8) under special circumstances described below.
870
871 Normally, a Samba server requires that UNIX users are created for
872 all users accessing files on this server. For sites that use
873 Windows NT account databases as their primary user database
874 creating these users and keeping the user list in sync with the
875 Windows NT PDC is an onerous task. This option allows smbd to
876 create the required UNIX users ON DEMAND when a user accesses the
877 Samba server.
878
879 When the Windows user attempts to access the Samba server, at login
880 (session setup in the SMB protocol) time, smbd(8) contacts the
881 password server and attempts to authenticate the given user with
882 the given password. If the authentication succeeds then smbd
883 attempts to find a UNIX user in the UNIX password database to map
884 the Windows user into. If this lookup fails, and add user script is
885 set then smbd will call the specified script AS ROOT, expanding any
886 %u argument to be the user name to create.
887
888 If this script successfully creates the user then smbd will
889 continue on as though the UNIX user already existed. In this way,
890 UNIX users are dynamically created to match existing Windows NT
891 accounts.
892
893 See also security, password server, delete user script.
894
895 Default: add user script =
896
897 Example: add user script = /usr/local/samba/bin/add_user %u
898
899 add user to group script (G)
900
901 Full path to the script that will be called when a user is added to
902 a group using the Windows NT domain administration tools. It will
903 be run by smbd(8) AS ROOT. Any %g will be replaced with the group
904 name and any %u will be replaced with the user name.
905
906 Note that the adduser command used in the example below does not
907 support the used syntax on all systems.
908
909 Default: add user to group script =
910
911 Example: add user to group script = /usr/sbin/adduser %u %g
912
913 administrative share (S)
914
915 If this parameter is set to yes for a share, then the share will be
916 an administrative share. The Administrative Shares are the default
917 network shares created by all Windows NT-based operating systems.
918 These are shares like C$, D$ or ADMIN$. The type of these shares is
919 STYPE_DISKTREE_HIDDEN.
920
921 See the section below on security for more information about this
922 option.
923
924 Default: administrative share = no
925
926 admin users (S)
927
928 This is a list of users who will be granted administrative
929 privileges on the share. This means that they will do all file
930 operations as the super-user (root).
931
932 You should use this option very carefully, as any user in this list
933 will be able to do anything they like on the share, irrespective of
934 file permissions.
935
936 Default: admin users =
937
938 Example: admin users = jason
939
940 afs share (S)
941
942 This parameter controls whether special AFS features are enabled
943 for this share. If enabled, it assumes that the directory exported
944 via the path parameter is a local AFS import. The special AFS
945 features include the attempt to hand-craft an AFS token if you
946 enabled --with-fake-kaserver in configure.
947
948 Default: afs share = no
949
950 afs token lifetime (G)
951
952 This parameter controls the lifetime of tokens that the AFS
953 fake-kaserver claims. In reality these never expire but this
954 lifetime controls when the afs client will forget the token.
955
956 Set this parameter to 0 to get NEVERDATE.
957
958 Default: afs token lifetime = 604800
959
960 afs username map (G)
961
962 If you are using the fake kaserver AFS feature, you might want to
963 hand-craft the usernames you are creating tokens for. For example
964 this is necessary if you have users from several domain in your AFS
965 Protection Database. One possible scheme to code users as
966 DOMAIN+User as it is done by winbind with the + as a separator.
967
968 The mapped user name must contain the cell name to log into, so
969 without setting this parameter there will be no token.
970
971 Default: afs username map =
972
973 Example: afs username map = %u@afs.samba.org
974
975 aio max threads (G)
976
977 The integer parameter specifies the maximum number of threads each
978 smbd process will create when doing parallel asynchronous IO calls.
979 If the number of outstanding calls is greater than this number the
980 requests will not be refused but go onto a queue and will be
981 scheduled in turn as outstanding requests complete.
982
983 Related command: aio read size
984
985 Related command: aio write size
986
987 Default: aio max threads = 100
988
989 aio read size (S)
990
991 If this integer parameter is set to a non-zero value, Samba will
992 read from files asynchronously when the request size is bigger than
993 this value. Note that it happens only for non-chained and
994 non-chaining reads and when not using write cache.
995
996 The only reasonable values for this parameter are 0 (no async I/O)
997 and 1 (always do async I/O).
998
999 Related command: write cache size
1000
1001 Related command: aio write size
1002
1003 Default: aio read size = 1
1004
1005 Example: aio read size = 0 # Always do reads synchronously
1006
1007 aio write behind (S)
1008
1009 If Samba has been built with asynchronous I/O support, Samba will
1010 not wait until write requests are finished before returning the
1011 result to the client for files listed in this parameter. Instead,
1012 Samba will immediately return that the write request has been
1013 finished successfully, no matter if the operation will succeed or
1014 not. This might speed up clients without aio support, but is really
1015 dangerous, because data could be lost and files could be damaged.
1016
1017 The syntax is identical to the veto files parameter.
1018
1019 Default: aio write behind =
1020
1021 Example: aio write behind = /*.tmp/
1022
1023 aio write size (S)
1024
1025 If this integer parameter is set to a non-zero value, Samba will
1026 write to files asynchronously when the request size is bigger than
1027 this value. Note that it happens only for non-chained and
1028 non-chaining reads and when not using write cache.
1029
1030 The only reasonable values for this parameter are 0 (no async I/O)
1031 and 1 (always do async I/O).
1032
1033 Compared to aio read size this parameter has a smaller effect, most
1034 writes should end up in the file system cache. Writes that require
1035 space allocation might benefit most from going asynchronous.
1036
1037 Related command: write cache size
1038
1039 Related command: aio read size
1040
1041 Default: aio write size = 1
1042
1043 Example: aio write size = 0 # Always do writes synchronously
1044
1045 algorithmic rid base (G)
1046
1047 This determines how Samba will use its algorithmic mapping from
1048 uids/gid to the RIDs needed to construct NT Security Identifiers.
1049
1050 Setting this option to a larger value could be useful to sites
1051 transitioning from WinNT and Win2k, as existing user and group rids
1052 would otherwise clash with system users etc.
1053
1054 All UIDs and GIDs must be able to be resolved into SIDs for the
1055 correct operation of ACLs on the server. As such the algorithmic
1056 mapping can't be 'turned off', but pushing it 'out of the way'
1057 should resolve the issues. Users and groups can then be assigned
1058 'low' RIDs in arbitrary-rid supporting backends.
1059
1060 Default: algorithmic rid base = 1000
1061
1062 Example: algorithmic rid base = 100000
1063
1064 allocation roundup size (S)
1065
1066 This parameter allows an administrator to tune the allocation size
1067 reported to Windows clients. This is only useful for old SMB1
1068 clients because modern SMB dialects eliminated that bottleneck and
1069 have better performance by default. Using this parameter may cause
1070 difficulties for some applications, e.g. MS Visual Studio. If the
1071 MS Visual Studio compiler starts to crash with an internal error,
1072 set this parameter to zero for this share. Settings this parameter
1073 to a large value can also cause small files to allocate more space
1074 on the disk than needed.
1075
1076 This parameter is deprecated and will be removed in one of the next
1077 Samba releases.
1078
1079 The integer parameter specifies the roundup size in bytes.
1080
1081 Default: allocation roundup size = 0
1082
1083 Example: allocation roundup size = 1048576 # (to set it to the
1084 former default of 1 MiB)
1085
1086 allow dcerpc auth level connect (G)
1087
1088 This option controls whether DCERPC services are allowed to be used
1089 with DCERPC_AUTH_LEVEL_CONNECT, which provides authentication, but
1090 no per message integrity nor privacy protection.
1091
1092 Some interfaces like samr, lsarpc and netlogon have a hard-coded
1093 default of no and epmapper, mgmt and rpcecho have a hard-coded
1094 default of yes.
1095
1096 The behavior can be overwritten per interface name (e.g. lsarpc,
1097 netlogon, samr, srvsvc, winreg, wkssvc ...) by using 'allow dcerpc
1098 auth level connect:interface = yes' as option.
1099
1100 This option yields precedence to the implementation specific
1101 restrictions. E.g. the drsuapi and backupkey protocols require
1102 DCERPC_AUTH_LEVEL_PRIVACY. The dnsserver protocol requires
1103 DCERPC_AUTH_LEVEL_INTEGRITY.
1104
1105 Default: allow dcerpc auth level connect = no
1106
1107 Example: allow dcerpc auth level connect = yes
1108
1109 allow dns updates (G)
1110
1111 This option determines what kind of updates to the DNS are allowed.
1112
1113 DNS updates can either be disallowed completely by setting it to
1114 disabled, enabled over secure connections only by setting it to
1115 secure only or allowed in all cases by setting it to nonsecure.
1116
1117 Default: allow dns updates = secure only
1118
1119 Example: allow dns updates = disabled
1120
1121 allow insecure wide links (G)
1122
1123 In normal operation the option wide links which allows the server
1124 to follow symlinks outside of a share path is automatically
1125 disabled when unix extensions are enabled on a Samba server. This
1126 is done for security purposes to prevent UNIX clients creating
1127 symlinks to areas of the server file system that the administrator
1128 does not wish to export.
1129
1130 Setting allow insecure wide links to true disables the link between
1131 these two parameters, removing this protection and allowing a site
1132 to configure the server to follow symlinks (by setting wide links
1133 to "true") even when unix extensions is turned on.
1134
1135 It is not recommended to enable this option unless you fully
1136 understand the implications of allowing the server to follow
1137 symbolic links created by UNIX clients. For most normal Samba
1138 configurations this would be considered a security hole and setting
1139 this parameter is not recommended.
1140
1141 This option was added at the request of sites who had deliberately
1142 set Samba up in this way and needed to continue supporting this
1143 functionality without having to patch the Samba code.
1144
1145 Default: allow insecure wide links = no
1146
1147 allow nt4 crypto (G)
1148
1149 This option controls whether the netlogon server (currently only in
1150 'active directory domain controller' mode), will reject clients
1151 which does not support NETLOGON_NEG_STRONG_KEYS nor
1152 NETLOGON_NEG_SUPPORTS_AES.
1153
1154 This option was added with Samba 4.2.0. It may lock out clients
1155 which worked fine with Samba versions up to 4.1.x. as the effective
1156 default was "yes" there, while it is "no" now.
1157
1158 If you have clients without RequireStrongKey = 1 in the registry,
1159 you may need to set "allow nt4 crypto = yes", until you have fixed
1160 all clients.
1161
1162 "allow nt4 crypto = yes" allows weak crypto to be negotiated, maybe
1163 via downgrade attacks.
1164
1165 This option yields precedence to the 'reject md5 clients' option.
1166
1167 Default: allow nt4 crypto = no
1168
1169 allow trusted domains (G)
1170
1171 This option only takes effect when the security option is set to
1172 server, domain or ads. If it is set to no, then attempts to connect
1173 to a resource from a domain or workgroup other than the one which
1174 smbd is running in will fail, even if that domain is trusted by the
1175 remote server doing the authentication.
1176
1177 This is useful if you only want your Samba server to serve
1178 resources to users in the domain it is a member of. As an example,
1179 suppose that there are two domains DOMA and DOMB. DOMB is trusted
1180 by DOMA, which contains the Samba server. Under normal
1181 circumstances, a user with an account in DOMB can then access the
1182 resources of a UNIX account with the same account name on the Samba
1183 server even if they do not have an account in DOMA. This can make
1184 implementing a security boundary difficult.
1185
1186 Default: allow trusted domains = yes
1187
1188 allow unsafe cluster upgrade (G)
1189
1190 If set to no (the default), smbd checks at startup if other smbd
1191 versions are running in the cluster and refuses to start if so.
1192 This is done to protect data corruption in internal data structures
1193 due to incompatible Samba versions running concurrently in the same
1194 cluster. Setting this parameter to yes disables this safety check.
1195
1196 Default: allow unsafe cluster upgrade = no
1197
1198 apply group policies (G)
1199
1200 This option controls whether winbind will execute the gpupdate
1201 command defined in gpo update command on the Group Policy update
1202 interval. The Group Policy update interval is defined as every 90
1203 minutes, plus a random offset between 0 and 30 minutes. This
1204 applies Group Policy Machine polices to the client or KDC and
1205 machine policies to a server.
1206
1207 Default: apply group policies = no
1208
1209 Example: apply group policies = yes
1210
1211 async smb echo handler (G)
1212
1213 This parameter specifies whether Samba should fork the async smb
1214 echo handler. It can be beneficial if your file system can block
1215 syscalls for a very long time. In some circumstances, it prolongs
1216 the timeout that Windows uses to determine whether a connection is
1217 dead. This parameter is only for SMB1. For SMB2 and above TCP
1218 keepalives can be used instead.
1219
1220 Default: async smb echo handler = no
1221
1222 auth event notification (G)
1223
1224 When enabled, this option causes Samba (acting as an Active
1225 Directory Domain Controller) to stream authentication events across
1226 the internal message bus. Scripts built using Samba's python
1227 bindings can listen to these events by registering as the service
1228 auth_event.
1229
1230 This should be considered a developer option (it assists in the
1231 Samba testsuite) rather than a facility for external auditing, as
1232 message delivery is not guaranteed (a feature that the testsuite
1233 works around). Additionally Samba must be compiled with the jansson
1234 support for this option to be effective.
1235
1236 The authentication events are also logged via the normal logging
1237 methods when the log level is set appropriately.
1238
1239 Default: auth event notification = no
1240
1241 preload
1242
1243 This parameter is a synonym for auto services.
1244
1245 auto services (G)
1246
1247 This is a list of services that you want to be automatically added
1248 to the browse lists. This is most useful for homes and printers
1249 services that would otherwise not be visible.
1250
1251 Note that if you just want all printers in your printcap file
1252 loaded then the load printers option is easier.
1253
1254 Default: auto services =
1255
1256 Example: auto services = fred lp colorlp
1257
1258 available (S)
1259
1260 This parameter lets you "turn off" a service. If available = no,
1261 then ALL attempts to connect to the service will fail. Such
1262 failures are logged.
1263
1264 Default: available = yes
1265
1266 bind dns directory
1267
1268 This parameter is a synonym for binddns dir.
1269
1270 binddns dir (G)
1271
1272 This parameters defines the directory samba will use to store the
1273 configuration files for bind, such as named.conf. NOTE: The bind
1274 dns directory needs to be on the same mount point as the private
1275 directory!
1276
1277 Default: binddns dir = /var/lib/samba/bind-dns
1278
1279 bind interfaces only (G)
1280
1281 This global parameter allows the Samba admin to limit what
1282 interfaces on a machine will serve SMB requests. It affects file
1283 service smbd(8) and name service nmbd(8) in a slightly different
1284 ways.
1285
1286 For name service it causes nmbd to bind to ports 137 and 138 on the
1287 interfaces listed in the interfaces parameter. nmbd also binds to
1288 the "all addresses" interface (0.0.0.0) on ports 137 and 138 for
1289 the purposes of reading broadcast messages. If this option is not
1290 set then nmbd will service name requests on all of these sockets.
1291 If bind interfaces only is set then nmbd will check the source
1292 address of any packets coming in on the broadcast sockets and
1293 discard any that don't match the broadcast addresses of the
1294 interfaces in the interfaces parameter list. As unicast packets are
1295 received on the other sockets it allows nmbd to refuse to serve
1296 names to machines that send packets that arrive through any
1297 interfaces not listed in the interfaces list. IP Source address
1298 spoofing does defeat this simple check, however, so it must not be
1299 used seriously as a security feature for nmbd.
1300
1301 For file service it causes smbd(8) to bind only to the interface
1302 list given in the interfaces parameter. This restricts the networks
1303 that smbd will serve, to packets coming in on those interfaces.
1304 Note that you should not use this parameter for machines that are
1305 serving PPP or other intermittent or non-broadcast network
1306 interfaces as it will not cope with non-permanent interfaces.
1307
1308 If bind interfaces only is set and the network address 127.0.0.1 is
1309 not added to the interfaces parameter list smbpasswd(8) may not
1310 work as expected due to the reasons covered below.
1311
1312 To change a users SMB password, the smbpasswd by default connects
1313 to the localhost - 127.0.0.1 address as an SMB client to issue the
1314 password change request. If bind interfaces only is set then unless
1315 the network address 127.0.0.1 is added to the interfaces parameter
1316 list then smbpasswd will fail to connect in it's default mode.
1317 smbpasswd can be forced to use the primary IP interface of the
1318 local host by using its smbpasswd(8) -r remote machine parameter,
1319 with remote machine set to the IP name of the primary interface of
1320 the local host.
1321
1322 Default: bind interfaces only = no
1323
1324 blocking locks (S)
1325
1326 This parameter controls the behavior of smbd(8) when given a
1327 request by a client to obtain a byte range lock on a region of an
1328 open file, and the request has a time limit associated with it.
1329
1330 If this parameter is set and the lock range requested cannot be
1331 immediately satisfied, samba will internally queue the lock
1332 request, and periodically attempt to obtain the lock until the
1333 timeout period expires.
1334
1335 If this parameter is set to no, then samba will behave as previous
1336 versions of Samba would and will fail the lock request immediately
1337 if the lock range cannot be obtained.
1338
1339 Default: blocking locks = yes
1340
1341 block size (S)
1342
1343 This parameter controls the behavior of smbd(8) when reporting disk
1344 free sizes. By default, this reports a disk block size of 1024
1345 bytes.
1346
1347 Changing this parameter may have some effect on the efficiency of
1348 client writes, this is not yet confirmed. This parameter was added
1349 to allow advanced administrators to change it (usually to a higher
1350 value) and test the effect it has on client write performance
1351 without re-compiling the code. As this is an experimental option it
1352 may be removed in a future release.
1353
1354 Changing this option does not change the disk free reporting size,
1355 just the block size unit reported to the client.
1356
1357 Default: block size = 1024
1358
1359 Example: block size = 4096
1360
1361 browsable
1362
1363 This parameter is a synonym for browseable.
1364
1365 browseable (S)
1366
1367 This controls whether this share is seen in the list of available
1368 shares in a net view and in the browse list.
1369
1370 Default: browseable = yes
1371
1372 browse list (G)
1373
1374 This controls whether smbd(8) will serve a browse list to a client
1375 doing a NetServerEnum call. Normally set to yes. You should never
1376 need to change this.
1377
1378 Default: browse list = yes
1379
1380 cache directory (G)
1381
1382 Usually, most of the TDB files are stored in the lock directory.
1383 Since Samba 3.4.0, it is possible to differentiate between TDB
1384 files with persistent data and TDB files with non-persistent data
1385 using the state directory and the cache directory options.
1386
1387 This option specifies the directory for storing TDB files
1388 containing non-persistent data that will be kept across service
1389 restarts. The directory should be placed on persistent storage, but
1390 the data can be safely deleted by an administrator.
1391
1392 Default: cache directory = /var/lib/samba
1393
1394 Example: cache directory = /var/run/samba/locks/cache
1395
1396 casesignames
1397
1398 This parameter is a synonym for case sensitive.
1399
1400 case sensitive (S)
1401
1402 See the discussion in the section name mangling.
1403
1404 Default: case sensitive = auto
1405
1406 change notify (G)
1407
1408 This parameter specifies whether Samba should reply to a client's
1409 file change notify requests.
1410
1411 You should never need to change this parameter
1412
1413 Default: change notify = yes
1414
1415 change share command (G)
1416
1417 Samba 2.2.0 introduced the ability to dynamically add and delete
1418 shares via the Windows NT 4.0 Server Manager. The change share
1419 command is used to define an external program or script which will
1420 modify an existing service definition in smb.conf.
1421
1422 In order to successfully execute the change share command, smbd
1423 requires that the administrator connects using a root account (i.e.
1424 uid == 0) or has the SeDiskOperatorPrivilege. Scripts defined in
1425 the change share command parameter are executed as root.
1426
1427 When executed, smbd will automatically invoke the change share
1428 command with six parameters.
1429
1430 · configFile - the location of the global smb.conf file.
1431
1432 · shareName - the name of the new share.
1433
1434 · pathName - path to an **existing** directory on disk.
1435
1436 · comment - comment string to associate with the new
1437 share.
1438
1439 · max connections Number of maximum simultaneous
1440 connections to this share.
1441
1442 · CSC policy - client side caching policy in string form.
1443 Valid values are: manual, documents, programs, disable.
1444
1445 This parameter is only used to modify existing file share
1446 definitions. To modify printer shares, use the "Printers..." folder
1447 as seen when browsing the Samba host.
1448
1449 Default: change share command =
1450
1451 Example: change share command = /usr/local/bin/changeshare
1452
1453 check parent directory delete on close (S)
1454
1455 A Windows SMB server prevents the client from creating files in a
1456 directory that has the delete-on-close flag set. By default Samba
1457 doesn't perform this check as this check is a quite expensive
1458 operation in Samba.
1459
1460 Default: check parent directory delete on close = no
1461
1462 check password script (G)
1463
1464 The name of a program that can be used to check password
1465 complexity. The password is sent to the program's standard input.
1466
1467 The program must return 0 on a good password, or any other value if
1468 the password is bad. In case the password is considered weak (the
1469 program does not return 0) the user will be notified and the
1470 password change will fail.
1471
1472 In Samba AD, this script will be run AS ROOT by samba(8) without
1473 any substitutions.
1474
1475 Note that starting with Samba 4.11 the following environment
1476 variables are exported to the script:
1477
1478 · SAMBA_CPS_ACCOUNT_NAME is always present and contains
1479 the sAMAccountName of user, the is the same as the %u
1480 substitutions in the none AD DC case.
1481
1482 · SAMBA_CPS_USER_PRINCIPAL_NAME is optional in the AD DC
1483 case if the userPrincipalName is present.
1484
1485 · SAMBA_CPS_FULL_NAME is optional if the displayName is
1486 present.
1487
1488 Note: In the example directory is a sample program called
1489 crackcheck that uses cracklib to check the password quality.
1490
1491 Default: check password script = # Disabled
1492
1493 Example: check password script = /usr/local/sbin/crackcheck
1494
1495 cldap port (G)
1496
1497 This option controls the port used by the CLDAP protocol.
1498
1499 Default: cldap port = 389
1500
1501 Example: cldap port = 3389
1502
1503 client ipc max protocol (G)
1504
1505 The value of the parameter (a string) is the highest protocol level
1506 that will be supported for IPC$ connections as DCERPC transport.
1507
1508 Normally this option should not be set as the automatic negotiation
1509 phase in the SMB protocol takes care of choosing the appropriate
1510 protocol.
1511
1512 The value default refers to the latest supported protocol,
1513 currently SMB3_11.
1514
1515 See client max protocol for a full list of available protocols. The
1516 values CORE, COREPLUS, LANMAN1, LANMAN2 are silently upgraded to
1517 NT1.
1518
1519 Default: client ipc max protocol = default
1520
1521 Example: client ipc max protocol = SMB2_10
1522
1523 client ipc min protocol (G)
1524
1525 This setting controls the minimum protocol version that the will be
1526 attempted to use for IPC$ connections as DCERPC transport.
1527
1528 Normally this option should not be set as the automatic negotiation
1529 phase in the SMB protocol takes care of choosing the appropriate
1530 protocol.
1531
1532 The value default refers to the higher value of NT1 and the
1533 effective value of client min protocol.
1534
1535 See client max protocol for a full list of available protocols. The
1536 values CORE, COREPLUS, LANMAN1, LANMAN2 are silently upgraded to
1537 NT1.
1538
1539 Default: client ipc min protocol = default
1540
1541 Example: client ipc min protocol = SMB3_11
1542
1543 client ipc signing (G)
1544
1545 This controls whether the client is allowed or required to use SMB
1546 signing for IPC$ connections as DCERPC transport. Possible values
1547 are auto, mandatory and disabled.
1548
1549 When set to mandatory or default, SMB signing is required.
1550
1551 When set to auto, SMB signing is offered, but not enforced and if
1552 set to disabled, SMB signing is not offered either.
1553
1554 Connections from winbindd to Active Directory Domain Controllers
1555 always enforce signing.
1556
1557 Default: client ipc signing = default
1558
1559 client lanman auth (G)
1560
1561 This parameter has been deprecated since Samba 4.13 and support for
1562 LanMan (as distinct from NTLM, NTLMv2 or Kerberos) authentication
1563 as a client will be removed in a future Samba release.
1564
1565 That is, in the future, the current default of client NTLMv2 auth =
1566 yes will be the enforced behaviour.
1567
1568 This parameter determines whether or not smbclient(8) and other
1569 samba client tools will attempt to authenticate itself to servers
1570 using the weaker LANMAN password hash. If disabled, only server
1571 which support NT password hashes (e.g. Windows NT/2000, Samba,
1572 etc... but not Windows 95/98) will be able to be connected from the
1573 Samba client.
1574
1575 The LANMAN encrypted response is easily broken, due to its
1576 case-insensitive nature, and the choice of algorithm. Clients
1577 without Windows 95/98 servers are advised to disable this option.
1578
1579 Disabling this option will also disable the client plaintext auth
1580 option.
1581
1582 Likewise, if the client ntlmv2 auth parameter is enabled, then only
1583 NTLMv2 logins will be attempted.
1584
1585 Default: client lanman auth = no
1586
1587 client ldap sasl wrapping (G)
1588
1589 The client ldap sasl wrapping defines whether ldap traffic will be
1590 signed or signed and encrypted (sealed). Possible values are plain,
1591 sign and seal.
1592
1593 The values sign and seal are only available if Samba has been
1594 compiled against a modern OpenLDAP version (2.3.x or higher).
1595
1596 This option is needed in the case of Domain Controllers enforcing
1597 the usage of signed LDAP connections (e.g. Windows 2000 SP3 or
1598 higher). LDAP sign and seal can be controlled with the registry key
1599 "HKLM\System\CurrentControlSet\Services\
1600 NTDS\Parameters\LDAPServerIntegrity" on the Windows server side.
1601
1602 Depending on the used KRB5 library (MIT and older Heimdal versions)
1603 it is possible that the message "integrity only" is not supported.
1604 In this case, sign is just an alias for seal.
1605
1606 The default value is sign. That implies synchronizing the time with
1607 the KDC in the case of using Kerberos.
1608
1609 Default: client ldap sasl wrapping = sign
1610
1611 client max protocol (G)
1612
1613 The value of the parameter (a string) is the highest protocol level
1614 that will be supported by the client.
1615
1616 Possible values are :
1617
1618 · CORE: Earliest version. No concept of user names.
1619
1620 · COREPLUS: Slight improvements on CORE for efficiency.
1621
1622 · LANMAN1: First modern version of the protocol. Long
1623 filename support.
1624
1625 · LANMAN2: Updates to Lanman1 protocol.
1626
1627 · NT1: Current up to date version of the protocol. Used by
1628 Windows NT. Known as CIFS.
1629
1630 · SMB2: Re-implementation of the SMB protocol. Used by
1631 Windows Vista and later versions of Windows. SMB2 has
1632 sub protocols available.
1633
1634 · SMB2_02: The earliest SMB2 version.
1635
1636 · SMB2_10: Windows 7 SMB2 version.
1637
1638 · SMB2_22: Early Windows 8 SMB2 version.
1639
1640 · SMB2_24: Windows 8 beta SMB2 version.
1641
1642 By default SMB2 selects the SMB2_10 variant.
1643
1644 · SMB3: The same as SMB2. Used by Windows 8. SMB3 has sub
1645 protocols available.
1646
1647 · SMB3_00: Windows 8 SMB3 version. (mostly the
1648 same as SMB2_24)
1649
1650 · SMB3_02: Windows 8.1 SMB3 version.
1651
1652 · SMB3_10: early Windows 10 technical preview
1653 SMB3 version.
1654
1655 · SMB3_11: Windows 10 technical preview SMB3
1656 version (maybe final).
1657
1658 By default SMB3 selects the SMB3_11 variant.
1659
1660 Normally this option should not be set as the automatic negotiation
1661 phase in the SMB protocol takes care of choosing the appropriate
1662 protocol.
1663
1664 The value default refers to SMB3_11.
1665
1666 IPC$ connections for DCERPC e.g. in winbindd, are handled by the
1667 client ipc max protocol option.
1668
1669 Default: client max protocol = default
1670
1671 Example: client max protocol = LANMAN1
1672
1673 client min protocol (G)
1674
1675 This setting controls the minimum protocol version that the client
1676 will attempt to use.
1677
1678 Normally this option should not be set as the automatic negotiation
1679 phase in the SMB protocol takes care of choosing the appropriate
1680 protocol unless you connect to a legacy SMB1-only server.
1681
1682 See Related command: client max protocol for a full list of
1683 available protocols.
1684
1685 IPC$ connections for DCERPC e.g. in winbindd, are handled by the
1686 client ipc min protocol option.
1687
1688 Note that most command line tools support --option='client min
1689 protocol=NT1', so it may not be required to enable SMB1 protocols
1690 globally in smb.conf.
1691
1692 Default: client min protocol = SMB2_02
1693
1694 Example: client min protocol = NT1
1695
1696 client NTLMv2 auth (G)
1697
1698 This parameter has been deprecated since Samba 4.13 and support for
1699 NTLM and LanMan (as distinct from NTLMv2 or Kerberos
1700 authentication) will be removed in a future Samba release.
1701
1702 That is, in the future, the current default of client NTLMv2 auth =
1703 yes will be the enforced behaviour.
1704
1705 This parameter determines whether or not smbclient(8) will attempt
1706 to authenticate itself to servers using the NTLMv2 encrypted
1707 password response.
1708
1709 If enabled, only an NTLMv2 and LMv2 response (both much more secure
1710 than earlier versions) will be sent. Older servers (including NT4 <
1711 SP4, Win9x and Samba 2.2) are not compatible with NTLMv2 when not
1712 in an NTLMv2 supporting domain
1713
1714 Similarly, if enabled, NTLMv1, client lanman auth and client
1715 plaintext auth authentication will be disabled. This also disables
1716 share-level authentication.
1717
1718 If disabled, an NTLM response (and possibly a LANMAN response) will
1719 be sent by the client, depending on the value of client lanman
1720 auth.
1721
1722 Note that Windows Vista and later versions already use NTLMv2 by
1723 default, and some sites (particularly those following 'best
1724 practice' security polices) only allow NTLMv2 responses, and not
1725 the weaker LM or NTLM.
1726
1727 When client use spnego is also set to yes extended security
1728 (SPNEGO) is required in order to use NTLMv2 only within NTLMSSP.
1729 This behavior was introduced with the patches for CVE-2016-2111.
1730
1731 Default: client NTLMv2 auth = yes
1732
1733 client plaintext auth (G)
1734
1735 This parameter has been deprecated since Samba 4.13 and support for
1736 plaintext (as distinct from NTLM, NTLMv2 or Kerberos
1737 authentication) will be removed in a future Samba release.
1738
1739 That is, in the future, the current default of client plaintext
1740 auth = no will be the enforced behaviour.
1741
1742 Specifies whether a client should send a plaintext password if the
1743 server does not support encrypted passwords.
1744
1745 Default: client plaintext auth = no
1746
1747 client schannel (G)
1748
1749 This option is deprecated with Samba 4.8 and will be removed in
1750 future. At the same time the default changed to yes, which will be
1751 the hardcoded behavior in future.
1752
1753 This controls whether the client offers or even demands the use of
1754 the netlogon schannel. client schannel = no does not offer the
1755 schannel, client schannel = auto offers the schannel but does not
1756 enforce it, and client schannel = yes denies access if the server
1757 is not able to speak netlogon schannel.
1758
1759 Note that for active directory domains this is hardcoded to client
1760 schannel = yes.
1761
1762 This option yields precedence to the require strong key option.
1763
1764 Default: client schannel = yes
1765
1766 Example: client schannel = auto
1767
1768 client signing (G)
1769
1770 This controls whether the client is allowed or required to use SMB
1771 signing. Possible values are auto, mandatory and disabled.
1772
1773 When set to auto or default, SMB signing is offered, but not
1774 enforced.
1775
1776 When set to mandatory, SMB signing is required and if set to
1777 disabled, SMB signing is not offered either.
1778
1779 IPC$ connections for DCERPC e.g. in winbindd, are handled by the
1780 client ipc signing option.
1781
1782 Default: client signing = default
1783
1784 client smb encrypt (G)
1785
1786 This parameter controls whether a client should try or is required
1787 to use SMB encryption. It has different effects depending on
1788 whether the connection uses SMB1 or SMB3:
1789
1790 · If the connection uses SMB1, then this option controls
1791 the use of a Samba-specific extension to the SMB
1792 protocol introduced in Samba 3.2 that makes use of the
1793 Unix extensions.
1794
1795 · If the connection uses SMB2 or newer, then this option
1796 controls the use of the SMB-level encryption that is
1797 supported in SMB version 3.0 and above and available in
1798 Windows 8 and newer.
1799
1800 This parameter can be set globally. Possible values are off,
1801 if_required, desired, and required. A special value is default
1802 which is the implicit default setting of if_required.
1803
1804 Effects for SMB1
1805 The Samba-specific encryption of SMB1 connections is an
1806 extension to the SMB protocol negotiated as part of the UNIX
1807 extensions. SMB encryption uses the GSSAPI (SSPI on Windows)
1808 ability to encrypt and sign every request/response in a SMB
1809 protocol stream. When enabled it provides a secure method of
1810 SMB/CIFS communication, similar to an ssh protected session,
1811 but using SMB/CIFS authentication to negotiate encryption and
1812 signing keys. Currently this is only supported smbclient of by
1813 Samba 3.2 and newer. Windows does not support this feature.
1814
1815 When set to default, SMB encryption is probed, but not
1816 enforced. When set to required, SMB encryption is required and
1817 if set to disabled, SMB encryption can not be negotiated.
1818
1819 Effects for SMB3 and newer
1820 Native SMB transport encryption is available in SMB version 3.0
1821 or newer. It is only used by Samba if client max protocol is
1822 set to SMB3 or newer.
1823
1824 These features can be controlled with settings of client smb
1825 encrypt as follows:
1826
1827 · Leaving it as default, explicitly setting default,
1828 or setting it to if_required globally will enable
1829 negotiation of encryption but will not turn on data
1830 encryption globally.
1831
1832 · Setting it to desired globally will enable
1833 negotiation and will turn on data encryption on
1834 sessions and share connections for those servers
1835 that support it.
1836
1837 · Setting it to required globally will enable
1838 negotiation and turn on data encryption on sessions
1839 and share connections. Clients that do not support
1840 encryption will be denied access to the server.
1841
1842 · Setting it to off globally will completely disable
1843 the encryption feature for all connections.
1844
1845
1846 Default: client smb encrypt = default
1847
1848 client use spnego principal (G)
1849
1850 This parameter determines whether or not smbclient(8) and other
1851 samba components acting as a client will attempt to use the
1852 server-supplied principal sometimes given in the SPNEGO exchange.
1853
1854 If enabled, Samba can attempt to use Kerberos to contact servers
1855 known only by IP address. Kerberos relies on names, so ordinarily
1856 cannot function in this situation.
1857
1858 This is a VERY BAD IDEA for security reasons, and so this parameter
1859 SHOULD NOT BE USED. It will be removed in a future version of
1860 Samba.
1861
1862 If disabled, Samba will use the name used to look up the server
1863 when asking the KDC for a ticket. This avoids situations where a
1864 server may impersonate another, soliciting authentication as one
1865 principal while being known on the network as another.
1866
1867 Note that Windows XP SP2 and later versions already follow this
1868 behaviour, and Windows Vista and later servers no longer supply
1869 this 'rfc4178 hint' principal on the server side.
1870
1871 This parameter is deprecated in Samba 4.2.1 and will be removed
1872 (along with the functionality) in a later release of Samba.
1873
1874 Default: client use spnego principal = no
1875
1876 client use spnego (G)
1877
1878 This parameter has been deprecated since Samba 4.13 and support for
1879 NTLMv2, NTLM and LanMan authentication outside NTLMSSP will be
1880 removed in a future Samba release.
1881
1882 That is, in the future, the current default of client use spnego =
1883 yes will be the enforced behaviour.
1884
1885 This variable controls whether Samba clients will try to use Simple
1886 and Protected NEGOciation (as specified by rfc2478) with supporting
1887 servers (including WindowsXP, Windows2000 and Samba 3.0) to agree
1888 upon an authentication mechanism. This enables Kerberos
1889 authentication in particular.
1890
1891 When client NTLMv2 auth is also set to yes extended security
1892 (SPNEGO) is required in order to use NTLMv2 only within NTLMSSP.
1893 This behavior was introduced with the patches for CVE-2016-2111.
1894
1895 Default: client use spnego = yes
1896
1897 cluster addresses (G)
1898
1899 With this parameter you can add additional addresses that nmbd will
1900 register with a WINS server. Similarly, these addresses will be
1901 registered by default when net ads dns register is called with
1902 clustering = yes configured.
1903
1904 Default: cluster addresses =
1905
1906 Example: cluster addresses = 10.0.0.1 10.0.0.2 10.0.0.3
1907
1908 clustering (G)
1909
1910 This parameter specifies whether Samba should contact ctdb for
1911 accessing its tdb files and use ctdb as a backend for its messaging
1912 backend.
1913
1914 Set this parameter to yes only if you have a cluster setup with
1915 ctdb running.
1916
1917 Default: clustering = no
1918
1919 comment (S)
1920
1921 This is a text field that is seen next to a share when a client
1922 does a queries the server, either via the network neighborhood or
1923 via net view to list what shares are available.
1924
1925 If you want to set the string that is displayed next to the machine
1926 name then see the server string parameter.
1927
1928 Default: comment = # No comment
1929
1930 Example: comment = Fred's Files
1931
1932 config backend (G)
1933
1934 This controls the backend for storing the configuration. Possible
1935 values are file (the default) and registry. When config backend =
1936 registry is encountered while loading smb.conf, the configuration
1937 read so far is dropped and the global options are read from
1938 registry instead. So this triggers a registry only configuration.
1939 Share definitions are not read immediately but instead registry
1940 shares is set to yes.
1941
1942 Note: This option can not be set inside the registry configuration
1943 itself.
1944
1945 Default: config backend = file
1946
1947 Example: config backend = registry
1948
1949 config file (G)
1950
1951 This allows you to override the config file to use, instead of the
1952 default (usually smb.conf). There is a chicken and egg problem here
1953 as this option is set in the config file!
1954
1955 For this reason, if the name of the config file has changed when
1956 the parameters are loaded then it will reload them from the new
1957 config file.
1958
1959 This option takes the usual substitutions, which can be very
1960 useful.
1961
1962 If the config file doesn't exist then it won't be loaded (allowing
1963 you to special case the config files of just a few clients).
1964
1965 No default
1966
1967 Example: config file = /usr/local/samba/lib/smb.conf.%m
1968
1969 copy (S)
1970
1971 This parameter allows you to "clone" service entries. The specified
1972 service is simply duplicated under the current service's name. Any
1973 parameters specified in the current section will override those in
1974 the section being copied.
1975
1976 This feature lets you set up a 'template' service and create
1977 similar services easily. Note that the service being copied must
1978 occur earlier in the configuration file than the service doing the
1979 copying.
1980
1981 Default: copy =
1982
1983 Example: copy = otherservice
1984
1985 create krb5 conf (G)
1986
1987 Setting this parameter to no prevents winbind from creating custom
1988 krb5.conf files. Winbind normally does this because the krb5
1989 libraries are not AD-site-aware and thus would pick any domain
1990 controller out of potentially very many. Winbind is site-aware and
1991 makes the krb5 libraries use a local DC by creating its own
1992 krb5.conf files.
1993
1994 Preventing winbind from doing this might become necessary if you
1995 have to add special options into your system-krb5.conf that winbind
1996 does not see.
1997
1998 Default: create krb5 conf = yes
1999
2000 create mode
2001
2002 This parameter is a synonym for create mask.
2003
2004 create mask (S)
2005
2006 When a file is created, the necessary permissions are calculated
2007 according to the mapping from DOS modes to UNIX permissions, and
2008 the resulting UNIX mode is then bit-wise 'AND'ed with this
2009 parameter. This parameter may be thought of as a bit-wise MASK for
2010 the UNIX modes of a file. Any bit not set here will be removed from
2011 the modes set on a file when it is created.
2012
2013 The default value of this parameter removes the group and other
2014 write and execute bits from the UNIX modes.
2015
2016 Following this Samba will bit-wise 'OR' the UNIX mode created from
2017 this parameter with the value of the force create mode parameter
2018 which is set to 000 by default.
2019
2020 This parameter does not affect directory masks. See the parameter
2021 directory mask for details.
2022
2023 Default: create mask = 0744
2024
2025 Example: create mask = 0775
2026
2027 csc policy (S)
2028
2029 This stands for client-side caching policy, and specifies how
2030 clients capable of offline caching will cache the files in the
2031 share. The valid values are: manual, documents, programs, disable.
2032
2033 These values correspond to those used on Windows servers.
2034
2035 For example, shares containing roaming profiles can have offline
2036 caching disabled using csc policy = disable.
2037
2038 Default: csc policy = manual
2039
2040 Example: csc policy = programs
2041
2042 ctdbd socket (G)
2043
2044 If you set clustering=yes, you need to tell Samba where ctdbd
2045 listens on its unix domain socket. The default path as of ctdb 1.0
2046 is /tmp/ctdb.socket which you have to explicitly set for Samba in
2047 smb.conf.
2048
2049 Default: ctdbd socket =
2050
2051 Example: ctdbd socket = /tmp/ctdb.socket
2052
2053 ctdb locktime warn threshold (G)
2054
2055 In a cluster environment using Samba and ctdb it is critical that
2056 locks on central ctdb-hosted databases like locking.tdb are not
2057 held for long. With the current Samba architecture it happens that
2058 Samba takes a lock and while holding that lock makes file system
2059 calls into the shared cluster file system. This option makes Samba
2060 warn if it detects that it has held locks for the specified number
2061 of milliseconds. If this happens, smbd will emit a debug level 0
2062 message into its logs and potentially into syslog. The most likely
2063 reason for such a log message is that an operation of the cluster
2064 file system Samba exports is taking longer than expected. The
2065 messages are meant as a debugging aid for potential cluster
2066 problems.
2067
2068 The default value of 0 disables this logging.
2069
2070 Default: ctdb locktime warn threshold = 0
2071
2072 ctdb timeout (G)
2073
2074 This parameter specifies a timeout in milliseconds for the
2075 connection between Samba and ctdb. It is only valid if you have
2076 compiled Samba with clustering and if you have set clustering=yes.
2077
2078 When something in the cluster blocks, it can happen that we wait
2079 indefinitely long for ctdb, just adding to the blocking condition.
2080 In a well-running cluster this should never happen, but there are
2081 too many components in a cluster that might have hickups. Choosing
2082 the right balance for this value is very tricky, because on a busy
2083 cluster long service times to transfer something across the cluster
2084 might be valid. Setting it too short will degrade the service your
2085 cluster presents, setting it too long might make the cluster itself
2086 not recover from something severely broken for too long.
2087
2088 Be aware that if you set this parameter, this needs to be in the
2089 file smb.conf, it is not really helpful to put this into a registry
2090 configuration (typical on a cluster), because to access the
2091 registry contact to ctdb is required.
2092
2093 Setting ctdb timeout to n makes any process waiting longer than n
2094 milliseconds for a reply by the cluster panic. Setting it to 0 (the
2095 default) makes Samba block forever, which is the highly recommended
2096 default.
2097
2098 Default: ctdb timeout = 0
2099
2100 cups connection timeout (G)
2101
2102 This parameter is only applicable if printing is set to cups.
2103
2104 If set, this option specifies the number of seconds that smbd will
2105 wait whilst trying to contact to the CUPS server. The connection
2106 will fail if it takes longer than this number of seconds.
2107
2108 Default: cups connection timeout = 30
2109
2110 Example: cups connection timeout = 60
2111
2112 cups encrypt (G)
2113
2114 This parameter is only applicable if printing is set to cups and if
2115 you use CUPS newer than 1.0.x.It is used to define whether or not
2116 Samba should use encryption when talking to the CUPS server.
2117 Possible values are auto, yes and no
2118
2119 When set to auto we will try to do a TLS handshake on each CUPS
2120 connection setup. If that fails, we will fall back to unencrypted
2121 operation.
2122
2123 Default: cups encrypt = no
2124
2125 cups options (S)
2126
2127 This parameter is only applicable if printing is set to cups. Its
2128 value is a free form string of options passed directly to the cups
2129 library.
2130
2131 You can pass any generic print option known to CUPS (as listed in
2132 the CUPS "Software Users' Manual"). You can also pass any printer
2133 specific option (as listed in "lpoptions -d printername -l") valid
2134 for the target queue. Multiple parameters should be space-delimited
2135 name/value pairs according to the PAPI text option ABNF
2136 specification. Collection values ("name={a=... b=... c=...}") are
2137 stored with the curley brackets intact.
2138
2139 You should set this parameter to raw if your CUPS server error_log
2140 file contains messages such as "Unsupported format
2141 'application/octet-stream'" when printing from a Windows client
2142 through Samba. It is no longer necessary to enable system wide raw
2143 printing in /etc/cups/mime.{convs,types}.
2144
2145 Default: cups options = ""
2146
2147 Example: cups options = "raw media=a4"
2148
2149 cups server (G)
2150
2151 This parameter is only applicable if printing is set to cups.
2152
2153 If set, this option overrides the ServerName option in the CUPS
2154 client.conf. This is necessary if you have virtual samba servers
2155 that connect to different CUPS daemons.
2156
2157 Optionally, a port can be specified by separating the server name
2158 and port number with a colon. If no port was specified, the default
2159 port for IPP (631) will be used.
2160
2161 Default: cups server = ""
2162
2163 Example: cups server = mycupsserver
2164
2165 Example: cups server = mycupsserver:1631
2166
2167 dcerpc endpoint servers (G)
2168
2169 Specifies which DCE/RPC endpoint servers should be run.
2170
2171 Default: dcerpc endpoint servers = epmapper, wkssvc, rpcecho, samr,
2172 netlogon, lsarpc, drsuapi, dssetup, unixinfo, browser, eventlog6,
2173 backupkey, dnsserver
2174
2175 Example: dcerpc endpoint servers = rpcecho
2176
2177 deadtime (G)
2178
2179 The value of the parameter (a decimal integer) represents the
2180 number of minutes of inactivity before a connection is considered
2181 dead, and it is disconnected. The deadtime only takes effect if the
2182 number of open files is zero.
2183
2184 This is useful to stop a server's resources being exhausted by a
2185 large number of inactive connections.
2186
2187 Most clients have an auto-reconnect feature when a connection is
2188 broken so in most cases this parameter should be transparent to
2189 users.
2190
2191 Using this parameter with a timeout of a few minutes is recommended
2192 for most systems.
2193
2194 A deadtime of zero indicates that no auto-disconnection should be
2195 performed.
2196
2197 Default: deadtime = 10080
2198
2199 Example: deadtime = 15
2200
2201 debug class (G)
2202
2203 With this boolean parameter enabled, the debug class (DBGC_CLASS)
2204 will be displayed in the debug header.
2205
2206 For more information about currently available debug classes, see
2207 section about log level.
2208
2209 Default: debug class = no
2210
2211 debug encryption (G)
2212
2213 This option will make the smbd server and client code using libsmb
2214 (smbclient, smbget, smbspool, ...) dump the Session Id, the
2215 decrypted Session Key, the Signing Key, the Application Key, the
2216 Encryption Key and the Decryption Key every time an SMB3+ session
2217 is established. This information will be printed in logs at level
2218 0.
2219
2220 Warning: access to these values enables the decryption of any
2221 encrypted traffic on the dumped sessions. This option should only
2222 be enabled for debugging purposes.
2223
2224 Default: debug encryption = no
2225
2226 debug hires timestamp (G)
2227
2228 Sometimes the timestamps in the log messages are needed with a
2229 resolution of higher that seconds, this boolean parameter adds
2230 microsecond resolution to the timestamp message header when turned
2231 on.
2232
2233 Note that the parameter debug timestamp must be on for this to have
2234 an effect.
2235
2236 Default: debug hires timestamp = yes
2237
2238 debug pid (G)
2239
2240 When using only one log file for more then one forked
2241 smbd(8)-process there may be hard to follow which process outputs
2242 which message. This boolean parameter is adds the process-id to the
2243 timestamp message headers in the logfile when turned on.
2244
2245 Note that the parameter debug timestamp must be on for this to have
2246 an effect.
2247
2248 Default: debug pid = no
2249
2250 debug prefix timestamp (G)
2251
2252 With this option enabled, the timestamp message header is prefixed
2253 to the debug message without the filename and function information
2254 that is included with the debug timestamp parameter. This gives
2255 timestamps to the messages without adding an additional line.
2256
2257 Note that this parameter overrides the debug timestamp parameter.
2258
2259 Default: debug prefix timestamp = no
2260
2261 debug uid (G)
2262
2263 Samba is sometimes run as root and sometime run as the connected
2264 user, this boolean parameter inserts the current euid, egid, uid
2265 and gid to the timestamp message headers in the log file if turned
2266 on.
2267
2268 Note that the parameter debug timestamp must be on for this to have
2269 an effect.
2270
2271 Default: debug uid = no
2272
2273 dedicated keytab file (G)
2274
2275 Specifies the absolute path to the kerberos keytab file when
2276 kerberos method is set to "dedicated keytab".
2277
2278 Default: dedicated keytab file =
2279
2280 Example: dedicated keytab file = /usr/local/etc/krb5.keytab
2281
2282 default case (S)
2283
2284 See the section on name mangling. Also note the short preserve case
2285 parameter.
2286
2287 Default: default case = lower
2288
2289 default devmode (S)
2290
2291 This parameter is only applicable to printable services. When smbd
2292 is serving Printer Drivers to Windows NT/2k/XP clients, each
2293 printer on the Samba server has a Device Mode which defines things
2294 such as paper size and orientation and duplex settings. The device
2295 mode can only correctly be generated by the printer driver itself
2296 (which can only be executed on a Win32 platform). Because smbd is
2297 unable to execute the driver code to generate the device mode, the
2298 default behavior is to set this field to NULL.
2299
2300 Most problems with serving printer drivers to Windows NT/2k/XP
2301 clients can be traced to a problem with the generated device mode.
2302 Certain drivers will do things such as crashing the client's
2303 Explorer.exe with a NULL devmode. However, other printer drivers
2304 can cause the client's spooler service (spoolsv.exe) to die if the
2305 devmode was not created by the driver itself (i.e. smbd generates a
2306 default devmode).
2307
2308 This parameter should be used with care and tested with the printer
2309 driver in question. It is better to leave the device mode to NULL
2310 and let the Windows client set the correct values. Because drivers
2311 do not do this all the time, setting default devmode = yes will
2312 instruct smbd to generate a default one.
2313
2314 For more information on Windows NT/2k printing and Device Modes,
2315 see the MSDN documentation.
2316
2317 Default: default devmode = yes
2318
2319 default
2320
2321 This parameter is a synonym for default service.
2322
2323 default service (G)
2324
2325 This parameter specifies the name of a service which will be
2326 connected to if the service actually requested cannot be found.
2327 Note that the square brackets are NOT given in the parameter value
2328 (see example below).
2329
2330 There is no default value for this parameter. If this parameter is
2331 not given, attempting to connect to a nonexistent service results
2332 in an error.
2333
2334 Typically the default service would be a guest ok, read-only
2335 service.
2336
2337 Also note that the apparent service name will be changed to equal
2338 that of the requested service, this is very useful as it allows you
2339 to use macros like %S to make a wildcard service.
2340
2341 Note also that any "_" characters in the name of the service used
2342 in the default service will get mapped to a "/". This allows for
2343 interesting things.
2344
2345 Default: default service =
2346
2347 Example: default service = pub
2348
2349 defer sharing violations (G)
2350
2351 Windows allows specifying how a file will be shared with other
2352 processes when it is opened. Sharing violations occur when a file
2353 is opened by a different process using options that violate the
2354 share settings specified by other processes. This parameter causes
2355 smbd to act as a Windows server does, and defer returning a
2356 "sharing violation" error message for up to one second, allowing
2357 the client to close the file causing the violation in the meantime.
2358
2359 UNIX by default does not have this behaviour.
2360
2361 There should be no reason to turn off this parameter, as it is
2362 designed to enable Samba to more correctly emulate Windows.
2363
2364 Default: defer sharing violations = yes
2365
2366 delete group script (G)
2367
2368 This is the full pathname to a script that will be run AS ROOT by
2369 smbd(8) when a group is requested to be deleted. It will expand any
2370 %g to the group name passed. This script is only useful for
2371 installations using the Windows NT domain administration tools.
2372
2373 Default: delete group script =
2374
2375 deleteprinter command (G)
2376
2377 With the introduction of MS-RPC based printer support for Windows
2378 NT/2000 clients in Samba 2.2, it is now possible to delete a
2379 printer at run time by issuing the DeletePrinter() RPC call.
2380
2381 For a Samba host this means that the printer must be physically
2382 deleted from the underlying printing system. The deleteprinter
2383 command defines a script to be run which will perform the necessary
2384 operations for removing the printer from the print system and from
2385 smb.conf.
2386
2387 The deleteprinter command is automatically called with only one
2388 parameter: printer name.
2389
2390 Once the deleteprinter command has been executed, smbd will reparse
2391 the smb.conf to check that the associated printer no longer exists.
2392 If the sharename is still valid, then smbd will return an
2393 ACCESS_DENIED error to the client.
2394
2395 Default: deleteprinter command =
2396
2397 Example: deleteprinter command = /usr/bin/removeprinter
2398
2399 delete readonly (S)
2400
2401 This parameter allows readonly files to be deleted. This is not
2402 normal DOS semantics, but is allowed by UNIX.
2403
2404 This option may be useful for running applications such as rcs,
2405 where UNIX file ownership prevents changing file permissions, and
2406 DOS semantics prevent deletion of a read only file.
2407
2408 Default: delete readonly = no
2409
2410 delete share command (G)
2411
2412 Samba 2.2.0 introduced the ability to dynamically add and delete
2413 shares via the Windows NT 4.0 Server Manager. The delete share
2414 command is used to define an external program or script which will
2415 remove an existing service definition from smb.conf.
2416
2417 In order to successfully execute the delete share command, smbd
2418 requires that the administrator connects using a root account (i.e.
2419 uid == 0) or has the SeDiskOperatorPrivilege. Scripts defined in
2420 the delete share command parameter are executed as root.
2421
2422 When executed, smbd will automatically invoke the delete share
2423 command with two parameters.
2424
2425 · configFile - the location of the global smb.conf file.
2426
2427 · shareName - the name of the existing service.
2428
2429 This parameter is only used to remove file shares. To delete
2430 printer shares, see the deleteprinter command.
2431
2432 Default: delete share command =
2433
2434 Example: delete share command = /usr/local/bin/delshare
2435
2436 delete user from group script (G)
2437
2438 Full path to the script that will be called when a user is removed
2439 from a group using the Windows NT domain administration tools. It
2440 will be run by smbd(8) AS ROOT. Any %g will be replaced with the
2441 group name and any %u will be replaced with the user name.
2442
2443 Default: delete user from group script =
2444
2445 Example: delete user from group script = /usr/sbin/deluser %u %g
2446
2447 delete user script (G)
2448
2449 This is the full pathname to a script that will be run by smbd(8)
2450 when managing users with remote RPC (NT) tools.
2451
2452 This script is called when a remote client removes a user from the
2453 server, normally using 'User Manager for Domains' or rpcclient.
2454
2455 This script should delete the given UNIX username.
2456
2457 Default: delete user script =
2458
2459 Example: delete user script = /usr/local/samba/bin/del_user %u
2460
2461 delete veto files (S)
2462
2463 This option is used when Samba is attempting to delete a directory
2464 that contains one or more vetoed directories (see the veto files
2465 option). If this option is set to no (the default) then if a vetoed
2466 directory contains any non-vetoed files or directories then the
2467 directory delete will fail. This is usually what you want.
2468
2469 If this option is set to yes, then Samba will attempt to
2470 recursively delete any files and directories within the vetoed
2471 directory. This can be useful for integration with file serving
2472 systems such as NetAtalk which create meta-files within directories
2473 you might normally veto DOS/Windows users from seeing (e.g.
2474 .AppleDouble)
2475
2476 Setting delete veto files = yes allows these directories to be
2477 transparently deleted when the parent directory is deleted (so long
2478 as the user has permissions to do so).
2479
2480 Default: delete veto files = no
2481
2482 dfree cache time (S)
2483
2484 The dfree cache time should only be used on systems where a problem
2485 occurs with the internal disk space calculations. This has been
2486 known to happen with Ultrix, but may occur with other operating
2487 systems. The symptom that was seen was an error of "Abort Retry
2488 Ignore" at the end of each directory listing.
2489
2490 This is a new parameter introduced in Samba version 3.0.21. It
2491 specifies in seconds the time that smbd will cache the output of a
2492 disk free query. If set to zero (the default) no caching is done.
2493 This allows a heavily loaded server to prevent rapid spawning of
2494 dfree command scripts increasing the load.
2495
2496 By default this parameter is zero, meaning no caching will be done.
2497
2498 No default
2499
2500 Example: dfree cache time = 60
2501
2502 dfree command (S)
2503
2504 The dfree command setting should only be used on systems where a
2505 problem occurs with the internal disk space calculations. This has
2506 been known to happen with Ultrix, but may occur with other
2507 operating systems. The symptom that was seen was an error of "Abort
2508 Retry Ignore" at the end of each directory listing.
2509
2510 This setting allows the replacement of the internal routines to
2511 calculate the total disk space and amount available with an
2512 external routine. The example below gives a possible script that
2513 might fulfill this function.
2514
2515 In Samba version 3.0.21 this parameter has been changed to be a
2516 per-share parameter, and in addition the parameter dfree cache time
2517 was added to allow the output of this script to be cached for
2518 systems under heavy load.
2519
2520 The external program will be passed a single parameter indicating a
2521 directory in the filesystem being queried. This will typically
2522 consist of the string ./. The script should return two integers in
2523 ASCII. The first should be the total disk space in blocks, and the
2524 second should be the number of available blocks. An optional third
2525 return value can give the block size in bytes. The default
2526 blocksize is 1024 bytes.
2527
2528 Note: Your script should NOT be setuid or setgid and should be
2529 owned by (and writeable only by) root!
2530
2531 Where the script dfree (which must be made executable) could be:
2532
2533
2534 #!/bin/sh
2535 df "$1" | tail -1 | awk '{print $(NF-4),$(NF-2)}'
2536
2537 or perhaps (on Sys V based systems):
2538
2539
2540 #!/bin/sh
2541 /usr/bin/df -k "$1" | tail -1 | awk '{print $3" "$5}'
2542
2543 Note that you may have to replace the command names with full path
2544 names on some systems. Also note the arguments passed into the
2545 script should be quoted inside the script in case they contain
2546 special characters such as spaces or newlines.
2547
2548 By default internal routines for determining the disk capacity and
2549 remaining space will be used.
2550
2551 No default
2552
2553 Example: dfree command = /usr/local/samba/bin/dfree
2554
2555 dgram port (G)
2556
2557 Specifies which ports the server should listen on for NetBIOS
2558 datagram traffic.
2559
2560 Default: dgram port = 138
2561
2562 directory mode
2563
2564 This parameter is a synonym for directory mask.
2565
2566 directory mask (S)
2567
2568 This parameter is the octal modes which are used when converting
2569 DOS modes to UNIX modes when creating UNIX directories.
2570
2571 When a directory is created, the necessary permissions are
2572 calculated according to the mapping from DOS modes to UNIX
2573 permissions, and the resulting UNIX mode is then bit-wise 'AND'ed
2574 with this parameter. This parameter may be thought of as a bit-wise
2575 MASK for the UNIX modes of a directory. Any bit not set here will
2576 be removed from the modes set on a directory when it is created.
2577
2578 The default value of this parameter removes the 'group' and 'other'
2579 write bits from the UNIX mode, allowing only the user who owns the
2580 directory to modify it.
2581
2582 Following this Samba will bit-wise 'OR' the UNIX mode created from
2583 this parameter with the value of the force directory mode
2584 parameter. This parameter is set to 000 by default (i.e. no extra
2585 mode bits are added).
2586
2587 Default: directory mask = 0755
2588
2589 Example: directory mask = 0775
2590
2591 directory name cache size (S)
2592
2593 This parameter specifies the size of the directory name cache for
2594 SMB1 connections. It is not used for SMB2. It will be needed to
2595 turn this off for *BSD systems.
2596
2597 Default: directory name cache size = 100
2598
2599 directory security mask (S)
2600
2601 This parameter has been removed for Samba 4.0.0.
2602
2603 No default
2604
2605 disable netbios (G)
2606
2607 Enabling this parameter will disable netbios support in Samba.
2608 Netbios is the only available form of browsing in all windows
2609 versions except for 2000 and XP.
2610
2611 Note
2612 Clients that only support netbios won't be able to see your
2613 samba server when netbios support is disabled.
2614 Default: disable netbios = no
2615
2616 disable spoolss (G)
2617
2618 Enabling this parameter will disable Samba's support for the
2619 SPOOLSS set of MS-RPC's and will yield identical behavior as Samba
2620 2.0.x. Windows NT/2000 clients will downgrade to using Lanman style
2621 printing commands. Windows 9x/ME will be unaffected by the
2622 parameter. However, this will also disable the ability to upload
2623 printer drivers to a Samba server via the Windows NT Add Printer
2624 Wizard or by using the NT printer properties dialog window. It will
2625 also disable the capability of Windows NT/2000 clients to download
2626 print drivers from the Samba host upon demand. Be very careful
2627 about enabling this parameter.
2628
2629 Default: disable spoolss = no
2630
2631 dmapi support (S)
2632
2633 This parameter specifies whether Samba should use DMAPI to
2634 determine whether a file is offline or not. This would typically be
2635 used in conjunction with a hierarchical storage system that
2636 automatically migrates files to tape.
2637
2638 Note that Samba infers the status of a file by examining the events
2639 that a DMAPI application has registered interest in. This heuristic
2640 is satisfactory for a number of hierarchical storage systems, but
2641 there may be system for which it will fail. In this case, Samba may
2642 erroneously report files to be offline.
2643
2644 This parameter is only available if a supported DMAPI
2645 implementation was found at compilation time. It will only be used
2646 if DMAPI is found to enabled on the system at run time.
2647
2648 Default: dmapi support = no
2649
2650 dns forwarder (G)
2651
2652 This option specifies the list of DNS servers that DNS requests
2653 will be forwarded to if they can not be handled by Samba itself.
2654
2655 The DNS forwarder is only used if the internal DNS server in Samba
2656 is used.
2657
2658 Default: dns forwarder =
2659
2660 Example: dns forwarder = 192.168.0.1 192.168.0.2
2661
2662 dns proxy (G)
2663
2664 Specifies that nmbd(8) when acting as a WINS server and finding
2665 that a NetBIOS name has not been registered, should treat the
2666 NetBIOS name word-for-word as a DNS name and do a lookup with the
2667 DNS server for that name on behalf of the name-querying client.
2668
2669 Note that the maximum length for a NetBIOS name is 15 characters,
2670 so the DNS name (or DNS alias) can likewise only be 15 characters,
2671 maximum.
2672
2673 nmbd spawns a second copy of itself to do the DNS name lookup
2674 requests, as doing a name lookup is a blocking action.
2675
2676 Default: dns proxy = yes
2677
2678 dns update command (G)
2679
2680 This option sets the command that is called when there are DNS
2681 updates. It should update the local machines DNS names using
2682 TSIG-GSS.
2683
2684 Default: dns update command =
2685 /builddir/build/BUILD/samba-4.13.7/source4/scripting/bin/samba_dnsupdate
2686
2687 Example: dns update command = /usr/local/sbin/dnsupdate
2688
2689 dns zone scavenging (G)
2690
2691 When enabled (the default is disabled) unused dynamic dns records
2692 are periodically removed.
2693
2694 Warning
2695 This option should not be enabled for installations created
2696 with versions of samba before 4.9. Doing this will result in
2697 the loss of static DNS entries. This is due to a bug in
2698 previous versions of samba (BUG 12451) which marked dynamic DNS
2699 records as static and static records as dynamic.
2700
2701 Note
2702 If one record for a DNS name is static (non-aging) then no
2703 other record for that DNS name will be scavenged.
2704 Default: dns zone scavenging = no
2705
2706 domain logons (G)
2707
2708 This parameter has been deprecated since Samba 4.13 and support for
2709 NT4-style domain logons(as distinct from the Samba AD DC) will be
2710 removed in a future Samba release.
2711
2712 That is, in the future, the current default of domain logons = no
2713 will be the enforced behaviour.
2714
2715 If set to yes, the Samba server will provide the netlogon service
2716 for Windows 9X network logons for the workgroup it is in. This will
2717 also cause the Samba server to act as a domain controller for NT4
2718 style domain services. For more details on setting up this feature
2719 see the Domain Control chapter of the Samba HOWTO Collection.
2720
2721 Default: domain logons = no
2722
2723 domain master (G)
2724
2725 Tell smbd(8) to enable WAN-wide browse list collation. Setting this
2726 option causes nmbd to claim a special domain specific NetBIOS name
2727 that identifies it as a domain master browser for its given
2728 workgroup. Local master browsers in the same workgroup on
2729 broadcast-isolated subnets will give this nmbd their local browse
2730 lists, and then ask smbd(8) for a complete copy of the browse list
2731 for the whole wide area network. Browser clients will then contact
2732 their local master browser, and will receive the domain-wide browse
2733 list, instead of just the list for their broadcast-isolated subnet.
2734
2735 Note that Windows NT Primary Domain Controllers expect to be able
2736 to claim this workgroup specific special NetBIOS name that
2737 identifies them as domain master browsers for that workgroup by
2738 default (i.e. there is no way to prevent a Windows NT PDC from
2739 attempting to do this). This means that if this parameter is set
2740 and nmbd claims the special name for a workgroup before a Windows
2741 NT PDC is able to do so then cross subnet browsing will behave
2742 strangely and may fail.
2743
2744 If domain logons = yes, then the default behavior is to enable the
2745 domain master parameter. If domain logons is not enabled (the
2746 default setting), then neither will domain master be enabled by
2747 default.
2748
2749 When domain logons = Yes the default setting for this parameter is
2750 Yes, with the result that Samba will be a PDC. If domain master =
2751 No, Samba will function as a BDC. In general, this parameter should
2752 be set to 'No' only on a BDC.
2753
2754 Default: domain master = auto
2755
2756 dont descend (S)
2757
2758 There are certain directories on some systems (e.g., the /proc tree
2759 under Linux) that are either not of interest to clients or are
2760 infinitely deep (recursive). This parameter allows you to specify a
2761 comma-delimited list of directories that the server should always
2762 show as empty.
2763
2764 Note that Samba can be very fussy about the exact format of the
2765 "dont descend" entries. For example you may need ./proc instead of
2766 just /proc. Experimentation is the best policy :-)
2767
2768 Default: dont descend =
2769
2770 Example: dont descend = /proc,/dev
2771
2772 dos charset (G)
2773
2774 DOS SMB clients assume the server has the same charset as they do.
2775 This option specifies which charset Samba should talk to DOS
2776 clients.
2777
2778 The default depends on which charsets you have installed. Samba
2779 tries to use charset 850 but falls back to ASCII in case it is not
2780 available. Run testparm(1) to check the default on your system.
2781
2782 No default
2783
2784 dos filemode (S)
2785
2786 The default behavior in Samba is to provide UNIX-like behavior
2787 where only the owner of a file/directory is able to change the
2788 permissions on it. However, this behavior is often confusing to
2789 DOS/Windows users. Enabling this parameter allows a user who has
2790 write access to the file (by whatever means, including an ACL
2791 permission) to modify the permissions (including ACL) on it. Note
2792 that a user belonging to the group owning the file will not be
2793 allowed to change permissions if the group is only granted read
2794 access. Ownership of the file/directory may also be changed. Note
2795 that using the VFS modules acl_xattr or acl_tdb which store native
2796 Windows as meta-data will automatically turn this option on for any
2797 share for which they are loaded, as they require this option to
2798 emulate Windows ACLs correctly.
2799
2800 Default: dos filemode = no
2801
2802 dos filetime resolution (S)
2803
2804 Under the DOS and Windows FAT filesystem, the finest granularity on
2805 time resolution is two seconds. Setting this parameter for a share
2806 causes Samba to round the reported time down to the nearest two
2807 second boundary when a query call that requires one second
2808 resolution is made to smbd(8).
2809
2810 This option is mainly used as a compatibility option for Visual C++
2811 when used against Samba shares. If oplocks are enabled on a share,
2812 Visual C++ uses two different time reading calls to check if a file
2813 has changed since it was last read. One of these calls uses a
2814 one-second granularity, the other uses a two second granularity. As
2815 the two second call rounds any odd second down, then if the file
2816 has a timestamp of an odd number of seconds then the two timestamps
2817 will not match and Visual C++ will keep reporting the file has
2818 changed. Setting this option causes the two timestamps to match,
2819 and Visual C++ is happy.
2820
2821 Default: dos filetime resolution = no
2822
2823 dos filetimes (S)
2824
2825 Under DOS and Windows, if a user can write to a file they can
2826 change the timestamp on it. Under POSIX semantics, only the owner
2827 of the file or root may change the timestamp. By default, Samba
2828 emulates the DOS semantics and allows one to change the timestamp
2829 on a file if the user smbd is acting on behalf has write
2830 permissions. Due to changes in Microsoft Office 2000 and beyond,
2831 the default for this parameter has been changed from "no" to "yes"
2832 in Samba 3.0.14 and above. Microsoft Excel will display dialog box
2833 warnings about the file being changed by another user if this
2834 parameter is not set to "yes" and files are being shared between
2835 users.
2836
2837 Default: dos filetimes = yes
2838
2839 dsdb event notification (G)
2840
2841 When enabled, this option causes Samba (acting as an Active
2842 Directory Domain Controller) to stream Samba database events across
2843 the internal message bus. Scripts built using Samba's python
2844 bindings can listen to these events by registering as the service
2845 dsdb_event.
2846
2847 This should be considered a developer option (it assists in the
2848 Samba testsuite) rather than a facility for external auditing, as
2849 message delivery is not guaranteed (a feature that the testsuite
2850 works around).
2851
2852 The Samba database events are also logged via the normal logging
2853 methods when the log level is set appropriately.
2854
2855 Default: dsdb event notification = no
2856
2857 dsdb group change notification (G)
2858
2859 When enabled, this option causes Samba (acting as an Active
2860 Directory Domain Controller) to stream group membership change
2861 events across the internal message bus. Scripts built using Samba's
2862 python bindings can listen to these events by registering as the
2863 service dsdb_group_event.
2864
2865 This should be considered a developer option (it assists in the
2866 Samba testsuite) rather than a facility for external auditing, as
2867 message delivery is not guaranteed (a feature that the testsuite
2868 works around).
2869
2870 The group events are also logged via the normal logging methods
2871 when the log level is set appropriately.
2872
2873 Default: dsdb group change notification = no
2874
2875 dsdb password event notification (G)
2876
2877 When enabled, this option causes Samba (acting as an Active
2878 Directory Domain Controller) to stream password change and reset
2879 events across the internal message bus. Scripts built using Samba's
2880 python bindings can listen to these events by registering as the
2881 service password_event.
2882
2883 This should be considered a developer option (it assists in the
2884 Samba testsuite) rather than a facility for external auditing, as
2885 message delivery is not guaranteed (a feature that the testsuite
2886 works around).
2887
2888 The password events are also logged via the normal logging methods
2889 when the log level is set appropriately.
2890
2891 Default: dsdb password event notification = no
2892
2893 durable handles (S)
2894
2895 This boolean parameter controls whether Samba can grant SMB2
2896 durable file handles on a share.
2897
2898 Note that durable handles are only enabled if kernel oplocks = no,
2899 kernel share modes = no, and posix locking = no, i.e. if the share
2900 is configured for CIFS/SMB2 only access, not supporting
2901 interoperability features with local UNIX processes or NFS
2902 operations.
2903
2904 Also note that, for the time being, durability is not granted for a
2905 handle that has the delete on close flag set.
2906
2907 Default: durable handles = yes
2908
2909 ea support (S)
2910
2911 This boolean parameter controls whether smbd(8) will allow clients
2912 to attempt to access extended attributes on a share. In order to
2913 enable this parameter on a setup with default VFS modules:
2914
2915 · Samba must have been built with extended attributes
2916 support.
2917
2918 · The underlying filesystem exposed by the share must
2919 support extended attributes (e.g. the getfattr(1) /
2920 setfattr(1) utilities must work).
2921
2922 Note that the SMB protocol allows setting attributes whose value is
2923 64K bytes long, and that on NTFS, the maximum storage space for
2924 extended attributes per file is 64K. On most UNIX systems (Solaris
2925 and ZFS file system being the exception), the limits are much lower
2926 - typically 4K. Worse, the same 4K space is often used to store
2927 system metadata such as POSIX ACLs, or Samba's NT ACLs. Giving
2928 clients access to this tight space via extended attribute support
2929 could consume all of it by unsuspecting client applications, which
2930 would prevent changing system metadata due to lack of space. The
2931 default has changed to yes in Samba release 4.9.0 and above to
2932 allow better Windows fileserver compatibility in a default install.
2933
2934 Default: ea support = yes
2935
2936 elasticsearch:address (S)
2937
2938 Specifies the name of the Elasticsearch server to use for Spotlight
2939 queries when using the Elasticsearch backend.
2940
2941 Default: elasticsearch:address = localhost
2942
2943 Example: elasticsearch:address = needle.haystack.samba.org
2944
2945 elasticsearch:index (S)
2946
2947 Specifies the name of the Elasticsearch index to use for Spotlight
2948 queries when using the Elasticsearch backend. The default value of
2949 "_all" is a special Elasticsearch value that performs the search
2950 operation on all indices.
2951
2952 Default: elasticsearch:index = _all
2953
2954 Example: elasticsearch:index = spotlight
2955
2956 elasticsearch:mappings (G)
2957
2958 Path to a file specifying metadata attribute mappings in JSON
2959 format. Use by the Elasticsearch backend of the Spotlight RPC
2960 service.
2961
2962 Default: elasticsearch:mappings =
2963 /usr/share/samba/elasticsearch_mappings.json
2964
2965 Example: elasticsearch:mappings = /usr/share/foo/mymappings.json
2966
2967 elasticsearch:max results (S)
2968
2969 Path to a file specifying metadata attribute mappings in JSON
2970 format. Used by the Elasticsearch backend of the Spotlight RPC
2971 service. A value of 0 means no limit.
2972
2973 Default: elasticsearch:max results = 100
2974
2975 Example: elasticsearch:max results = 10
2976
2977 elasticsearch:port (S)
2978
2979 Specifies the TCP port of the Elasticsearch server to use for
2980 Spotlight queries when using the Elasticsearch backend.
2981
2982 Default: elasticsearch:port = 9200
2983
2984 Example: elasticsearch:port = 9201
2985
2986 elasticsearch:use tls (S)
2987
2988 Specifies whether to use HTTPS when talking to the Elasticsearch
2989 server used for Spotlight queries when using the Elasticsearch
2990 backend.
2991
2992 Default: elasticsearch:use tls = no
2993
2994 Example: elasticsearch:use tls = yes
2995
2996 enable asu support (G)
2997
2998 Hosts running the "Advanced Server for Unix (ASU)" product require
2999 some special accommodations such as creating a builtin [ADMIN$]
3000 share that only supports IPC connections. The has been the default
3001 behavior in smbd for many years. However, certain Microsoft
3002 applications such as the Print Migrator tool require that the
3003 remote server support an [ADMIN$] file share. Disabling this
3004 parameter allows for creating an [ADMIN$] file share in smb.conf.
3005
3006 Default: enable asu support = no
3007
3008 enable core files (G)
3009
3010 This parameter specifies whether core dumps should be written on
3011 internal exits. Normally set to yes. You should never need to
3012 change this.
3013
3014 Default: enable core files = yes
3015
3016 Example: enable core files = no
3017
3018 enable privileges (G)
3019
3020 This deprecated parameter controls whether or not smbd will honor
3021 privileges assigned to specific SIDs via either net rpc rights or
3022 one of the Windows user and group manager tools. This parameter is
3023 enabled by default. It can be disabled to prevent members of the
3024 Domain Admins group from being able to assign privileges to users
3025 or groups which can then result in certain smbd operations running
3026 as root that would normally run under the context of the connected
3027 user.
3028
3029 An example of how privileges can be used is to assign the right to
3030 join clients to a Samba controlled domain without providing root
3031 access to the server via smbd.
3032
3033 Please read the extended description provided in the Samba HOWTO
3034 documentation.
3035
3036 Default: enable privileges = yes
3037
3038 enable spoolss (G)
3039
3040 Inverted synonym for disable spoolss.
3041
3042 Default: enable spoolss = yes
3043
3044 encrypt passwords (G)
3045
3046 This parameter has been deprecated since Samba 4.11 and support for
3047 plaintext (as distinct from NTLM, NTLMv2 or Kerberos
3048 authentication) will be removed in a future Samba release.
3049
3050 That is, in the future, the current default of encrypt passwords =
3051 yes will be the enforced behaviour.
3052
3053 This boolean controls whether encrypted passwords will be
3054 negotiated with the client. Note that Windows NT 4.0 SP3 and above
3055 and also Windows 98 will by default expect encrypted passwords
3056 unless a registry entry is changed. To use encrypted passwords in
3057 Samba see the chapter "User Database" in the Samba HOWTO
3058 Collection.
3059
3060 MS Windows clients that expect Microsoft encrypted passwords and
3061 that do not have plain text password support enabled will be able
3062 to connect only to a Samba server that has encrypted password
3063 support enabled and for which the user accounts have a valid
3064 encrypted password. Refer to the smbpasswd command man page for
3065 information regarding the creation of encrypted passwords for user
3066 accounts.
3067
3068 The use of plain text passwords is NOT advised as support for this
3069 feature is no longer maintained in Microsoft Windows products. If
3070 you want to use plain text passwords you must set this parameter to
3071 no.
3072
3073 In order for encrypted passwords to work correctly smbd(8) must
3074 either have access to a local smbpasswd(5) file (see the
3075 smbpasswd(8) program for information on how to set up and maintain
3076 this file), or set the security = [domain|ads] parameter which
3077 causes smbd to authenticate against another server.
3078
3079 Default: encrypt passwords = yes
3080
3081 enhanced browsing (G)
3082
3083 This option enables a couple of enhancements to cross-subnet browse
3084 propagation that have been added in Samba but which are not
3085 standard in Microsoft implementations.
3086
3087 The first enhancement to browse propagation consists of a regular
3088 wildcard query to a Samba WINS server for all Domain Master
3089 Browsers, followed by a browse synchronization with each of the
3090 returned DMBs. The second enhancement consists of a regular
3091 randomised browse synchronization with all currently known DMBs.
3092
3093 You may wish to disable this option if you have a problem with
3094 empty workgroups not disappearing from browse lists. Due to the
3095 restrictions of the browse protocols, these enhancements can cause
3096 a empty workgroup to stay around forever which can be annoying.
3097
3098 In general you should leave this option enabled as it makes
3099 cross-subnet browse propagation much more reliable.
3100
3101 Default: enhanced browsing = yes
3102
3103 enumports command (G)
3104
3105 The concept of a "port" is fairly foreign to UNIX hosts. Under
3106 Windows NT/2000 print servers, a port is associated with a port
3107 monitor and generally takes the form of a local port (i.e. LPT1:,
3108 COM1:, FILE:) or a remote port (i.e. LPD Port Monitor, etc...). By
3109 default, Samba has only one port defined--"Samba Printer Port".
3110 Under Windows NT/2000, all printers must have a valid port name. If
3111 you wish to have a list of ports displayed (smbd does not use a
3112 port name for anything) other than the default "Samba Printer
3113 Port", you can define enumports command to point to a program which
3114 should generate a list of ports, one per line, to standard output.
3115 This listing will then be used in response to the level 1 and 2
3116 EnumPorts() RPC.
3117
3118 Default: enumports command =
3119
3120 Example: enumports command = /usr/bin/listports
3121
3122 eventlog list (G)
3123
3124 This option defines a list of log names that Samba will report to
3125 the Microsoft EventViewer utility. The listed eventlogs will be
3126 associated with tdb file on disk in the $(statedir)/eventlog.
3127
3128 The administrator must use an external process to parse the normal
3129 Unix logs such as /var/log/messages and write then entries to the
3130 eventlog tdb files. Refer to the eventlogadm(8) utility for how to
3131 write eventlog entries.
3132
3133 Default: eventlog list =
3134
3135 Example: eventlog list = Security Application Syslog Apache
3136
3137 fake directory create times (S)
3138
3139 NTFS and Windows VFAT file systems keep a create time for all files
3140 and directories. This is not the same as the ctime - status change
3141 time - that Unix keeps, so Samba by default reports the earliest of
3142 the various times Unix does keep. Setting this parameter for a
3143 share causes Samba to always report midnight 1-1-1980 as the create
3144 time for directories.
3145
3146 This option is mainly used as a compatibility option for Visual C++
3147 when used against Samba shares. Visual C++ generated makefiles have
3148 the object directory as a dependency for each object file, and a
3149 make rule to create the directory. Also, when NMAKE compares
3150 timestamps it uses the creation time when examining a directory.
3151 Thus the object directory will be created if it does not exist, but
3152 once it does exist it will always have an earlier timestamp than
3153 the object files it contains.
3154
3155 However, Unix time semantics mean that the create time reported by
3156 Samba will be updated whenever a file is created or deleted in the
3157 directory. NMAKE finds all object files in the object directory.
3158 The timestamp of the last one built is then compared to the
3159 timestamp of the object directory. If the directory's timestamp if
3160 newer, then all object files will be rebuilt. Enabling this option
3161 ensures directories always predate their contents and an NMAKE
3162 build will proceed as expected.
3163
3164 Default: fake directory create times = no
3165
3166 fake oplocks (S)
3167
3168 Oplocks are the way that SMB clients get permission from a server
3169 to locally cache file operations. If a server grants an oplock
3170 (opportunistic lock) then the client is free to assume that it is
3171 the only one accessing the file and it will aggressively cache file
3172 data. With some oplock types the client may even cache file
3173 open/close operations. This can give enormous performance benefits.
3174
3175 When you set fake oplocks = yes, smbd(8) will always grant oplock
3176 requests no matter how many clients are using the file.
3177
3178 It is generally much better to use the real oplocks support rather
3179 than this parameter.
3180
3181 If you enable this option on all read-only shares or shares that
3182 you know will only be accessed from one client at a time such as
3183 physically read-only media like CDROMs, you will see a big
3184 performance improvement on many operations. If you enable this
3185 option on shares where multiple clients may be accessing the files
3186 read-write at the same time you can get data corruption. Use this
3187 option carefully!
3188
3189 Default: fake oplocks = no
3190
3191 follow symlinks (S)
3192
3193 This parameter allows the Samba administrator to stop smbd(8) from
3194 following symbolic links in a particular share. Setting this
3195 parameter to no prevents any file or directory that is a symbolic
3196 link from being followed (the user will get an error). This option
3197 is very useful to stop users from adding a symbolic link to
3198 /etc/passwd in their home directory for instance. However it will
3199 slow filename lookups down slightly.
3200
3201 This option is enabled (i.e. smbd will follow symbolic links) by
3202 default.
3203
3204 Default: follow symlinks = yes
3205
3206 force create mode (S)
3207
3208 This parameter specifies a set of UNIX mode bit permissions that
3209 will always be set on a file created by Samba. This is done by
3210 bitwise 'OR'ing these bits onto the mode bits of a file that is
3211 being created. The default for this parameter is (in octal) 000.
3212 The modes in this parameter are bitwise 'OR'ed onto the file mode
3213 after the mask set in the create mask parameter is applied.
3214
3215 The example below would force all newly created files to have read
3216 and execute permissions set for 'group' and 'other' as well as the
3217 read/write/execute bits set for the 'user'.
3218
3219 Default: force create mode = 0000
3220
3221 Example: force create mode = 0755
3222
3223 force directory mode (S)
3224
3225 This parameter specifies a set of UNIX mode bit permissions that
3226 will always be set on a directory created by Samba. This is done by
3227 bitwise 'OR'ing these bits onto the mode bits of a directory that
3228 is being created. The default for this parameter is (in octal) 0000
3229 which will not add any extra permission bits to a created
3230 directory. This operation is done after the mode mask in the
3231 parameter directory mask is applied.
3232
3233 The example below would force all created directories to have read
3234 and execute permissions set for 'group' and 'other' as well as the
3235 read/write/execute bits set for the 'user'.
3236
3237 Default: force directory mode = 0000
3238
3239 Example: force directory mode = 0755
3240
3241 force directory security mode (S)
3242
3243 This parameter has been removed for Samba 4.0.0.
3244
3245 No default
3246
3247 group
3248
3249 This parameter is a synonym for force group.
3250
3251 force group (S)
3252
3253 This specifies a UNIX group name that will be assigned as the
3254 default primary group for all users connecting to this service.
3255 This is useful for sharing files by ensuring that all access to
3256 files on service will use the named group for their permissions
3257 checking. Thus, by assigning permissions for this group to the
3258 files and directories within this service the Samba administrator
3259 can restrict or allow sharing of these files.
3260
3261 In Samba 2.0.5 and above this parameter has extended functionality
3262 in the following way. If the group name listed here has a '+'
3263 character prepended to it then the current user accessing the share
3264 only has the primary group default assigned to this group if they
3265 are already assigned as a member of that group. This allows an
3266 administrator to decide that only users who are already in a
3267 particular group will create files with group ownership set to that
3268 group. This gives a finer granularity of ownership assignment. For
3269 example, the setting force group = +sys means that only users who
3270 are already in group sys will have their default primary group
3271 assigned to sys when accessing this Samba share. All other users
3272 will retain their ordinary primary group.
3273
3274 If the force user parameter is also set the group specified in
3275 force group will override the primary group set in force user.
3276
3277 Default: force group =
3278
3279 Example: force group = agroup
3280
3281 force printername (S)
3282
3283 When printing from Windows NT (or later), each printer in smb.conf
3284 has two associated names which can be used by the client. The first
3285 is the sharename (or shortname) defined in smb.conf. This is the
3286 only printername available for use by Windows 9x clients. The
3287 second name associated with a printer can be seen when browsing to
3288 the "Printers" (or "Printers and Faxes") folder on the Samba
3289 server. This is referred to simply as the printername (not to be
3290 confused with the printer name option).
3291
3292 When assigning a new driver to a printer on a remote Windows
3293 compatible print server such as Samba, the Windows client will
3294 rename the printer to match the driver name just uploaded. This can
3295 result in confusion for users when multiple printers are bound to
3296 the same driver. To prevent Samba from allowing the printer's
3297 printername to differ from the sharename defined in smb.conf, set
3298 force printername = yes.
3299
3300 Be aware that enabling this parameter may affect migrating printers
3301 from a Windows server to Samba since Windows has no way to force
3302 the sharename and printername to match.
3303
3304 It is recommended that this parameter's value not be changed once
3305 the printer is in use by clients as this could cause a user not be
3306 able to delete printer connections from their local Printers
3307 folder.
3308
3309 Default: force printername = no
3310
3311 force security mode (S)
3312
3313 This parameter has been removed for Samba 4.0.0.
3314
3315 No default
3316
3317 force unknown acl user (S)
3318
3319 If this parameter is set, a Windows NT ACL that contains an unknown
3320 SID (security descriptor, or representation of a user or group id)
3321 as the owner or group owner of the file will be silently mapped
3322 into the current UNIX uid or gid of the currently connected user.
3323
3324 This is designed to allow Windows NT clients to copy files and
3325 folders containing ACLs that were created locally on the client
3326 machine and contain users local to that machine only (no domain
3327 users) to be copied to a Samba server (usually with XCOPY /O) and
3328 have the unknown userid and groupid of the file owner map to the
3329 current connected user. This can only be fixed correctly when
3330 winbindd allows arbitrary mapping from any Windows NT SID to a UNIX
3331 uid or gid.
3332
3333 Try using this parameter when XCOPY /O gives an ACCESS_DENIED
3334 error.
3335
3336 Default: force unknown acl user = no
3337
3338 force user (S)
3339
3340 This specifies a UNIX user name that will be assigned as the
3341 default user for all users connecting to this service. This is
3342 useful for sharing files. You should also use it carefully as using
3343 it incorrectly can cause security problems.
3344
3345 This user name only gets used once a connection is established.
3346 Thus clients still need to connect as a valid user and supply a
3347 valid password. Once connected, all file operations will be
3348 performed as the "forced user", no matter what username the client
3349 connected as. This can be very useful.
3350
3351 In Samba 2.0.5 and above this parameter also causes the primary
3352 group of the forced user to be used as the primary group for all
3353 file activity. Prior to 2.0.5 the primary group was left as the
3354 primary group of the connecting user (this was a bug).
3355
3356 Default: force user =
3357
3358 Example: force user = auser
3359
3360 fss: prune stale (G)
3361
3362 When enabled, Samba's File Server Remote VSS Protocol (FSRVP)
3363 server checks all FSRVP initiated snapshots on startup, and removes
3364 any corresponding state (including share definitions) for
3365 nonexistent snapshot paths.
3366
3367 Default: fss: prune stale = no
3368
3369 Example: fss: prune stale = yes
3370
3371 fss: sequence timeout (G)
3372
3373 The File Server Remote VSS Protocol (FSRVP) server includes a
3374 message sequence timer to ensure cleanup on unexpected client
3375 disconnect. This parameter overrides the default timeout between
3376 FSRVP operations. FSRVP timeouts can be completely disabled via a
3377 value of 0.
3378
3379 Default: fss: sequence timeout = 180 or 1800, depending on
3380 operation
3381
3382 Example: fss: sequence timeout = 0
3383
3384 fstype (S)
3385
3386 This parameter allows the administrator to configure the string
3387 that specifies the type of filesystem a share is using that is
3388 reported by smbd(8) when a client queries the filesystem type for a
3389 share. The default type is NTFS for compatibility with Windows NT
3390 but this can be changed to other strings such as Samba or FAT if
3391 required.
3392
3393 Default: fstype = NTFS
3394
3395 Example: fstype = Samba
3396
3397 get quota command (G)
3398
3399 The get quota command should only be used whenever there is no
3400 operating system API available from the OS that samba can use.
3401
3402 This option is only available Samba was compiled with quotas
3403 support.
3404
3405 This parameter should specify the path to a script that queries the
3406 quota information for the specified user/group for the partition
3407 that the specified directory is on.
3408
3409 Such a script is being given 3 arguments:
3410
3411 · directory
3412
3413 · type of query
3414
3415 · uid of user or gid of group
3416
3417 The directory is actually mostly just "." - It needs to be treated
3418 relatively to the current working directory that the script can
3419 also query.
3420
3421 The type of query can be one of:
3422
3423 · 1 - user quotas
3424
3425 · 2 - user default quotas (uid = -1)
3426
3427 · 3 - group quotas
3428
3429 · 4 - group default quotas (gid = -1)
3430
3431 This script should print one line as output with spaces between the
3432 columns. The printed columns should be:
3433
3434 · 1 - quota flags (0 = no quotas, 1 = quotas enabled, 2 =
3435 quotas enabled and enforced)
3436
3437 · 2 - number of currently used blocks
3438
3439 · 3 - the softlimit number of blocks
3440
3441 · 4 - the hardlimit number of blocks
3442
3443 · 5 - currently used number of inodes
3444
3445 · 6 - the softlimit number of inodes
3446
3447 · 7 - the hardlimit number of inodes
3448
3449 · 8 (optional) - the number of bytes in a block(default is
3450 1024)
3451
3452 Default: get quota command =
3453
3454 Example: get quota command = /usr/local/sbin/query_quota
3455
3456 getwd cache (G)
3457
3458 This is a tuning option. When this is enabled a caching algorithm
3459 will be used to reduce the time taken for getwd() calls. This can
3460 have a significant impact on performance, especially when the wide
3461 links parameter is set to no.
3462
3463 Default: getwd cache = yes
3464
3465 gpo update command (G)
3466
3467 This option sets the command that is called to apply GPO policies.
3468 The samba-gpupdate script applies System Access and Kerberos
3469 Policies to the KDC. System Access policies set minPwdAge,
3470 maxPwdAge, minPwdLength, and pwdProperties in the samdb. Kerberos
3471 Policies set kdc:service ticket lifetime, kdc:user ticket lifetime,
3472 and kdc:renewal lifetime in smb.conf.
3473
3474 Default: gpo update command =
3475 /builddir/build/BUILD/samba-4.13.7/source4/scripting/bin/samba-gpupdate
3476
3477 Example: gpo update command = /usr/local/sbin/gpoupdate
3478
3479 guest account (G)
3480
3481 This is a username which will be used for access to services which
3482 are specified as guest ok (see below). Whatever privileges this
3483 user has will be available to any client connecting to the guest
3484 service. This user must exist in the password file, but does not
3485 require a valid login. The user account "ftp" is often a good
3486 choice for this parameter.
3487
3488 On some systems the default guest account "nobody" may not be able
3489 to print. Use another account in this case. You should test this by
3490 trying to log in as your guest user (perhaps by using the su -
3491 command) and trying to print using the system print command such as
3492 lpr(1) or lp(1).
3493
3494 This parameter does not accept % macros, because many parts of the
3495 system require this value to be constant for correct operation.
3496
3497 Default: guest account = nobody # default can be changed at
3498 compile-time
3499
3500 Example: guest account = ftp
3501
3502 public
3503
3504 This parameter is a synonym for guest ok.
3505
3506 guest ok (S)
3507
3508 If this parameter is yes for a service, then no password is
3509 required to connect to the service. Privileges will be those of the
3510 guest account.
3511
3512 This parameter nullifies the benefits of setting restrict anonymous
3513 = 2
3514
3515 See the section below on security for more information about this
3516 option.
3517
3518 Default: guest ok = no
3519
3520 only guest
3521
3522 This parameter is a synonym for guest only.
3523
3524 guest only (S)
3525
3526 If this parameter is yes for a service, then only guest connections
3527 to the service are permitted. This parameter will have no effect if
3528 guest ok is not set for the service.
3529
3530 See the section below on security for more information about this
3531 option.
3532
3533 Default: guest only = no
3534
3535 hide dot files (S)
3536
3537 This is a boolean parameter that controls whether files starting
3538 with a dot appear as hidden files.
3539
3540 Default: hide dot files = yes
3541
3542 hide files (S)
3543
3544 This is a list of files or directories that are not visible but are
3545 accessible. The DOS 'hidden' attribute is applied to any files or
3546 directories that match.
3547
3548 Each entry in the list must be separated by a '/', which allows
3549 spaces to be included in the entry. '*' and '?' can be used to
3550 specify multiple files or directories as in DOS wildcards.
3551
3552 Each entry must be a Unix path, not a DOS path and must not include
3553 the Unix directory separator '/'.
3554
3555 Note that the case sensitivity option is applicable in hiding
3556 files.
3557
3558 Setting this parameter will affect the performance of Samba, as it
3559 will be forced to check all files and directories for a match as
3560 they are scanned.
3561
3562 The example shown above is based on files that the Macintosh SMB
3563 client (DAVE) available from Thursby creates for internal use, and
3564 also still hides all files beginning with a dot.
3565
3566 An example of us of this parameter is:
3567
3568 hide files = /.*/DesktopFolderDB/TrashFor%m/resource.frk/
3569
3570 Default: hide files = # no file are hidden
3571
3572 hide new files timeout (S)
3573
3574 Setting this parameter to something but 0 hides files that have
3575 been modified less than N seconds ago.
3576
3577 It can be used for ingest/process queue style workloads. A
3578 processing application should only see files that are definitely
3579 finished. As many applications do not have proper external workflow
3580 control, this can be a way to make sure processing does not
3581 interfere with file ingest.
3582
3583 Default: hide new files timeout = 0
3584
3585 hide special files (S)
3586
3587 This parameter prevents clients from seeing special files such as
3588 sockets, devices and fifo's in directory listings.
3589
3590 Default: hide special files = no
3591
3592 hide unreadable (S)
3593
3594 This parameter prevents clients from seeing the existence of files
3595 that cannot be read. Defaults to off.
3596
3597 Please note that enabling this can slow down listing large
3598 directories significantly. Samba has to evaluate the ACLs of all
3599 directory members, which can be a lot of effort.
3600
3601 Default: hide unreadable = no
3602
3603 hide unwriteable files (S)
3604
3605 This parameter prevents clients from seeing the existence of files
3606 that cannot be written to. Defaults to off. Note that unwriteable
3607 directories are shown as usual.
3608
3609 Please note that enabling this can slow down listing large
3610 directories significantly. Samba has to evaluate the ACLs of all
3611 directory members, which can be a lot of effort.
3612
3613 Default: hide unwriteable files = no
3614
3615 homedir map (G)
3616
3617 If nis homedir is yes, and smbd(8) is also acting as a Win95/98
3618 logon server then this parameter specifies the NIS (or YP) map from
3619 which the server for the user's home directory should be extracted.
3620 At present, only the Sun auto.home map format is understood. The
3621 form of the map is:
3622
3623 username server:/some/file/system
3624
3625 and the program will extract the servername from before the first
3626 ':'. There should probably be a better parsing system that copes
3627 with different map formats and also Amd (another automounter) maps.
3628
3629 Note
3630 A working NIS client is required on the system for this option
3631 to work.
3632 Default: homedir map =
3633
3634 Example: homedir map = amd.homedir
3635
3636 host msdfs (G)
3637
3638 If set to yes, Samba will act as a Dfs server, and allow Dfs-aware
3639 clients to browse Dfs trees hosted on the server.
3640
3641 See also the msdfs root share level parameter. For more information
3642 on setting up a Dfs tree on Samba, refer to the MSFDS chapter in
3643 the book Samba3-HOWTO.
3644
3645 Default: host msdfs = yes
3646
3647 hostname lookups (G)
3648
3649 Specifies whether samba should use (expensive) hostname lookups or
3650 use the ip addresses instead. An example place where hostname
3651 lookups are currently used is when checking the hosts deny and
3652 hosts allow.
3653
3654 Default: hostname lookups = no
3655
3656 Example: hostname lookups = yes
3657
3658 allow hosts
3659
3660 This parameter is a synonym for hosts allow.
3661
3662 hosts allow (S)
3663
3664 A synonym for this parameter is allow hosts.
3665
3666 This parameter is a comma, space, or tab delimited set of hosts
3667 which are permitted to access a service.
3668
3669 If specified in the [global] section then it will apply to all
3670 services, regardless of whether the individual service has a
3671 different setting.
3672
3673 You can specify the hosts by name or IP number. For example, you
3674 could restrict access to only the hosts on a Class C subnet with
3675 something like allow hosts = 150.203.5.. The full syntax of the
3676 list is described in the man page hosts_access(5). Note that this
3677 man page may not be present on your system, so a brief description
3678 will be given here also.
3679
3680 Note that the localhost address 127.0.0.1 will always be allowed
3681 access unless specifically denied by a hosts deny option.
3682
3683 You can also specify hosts by network/netmask pairs and by netgroup
3684 names if your system supports netgroups. The EXCEPT keyword can
3685 also be used to limit a wildcard list. The following examples may
3686 provide some help:
3687
3688 Example 1: allow all IPs in 150.203.*.*; except one
3689
3690 hosts allow = 150.203. EXCEPT 150.203.6.66
3691
3692 Example 2: allow hosts that match the given network/netmask
3693
3694 hosts allow = 150.203.15.0/255.255.255.0
3695
3696 Example 3: allow a couple of hosts
3697
3698 hosts allow = lapland, arvidsjaur
3699
3700 Example 4: allow only hosts in NIS netgroup "foonet", but deny
3701 access from one particular host
3702
3703 hosts allow = @foonet
3704
3705 hosts deny = pirate
3706
3707 Note
3708 Note that access still requires suitable user-level passwords.
3709 See testparm(1) for a way of testing your host access to see if it
3710 does what you expect.
3711
3712 Default: hosts allow = # none (i.e., all hosts permitted access)
3713
3714 Example: hosts allow = 150.203.5. myhost.mynet.edu.au
3715
3716 deny hosts
3717
3718 This parameter is a synonym for hosts deny.
3719
3720 hosts deny (S)
3721
3722 The opposite of hosts allow - hosts listed here are NOT permitted
3723 access to services unless the specific services have their own
3724 lists to override this one. Where the lists conflict, the allow
3725 list takes precedence.
3726
3727 In the event that it is necessary to deny all by default, use the
3728 keyword ALL (or the netmask 0.0.0.0/0) and then explicitly specify
3729 to the hosts allow = hosts allow parameter those hosts that should
3730 be permitted access.
3731
3732 Default: hosts deny = # none (i.e., no hosts specifically
3733 excluded)
3734
3735 Example: hosts deny = 150.203.4. badhost.mynet.edu.au
3736
3737 idmap backend (G)
3738
3739 The idmap backend provides a plugin interface for Winbind to use
3740 varying backends to store SID/uid/gid mapping tables.
3741
3742 This option specifies the default backend that is used when no
3743 special configuration set, but it is now deprecated in favour of
3744 the new spelling idmap config * : backend.
3745
3746 Default: idmap backend = tdb
3747
3748 idmap cache time (G)
3749
3750 This parameter specifies the number of seconds that Winbind's idmap
3751 interface will cache positive SID/uid/gid query results. By
3752 default, Samba will cache these results for one week.
3753
3754 Default: idmap cache time = 604800
3755
3756 idmap config DOMAIN : OPTION (G)
3757
3758 ID mapping in Samba is the mapping between Windows SIDs and Unix
3759 user and group IDs. This is performed by Winbindd with a
3760 configurable plugin interface. Samba's ID mapping is configured by
3761 options starting with the idmap config prefix. An idmap option
3762 consists of the idmap config prefix, followed by a domain name or
3763 the asterisk character (*), a colon, and the name of an idmap
3764 setting for the chosen domain.
3765
3766 The idmap configuration is hence divided into groups, one group for
3767 each domain to be configured, and one group with the asterisk
3768 instead of a proper domain name, which specifies the default
3769 configuration that is used to catch all domains that do not have an
3770 explicit idmap configuration of their own.
3771
3772 There are three general options available:
3773
3774 backend = backend_name
3775 This specifies the name of the idmap plugin to use as the
3776 SID/uid/gid backend for this domain. The standard backends are
3777 tdb (idmap_tdb(8)), tdb2 (idmap_tdb2(8)), ldap (idmap_ldap(8)),
3778 rid (idmap_rid(8)), hash (idmap_hash(8)), autorid
3779 (idmap_autorid(8)), ad (idmap_ad(8)) and nss (idmap_nss(8)).
3780 The corresponding manual pages contain the details, but here is
3781 a summary.
3782
3783 The first three of these create mappings of their own using
3784 internal unixid counters and store the mappings in a database.
3785 These are suitable for use in the default idmap configuration.
3786 The rid and hash backends use a pure algorithmic calculation to
3787 determine the unixid for a SID. The autorid module is a mixture
3788 of the tdb and rid backend. It creates ranges for each domain
3789 encountered and then uses the rid algorithm for each of these
3790 automatically configured domains individually. The ad backend
3791 uses unix ids stored in Active Directory via the standard
3792 schema extensions. The nss backend reverses the standard
3793 winbindd setup and gets the unix ids via names from nsswitch
3794 which can be useful in an ldap setup.
3795
3796 range = low - high
3797 Defines the available matching uid and gid range for which the
3798 backend is authoritative. For allocating backends, this also
3799 defines the start and the end of the range for allocating new
3800 unique IDs.
3801
3802 winbind uses this parameter to find the backend that is
3803 authoritative for a unix ID to SID mapping, so it must be set
3804 for each individually configured domain and for the default
3805 configuration. The configured ranges must be mutually disjoint.
3806
3807 read only = yes|no
3808 This option can be used to turn the writing backends tdb, tdb2,
3809 and ldap into read only mode. This can be useful e.g. in cases
3810 where a pre-filled database exists that should not be extended
3811 automatically.
3812
3813 The following example illustrates how to configure the idmap_ad(8)
3814 backend for the CORP domain and the idmap_tdb(8) backend for all
3815 other domains. This configuration assumes that the admin of CORP
3816 assigns unix ids below 1000000 via the SFU extensions, and winbind
3817 is supposed to use the next million entries for its own mappings
3818 from trusted domains and for local groups for example.
3819
3820 idmap config * : backend = tdb
3821 idmap config * : range = 1000000-1999999
3822
3823 idmap config CORP : backend = ad
3824 idmap config CORP : range = 1000-999999
3825
3826
3827 No default
3828
3829 winbind gid
3830
3831 This parameter is a synonym for idmap gid.
3832
3833 idmap gid (G)
3834
3835 The idmap gid parameter specifies the range of group ids for the
3836 default idmap configuration. It is now deprecated in favour of
3837 idmap config * : range.
3838
3839 See the idmap config option.
3840
3841 Default: idmap gid =
3842
3843 Example: idmap gid = 10000-20000
3844
3845 idmap negative cache time (G)
3846
3847 This parameter specifies the number of seconds that Winbind's idmap
3848 interface will cache negative SID/uid/gid query results.
3849
3850 Default: idmap negative cache time = 120
3851
3852 winbind uid
3853
3854 This parameter is a synonym for idmap uid.
3855
3856 idmap uid (G)
3857
3858 The idmap uid parameter specifies the range of user ids for the
3859 default idmap configuration. It is now deprecated in favour of
3860 idmap config * : range.
3861
3862 See the idmap config option.
3863
3864 Default: idmap uid =
3865
3866 Example: idmap uid = 10000-20000
3867
3868 include (S)
3869
3870 This allows you to include one config file inside another. The file
3871 is included literally, as though typed in place.
3872
3873 It takes the standard substitutions, except %u, %P and %S.
3874
3875 The parameter include = registry has a special meaning: It does not
3876 include a file named registry from the current working directory,
3877 but instead reads the global configuration options from the
3878 registry. See the section on registry-based configuration for
3879 details. Note that this option automatically activates registry
3880 shares.
3881
3882 Default: include =
3883
3884 Example: include = /usr/local/samba/lib/admin_smb.conf
3885
3886 include system krb5 conf (G)
3887
3888 Setting this parameter to no will prevent winbind to include the
3889 system /etc/krb5.conf file into the krb5.conf file it creates. See
3890 also create krb5 conf. This option only applies to Samba built with
3891 MIT Kerberos.
3892
3893 Default: include system krb5 conf = yes
3894
3895 inherit acls (S)
3896
3897 This parameter can be used to ensure that if default acls exist on
3898 parent directories, they are always honored when creating a new
3899 file or subdirectory in these parent directories. The default
3900 behavior is to use the unix mode specified when creating the
3901 directory. Enabling this option sets the unix mode to 0777, thus
3902 guaranteeing that default directory acls are propagated. Note that
3903 using the VFS modules acl_xattr or acl_tdb which store native
3904 Windows as meta-data will automatically turn this option on for any
3905 share for which they are loaded, as they require this option to
3906 emulate Windows ACLs correctly.
3907
3908 Default: inherit acls = no
3909
3910 inherit owner (S)
3911
3912 The ownership of new files and directories is normally governed by
3913 effective uid of the connected user. This option allows the Samba
3914 administrator to specify that the ownership for new files and
3915 directories should be controlled by the ownership of the parent
3916 directory.
3917
3918 Valid options are:
3919
3920 · no - Both the Windows (SID) owner and the UNIX (uid)
3921 owner of the file are governed by the identity of the
3922 user that created the file.
3923
3924 · windows and unix - The Windows (SID) owner and the UNIX
3925 (uid) owner of new files and directories are set to the
3926 respective owner of the parent directory.
3927
3928 · yes - a synonym for windows and unix.
3929
3930 · unix only - Only the UNIX owner is set to the UNIX owner
3931 of the parent directory.
3932
3933 Common scenarios where this behavior is useful is in implementing
3934 drop-boxes, where users can create and edit files but not delete
3935 them and ensuring that newly created files in a user's roaming
3936 profile directory are actually owned by the user.
3937
3938 The unix only option effectively breaks the tie between the Windows
3939 owner of a file and the UNIX owner. As a logical consequence, in
3940 this mode, setting the the Windows owner of a file does not modify
3941 the UNIX owner. Using this mode should typically be combined with a
3942 backing store that can emulate the full NT ACL model without
3943 affecting the POSIX permissions, such as the acl_xattr VFS module,
3944 coupled with acl_xattr:ignore system acls = yes. This can be used
3945 to emulate folder quotas, when files are exposed only via SMB
3946 (without UNIX extensions). The UNIX owner of a directory is locally
3947 set and inherited by all subdirectories and files, and they all
3948 consume the same quota.
3949
3950 Default: inherit owner = no
3951
3952 inherit permissions (S)
3953
3954 The permissions on new files and directories are normally governed
3955 by create mask, directory mask, force create mode and force
3956 directory mode but the boolean inherit permissions parameter
3957 overrides this.
3958
3959 New directories inherit the mode of the parent directory, including
3960 bits such as setgid.
3961
3962 New files inherit their read/write bits from the parent directory.
3963 Their execute bits continue to be determined by map archive, map
3964 hidden and map system as usual.
3965
3966 Note that the setuid bit is never set via inheritance (the code
3967 explicitly prohibits this).
3968
3969 This can be particularly useful on large systems with many users,
3970 perhaps several thousand, to allow a single [homes] share to be
3971 used flexibly by each user.
3972
3973 Default: inherit permissions = no
3974
3975 init logon delay (G)
3976
3977 This parameter specifies a delay in milliseconds for the hosts
3978 configured for delayed initial samlogon with init logon delayed
3979 hosts.
3980
3981 Default: init logon delay = 100
3982
3983 init logon delayed hosts (G)
3984
3985 This parameter takes a list of host names, addresses or networks
3986 for which the initial samlogon reply should be delayed (so other
3987 DCs get preferred by XP workstations if there are any).
3988
3989 The length of the delay can be specified with the init logon delay
3990 parameter.
3991
3992 Default: init logon delayed hosts =
3993
3994 Example: init logon delayed hosts = 150.203.5. myhost.mynet.de
3995
3996 interfaces (G)
3997
3998 This option allows you to override the default network interfaces
3999 list that Samba will use for browsing, name registration and other
4000 NetBIOS over TCP/IP (NBT) traffic. By default Samba will query the
4001 kernel for the list of all active interfaces and use any interfaces
4002 except 127.0.0.1 that are broadcast capable.
4003
4004 The option takes a list of interface strings. Each string can be in
4005 any of the following forms:
4006
4007 · a network interface name (such as eth0). This may
4008 include shell-like wildcards so eth* will match any
4009 interface starting with the substring "eth"
4010
4011 · an IP address. In this case the netmask is determined
4012 from the list of interfaces obtained from the kernel
4013
4014 · an IP/mask pair.
4015
4016 · a broadcast/mask pair.
4017
4018 The "mask" parameters can either be a bit length (such as 24 for a
4019 C class network) or a full netmask in dotted decimal form.
4020
4021 The "IP" parameters above can either be a full dotted decimal IP
4022 address or a hostname which will be looked up via the OS's normal
4023 hostname resolution mechanisms.
4024
4025 By default Samba enables all active interfaces that are broadcast
4026 capable except the loopback adaptor (IP address 127.0.0.1).
4027
4028 In order to support SMB3 multi-channel configurations, smbd
4029 understands some extra parameters which can be appended after the
4030 actual interface with this extended syntax (note that the quoting
4031 is important in order to handle the ; and , characters):
4032
4033 "interface[;key1=value1[,key2=value2[...]]]"
4034
4035 Known keys are speed, capability, and if_index. Speed is specified
4036 in bits per second. Known capabilities are RSS and RDMA. The
4037 if_index should be used with care: the values must not coincide
4038 with indexes used by the kernel. Note that these options are mainly
4039 intended for testing and development rather than for production
4040 use. At least on Linux systems, these values should be
4041 auto-detected, but the settings can serve as last a resort when
4042 autodetection is not working or is not available. The specified
4043 values overwrite the auto-detected values.
4044
4045 The first two example below configures three network interfaces
4046 corresponding to the eth0 device and IP addresses 192.168.2.10 and
4047 192.168.3.10. The netmasks of the latter two interfaces would be
4048 set to 255.255.255.0.
4049
4050 The other examples show how per interface extra parameters can be
4051 specified. Notice the possible usage of "," and ";", which makes
4052 the double quoting necessary.
4053
4054 Default: interfaces =
4055
4056 Example: interfaces = eth0 192.168.2.10/24
4057 192.168.3.10/255.255.255.0
4058
4059 Example: interfaces = eth0, 192.168.2.10/24;
4060 192.168.3.10/255.255.255.0
4061
4062 Example: interfaces =
4063 "eth0;if_index=65,speed=1000000000,capability=RSS"
4064
4065 Example: interfaces = "lo;speed=1000000000" "eth0;capability=RSS"
4066
4067 Example: interfaces = "lo;speed=1000000000" , "eth0;capability=RSS"
4068
4069 Example: interfaces = "eth0;capability=RSS" ,
4070 "rdma1;capability=RDMA" ; "rdma2;capability=RSS,capability=RDMA"
4071
4072 invalid users (S)
4073
4074 This is a list of users that should not be allowed to login to this
4075 service. This is really a paranoid check to absolutely ensure an
4076 improper setting does not breach your security.
4077
4078 A name starting with a '@' is interpreted as an NIS netgroup first
4079 (if your system supports NIS), and then as a UNIX group if the name
4080 was not found in the NIS netgroup database.
4081
4082 A name starting with '+' is interpreted only by looking in the UNIX
4083 group database via the NSS getgrnam() interface. A name starting
4084 with '&' is interpreted only by looking in the NIS netgroup
4085 database (this requires NIS to be working on your system). The
4086 characters '+' and '&' may be used at the start of the name in
4087 either order so the value +&group means check the UNIX group
4088 database, followed by the NIS netgroup database, and the value
4089 &+group means check the NIS netgroup database, followed by the UNIX
4090 group database (the same as the '@' prefix).
4091
4092 The current servicename is substituted for %S. This is useful in
4093 the [homes] section.
4094
4095 Default: invalid users = # no invalid users
4096
4097 Example: invalid users = root fred admin @wheel
4098
4099 iprint server (G)
4100
4101 This parameter is only applicable if printing is set to iprint.
4102
4103 If set, this option overrides the ServerName option in the CUPS
4104 client.conf. This is necessary if you have virtual samba servers
4105 that connect to different CUPS daemons.
4106
4107 Default: iprint server = ""
4108
4109 Example: iprint server = MYCUPSSERVER
4110
4111 keepalive (G)
4112
4113 The value of the parameter (an integer) represents the number of
4114 seconds between keepalive packets. If this parameter is zero, no
4115 keepalive packets will be sent. Keepalive packets, if sent, allow
4116 the server to tell whether a client is still present and
4117 responding.
4118
4119 Keepalives should, in general, not be needed if the socket has the
4120 SO_KEEPALIVE attribute set on it by default. (see socket options).
4121 Basically you should only use this option if you strike
4122 difficulties.
4123
4124 Please note this option only applies to SMB1 client connections,
4125 and has no effect on SMB2 clients.
4126
4127 Default: keepalive = 300
4128
4129 Example: keepalive = 600
4130
4131 kerberos encryption types (G)
4132
4133 This parameter determines the encryption types to use when
4134 operating as a Kerberos client. Possible values are all, strong,
4135 and legacy.
4136
4137 Samba uses a Kerberos library (MIT or Heimdal) to obtain Kerberos
4138 tickets. This library is normally configured outside of Samba,
4139 using the krb5.conf file. This file may also include directives to
4140 configure the encryption types to be used. However, Samba
4141 implements Active Directory protocols and algorithms to locate a
4142 domain controller. In order to force the Kerberos library into
4143 using the correct domain controller, some Samba processes, such as
4144 winbindd(8) and net(8), build a private krb5.conf file for use by
4145 the Kerberos library while being invoked from Samba. This private
4146 file controls all aspects of the Kerberos library operation, and
4147 this parameter controls how the encryption types are configured
4148 within this generated file, and therefore also controls the
4149 encryption types negotiable by Samba.
4150
4151 When set to all, all active directory encryption types are allowed.
4152
4153 When set to strong, only AES-based encryption types are offered.
4154 This can be used in hardened environments to prevent downgrade
4155 attacks.
4156
4157 When set to legacy, only RC4-HMAC-MD5 is allowed. Avoiding AES this
4158 way has one a very specific use. Normally, the encryption type is
4159 negotiated between the peers. However, there is one scenario in
4160 which a Windows read-only domain controller (RODC) advertises AES
4161 encryption, but then proxies the request to a writeable DC which
4162 may not support AES encryption, leading to failure of the
4163 handshake. Setting this parameter to legacy would cause samba not
4164 to negotiate AES encryption. It is assumed of course that the
4165 weaker legacy encryption types are acceptable for the setup.
4166
4167 Default: kerberos encryption types = all
4168
4169 kerberos method (G)
4170
4171 Controls how kerberos tickets are verified.
4172
4173 Valid options are:
4174
4175 · secrets only - use only the secrets.tdb for ticket
4176 verification (default)
4177
4178 · system keytab - use only the system keytab for ticket
4179 verification
4180
4181 · dedicated keytab - use a dedicated keytab for ticket
4182 verification
4183
4184 · secrets and keytab - use the secrets.tdb first, then the
4185 system keytab
4186
4187 The major difference between "system keytab" and "dedicated keytab"
4188 is that the latter method relies on kerberos to find the correct
4189 keytab entry instead of filtering based on expected principals.
4190
4191 When the kerberos method is in "dedicated keytab" mode, dedicated
4192 keytab file must be set to specify the location of the keytab file.
4193
4194 Default: kerberos method = default
4195
4196 kernel change notify (G)
4197
4198 This parameter specifies whether Samba should ask the kernel for
4199 change notifications in directories so that SMB clients can refresh
4200 whenever the data on the server changes.
4201
4202 This parameter is only used when your kernel supports change
4203 notification to user programs using the inotify interface.
4204
4205 Default: kernel change notify = yes
4206
4207 kernel oplocks (S)
4208
4209 For UNIXes that support kernel based oplocks (currently only
4210 Linux), this parameter allows the use of them to be turned on or
4211 off. However, this disables Level II oplocks for clients as the
4212 Linux kernel does not support them properly.
4213
4214 Kernel oplocks support allows Samba oplocks to be broken whenever a
4215 local UNIX process or NFS operation accesses a file that smbd(8)
4216 has oplocked. This allows complete data consistency between
4217 SMB/CIFS, NFS and local file access (and is a very cool feature
4218 :-).
4219
4220 If you do not need this interaction, you should disable the
4221 parameter on Linux to get Level II oplocks and the associated
4222 performance benefit.
4223
4224 This parameter defaults to no and is translated to a no-op on
4225 systems that do not have the necessary kernel support.
4226
4227 Default: kernel oplocks = no
4228
4229 kernel share modes (S)
4230
4231 This parameter controls whether SMB share modes are translated into
4232 UNIX flocks.
4233
4234 Kernel share modes provide a minimal level of interoperability with
4235 local UNIX processes and NFS operations by preventing access with
4236 flocks corresponding to the SMB share modes. Generally, it is very
4237 desirable to leave this enabled.
4238
4239 Note that in order to use SMB2 durable file handles on a share, you
4240 have to turn kernel share modes off.
4241
4242 This parameter defaults to yes and is translated to a no-op on
4243 systems that do not have the necessary kernel flock support.
4244
4245 Default: kernel share modes = yes
4246
4247 kpasswd port (G)
4248
4249 Specifies which ports the Kerberos server should listen on for
4250 password changes.
4251
4252 Default: kpasswd port = 464
4253
4254 krb5 port (G)
4255
4256 Specifies which port the KDC should listen on for Kerberos traffic.
4257
4258 Default: krb5 port = 88
4259
4260 lanman auth (G)
4261
4262 This parameter has been deprecated since Samba 4.11 and support for
4263 LanMan (as distinct from NTLM, NTLMv2 or Kerberos authentication)
4264 will be removed in a future Samba release.
4265
4266 That is, in the future, the current default of lanman auth = no
4267 will be the enforced behaviour.
4268
4269 This parameter determines whether or not smbd(8) will attempt to
4270 authenticate users or permit password changes using the LANMAN
4271 password hash. If disabled, only clients which support NT password
4272 hashes (e.g. Windows NT/2000 clients, smbclient, but not Windows
4273 95/98 or the MS DOS network client) will be able to connect to the
4274 Samba host.
4275
4276 The LANMAN encrypted response is easily broken, due to its
4277 case-insensitive nature, and the choice of algorithm. Servers
4278 without Windows 95/98/ME or MS DOS clients are advised to disable
4279 this option.
4280
4281 When this parameter is set to no this will also result in
4282 sambaLMPassword in Samba's passdb being blanked after the next
4283 password change. As a result of that lanman clients won't be able
4284 to authenticate, even if lanman auth is re-enabled later on.
4285
4286 Unlike the encrypt passwords option, this parameter cannot alter
4287 client behaviour, and the LANMAN response will still be sent over
4288 the network. See the client lanman auth to disable this for Samba's
4289 clients (such as smbclient)
4290
4291 This parameter is overridden by ntlm auth, so unless that it is
4292 also set to ntlmv1-permitted or yes, then only NTLMv2 logins will
4293 be permitted and no LM hash will be stored. All modern clients
4294 support NTLMv2, and but some older clients require special
4295 configuration to use it.
4296
4297 Default: lanman auth = no
4298
4299 large readwrite (G)
4300
4301 This parameter determines whether or not smbd(8) supports the new
4302 64k streaming read and write variant SMB requests introduced with
4303 Windows 2000. Note that due to Windows 2000 client redirector bugs
4304 this requires Samba to be running on a 64-bit capable operating
4305 system such as IRIX, Solaris or a Linux 2.4 kernel. Can improve
4306 performance by 10% with Windows 2000 clients. Defaults to on. Not
4307 as tested as some other Samba code paths.
4308
4309 Default: large readwrite = yes
4310
4311 ldap admin dn (G)
4312
4313 The ldap admin dn defines the Distinguished Name (DN) name used by
4314 Samba to contact the ldap server when retrieving user account
4315 information. The ldap admin dn is used in conjunction with the
4316 admin dn password stored in the private/secrets.tdb file. See the
4317 smbpasswd(8) man page for more information on how to accomplish
4318 this.
4319
4320 The ldap admin dn requires a fully specified DN. The ldap suffix is
4321 not appended to the ldap admin dn.
4322
4323 No default
4324
4325 ldap connection timeout (G)
4326
4327 This parameter tells the LDAP library calls which timeout in
4328 seconds they should honor during initial connection establishments
4329 to LDAP servers. It is very useful in failover scenarios in
4330 particular. If one or more LDAP servers are not reachable at all,
4331 we do not have to wait until TCP timeouts are over. This feature
4332 must be supported by your LDAP library.
4333
4334 This parameter is different from ldap timeout which affects
4335 operations on LDAP servers using an existing connection and not
4336 establishing an initial connection.
4337
4338 Default: ldap connection timeout = 2
4339
4340 ldap debug level (G)
4341
4342 This parameter controls the debug level of the LDAP library calls.
4343 In the case of OpenLDAP, it is the same bit-field as understood by
4344 the server and documented in the slapd.conf(5) manpage. A typical
4345 useful value will be 1 for tracing function calls.
4346
4347 The debug output from the LDAP libraries appears with the prefix
4348 [LDAP] in Samba's logging output. The level at which LDAP logging
4349 is printed is controlled by the parameter ldap debug threshold.
4350
4351 Default: ldap debug level = 0
4352
4353 Example: ldap debug level = 1
4354
4355 ldap debug threshold (G)
4356
4357 This parameter controls the Samba debug level at which the ldap
4358 library debug output is printed in the Samba logs. See the
4359 description of ldap debug level for details.
4360
4361 Default: ldap debug threshold = 10
4362
4363 Example: ldap debug threshold = 5
4364
4365 ldap delete dn (G)
4366
4367 This parameter specifies whether a delete operation in the ldapsam
4368 deletes the complete entry or only the attributes specific to
4369 Samba.
4370
4371 Default: ldap delete dn = no
4372
4373 ldap deref (G)
4374
4375 This option controls whether Samba should tell the LDAP library to
4376 use a certain alias dereferencing method. The default is auto,
4377 which means that the default setting of the ldap client library
4378 will be kept. Other possible values are never, finding, searching
4379 and always. Grab your LDAP manual for more information.
4380
4381 Default: ldap deref = auto
4382
4383 Example: ldap deref = searching
4384
4385 ldap follow referral (G)
4386
4387 This option controls whether to follow LDAP referrals or not when
4388 searching for entries in the LDAP database. Possible values are on
4389 to enable following referrals, off to disable this, and auto, to
4390 use the libldap default settings. libldap's choice of following
4391 referrals or not is set in /etc/openldap/ldap.conf with the
4392 REFERRALS parameter as documented in ldap.conf(5).
4393
4394 Default: ldap follow referral = auto
4395
4396 Example: ldap follow referral = off
4397
4398 ldap group suffix (G)
4399
4400 This parameter specifies the suffix that is used for groups when
4401 these are added to the LDAP directory. If this parameter is unset,
4402 the value of ldap suffix will be used instead. The suffix string is
4403 pre-pended to the ldap suffix string so use a partial DN.
4404
4405 Default: ldap group suffix =
4406
4407 Example: ldap group suffix = ou=Groups
4408
4409 ldap idmap suffix (G)
4410
4411 This parameters specifies the suffix that is used when storing
4412 idmap mappings. If this parameter is unset, the value of ldap
4413 suffix will be used instead. The suffix string is pre-pended to the
4414 ldap suffix string so use a partial DN.
4415
4416 Default: ldap idmap suffix =
4417
4418 Example: ldap idmap suffix = ou=Idmap
4419
4420 ldap machine suffix (G)
4421
4422 It specifies where machines should be added to the ldap tree. If
4423 this parameter is unset, the value of ldap suffix will be used
4424 instead. The suffix string is pre-pended to the ldap suffix string
4425 so use a partial DN.
4426
4427 Default: ldap machine suffix =
4428
4429 Example: ldap machine suffix = ou=Computers
4430
4431 ldap max anonymous request size (G)
4432
4433 This parameter specifies the maximum permitted size (in bytes) for
4434 an LDAP request received on an anonymous connection.
4435
4436 If the request size exceeds this limit the request will be
4437 rejected.
4438
4439 Default: ldap max anonymous request size = 256000
4440
4441 Example: ldap max anonymous request size = 500000
4442
4443 ldap max authenticated request size (G)
4444
4445 This parameter specifies the maximum permitted size (in bytes) for
4446 an LDAP request received on an authenticated connection.
4447
4448 If the request size exceeds this limit the request will be
4449 rejected.
4450
4451 Default: ldap max authenticated request size = 16777216
4452
4453 Example: ldap max authenticated request size = 4194304
4454
4455 ldap max search request size (G)
4456
4457 This parameter specifies the maximum permitted size (in bytes) for
4458 an LDAP search request.
4459
4460 If the request size exceeds this limit the request will be
4461 rejected.
4462
4463 Default: ldap max search request size = 256000
4464
4465 Example: ldap max search request size = 4194304
4466
4467 ldap page size (G)
4468
4469 This parameter specifies the number of entries per page.
4470
4471 If the LDAP server supports paged results, clients can request
4472 subsets of search results (pages) instead of the entire list. This
4473 parameter specifies the size of these pages.
4474
4475 Default: ldap page size = 1000
4476
4477 Example: ldap page size = 512
4478
4479 ldap password sync
4480
4481 This parameter is a synonym for ldap passwd sync.
4482
4483 ldap passwd sync (G)
4484
4485 This option is used to define whether or not Samba should sync the
4486 LDAP password with the NT and LM hashes for normal accounts (NOT
4487 for workstation, server or domain trusts) on a password change via
4488 SAMBA.
4489
4490 The ldap passwd sync can be set to one of three values:
4491
4492 · Yes = Try to update the LDAP, NT and LM passwords and
4493 update the pwdLastSet time.
4494
4495 · No = Update NT and LM passwords and update the
4496 pwdLastSet time.
4497
4498 · Only = Only update the LDAP password and let the LDAP
4499 server do the rest.
4500
4501 Default: ldap passwd sync = no
4502
4503 ldap replication sleep (G)
4504
4505 When Samba is asked to write to a read-only LDAP replica, we are
4506 redirected to talk to the read-write master server. This server
4507 then replicates our changes back to the 'local' server, however the
4508 replication might take some seconds, especially over slow links.
4509 Certain client activities, particularly domain joins, can become
4510 confused by the 'success' that does not immediately change the LDAP
4511 back-end's data.
4512
4513 This option simply causes Samba to wait a short time, to allow the
4514 LDAP server to catch up. If you have a particularly high-latency
4515 network, you may wish to time the LDAP replication with a network
4516 sniffer, and increase this value accordingly. Be aware that no
4517 checking is performed that the data has actually replicated.
4518
4519 The value is specified in milliseconds, the maximum value is 5000
4520 (5 seconds).
4521
4522 Default: ldap replication sleep = 1000
4523
4524 ldapsam:editposix (G)
4525
4526 Editposix is an option that leverages ldapsam:trusted to make it
4527 simpler to manage a domain controller eliminating the need to set
4528 up custom scripts to add and manage the posix users and groups.
4529 This option will instead directly manipulate the ldap tree to
4530 create, remove and modify user and group entries. This option also
4531 requires a running winbindd as it is used to allocate new uids/gids
4532 on user/group creation. The allocation range must be therefore
4533 configured.
4534
4535 To use this option, a basic ldap tree must be provided and the ldap
4536 suffix parameters must be properly configured. On virgin servers
4537 the default users and groups (Administrator, Guest, Domain Users,
4538 Domain Admins, Domain Guests) can be precreated with the command
4539 net sam provision. To run this command the ldap server must be
4540 running, Winbindd must be running and the smb.conf ldap options
4541 must be properly configured. The typical ldap setup used with the
4542 ldapsam:trusted = yes option is usually sufficient to use
4543 ldapsam:editposix = yes as well.
4544
4545 An example configuration can be the following:
4546
4547 encrypt passwords = true
4548 passdb backend = ldapsam
4549
4550 ldapsam:trusted=yes
4551 ldapsam:editposix=yes
4552
4553 ldap admin dn = cn=admin,dc=samba,dc=org
4554 ldap delete dn = yes
4555 ldap group suffix = ou=groups
4556 ldap idmap suffix = ou=idmap
4557 ldap machine suffix = ou=computers
4558 ldap user suffix = ou=users
4559 ldap suffix = dc=samba,dc=org
4560
4561 idmap backend = ldap:"ldap://localhost"
4562
4563 idmap uid = 5000-50000
4564 idmap gid = 5000-50000
4565
4566
4567 This configuration assumes a directory layout like described in the
4568 following ldif:
4569
4570 dn: dc=samba,dc=org
4571 objectClass: top
4572 objectClass: dcObject
4573 objectClass: organization
4574 o: samba.org
4575 dc: samba
4576
4577 dn: cn=admin,dc=samba,dc=org
4578 objectClass: simpleSecurityObject
4579 objectClass: organizationalRole
4580 cn: admin
4581 description: LDAP administrator
4582 userPassword: secret
4583
4584 dn: ou=users,dc=samba,dc=org
4585 objectClass: top
4586 objectClass: organizationalUnit
4587 ou: users
4588
4589 dn: ou=groups,dc=samba,dc=org
4590 objectClass: top
4591 objectClass: organizationalUnit
4592 ou: groups
4593
4594 dn: ou=idmap,dc=samba,dc=org
4595 objectClass: top
4596 objectClass: organizationalUnit
4597 ou: idmap
4598
4599 dn: ou=computers,dc=samba,dc=org
4600 objectClass: top
4601 objectClass: organizationalUnit
4602 ou: computers
4603
4604
4605 Default: ldapsam:editposix = no
4606
4607 ldapsam:trusted (G)
4608
4609 By default, Samba as a Domain Controller with an LDAP backend needs
4610 to use the Unix-style NSS subsystem to access user and group
4611 information. Due to the way Unix stores user information in
4612 /etc/passwd and /etc/group this inevitably leads to inefficiencies.
4613 One important question a user needs to know is the list of groups
4614 he is member of. The plain UNIX model involves a complete
4615 enumeration of the file /etc/group and its NSS counterparts in
4616 LDAP. UNIX has optimized functions to enumerate group membership.
4617 Sadly, other functions that are used to deal with user and group
4618 attributes lack such optimization.
4619
4620 To make Samba scale well in large environments, the ldapsam:trusted
4621 = yes option assumes that the complete user and group database that
4622 is relevant to Samba is stored in LDAP with the standard
4623 posixAccount/posixGroup attributes. It further assumes that the
4624 Samba auxiliary object classes are stored together with the POSIX
4625 data in the same LDAP object. If these assumptions are met,
4626 ldapsam:trusted = yes can be activated and Samba can bypass the NSS
4627 system to query user group memberships. Optimized LDAP queries can
4628 greatly speed up domain logon and administration tasks. Depending
4629 on the size of the LDAP database a factor of 100 or more for common
4630 queries is easily achieved.
4631
4632 Default: ldapsam:trusted = no
4633
4634 ldap server require strong auth (G)
4635
4636 The ldap server require strong auth defines whether the ldap server
4637 requires ldap traffic to be signed or signed and encrypted
4638 (sealed). Possible values are no, allow_sasl_over_tls and yes.
4639
4640 A value of no allows simple and sasl binds over all transports.
4641
4642 A value of allow_sasl_over_tls allows simple and sasl binds
4643 (without sign or seal) over TLS encrypted connections. Unencrypted
4644 connections only allow sasl binds with sign or seal.
4645
4646 A value of yes allows only simple binds over TLS encrypted
4647 connections. Unencrypted connections only allow sasl binds with
4648 sign or seal.
4649
4650 Default: ldap server require strong auth = yes
4651
4652 ldap ssl (G)
4653
4654 This option is used to define whether or not Samba should use SSL
4655 when connecting to the ldap server This is NOT related to Samba's
4656 previous SSL support which was enabled by specifying the --with-ssl
4657 option to the configure script.
4658
4659 LDAP connections should be secured where possible. This may be done
4660 setting either this parameter to start tls or by specifying
4661 ldaps:// in the URL argument of passdb backend.
4662
4663 The ldap ssl can be set to one of two values:
4664
4665 · Off = Never use SSL when querying the directory.
4666
4667 · start tls = Use the LDAPv3 StartTLS extended operation
4668 (RFC2830) for communicating with the directory server.
4669
4670 Please note that this parameter does only affect rpc methods. To
4671 enable the LDAPv3 StartTLS extended operation (RFC2830) for ads,
4672 set ldap ssl = start tls and ldap ssl ads = yes. See smb.conf(5)
4673 for more information on ldap ssl ads.
4674
4675 Default: ldap ssl = start tls
4676
4677 ldap suffix (G)
4678
4679 Specifies the base for all ldap suffixes and for storing the
4680 sambaDomain object.
4681
4682 The ldap suffix will be appended to the values specified for the
4683 ldap user suffix, ldap group suffix, ldap machine suffix, and the
4684 ldap idmap suffix. Each of these should be given only a DN relative
4685 to the ldap suffix.
4686
4687 Default: ldap suffix =
4688
4689 Example: ldap suffix = dc=samba,dc=org
4690
4691 ldap timeout (G)
4692
4693 This parameter defines the number of seconds that Samba should use
4694 as timeout for LDAP operations.
4695
4696 Default: ldap timeout = 15
4697
4698 ldap user suffix (G)
4699
4700 This parameter specifies where users are added to the tree. If this
4701 parameter is unset, the value of ldap suffix will be used instead.
4702 The suffix string is pre-pended to the ldap suffix string so use a
4703 partial DN.
4704
4705 Default: ldap user suffix =
4706
4707 Example: ldap user suffix = ou=people
4708
4709 level2 oplocks (S)
4710
4711 This parameter controls whether Samba supports level2 (read-only)
4712 oplocks on a share.
4713
4714 Level2, or read-only oplocks allow Windows NT clients that have an
4715 oplock on a file to downgrade from a read-write oplock to a
4716 read-only oplock once a second client opens the file (instead of
4717 releasing all oplocks on a second open, as in traditional,
4718 exclusive oplocks). This allows all openers of the file that
4719 support level2 oplocks to cache the file for read-ahead only (ie.
4720 they may not cache writes or lock requests) and increases
4721 performance for many accesses of files that are not commonly
4722 written (such as application .EXE files).
4723
4724 Once one of the clients which have a read-only oplock writes to the
4725 file all clients are notified (no reply is needed or waited for)
4726 and told to break their oplocks to "none" and delete any read-ahead
4727 caches.
4728
4729 It is recommended that this parameter be turned on to speed access
4730 to shared executables.
4731
4732 For more discussions on level2 oplocks see the CIFS spec.
4733
4734 Currently, if kernel oplocks are supported then level2 oplocks are
4735 not granted (even if this parameter is set to yes). Note also, the
4736 oplocks parameter must be set to yes on this share in order for
4737 this parameter to have any effect.
4738
4739 Default: level2 oplocks = yes
4740
4741 lm announce (G)
4742
4743 This parameter determines if nmbd(8) will produce Lanman announce
4744 broadcasts that are needed by OS/2 clients in order for them to see
4745 the Samba server in their browse list. This parameter can have
4746 three values, yes, no, or auto. The default is auto. If set to no
4747 Samba will never produce these broadcasts. If set to yes Samba will
4748 produce Lanman announce broadcasts at a frequency set by the
4749 parameter lm interval. If set to auto Samba will not send Lanman
4750 announce broadcasts by default but will listen for them. If it
4751 hears such a broadcast on the wire it will then start sending them
4752 at a frequency set by the parameter lm interval.
4753
4754 Default: lm announce = auto
4755
4756 Example: lm announce = yes
4757
4758 lm interval (G)
4759
4760 If Samba is set to produce Lanman announce broadcasts needed by
4761 OS/2 clients (see the lm announce parameter) then this parameter
4762 defines the frequency in seconds with which they will be made. If
4763 this is set to zero then no Lanman announcements will be made
4764 despite the setting of the lm announce parameter.
4765
4766 Default: lm interval = 60
4767
4768 Example: lm interval = 120
4769
4770 load printers (G)
4771
4772 A boolean variable that controls whether all printers in the
4773 printcap will be loaded for browsing by default. See the printers
4774 section for more details.
4775
4776 Default: load printers = yes
4777
4778 local master (G)
4779
4780 This option allows nmbd(8) to try and become a local master browser
4781 on a subnet. If set to no then nmbd will not attempt to become a
4782 local master browser on a subnet and will also lose in all browsing
4783 elections. By default this value is set to yes. Setting this value
4784 to yes doesn't mean that Samba will become the local master browser
4785 on a subnet, just that nmbd will participate in elections for local
4786 master browser.
4787
4788 Setting this value to no will cause nmbd never to become a local
4789 master browser.
4790
4791 Default: local master = yes
4792
4793 lock dir
4794
4795 This parameter is a synonym for lock directory.
4796
4797 lock directory (G)
4798
4799 This option specifies the directory where lock files will be
4800 placed. The lock files are used to implement the max connections
4801 option.
4802
4803 Note: This option can not be set inside registry configurations.
4804
4805 The files placed in this directory are not required across service
4806 restarts and can be safely placed on volatile storage (e.g. tmpfs
4807 in Linux)
4808
4809 Default: lock directory = /var/lib/samba/lock
4810
4811 Example: lock directory = /var/run/samba/locks
4812
4813 locking (S)
4814
4815 This controls whether or not locking will be performed by the
4816 server in response to lock requests from the client.
4817
4818 If locking = no, all lock and unlock requests will appear to
4819 succeed and all lock queries will report that the file in question
4820 is available for locking.
4821
4822 If locking = yes, real locking will be performed by the server.
4823
4824 This option may be useful for read-only filesystems which may not
4825 need locking (such as CDROM drives), although setting this
4826 parameter of no is not really recommended even in this case.
4827
4828 Be careful about disabling locking either globally or in a specific
4829 service, as lack of locking may result in data corruption. You
4830 should never need to set this parameter.
4831
4832 Default: locking = yes
4833
4834 lock spin time (G)
4835
4836 The time in milliseconds that smbd should keep waiting to see if a
4837 failed lock request can be granted. This parameter has changed in
4838 default value from Samba 3.0.23 from 10 to 200. The associated lock
4839 spin count parameter is no longer used in Samba 3.0.24. You should
4840 not need to change the value of this parameter.
4841
4842 Default: lock spin time = 200
4843
4844 log file (G)
4845
4846 This option allows you to override the name of the Samba log file
4847 (also known as the debug file).
4848
4849 This option takes the standard substitutions, allowing you to have
4850 separate log files for each user or machine.
4851
4852 No default
4853
4854 Example: log file = /usr/local/samba/var/log.%m
4855
4856 logging (G)
4857
4858 This parameter configures logging backends. Multiple backends can
4859 be specified at the same time, with different log levels for each
4860 backend. The parameter is a list of backends, where each backend is
4861 specified as backend[:option][@loglevel].
4862
4863 The 'option' parameter can be used to pass backend-specific
4864 options.
4865
4866 The log level for a backend is optional, if it is not set for a
4867 backend, all messages are sent to this backend. The parameter log
4868 level determines overall log levels, while the log levels specified
4869 here define what is sent to the individual backends.
4870
4871 When logging is set, it overrides the syslog and syslog only
4872 parameters.
4873
4874 Some backends are only available when Samba has been compiled with
4875 the additional libraries. The overall list of logging backends:
4876
4877 · syslog
4878
4879 · file
4880
4881 · systemd
4882
4883 · lttng
4884
4885 · gpfs
4886
4887 · ringbuf
4888
4889 The ringbuf backend supports an optional size argument to change
4890 the buffer size used, the default is 1 MB: ringbuf:size=NBYTES
4891
4892 Default: logging =
4893
4894 Example: logging = syslog@1 file
4895
4896 debuglevel
4897
4898 This parameter is a synonym for log level.
4899
4900 log level (G)
4901
4902 The value of the parameter (a string) allows the debug level
4903 (logging level) to be specified in the smb.conf file.
4904
4905 This parameter has been extended since the 2.2.x series, now it
4906 allows one to specify the debug level for multiple debug classes
4907 and distinct logfiles for debug classes. This is to give greater
4908 flexibility in the configuration of the system. The following debug
4909 classes are currently implemented:
4910
4911 · all
4912
4913 · tdb
4914
4915 · printdrivers
4916
4917 · lanman
4918
4919 · smb
4920
4921 · smb2
4922
4923 · smb2_credits
4924
4925 · rpc_parse
4926
4927 · rpc_srv
4928
4929 · rpc_cli
4930
4931 · passdb
4932
4933 · sam
4934
4935 · auth
4936
4937 · winbind
4938
4939 · vfs
4940
4941 · idmap
4942
4943 · quota
4944
4945 · acls
4946
4947 · locking
4948
4949 · msdfs
4950
4951 · dmapi
4952
4953 · registry
4954
4955 · scavenger
4956
4957 · dns
4958
4959 · ldb
4960
4961 · tevent
4962
4963 · auth_audit
4964
4965 · auth_json_audit
4966
4967 · kerberos
4968
4969 · dsdb_audit
4970
4971 · dsdb_json_audit
4972
4973 · dsdb_password_audit
4974
4975 · dsdb_password_json_audit
4976
4977 · dsdb_transaction_audit
4978
4979 · dsdb_transaction_json_audit
4980
4981 To configure the logging for specific classes to go into a
4982 different file then log file, you can append @PATH to the class, eg
4983 log level = 1 full_audit:1@/var/log/audit.log.
4984
4985 Authentication and authorization audit information is logged under
4986 the auth_audit, and if Samba was not compiled with --without-json,
4987 a JSON representation is logged under auth_json_audit.
4988
4989 Support is comprehensive for all authentication and authorisation
4990 of user accounts in the Samba Active Directory Domain Controller,
4991 as well as the implicit authentication in password changes. In the
4992 file server, NTLM authentication, SMB and RPC authorization is
4993 covered.
4994
4995 Log levels for auth_audit and auth_audit_json are:
4996
4997 · 2: Authentication Failure
4998
4999 · 3: Authentication Success
5000
5001 · 4: Authorization Success
5002
5003 · 5: Anonymous Authentication and Authorization Success
5004
5005 Changes to the sam.ldb database are logged under the dsdb_audit and
5006 a JSON representation is logged under dsdb_json_audit.
5007
5008 Password changes and Password resets are logged under
5009 dsdb_password_audit and a JSON representation is logged under the
5010 dsdb_password_json_audit.
5011
5012 Transaction rollbacks and prepare commit failures are logged under
5013 the dsdb_transaction_audit and a JSON representation is logged
5014 under the password_json_audit. Logging the transaction details
5015 allows the identification of password and sam.ldb operations that
5016 have been rolled back.
5017
5018 Default: log level = 0
5019
5020 Example: log level = 3 passdb:5 auth:10 winbind:2
5021
5022 Example: log level = 1 full_audit:1@/var/log/audit.log winbind:2
5023
5024 log nt token command (G)
5025
5026 This option can be set to a command that will be called when new nt
5027 tokens are created.
5028
5029 This is only useful for development purposes.
5030
5031 Default: log nt token command =
5032
5033 logon drive (G)
5034
5035 This parameter specifies the local path to which the home directory
5036 will be connected (see logon home) and is only used by NT
5037 Workstations.
5038
5039 Note that this option is only useful if Samba is set up as a logon
5040 server.
5041
5042 Default: logon drive =
5043
5044 Example: logon drive = h:
5045
5046 logon home (G)
5047
5048 This parameter specifies the home directory location when a
5049 Win95/98 or NT Workstation logs into a Samba PDC. It allows you to
5050 do
5051
5052 C:\>NET USE H: /HOME
5053
5054 from a command prompt, for example.
5055
5056 This option takes the standard substitutions, allowing you to have
5057 separate logon scripts for each user or machine.
5058
5059 This parameter can be used with Win9X workstations to ensure that
5060 roaming profiles are stored in a subdirectory of the user's home
5061 directory. This is done in the following way:
5062
5063 logon home = \\%N\%U\profile
5064
5065 This tells Samba to return the above string, with substitutions
5066 made when a client requests the info, generally in a NetUserGetInfo
5067 request. Win9X clients truncate the info to \\server\share when a
5068 user does net use /home but use the whole string when dealing with
5069 profiles.
5070
5071 Note that in prior versions of Samba, the logon path was returned
5072 rather than logon home. This broke net use /home but allowed
5073 profiles outside the home directory. The current implementation is
5074 correct, and can be used for profiles if you use the above trick.
5075
5076 Disable this feature by setting logon home = "" - using the empty
5077 string.
5078
5079 This option is only useful if Samba is set up as a logon server.
5080
5081 Default: logon home = \\%N\%U
5082
5083 Example: logon home = \\remote_smb_server\%U
5084
5085 logon path (G)
5086
5087 This parameter specifies the directory where roaming profiles
5088 (Desktop, NTuser.dat, etc) are stored. Contrary to previous
5089 versions of these manual pages, it has nothing to do with Win 9X
5090 roaming profiles. To find out how to handle roaming profiles for
5091 Win 9X system, see the logon home parameter.
5092
5093 This option takes the standard substitutions, allowing you to have
5094 separate logon scripts for each user or machine. It also specifies
5095 the directory from which the "Application Data", desktop, start
5096 menu, network neighborhood, programs and other folders, and their
5097 contents, are loaded and displayed on your Windows NT client.
5098
5099 The share and the path must be readable by the user for the
5100 preferences and directories to be loaded onto the Windows NT
5101 client. The share must be writeable when the user logs in for the
5102 first time, in order that the Windows NT client can create the
5103 NTuser.dat and other directories. Thereafter, the directories and
5104 any of the contents can, if required, be made read-only. It is not
5105 advisable that the NTuser.dat file be made read-only - rename it to
5106 NTuser.man to achieve the desired effect (a MANdatory profile).
5107
5108 Windows clients can sometimes maintain a connection to the [homes]
5109 share, even though there is no user logged in. Therefore, it is
5110 vital that the logon path does not include a reference to the homes
5111 share (i.e. setting this parameter to \\%N\homes\profile_path will
5112 cause problems).
5113
5114 This option takes the standard substitutions, allowing you to have
5115 separate logon scripts for each user or machine.
5116
5117 Warning
5118 Do not quote the value. Setting this as “\\%N\profile\%U” will
5119 break profile handling. Where the tdbsam or ldapsam passdb
5120 backend is used, at the time the user account is created the
5121 value configured for this parameter is written to the passdb
5122 backend and that value will over-ride the parameter value
5123 present in the smb.conf file. Any error present in the passdb
5124 backend account record must be editted using the appropriate
5125 tool (pdbedit on the command-line, or any other locally
5126 provided system tool).
5127 Note that this option is only useful if Samba is set up as a domain
5128 controller.
5129
5130 Disable the use of roaming profiles by setting the value of this
5131 parameter to the empty string. For example, logon path = "". Take
5132 note that even if the default setting in the smb.conf file is the
5133 empty string, any value specified in the user account settings in
5134 the passdb backend will over-ride the effect of setting this
5135 parameter to null. Disabling of all roaming profile use requires
5136 that the user account settings must also be blank.
5137
5138 An example of use is:
5139
5140 logon path = \\PROFILESERVER\PROFILE\%U
5141
5142 Default: logon path = \\%N\%U\profile
5143
5144 logon script (G)
5145
5146 This parameter specifies the batch file (.bat) or NT command file
5147 (.cmd) to be downloaded and run on a machine when a user
5148 successfully logs in. The file must contain the DOS style CR/LF
5149 line endings. Using a DOS-style editor to create the file is
5150 recommended.
5151
5152 The script must be a relative path to the [netlogon] service. If
5153 the [netlogon] service specifies a path of
5154 /usr/local/samba/netlogon, and logon script = STARTUP.BAT, then the
5155 file that will be downloaded is:
5156
5157 /usr/local/samba/netlogon/STARTUP.BAT
5158
5159 The contents of the batch file are entirely your choice. A
5160 suggested command would be to add NET TIME \\SERVER /SET /YES, to
5161 force every machine to synchronize clocks with the same time
5162 server. Another use would be to add NET USE U: \\SERVER\UTILS for
5163 commonly used utilities, or
5164
5165 NET USE Q: \\SERVER\ISO9001_QA
5166
5167 for example.
5168
5169 Note that it is particularly important not to allow write access to
5170 the [netlogon] share, or to grant users write permission on the
5171 batch files in a secure environment, as this would allow the batch
5172 files to be arbitrarily modified and security to be breached.
5173
5174 This option takes the standard substitutions, allowing you to have
5175 separate logon scripts for each user or machine.
5176
5177 This option is only useful if Samba is set up as a logon server in
5178 a classic domain controller role. If Samba is set up as an Active
5179 Directory domain controller, LDAP attribute scriptPath is used
5180 instead. For configurations where passdb backend = ldapsam is in
5181 use, this option only defines a default value in case LDAP
5182 attribute sambaLogonScript is missing.
5183
5184 Default: logon script =
5185
5186 Example: logon script = scripts\%U.bat
5187
5188 log writeable files on exit (G)
5189
5190 When the network connection between a CIFS client and Samba dies,
5191 Samba has no option but to simply shut down the server side of the
5192 network connection. If this happens, there is a risk of data
5193 corruption because the Windows client did not complete all write
5194 operations that the Windows application requested. Setting this
5195 option to "yes" makes smbd log with a level 0 message a list of all
5196 files that have been opened for writing when the network connection
5197 died. Those are the files that are potentially corrupted. It is
5198 meant as an aid for the administrator to give him a list of files
5199 to do consistency checks on.
5200
5201 Default: log writeable files on exit = no
5202
5203 lppause command (S)
5204
5205 This parameter specifies the command to be executed on the server
5206 host in order to stop printing or spooling a specific print job.
5207
5208 This command should be a program or script which takes a printer
5209 name and job number to pause the print job. One way of implementing
5210 this is by using job priorities, where jobs having a too low
5211 priority won't be sent to the printer.
5212
5213 If a %p is given then the printer name is put in its place. A %j is
5214 replaced with the job number (an integer). On HPUX (see
5215 printing=hpux ), if the -p%p option is added to the lpq command,
5216 the job will show up with the correct status, i.e. if the job
5217 priority is lower than the set fence priority it will have the
5218 PAUSED status, whereas if the priority is equal or higher it will
5219 have the SPOOLED or PRINTING status.
5220
5221 Note that it is good practice to include the absolute path in the
5222 lppause command as the PATH may not be available to the server.
5223
5224 Currently no default value is given to this string, unless the
5225 value of the printing parameter is SYSV, in which case the default
5226 is : lp -i %p-%j -H hold or if the value of the printing parameter
5227 is SOFTQ, then the default is: qstat -s -j%j -h.
5228
5229 Default: lppause command = # determined by printing parameter
5230
5231 Example: lppause command = /usr/bin/lpalt %p-%j -p0
5232
5233 lpq cache time (G)
5234
5235 This controls how long lpq info will be cached for to prevent the
5236 lpq command being called too often. A separate cache is kept for
5237 each variation of the lpq command used by the system, so if you use
5238 different lpq commands for different users then they won't share
5239 cache information.
5240
5241 The cache files are stored in /tmp/lpq.xxxx where xxxx is a hash of
5242 the lpq command in use.
5243
5244 The default is 30 seconds, meaning that the cached results of a
5245 previous identical lpq command will be used if the cached data is
5246 less than 30 seconds old. A large value may be advisable if your
5247 lpq command is very slow.
5248
5249 A value of 0 will disable caching completely.
5250
5251 Default: lpq cache time = 30
5252
5253 Example: lpq cache time = 10
5254
5255 lpq command (S)
5256
5257 This parameter specifies the command to be executed on the server
5258 host in order to obtain lpq-style printer status information.
5259
5260 This command should be a program or script which takes a printer
5261 name as its only parameter and outputs printer status information.
5262
5263 Currently nine styles of printer status information are supported;
5264 BSD, AIX, LPRNG, PLP, SYSV, HPUX, QNX, CUPS, and SOFTQ. This covers
5265 most UNIX systems. You control which type is expected using the
5266 printing = option.
5267
5268 Some clients (notably Windows for Workgroups) may not correctly
5269 send the connection number for the printer they are requesting
5270 status information about. To get around this, the server reports on
5271 the first printer service connected to by the client. This only
5272 happens if the connection number sent is invalid.
5273
5274 If a %p is given then the printer name is put in its place.
5275 Otherwise it is placed at the end of the command.
5276
5277 Note that it is good practice to include the absolute path in the
5278 lpq command as the $PATH may not be available to the server. When
5279 compiled with the CUPS libraries, no lpq command is needed because
5280 smbd will make a library call to obtain the print queue listing.
5281
5282 Default: lpq command = # determined by printing parameter
5283
5284 Example: lpq command = /usr/bin/lpq -P%p
5285
5286 lpresume command (S)
5287
5288 This parameter specifies the command to be executed on the server
5289 host in order to restart or continue printing or spooling a
5290 specific print job.
5291
5292 This command should be a program or script which takes a printer
5293 name and job number to resume the print job. See also the lppause
5294 command parameter.
5295
5296 If a %p is given then the printer name is put in its place. A %j is
5297 replaced with the job number (an integer).
5298
5299 Note that it is good practice to include the absolute path in the
5300 lpresume command as the PATH may not be available to the server.
5301
5302 See also the printing parameter.
5303
5304 Default: Currently no default value is given to this string, unless
5305 the value of the printing parameter is SYSV, in which case the
5306 default is:
5307
5308 lp -i %p-%j -H resume
5309
5310 or if the value of the printing parameter is SOFTQ, then the
5311 default is:
5312
5313 qstat -s -j%j -r
5314
5315 Default: lpresume command = # determined by printing parameter
5316
5317 Example: lpresume command = /usr/bin/lpalt %p-%j -p2
5318
5319 lprm command (S)
5320
5321 This parameter specifies the command to be executed on the server
5322 host in order to delete a print job.
5323
5324 This command should be a program or script which takes a printer
5325 name and job number, and deletes the print job.
5326
5327 If a %p is given then the printer name is put in its place. A %j is
5328 replaced with the job number (an integer).
5329
5330 Note that it is good practice to include the absolute path in the
5331 lprm command as the PATH may not be available to the server.
5332
5333 Examples of use are:
5334
5335 lprm command = /usr/bin/lprm -P%p %j
5336
5337 or
5338
5339 lprm command = /usr/bin/cancel %p-%j
5340
5341 Default: lprm command = # determined by printing parameter
5342
5343 lsa over netlogon (G)
5344
5345 Setting this deprecated option will allow the RPC server in the AD
5346 DC to answer the LSARPC interface on the \pipe\netlogon IPC pipe.
5347
5348 When enabled, this matches the behaviour of Microsoft's Windows,
5349 due to their internal implementation choices.
5350
5351 If it is disabled (the default), the AD DC can offer improved
5352 performance, as the netlogon server is decoupled and can run as
5353 multiple processes.
5354
5355 Default: lsa over netlogon = no
5356
5357 machine password timeout (G)
5358
5359 If a Samba server is a member of a Windows NT or Active Directory
5360 Domain (see the security = domain and security = ads parameters),
5361 then periodically a running winbindd process will try and change
5362 the MACHINE ACCOUNT PASSWORD stored in the TDB called secrets.tdb.
5363 This parameter specifies how often this password will be changed,
5364 in seconds. The default is one week (expressed in seconds), the
5365 same as a Windows NT Domain member server.
5366
5367 See also smbpasswd(8), and the security = domain and security = ads
5368 parameters.
5369
5370 Default: machine password timeout = 604800
5371
5372 magic output (S)
5373
5374 This parameter specifies the name of a file which will contain
5375 output created by a magic script (see the magic script parameter
5376 below).
5377
5378 Warning
5379 If two clients use the same magic script in the same directory
5380 the output file content is undefined.
5381 Default: magic output = # <magic script name>.out
5382
5383 Example: magic output = myfile.txt
5384
5385 magic script (S)
5386
5387 This parameter specifies the name of a file which, if opened, will
5388 be executed by the server when the file is closed. This allows a
5389 UNIX script to be sent to the Samba host and executed on behalf of
5390 the connected user.
5391
5392 Scripts executed in this way will be deleted upon completion
5393 assuming that the user has the appropriate level of privilege and
5394 the file permissions allow the deletion.
5395
5396 If the script generates output, output will be sent to the file
5397 specified by the magic output parameter (see above).
5398
5399 Note that some shells are unable to interpret scripts containing
5400 CR/LF instead of CR as the end-of-line marker. Magic scripts must
5401 be executable as is on the host, which for some hosts and some
5402 shells will require filtering at the DOS end.
5403
5404 Magic scripts are EXPERIMENTAL and should NOT be relied upon.
5405
5406 Default: magic script =
5407
5408 Example: magic script = user.csh
5409
5410 mangled names (S)
5411
5412 This controls whether non-DOS names under UNIX should be mapped to
5413 DOS-compatible names ("mangled") and made visible, or whether
5414 non-DOS names should simply be ignored.
5415
5416 See the section on name mangling for details on how to control the
5417 mangling process.
5418
5419 Possible option settings are
5420
5421 · yes - enables name mangling for all not DOS 8.3
5422 conforming names.
5423
5424 · no - disables any name mangling.
5425
5426 · illegal (default) - does mangling for names with illegal
5427 NTFS characters. This is the most sensible setting for
5428 modern clients that don't use the shortname anymore.
5429
5430 If mangling is used then the mangling method is as follows:
5431
5432 · The first (up to) five alphanumeric characters before
5433 the rightmost dot of the filename are preserved, forced
5434 to upper case, and appear as the first (up to) five
5435 characters of the mangled name.
5436
5437 · A tilde "~" is appended to the first part of the mangled
5438 name, followed by a two-character unique sequence, based
5439 on the original root name (i.e., the original filename
5440 minus its final extension). The final extension is
5441 included in the hash calculation only if it contains any
5442 upper case characters or is longer than three
5443 characters.
5444
5445 Note that the character to use may be specified using
5446 the mangling char option, if you don't like '~'.
5447
5448 · Files whose UNIX name begins with a dot will be
5449 presented as DOS hidden files. The mangled name will be
5450 created as for other filenames, but with the leading dot
5451 removed and "___" as its extension regardless of actual
5452 original extension (that's three underscores).
5453
5454 The two-digit hash value consists of upper case alphanumeric
5455 characters.
5456
5457 This algorithm can cause name collisions only if files in a
5458 directory share the same first five alphanumeric characters. The
5459 probability of such a clash is 1/1300.
5460
5461 The name mangling (if enabled) allows a file to be copied between
5462 UNIX directories from Windows/DOS while retaining the long UNIX
5463 filename. UNIX files can be renamed to a new extension from
5464 Windows/DOS and will retain the same basename. Mangled names do not
5465 change between sessions.
5466
5467 Default: mangled names = illegal
5468
5469 Example: mangled names = no
5470
5471 mangle prefix (G)
5472
5473 controls the number of prefix characters from the original name
5474 used when generating the mangled names. A larger value will give a
5475 weaker hash and therefore more name collisions. The minimum value
5476 is 1 and the maximum value is 6.
5477
5478 mangle prefix is effective only when mangling method is hash2.
5479
5480 Default: mangle prefix = 1
5481
5482 Example: mangle prefix = 4
5483
5484 mangling char (S)
5485
5486 This controls what character is used as the magic character in name
5487 mangling. The default is a '~' but this may interfere with some
5488 software. Use this option to set it to whatever you prefer. This is
5489 effective only when mangling method is hash.
5490
5491 Default: mangling char = ~
5492
5493 Example: mangling char = ^
5494
5495 mangling method (G)
5496
5497 controls the algorithm used for the generating the mangled names.
5498 Can take two different values, "hash" and "hash2". "hash" is the
5499 algorithm that was used in Samba for many years and was the default
5500 in Samba 2.2.x "hash2" is now the default and is newer and
5501 considered a better algorithm (generates less collisions) in the
5502 names. Many Win32 applications store the mangled names and so
5503 changing to algorithms must not be done lightly as these
5504 applications may break unless reinstalled.
5505
5506 Default: mangling method = hash2
5507
5508 Example: mangling method = hash
5509
5510 map acl inherit (S)
5511
5512 This boolean parameter controls whether smbd(8) will attempt to map
5513 the 'inherit' and 'protected' access control entry flags stored in
5514 Windows ACLs into an extended attribute called user.SAMBA_PAI
5515 (POSIX ACL Inheritance). This parameter requires supports for
5516 extended attributes on the filesystem and allows the Windows ACL
5517 editor to store inheritance information while NT ACLs are mapped
5518 best-effort to the POSIX ACLs.
5519
5520 Default: map acl inherit = no
5521
5522 map archive (S)
5523
5524 This controls whether the DOS archive attribute should be mapped to
5525 the UNIX owner execute bit. The DOS archive bit is set when a file
5526 has been modified since its last backup. One motivation for this
5527 option is to keep Samba/your PC from making any file it touches
5528 from becoming executable under UNIX. This can be quite annoying for
5529 shared source code, documents, etc...
5530
5531 Note that this parameter will be ignored if the store dos
5532 attributes parameter is set, as the DOS archive attribute will then
5533 be stored inside a UNIX extended attribute.
5534
5535 Note that this requires the create mask parameter to be set such
5536 that owner execute bit is not masked out (i.e. it must include
5537 100). See the parameter create mask for details.
5538
5539 Default: map archive = yes
5540
5541 map hidden (S)
5542
5543 This controls whether DOS style hidden files should be mapped to
5544 the UNIX world execute bit.
5545
5546 Note that this parameter will be ignored if the store dos
5547 attributes parameter is set, as the DOS hidden attribute will then
5548 be stored inside a UNIX extended attribute.
5549
5550 Note that this requires the create mask to be set such that the
5551 world execute bit is not masked out (i.e. it must include 001). See
5552 the parameter create mask for details.
5553
5554 Default: map hidden = no
5555
5556 map readonly (S)
5557
5558 This controls how the DOS read only attribute should be mapped from
5559 a UNIX filesystem.
5560
5561 This parameter can take three different values, which tell smbd(8)
5562 how to display the read only attribute on files, where either store
5563 dos attributes is set to No, or no extended attribute is present.
5564 If store dos attributes is set to yes then this parameter is
5565 ignored. This is a new parameter introduced in Samba version
5566 3.0.21.
5567
5568 The three settings are :
5569
5570 · Yes - The read only DOS attribute is mapped to the
5571 inverse of the user or owner write bit in the unix
5572 permission mode set. If the owner write bit is not set,
5573 the read only attribute is reported as being set on the
5574 file. If the read only DOS attribute is set, Samba sets
5575 the owner, group and others write bits to zero. Write
5576 bits set in an ACL are ignored by Samba. If the read
5577 only DOS attribute is unset, Samba simply sets the write
5578 bit of the owner to one.
5579
5580 · Permissions - The read only DOS attribute is mapped to
5581 the effective permissions of the connecting user, as
5582 evaluated by smbd(8) by reading the unix permissions and
5583 POSIX ACL (if present). If the connecting user does not
5584 have permission to modify the file, the read only
5585 attribute is reported as being set on the file.
5586
5587 · No - The read only DOS attribute is unaffected by
5588 permissions, and can only be set by the store dos
5589 attributes method. This may be useful for exporting
5590 mounted CDs.
5591
5592 Note that this parameter will be ignored if the store dos
5593 attributes parameter is set, as the DOS 'read-only' attribute will
5594 then be stored inside a UNIX extended attribute.
5595
5596 The default has changed to no in Samba release 4.9.0 and above to
5597 allow better Windows fileserver compatibility in a default install.
5598 In addition the default setting of store dos attributes has been
5599 changed to Yes in Samba release 4.9.0 and above.
5600
5601 Default: map readonly = no
5602
5603 map system (S)
5604
5605 This controls whether DOS style system files should be mapped to
5606 the UNIX group execute bit.
5607
5608 Note that this parameter will be ignored if the store dos
5609 attributes parameter is set, as the DOS system attribute will then
5610 be stored inside a UNIX extended attribute.
5611
5612 Note that this requires the create mask to be set such that the
5613 group execute bit is not masked out (i.e. it must include 010). See
5614 the parameter create mask for details.
5615
5616 Default: map system = no
5617
5618 map to guest (G)
5619
5620 This parameter can take four different values, which tell smbd(8)
5621 what to do with user login requests that don't match a valid UNIX
5622 user in some way.
5623
5624 The four settings are :
5625
5626 · Never - Means user login requests with an invalid
5627 password are rejected. This is the default.
5628
5629 · Bad User - Means user logins with an invalid password
5630 are rejected, unless the username does not exist, in
5631 which case it is treated as a guest login and mapped
5632 into the guest account.
5633
5634 · Bad Password - Means user logins with an invalid
5635 password are treated as a guest login and mapped into
5636 the guest account. Note that this can cause problems as
5637 it means that any user incorrectly typing their password
5638 will be silently logged on as "guest" - and will not
5639 know the reason they cannot access files they think they
5640 should - there will have been no message given to them
5641 that they got their password wrong. Helpdesk services
5642 will hate you if you set the map to guest parameter this
5643 way :-).
5644
5645 · Bad Uid - Is only applicable when Samba is configured in
5646 some type of domain mode security (security =
5647 {domain|ads}) and means that user logins which are
5648 successfully authenticated but which have no valid Unix
5649 user account (and smbd is unable to create one) should
5650 be mapped to the defined guest account. This was the
5651 default behavior of Samba 2.x releases. Note that if a
5652 member server is running winbindd, this option should
5653 never be required because the nss_winbind library will
5654 export the Windows domain users and groups to the
5655 underlying OS via the Name Service Switch interface.
5656
5657 Note that this parameter is needed to set up "Guest" share
5658 services. This is because in these modes the name of the resource
5659 being requested is not sent to the server until after the server
5660 has successfully authenticated the client so the server cannot make
5661 authentication decisions at the correct time (connection to the
5662 share) for "Guest" shares.
5663
5664 Default: map to guest = Never
5665
5666 Example: map to guest = Bad User
5667
5668 max connections (S)
5669
5670 This option allows the number of simultaneous connections to a
5671 service to be limited. If max connections is greater than 0 then
5672 connections will be refused if this number of connections to the
5673 service are already open. A value of zero mean an unlimited number
5674 of connections may be made.
5675
5676 Record lock files are used to implement this feature. The lock
5677 files will be stored in the directory specified by the lock
5678 directory option.
5679
5680 Default: max connections = 0
5681
5682 Example: max connections = 10
5683
5684 max disk size (G)
5685
5686 This option allows you to put an upper limit on the apparent size
5687 of disks. If you set this option to 100 then all shares will appear
5688 to be not larger than 100 MB in size.
5689
5690 Note that this option does not limit the amount of data you can put
5691 on the disk. In the above case you could still store much more than
5692 100 MB on the disk, but if a client ever asks for the amount of
5693 free disk space or the total disk size then the result will be
5694 bounded by the amount specified in max disk size.
5695
5696 This option is primarily useful to work around bugs in some pieces
5697 of software that can't handle very large disks, particularly disks
5698 over 1GB in size.
5699
5700 A max disk size of 0 means no limit.
5701
5702 Default: max disk size = 0
5703
5704 Example: max disk size = 1000
5705
5706 max log size (G)
5707
5708 This option (an integer in kilobytes) specifies the max size the
5709 log file should grow to. Samba periodically checks the size and if
5710 it is exceeded it will rename the file, adding a .old extension.
5711
5712 A size of 0 means no limit.
5713
5714 Default: max log size = 5000
5715
5716 Example: max log size = 1000
5717
5718 max mux (G)
5719
5720 This option controls the maximum number of outstanding simultaneous
5721 SMB operations that Samba tells the client it will allow. You
5722 should never need to set this parameter.
5723
5724 Default: max mux = 50
5725
5726 max open files (G)
5727
5728 This parameter limits the maximum number of open files that one
5729 smbd(8) file serving process may have open for a client at any one
5730 time. This parameter can be set very high (16384) as Samba uses
5731 only one bit per unopened file. Setting this parameter lower than
5732 16384 will cause Samba to complain and set this value back to the
5733 minimum of 16384, as Windows 7 depends on this number of open file
5734 handles being available.
5735
5736 The limit of the number of open files is usually set by the UNIX
5737 per-process file descriptor limit rather than this parameter so you
5738 should never need to touch this parameter.
5739
5740 Default: max open files = 16384
5741
5742 max print jobs (S)
5743
5744 This parameter limits the maximum number of jobs allowable in a
5745 Samba printer queue at any given moment. If this number is
5746 exceeded, smbd(8) will remote "Out of Space" to the client.
5747
5748 Default: max print jobs = 1000
5749
5750 Example: max print jobs = 5000
5751
5752 max reported print jobs (S)
5753
5754 This parameter limits the maximum number of jobs displayed in a
5755 port monitor for Samba printer queue at any given moment. If this
5756 number is exceeded, the excess jobs will not be shown. A value of
5757 zero means there is no limit on the number of print jobs reported.
5758
5759 Default: max reported print jobs = 0
5760
5761 Example: max reported print jobs = 1000
5762
5763 max smbd processes (G)
5764
5765 This parameter limits the maximum number of smbd(8) processes
5766 concurrently running on a system and is intended as a stopgap to
5767 prevent degrading service to clients in the event that the server
5768 has insufficient resources to handle more than this number of
5769 connections. Remember that under normal operating conditions, each
5770 user will have an smbd(8) associated with him or her to handle
5771 connections to all shares from a given host.
5772
5773 For a Samba ADDC running the standard process model this option
5774 limits the number of processes forked to handle requests. Currently
5775 new processes are only forked for ldap and netlogon requests.
5776
5777 Default: max smbd processes = 0
5778
5779 Example: max smbd processes = 1000
5780
5781 max stat cache size (G)
5782
5783 This parameter limits the size in memory of any stat cache being
5784 used to speed up case insensitive name mappings. It represents the
5785 number of kilobyte (1024) units the stat cache can use. A value of
5786 zero, meaning unlimited, is not advisable due to increased memory
5787 usage. You should not need to change this parameter.
5788
5789 Default: max stat cache size = 512
5790
5791 Example: max stat cache size = 100
5792
5793 max ttl (G)
5794
5795 This option tells nmbd(8) what the default 'time to live' of
5796 NetBIOS names should be (in seconds) when nmbd is requesting a name
5797 using either a broadcast packet or from a WINS server. You should
5798 never need to change this parameter. The default is 3 days.
5799
5800 Default: max ttl = 259200
5801
5802 max wins ttl (G)
5803
5804 This option tells smbd(8) when acting as a WINS server (wins
5805 support = yes) what the maximum 'time to live' of NetBIOS names
5806 that nmbd will grant will be (in seconds). You should never need to
5807 change this parameter. The default is 6 days (518400 seconds).
5808
5809 Default: max wins ttl = 518400
5810
5811 max xmit (G)
5812
5813 This option controls the maximum packet size that will be
5814 negotiated by Samba's smbd(8) for the SMB1 protocol. The default is
5815 16644, which matches the behavior of Windows 2000. A value below
5816 2048 is likely to cause problems. You should never need to change
5817 this parameter from its default value.
5818
5819 Default: max xmit = 16644
5820
5821 Example: max xmit = 8192
5822
5823 mdns name (G)
5824
5825 This parameter controls the name that multicast DNS support
5826 advertises as its' hostname.
5827
5828 The default is to use the NETBIOS name which is typically the
5829 hostname in all capital letters.
5830
5831 A setting of mdns will defer the hostname configuration to the MDNS
5832 library that is used.
5833
5834 Default: mdns name = netbios
5835
5836 message command (G)
5837
5838 This specifies what command to run when the server receives a
5839 WinPopup style message.
5840
5841 This would normally be a command that would deliver the message
5842 somehow. How this is to be done is up to your imagination.
5843
5844 An example is:
5845
5846 message command = csh -c 'xedit %s;rm %s' &
5847
5848 This delivers the message using xedit, then removes it afterwards.
5849 NOTE THAT IT IS VERY IMPORTANT THAT THIS COMMAND RETURN
5850 IMMEDIATELY. That's why I have the '&' on the end. If it doesn't
5851 return immediately then your PCs may freeze when sending messages
5852 (they should recover after 30 seconds, hopefully).
5853
5854 All messages are delivered as the global guest user. The command
5855 takes the standard substitutions, although
5856 %u won't work (%U may be better in this case).
5857
5858 Apart from the standard substitutions, some additional ones apply.
5859 In particular:
5860
5861 · %s = the filename containing the message.
5862
5863 · %t = the destination that the message was sent to
5864 (probably the server name).
5865
5866 · %f = who the message is from.
5867
5868 You could make this command send mail, or whatever else takes your
5869 fancy. Please let us know of any really interesting ideas you have.
5870
5871 Here's a way of sending the messages as mail to root:
5872
5873 message command = /bin/mail -s 'message from %f on %m' root < %s; rm %s
5874
5875 If you don't have a message command then the message won't be
5876 delivered and Samba will tell the sender there was an error.
5877 Unfortunately WfWg totally ignores the error code and carries on
5878 regardless, saying that the message was delivered.
5879
5880 If you want to silently delete it then try:
5881
5882 message command = rm %s
5883
5884 Default: message command =
5885
5886 Example: message command = csh -c 'xedit %s; rm %s' &
5887
5888 min print space (S)
5889
5890 This sets the minimum amount of free disk space that must be
5891 available before a user will be able to spool a print job. It is
5892 specified in kilobytes. The default is 0, which means a user can
5893 always spool a print job.
5894
5895 Default: min print space = 0
5896
5897 Example: min print space = 2000
5898
5899 min receivefile size (G)
5900
5901 This option changes the behavior of smbd(8) when processing
5902 SMBwriteX calls. Any incoming SMBwriteX call on a non-signed
5903 SMB/CIFS connection greater than this value will not be processed
5904 in the normal way but will be passed to any underlying kernel
5905 recvfile or splice system call (if there is no such call Samba will
5906 emulate in user space). This allows zero-copy writes directly from
5907 network socket buffers into the filesystem buffer cache, if
5908 available. It may improve performance but user testing is
5909 recommended. If set to zero Samba processes SMBwriteX calls in the
5910 normal way. To enable POSIX large write support (SMB/CIFS writes up
5911 to 16Mb) this option must be nonzero. The maximum value is 128k.
5912 Values greater than 128k will be silently set to 128k.
5913
5914 Note this option will have NO EFFECT if set on a SMB signed
5915 connection.
5916
5917 The default is zero, which disables this option.
5918
5919 Default: min receivefile size = 0
5920
5921 min wins ttl (G)
5922
5923 This option tells nmbd(8) when acting as a WINS server (wins
5924 support = yes) what the minimum 'time to live' of NetBIOS names
5925 that nmbd will grant will be (in seconds). You should never need to
5926 change this parameter. The default is 6 hours (21600 seconds).
5927
5928 Default: min wins ttl = 21600
5929
5930 mit kdc command (G)
5931
5932 This option specifies the path to the MIT kdc binary.
5933
5934 If the KDC is not installed in the default location and wasn't
5935 correctly detected during build then you should modify this
5936 variable and point it to the correct binary.
5937
5938 Default: mit kdc command = /usr/sbin/krb5kdc
5939
5940 Example: mit kdc command = /opt/mit/sbin/krb5kdc
5941
5942 msdfs proxy (S)
5943
5944 This parameter indicates that the share is a stand-in for another
5945 CIFS share whose location is specified by the value of the
5946 parameter. When clients attempt to connect to this share, they are
5947 redirected to one or multiple, comma separated proxied shares using
5948 the SMB-Dfs protocol.
5949
5950 Only Dfs roots can act as proxy shares. Take a look at the msdfs
5951 root and host msdfs options to find out how to set up a Dfs root
5952 share.
5953
5954 No default
5955
5956 Example: msdfs proxy =
5957 \otherserver\someshare,\otherserver2\someshare
5958
5959 msdfs root (S)
5960
5961 If set to yes, Samba treats the share as a Dfs root and allows
5962 clients to browse the distributed file system tree rooted at the
5963 share directory. Dfs links are specified in the share directory by
5964 symbolic links of the form msdfs:serverA\\shareA,serverB\\shareB
5965 and so on. For more information on setting up a Dfs tree on Samba,
5966 refer to the MSDFS chapter in the Samba3-HOWTO book.
5967
5968 Default: msdfs root = no
5969
5970 msdfs shuffle referrals (S)
5971
5972 If set to yes, Samba will shuffle Dfs referrals for a given Dfs
5973 link if multiple are available, allowing for load balancing across
5974 clients. For more information on setting up a Dfs tree on Samba,
5975 refer to the MSDFS chapter in the Samba3-HOWTO book.
5976
5977 Default: msdfs shuffle referrals = no
5978
5979 multicast dns register (G)
5980
5981 If compiled with proper support for it, Samba will announce itself
5982 with multicast DNS services like for example provided by the Avahi
5983 daemon.
5984
5985 This parameter allows disabling Samba to register itself.
5986
5987 Default: multicast dns register = yes
5988
5989 name cache timeout (G)
5990
5991 Specifies the number of seconds it takes before entries in samba's
5992 hostname resolve cache time out. If the timeout is set to 0. the
5993 caching is disabled.
5994
5995 Default: name cache timeout = 660
5996
5997 Example: name cache timeout = 0
5998
5999 name resolve order (G)
6000
6001 This option is used by the programs in the Samba suite to determine
6002 what naming services to use and in what order to resolve host names
6003 to IP addresses. Its main purpose to is to control how netbios name
6004 resolution is performed. The option takes a space separated string
6005 of name resolution options.
6006
6007 The options are: "lmhosts", "host", "wins" and "bcast". They cause
6008 names to be resolved as follows:
6009
6010 · lmhosts : Lookup an IP address in the Samba lmhosts
6011 file. If the line in lmhosts has no name type attached
6012 to the NetBIOS name (see the manpage for lmhosts for
6013 details) then any name type matches for lookup.
6014
6015 · host : Do a standard host name to IP address resolution,
6016 using the system /etc/hosts, NIS, or DNS lookups. This
6017 method of name resolution is operating system depended
6018 for instance on IRIX or Solaris this may be controlled
6019 by the /etc/nsswitch.conf file. Note that this method is
6020 used only if the NetBIOS name type being queried is the
6021 0x20 (server) name type or 0x1c (domain controllers).
6022 The latter case is only useful for active directory
6023 domains and results in a DNS query for the SRV RR entry
6024 matching _ldap._tcp.domain.
6025
6026 · wins : Query a name with the IP address listed in the
6027 WINSSERVER parameter. If no WINS server has been
6028 specified this method will be ignored.
6029
6030 · bcast : Do a broadcast on each of the known local
6031 interfaces listed in the interfaces parameter. This is
6032 the least reliable of the name resolution methods as it
6033 depends on the target host being on a locally connected
6034 subnet.
6035
6036 The example below will cause the local lmhosts file to be examined
6037 first, followed by a broadcast attempt, followed by a normal system
6038 hostname lookup.
6039
6040 When Samba is functioning in ADS security mode (security = ads) it
6041 is advised to use following settings for name resolve order:
6042
6043 name resolve order = wins bcast
6044
6045 DC lookups will still be done via DNS, but fallbacks to netbios
6046 names will not inundate your DNS servers with needless queries for
6047 DOMAIN<0x1c> lookups.
6048
6049 Default: name resolve order = lmhosts wins host bcast
6050
6051 Example: name resolve order = lmhosts bcast host
6052
6053 socket address
6054
6055 This parameter is a synonym for nbt client socket address.
6056
6057 nbt client socket address (G)
6058
6059 This option allows you to control what address Samba will send NBT
6060 client packets from, and process replies using, including in nmbd.
6061
6062 Setting this option should never be necessary on usual Samba
6063 servers running only one nmbd.
6064
6065 By default Samba will send UDP packets from the OS default address
6066 for the destination, and accept replies on 0.0.0.0.
6067
6068 This parameter is deprecated. See bind interfaces only = Yes and
6069 interfaces for the previous behaviour of controlling the normal
6070 listening sockets.
6071
6072 Default: nbt client socket address = 0.0.0.0
6073
6074 Example: nbt client socket address = 192.168.2.20
6075
6076 nbtd:wins_prepend1Bto1Cqueries (G)
6077
6078 Normally queries for 0x1C names (all logon servers for a domain)
6079 will return the first address of the 0x1B names (domain master
6080 browser and PDC) as first address in the result list. As many
6081 client only use the first address in the list by default, all
6082 clients will use the same server (the PDC). Windows servers have an
6083 option to disable this behavior (since Windows 2000 Service Pack
6084 2).
6085
6086 Default: nbtd:wins_prepend1Bto1Cqueries = yes
6087
6088 nbtd:wins_wins_randomize1Clist (G)
6089
6090 Normally queries for 0x1C names will return the addresses in the
6091 same order as they're stored in the database, that means first all
6092 addresses which have been directly registered at the local wins
6093 server and then all addresses registered at other servers. Windows
6094 servers have an option to change this behavior and randomize the
6095 returned addresses. Set this parameter to "yes" and Samba will sort
6096 the address list depending on the client address and the matching
6097 bits of the addresses, the first address is randomized based on
6098 depending on the "nbtd:wins_randomize1Clist_mask" parameter.
6099
6100 Default: nbtd:wins_wins_randomize1Clist = no
6101
6102 nbtd:wins_randomize1Clist_mask (G)
6103
6104 If the "nbtd:wins_randomize1Clist" parameter is set to "yes", then
6105 randomizing of the first returned address is based on the specified
6106 netmask. If there are addresses which are in the same subnet as the
6107 client address, the first returned address is randomly chosen out
6108 them. Otherwise the first returned address is randomly chosen out
6109 of all addresses.
6110
6111 Default: nbtd:wins_randomize1Clist_mask = 255.255.255.0
6112
6113 nbt port (G)
6114
6115 Specifies which port the server should use for NetBIOS over IP name
6116 services traffic.
6117
6118 Default: nbt port = 137
6119
6120 ncalrpc dir (G)
6121
6122 This directory will hold a series of named pipes to allow RPC over
6123 inter-process communication.
6124
6125 This will allow Samba and other unix processes to interact over
6126 DCE/RPC without using TCP/IP. Additionally a sub-directory 'np' has
6127 restricted permissions, and allows a trusted communication channel
6128 between Samba processes
6129
6130 Default: ncalrpc dir = /run/samba/ncalrpc
6131
6132 Example: ncalrpc dir = /var/run/samba/ncalrpc
6133
6134 netbios aliases (G)
6135
6136 This is a list of NetBIOS names that nmbd will advertise as
6137 additional names by which the Samba server is known. This allows
6138 one machine to appear in browse lists under multiple names. If a
6139 machine is acting as a browse server or logon server none of these
6140 names will be advertised as either browse server or logon servers,
6141 only the primary name of the machine will be advertised with these
6142 capabilities.
6143
6144 Default: netbios aliases = # empty string (no additional names)
6145
6146 Example: netbios aliases = TEST TEST1 TEST2
6147
6148 netbios name (G)
6149
6150 This sets the NetBIOS name by which a Samba server is known. By
6151 default it is the same as the first component of the host's DNS
6152 name. If a machine is a browse server or logon server this name (or
6153 the first component of the hosts DNS name) will be the name that
6154 these services are advertised under.
6155
6156 Note that the maximum length for a NetBIOS name is 15 characters.
6157
6158 There is a bug in Samba that breaks operation of browsing and
6159 access to shares if the netbios name is set to the literal name
6160 PIPE. To avoid this problem, do not name your Samba server PIPE.
6161
6162 Default: netbios name = # machine DNS name
6163
6164 Example: netbios name = MYNAME
6165
6166 netbios scope (G)
6167
6168 This sets the NetBIOS scope that Samba will operate under. This
6169 should not be set unless every machine on your LAN also sets this
6170 value.
6171
6172 Default: netbios scope =
6173
6174 neutralize nt4 emulation (G)
6175
6176 This option controls whether winbindd sends the
6177 NETLOGON_NEG_NEUTRALIZE_NT4_EMULATION flag in order to bypass the
6178 NT4 emulation of a domain controller.
6179
6180 Typically you should not need set this. It can be useful for
6181 upgrades from NT4 to AD domains.
6182
6183 The behavior can be controlled per netbios domain by using
6184 'neutralize nt4 emulation:NETBIOSDOMAIN = yes' as option.
6185
6186 Default: neutralize nt4 emulation = no
6187
6188 NIS homedir (G)
6189
6190 Get the home share server from a NIS map. For UNIX systems that use
6191 an automounter, the user's home directory will often be mounted on
6192 a workstation on demand from a remote server.
6193
6194 When the Samba logon server is not the actual home directory
6195 server, but is mounting the home directories via NFS then two
6196 network hops would be required to access the users home directory
6197 if the logon server told the client to use itself as the SMB server
6198 for home directories (one over SMB and one over NFS). This can be
6199 very slow.
6200
6201 This option allows Samba to return the home share as being on a
6202 different server to the logon server and as long as a Samba daemon
6203 is running on the home directory server, it will be mounted on the
6204 Samba client directly from the directory server. When Samba is
6205 returning the home share to the client, it will consult the NIS map
6206 specified in homedir map and return the server listed there.
6207
6208 Note that for this option to work there must be a working NIS
6209 system and the Samba server with this option must also be a logon
6210 server.
6211
6212 Default: NIS homedir = no
6213
6214 nmbd bind explicit broadcast (G)
6215
6216 This option causes nmbd(8) to explicitly bind to the broadcast
6217 address of the local subnets. This is needed to make nmbd work
6218 correctly in combination with the socket address option. You should
6219 not need to unset this option.
6220
6221 Default: nmbd bind explicit broadcast = yes
6222
6223 nsupdate command (G)
6224
6225 This option sets the path to the nsupdate command which is used for
6226 GSS-TSIG dynamic DNS updates.
6227
6228 Default: nsupdate command = /usr/bin/nsupdate -g
6229
6230 nt acl support (S)
6231
6232 This boolean parameter controls whether smbd(8) will attempt to map
6233 UNIX permissions into Windows NT access control lists. The UNIX
6234 permissions considered are the traditional UNIX owner and group
6235 permissions, as well as POSIX ACLs set on any files or directories.
6236 This parameter was formally a global parameter in releases prior to
6237 2.2.2.
6238
6239 Default: nt acl support = yes
6240
6241 ntlm auth (G)
6242
6243 This parameter determines whether or not smbd(8) will attempt to
6244 authenticate users using the NTLM encrypted password response for
6245 this local passdb (SAM or account database).
6246
6247 If disabled, both NTLM and LanMan authencication against the local
6248 passdb is disabled.
6249
6250 Note that these settings apply only to local users, authentication
6251 will still be forwarded to and NTLM authentication accepted against
6252 any domain we are joined to, and any trusted domain, even if
6253 disabled or if NTLMv2-only is enforced here. To control NTLM
6254 authentiation for domain users, this must option must be configured
6255 on each DC.
6256
6257 By default with ntlm auth set to ntlmv2-only only NTLMv2 logins
6258 will be permitted. All modern clients support NTLMv2 by default,
6259 but some older clients will require special configuration to use
6260 it.
6261
6262 The primary user of NTLMv1 is MSCHAPv2 for VPNs and 802.1x.
6263
6264 The available settings are:
6265
6266 · ntlmv1-permitted (alias yes) - Allow NTLMv1 and above
6267 for all clients.
6268
6269 This is the required setting for to enable the lanman
6270 auth parameter.
6271
6272 · ntlmv2-only (alias no) - Do not allow NTLMv1 to be used,
6273 but permit NTLMv2.
6274
6275 · mschapv2-and-ntlmv2-only - Only allow NTLMv1 when the
6276 client promises that it is providing MSCHAPv2
6277 authentication (such as the ntlm_auth tool).
6278
6279 · disabled - Do not accept NTLM (or LanMan) authentication
6280 of any level, nor permit NTLM password changes.
6281
6282 The default changed from yes to no with Samba 4.5. The default
6283 changed again to ntlmv2-only with Samba 4.7, however the behaviour
6284 is unchanged.
6285
6286 Default: ntlm auth = ntlmv2-only
6287
6288 nt pipe support (G)
6289
6290 This boolean parameter controls whether smbd(8) will allow Windows
6291 NT clients to connect to the NT SMB specific IPC$ pipes. This is a
6292 developer debugging option and can be left alone.
6293
6294 Default: nt pipe support = yes
6295
6296 ntp signd socket directory (G)
6297
6298 This setting controls the location of the socket that the NTP
6299 daemon uses to communicate with Samba for signing packets.
6300
6301 If a non-default path is specified here, then it is also necessary
6302 to make NTP aware of the new path using the ntpsigndsocket
6303 directive in ntp.conf.
6304
6305 Default: ntp signd socket directory = /var/lib/samba/ntp_signd
6306
6307 nt status support (G)
6308
6309 This boolean parameter controls whether smbd(8) will negotiate NT
6310 specific status support with Windows NT/2k/XP clients. This is a
6311 developer debugging option and should be left alone. If this option
6312 is set to no then Samba offers exactly the same DOS error codes
6313 that versions prior to Samba 2.2.3 reported.
6314
6315 You should not need to ever disable this parameter.
6316
6317 Default: nt status support = yes
6318
6319 ntvfs handler (S)
6320
6321 This specifies the NTVFS handlers for this share.
6322
6323 · unixuid: Sets up user credentials based on POSIX
6324 gid/uid.
6325
6326 · cifs: Proxies a remote CIFS FS. Mainly useful for
6327 testing.
6328
6329 · nbench: Filter module that saves data useful to the
6330 nbench benchmark suite.
6331
6332 · ipc: Allows using SMB for inter process communication.
6333 Only used for the IPC$ share.
6334
6335 · posix: Maps POSIX FS semantics to NT semantics
6336
6337 · print: Allows printing over SMB. This is LANMAN-style
6338 printing, not the be confused with the spoolss DCE/RPC
6339 interface used by later versions of Windows.
6340
6341 Note that this option is only used when the NTVFS file server is in
6342 use. It is not used with the (default) s3fs file server.
6343
6344 Default: ntvfs handler = unixuid, default
6345
6346 null passwords (G)
6347
6348 Allow or disallow client access to accounts that have null
6349 passwords.
6350
6351 See also smbpasswd(5).
6352
6353 Default: null passwords = no
6354
6355 obey pam restrictions (G)
6356
6357 When Samba 3.0 is configured to enable PAM support (i.e.
6358 --with-pam), this parameter will control whether or not Samba
6359 should obey PAM's account and session management directives. The
6360 default behavior is to use PAM for clear text authentication only
6361 and to ignore any account or session management. Note that Samba
6362 always ignores PAM for authentication in the case of encrypt
6363 passwords = yes. The reason is that PAM modules cannot support the
6364 challenge/response authentication mechanism needed in the presence
6365 of SMB password encryption.
6366
6367 Default: obey pam restrictions = no
6368
6369 old password allowed period (G)
6370
6371 Number of minutes to permit an NTLM login after a password change
6372 or reset using the old password. This allows the user to re-cache
6373 the new password on multiple clients without disrupting a network
6374 reconnection in the meantime.
6375
6376 This parameter only applies when server role is set to Active
6377 Directory Domain Controller
6378
6379 Default: old password allowed period = 60
6380
6381 oplock break wait time (G)
6382
6383 This is a tuning parameter added due to bugs in both Windows 9x and
6384 WinNT. If Samba responds to a client too quickly when that client
6385 issues an SMB that can cause an oplock break request, then the
6386 network client can fail and not respond to the break request. This
6387 tuning parameter (which is set in milliseconds) is the amount of
6388 time Samba will wait before sending an oplock break request to such
6389 (broken) clients.
6390
6391 Warning
6392 DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ AND
6393 UNDERSTOOD THE SAMBA OPLOCK CODE.
6394 Default: oplock break wait time = 0
6395
6396 oplocks (S)
6397
6398 This boolean option tells smbd whether to issue oplocks
6399 (opportunistic locks) to file open requests on this share. The
6400 oplock code can dramatically (approx. 30% or more) improve the
6401 speed of access to files on Samba servers. It allows the clients to
6402 aggressively cache files locally and you may want to disable this
6403 option for unreliable network environments (it is turned on by
6404 default in Windows NT Servers).
6405
6406 Oplocks may be selectively turned off on certain files with a
6407 share. See the veto oplock files parameter. On some systems oplocks
6408 are recognized by the underlying operating system. This allows data
6409 synchronization between all access to oplocked files, whether it be
6410 via Samba or NFS or a local UNIX process. See the kernel oplocks
6411 parameter for details.
6412
6413 Default: oplocks = yes
6414
6415 os2 driver map (G)
6416
6417 The parameter is used to define the absolute path to a file
6418 containing a mapping of Windows NT printer driver names to OS/2
6419 printer driver names. The format is:
6420
6421 <nt driver name> = <os2 driver name>.<device name>
6422
6423 For example, a valid entry using the HP LaserJet 5 printer driver
6424 would appear as HP LaserJet 5L = LASERJET.HP LaserJet 5L.
6425
6426 The need for the file is due to the printer driver namespace
6427 problem described in the chapter on Classical Printing in the
6428 Samba3-HOWTO book. For more details on OS/2 clients, please refer
6429 to chapter on other clients in the Samba3-HOWTO book.
6430
6431 Default: os2 driver map =
6432
6433 os level (G)
6434
6435 This integer value controls what level Samba advertises itself as
6436 for browse elections. The value of this parameter determines
6437 whether nmbd(8) has a chance of becoming a local master browser for
6438 the workgroup in the local broadcast area.
6439
6440 Note: By default, Samba will win a local master browsing election
6441 over all Microsoft operating systems except a Windows NT 4.0/2000
6442 Domain Controller. This means that a misconfigured Samba host can
6443 effectively isolate a subnet for browsing purposes. This parameter
6444 is largely auto-configured in the Samba-3 release series and it is
6445 seldom necessary to manually override the default setting. Please
6446 refer to the chapter on Network Browsing in the Samba-3 HOWTO
6447 document for further information regarding the use of this
6448 parameter. Note: The maximum value for this parameter is 255. If
6449 you use higher values, counting will start at 0!
6450
6451 Default: os level = 20
6452
6453 Example: os level = 65
6454
6455 pam password change (G)
6456
6457 With the addition of better PAM support in Samba 2.2, this
6458 parameter, it is possible to use PAM's password change control flag
6459 for Samba. If enabled, then PAM will be used for password changes
6460 when requested by an SMB client instead of the program listed in
6461 passwd program. It should be possible to enable this without
6462 changing your passwd chat parameter for most setups.
6463
6464 Default: pam password change = no
6465
6466 panic action (G)
6467
6468 This is a Samba developer option that allows a system command to be
6469 called when either smbd(8) or nmbd(8) crashes. This is usually used
6470 to draw attention to the fact that a problem occurred.
6471
6472 Default: panic action =
6473
6474 Example: panic action = /bin/sleep 90000
6475
6476 passdb backend (G)
6477
6478 This option allows the administrator to chose which backend will be
6479 used for storing user and possibly group information. This allows
6480 you to swap between different storage mechanisms without recompile.
6481
6482 The parameter value is divided into two parts, the backend's name,
6483 and a 'location' string that has meaning only to that particular
6484 backed. These are separated by a : character.
6485
6486 Available backends can include:
6487
6488 · smbpasswd - The old plaintext passdb backend. Some Samba
6489 features will not work if this passdb backend is used.
6490 Takes a path to the smbpasswd file as an optional
6491 argument.
6492
6493 · tdbsam - The TDB based password storage backend. Takes a
6494 path to the TDB as an optional argument (defaults to
6495 passdb.tdb in the private dir directory.
6496
6497 · ldapsam - The LDAP based passdb backend. Takes an LDAP
6498 URL as an optional argument (defaults to
6499 ldap://localhost)
6500
6501 LDAP connections should be secured where possible. This
6502 may be done using either Start-TLS (see ldap ssl) or by
6503 specifying ldaps:// in the URL argument.
6504
6505 Multiple servers may also be specified in double-quotes.
6506 Whether multiple servers are supported or not and the
6507 exact syntax depends on the LDAP library you use.
6508
6509
6510 Examples of use are:
6511
6512 passdb backend = tdbsam:/etc/samba/private/passdb.tdb
6513
6514 or multi server LDAP URL with OpenLDAP library:
6515
6516 passdb backend = ldapsam:"ldap://ldap-1.example.com ldap://ldap-2.example.com"
6517
6518 or multi server LDAP URL with Netscape based LDAP library:
6519
6520 passdb backend = ldapsam:"ldap://ldap-1.example.com ldap-2.example.com"
6521
6522 Default: passdb backend = tdbsam
6523
6524 passdb expand explicit (G)
6525
6526 This parameter controls whether Samba substitutes %-macros in the
6527 passdb fields if they are explicitly set. We used to expand macros
6528 here, but this turned out to be a bug because the Windows client
6529 can expand a variable %G_osver% in which %G would have been
6530 substituted by the user's primary group.
6531
6532 Default: passdb expand explicit = no
6533
6534 passwd chat (G)
6535
6536 This string controls the "chat" conversation that takes places
6537 between smbd(8) and the local password changing program to change
6538 the user's password. The string describes a sequence of
6539 response-receive pairs that smbd(8) uses to determine what to send
6540 to the passwd program and what to expect back. If the expected
6541 output is not received then the password is not changed.
6542
6543 This chat sequence is often quite site specific, depending on what
6544 local methods are used for password control (such as NIS etc).
6545
6546 Note that this parameter only is used if the unix password sync
6547 parameter is set to yes. This sequence is then called AS ROOT when
6548 the SMB password in the smbpasswd file is being changed, without
6549 access to the old password cleartext. This means that root must be
6550 able to reset the user's password without knowing the text of the
6551 previous password. In the presence of NIS/YP, this means that the
6552 passwd program must be executed on the NIS master.
6553
6554 The string can contain the macro %n which is substituted for the
6555 new password. The old password (%o) is only available when encrypt
6556 passwords has been disabled. The chat sequence can also contain the
6557 standard macros \n, \r, \t and \s to give line-feed,
6558 carriage-return, tab and space. The chat sequence string can also
6559 contain a '*' which matches any sequence of characters. Double
6560 quotes can be used to collect strings with spaces in them into a
6561 single string.
6562
6563 If the send string in any part of the chat sequence is a full stop
6564 ".", then no string is sent. Similarly, if the expect string is a
6565 full stop then no string is expected.
6566
6567 If the pam password change parameter is set to yes, the chat pairs
6568 may be matched in any order, and success is determined by the PAM
6569 result, not any particular output. The \n macro is ignored for PAM
6570 conversions.
6571
6572 Default: passwd chat = *new*password* %n\n *new*password* %n\n
6573 *changed*
6574
6575 Example: passwd chat = "*Enter NEW password*" %n\n "*Reenter NEW
6576 password*" %n\n "*Password changed*"
6577
6578 passwd chat debug (G)
6579
6580 This boolean specifies if the passwd chat script parameter is run
6581 in debug mode. In this mode the strings passed to and received from
6582 the passwd chat are printed in the smbd(8) log with a debug level
6583 of 100. This is a dangerous option as it will allow plaintext
6584 passwords to be seen in the smbd log. It is available to help Samba
6585 admins debug their passwd chat scripts when calling the passwd
6586 program and should be turned off after this has been done. This
6587 option has no effect if the pam password change parameter is set.
6588 This parameter is off by default.
6589
6590 Default: passwd chat debug = no
6591
6592 passwd chat timeout (G)
6593
6594 This integer specifies the number of seconds smbd will wait for an
6595 initial answer from a passwd chat script being run. Once the
6596 initial answer is received the subsequent answers must be received
6597 in one tenth of this time. The default it two seconds.
6598
6599 Default: passwd chat timeout = 2
6600
6601 passwd program (G)
6602
6603 The name of a program that can be used to set UNIX user passwords.
6604 Any occurrences of %u will be replaced with the user name. The user
6605 name is checked for existence before calling the password changing
6606 program.
6607
6608 Also note that many passwd programs insist in reasonable passwords,
6609 such as a minimum length, or the inclusion of mixed case chars and
6610 digits. This can pose a problem as some clients (such as Windows
6611 for Workgroups) uppercase the password before sending it.
6612
6613 Note that if the unix password sync parameter is set to yes then
6614 this program is called AS ROOT before the SMB password in the
6615 smbpasswd file is changed. If this UNIX password change fails, then
6616 smbd will fail to change the SMB password also (this is by design).
6617
6618 If the unix password sync parameter is set this parameter MUST USE
6619 ABSOLUTE PATHS for ALL programs called, and must be examined for
6620 security implications. Note that by default unix password sync is
6621 set to no.
6622
6623 Default: passwd program =
6624
6625 Example: passwd program = /bin/passwd %u
6626
6627 password hash gpg key ids (G)
6628
6629 If samba is running as an active directory domain controller, it is
6630 possible to store the cleartext password of accounts in a
6631 PGP/OpenGPG encrypted form.
6632
6633 You can specify one or more recipients by key id or user id. Note
6634 that 32bit key ids are not allowed, specify at least 64bit.
6635
6636 The value is stored as 'Primary:SambaGPG' in the
6637 supplementalCredentials attribute.
6638
6639 As password changes can occur on any domain controller, you should
6640 configure this on each of them. Note that this feature is currently
6641 available only on Samba domain controllers.
6642
6643 This option is only available if samba was compiled with gpgme
6644 support.
6645
6646 You may need to export the GNUPGHOME environment variable before
6647 starting samba. It is strongly recommended to only store the
6648 public key in this location. The private key is not used for
6649 encryption and should be only stored where decryption is required.
6650
6651 Being able to restore the cleartext password helps, when they need
6652 to be imported into other authentication systems later (see
6653 samba-tool user getpassword) or you want to keep the passwords in
6654 sync with another system, e.g. an OpenLDAP server (see samba-tool
6655 user syncpasswords).
6656
6657 While this option needs to be configured on all domain controllers,
6658 the samba-tool user syncpasswords command should run on a single
6659 domain controller only (typically the PDC-emulator).
6660
6661 Default: password hash gpg key ids =
6662
6663 Example: password hash gpg key ids = 4952E40301FAB41A
6664
6665 Example: password hash gpg key ids = selftest@samba.example.com
6666
6667 Example: password hash gpg key ids = selftest@samba.example.com,
6668 4952E40301FAB41A
6669
6670 password hash userPassword schemes (G)
6671
6672 This parameter determines whether or not samba(8) acting as an
6673 Active Directory Domain Controller will attempt to store additional
6674 passwords hash types for the user
6675
6676 The values are stored as 'Primary:userPassword' in the
6677 supplementalCredentials attribute. The value of this option is a
6678 hash type.
6679
6680 The currently supported hash types are:
6681
6682 · CryptSHA256
6683
6684 · CryptSHA512
6685
6686 Multiple instances of a hash type may be computed and stored. The
6687 password hashes are calculated using the crypt(3) call. The number
6688 of rounds used to compute the hash can be specified by adding
6689 ':rounds=xxxx' to the hash type, i.e. CryptSHA512:rounds=4500 would
6690 calculate an SHA512 hash using 4500 rounds. If not specified the
6691 Operating System defaults for crypt(3) are used.
6692
6693 As password changes can occur on any domain controller, you should
6694 configure this on each of them. Note that this feature is currently
6695 available only on Samba domain controllers.
6696
6697 Currently the NT Hash of the password is recorded when these hashes
6698 are calculated and stored. When retrieving the hashes the current
6699 value of the NT Hash is checked against the stored NT Hash. This
6700 detects password changes that have not updated the password hashes.
6701 In this case samba-tool user will ignore the stored hash values.
6702
6703 Being able to obtain the hashed password helps, when they need to
6704 be imported into other authentication systems later (see samba-tool
6705 user getpassword) or you want to keep the passwords in sync with
6706 another system, e.g. an OpenLDAP server (see samba-tool user
6707 syncpasswords).
6708
6709 Related command: unix password sync
6710
6711 Default: password hash userPassword schemes =
6712
6713 Example: password hash userPassword schemes = CryptSHA256
6714
6715 Example: password hash userPassword schemes = CryptSHA256
6716 CryptSHA512
6717
6718 Example: password hash userPassword schemes =
6719 CryptSHA256:rounds=5000 CryptSHA512:rounds=7000
6720
6721 password server (G)
6722
6723 By specifying the name of a domain controller with this option, and
6724 using security = [ads|domain] it is possible to get Samba to do all
6725 its username/password validation using a specific remote server.
6726
6727 Ideally, this option should not be used, as the default '*'
6728 indicates to Samba to determine the best DC to contact dynamically,
6729 just as all other hosts in an AD domain do. This allows the domain
6730 to be maintained (addition and removal of domain controllers)
6731 without modification to the smb.conf file. The cryptographic
6732 protection on the authenticated RPC calls used to verify passwords
6733 ensures that this default is safe.
6734
6735 It is strongly recommended that you use the default of '*', however
6736 if in your particular environment you have reason to specify a
6737 particular DC list, then the list of machines in this option must
6738 be a list of names or IP addresses of Domain controllers for the
6739 Domain. If you use the default of '*', or list several hosts in the
6740 password server option then smbd will try each in turn till it
6741 finds one that responds. This is useful in case your primary server
6742 goes down.
6743
6744 If the list of servers contains both names/IP's and the '*'
6745 character, the list is treated as a list of preferred domain
6746 controllers, but an auto lookup of all remaining DC's will be added
6747 to the list as well. Samba will not attempt to optimize this list
6748 by locating the closest DC.
6749
6750 If parameter is a name, it is looked up using the parameter name
6751 resolve order and so may resolved by any method and order described
6752 in that parameter.
6753
6754 Default: password server = *
6755
6756 Example: password server = NT-PDC, NT-BDC1, NT-BDC2, *
6757
6758 Example: password server = windc.mydomain.com:389 192.168.1.101 *
6759
6760 directory
6761
6762 This parameter is a synonym for path.
6763
6764 path (S)
6765
6766 This parameter specifies a directory to which the user of the
6767 service is to be given access. In the case of printable services,
6768 this is where print data will spool prior to being submitted to the
6769 host for printing.
6770
6771 For a printable service offering guest access, the service should
6772 be readonly and the path should be world-writeable and have the
6773 sticky bit set. This is not mandatory of course, but you probably
6774 won't get the results you expect if you do otherwise.
6775
6776 Any occurrences of %u in the path will be replaced with the UNIX
6777 username that the client is using on this connection. Any
6778 occurrences of %m will be replaced by the NetBIOS name of the
6779 machine they are connecting from. These replacements are very
6780 useful for setting up pseudo home directories for users.
6781
6782 Note that this path will be based on root dir if one was specified.
6783
6784 Default: path =
6785
6786 Example: path = /home/fred
6787
6788 perfcount module (G)
6789
6790 This parameter specifies the perfcount backend to be used when
6791 monitoring SMB operations. Only one perfcount module may be used,
6792 and it must implement all of the apis contained in the
6793 smb_perfcount_handler structure defined in smb.h.
6794
6795 No default
6796
6797 pid directory (G)
6798
6799 This option specifies the directory where pid files will be placed.
6800
6801 Default: pid directory = /run
6802
6803 Example: pid directory = /var/run/
6804
6805 posix locking (S)
6806
6807 The smbd(8) daemon maintains an database of file locks obtained by
6808 SMB clients. The default behavior is to map this internal database
6809 to POSIX locks. This means that file locks obtained by SMB clients
6810 are consistent with those seen by POSIX compliant applications
6811 accessing the files via a non-SMB method (e.g. NFS or local file
6812 access). It is very unlikely that you need to set this parameter to
6813 "no", unless you are sharing from an NFS mount, which is not a good
6814 idea in the first place.
6815
6816 Default: posix locking = yes
6817
6818 postexec (S)
6819
6820 This option specifies a command to be run whenever the service is
6821 disconnected. It takes the usual substitutions. The command may be
6822 run as the root on some systems.
6823
6824 An interesting example may be to unmount server resources:
6825
6826 postexec = /etc/umount /cdrom
6827
6828 Default: postexec =
6829
6830 Example: postexec = echo \"%u disconnected from %S from %m (%I)\"
6831 >> /tmp/log
6832
6833 exec
6834
6835 This parameter is a synonym for preexec.
6836
6837 preexec (S)
6838
6839 This option specifies a command to be run whenever the service is
6840 connected to. It takes the usual substitutions.
6841
6842 An interesting example is to send the users a welcome message every
6843 time they log in. Maybe a message of the day? Here is an example:
6844
6845 preexec = csh -c 'echo \"Welcome to %S!\" |
6846 /usr/local/samba/bin/smbclient -M %m -I %I' &
6847
6848 Of course, this could get annoying after a while :-)
6849
6850 See also preexec close and postexec.
6851
6852 Default: preexec =
6853
6854 Example: preexec = echo \"%u connected to %S from %m (%I)\" >>
6855 /tmp/log
6856
6857 preexec close (S)
6858
6859 This boolean option controls whether a non-zero return code from
6860 preexec should close the service being connected to.
6861
6862 Default: preexec close = no
6863
6864 prefered master
6865
6866 This parameter is a synonym for preferred master.
6867
6868 preferred master (G)
6869
6870 This boolean parameter controls if nmbd(8) is a preferred master
6871 browser for its workgroup.
6872
6873 If this is set to yes, on startup, nmbd will force an election, and
6874 it will have a slight advantage in winning the election. It is
6875 recommended that this parameter is used in conjunction with domain
6876 master = yes, so that nmbd can guarantee becoming a domain master.
6877
6878 Use this option with caution, because if there are several hosts
6879 (whether Samba servers, Windows 95 or NT) that are preferred master
6880 browsers on the same subnet, they will each periodically and
6881 continuously attempt to become the local master browser. This will
6882 result in unnecessary broadcast traffic and reduced browsing
6883 capabilities.
6884
6885 Default: preferred master = auto
6886
6887 prefork backoff increment (G)
6888
6889 This option specifies the number of seconds added to the delay
6890 before a prefork master or worker process is restarted. The restart
6891 is initially zero, the prefork backoff increment is added to the
6892 delay on each restart up to the value specified by "prefork maximum
6893 backoff".
6894
6895 Additionally the the backoff for an individual service by using
6896 "prefork backoff increment: service name" i.e. "prefork backoff
6897 increment:ldap = 2" to set the backoff increment to 2.
6898
6899 If the backoff increment is 2 and the maximum backoff is 5. There
6900 will be a zero second delay for the first restart. A two second
6901 delay for the second restart. A four second delay for the third and
6902 any subsequent restarts
6903
6904 Default: prefork backoff increment = 10
6905
6906 prefork children (G)
6907
6908 This option controls the number of worker processes that are
6909 started for each service when prefork process model is enabled (see
6910 samba(8) -M) The prefork children are only started for those
6911 services that support prefork (currently ldap, kdc and netlogon).
6912 For processes that don't support preforking all requests are
6913 handled by a single process for that service.
6914
6915 This should be set to a small multiple of the number of CPU's
6916 available on the server
6917
6918 Additionally the number of prefork children can be specified for an
6919 individual service by using "prefork children: service name" i.e.
6920 "prefork children:ldap = 8" to set the number of ldap worker
6921 processes.
6922
6923 Default: prefork children = 4
6924
6925 prefork maximum backoff (G)
6926
6927 This option controls the maximum delay before a failed pre-fork
6928 process is restarted.
6929
6930 Default: prefork maximum backoff = 120
6931
6932 preload modules (G)
6933
6934 This is a list of paths to modules that should be loaded into smbd
6935 before a client connects. This improves the speed of smbd when
6936 reacting to new connections somewhat.
6937
6938 Default: preload modules =
6939
6940 Example: preload modules = /usr/lib/samba/passdb/mysql.so
6941
6942 preserve case (S)
6943
6944 This controls if new filenames are created with the case that the
6945 client passes, or if they are forced to be the default case.
6946
6947 See the section on NAME MANGLING for a fuller discussion.
6948
6949 Default: preserve case = yes
6950
6951 print ok
6952
6953 This parameter is a synonym for printable.
6954
6955 printable (S)
6956
6957 If this parameter is yes, then clients may open, write to and
6958 submit spool files on the directory specified for the service.
6959
6960 Note that a printable service will ALWAYS allow writing to the
6961 service path (user privileges permitting) via the spooling of print
6962 data. The read only parameter controls only non-printing access to
6963 the resource.
6964
6965 Default: printable = no
6966
6967 printcap cache time (G)
6968
6969 This option specifies the number of seconds before the printing
6970 subsystem is again asked for the known printers.
6971
6972 Setting this parameter to 0 disables any rescanning for new or
6973 removed printers after the initial startup.
6974
6975 Default: printcap cache time = 750
6976
6977 Example: printcap cache time = 600
6978
6979 printcap
6980
6981 This parameter is a synonym for printcap name.
6982
6983 printcap name (G)
6984
6985 This parameter may be used to override the compiled-in default
6986 printcap name used by the server (usually /etc/printcap). See the
6987 discussion of the [printers] section above for reasons why you
6988 might want to do this.
6989
6990 To use the CUPS printing interface set printcap name = cups. This
6991 should be supplemented by an additional setting printing = cups in
6992 the [global] section. printcap name = cups will use the "dummy"
6993 printcap created by CUPS, as specified in your CUPS configuration
6994 file.
6995
6996 On System V systems that use lpstat to list available printers you
6997 can use printcap name = lpstat to automatically obtain lists of
6998 available printers. This is the default for systems that define
6999 SYSV at configure time in Samba (this includes most System V based
7000 systems). If
7001 printcap name is set to lpstat on these systems then Samba will
7002 launch lpstat -v and attempt to parse the output to obtain a
7003 printer list.
7004
7005 A minimal printcap file would look something like this:
7006
7007 print1|My Printer 1
7008 print2|My Printer 2
7009 print3|My Printer 3
7010 print4|My Printer 4
7011 print5|My Printer 5
7012
7013 where the '|' separates aliases of a printer. The fact that the
7014 second alias has a space in it gives a hint to Samba that it's a
7015 comment.
7016
7017 Note
7018 Under AIX the default printcap name is /etc/qconfig. Samba will
7019 assume the file is in AIX qconfig format if the string qconfig
7020 appears in the printcap filename.
7021 Default: printcap name = /etc/printcap
7022
7023 Example: printcap name = /etc/myprintcap
7024
7025 print command (S)
7026
7027 After a print job has finished spooling to a service, this command
7028 will be used via a system() call to process the spool file.
7029 Typically the command specified will submit the spool file to the
7030 host's printing subsystem, but there is no requirement that this be
7031 the case. The server will not remove the spool file, so whatever
7032 command you specify should remove the spool file when it has been
7033 processed, otherwise you will need to manually remove old spool
7034 files.
7035
7036 The print command is simply a text string. It will be used verbatim
7037 after macro substitutions have been made:
7038
7039 %s, %f - the path to the spool file name
7040
7041 %p - the appropriate printer name
7042
7043 %J - the job name as transmitted by the client.
7044
7045 %c - The number of printed pages of the spooled job (if known).
7046
7047 %z - the size of the spooled print job (in bytes)
7048
7049 The print command MUST contain at least one occurrence of %s or %f
7050 - the %p is optional. At the time a job is submitted, if no printer
7051 name is supplied the %p will be silently removed from the printer
7052 command.
7053
7054 If specified in the [global] section, the print command given will
7055 be used for any printable service that does not have its own print
7056 command specified.
7057
7058 If there is neither a specified print command for a printable
7059 service nor a global print command, spool files will be created but
7060 not processed and (most importantly) not removed.
7061
7062 Note that printing may fail on some UNIXes from the nobody account.
7063 If this happens then create an alternative guest account that can
7064 print and set the guest account in the [global] section.
7065
7066 You can form quite complex print commands by realizing that they
7067 are just passed to a shell. For example the following will log a
7068 print job, print the file, then remove it. Note that ';' is the
7069 usual separator for command in shell scripts.
7070
7071 print command = echo Printing %s >> /tmp/print.log; lpr -P %p %s;
7072 rm %s
7073
7074 You may have to vary this command considerably depending on how you
7075 normally print files on your system. The default for the parameter
7076 varies depending on the setting of the printing parameter.
7077
7078 Default: For printing = BSD, AIX, QNX, LPRNG or PLP :
7079
7080 print command = lpr -r -P%p %s
7081
7082 For printing = SYSV or HPUX :
7083
7084 print command = lp -c -d%p %s; rm %s
7085
7086 For printing = SOFTQ :
7087
7088 print command = lp -d%p -s %s; rm %s
7089
7090 For printing = CUPS : If SAMBA is compiled against libcups, then
7091 printcap = cups uses the CUPS API to submit jobs, etc. Otherwise it
7092 maps to the System V commands with the -oraw option for printing,
7093 i.e. it uses lp -c -d%p -oraw; rm %s. With printing = cups, and if
7094 SAMBA is compiled against libcups, any manually set print command
7095 will be ignored.
7096
7097 No default
7098
7099 Example: print command = /usr/local/samba/bin/myprintscript %p %s
7100
7101 printer
7102
7103 This parameter is a synonym for printer name.
7104
7105 printer name (S)
7106
7107 This parameter specifies the name of the printer to which print
7108 jobs spooled through a printable service will be sent.
7109
7110 If specified in the [global] section, the printer name given will
7111 be used for any printable service that does not have its own
7112 printer name specified.
7113
7114 The default value of the printer name may be lp on many systems.
7115
7116 Default: printer name =
7117
7118 Example: printer name = laserwriter
7119
7120 printing (S)
7121
7122 This parameters controls how printer status information is
7123 interpreted on your system. It also affects the default values for
7124 the print command, lpq command, lppause command , lpresume command,
7125 and lprm command if specified in the [global] section.
7126
7127 Currently nine printing styles are supported. They are BSD, AIX,
7128 LPRNG, PLP, SYSV, HPUX, QNX, SOFTQ, CUPS and IPRINT.
7129
7130 Be aware that CUPS and IPRINT are only available if the CUPS
7131 development library was available at the time Samba was compiled or
7132 packaged.
7133
7134 To see what the defaults are for the other print commands when
7135 using the various options use the testparm(1) program.
7136
7137 This option can be set on a per printer basis. Please be aware
7138 however, that you must place any of the various printing commands
7139 (e.g. print command, lpq command, etc...) after defining the value
7140 for the printing option since it will reset the printing commands
7141 to default values.
7142
7143 See also the discussion in the [printers] section.
7144
7145 See testparm -v. for the default value on your system
7146
7147 Default: printing = # Depends on the operating system
7148
7149 printjob username (S)
7150
7151 This parameter specifies which user information will be passed to
7152 the printing system. Usually, the username is sent, but in some
7153 cases, e.g. the domain prefix is useful, too.
7154
7155 Default: printjob username = %U
7156
7157 Example: printjob username = %D\%U
7158
7159 print notify backchannel (S)
7160
7161 Windows print clients can update print queue status by expecting
7162 the server to open a backchannel SMB connection to them. Due to
7163 client firewall settings this can cause considerable timeouts and
7164 will often fail, as there is no guarantee the client is even
7165 running an SMB server. By default, the Samba print server will not
7166 try to connect back to clients, and will treat corresponding
7167 requests as if the connection back to the client failed.
7168
7169 Default: print notify backchannel = no
7170
7171 private directory
7172
7173 This parameter is a synonym for private dir.
7174
7175 private dir (G)
7176
7177 This parameters defines the directory smbd will use for storing
7178 such files as smbpasswd and secrets.tdb.
7179
7180 Default: private dir = /var/lib/samba/private
7181
7182 queuepause command (S)
7183
7184 This parameter specifies the command to be executed on the server
7185 host in order to pause the printer queue.
7186
7187 This command should be a program or script which takes a printer
7188 name as its only parameter and stops the printer queue, such that
7189 no longer jobs are submitted to the printer.
7190
7191 This command is not supported by Windows for Workgroups, but can be
7192 issued from the Printers window under Windows 95 and NT.
7193
7194 If a %p is given then the printer name is put in its place.
7195 Otherwise it is placed at the end of the command.
7196
7197 Note that it is good practice to include the absolute path in the
7198 command as the PATH may not be available to the server.
7199
7200 Default: queuepause command = # determined by printing parameter
7201
7202 Example: queuepause command = disable %p
7203
7204 queueresume command (S)
7205
7206 This parameter specifies the command to be executed on the server
7207 host in order to resume the printer queue. It is the command to
7208 undo the behavior that is caused by the previous parameter
7209 (queuepause command).
7210
7211 This command should be a program or script which takes a printer
7212 name as its only parameter and resumes the printer queue, such that
7213 queued jobs are resubmitted to the printer.
7214
7215 This command is not supported by Windows for Workgroups, but can be
7216 issued from the Printers window under Windows 95 and NT.
7217
7218 If a %p is given then the printer name is put in its place.
7219 Otherwise it is placed at the end of the command.
7220
7221 Note that it is good practice to include the absolute path in the
7222 command as the PATH may not be available to the server.
7223
7224 Default: queueresume command = # determined by printing parameter
7225
7226 Example: queueresume command = enable %p
7227
7228 raw NTLMv2 auth (G)
7229
7230 This parameter has been deprecated since Samba 4.13 and support for
7231 NTLMv2 authentication without NTLMSSP will be removed in a future
7232 Samba release.
7233
7234 That is, in the future, the current default of raw NTLMv2 auth = no
7235 will be the enforced behaviour.
7236
7237 This parameter determines whether or not smbd(8) will allow SMB1
7238 clients without extended security (without SPNEGO) to use NTLMv2
7239 authentication.
7240
7241 If this option, lanman auth and ntlm auth are all disabled, then
7242 only clients with SPNEGO support will be permitted. That means
7243 NTLMv2 is only supported within NTLMSSP.
7244
7245 Default: raw NTLMv2 auth = no
7246
7247 read list (S)
7248
7249 This is a list of users that are given read-only access to a
7250 service. If the connecting user is in this list then they will not
7251 be given write access, no matter what the read only option is set
7252 to. The list can include group names using the syntax described in
7253 the invalid users parameter.
7254
7255 Default: read list =
7256
7257 Example: read list = mary, @students
7258
7259 read only (S)
7260
7261 An inverted synonym is writeable.
7262
7263 If this parameter is yes, then users of a service may not create or
7264 modify files in the service's directory.
7265
7266 Note that a printable service (printable = yes) will ALWAYS allow
7267 writing to the directory (user privileges permitting), but only via
7268 spooling operations.
7269
7270 Default: read only = yes
7271
7272 read raw (G)
7273
7274 This is ignored if async smb echo handler is set, because this
7275 feature is incompatible with raw read SMB requests
7276
7277 If enabled, raw reads allow reads of 65535 bytes in one packet.
7278 This typically provides a major performance benefit for some very,
7279 very old clients.
7280
7281 However, some clients either negotiate the allowable block size
7282 incorrectly or are incapable of supporting larger block sizes, and
7283 for these clients you may need to disable raw reads.
7284
7285 In general this parameter should be viewed as a system tuning tool
7286 and left severely alone.
7287
7288 Default: read raw = yes
7289
7290 realm (G)
7291
7292 This option specifies the kerberos realm to use. The realm is used
7293 as the ADS equivalent of the NT4 domain. It is usually set to the
7294 DNS name of the kerberos server.
7295
7296 Default: realm =
7297
7298 Example: realm = mysambabox.mycompany.com
7299
7300 registry shares (G)
7301
7302 This turns on or off support for share definitions read from
7303 registry. Shares defined in smb.conf take precedence over shares
7304 with the same name defined in registry. See the section on
7305 registry-based configuration for details.
7306
7307 Note that this parameter defaults to no, but it is set to yes when
7308 config backend is set to registry.
7309
7310 Default: registry shares = no
7311
7312 Example: registry shares = yes
7313
7314 reject md5 clients (G)
7315
7316 This option controls whether the netlogon server (currently only in
7317 'active directory domain controller' mode), will reject clients
7318 which does not support NETLOGON_NEG_SUPPORTS_AES.
7319
7320 You can set this to yes if all domain members support aes. This
7321 will prevent downgrade attacks.
7322
7323 This option takes precedence to the 'allow nt4 crypto' option.
7324
7325 Default: reject md5 clients = no
7326
7327 reject md5 servers (G)
7328
7329 This option controls whether winbindd requires support for aes
7330 support for the netlogon secure channel.
7331
7332 The following flags will be required NETLOGON_NEG_ARCFOUR,
7333 NETLOGON_NEG_SUPPORTS_AES, NETLOGON_NEG_PASSWORD_SET2 and
7334 NETLOGON_NEG_AUTHENTICATED_RPC.
7335
7336 You can set this to yes if all domain controllers support aes. This
7337 will prevent downgrade attacks.
7338
7339 The behavior can be controlled per netbios domain by using 'reject
7340 md5 servers:NETBIOSDOMAIN = yes' as option.
7341
7342 This option takes precedence to the require strong key option.
7343
7344 Default: reject md5 servers = no
7345
7346 remote announce (G)
7347
7348 This option allows you to setup nmbd(8) to periodically announce
7349 itself to arbitrary IP addresses with an arbitrary workgroup name.
7350
7351 This is useful if you want your Samba server to appear in a remote
7352 workgroup for which the normal browse propagation rules don't work.
7353 The remote workgroup can be anywhere that you can send IP packets
7354 to.
7355
7356 For example:
7357
7358 remote announce = 192.168.2.255/SERVERS 192.168.4.255/STAFF
7359
7360 the above line would cause nmbd to announce itself to the two given
7361 IP addresses using the given workgroup names. If you leave out the
7362 workgroup name, then the one given in the workgroup parameter is
7363 used instead.
7364
7365 The IP addresses you choose would normally be the broadcast
7366 addresses of the remote networks, but can also be the IP addresses
7367 of known browse masters if your network config is that stable.
7368
7369 See the chapter on Network Browsing in the Samba-HOWTO book.
7370
7371 Default: remote announce =
7372
7373 remote browse sync (G)
7374
7375 This option allows you to setup nmbd(8) to periodically request
7376 synchronization of browse lists with the master browser of a Samba
7377 server that is on a remote segment. This option will allow you to
7378 gain browse lists for multiple workgroups across routed networks.
7379 This is done in a manner that does not work with any non-Samba
7380 servers.
7381
7382 This is useful if you want your Samba server and all local clients
7383 to appear in a remote workgroup for which the normal browse
7384 propagation rules don't work. The remote workgroup can be anywhere
7385 that you can send IP packets to.
7386
7387 For example:
7388
7389 remote browse sync = 192.168.2.255 192.168.4.255
7390
7391 the above line would cause nmbd to request the master browser on
7392 the specified subnets or addresses to synchronize their browse
7393 lists with the local server.
7394
7395 The IP addresses you choose would normally be the broadcast
7396 addresses of the remote networks, but can also be the IP addresses
7397 of known browse masters if your network config is that stable. If a
7398 machine IP address is given Samba makes NO attempt to validate that
7399 the remote machine is available, is listening, nor that it is in
7400 fact the browse master on its segment.
7401
7402 The remote browse sync may be used on networks where there is no
7403 WINS server, and may be used on disjoint networks where each
7404 network has its own WINS server.
7405
7406 Default: remote browse sync =
7407
7408 rename user script (G)
7409
7410 This is the full pathname to a script that will be run as root by
7411 smbd(8) under special circumstances described below.
7412
7413 When a user with admin authority or SeAddUserPrivilege rights
7414 renames a user (e.g.: from the NT4 User Manager for Domains), this
7415 script will be run to rename the POSIX user. Two variables, %uold
7416 and %unew, will be substituted with the old and new usernames,
7417 respectively. The script should return 0 upon successful
7418 completion, and nonzero otherwise.
7419
7420 Note
7421 The script has all responsibility to rename all the necessary
7422 data that is accessible in this posix method. This can mean
7423 different requirements for different backends. The tdbsam and
7424 smbpasswd backends will take care of the contents of their
7425 respective files, so the script is responsible only for
7426 changing the POSIX username, and other data that may required
7427 for your circumstances, such as home directory. Please also
7428 consider whether or not you need to rename the actual home
7429 directories themselves. The ldapsam backend will not make any
7430 changes, because of the potential issues with renaming the LDAP
7431 naming attribute. In this case the script is responsible for
7432 changing the attribute that samba uses (uid) for locating
7433 users, as well as any data that needs to change for other
7434 applications using the same directory.
7435 Default: rename user script =
7436
7437 require strong key (G)
7438
7439 This option controls whether winbindd requires support for md5
7440 strong key support for the netlogon secure channel.
7441
7442 The following flags will be required NETLOGON_NEG_STRONG_KEYS,
7443 NETLOGON_NEG_ARCFOUR and NETLOGON_NEG_AUTHENTICATED_RPC.
7444
7445 You can set this to no if some domain controllers only support des.
7446 This might allows weak crypto to be negotiated, may via downgrade
7447 attacks.
7448
7449 The behavior can be controlled per netbios domain by using 'require
7450 strong key:NETBIOSDOMAIN = no' as option.
7451
7452 Note for active directory domain this option is hardcoded to 'yes'
7453
7454 This option yields precedence to the reject md5 servers option.
7455
7456 This option takes precedence to the client schannel option.
7457
7458 Default: require strong key = yes
7459
7460 reset on zero vc (G)
7461
7462 This boolean option controls whether an incoming SMB1 session setup
7463 should kill other connections coming from the same IP. This matches
7464 the default Windows 2003 behaviour. Setting this parameter to yes
7465 becomes necessary when you have a flaky network and windows decides
7466 to reconnect while the old connection still has files with share
7467 modes open. These files become inaccessible over the new
7468 connection. The client sends a zero VC on the new connection, and
7469 Windows 2003 kills all other connections coming from the same IP.
7470 This way the locked files are accessible again. Please be aware
7471 that enabling this option will kill connections behind a
7472 masquerading router, and will not trigger for clients that only use
7473 SMB2 or SMB3.
7474
7475 Default: reset on zero vc = no
7476
7477 restrict anonymous (G)
7478
7479 The setting of this parameter determines whether SAMR and LSA
7480 DCERPC services can be accessed anonymously. This corresponds to
7481 the following Windows Server registry options:
7482
7483 HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Lsa\RestrictAnonymous
7484
7485
7486 The option also affects the browse option which is required by
7487 legacy clients which rely on Netbios browsing. While modern Windows
7488 version should be fine with restricting the access there could
7489 still be applications relying on anonymous access.
7490
7491 Setting restrict anonymous = 1 will disable anonymous SAMR access.
7492
7493 Setting restrict anonymous = 2 will, in addition to restricting
7494 SAMR access, disallow anonymous connections to the IPC$ share in
7495 general. Setting guest ok = yes on any share will remove the
7496 security advantage.
7497
7498 Default: restrict anonymous = 0
7499
7500 root
7501
7502 This parameter is a synonym for root directory.
7503
7504 root dir
7505
7506 This parameter is a synonym for root directory.
7507
7508 root directory (G)
7509
7510 The server will chroot() (i.e. Change its root directory) to this
7511 directory on startup. This is not strictly necessary for secure
7512 operation. Even without it the server will deny access to files not
7513 in one of the service entries. It may also check for, and deny
7514 access to, soft links to other parts of the filesystem, or attempts
7515 to use ".." in file names to access other directories (depending on
7516 the setting of the wide smbconfoptions parameter).
7517
7518 Adding a root directory entry other than "/" adds an extra level of
7519 security, but at a price. It absolutely ensures that no access is
7520 given to files not in the sub-tree specified in the root directory
7521 option, including some files needed for complete operation of the
7522 server. To maintain full operability of the server you will need to
7523 mirror some system files into the root directory tree. In
7524 particular you will need to mirror /etc/passwd (or a subset of it),
7525 and any binaries or configuration files needed for printing (if
7526 required). The set of files that must be mirrored is operating
7527 system dependent.
7528
7529 Default: root directory =
7530
7531 Example: root directory = /homes/smb
7532
7533 root postexec (S)
7534
7535 This is the same as the postexec parameter except that the command
7536 is run as root. This is useful for unmounting filesystems (such as
7537 CDROMs) after a connection is closed.
7538
7539 Default: root postexec =
7540
7541 root preexec (S)
7542
7543 This is the same as the preexec parameter except that the command
7544 is run as root. This is useful for mounting filesystems (such as
7545 CDROMs) when a connection is opened.
7546
7547 Default: root preexec =
7548
7549 root preexec close (S)
7550
7551 This is the same as the preexec close parameter except that the
7552 command is run as root.
7553
7554 Default: root preexec close = no
7555
7556 rpc big endian (G)
7557
7558 Setting this option will force the RPC client and server to
7559 transfer data in big endian.
7560
7561 If it is disabled, data will be transferred in little endian.
7562
7563 The behaviour is independent of the endianness of the host machine.
7564
7565 Default: rpc big endian = no
7566
7567 rpc_daemon:DAEMON (G)
7568
7569 Defines whether to use the embedded code or start a separate daemon
7570 for the defined rpc services. The rpc_daemon prefix must be
7571 followed by the server name, and a value.
7572
7573 Two possible values are currently supported:
7574
7575 disabled
7576 fork
7577
7578
7579 The classic method is to run rpc services as internal daemons
7580 embedded in smbd, therefore the external daemons are disabled by
7581 default.
7582
7583 Choosing the fork option will cause samba to fork a separate
7584 process for each daemon configured this way. Each daemon may in
7585 turn fork a number of children used to handle requests from
7586 multiple smbds and direct tcp/ip connections (if the Endpoint
7587 Mapper is enabled). Communication with smbd happens over named
7588 pipes and require that said pipes are forward to the external
7589 daemon (see rpc_server).
7590
7591 Forked RPC Daemons support dynamically forking children to handle
7592 connections. The heuristics about how many children to keep around
7593 and how fast to allow them to fork and also how many clients each
7594 child is allowed to handle concurrently is defined by parametrical
7595 options named after the daemon. Five options are currently
7596 supported:
7597
7598 prefork_min_children
7599 prefork_max_children
7600 prefork_spawn_rate
7601 prefork_max_allowed_clients
7602 prefork_child_min_life
7603
7604
7605 To set one of these options use the following syntax:
7606
7607 daemonname:prefork_min_children = 5
7608
7609
7610 Samba includes separate daemons for spoolss, lsarpc/lsass,
7611 netlogon, samr, FSRVP and mdssvc(Spotlight). Currently five daemons
7612 are available and they are called:
7613
7614 epmd
7615 lsasd
7616 spoolssd
7617 fssd
7618 mdssd
7619
7620
7621 Example:
7622
7623 rpc_daemon:spoolssd = fork
7624
7625
7626 Default: rpc_daemon:DAEMON = disabled
7627
7628 rpc_server:SERVER (G)
7629
7630 With this option you can define if a rpc service should be running
7631 internal/embedded in smbd or should be redirected to an external
7632 daemon like Samba4, the endpoint mapper daemon, the spoolss daemon
7633 or the new LSA service daemon. The rpc_server prefix must be
7634 followed by the pipe name, and a value.
7635
7636 This option can be set for each available rpc service in Samba. The
7637 following list shows all available pipe names services you can
7638 modify with this option.
7639
7640 · epmapper - Endpoint Mapper
7641
7642 · winreg - Remote Registry Service
7643
7644 · srvsvc - Remote Server Services
7645
7646 · lsarpc - Local Security Authority
7647
7648 · samr - Security Account Management
7649
7650 · netlogon - Netlogon Remote Protocol
7651
7652 · netdfs - Settings for Distributed File System
7653
7654 · dssetup - Active Directory Setup
7655
7656 · wkssvc - Workstation Services
7657
7658 · spoolss - Network Printing Spooler
7659
7660 · svcctl - Service Control
7661
7662 · ntsvcs - Plug and Play Services
7663
7664 · eventlog - Event Logger
7665
7666 · initshutdown - Init Shutdown Service
7667
7668 · mdssvc - Spotlight
7669
7670 Three possible values currently supported are: embedded external
7671 disabled
7672
7673 The classic method is to run every pipe as an internal function
7674 embedded in smbd. The defaults may vary depending on the service.
7675
7676 Choosing the external option allows one to run a separate daemon or
7677 even a completely independent (3rd party) server capable of
7678 interfacing with samba via the MS-RPC interface over named pipes.
7679
7680 Currently in Samba3 we support four daemons, spoolssd, epmd, lsasd
7681 and mdssd. These daemons can be enabled using the rpc_daemon
7682 option. For spoolssd you have to enable the daemon and proxy the
7683 named pipe with:
7684
7685 Examples:
7686
7687 rpc_daemon:lsasd = fork
7688 rpc_server:lsarpc = external
7689 rpc_server:samr = external
7690 rpc_server:netlogon = external
7691
7692 rpc_server:spoolss = external
7693 rpc_server:epmapper = disabled
7694
7695 rpc_daemon:mdssd = fork
7696 rpc_server:mdssvc = external
7697
7698
7699 There is one special option which allows you to enable rpc services
7700 to listen for ncacn_ip_tcp connections too. Currently this is only
7701 used for testing and doesn't scale!
7702
7703 rpc_server:tcpip = yes
7704
7705
7706 Default: rpc_server:SERVER = embedded
7707
7708 rpc server dynamic port range (G)
7709
7710 This parameter tells the RPC server which port range it is allowed
7711 to use to create a listening socket for LSA, SAM, Netlogon and
7712 others without wellknown tcp ports. The first value is the lowest
7713 number of the port range and the second the highest.
7714
7715 This applies to RPC servers in all server roles.
7716
7717 Default: rpc server dynamic port range = 49152-65535
7718
7719 rpc server port (G)
7720
7721 Specifies which port the server should listen on for DCE/RPC over
7722 TCP/IP traffic.
7723
7724 This controls the default port for all protocols, except for
7725 NETLOGON.
7726
7727 If unset, the first available port from rpc server dynamic port
7728 range is used, e.g. 49152.
7729
7730 The NETLOGON server will use the next available port, e.g. 49153.
7731 To change this port use (eg) rpc server port:netlogon = 4000.
7732
7733 Furthermore, all RPC servers can have the port they use specified
7734 independenty, with (for example) rpc server port:drsuapi = 5000.
7735
7736 This option applies currently only when samba(8) runs as an active
7737 directory domain controller.
7738
7739 The default value 0 causes Samba to select the first available port
7740 from rpc server dynamic port range.
7741
7742 Default: rpc server port = 0
7743
7744 samba kcc command (G)
7745
7746 This option specifies the path to the Samba KCC command. This
7747 script is used for replication topology replication.
7748
7749 It should not be necessary to modify this option except for testing
7750 purposes or if the samba_kcc was installed in a non-default
7751 location.
7752
7753 Default: samba kcc command =
7754 /builddir/build/BUILD/samba-4.13.7/source4/scripting/bin/samba_kcc
7755
7756 Example: samba kcc command = /usr/local/bin/kcc
7757
7758 security (G)
7759
7760 This option affects how clients respond to Samba and is one of the
7761 most important settings in the smb.conf file.
7762
7763 The default is security = user, as this is the most common setting,
7764 used for a standalone file server or a DC.
7765
7766 The alternatives are security = ads or security = domain, which
7767 support joining Samba to a Windows domain
7768
7769 You should use security = user and map to guest if you want to
7770 mainly setup shares without a password (guest shares). This is
7771 commonly used for a shared printer server.
7772
7773 The different settings will now be explained.
7774
7775 SECURITY = AUTO
7776
7777 This is the default security setting in Samba, and causes Samba to
7778 consult the server role parameter (if set) to determine the
7779 security mode.
7780
7781 SECURITY = USER
7782
7783 If server role is not specified, this is the default security
7784 setting in Samba. With user-level security a client must first
7785 "log-on" with a valid username and password (which can be mapped
7786 using the username map parameter). Encrypted passwords (see the
7787 encrypted passwords parameter) can also be used in this security
7788 mode. Parameters such as user and guest only if set are then
7789 applied and may change the UNIX user to use on this connection, but
7790 only after the user has been successfully authenticated.
7791
7792 Note that the name of the resource being requested is not sent to
7793 the server until after the server has successfully authenticated
7794 the client. This is why guest shares don't work in user level
7795 security without allowing the server to automatically map unknown
7796 users into the guest account. See the map to guest parameter for
7797 details on doing this.
7798
7799 SECURITY = DOMAIN
7800
7801 This mode will only work correctly if net(8) has been used to add
7802 this machine into a Windows NT Domain. It expects the encrypted
7803 passwords parameter to be set to yes. In this mode Samba will try
7804 to validate the username/password by passing it to a Windows NT
7805 Primary or Backup Domain Controller, in exactly the same way that a
7806 Windows NT Server would do.
7807
7808 Note that a valid UNIX user must still exist as well as the account
7809 on the Domain Controller to allow Samba to have a valid UNIX
7810 account to map file access to.
7811
7812 Note that from the client's point of view security = domain is the
7813 same as security = user. It only affects how the server deals with
7814 the authentication, it does not in any way affect what the client
7815 sees.
7816
7817 Note that the name of the resource being requested is not sent to
7818 the server until after the server has successfully authenticated
7819 the client. This is why guest shares don't work in user level
7820 security without allowing the server to automatically map unknown
7821 users into the guest account. See the map to guest parameter for
7822 details on doing this.
7823
7824 See also the password server parameter and the encrypted passwords
7825 parameter.
7826
7827 SECURITY = ADS
7828
7829 In this mode, Samba will act as a domain member in an ADS realm. To
7830 operate in this mode, the machine running Samba will need to have
7831 Kerberos installed and configured and Samba will need to be joined
7832 to the ADS realm using the net utility.
7833
7834 Note that this mode does NOT make Samba operate as a Active
7835 Directory Domain Controller.
7836
7837 Note that this forces require strong key = yes and client schannel
7838 = yes for the primary domain.
7839
7840 Read the chapter about Domain Membership in the HOWTO for details.
7841
7842 Default: security = AUTO
7843
7844 Example: security = DOMAIN
7845
7846 security mask (S)
7847
7848 This parameter has been removed for Samba 4.0.0.
7849
7850 No default
7851
7852 max protocol
7853
7854 This parameter is a synonym for server max protocol.
7855
7856 protocol
7857
7858 This parameter is a synonym for server max protocol.
7859
7860 server max protocol (G)
7861
7862 The value of the parameter (a string) is the highest protocol level
7863 that will be supported by the server.
7864
7865 Possible values are :
7866
7867 · LANMAN1: First modern version of the protocol. Long
7868 filename support.
7869
7870 · LANMAN2: Updates to Lanman1 protocol.
7871
7872 · NT1: Current up to date version of the protocol. Used by
7873 Windows NT. Known as CIFS.
7874
7875 · SMB2: Re-implementation of the SMB protocol. Used by
7876 Windows Vista and later versions of Windows. SMB2 has
7877 sub protocols available.
7878
7879 · SMB2_02: The earliest SMB2 version.
7880
7881 · SMB2_10: Windows 7 SMB2 version.
7882
7883 · SMB2_22: Early Windows 8 SMB2 version.
7884
7885 · SMB2_24: Windows 8 beta SMB2 version.
7886
7887 By default SMB2 selects the SMB2_10 variant.
7888
7889 · SMB3: The same as SMB2. Used by Windows 8. SMB3 has sub
7890 protocols available.
7891
7892 · SMB3_00: Windows 8 SMB3 version. (mostly the
7893 same as SMB2_24)
7894
7895 · SMB3_02: Windows 8.1 SMB3 version.
7896
7897 · SMB3_10: early Windows 10 technical preview
7898 SMB3 version.
7899
7900 · SMB3_11: Windows 10 technical preview SMB3
7901 version (maybe final).
7902
7903 By default SMB3 selects the SMB3_11 variant.
7904
7905 Normally this option should not be set as the automatic negotiation
7906 phase in the SMB protocol takes care of choosing the appropriate
7907 protocol.
7908
7909 Default: server max protocol = SMB3
7910
7911 Example: server max protocol = LANMAN1
7912
7913 min protocol
7914
7915 This parameter is a synonym for server min protocol.
7916
7917 server min protocol (G)
7918
7919 This setting controls the minimum protocol version that the server
7920 will allow the client to use.
7921
7922 Normally this option should not be set as the automatic negotiation
7923 phase in the SMB protocol takes care of choosing the appropriate
7924 protocol unless you have legacy clients which are SMB1 capable
7925 only.
7926
7927 See Related command: server max protocol for a full list of
7928 available protocols.
7929
7930 Default: server min protocol = SMB2_02
7931
7932 Example: server min protocol = NT1
7933
7934 server multi channel support (G)
7935
7936 This boolean parameter controls whether smbd(8) will support SMB3
7937 multi-channel.
7938
7939 This parameter was added with version 4.4.
7940
7941 Warning: Note that this feature is still considered experimental.
7942 Use it at your own risk: Even though it may seem to work well in
7943 testing, it may result in data corruption under some race
7944 conditions. Future releases may improve this situation.
7945
7946 Due to dependencies to kernel APIs of Linux or FreeBSD, it's only
7947 possible to use this feature on Linux and FreeBSD for now. For
7948 testing this restriction can be overwritten by specifying
7949 force:server multi channel support=yes in addition.
7950
7951 Default: server multi channel support = no
7952
7953 server role (G)
7954
7955 This option determines the basic operating mode of a Samba server
7956 and is one of the most important settings in the smb.conf file.
7957
7958 The default is server role = auto, as causes Samba to operate
7959 according to the security setting, or if not specified as a simple
7960 file server that is not connected to any domain.
7961
7962 The alternatives are server role = standalone or server role =
7963 member server, which support joining Samba to a Windows domain,
7964 along with server role = domain controller, which run Samba as a
7965 Windows domain controller.
7966
7967 You should use server role = standalone and map to guest if you
7968 want to mainly setup shares without a password (guest shares). This
7969 is commonly used for a shared printer server.
7970
7971 SERVER ROLE = AUTO
7972
7973 This is the default server role in Samba, and causes Samba to
7974 consult the security parameter (if set) to determine the server
7975 role, giving compatible behaviours to previous Samba versions.
7976
7977 SERVER ROLE = STANDALONE
7978
7979 If security is also not specified, this is the default security
7980 setting in Samba. In standalone operation, a client must first
7981 "log-on" with a valid username and password (which can be mapped
7982 using the username map parameter) stored on this machine. Encrypted
7983 passwords (see the encrypted passwords parameter) are by default
7984 used in this security mode. Parameters such as user and guest only
7985 if set are then applied and may change the UNIX user to use on this
7986 connection, but only after the user has been successfully
7987 authenticated.
7988
7989 SERVER ROLE = MEMBER SERVER
7990
7991 This mode will only work correctly if net(8) has been used to add
7992 this machine into a Windows Domain. It expects the encrypted
7993 passwords parameter to be set to yes. In this mode Samba will try
7994 to validate the username/password by passing it to a Windows or
7995 Samba Domain Controller, in exactly the same way that a Windows
7996 Server would do.
7997
7998 Note that a valid UNIX user must still exist as well as the account
7999 on the Domain Controller to allow Samba to have a valid UNIX
8000 account to map file access to. Winbind can provide this.
8001
8002 SERVER ROLE = CLASSIC PRIMARY DOMAIN CONTROLLER
8003
8004 This mode of operation runs a classic Samba primary domain
8005 controller, providing domain logon services to Windows and Samba
8006 clients of an NT4-like domain. Clients must be joined to the domain
8007 to create a secure, trusted path across the network. There must be
8008 only one PDC per NetBIOS scope (typcially a broadcast network or
8009 clients served by a single WINS server).
8010
8011 SERVER ROLE = CLASSIC BACKUP DOMAIN CONTROLLER
8012
8013 This mode of operation runs a classic Samba backup domain
8014 controller, providing domain logon services to Windows and Samba
8015 clients of an NT4-like domain. As a BDC, this allows multiple Samba
8016 servers to provide redundant logon services to a single NetBIOS
8017 scope.
8018
8019 SERVER ROLE = ACTIVE DIRECTORY DOMAIN CONTROLLER
8020
8021 This mode of operation runs Samba as an active directory domain
8022 controller, providing domain logon services to Windows and Samba
8023 clients of the domain. This role requires special configuration,
8024 see the Samba4 HOWTO
8025
8026 Default: server role = AUTO
8027
8028 Example: server role = ACTIVE DIRECTORY DOMAIN CONTROLLER
8029
8030 server schannel (G)
8031
8032 This option is deprecated and will be removed in future, as it is a
8033 security problem if not set to "yes" (which will be the hardcoded
8034 behavior in future).
8035
8036 Samba will complain in the log files at log level 0, about the
8037 security problem if the option is not set to "yes".
8038
8039 See CVE-2020-1472(ZeroLogon)
8040 https://bugzilla.samba.org/show_bug.cgi?id=14497
8041
8042 If you still have legacy domain members use the server require
8043 schannel:COMPUTERACCOUNT option.
8044
8045 This option yields precedence to the server require
8046 schannel:COMPUTERACCOUNT option.
8047
8048 Default: server schannel = yes
8049
8050 server require schannel:COMPUTERACCOUNT (G)
8051
8052 If you still have legacy domain members, which required "server
8053 schannel = auto" before, it is possible to specify explicit
8054 expection per computer account by using 'server require
8055 schannel:COMPUTERACCOUNT = no' as option. Note that COMPUTERACCOUNT
8056 has to be the sAMAccountName value of the computer account
8057 (including the trailing '$' sign).
8058
8059 Samba will complain in the log files at log level 0, about the
8060 security problem if the option is not set to "no", but the related
8061 computer is actually using the netlogon secure channel (schannel)
8062 feature.
8063
8064 Samba will warn in the log files at log level 5, if a setting is
8065 still needed for the specified computer account.
8066
8067 See CVE-2020-1472(ZeroLogon)
8068 https://bugzilla.samba.org/show_bug.cgi?id=14497
8069
8070 This option takes precedence to the server schannel option.
8071
8072 server require schannel:LEGACYCOMPUTER1$ = no
8073 server require schannel:NASBOX$ = no
8074 server require schannel:LEGACYCOMPUTER2$ = no
8075
8076
8077 No default
8078
8079 server services (G)
8080
8081 This option contains the services that the Samba daemon will run.
8082
8083 An entry in the smb.conf file can either override the previous
8084 value completely or entries can be removed from or added to it by
8085 prefixing them with + or -.
8086
8087 Default: server services = s3fs, rpc, nbt, wrepl, ldap, cldap, kdc,
8088 drepl, winbindd, ntp_signd, kcc, dnsupdate, dns
8089
8090 Example: server services = -s3fs, +smb
8091
8092 server signing (G)
8093
8094 This controls whether the client is allowed or required to use SMB1
8095 and SMB2 signing. Possible values are default, auto, mandatory and
8096 disabled.
8097
8098 By default, and when smb signing is set to default, smb signing is
8099 required when server role is active directory domain controller and
8100 disabled otherwise.
8101
8102 When set to auto, SMB1 signing is offered, but not enforced. When
8103 set to mandatory, SMB1 signing is required and if set to disabled,
8104 SMB signing is not offered either.
8105
8106 For the SMB2 protocol, by design, signing cannot be disabled. In
8107 the case where SMB2 is negotiated, if this parameter is set to
8108 disabled, it will be treated as auto. Setting it to mandatory will
8109 still require SMB2 clients to use signing.
8110
8111 Default: server signing = default
8112
8113 server smb encrypt (S)
8114
8115 This parameter controls whether a remote client is allowed or
8116 required to use SMB encryption. It has different effects depending
8117 on whether the connection uses SMB1 or SMB2 and newer:
8118
8119 · If the connection uses SMB1, then this option controls
8120 the use of a Samba-specific extension to the SMB
8121 protocol introduced in Samba 3.2 that makes use of the
8122 Unix extensions.
8123
8124 · If the connection uses SMB2 or newer, then this option
8125 controls the use of the SMB-level encryption that is
8126 supported in SMB version 3.0 and above and available in
8127 Windows 8 and newer.
8128
8129 This parameter can be set globally and on a per-share bases.
8130 Possible values are off, if_required, desired, and required. A
8131 special value is default which is the implicit default setting of
8132 if_required.
8133
8134 Effects for SMB1
8135 The Samba-specific encryption of SMB1 connections is an
8136 extension to the SMB protocol negotiated as part of the UNIX
8137 extensions. SMB encryption uses the GSSAPI (SSPI on Windows)
8138 ability to encrypt and sign every request/response in a SMB
8139 protocol stream. When enabled it provides a secure method of
8140 SMB/CIFS communication, similar to an ssh protected session,
8141 but using SMB/CIFS authentication to negotiate encryption and
8142 signing keys. Currently this is only supported smbclient of by
8143 Samba 3.2 and newer, and hopefully soon Linux CIFSFS and
8144 MacOS/X clients. Windows clients do not support this feature.
8145
8146 This may be set on a per-share basis, but clients may chose to
8147 encrypt the entire session, not just traffic to a specific
8148 share. If this is set to mandatory then all traffic to a share
8149 must be encrypted once the connection has been made to the
8150 share. The server would return "access denied" to all
8151 non-encrypted requests on such a share. Selecting encrypted
8152 traffic reduces throughput as smaller packet sizes must be used
8153 (no huge UNIX style read/writes allowed) as well as the
8154 overhead of encrypting and signing all the data.
8155
8156 If SMB encryption is selected, Windows style SMB signing (see
8157 the server signing option) is no longer necessary, as the
8158 GSSAPI flags use select both signing and sealing of the data.
8159
8160 When set to auto or default, SMB encryption is offered, but not
8161 enforced. When set to mandatory, SMB encryption is required and
8162 if set to disabled, SMB encryption can not be negotiated.
8163
8164 Effects for SMB2 and newer
8165 Native SMB transport encryption is available in SMB version 3.0
8166 or newer. It is only offered by Samba if server max protocol is
8167 set to SMB3 or newer. Clients supporting this type of
8168 encryption include Windows 8 and newer, Windows server 2012 and
8169 newer, and smbclient of Samba 4.1 and newer.
8170
8171 The protocol implementation offers various options:
8172
8173 · The capability to perform SMB encryption can be
8174 negotiated during protocol negotiation.
8175
8176 · Data encryption can be enabled globally. In that
8177 case, an encryption-capable connection will have all
8178 traffic in all its sessions encrypted. In particular
8179 all share connections will be encrypted.
8180
8181 · Data encryption can also be enabled per share if not
8182 enabled globally. For an encryption-capable
8183 connection, all connections to an encryption-enabled
8184 share will be encrypted.
8185
8186 · Encryption can be enforced. This means that session
8187 setups will be denied on non-encryption-capable
8188 connections if data encryption has been enabled
8189 globally. And tree connections will be denied for
8190 non-encryption capable connections to shares with
8191 data encryption enabled.
8192
8193 These features can be controlled with settings of server smb
8194 encrypt as follows:
8195
8196 · Leaving it as default, explicitly setting default,
8197 or setting it to if_required globally will enable
8198 negotiation of encryption but will not turn on data
8199 encryption globally or per share.
8200
8201 · Setting it to desired globally will enable
8202 negotiation and will turn on data encryption on
8203 sessions and share connections for those clients
8204 that support it.
8205
8206 · Setting it to required globally will enable
8207 negotiation and turn on data encryption on sessions
8208 and share connections. Clients that do not support
8209 encryption will be denied access to the server.
8210
8211 · Setting it to off globally will completely disable
8212 the encryption feature for all connections. Setting
8213 server smb encrypt = required for individual shares
8214 (while it's globally off) will deny access to this
8215 shares for all clients.
8216
8217 · Setting it to desired on a share will turn on data
8218 encryption for this share for clients that support
8219 encryption if negotiation has been enabled globally.
8220
8221 · Setting it to required on a share will enforce data
8222 encryption for this share if negotiation has been
8223 enabled globally. I.e. clients that do not support
8224 encryption will be denied access to the share.
8225
8226 Note that this allows per-share enforcing to be
8227 controlled in Samba differently from Windows: In
8228 Windows, RejectUnencryptedAccess is a global
8229 setting, and if it is set, all shares with data
8230 encryption turned on are automatically enforcing
8231 encryption. In order to achieve the same effect in
8232 Samba, one has to globally set server smb encrypt to
8233 if_required, and then set all shares that should be
8234 encrypted to required. Additionally, it is possible
8235 in Samba to have some shares with encryption
8236 required and some other shares with encryption only
8237 desired, which is not possible in Windows.
8238
8239 · Setting it to off or if_required for a share has no
8240 effect.
8241
8242
8243 Default: server smb encrypt = default
8244
8245 server string (G)
8246
8247 This controls what string will show up in the printer comment box
8248 in print manager and next to the IPC connection in net view. It can
8249 be any string that you wish to show to your users.
8250
8251 It also sets what will appear in browse lists next to the machine
8252 name.
8253
8254 A %v will be replaced with the Samba version number.
8255
8256 A %h will be replaced with the hostname.
8257
8258 Default: server string = Samba %v
8259
8260 Example: server string = University of GNUs Samba Server
8261
8262 set primary group script (G)
8263
8264 Thanks to the Posix subsystem in NT a Windows User has a primary
8265 group in addition to the auxiliary groups. This script sets the
8266 primary group in the unix user database when an administrator sets
8267 the primary group from the windows user manager or when fetching a
8268 SAM with net rpc vampire. %u will be replaced with the user whose
8269 primary group is to be set. %g will be replaced with the group to
8270 set.
8271
8272 Default: set primary group script =
8273
8274 Example: set primary group script = /usr/sbin/usermod -g '%g' '%u'
8275
8276 set quota command (G)
8277
8278 The set quota command should only be used whenever there is no
8279 operating system API available from the OS that samba can use.
8280
8281 This option is only available if Samba was compiled with quota
8282 support.
8283
8284 This parameter should specify the path to a script that can set
8285 quota for the specified arguments.
8286
8287 The specified script should take the following arguments:
8288
8289 · 1 - path to where the quota needs to be set. This needs
8290 to be interpreted relative to the current working
8291 directory that the script may also check for.
8292
8293 · 2 - quota type
8294
8295 · 1 - user quotas
8296
8297 · 2 - user default quotas (uid = -1)
8298
8299 · 3 - group quotas
8300
8301 · 4 - group default quotas (gid = -1)
8302
8303
8304 · 3 - id (uid for user, gid for group, -1 if N/A)
8305
8306 · 4 - quota state (0 = disable, 1 = enable, 2 = enable and
8307 enforce)
8308
8309 · 5 - block softlimit
8310
8311 · 6 - block hardlimit
8312
8313 · 7 - inode softlimit
8314
8315 · 8 - inode hardlimit
8316
8317 · 9(optional) - block size, defaults to 1024
8318
8319 The script should output at least one line of data on success. And
8320 nothing on failure.
8321
8322 Default: set quota command =
8323
8324 Example: set quota command = /usr/local/sbin/set_quota
8325
8326 share backend (G)
8327
8328 This option specifies the backend that will be used to access the
8329 configuration of file shares.
8330
8331 Traditionally, Samba file shares have been configured in the
8332 smb.conf file and this is still the default.
8333
8334 At the moment there are no other supported backends.
8335
8336 Default: share backend = classic
8337
8338 share:fake_fscaps (G)
8339
8340 This is needed to support some special application that makes
8341 QFSINFO calls to check whether we set the SPARSE_FILES bit (0x40).
8342 If this bit is not set that particular application refuses to work
8343 against Samba. With share:fake_fscaps = 64 the SPARSE_FILES file
8344 system capability flag is set. Use other decimal values to specify
8345 the bitmask you need to fake.
8346
8347 Default: share:fake_fscaps = 0
8348
8349 short preserve case (S)
8350
8351 This boolean parameter controls if new files which conform to 8.3
8352 syntax, that is all in upper case and of suitable length, are
8353 created upper case, or if they are forced to be the default case.
8354 This option can be use with preserve case = yes to permit long
8355 filenames to retain their case, while short names are lowered.
8356
8357 See the section on NAME MANGLING.
8358
8359 Default: short preserve case = yes
8360
8361 show add printer wizard (G)
8362
8363 With the introduction of MS-RPC based printing support for Windows
8364 NT/2000 client in Samba 2.2, a "Printers..." folder will appear on
8365 Samba hosts in the share listing. Normally this folder will contain
8366 an icon for the MS Add Printer Wizard (APW). However, it is
8367 possible to disable this feature regardless of the level of
8368 privilege of the connected user.
8369
8370 Under normal circumstances, the Windows NT/2000 client will open a
8371 handle on the printer server with OpenPrinterEx() asking for
8372 Administrator privileges. If the user does not have administrative
8373 access on the print server (i.e is not root or has granted the
8374 SePrintOperatorPrivilege), the OpenPrinterEx() call fails and the
8375 client makes another open call with a request for a lower privilege
8376 level. This should succeed, however the APW icon will not be
8377 displayed.
8378
8379 Disabling the show add printer wizard parameter will always cause
8380 the OpenPrinterEx() on the server to fail. Thus the APW icon will
8381 never be displayed.
8382
8383 Note
8384 This does not prevent the same user from having administrative
8385 privilege on an individual printer.
8386 Default: show add printer wizard = yes
8387
8388 shutdown script (G)
8389
8390 This a full path name to a script called by smbd(8) that should
8391 start a shutdown procedure.
8392
8393 If the connected user possesses the SeRemoteShutdownPrivilege,
8394 right, this command will be run as root.
8395
8396 The %z %t %r %f variables are expanded as follows:
8397
8398 · %z will be substituted with the shutdown message sent to
8399 the server.
8400
8401 · %t will be substituted with the number of seconds to
8402 wait before effectively starting the shutdown procedure.
8403
8404 · %r will be substituted with the switch -r. It means
8405 reboot after shutdown for NT.
8406
8407 · %f will be substituted with the switch -f. It means
8408 force the shutdown even if applications do not respond
8409 for NT.
8410
8411 Shutdown script example:
8412
8413 #!/bin/bash
8414
8415 time=$2
8416 let time="${time} / 60"
8417 let time="${time} + 1"
8418
8419 /sbin/shutdown $3 $4 +$time $1 &
8420
8421
8422 Shutdown does not return so we need to launch it in background.
8423
8424 Default: shutdown script =
8425
8426 Example: shutdown script = /usr/local/samba/sbin/shutdown %m %t %r
8427 %f
8428
8429 smb2 disable lock sequence checking (G)
8430
8431 This boolean parameter controls whether smbd(8) will disable lock
8432 sequence checking even for multi-channel connections as well as
8433 durable handles.
8434
8435 The [MS-SMB2] specification (under 3.3.5.14 Receiving an SMB2 LOCK
8436 Request) documents that a server should do lock sequence if
8437 Open.IsResilient or Open.IsDurable or Open.IsPersistent is TRUE or
8438 if Connection.Dialect belongs to the SMB 3.x dialect family and
8439 Connection.ServerCapabilities includes
8440 SMB2_GLOBAL_CAP_MULTI_CHANNEL.
8441
8442 But Windows Server (at least up to v2004) only does these checks
8443 for the Open.IsResilient and Open.IsPersistent. That means they do
8444 not implement the behavior specified in [MS-SMB2].
8445
8446 By default Samba behaves according to the specification and sends
8447 smb2 oplock break notification retries.
8448
8449 Warning: Only enable this option if existing clients can't handle
8450 lock sequence checking for handles without Open.IsResilient and
8451 Open.IsPersistent. And it turns out that the Windows Server
8452 behavior is required.
8453
8454 Note: it's likely that this option will be removed again if future
8455 Windows versions change their behavior.
8456
8457 Note: Samba does not implement Open.IsResilient and
8458 Open.IsPersistent yet.
8459
8460 Default: smb2 disable lock sequence checking = no
8461
8462 Example: smb2 disable lock sequence checking = yes
8463
8464 smb2 disable oplock break retry (G)
8465
8466 This boolean parameter controls whether smbd(8) will trigger smb2
8467 oplock break notification retries when using server multi channel
8468 support = yes.
8469
8470 The [MS-SMB2] specification documents that a server should send
8471 smb2 oplock break notification retries on all available channel to
8472 the given client.
8473
8474 But Windows Server versions (at least up to 2019) do not send smb2
8475 oplock break notification retries on channel failures. That means
8476 they do not implement the behavior specified in [MS-SMB2].
8477
8478 By default Samba behaves according to the specification and send
8479 smb2 oplock break notification retries.
8480
8481 Warning: Only enable this option if existing clients can't handle
8482 possible retries and it turns out that the Windows Server behavior
8483 is required.
8484
8485 Note: it's likely that this option gets removed again if future
8486 Windows versions change their behavior.
8487
8488 Note: this only applies to oplocks and not SMB2 leases.
8489
8490 Default: smb2 disable oplock break retry = no
8491
8492 Example: smb2 disable oplock break retry = yes
8493
8494 smb2 leases (G)
8495
8496 This boolean option tells smbd whether to globally negotiate SMB2
8497 leases on file open requests. Leasing is an SMB2-only feature which
8498 allows clients to aggressively cache files locally above and beyond
8499 the caching allowed by SMB1 oplocks.
8500
8501 This is only available with oplocks = yes and kernel oplocks = no.
8502
8503 Note that the write cache won't be used for file handles with a
8504 smb2 write lease.
8505
8506 Default: smb2 leases = yes
8507
8508 smb2 max credits (G)
8509
8510 This option controls the maximum number of outstanding simultaneous
8511 SMB2 operations that Samba tells the client it will allow. This is
8512 similar to the max mux parameter for SMB1. You should never need to
8513 set this parameter.
8514
8515 The default is 8192 credits, which is the same as a Windows 2008R2
8516 SMB2 server.
8517
8518 Default: smb2 max credits = 8192
8519
8520 smb2 max read (G)
8521
8522 This option specifies the protocol value that smbd(8) will return
8523 to a client, informing the client of the largest size that may be
8524 returned by a single SMB2 read call.
8525
8526 The maximum is 8388608 bytes (8MiB), which is the same as a Windows
8527 Server 2012 r2.
8528
8529 Please note that the default is 8MiB, but it's limit is based on
8530 the smb2 dialect (64KiB for SMB == 2.0, 8MiB for SMB >= 2.1 with
8531 LargeMTU). Large MTU is not supported over NBT (tcp port 139).
8532
8533 Default: smb2 max read = 8388608
8534
8535 smb2 max trans (G)
8536
8537 This option specifies the protocol value that smbd(8) will return
8538 to a client, informing the client of the largest size of buffer
8539 that may be used in querying file meta-data via QUERY_INFO and
8540 related SMB2 calls.
8541
8542 The maximum is 8388608 bytes (8MiB), which is the same as a Windows
8543 Server 2012 r2.
8544
8545 Please note that the default is 8MiB, but it's limit is based on
8546 the smb2 dialect (64KiB for SMB == 2.0, 1MiB for SMB >= 2.1 with
8547 LargeMTU). Large MTU is not supported over NBT (tcp port 139).
8548
8549 Default: smb2 max trans = 8388608
8550
8551 smb2 max write (G)
8552
8553 This option specifies the protocol value that smbd(8) will return
8554 to a client, informing the client of the largest size that may be
8555 sent to the server by a single SMB2 write call.
8556
8557 The maximum is 8388608 bytes (8MiB), which is the same as a Windows
8558 Server 2012 r2.
8559
8560 Please note that the default is 8MiB, but it's limit is based on
8561 the smb2 dialect (64KiB for SMB == 2.0, 8MiB for SMB => 2.1 with
8562 LargeMTU). Large MTU is not supported over NBT (tcp port 139).
8563
8564 Default: smb2 max write = 8388608
8565
8566 smbd async dosmode (S)
8567
8568 This parameter control whether the fileserver will use sync or
8569 async methods for fetching the DOS attributes when doing a
8570 directory listing. By default sync methods will be used.
8571
8572 Default: smbd async dosmode = no
8573
8574 smbd getinfo ask sharemode (S)
8575
8576 This parameter allows disabling fetching file write time from the
8577 open file handle database locking.tdb when a client requests file
8578 or directory metadata. It's a performance optimisation at the
8579 expense of protocol correctness.
8580
8581 Default: smbd getinfo ask sharemode = yes
8582
8583 smbd max async dosmode (S)
8584
8585 This parameter controls how many async operations to fetch the DOS
8586 attributes the fileserver will queue when doing directory listings.
8587
8588 Default: smbd max async dosmode = aio max threads * 2
8589
8590 smbd profiling level (G)
8591
8592 This parameter allows the administrator to enable profiling
8593 support.
8594
8595 Possible values are off, count and on.
8596
8597 Default: smbd profiling level = off
8598
8599 Example: smbd profiling level = on
8600
8601 smbd search ask sharemode (S)
8602
8603 This parameter allows disabling fetching file write time from the
8604 open file handle database locking.tdb. It's a performance
8605 optimisation at the expense of protocol correctness.
8606
8607 Default: smbd search ask sharemode = yes
8608
8609 smb encrypt (S)
8610
8611 This is a synonym for server smb encrypt.
8612
8613 Default: smb encrypt = default
8614
8615 smb passwd file (G)
8616
8617 This option sets the path to the encrypted smbpasswd file. By
8618 default the path to the smbpasswd file is compiled into Samba.
8619
8620 An example of use is:
8621
8622 smb passwd file = /etc/samba/smbpasswd
8623
8624 Default: smb passwd file = /var/lib/samba/private/smbpasswd
8625
8626 smb ports (G)
8627
8628 Specifies which ports the server should listen on for SMB traffic.
8629
8630 Default: smb ports = 445 139
8631
8632 socket options (G)
8633
8634 Warning
8635 Modern server operating systems are tuned for high network
8636 performance in the majority of situations; when you set socket
8637 options you are overriding those settings. Linux in particular
8638 has an auto-tuning mechanism for buffer sizes that will be
8639 disabled if you specify a socket buffer size. This can
8640 potentially cripple your TCP/IP stack.
8641
8642 Getting the socket options correct can make a big difference to
8643 your performance, but getting them wrong can degrade it by just
8644 as much. As with any other low level setting, if you must make
8645 changes to it, make small changes and test the effect before
8646 making any large changes.
8647
8648 This option allows you to set socket options to be used when
8649 talking with the client.
8650
8651 Socket options are controls on the networking layer of the
8652 operating systems which allow the connection to be tuned.
8653
8654 This option will typically be used to tune your Samba server for
8655 optimal performance for your local network. There is no way that
8656 Samba can know what the optimal parameters are for your net, so you
8657 must experiment and choose them yourself. We strongly suggest you
8658 read the appropriate documentation for your operating system first
8659 (perhaps man setsockopt will help).
8660
8661 You may find that on some systems Samba will say "Unknown socket
8662 option" when you supply an option. This means you either
8663 incorrectly typed it or you need to add an include file to
8664 includes.h for your OS. If the latter is the case please send the
8665 patch to samba-technical@lists.samba.org.
8666
8667 Any of the supported socket options may be combined in any way you
8668 like, as long as your OS allows it.
8669
8670 This is the list of socket options currently settable using this
8671 option:
8672
8673 · SO_KEEPALIVE
8674
8675 · SO_REUSEADDR
8676
8677 · SO_BROADCAST
8678
8679 · TCP_NODELAY
8680
8681 · TCP_KEEPCNT *
8682
8683 · TCP_KEEPIDLE *
8684
8685 · TCP_KEEPINTVL *
8686
8687 · IPTOS_LOWDELAY
8688
8689 · IPTOS_THROUGHPUT
8690
8691 · SO_REUSEPORT
8692
8693 · SO_SNDBUF *
8694
8695 · SO_RCVBUF *
8696
8697 · SO_SNDLOWAT *
8698
8699 · SO_RCVLOWAT *
8700
8701 · SO_SNDTIMEO *
8702
8703 · SO_RCVTIMEO *
8704
8705 · TCP_FASTACK *
8706
8707 · TCP_QUICKACK
8708
8709 · TCP_NODELAYACK
8710
8711 · TCP_KEEPALIVE_THRESHOLD *
8712
8713 · TCP_KEEPALIVE_ABORT_THRESHOLD *
8714
8715 · TCP_DEFER_ACCEPT *
8716
8717 · TCP_USER_TIMEOUT *
8718
8719 Those marked with a '*' take an integer argument. The others can
8720 optionally take a 1 or 0 argument to enable or disable the option,
8721 by default they will be enabled if you don't specify 1 or 0.
8722
8723 To specify an argument use the syntax SOME_OPTION = VALUE for
8724 example SO_SNDBUF = 8192. Note that you must not have any spaces
8725 before or after the = sign.
8726
8727 If you are on a local network then a sensible option might be:
8728
8729 socket options = IPTOS_LOWDELAY
8730
8731 If you have a local network then you could try:
8732
8733 socket options = IPTOS_LOWDELAY TCP_NODELAY
8734
8735 If you are on a wide area network then perhaps try setting
8736 IPTOS_THROUGHPUT.
8737
8738 Note that several of the options may cause your Samba server to
8739 fail completely. Use these options with caution!
8740
8741 Default: socket options = TCP_NODELAY
8742
8743 Example: socket options = IPTOS_LOWDELAY
8744
8745 spn update command (G)
8746
8747 This option sets the command that for updating servicePrincipalName
8748 names from spn_update_list.
8749
8750 Default: spn update command =
8751 /builddir/build/BUILD/samba-4.13.7/source4/scripting/bin/samba_spnupdate
8752
8753 Example: spn update command = /usr/local/sbin/spnupdate
8754
8755 spoolss: architecture (G)
8756
8757 Windows spoolss print clients only allow association of server-side
8758 drivers with printers when the driver architecture matches the
8759 advertised print server architecture. Samba's spoolss print server
8760 architecture can be changed using this parameter.
8761
8762 Default: spoolss: architecture = Windows x64
8763
8764 Example: spoolss: architecture = Windows NT x86
8765
8766 spoolss: os_major (G)
8767
8768 Windows might require a new os version number. This option allows
8769 to modify the build number. The complete default version number is:
8770 5.0.2195 (Windows 2000). The example is 6.1.7601 (Windows 2008 R2).
8771
8772 Default: spoolss: os_major = 5
8773
8774 Example: spoolss: os_major = 6
8775
8776 spoolss: os_minor (G)
8777
8778 Windows might require a new os version number. This option allows
8779 to modify the build number. The complete default version number is:
8780 5.0.2195 (Windows 2000). The example is 6.1.7601 (Windows 2008 R2).
8781
8782 Default: spoolss: os_minor = 0
8783
8784 Example: spoolss: os_minor = 1
8785
8786 spoolss: os_build (G)
8787
8788 Windows might require a new os version number. This option allows
8789 to modify the build number. The complete default version number is:
8790 5.0.2195 (Windows 2000). The example is 6.1.7601 (Windows 2008 R2).
8791
8792 Default: spoolss: os_build = 2195
8793
8794 Example: spoolss: os_build = 7601
8795
8796 spoolss_client: os_major (G)
8797
8798 Windows might require a new os version number. This option allows
8799 to modify the build number. The complete default version number is:
8800 6.1.7007 (Windows 7 and Windows Server 2008 R2).
8801
8802 Default: spoolss_client: os_major = 6
8803
8804 spoolss_client: os_minor (G)
8805
8806 Windows might require a new os version number. This option allows
8807 to modify the build number. The complete default version number is:
8808 6.1.7007 (Windows 7 and Windows Server 2008 R2).
8809
8810 Default: spoolss_client: os_minor = 1
8811
8812 spoolss_client: os_build (G)
8813
8814 Windows might require a new os version number. This option allows
8815 to modify the build number. The complete default version number is:
8816 6.1.7007 (Windows 7 and Windows Server 2008 R2).
8817
8818 Default: spoolss_client: os_build = 7007
8819
8820 spotlight (S)
8821
8822 This parameter controls whether Samba allows Spotlight queries on a
8823 share. For controlling indexing of filesystems you also have to use
8824 Tracker's own configuration system.
8825
8826 Spotlight has several prerequisites:
8827
8828 · Samba must be configured and built with Spotlight
8829 support.
8830
8831 · The mdssvc RPC service must be enabled, see below.
8832
8833 · Tracker integration must be setup and the share must be
8834 indexed by Tracker.
8835
8836 For a detailed set of instructions please see
8837 https://wiki.samba.org/index.php/Spotlight.
8838
8839 The Spotlight RPC service can either be enabled as embedded RPC
8840 service:
8841
8842 [Global]
8843 rpc_server:mdsvc = embedded
8844
8845 Or it can be run in a separate RPC service daemon:
8846
8847 [Global]
8848 rpc_server:mdssd = fork
8849 rpc_server:mdsvc = external
8850
8851 Default: spotlight = no
8852
8853 spotlight backend (S)
8854
8855 Spotlight search backend. Available backends:
8856
8857 · noindex - a backend that returns no results.
8858
8859
8860 · tracker - Gnome Tracker.
8861
8862 · elasticsearch - a backend that uses JSON and REST over
8863 HTTP(s) to query an Elasticsearch server.
8864
8865
8866 Default: spotlight backend = noindex
8867
8868 stat cache (G)
8869
8870 This parameter determines if smbd(8) will use a cache in order to
8871 speed up case insensitive name mappings. You should never need to
8872 change this parameter.
8873
8874 Default: stat cache = yes
8875
8876 state directory (G)
8877
8878 Usually, most of the TDB files are stored in the lock directory.
8879 Since Samba 3.4.0, it is possible to differentiate between TDB
8880 files with persistent data and TDB files with non-persistent data
8881 using the state directory and the cache directory options.
8882
8883 This option specifies the directory where TDB files containing
8884 important persistent data will be stored.
8885
8886 Default: state directory = /var/lib/samba
8887
8888 Example: state directory = /var/run/samba/locks/state
8889
8890 store dos attributes (S)
8891
8892 If this parameter is set Samba attempts to first read DOS
8893 attributes (SYSTEM, HIDDEN, ARCHIVE or READ-ONLY) from a filesystem
8894 extended attribute, before mapping DOS attributes to UNIX
8895 permission bits (such as occurs with map hidden and map readonly).
8896 When set, DOS attributes will be stored onto an extended attribute
8897 in the UNIX filesystem, associated with the file or directory. When
8898 this parameter is set it will override the parameters map hidden,
8899 map system, map archive and map readonly and they will behave as if
8900 they were set to off. This parameter writes the DOS attributes as a
8901 string into the extended attribute named "user.DOSATTRIB". This
8902 extended attribute is explicitly hidden from smbd clients
8903 requesting an EA list. On Linux the filesystem must have been
8904 mounted with the mount option user_xattr in order for extended
8905 attributes to work, also extended attributes must be compiled into
8906 the Linux kernel. In Samba 3.5.0 and above the "user.DOSATTRIB"
8907 extended attribute has been extended to store the create time for a
8908 file as well as the DOS attributes. This is done in a backwards
8909 compatible way so files created by Samba 3.5.0 and above can still
8910 have the DOS attribute read from this extended attribute by earlier
8911 versions of Samba, but they will not be able to read the create
8912 time stored there. Storing the create time separately from the
8913 normal filesystem meta-data allows Samba to faithfully reproduce
8914 NTFS semantics on top of a POSIX filesystem. The default has
8915 changed to yes in Samba release 4.9.0 and above to allow better
8916 Windows fileserver compatibility in a default install.
8917
8918 Default: store dos attributes = yes
8919
8920 strict allocate (S)
8921
8922 This is a boolean that controls the handling of disk space
8923 allocation in the server. When this is set to yes the server will
8924 change from UNIX behaviour of not committing real disk storage
8925 blocks when a file is extended to the Windows behaviour of actually
8926 forcing the disk system to allocate real storage blocks when a file
8927 is created or extended to be a given size. In UNIX terminology this
8928 means that Samba will stop creating sparse files.
8929
8930 This option is really designed for file systems that support fast
8931 allocation of large numbers of blocks such as extent-based file
8932 systems. On file systems that don't support extents (most notably
8933 ext3) this can make Samba slower. When you work with large files
8934 over >100MB on file systems without extents you may even run into
8935 problems with clients running into timeouts.
8936
8937 When you have an extent based filesystem it's likely that we can
8938 make use of unwritten extents which allows Samba to allocate even
8939 large amounts of space very fast and you will not see any timeout
8940 problems caused by strict allocate. With strict allocate in use you
8941 will also get much better out of quota messages in case you use
8942 quotas. Another advantage of activating this setting is that it
8943 will help to reduce file fragmentation.
8944
8945 To give you an idea on which filesystems this setting might
8946 currently be a good option for you: XFS, ext4, btrfs, ocfs2 on
8947 Linux and JFS2 on AIX support unwritten extents. On Filesystems
8948 that do not support it, preallocation is probably an expensive
8949 operation where you will see reduced performance and risk to let
8950 clients run into timeouts when creating large files. Examples are
8951 ext3, ZFS, HFS+ and most others, so be aware if you activate this
8952 setting on those filesystems.
8953
8954 Default: strict allocate = no
8955
8956 strict locking (S)
8957
8958 This is an enumerated type that controls the handling of file
8959 locking in the server. When this is set to yes, the server will
8960 check every read and write access for file locks, and deny access
8961 if locks exist. This can be slow on some systems.
8962
8963 When strict locking is set to Auto (the default), the server
8964 performs file lock checks only on non-oplocked files. As most
8965 Windows redirectors perform file locking checks locally on oplocked
8966 files this is a good trade off for improved performance.
8967
8968 When strict locking is disabled, the server performs file lock
8969 checks only when the client explicitly asks for them.
8970
8971 Well-behaved clients always ask for lock checks when it is
8972 important. So in the vast majority of cases, strict locking = Auto
8973 or strict locking = no is acceptable.
8974
8975 Default: strict locking = Auto
8976
8977 strict rename (S)
8978
8979 By default a Windows SMB server prevents directory renames when
8980 there are open file or directory handles below it in the filesystem
8981 hierarchy. Historically Samba has always allowed this as POSIX
8982 filesystem semantics require it.
8983
8984 This boolean parameter allows Samba to match the Windows behavior.
8985 Setting this to "yes" is a very expensive change, as it forces
8986 Samba to travers the entire open file handle database on every
8987 directory rename request. In a clustered Samba system the cost is
8988 even greater than the non-clustered case.
8989
8990 When set to "no" smbd only checks the local process the client is
8991 attached to for open files below a directory being renamed, instead
8992 of checking for open files across all smbd processes.
8993
8994 Because of the expense in fully searching the database, the default
8995 is "no", and it is recommended to be left that way unless a
8996 specific Windows application requires it to be changed.
8997
8998 If the client has requested UNIX extensions (POSIX pathnames) then
8999 renames are always allowed and this parameter has no effect.
9000
9001 Default: strict rename = no
9002
9003 strict sync (S)
9004
9005 This parameter controls whether Samba honors a request from an SMB
9006 client to ensure any outstanding operating system buffer contents
9007 held in memory are safely written onto stable storage on disk. If
9008 set to yes, which is the default, then Windows applications can
9009 force the smbd server to synchronize unwritten data onto the disk.
9010 If set to no then smbd will ignore client requests to synchronize
9011 unwritten data onto stable storage on disk.
9012
9013 In Samba 4.7.0, the default for this parameter changed from no to
9014 yes to better match the expectations of SMB2/3 clients and improve
9015 application safety when running against smbd.
9016
9017 The flush request from SMB2/3 clients is handled asynchronously
9018 inside smbd, so leaving the parameter as the default value of yes
9019 does not block the processing of other requests to the smbd
9020 process.
9021
9022 Legacy Windows applications (such as the Windows 98 explorer shell)
9023 seemed to confuse writing buffer contents to the operating system
9024 with synchronously writing outstanding data onto stable storage on
9025 disk. Changing this parameter to no means that smbd(8) will ignore
9026 the Windows applications request to synchronize unwritten data onto
9027 disk. Only consider changing this if smbd is serving obsolete SMB1
9028 Windows clients prior to Windows XP (Windows 98 and below). There
9029 should be no need to change this setting for normal operations.
9030
9031 Default: strict sync = yes
9032
9033 svcctl list (G)
9034
9035 This option defines a list of init scripts that smbd will use for
9036 starting and stopping Unix services via the Win32 ServiceControl
9037 API. This allows Windows administrators to utilize the MS
9038 Management Console plug-ins to manage a Unix server running Samba.
9039
9040 The administrator must create a directory name svcctl in Samba's
9041 $(libdir) and create symbolic links to the init scripts in
9042 /etc/init.d/. The name of the links must match the names given as
9043 part of the svcctl list.
9044
9045 Default: svcctl list =
9046
9047 Example: svcctl list = cups postfix portmap httpd
9048
9049 sync always (S)
9050
9051 This is a boolean parameter that controls whether writes will
9052 always be written to stable storage before the write call returns.
9053 If this is no then the server will be guided by the client's
9054 request in each write call (clients can set a bit indicating that a
9055 particular write should be synchronous). If this is yes then every
9056 write will be followed by a fsync() call to ensure the data is
9057 written to disk. Note that the strict sync parameter must be set to
9058 yes in order for this parameter to have any effect.
9059
9060 Default: sync always = no
9061
9062 syslog (G)
9063
9064 This parameter maps how Samba debug messages are logged onto the
9065 system syslog logging levels. Samba debug level zero maps onto
9066 syslog LOG_ERR, debug level one maps onto LOG_WARNING, debug level
9067 two maps onto LOG_NOTICE, debug level three maps onto LOG_INFO. All
9068 higher levels are mapped to LOG_DEBUG.
9069
9070 This parameter sets the threshold for sending messages to syslog.
9071 Only messages with debug level less than this value will be sent to
9072 syslog. There still will be some logging to log.[sn]mbd even if
9073 syslog only is enabled.
9074
9075 The logging parameter should be used instead. When logging is set,
9076 it overrides the syslog parameter.
9077
9078 Default: syslog = 1
9079
9080 syslog only (G)
9081
9082 If this parameter is set then Samba debug messages are logged into
9083 the system syslog only, and not to the debug log files. There still
9084 will be some logging to log.[sn]mbd even if syslog only is enabled.
9085
9086 The logging parameter should be used instead. When logging is set,
9087 it overrides the syslog only parameter.
9088
9089 Default: syslog only = no
9090
9091 template homedir (G)
9092
9093 When filling out the user information for a Windows NT user, the
9094 winbindd(8) daemon uses this parameter to fill in the home
9095 directory for that user. If the string %D is present it is
9096 substituted with the user's Windows NT domain name. If the string
9097 %U is present it is substituted with the user's Windows NT user
9098 name.
9099
9100 Default: template homedir = /home/%D/%U
9101
9102 template shell (G)
9103
9104 When filling out the user information for a Windows NT user, the
9105 winbindd(8) daemon uses this parameter to fill in the login shell
9106 for that user.
9107
9108 Default: template shell = /bin/false
9109
9110 time server (G)
9111
9112 This parameter determines if nmbd(8) advertises itself as a time
9113 server to Windows clients.
9114
9115 Default: time server = no
9116
9117 debug timestamp
9118
9119 This parameter is a synonym for timestamp logs.
9120
9121 timestamp logs (G)
9122
9123 Samba debug log messages are timestamped by default. If you are
9124 running at a high debug level these timestamps can be distracting.
9125 This boolean parameter allows timestamping to be turned off.
9126
9127 Default: timestamp logs = yes
9128
9129 tls cafile (G)
9130
9131 This option can be set to a file (PEM format) containing CA
9132 certificates of root CAs to trust to sign certificates or
9133 intermediate CA certificates.
9134
9135 This path is relative to private dir if the path does not start
9136 with a /.
9137
9138 Default: tls cafile = tls/ca.pem
9139
9140 tls certfile (G)
9141
9142 This option can be set to a file (PEM format) containing the RSA
9143 certificate.
9144
9145 This path is relative to private dir if the path does not start
9146 with a /.
9147
9148 Default: tls certfile = tls/cert.pem
9149
9150 tls crlfile (G)
9151
9152 This option can be set to a file containing a certificate
9153 revocation list (CRL).
9154
9155 This path is relative to private dir if the path does not start
9156 with a /.
9157
9158 Default: tls crlfile =
9159
9160 tls dh params file (G)
9161
9162 This option can be set to a file with Diffie-Hellman parameters
9163 which will be used with DH ciphers.
9164
9165 This path is relative to private dir if the path does not start
9166 with a /.
9167
9168 Default: tls dh params file =
9169
9170 tls enabled (G)
9171
9172 If this option is set to yes, then Samba will use TLS when possible
9173 in communication.
9174
9175 Default: tls enabled = yes
9176
9177 tls keyfile (G)
9178
9179 This option can be set to a file (PEM format) containing the RSA
9180 private key. This file must be accessible without a pass-phrase,
9181 i.e. it must not be encrypted.
9182
9183 This path is relative to private dir if the path does not start
9184 with a /.
9185
9186 Default: tls keyfile = tls/key.pem
9187
9188 tls priority (G)
9189
9190 This option can be set to a string describing the TLS protocols to
9191 be supported in the parts of Samba that use GnuTLS, specifically
9192 the AD DC.
9193
9194 The string is appended to the default priority list of GnuTLS.
9195
9196 The valid options are described in the GNUTLS Priority-Strings
9197 documentation at
9198 http://gnutls.org/manual/html_node/Priority-Strings.html
9199
9200 The SSL3.0 protocol will be disabled.
9201
9202 Default: tls priority = NORMAL:-VERS-SSL3.0
9203
9204 tls verify peer (G)
9205
9206 This controls if and how strict the client will verify the peer's
9207 certificate and name. Possible values are (in increasing order):
9208 no_check, ca_only, ca_and_name_if_available, ca_and_name and
9209 as_strict_as_possible.
9210
9211 When set to no_check the certificate is not verified at all, which
9212 allows trivial man in the middle attacks.
9213
9214 When set to ca_only the certificate is verified to be signed from a
9215 ca specified in the tls ca file option. Setting tls ca file to a
9216 valid file is required. The certificate lifetime is also verified.
9217 If the tls crl file option is configured, the certificate is also
9218 verified against the ca crl.
9219
9220 When set to ca_and_name_if_available all checks from ca_only are
9221 performed. In addition, the peer hostname is verified against the
9222 certificate's name, if it is provided by the application layer and
9223 not given as an ip address string.
9224
9225 When set to ca_and_name all checks from ca_and_name_if_available
9226 are performed. In addition the peer hostname needs to be provided
9227 and even an ip address is checked against the certificate's name.
9228
9229 When set to as_strict_as_possible all checks from ca_and_name are
9230 performed. In addition the tls crl file needs to be configured.
9231 Future versions of Samba may implement additional checks.
9232
9233 Default: tls verify peer = as_strict_as_possible
9234
9235 unicode (G)
9236
9237 Specifies whether the server and client should support unicode.
9238
9239 If this option is set to false, the use of ASCII will be forced.
9240
9241 Default: unicode = yes
9242
9243 unix charset (G)
9244
9245 Specifies the charset the unix machine Samba runs on uses. Samba
9246 needs to know this in order to be able to convert text to the
9247 charsets other SMB clients use.
9248
9249 This is also the charset Samba will use when specifying arguments
9250 to scripts that it invokes.
9251
9252 Default: unix charset = UTF-8
9253
9254 Example: unix charset = ASCII
9255
9256 unix extensions (G)
9257
9258 This boolean parameter controls whether Samba implements the CIFS
9259 UNIX extensions, as defined by HP. These extensions enable Samba to
9260 better serve UNIX CIFS clients by supporting features such as
9261 symbolic links, hard links, etc... These extensions require a
9262 similarly enabled client, and are of no current use to Windows
9263 clients.
9264
9265 Note if this parameter is turned on, the wide links parameter will
9266 automatically be disabled.
9267
9268 See the parameter allow insecure wide links if you wish to change
9269 this coupling between the two parameters.
9270
9271 Default: unix extensions = yes
9272
9273 unix password sync (G)
9274
9275 This boolean parameter controls whether Samba attempts to
9276 synchronize the UNIX password with the SMB password when the
9277 encrypted SMB password in the smbpasswd file is changed. If this is
9278 set to yes the program specified in the passwd program parameter is
9279 called AS ROOT - to allow the new UNIX password to be set without
9280 access to the old UNIX password (as the SMB password change code
9281 has no access to the old password cleartext, only the new).
9282
9283 This option has no effect if samba is running as an active
9284 directory domain controller, in that case have a look at the
9285 password hash gpg key ids option and the samba-tool user
9286 syncpasswords command.
9287
9288 Default: unix password sync = no
9289
9290 use client driver (S)
9291
9292 This parameter applies only to Windows NT/2000 clients. It has no
9293 effect on Windows 95/98/ME clients. When serving a printer to
9294 Windows NT/2000 clients without first installing a valid printer
9295 driver on the Samba host, the client will be required to install a
9296 local printer driver. From this point on, the client will treat the
9297 print as a local printer and not a network printer connection. This
9298 is much the same behavior that will occur when disable spoolss =
9299 yes.
9300
9301 The differentiating factor is that under normal circumstances, the
9302 NT/2000 client will attempt to open the network printer using
9303 MS-RPC. The problem is that because the client considers the
9304 printer to be local, it will attempt to issue the OpenPrinterEx()
9305 call requesting access rights associated with the logged on user.
9306 If the user possesses local administrator rights but not root
9307 privilege on the Samba host (often the case), the OpenPrinterEx()
9308 call will fail. The result is that the client will now display an
9309 "Access Denied; Unable to connect" message in the printer queue
9310 window (even though jobs may successfully be printed).
9311
9312 If this parameter is enabled for a printer, then any attempt to
9313 open the printer with the PRINTER_ACCESS_ADMINISTER right is mapped
9314 to PRINTER_ACCESS_USE instead. Thus allowing the OpenPrinterEx()
9315 call to succeed. This parameter MUST not be enabled on a print
9316 share which has valid print driver installed on the Samba server.
9317
9318 Default: use client driver = no
9319
9320 use mmap (G)
9321
9322 This global parameter determines if the tdb internals of Samba can
9323 depend on mmap working correctly on the running system. Samba
9324 requires a coherent mmap/read-write system memory cache. Currently
9325 only OpenBSD and HPUX do not have such a coherent cache, and on
9326 those platforms this paramter is overridden internally to be
9327 effeceively no. On all systems this parameter should be left alone.
9328 This parameter is provided to help the Samba developers track down
9329 problems with the tdb internal code.
9330
9331 Default: use mmap = yes
9332
9333 username level (G)
9334
9335 This option helps Samba to try and 'guess' at the real UNIX
9336 username, as many DOS clients send an all-uppercase username. By
9337 default Samba tries all lowercase, followed by the username with
9338 the first letter capitalized, and fails if the username is not
9339 found on the UNIX machine.
9340
9341 If this parameter is set to non-zero the behavior changes. This
9342 parameter is a number that specifies the number of uppercase
9343 combinations to try while trying to determine the UNIX user name.
9344 The higher the number the more combinations will be tried, but the
9345 slower the discovery of usernames will be. Use this parameter when
9346 you have strange usernames on your UNIX machine, such as
9347 AstrangeUser .
9348
9349 This parameter is needed only on UNIX systems that have case
9350 sensitive usernames.
9351
9352 Default: username level = 0
9353
9354 Example: username level = 5
9355
9356 username map (G)
9357
9358 This option allows you to specify a file containing a mapping of
9359 usernames from the clients to the server. This can be used for
9360 several purposes. The most common is to map usernames that users
9361 use on DOS or Windows machines to those that the UNIX box uses. The
9362 other is to map multiple users to a single username so that they
9363 can more easily share files.
9364
9365 Please note that for user mode security, the username map is
9366 applied prior to validating the user credentials. Domain member
9367 servers (domain or ads) apply the username map after the user has
9368 been successfully authenticated by the domain controller and
9369 require fully qualified entries in the map table (e.g. biddle =
9370 DOMAIN\foo).
9371
9372 The map file is parsed line by line. Each line should contain a
9373 single UNIX username on the left then a '=' followed by a list of
9374 usernames on the right. The list of usernames on the right may
9375 contain names of the form @group in which case they will match any
9376 UNIX username in that group. The special client name '*' is a
9377 wildcard and matches any name. Each line of the map file may be up
9378 to 1023 characters long.
9379
9380 The file is processed on each line by taking the supplied username
9381 and comparing it with each username on the right hand side of the
9382 '=' signs. If the supplied name matches any of the names on the
9383 right hand side then it is replaced with the name on the left.
9384 Processing then continues with the next line.
9385
9386 If any line begins with a '#' or a ';' then it is ignored.
9387
9388 If any line begins with an '!' then the processing will stop after
9389 that line if a mapping was done by the line. Otherwise mapping
9390 continues with every line being processed. Using '!' is most useful
9391 when you have a wildcard mapping line later in the file.
9392
9393 For example to map from the name admin or administrator to the UNIX
9394 name
9395 root you would use:
9396
9397 root = admin administrator
9398
9399 Or to map anyone in the UNIX group system to the UNIX name sys you
9400 would use:
9401
9402 sys = @system
9403
9404 You can have as many mappings as you like in a username map file.
9405
9406 If your system supports the NIS NETGROUP option then the netgroup
9407 database is checked before the /etc/group database for matching
9408 groups.
9409
9410 You can map Windows usernames that have spaces in them by using
9411 double quotes around the name. For example:
9412
9413 tridge = "Andrew Tridgell"
9414
9415 would map the windows username "Andrew Tridgell" to the unix
9416 username "tridge".
9417
9418 The following example would map mary and fred to the unix user sys,
9419 and map the rest to guest. Note the use of the '!' to tell Samba to
9420 stop processing if it gets a match on that line:
9421
9422 !sys = mary fred
9423 guest = *
9424
9425 Note that the remapping is applied to all occurrences of usernames.
9426 Thus if you connect to \\server\fred and fred is remapped to mary
9427 then you will actually be connecting to \\server\mary and will need
9428 to supply a password suitable for mary not fred. The only exception
9429 to this is the username passed to a Domain Controller (if you have
9430 one). The DC will receive whatever username the client supplies
9431 without modification.
9432
9433 Also note that no reverse mapping is done. The main effect this has
9434 is with printing. Users who have been mapped may have trouble
9435 deleting print jobs as PrintManager under WfWg will think they
9436 don't own the print job.
9437
9438 Samba versions prior to 3.0.8 would only support reading the fully
9439 qualified username (e.g.: DOMAIN\user) from the username map when
9440 performing a kerberos login from a client. However, when looking up
9441 a map entry for a user authenticated by NTLM[SSP], only the login
9442 name would be used for matches. This resulted in inconsistent
9443 behavior sometimes even on the same server.
9444
9445 The following functionality is obeyed in version 3.0.8 and later:
9446
9447 When performing local authentication, the username map is applied
9448 to the login name before attempting to authenticate the connection.
9449
9450 When relying upon a external domain controller for validating
9451 authentication requests, smbd will apply the username map to the
9452 fully qualified username (i.e. DOMAIN\user) only after the user
9453 has been successfully authenticated.
9454
9455 An example of use is:
9456
9457 username map = /usr/local/samba/lib/users.map
9458
9459 Default: username map = # no username map
9460
9461 username map cache time (G)
9462
9463 Mapping usernames with the username map or username map script
9464 features of Samba can be relatively expensive. During login of a
9465 user, the mapping is done several times. In particular, calling the
9466 username map script can slow down logins if external databases have
9467 to be queried from the script being called.
9468
9469 The parameter username map cache time controls a mapping cache. It
9470 specifies the number of seconds a mapping from the username map
9471 file or script is to be efficiently cached. The default of 0 means
9472 no caching is done.
9473
9474 Default: username map cache time = 0
9475
9476 Example: username map cache time = 60
9477
9478 username map script (G)
9479
9480 This script is a mutually exclusive alternative to the username map
9481 parameter. This parameter specifies and external program or script
9482 that must accept a single command line option (the username
9483 transmitted in the authentication request) and return a line on
9484 standard output (the name to which the account should mapped). In
9485 this way, it is possible to store username map tables in an LDAP or
9486 NIS directory services.
9487
9488 Default: username map script =
9489
9490 Example: username map script = /etc/samba/scripts/mapusers.sh
9491
9492 usershare allow guests (G)
9493
9494 This parameter controls whether user defined shares are allowed to
9495 be accessed by non-authenticated users or not. It is the equivalent
9496 of allowing people who can create a share the option of setting
9497 guest ok = yes in a share definition. Due to its security sensitive
9498 nature, the default is set to off.
9499
9500 Default: usershare allow guests = no
9501
9502 usershare max shares (G)
9503
9504 This parameter specifies the number of user defined shares that are
9505 allowed to be created by users belonging to the group owning the
9506 usershare directory. If set to zero (the default) user defined
9507 shares are ignored.
9508
9509 Default: usershare max shares = 0
9510
9511 usershare owner only (G)
9512
9513 This parameter controls whether the pathname exported by a user
9514 defined shares must be owned by the user creating the user defined
9515 share or not. If set to True (the default) then smbd checks that
9516 the directory path being shared is owned by the user who owns the
9517 usershare file defining this share and refuses to create the share
9518 if not. If set to False then no such check is performed and any
9519 directory path may be exported regardless of who owns it.
9520
9521 Default: usershare owner only = yes
9522
9523 usershare path (G)
9524
9525 This parameter specifies the absolute path of the directory on the
9526 filesystem used to store the user defined share definition files.
9527 This directory must be owned by root, and have no access for other,
9528 and be writable only by the group owner. In addition the "sticky"
9529 bit must also be set, restricting rename and delete to owners of a
9530 file (in the same way the /tmp directory is usually configured).
9531 Members of the group owner of this directory are the users allowed
9532 to create usershares.
9533
9534 For example, a valid usershare directory might be
9535 /usr/local/samba/lib/usershares, set up as follows.
9536
9537 ls -ld /usr/local/samba/lib/usershares/
9538 drwxrwx--T 2 root power_users 4096 2006-05-05 12:27 /usr/local/samba/lib/usershares/
9539
9540
9541 In this case, only members of the group "power_users" can create
9542 user defined shares.
9543
9544 Default: usershare path = /var/lib/samba/usershares
9545
9546 usershare prefix allow list (G)
9547
9548 This parameter specifies a list of absolute pathnames the root of
9549 which are allowed to be exported by user defined share definitions.
9550 If the pathname to be exported doesn't start with one of the
9551 strings in this list, the user defined share will not be allowed.
9552 This allows the Samba administrator to restrict the directories on
9553 the system that can be exported by user defined shares.
9554
9555 If there is a "usershare prefix deny list" and also a "usershare
9556 prefix allow list" the deny list is processed first, followed by
9557 the allow list, thus leading to the most restrictive
9558 interpretation.
9559
9560 Default: usershare prefix allow list =
9561
9562 Example: usershare prefix allow list = /home /data /space
9563
9564 usershare prefix deny list (G)
9565
9566 This parameter specifies a list of absolute pathnames the root of
9567 which are NOT allowed to be exported by user defined share
9568 definitions. If the pathname exported starts with one of the
9569 strings in this list the user defined share will not be allowed.
9570 Any pathname not starting with one of these strings will be allowed
9571 to be exported as a usershare. This allows the Samba administrator
9572 to restrict the directories on the system that can be exported by
9573 user defined shares.
9574
9575 If there is a "usershare prefix deny list" and also a "usershare
9576 prefix allow list" the deny list is processed first, followed by
9577 the allow list, thus leading to the most restrictive
9578 interpretation.
9579
9580 Default: usershare prefix deny list =
9581
9582 Example: usershare prefix deny list = /etc /dev /private
9583
9584 usershare template share (G)
9585
9586 User defined shares only have limited possible parameters such as
9587 path, guest ok, etc. This parameter allows usershares to "cloned"
9588 from an existing share. If "usershare template share" is set to the
9589 name of an existing share, then all usershares created have their
9590 defaults set from the parameters set on this share.
9591
9592 The target share may be set to be invalid for real file sharing by
9593 setting the parameter "-valid = False" on the template share
9594 definition. This causes it not to be seen as a real exported share
9595 but to be able to be used as a template for usershares.
9596
9597 Default: usershare template share =
9598
9599 Example: usershare template share = template_share
9600
9601 use sendfile (S)
9602
9603 If this parameter is yes, and the sendfile() system call is
9604 supported by the underlying operating system, then some SMB read
9605 calls (mainly ReadAndX and ReadRaw) will use the more efficient
9606 sendfile system call for files that are exclusively oplocked. This
9607 may make more efficient use of the system CPU's and cause Samba to
9608 be faster. Samba automatically turns this off for clients that use
9609 protocol levels lower than NT LM 0.12 and when it detects a client
9610 is Windows 9x (using sendfile from Linux will cause these clients
9611 to fail).
9612
9613 Default: use sendfile = no
9614
9615 utmp (G)
9616
9617 This boolean parameter is only available if Samba has been
9618 configured and compiled with the option --with-utmp. If set to yes
9619 then Samba will attempt to add utmp or utmpx records (depending on
9620 the UNIX system) whenever a connection is made to a Samba server.
9621 Sites may use this to record the user connecting to a Samba share.
9622
9623 Due to the requirements of the utmp record, we are required to
9624 create a unique identifier for the incoming user. Enabling this
9625 option creates an n^2 algorithm to find this number. This may
9626 impede performance on large installations.
9627
9628 Default: utmp = no
9629
9630 utmp directory (G)
9631
9632 This parameter is only available if Samba has been configured and
9633 compiled with the option --with-utmp. It specifies a directory
9634 pathname that is used to store the utmp or utmpx files (depending
9635 on the UNIX system) that record user connections to a Samba server.
9636 By default this is not set, meaning the system will use whatever
9637 utmp file the native system is set to use (usually /var/run/utmp on
9638 Linux).
9639
9640 Default: utmp directory = # Determined automatically
9641
9642 Example: utmp directory = /var/run/utmp
9643
9644 -valid (S)
9645
9646 This parameter indicates whether a share is valid and thus can be
9647 used. When this parameter is set to false, the share will be in no
9648 way visible nor accessible.
9649
9650 This option should not be used by regular users but might be of
9651 help to developers. Samba uses this option internally to mark
9652 shares as deleted.
9653
9654 Default: -valid = yes
9655
9656 valid users (S)
9657
9658 This is a list of users that should be allowed to login to this
9659 service. Names starting with '@', '+' and '&' are interpreted using
9660 the same rules as described in the invalid users parameter.
9661
9662 If this is empty (the default) then any user can login. If a
9663 username is in both this list and the invalid users list then
9664 access is denied for that user.
9665
9666 The current servicename is substituted for %S. This is useful in
9667 the [homes] section.
9668
9669 Note: When used in the [global] section this parameter may have
9670 unwanted side effects. For example: If samba is configured as a
9671 MASTER BROWSER (see local master, os level, domain master,
9672 preferred master) this option will prevent workstations from being
9673 able to browse the network.
9674
9675 Default: valid users = # No valid users list (anyone can login)
9676
9677 Example: valid users = greg, @pcusers
9678
9679 veto files (S)
9680
9681 This is a list of files and directories that are neither visible
9682 nor accessible. Each entry in the list must be separated by a '/',
9683 which allows spaces to be included in the entry. '*' and '?' can be
9684 used to specify multiple files or directories as in DOS wildcards.
9685
9686 Each entry must be a unix path, not a DOS path and must not include
9687 the unix directory separator '/'.
9688
9689 Note that the case sensitive option is applicable in vetoing files.
9690
9691 One feature of the veto files parameter that it is important to be
9692 aware of is Samba's behaviour when trying to delete a directory. If
9693 a directory that is to be deleted contains nothing but veto files
9694 this deletion will fail unless you also set the delete veto files
9695 parameter to yes.
9696
9697 Setting this parameter will affect the performance of Samba, as it
9698 will be forced to check all files and directories for a match as
9699 they are scanned.
9700
9701 Examples of use include:
9702
9703 ; Veto any files containing the word Security,
9704 ; any ending in .tmp, and any directory containing the
9705 ; word root.
9706 veto files = /*Security*/*.tmp/*root*/
9707
9708 ; Veto the Apple specific files that a NetAtalk server
9709 ; creates.
9710 veto files = /.AppleDouble/.bin/.AppleDesktop/Network Trash Folder/
9711
9712 Default: veto files = # No files or directories are vetoed
9713
9714 veto oplock files (S)
9715
9716 This parameter is only valid when the oplocks parameter is turned
9717 on for a share. It allows the Samba administrator to selectively
9718 turn off the granting of oplocks on selected files that match a
9719 wildcarded list, similar to the wildcarded list used in the veto
9720 files parameter.
9721
9722 You might want to do this on files that you know will be heavily
9723 contended for by clients. A good example of this is in the NetBench
9724 SMB benchmark program, which causes heavy client contention for
9725 files ending in .SEM. To cause Samba not to grant oplocks on these
9726 files you would use the line (either in the [global] section or in
9727 the section for the particular NetBench share.
9728
9729 An example of use is:
9730
9731 veto oplock files = /.*SEM/
9732
9733 Default: veto oplock files = # No files are vetoed for oplock
9734 grants
9735
9736 vfs object
9737
9738 This parameter is a synonym for vfs objects.
9739
9740 vfs objects (S)
9741
9742 This parameter specifies the backend names which are used for Samba
9743 VFS I/O operations. By default, normal disk I/O operations are used
9744 but these can be overloaded with one or more VFS objects. Be aware
9745 that the definition of this parameter will overwrite a possible
9746 previous definition of the vfs objects parameter.
9747
9748 Default: vfs objects =
9749
9750 Example: vfs objects = extd_audit recycle
9751
9752 volume (S)
9753
9754 This allows you to override the volume label returned for a share.
9755 Useful for CDROMs with installation programs that insist on a
9756 particular volume label.
9757
9758 Default: volume = # the name of the share
9759
9760 wide links (S)
9761
9762 This parameter controls whether or not links in the UNIX file
9763 system may be followed by the server. Links that point to areas
9764 within the directory tree exported by the server are always
9765 allowed; this parameter controls access only to areas that are
9766 outside the directory tree being exported.
9767
9768 Note: Turning this parameter on when UNIX extensions are enabled
9769 will allow UNIX clients to create symbolic links on the share that
9770 can point to files or directories outside restricted path exported
9771 by the share definition. This can cause access to areas outside of
9772 the share. Due to this problem, this parameter will be
9773 automatically disabled (with a message in the log file) if the unix
9774 extensions option is on.
9775
9776 See the parameter allow insecure wide links if you wish to change
9777 this coupling between the two parameters.
9778
9779 Default: wide links = no
9780
9781 winbind cache time (G)
9782
9783 This parameter specifies the number of seconds the winbindd(8)
9784 daemon will cache user and group information before querying a
9785 Windows NT server again.
9786
9787 This does not apply to authentication requests, these are always
9788 evaluated in real time unless the winbind offline logon option has
9789 been enabled.
9790
9791 Default: winbind cache time = 300
9792
9793 winbindd socket directory (G)
9794
9795 This setting controls the location of the winbind daemon's socket.
9796
9797 Except within automated test scripts, this should not be altered,
9798 as the client tools (nss_winbind etc) do not honour this parameter.
9799 Client tools must then be advised of the altered path with the
9800 WINBINDD_SOCKET_DIR environment variable.
9801
9802 Default: winbindd socket directory = /run/samba/winbindd
9803
9804 winbind enum groups (G)
9805
9806 On large installations using winbindd(8) it may be necessary to
9807 suppress the enumeration of groups through the setgrent(),
9808 getgrent() and endgrent() group of system calls. If the winbind
9809 enum groups parameter is no, calls to the getgrent() system call
9810 will not return any data.
9811
9812 Warning
9813 Turning off group enumeration may cause some programs to behave
9814 oddly.
9815 Default: winbind enum groups = no
9816
9817 winbind enum users (G)
9818
9819 On large installations using winbindd(8) it may be necessary to
9820 suppress the enumeration of users through the setpwent(),
9821 getpwent() and endpwent() group of system calls. If the winbind
9822 enum users parameter is no, calls to the getpwent system call will
9823 not return any data.
9824
9825 Warning
9826 Turning off user enumeration may cause some programs to behave
9827 oddly. For example, the finger program relies on having access
9828 to the full user list when searching for matching usernames.
9829 Default: winbind enum users = no
9830
9831 winbind expand groups (G)
9832
9833 This option controls the maximum depth that winbindd will traverse
9834 when flattening nested group memberships of Windows domain groups.
9835 This is different from the winbind nested groups option which
9836 implements the Windows NT4 model of local group nesting. The
9837 "winbind expand groups" parameter specifically applies to the
9838 membership of domain groups.
9839
9840 This option also affects the return of non nested group memberships
9841 of Windows domain users. With the new default "winbind expand
9842 groups = 0" winbind does not query group memberships at all.
9843
9844 Be aware that a high value for this parameter can result in system
9845 slowdown as the main parent winbindd daemon must perform the group
9846 unrolling and will be unable to answer incoming NSS or
9847 authentication requests during this time.
9848
9849 The default value was changed from 1 to 0 with Samba 4.2. Some
9850 broken applications (including some implementations of newgrp and
9851 sg) calculate the group memberships of users by traversing groups,
9852 such applications will require "winbind expand groups = 1". But the
9853 new default makes winbindd more reliable as it doesn't require SAMR
9854 access to domain controllers of trusted domains.
9855
9856 Default: winbind expand groups = 0
9857
9858 winbind:ignore domains (G)
9859
9860 Allows one to enter a list of trusted domains winbind should ignore
9861 (untrust). This can avoid the overhead of resources from attempting
9862 to login to DCs that should not be communicated with.
9863
9864 Default: winbind:ignore domains =
9865
9866 Example: winbind:ignore domains = DOMAIN1, DOMAIN2
9867
9868 winbind max clients (G)
9869
9870 This parameter specifies the maximum number of clients the
9871 winbindd(8) daemon can connect with. The parameter is not a hard
9872 limit. The winbindd(8) daemon configures itself to be able to
9873 accept at least that many connections, and if the limit is reached,
9874 an attempt is made to disconnect idle clients.
9875
9876 Default: winbind max clients = 200
9877
9878 winbind max domain connections (G)
9879
9880 This parameter specifies the maximum number of simultaneous
9881 connections that the winbindd(8) daemon should open to the domain
9882 controller of one domain. Setting this parameter to a value greater
9883 than 1 can improve scalability with many simultaneous winbind
9884 requests, some of which might be slow.
9885
9886 Note that if winbind offline logon is set to Yes, then only one DC
9887 connection is allowed per domain, regardless of this setting.
9888
9889 Default: winbind max domain connections = 1
9890
9891 Example: winbind max domain connections = 10
9892
9893 winbind nested groups (G)
9894
9895 If set to yes, this parameter activates the support for nested
9896 groups. Nested groups are also called local groups or aliases. They
9897 work like their counterparts in Windows: Nested groups are defined
9898 locally on any machine (they are shared between DC's through their
9899 SAM) and can contain users and global groups from any trusted SAM.
9900 To be able to use nested groups, you need to run nss_winbind.
9901
9902 Default: winbind nested groups = yes
9903
9904 winbind normalize names (G)
9905
9906 This parameter controls whether winbindd will replace whitespace in
9907 user and group names with an underscore (_) character. For example,
9908 whether the name "Space Kadet" should be replaced with the string
9909 "space_kadet". Frequently Unix shell scripts will have difficulty
9910 with usernames contains whitespace due to the default field
9911 separator in the shell. If your domain possesses names containing
9912 the underscore character, this option may cause problems unless the
9913 name aliasing feature is supported by your nss_info plugin.
9914
9915 This feature also enables the name aliasing API which can be used
9916 to make domain user and group names to a non-qualified version.
9917 Please refer to the manpage for the configured idmap and nss_info
9918 plugin for the specifics on how to configure name aliasing for a
9919 specific configuration. Name aliasing takes precedence (and is
9920 mutually exclusive) over the whitespace replacement mechanism
9921 discussed previously.
9922
9923 Default: winbind normalize names = no
9924
9925 Example: winbind normalize names = yes
9926
9927 winbind nss info (G)
9928
9929 This parameter is designed to control how Winbind retrieves Name
9930 Service Information to construct a user's home directory and login
9931 shell. Currently the following settings are available:
9932
9933 · template - The default, using the parameters of template
9934 shell and template homedir)
9935
9936 · <sfu | sfu20 | rfc2307 > - When Samba is running in
9937 security = ads and your Active Directory Domain
9938 Controller does support the Microsoft "Services for
9939 Unix" (SFU) LDAP schema, winbind can retrieve the login
9940 shell and the home directory attributes directly from
9941 your Directory Server. For SFU 3.0 or 3.5 simply choose
9942 "sfu", if you use SFU 2.0 please choose "sfu20".
9943
9944 Note that for the idmap backend idmap_ad you need to
9945 configure those settings in the idmap configuration
9946 section. Make sure to consult the documentation of the
9947 idmap backend that you are using.
9948
9949
9950 Default: winbind nss info = template
9951
9952 Example: winbind nss info = sfu
9953
9954 winbind offline logon (G)
9955
9956 This parameter is designed to control whether Winbind should allow
9957 one to login with the pam_winbind module using Cached Credentials.
9958 If enabled, winbindd will store user credentials from successful
9959 logins encrypted in a local cache.
9960
9961 Default: winbind offline logon = no
9962
9963 Example: winbind offline logon = yes
9964
9965 winbind reconnect delay (G)
9966
9967 This parameter specifies the number of seconds the winbindd(8)
9968 daemon will wait between attempts to contact a Domain controller
9969 for a domain that is determined to be down or not contactable.
9970
9971 Default: winbind reconnect delay = 30
9972
9973 winbind refresh tickets (G)
9974
9975 This parameter is designed to control whether Winbind should
9976 refresh Kerberos Tickets retrieved using the pam_winbind module.
9977
9978 Default: winbind refresh tickets = no
9979
9980 Example: winbind refresh tickets = yes
9981
9982 winbind request timeout (G)
9983
9984 This parameter specifies the number of seconds the winbindd(8)
9985 daemon will wait before disconnecting either a client connection
9986 with no outstanding requests (idle) or a client connection with a
9987 request that has remained outstanding (hung) for longer than this
9988 number of seconds.
9989
9990 Default: winbind request timeout = 60
9991
9992 winbind rpc only (G)
9993
9994 Setting this parameter to yes forces winbindd to use RPC instead of
9995 LDAP to retrieve information from Domain Controllers.
9996
9997 Default: winbind rpc only = no
9998
9999 winbind scan trusted domains (G)
10000
10001 This option only takes effect when the security option is set to
10002 domain or ads. If it is set to yes (the default), winbindd
10003 periodically tries to scan for new trusted domains and adds them to
10004 a global list inside of winbindd. The list can be extracted with
10005 wbinfo --trusted-domains --verbose. This matches the behaviour of
10006 Samba 4.7 and older.
10007
10008 The construction of that global list is not reliable and often
10009 incomplete in complex trust setups. In most situations the list is
10010 not needed any more for winbindd to operate correctly. E.g. for
10011 plain file serving via SMB using a simple idmap setup with autorid,
10012 tdb or ad. However some more complex setups require the list, e.g.
10013 if you specify idmap backends for specific domains. Some
10014 pam_winbind setups may also require the global list.
10015
10016 If you have a setup that doesn't require the global list, you
10017 should set winbind scan trusted domains = no.
10018
10019 Default: winbind scan trusted domains = yes
10020
10021 winbind sealed pipes (G)
10022
10023 This option controls whether any requests from winbindd to domain
10024 controllers pipe will be sealed. Disabling sealing can be useful
10025 for debugging purposes.
10026
10027 The behavior can be controlled per netbios domain by using 'winbind
10028 sealed pipes:NETBIOSDOMAIN = no' as option.
10029
10030 Default: winbind sealed pipes = yes
10031
10032 winbind separator (G)
10033
10034 This parameter allows an admin to define the character used when
10035 listing a username of the form of DOMAIN \user. This parameter is
10036 only applicable when using the pam_winbind.so and nss_winbind.so
10037 modules for UNIX services.
10038
10039 Please note that setting this parameter to + causes problems with
10040 group membership at least on glibc systems, as the character + is
10041 used as a special character for NIS in /etc/group.
10042
10043 Default: winbind separator = \
10044
10045 Example: winbind separator = +
10046
10047 winbind use default domain (G)
10048
10049 This parameter specifies whether the winbindd(8) daemon should
10050 operate on users without domain component in their username. Users
10051 without a domain component are treated as is part of the winbindd
10052 server's own domain. While this does not benefit Windows users, it
10053 makes SSH, FTP and e-mail function in a way much closer to the way
10054 they would in a native unix system.
10055
10056 This option should be avoided if possible. It can cause confusion
10057 about responsibilities for a user or group. In many situations it
10058 is not clear whether winbind or /etc/passwd should be seen as
10059 authoritative for a user, likewise for groups.
10060
10061 Default: winbind use default domain = no
10062
10063 Example: winbind use default domain = yes
10064
10065 winbind use krb5 enterprise principals (G)
10066
10067 winbindd is able to get kerberos tickets for pam_winbind with
10068 krb5_auth or wbinfo -K/--krb5auth=.
10069
10070 winbindd (at least on a domain member) is never be able to have a
10071 complete picture of the trust topology (which is managed by the
10072 DCs). There might be uPNSuffixes and msDS-SPNSuffixes values, which
10073 don't belong to any AD domain at all.
10074
10075 With winbind scan trusted domains = no winbindd don't even get an
10076 incomplete picture of the topology.
10077
10078 It is not really required to know about the trust topology. We can
10079 just rely on the [K]DCs of our primary domain (e.g.
10080 PRIMARY.A.EXAMPLE.COM) and use enterprise principals e.g.
10081 upnfromB@B.EXAMPLE.COM@PRIMARY.A.EXAMPLE.COM and follow the
10082 WRONG_REALM referrals in order to find the correct DC. The final
10083 principal might be userfromB@INTERNALB.EXAMPLE.PRIVATE.
10084
10085 With winbind use krb5 enterprise principals = yes winbindd
10086 enterprise principals will be used.
10087
10088 Default: winbind use krb5 enterprise principals = no
10089
10090 Example: winbind use krb5 enterprise principals = yes
10091
10092 winsdb:local_owner (G)
10093
10094 This specifies the address that is stored in the winsOwner
10095 attribute, of locally registered winsRecord-objects. The default is
10096 to use the ip-address of the first network interface.
10097
10098 No default
10099
10100 winsdb:dbnosync (G)
10101
10102 This parameter disables fsync() after changes of the WINS database.
10103
10104 Default: winsdb:dbnosync = no
10105
10106 wins hook (G)
10107
10108 When Samba is running as a WINS server this allows you to call an
10109 external program for all changes to the WINS database. The primary
10110 use for this option is to allow the dynamic update of external name
10111 resolution databases such as dynamic DNS.
10112
10113 The wins hook parameter specifies the name of a script or
10114 executable that will be called as follows:
10115
10116 wins_hook operation name nametype ttl IP_list
10117
10118 · The first argument is the operation and is one of "add",
10119 "delete", or "refresh". In most cases the operation can
10120 be ignored as the rest of the parameters provide
10121 sufficient information. Note that "refresh" may
10122 sometimes be called when the name has not previously
10123 been added, in that case it should be treated as an add.
10124
10125 · The second argument is the NetBIOS name. If the name is
10126 not a legal name then the wins hook is not called. Legal
10127 names contain only letters, digits, hyphens, underscores
10128 and periods.
10129
10130 · The third argument is the NetBIOS name type as a 2 digit
10131 hexadecimal number.
10132
10133 · The fourth argument is the TTL (time to live) for the
10134 name in seconds.
10135
10136 · The fifth and subsequent arguments are the IP addresses
10137 currently registered for that name. If this list is
10138 empty then the name should be deleted.
10139
10140 An example script that calls the BIND dynamic DNS update program
10141 nsupdate is provided in the examples directory of the Samba source
10142 code.
10143
10144 No default
10145
10146 wins proxy (G)
10147
10148 This is a boolean that controls if nmbd(8) will respond to
10149 broadcast name queries on behalf of other hosts. You may need to
10150 set this to yes for some older clients.
10151
10152 Default: wins proxy = no
10153
10154 wins server (G)
10155
10156 This specifies the IP address (or DNS name: IP address for
10157 preference) of the WINS server that nmbd(8) should register with.
10158 If you have a WINS server on your network then you should set this
10159 to the WINS server's IP.
10160
10161 You should point this at your WINS server if you have a
10162 multi-subnetted network.
10163
10164 If you want to work in multiple namespaces, you can give every wins
10165 server a 'tag'. For each tag, only one (working) server will be
10166 queried for a name. The tag should be separated from the ip address
10167 by a colon.
10168
10169 Note
10170 You need to set up Samba to point to a WINS server if you have
10171 multiple subnets and wish cross-subnet browsing to work
10172 correctly.
10173 See the chapter in the Samba3-HOWTO on Network Browsing.
10174
10175 Default: wins server =
10176
10177 Example: wins server = mary:192.9.200.1 fred:192.168.3.199
10178 mary:192.168.2.61 # For this example when querying a certain name,
10179 192.19.200.1 will be asked first and if that doesn't respond
10180 192.168.2.61. If either of those doesn't know the name
10181 192.168.3.199 will be queried.
10182
10183 Example: wins server = 192.9.200.1 192.168.2.61
10184
10185 wins support (G)
10186
10187 This boolean controls if the nmbd(8) process in Samba will act as a
10188 WINS server. You should not set this to yes unless you have a
10189 multi-subnetted network and you wish a particular nmbd to be your
10190 WINS server. Note that you should NEVER set this to yes on more
10191 than one machine in your network.
10192
10193 Default: wins support = no
10194
10195 workgroup (G)
10196
10197 This controls what workgroup your server will appear to be in when
10198 queried by clients. Note that this parameter also controls the
10199 Domain name used with the security = domain setting.
10200
10201 Default: workgroup = WORKGROUP
10202
10203 Example: workgroup = MYGROUP
10204
10205 wreplsrv:periodic_interval (G)
10206
10207 This maximum interval in seconds between 2 periodically scheduled
10208 runs where we check for wins.ldb changes and do push notifications
10209 to our push partners. Also wins_config.ldb changes are checked in
10210 that interval and partner configuration reloads are done.
10211
10212 Default: wreplsrv:periodic_interval = 15
10213
10214 wreplsrv:propagate name releases (G)
10215
10216 If this parameter is enabled, then explicit (from the client) and
10217 implicit (via the scavenging) name releases are propagated to the
10218 other servers directly, even if there are still other addresses
10219 active, this applies to SPECIAL GROUP (2) and MULTIHOMED (3)
10220 entries. Also the replication conflict merge algorithm for SPECIAL
10221 GROUP (2) entries discards replica addresses where the address
10222 owner is the local server, if the address was not stored locally
10223 before. The merge result is propagated directly in case an address
10224 was discarded. A Windows servers doesn't propagate name releases of
10225 SPECIAL GROUP (2) and MULTIHOMED (3) entries directly, which means
10226 that Windows servers may return different results to name queries
10227 for SPECIAL GROUP (2) and MULTIHOMED (3) names. The option doesn't
10228 have much negative impact if Windows servers are around, but be
10229 aware that they might return unexpected results.
10230
10231 Default: wreplsrv:propagate name releases = no
10232
10233 wreplsrv:scavenging_interval (G)
10234
10235 This is the interval in s between 2 scavenging runs which clean up
10236 the WINS database and changes the states of expired name records.
10237 Defaults to half of the value of wreplsrv:renew_interval.
10238
10239 No default
10240
10241 wreplsrv:tombstone_extra_timeout (G)
10242
10243 This is the time in s the server needs to be up till we'll remove
10244 tombstone records from our database. Defaults to 3 days.
10245
10246 Default: wreplsrv:tombstone_extra_timeout = 259200
10247
10248 wreplsrv:tombstone_interval (G)
10249
10250 This is the interval in s till released records of the WINS server
10251 become tombstone. Defaults to 6 days.
10252
10253 Default: wreplsrv:tombstone_interval = 518400
10254
10255 wreplsrv:tombstone_timeout (G)
10256
10257 This is the interval in s till tombstone records are deleted from
10258 the WINS database. Defaults to 1 day.
10259
10260 Default: wreplsrv:tombstone_timeout = 86400
10261
10262 wreplsrv:verify_interval (G)
10263
10264 This is the interval in s till we verify active replica records
10265 with the owning WINS server. Unfortunately not implemented yet.
10266 Defaults to 24 days.
10267
10268 Default: wreplsrv:verify_interval = 2073600
10269
10270 writable
10271
10272 This parameter is a synonym for writeable.
10273
10274 write ok
10275
10276 This parameter is a synonym for writeable.
10277
10278 writeable (S)
10279
10280 Inverted synonym for read only.
10281
10282 Default: writeable = no
10283
10284 write list (S)
10285
10286 This is a list of users that are given read-write access to a
10287 service. If the connecting user is in this list then they will be
10288 given write access, no matter what the read only option is set to.
10289 The list can include group names using the @group syntax.
10290
10291 Note that if a user is in both the read list and the write list
10292 then they will be given write access.
10293
10294 Default: write list =
10295
10296 Example: write list = admin, root, @staff
10297
10298 write raw (G)
10299
10300 This is ignored if async smb echo handler is set, because this
10301 feature is incompatible with raw write SMB requests
10302
10303 If enabled, raw writes allow writes of 65535 bytes in one packet.
10304 This typically provides a major performance benefit for some very,
10305 very old clients.
10306
10307 However, some clients either negotiate the allowable block size
10308 incorrectly or are incapable of supporting larger block sizes, and
10309 for these clients you may need to disable raw writes.
10310
10311 In general this parameter should be viewed as a system tuning tool
10312 and left severely alone.
10313
10314 Default: write raw = yes
10315
10316 wtmp directory (G)
10317
10318 This parameter is only available if Samba has been configured and
10319 compiled with the option --with-utmp. It specifies a directory
10320 pathname that is used to store the wtmp or wtmpx files (depending
10321 on the UNIX system) that record user connections to a Samba server.
10322 The difference with the utmp directory is the fact that user info
10323 is kept after a user has logged out.
10324
10325 By default this is not set, meaning the system will use whatever
10326 utmp file the native system is set to use (usually /var/run/wtmp on
10327 Linux).
10328
10329 Default: wtmp directory =
10330
10331 Example: wtmp directory = /var/log/wtmp
10332
10334 Although the configuration file permits service names to contain
10335 spaces, your client software may not. Spaces will be ignored in
10336 comparisons anyway, so it shouldn't be a problem - but be aware of the
10337 possibility.
10338
10339 On a similar note, many clients - especially DOS clients - limit
10340 service names to eight characters. smbd(8) has no such limitation, but
10341 attempts to connect from such clients will fail if they truncate the
10342 service names. For this reason you should probably keep your service
10343 names down to eight characters in length.
10344
10345 Use of the [homes] and [printers] special sections make life for an
10346 administrator easy, but the various combinations of default attributes
10347 can be tricky. Take extreme care when designing these sections. In
10348 particular, ensure that the permissions on spool directories are
10349 correct.
10350
10352 This man page is part of version 4.13.7 of the Samba suite.
10353
10355 samba(7), smbpasswd(8), smbd(8), nmbd(8), winbindd(8), samba(8), samba-
10356 tool(8), smbclient(1), nmblookup(1), testparm(1).
10357
10359 The original Samba software and related utilities were created by
10360 Andrew Tridgell. Samba is now developed by the Samba Team as an Open
10361 Source project similar to the way the Linux kernel is developed.
10362
10363
10364
10365Samba 4.13.7 03/25/2021 SMB.CONF(5)