1SMB.CONF(5) File Formats and Conventions SMB.CONF(5)
2
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 • 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 • 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 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 name = value
39 The file is line-based - that is, each newline-terminated line
41 represents either a comment, a section name or a parameter.
42 Section and parameter names are not case sensitive.
44 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 Any line beginning with a semicolon (“;”) or a hash (“#”) character is
52 ignored, as are lines containing only whitespace.
53 Any line ending in a “\” is continued on the next line in the customary
55 UNIX fashion.
56 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 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 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 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 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 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 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 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 [foo]
101 path = /home/bar
102 read only = no
103 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 [aprinter]
111 path = /var/tmp
112 read only = yes
113 printable = yes
114 guest ok = yes
115
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 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 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 Some modifications are then made to the newly created share:
135 • The share name is changed from homes to the located
137 username.
138 • If no path was given, the path is set to the user's home
140 directory.
141 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 path = /data/pchome/%S
147 is useful if you have different home directories for your PCs than for
149 UNIX access.
150 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 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 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 [homes]
164 read only = no
165 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 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 The [printers] section
177 This section works like [homes], but for printers.
178 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 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 A few modifications are then made to the newly created share:
192 • The share name is set to the located printer name
194 • If no printer name was given, the printer name is set to the
196 located printer name
197 • If the share does not permit guest access and no username
199 was given, the username is set to the located printer name.
200 The [printers] service MUST be printable - if you specify otherwise,
203 the server will refuse to load the configuration file.
204 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 [printers]
210 path = /var/tmp
211 guest ok = yes
212 printable = yes
213 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 alias|alias|alias|alias...
221 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 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 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 usershare allow guests
247 Controls if usershares can permit guest access.
248 usershare max shares
250 Maximum number of user defined shares allowed.
251 usershare owner only
253 If set only directories owned by the sharing user can be shared.
254 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 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 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 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 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 Become root:
279 mkdir /usr/local/samba/lib/usershares
281 chgrp foo /usr/local/samba/lib/usershares
282 chmod 1770 /usr/local/samba/lib/usershares
283 Then add the parameters
285 usershare path = /usr/local/samba/lib/usershares
287 usershare max shares = 10 # (or the desired number of shares)
288 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 net usershare add sharename path [comment] [acl] [guest_ok=[y|n]]
293 To create or modify (overwrite) a user defined share.
294 net usershare delete sharename
296 To delete a user defined share.
297 net usershare list wildcard-sharename
299 To list user defined shares.
300 net usershare info wildcard-sharename
302 To print information about user defined shares.
303
305 Parameters define the specific attributes of sections.
306 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 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 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 %U
332 session username (the username that the client wanted, not
333 necessarily the same as the one they got).
334 %G
336 primary group name of %U.
337 %h
339 the Internet hostname that Samba is running on.
340 %m
342 the NetBIOS name of the client machine (very useful).
343 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 %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 %M
357 the Internet name of the client machine.
358 %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 SMB3_00, SMB3_02, SMB3_11 or SMB2_FF.
363 %d
365 the process id of the current server process.
366 %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 %I
377 the IP address of the client machine.
378 Before 4.0.0 it could contain IPv4 mapped IPv6 addresses, now it
380 only contains IPv4 or IPv6 addresses.
381 %J
383 the IP address of the client machine, colons/dots replaced by
384 underscores.
385 %i
387 the local IP address to which a client connected.
388 Before 4.0.0 it could contain IPv4 mapped IPv6 addresses, now it
390 only contains IPv4 or IPv6 addresses.
391 %j
393 the local IP address to which a client connected, colons/dots
394 replaced by underscores.
395 %T
397 the current date and time.
398 %t
400 the current date and time in a minimal format without colons
401 (YYYYYmmdd_HHMMSS).
402 %D
404 name of the domain or workgroup of the current user.
405 %w
407 the winbind separator.
408 %$(envvar)
410 the value of the environment variable envar.
411 The following substitutes apply only to some configuration options
413 (only those that are used when a connection has been established):
414 %S
416 the name of the current service, if any.
417 %P
419 the root directory of the current service, if any.
420 %u
422 username of the current service, if any.
423 %g
425 primary group name of %u.
426 %H
428 the home directory of the user given by %u.
429 %N
431 This value is the same as %L.
432 There are some quite creative things that can be done with these
434 substitutions and other smb.conf options.
435
437 Samba supports name mangling so that DOS and Windows clients can use
438 files that don't conform to the 8.3 format. It can also be set to
439 adjust the case of 8.3 format filenames.
440 There are several options that control the way mangling is performed,
442 and they are grouped here rather than listed separately. For the
443 defaults look at the output of the testparm program.
444 These options can be set separately for each service.
446 The options are:
448 case sensitive = yes/no/auto
450 controls whether filenames are case sensitive. If they aren't,
451 Samba must do a filename search and match on passed names. The
452 default setting of auto allows clients that support case sensitive
453 filenames (Linux CIFSVFS and smbclient 3.0.5 and above currently)
454 to tell the Samba server on a per-packet basis that they wish to
455 access the file system in a case-sensitive manner (to support UNIX
456 case sensitive semantics). No Windows or DOS system supports
457 case-sensitive filename so setting this option to auto is that same
458 as setting it to no for them. Default auto.
459 default case = upper/lower
461 controls what the default case is for new filenames (ie. files that
462 don't currently exist in the filesystem). Default lower. IMPORTANT
463 NOTE: As part of the optimizations for directories containing large
464 numbers of files, the following special case applies. If the
465 options case sensitive = yes, preserve case = No, and short
466 preserve case = No are set, then the case of all incoming client
467 filenames, not just new filenames, will be modified. See additional
468 notes below.
469 preserve case = yes/no
471 controls whether new files (ie. files that don't currently exist in
472 the filesystem) are created with the case that the client passes,
473 or if they are forced to be the default case. Default yes.
474 short preserve case = yes/no
476 controls if new files (ie. files that don't currently exist in the
477 filesystem) which conform to 8.3 syntax, that is all in upper case
478 and of suitable length, are created upper case, or if they are
479 forced to be the default case. This option can be used with
480 preserve case = yes to permit long filenames to retain their case,
481 while short names are lowercased. Default yes.
482 By default, Samba 3.0 has the same semantics as a Windows NT server, in
484 that it is case insensitive but case preserving. As a special case for
485 directories with large numbers of files, if the case options are set as
486 follows, "case sensitive = yes", "case preserve = no", "short preserve
487 case = no" then the "default case" option will be applied and will
488 modify all filenames sent from the client when accessing this share.
489
491 Starting with Samba version 3.2.0, the capability to store Samba
492 configuration in the registry is available. The configuration is stored
493 in the registry key HKLM\Software\Samba\smbconf. There are two levels
494 of registry configuration:
495 1. Share definitions stored in registry are used. This is
497 triggered by setting the global parameter registry shares to
498 “yes” in smb.conf.
499 The registry shares are loaded not at startup but on demand
501 at runtime by smbd. Shares defined in smb.conf take priority
502 over shares of the same name defined in registry.
503 2. Global smb.conf options stored in registry are used. This
505 can be activated in two different ways:
506 Firstly, a registry only configuration is triggered by
508 setting config backend = registry in the [global] section of
509 smb.conf. This resets everything that has been read from
510 config files to this point and reads the content of the
511 global configuration section from the registry. This is the
512 recommended method of using registry based configuration.
513 Secondly, a mixed configuration can be activated by a
515 special new meaning of the parameter include = registry in
516 the [global] section of smb.conf. This reads the global
517 options from registry with the same priorities as for an
518 include of a text file. This may be especially useful in
519 cases where an initial configuration is needed to access the
520 registry.
521 Activation of global registry options automatically
523 activates registry shares. So in the registry only case,
524 shares are loaded on demand only.
525 Note: To make registry-based configurations foolproof at least to a
528 certain extent, the use of lock directory and config backend inside the
529 registry configuration has been disabled: Especially by changing the
530 lock directory inside the registry configuration, one would create a
531 broken setup where the daemons do not see the configuration they loaded
532 once it is active.
533 The registry configuration can be accessed with tools like regedit or
535 net (rpc) registry in the key HKLM\Software\Samba\smbconf. More
536 conveniently, the conf subcommand of the net(8) utility offers a
537 dedicated interface to read and write the registry based configuration
538 locally, i.e. directly accessing the database file, circumventing the
539 server.
540
542 In the SMB protocol, users, groups, and machines are represented by
543 their security identifiers (SIDs). On POSIX system Samba processes need
544 to run under corresponding POSIX user identities and with supplemental
545 POSIX groups to allow access to the files owned by those users and
546 groups. The process of mapping SIDs to POSIX users and groups is called
547 IDENTITY MAPPING or, in short, ID MAPPING.
548 Samba supports multiple ways to map SIDs to POSIX users and groups. The
550 configuration is driven by the idmap config DOMAIN : OPTION option
551 which allows one to specify identity mapping (idmap) options for each
552 domain separately.
553 Identity mapping modules implement different strategies for mapping of
555 SIDs to POSIX user and group identities. They are applicable to
556 different use cases and scenarios. It is advised to read the
557 documentation of the individual identity mapping modules before
558 choosing a specific scenario to use. Each identity management module is
559 documented in a separate manual page. The standard idmap backends are
560 tdb (idmap_tdb(8)), tdb2 (idmap_tdb2(8)), ldap (idmap_ldap(8)), rid
561 (idmap_rid(8)), hash (idmap_hash(8)), autorid (idmap_autorid(8)), ad
562 (idmap_ad(8)), nss (idmap_nss(8)), and rfc2307 (idmap_rfc2307(8)).
563 Overall, ID mapping configuration should be decided carefully. Changes
565 to the already deployed ID mapping configuration may create the risk of
566 losing access to the data or disclosing the data to the wrong parties.
567 This example shows how to configure two domains with idmap_rid(8), the
569 principal domain and a trusted domain, leaving the default id mapping
570 scheme at tdb.
571 [global]
573 security = domain
574 workgroup = MAIN
575 idmap config * : backend = tdb
577 idmap config * : range = 1000000-1999999
578 idmap config MAIN : backend = rid
580 idmap config MAIN : range = 5000000-5999999
581 idmap config TRUSTED : backend = rid
583 idmap config TRUSTED : range = 6000000-6999999
584
587 abort shutdown script (G)
588 This a full path name to a script called by smbd(8) that should
590 stop a shutdown procedure issued by the shutdown script.
591 If the connected user possesses the SeRemoteShutdownPrivilege,
593 right, this command will be run as root.
594 Default: abort shutdown script = ""
596 Example: abort shutdown script = /sbin/shutdown -c
598 access based share enum (S)
600 If this parameter is yes for a service, then the share hosted by
602 the service will only be visible to users who have read or write
603 access to the share during share enumeration (for example net view
604 \\sambaserver). The share ACLs which allow or deny the access to
605 the share can be modified using for example the sharesec command or
606 using the appropriate Windows tools. This has parallels to access
607 based enumeration, the main difference being that only share
608 permissions are evaluated, and security descriptors on files
609 contained on the share are not used in computing enumeration access
610 rights.
611 Default: access based share enum = no
613 acl allow execute always (S)
615 This boolean parameter controls the behaviour of smbd(8) when
617 receiving a protocol request of "open for execution" from a Windows
618 client. With Samba 3.6 and older, the execution right in the ACL
619 was not checked, so a client could execute a file even if it did
620 not have execute rights on the file. In Samba 4.0, this has been
621 fixed, so that by default, i.e. when this parameter is set to
622 "False", "open for execution" is now denied when execution
623 permissions are not present.
624 If this parameter is set to "True", Samba does not check execute
626 permissions on "open for execution", thus re-establishing the
627 behaviour of Samba 3.6. This can be useful to smoothen upgrades
628 from older Samba versions to 4.0 and newer. This setting is not
629 meant to be used as a permanent setting, but as a temporary relief:
630 It is recommended to fix the permissions in the ACLs and reset this
631 parameter to the default after a certain transition period.
632 Default: acl allow execute always = no
634 acl check permissions (S)
636 Please note this parameter is now deprecated in Samba 3.6.2 and
638 will be removed in a future version of Samba.
639 This boolean parameter controls what smbd(8) does on receiving a
641 protocol request of "open for delete" from a Windows client. If a
642 Windows client doesn't have permissions to delete a file then they
643 expect this to be denied at open time. POSIX systems normally only
644 detect restrictions on delete by actually attempting to delete the
645 file or directory. As Windows clients can (and do) "back out" a
646 delete request by unsetting the "delete on close" bit Samba cannot
647 delete the file immediately on "open for delete" request as we
648 cannot restore such a deleted file. With this parameter set to true
649 (the default) then smbd checks the file system permissions directly
650 on "open for delete" and denies the request without actually
651 deleting the file if the file system permissions would seem to deny
652 it. This is not perfect, as it's possible a user could have deleted
653 a file without Samba being able to check the permissions correctly,
654 but it is close enough to Windows semantics for mostly correct
655 behaviour. Samba will correctly check POSIX ACL semantics in this
656 case.
657 If this parameter is set to "false" Samba doesn't check permissions
659 on "open for delete" and allows the open. If the user doesn't have
660 permission to delete the file this will only be discovered at close
661 time, which is too late for the Windows user tools to display an
662 error message to the user. The symptom of this is files that appear
663 to have been deleted "magically" re-appearing on a Windows explorer
664 refresh. This is an extremely advanced protocol option which should
665 not need to be changed. This parameter was introduced in its final
666 form in 3.0.21, an earlier version with slightly different
667 semantics was introduced in 3.0.20. That older version is not
668 documented here.
669 Default: acl check permissions = yes
671 acl flag inherited canonicalization (S)
673 This option controls the way Samba handles client requests setting
675 the Security Descriptor of files and directories and the effect the
676 operation has on the Security Descriptor flag "DACL auto-inherited"
677 (DI). Generally, this flag is set on a file (or directory) upon
678 creation if the parent directory has DI set and also has
679 inheritable ACEs.
680 On the other hand when a Security Descriptor is explicitly set on a
682 file, the DI flag is cleared, unless the flag "DACL Inheritance
683 Required" (DR) is also set in the new Security Descriptor (fwiw, DR
684 is never stored on disk).
685 This is the default behaviour when this option is enabled (the
687 default). When setting this option to no, the resulting value of
688 the DI flag on-disk is directly taken from the DI value of the
689 to-be-set Security Descriptor. This can be used so dump tools like
690 rsync that copy data blobs from xattrs that represent ACLs created
691 by the acl_xattr VFS module will result in copies of the ACL that
692 are identical to the source. Without this option, the copied ACLs
693 would all loose the DI flag if set on the source.
694 Default: acl flag inherited canonicalization = yes
696 acl group control (S)
698 In a POSIX filesystem, only the owner of a file or directory and
700 the superuser can modify the permissions and ACLs on a file. If
701 this parameter is set, then Samba overrides this restriction, and
702 also allows the primary group owner of a file or directory to
703 modify the permissions and ACLs on that file.
704 On a Windows server, groups may be the owner of a file or directory
706 - thus allowing anyone in that group to modify the permissions on
707 it. This allows the delegation of security controls on a point in
708 the filesystem to the group owner of a directory and anything below
709 it also owned by that group. This means there are multiple people
710 with permissions to modify ACLs on a file or directory, easing
711 manageability.
712 This parameter allows Samba to also permit delegation of the
714 control over a point in the exported directory hierarchy in much
715 the same way as Windows. This allows all members of a UNIX group to
716 control the permissions on a file or directory they have group
717 ownership on.
718 This parameter is best used with the inherit owner option and also
720 on a share containing directories with the UNIX setgid bit set on
721 them, which causes new files and directories created within it to
722 inherit the group ownership from the containing directory.
723 This parameter was deprecated in Samba 3.0.23, but re-activated in
725 Samba 3.0.31 and above, as it now only controls permission changes
726 if the user is in the owning primary group. It is now no longer
727 equivalent to the dos filemode option.
728 Default: acl group control = no
730 acl map full control (S)
732 This boolean parameter controls whether smbd(8) maps a POSIX ACE
734 entry of "rwx" (read/write/execute), the maximum allowed POSIX
735 permission set, into a Windows ACL of "FULL CONTROL". If this
736 parameter is set to true any POSIX ACE entry of "rwx" will be
737 returned in a Windows ACL as "FULL CONTROL", is this parameter is
738 set to false any POSIX ACE entry of "rwx" will be returned as the
739 specific Windows ACL bits representing read, write and execute.
740 Default: acl map full control = yes
742 ad dc functional level (G)
744 The value of the parameter (a string) is the Active Directory
746 functional level that this Domain Controller will claim to support.
747 Possible values are :
749 • 2008_R2: Similar to Windows 2008 R2 Functional Level
751 • 2012: Similar to Windows 2012 Functional Level
753 • 2012_R2: Similar to Windows 2012 R2 Functional Level
755 • 2016: Similar to Windows 2016 Functional Level
757 Normally this option should not be set as Samba will operate per
759 the released functionality of the Samba Active Directory Domain
760 Controller.
761 However to access incomplete features in domain functional level
763 2016 it may be useful to set this value, prior to upgrading the
764 domain functional level.
765 If this is set manually, the protection against mismatching
767 features between domain controllers is reduced, so all domain
768 controllers should be running the same version of Samba, to ensure
769 that behaviour as seen by the client is the same no matter which DC
770 is contacted.
771 Setting this to 2016 will allow raising the domain functional level
773 with samba-tool domain level raise --domain-level=2016 and provide
774 access to Samba's Kerberos Claims and Dynamic Access Control
775 feature.
776 Warning
778 The Samba's Kerberos Claims and Dynamic Access Control features
779 enabled with 2016 are incomplete in Samba 4.19.
780 Default: ad dc functional level = 2008_R2
781 Example: ad dc functional level = 2016
783 add group script (G)
785 This is the full pathname to a script that will be run AS ROOT by
787 smbd(8) when a new group is requested. It will expand any %g to the
788 group name passed. This script is only useful for installations
789 using the Windows NT domain administration tools. The script is
790 free to create a group with an arbitrary name to circumvent unix
791 group name restrictions. In that case the script must print the
792 numeric gid of the created group on stdout.
793 Default: add group script =
795 Example: add group script = /usr/sbin/groupadd %g
797 additional dns hostnames (G)
799 A list of additional DNS names by which this host can be identified
801 Default: additional dns hostnames = # empty string (no additional
803 dns names)
804 Example: additional dns hostnames = host2.example.com
806 host3.other.com
807 add machine script (G)
809 This is the full pathname to a script that will be run by smbd(8)
811 when a machine is added to Samba's domain and a Unix account
812 matching the machine's name appended with a "$" does not already
813 exist.
814 This option is very similar to the add user script, and likewise
816 uses the %u substitution for the account name. Do not use the %m
817 substitution.
818 Default: add machine script =
820 Example: add machine script = /usr/sbin/adduser -n -g machines -c
822 Machine -d /var/lib/nobody -s /bin/false %u
823 addport command (G)
825 Samba 3.0.23 introduced support for adding printer ports remotely
827 using the Windows "Add Standard TCP/IP Port Wizard". This option
828 defines an external program to be executed when smbd receives a
829 request to add a new Port to the system. The script is passed two
830 parameters:
831 • port name
833 • device URI
835 The deviceURI is in the format of
837 socket://<hostname>[:<portnumber>] or lpd://<hostname>/<queuename>.
838 Default: addport command =
840 Example: addport command = /etc/samba/scripts/addport.sh
842 addprinter command (G)
844 With the introduction of MS-RPC based printing support for Windows
846 NT/2000 clients in Samba 2.2, The MS Add Printer Wizard (APW) icon
847 is now also available in the "Printers..." folder displayed a share
848 listing. The APW allows for printers to be add remotely to a Samba
849 or Windows NT/2000 print server.
850 For a Samba host this means that the printer must be physically
852 added to the underlying printing system. The addprinter command
853 defines a script to be run which will perform the necessary
854 operations for adding the printer to the print system and to add
855 the appropriate service definition to the smb.conf file in order
856 that it can be shared by smbd(8).
857 The addprinter command is automatically invoked with the following
859 parameter (in order):
860 • printer name
862 • share name
864 • port name
866 • driver name
868 • location
870 • Windows 9x driver location
872 All parameters are filled in from the PRINTER_INFO_2 structure sent
874 by the Windows NT/2000 client with one exception. The "Windows 9x
875 driver location" parameter is included for backwards compatibility
876 only. The remaining fields in the structure are generated from
877 answers to the APW questions.
878 Once the addprinter command has been executed, smbd will reparse
880 the smb.conf to determine if the share defined by the APW exists.
881 If the sharename is still invalid, then smbd will return an
882 ACCESS_DENIED error to the client.
883 The addprinter command program can output a single line of text,
885 which Samba will set as the port the new printer is connected to.
886 If this line isn't output, Samba won't reload its printer shares.
887 Default: addprinter command =
889 Example: addprinter command = /usr/bin/addprinter
891 add share command (G)
893 Samba 2.2.0 introduced the ability to dynamically add and delete
895 shares via the Windows NT 4.0 Server Manager. The add share command
896 is used to define an external program or script which will add a
897 new service definition to smb.conf.
898 In order to successfully execute the add share command, smbd
900 requires that the administrator connects using a root account (i.e.
901 uid == 0) or has the SeDiskOperatorPrivilege. Scripts defined in
902 the add share command parameter are executed as root.
903 When executed, smbd will automatically invoke the add share command
905 with five parameters.
906 • configFile - the location of the global smb.conf file.
908 • shareName - the name of the new share.
910 • pathName - path to an **existing** directory on disk.
912 • comment - comment string to associate with the new
914 share.
915 • max connections Number of maximum simultaneous
917 connections to this share.
918 This parameter is only used to add file shares. To add printer
920 shares, see the addprinter command.
921 Default: add share command =
923 Example: add share command = /usr/local/bin/addshare
925 add user script (G)
927 This is the full pathname to a script that will be run AS ROOT by
929 smbd(8) under special circumstances described below.
930 Normally, a Samba server requires that UNIX users are created for
932 all users accessing files on this server. For sites that use
933 Windows NT account databases as their primary user database
934 creating these users and keeping the user list in sync with the
935 Windows NT PDC is an onerous task. This option allows smbd to
936 create the required UNIX users ON DEMAND when a user accesses the
937 Samba server.
938 When the Windows user attempts to access the Samba server, at login
940 (session setup in the SMB protocol) time, smbd(8) contacts the
941 password server and attempts to authenticate the given user with
942 the given password. If the authentication succeeds then smbd
943 attempts to find a UNIX user in the UNIX password database to map
944 the Windows user into. If this lookup fails, and add user script is
945 set then smbd will call the specified script AS ROOT, expanding any
946 %u argument to be the user name to create.
947 If this script successfully creates the user then smbd will
949 continue on as though the UNIX user already existed. In this way,
950 UNIX users are dynamically created to match existing Windows NT
951 accounts.
952 See also security, password server, delete user script.
954 Default: add user script =
956 Example: add user script = /usr/local/samba/bin/add_user %u
958 add user to group script (G)
960 Full path to the script that will be called when a user is added to
962 a group using the Windows NT domain administration tools. It will
963 be run by smbd(8) AS ROOT. Any %g will be replaced with the group
964 name and any %u will be replaced with the user name.
965 Note that the adduser command used in the example below does not
967 support the used syntax on all systems.
968 Default: add user to group script =
970 Example: add user to group script = /usr/sbin/adduser %u %g
972 administrative share (S)
974 If this parameter is set to yes for a share, then the share will be
976 an administrative share. The Administrative Shares are the default
977 network shares created by all Windows NT-based operating systems.
978 These are shares like C$, D$ or ADMIN$. The type of these shares is
979 STYPE_DISKTREE_HIDDEN.
980 See the section below on security for more information about this
982 option.
983 Default: administrative share = no
985 admin users (S)
987 This is a list of users who will be granted administrative
989 privileges on the share. This means that they will do all file
990 operations as the super-user (root).
991 You should use this option very carefully, as any user in this list
993 will be able to do anything they like on the share, irrespective of
994 file permissions.
995 Default: admin users =
997 Example: admin users = jason
999 afs share (S)
1001 This parameter controls whether special AFS features are enabled
1003 for this share. If enabled, it assumes that the directory exported
1004 via the path parameter is a local AFS import. The special AFS
1005 features include the attempt to hand-craft an AFS token if you
1006 enabled --with-fake-kaserver in configure.
1007 Default: afs share = no
1009 afs token lifetime (G)
1011 This parameter controls the lifetime of tokens that the AFS
1013 fake-kaserver claims. In reality these never expire but this
1014 lifetime controls when the afs client will forget the token.
1015 Set this parameter to 0 to get NEVERDATE.
1017 Default: afs token lifetime = 604800
1019 afs username map (G)
1021 If you are using the fake kaserver AFS feature, you might want to
1023 hand-craft the usernames you are creating tokens for. For example
1024 this is necessary if you have users from several domain in your AFS
1025 Protection Database. One possible scheme to code users as
1026 DOMAIN+User as it is done by winbind with the + as a separator.
1027 The mapped user name must contain the cell name to log into, so
1029 without setting this parameter there will be no token.
1030 Default: afs username map =
1032 Example: afs username map = %u@afs.samba.org
1034 aio max threads (G)
1036 The integer parameter specifies the maximum number of threads each
1038 smbd process will create when doing parallel asynchronous IO calls.
1039 If the number of outstanding calls is greater than this number the
1040 requests will not be refused but go onto a queue and will be
1041 scheduled in turn as outstanding requests complete.
1042 Related command: aio read size
1044 Related command: aio write size
1046 Default: aio max threads = 100
1048 aio read size (S)
1050 If this integer parameter is set to a non-zero value, Samba will
1052 read from files asynchronously when the request size is bigger than
1053 this value. Note that it happens only for non-chained and
1054 non-chaining reads.
1055 The only reasonable values for this parameter are 0 (no async I/O)
1057 and 1 (always do async I/O).
1058 Related command: aio write size
1060 Default: aio read size = 1
1062 Example: aio read size = 0 # Always do reads synchronously
1064 aio write behind (S)
1066 If Samba has been built with asynchronous I/O support, Samba will
1068 not wait until write requests are finished before returning the
1069 result to the client for files listed in this parameter. Instead,
1070 Samba will immediately return that the write request has been
1071 finished successfully, no matter if the operation will succeed or
1072 not. This might speed up clients without aio support, but is really
1073 dangerous, because data could be lost and files could be damaged.
1074 The syntax is identical to the veto files parameter.
1076 Default: aio write behind =
1078 Example: aio write behind = /*.tmp/
1080 aio write size (S)
1082 If this integer parameter is set to a non-zero value, Samba will
1084 write to files asynchronously when the request size is bigger than
1085 this value. Note that it happens only for non-chained and
1086 non-chaining writes.
1087 The only reasonable values for this parameter are 0 (no async I/O)
1089 and 1 (always do async I/O).
1090 Compared to aio read size this parameter has a smaller effect, most
1092 writes should end up in the file system cache. Writes that require
1093 space allocation might benefit most from going asynchronous.
1094 Related command: aio read size
1096 Default: aio write size = 1
1098 Example: aio write size = 0 # Always do writes synchronously
1100 algorithmic rid base (G)
1102 This determines how Samba will use its algorithmic mapping from
1104 uids/gid to the RIDs needed to construct NT Security Identifiers.
1105 Setting this option to a larger value could be useful to sites
1107 transitioning from WinNT and Win2k, as existing user and group rids
1108 would otherwise clash with system users etc.
1109 All UIDs and GIDs must be able to be resolved into SIDs for the
1111 correct operation of ACLs on the server. As such the algorithmic
1112 mapping can't be 'turned off', but pushing it 'out of the way'
1113 should resolve the issues. Users and groups can then be assigned
1114 'low' RIDs in arbitrary-rid supporting backends.
1115 Default: algorithmic rid base = 1000
1117 Example: algorithmic rid base = 100000
1119 allocation roundup size (S)
1121 This parameter allows an administrator to tune the allocation size
1123 reported to Windows clients. This is only useful for old SMB1
1124 clients because modern SMB dialects eliminated that bottleneck and
1125 have better performance by default. Using this parameter may cause
1126 difficulties for some applications, e.g. MS Visual Studio. If the
1127 MS Visual Studio compiler starts to crash with an internal error,
1128 set this parameter to zero for this share. Settings this parameter
1129 to a large value can also cause small files to allocate more space
1130 on the disk than needed.
1131 This parameter is deprecated and will be removed in one of the next
1133 Samba releases.
1134 The integer parameter specifies the roundup size in bytes.
1136 Default: allocation roundup size = 0
1138 Example: allocation roundup size = 1048576 # (to set it to the
1140 former default of 1 MiB)
1141 allow dcerpc auth level connect (G)
1143 This option controls whether DCERPC services are allowed to be used
1145 with DCERPC_AUTH_LEVEL_CONNECT, which provides authentication, but
1146 no per message integrity nor privacy protection.
1147 Some interfaces like samr, lsarpc and netlogon have a hard-coded
1149 default of no and epmapper, mgmt and rpcecho have a hard-coded
1150 default of yes.
1151 The behavior can be overwritten per interface name (e.g. lsarpc,
1153 netlogon, samr, srvsvc, winreg, wkssvc ...) by using 'allow dcerpc
1154 auth level connect:interface = yes' as option.
1155 This option is over-ridden by the implementation specific
1157 restrictions. E.g. the drsuapi and backupkey protocols require
1158 DCERPC_AUTH_LEVEL_PRIVACY. The dnsserver protocol requires
1159 DCERPC_AUTH_LEVEL_INTEGRITY.
1160 Default: allow dcerpc auth level connect = no
1162 Example: allow dcerpc auth level connect = yes
1164 allow dns updates (G)
1166 This option determines what kind of updates to the DNS are allowed.
1168 DNS updates can either be disallowed completely by setting it to
1170 disabled, enabled over secure connections only by setting it to
1171 secure only or allowed in all cases by setting it to nonsecure.
1172 Default: allow dns updates = secure only
1174 Example: allow dns updates = disabled
1176 allow insecure wide links (G)
1178 In normal operation the option wide links which allows the server
1180 to follow symlinks outside of a share path is automatically
1181 disabled when unix extensions are enabled on a Samba server. This
1182 is done for security purposes to prevent UNIX clients creating
1183 symlinks to areas of the server file system that the administrator
1184 does not wish to export.
1185 Setting allow insecure wide links to true disables the link between
1187 these two parameters, removing this protection and allowing a site
1188 to configure the server to follow symlinks (by setting wide links
1189 to "true") even when unix extensions is turned on.
1190 It is not recommended to enable this option unless you fully
1192 understand the implications of allowing the server to follow
1193 symbolic links created by UNIX clients. For most normal Samba
1194 configurations this would be considered a security hole and setting
1195 this parameter is not recommended.
1196 This option was added at the request of sites who had deliberately
1198 set Samba up in this way and needed to continue supporting this
1199 functionality without having to patch the Samba code.
1200 Default: allow insecure wide links = no
1202 allow nt4 crypto (G)
1204 This option is deprecated and will be removed in future, as it is a
1206 security problem if not set to "no" (which will be the hardcoded
1207 behavior in future).
1208 This option controls whether the netlogon server (currently only in
1210 'active directory domain controller' mode), will reject clients
1211 which do not support NETLOGON_NEG_STRONG_KEYS nor
1212 NETLOGON_NEG_SUPPORTS_AES.
1213 This option was added with Samba 4.2.0. It may lock out clients
1215 which worked fine with Samba versions up to 4.1.x. as the effective
1216 default was "yes" there, while it is "no" now.
1217 If you have clients without RequireStrongKey = 1 in the registry,
1219 you may need to set "allow nt4 crypto = yes", until you have fixed
1220 all clients.
1221 "allow nt4 crypto = yes" allows weak crypto to be negotiated, maybe
1223 via downgrade attacks.
1224 Avoid using this option! Use explicit 'allow nt4
1226 crypto:COMPUTERACCOUNT = yes' instead! Which is available with the
1227 patches for CVE-2022-38023 see
1228 https://bugzilla.samba.org/show_bug.cgi?id=15240
1229 Samba will log an error in the log files at log level 0 if legacy a
1231 client is rejected or allowed without an explicit, 'allow nt4
1232 crypto:COMPUTERACCOUNT = yes' option for the client. The message
1233 will indicate the explicit 'allow nt4 crypto:COMPUTERACCOUNT = yes'
1234 line to be added, if the legacy client software requires it. (The
1235 log level can be adjusted with 'CVE_2022_38023:error_debug_level =
1236 1' in order to complain only at a higher log level).
1237 This allows admins to use "yes" only for a short grace period, in
1239 order to collect the explicit 'allow nt4 crypto:COMPUTERACCOUNT =
1240 yes' options.
1241 This option is over-ridden by the effective value of 'yes' from the
1243 'server reject md5 schannel:COMPUTERACCOUNT' and/or 'reject md5
1244 clients' options.
1245 Default: allow nt4 crypto = no
1247 allow nt4 crypto:COMPUTERACCOUNT (G)
1249 If you still have legacy domain members which required 'allow nt4
1251 crypto = yes', it is possible to specify an explicit exception per
1252 computer account by using 'allow nt4 crypto:COMPUTERACCOUNT = yes'
1253 as option. Note that COMPUTERACCOUNT has to be the sAMAccountName
1254 value of the computer account (including the trailing '$' sign).
1255 Samba will log a complaint in the log files at log level 0 about
1257 the security problem if the option is set to "yes", but the related
1258 computer does not require it. (The log level can be adjusted with
1259 'CVE_2022_38023:warn_about_unused_debug_level = 1' in order to
1260 complain only at a higher log level).
1261 Samba will log a warning in the log files at log level 5, if a
1263 setting is still needed for the specified computer account.
1264 See CVE-2022-38023,
1266 https://bugzilla.samba.org/show_bug.cgi?id=15240.
1267 This option overrides the allow nt4 crypto option.
1269 This option is over-ridden by the effective value of 'yes' from the
1271 'server reject md5 schannel:COMPUTERACCOUNT' and/or 'reject md5
1272 clients' options.
1273 Which means 'allow nt4 crypto:COMPUTERACCOUNT = yes' is only useful
1275 in combination with 'server reject md5 schannel:COMPUTERACCOUNT =
1276 no'
1277 allow nt4 crypto:LEGACYCOMPUTER1$ = yes
1279 server reject md5 schannel:LEGACYCOMPUTER1$ = no
1280 allow nt4 crypto:NASBOX$ = yes
1281 server reject md5 schannel:NASBOX$ = no
1282 allow nt4 crypto:LEGACYCOMPUTER2$ = yes
1283 server reject md5 schannel:LEGACYCOMPUTER2$ = no
1284 No default
1287 allow trusted domains (G)
1289 This option only takes effect when the security option is set to
1291 server, domain or ads. If it is set to no, then attempts to connect
1292 to a resource from a domain or workgroup other than the one which
1293 smbd is running in will fail, even if that domain is trusted by the
1294 remote server doing the authentication.
1295 This is useful if you only want your Samba server to serve
1297 resources to users in the domain it is a member of. As an example,
1298 suppose that there are two domains DOMA and DOMB. DOMB is trusted
1299 by DOMA, which contains the Samba server. Under normal
1300 circumstances, a user with an account in DOMB can then access the
1301 resources of a UNIX account with the same account name on the Samba
1302 server even if they do not have an account in DOMA. This can make
1303 implementing a security boundary difficult.
1304 Default: allow trusted domains = yes
1306 allow unsafe cluster upgrade (G)
1308 If set to no (the default), smbd checks at startup if other smbd
1310 versions are running in the cluster and refuses to start if so.
1311 This is done to protect data corruption in internal data structures
1312 due to incompatible Samba versions running concurrently in the same
1313 cluster. Setting this parameter to yes disables this safety check.
1314 Default: allow unsafe cluster upgrade = no
1316 apply group policies (G)
1318 This option controls whether winbind will execute the gpupdate
1320 command defined in gpo update command on the Group Policy update
1321 interval. The Group Policy update interval is defined as every 90
1322 minutes, plus a random offset between 0 and 30 minutes. This
1323 applies Group Policy Machine polices to the client or KDC and
1324 machine policies to a server.
1325 Default: apply group policies = no
1327 Example: apply group policies = yes
1329 async dns timeout (G)
1331 The number of seconds the asynchronous DNS resolver code in Samba
1333 will wait for responses. Some of the Samba client library code uses
1334 internal asynchronous DNS resolution for A and AAAA records when
1335 trying to find Active Directory Domain controllers. This value
1336 prevents this name resolution code from waiting for DNS server
1337 timeouts.
1338 The minimum value of this parameter is clamped at 1 second.
1340 Default: async dns timeout = 10
1342 Example: async dns timeout = 20
1344 async smb echo handler (G)
1346 This parameter specifies whether Samba should fork the async smb
1348 echo handler. It can be beneficial if your file system can block
1349 syscalls for a very long time. In some circumstances, it prolongs
1350 the timeout that Windows uses to determine whether a connection is
1351 dead. This parameter is only for SMB1. For SMB2 and above TCP
1352 keepalives can be used instead.
1353 Default: async smb echo handler = no
1355 auth event notification (G)
1357 When enabled, this option causes Samba (acting as an Active
1359 Directory Domain Controller) to stream authentication events across
1360 the internal message bus. Scripts built using Samba's python
1361 bindings can listen to these events by registering as the service
1362 auth_event.
1363 This is not needed for the audit logging described in log level.
1365 Instead, this should instead be considered a developer option (it
1367 assists in the Samba testsuite) rather than a facility for external
1368 auditing, as message delivery is not guaranteed (a feature that the
1369 testsuite works around).
1370 The authentication events are also logged via the normal logging
1372 methods when the log level is set appropriately, say to
1373 auth_json_audit:3.
1374 Default: auth event notification = no
1376 preload
1378 This parameter is a synonym for auto services.
1380 auto services (G)
1382 This is a list of services that you want to be automatically added
1384 to the browse lists. This is most useful for homes and printers
1385 services that would otherwise not be visible.
1386 Note that if you just want all printers in your printcap file
1388 loaded then the load printers option is easier.
1389 Default: auto services =
1391 Example: auto services = fred lp colorlp
1393 available (S)
1395 This parameter lets you "turn off" a service. If available = no,
1397 then ALL attempts to connect to the service will fail. Such
1398 failures are logged.
1399 Default: available = yes
1401 bind dns directory
1403 This parameter is a synonym for binddns dir.
1405 binddns dir (G)
1407 This parameters defines the directory samba will use to store the
1409 configuration files for bind, such as named.conf. NOTE: The bind
1410 dns directory needs to be on the same mount point as the private
1411 directory!
1412 Default: binddns dir = /var/lib/samba/bind-dns
1414 bind interfaces only (G)
1416 This global parameter allows the Samba admin to limit what
1418 interfaces on a machine will serve SMB requests. It affects file
1419 service smbd(8) and name service nmbd(8) in a slightly different
1420 ways.
1421 For name service it causes nmbd to bind to ports 137 and 138 on the
1423 interfaces listed in the interfaces parameter. nmbd also binds to
1424 the "all addresses" interface (0.0.0.0) on ports 137 and 138 for
1425 the purposes of reading broadcast messages. If this option is not
1426 set then nmbd will service name requests on all of these sockets.
1427 If bind interfaces only is set then nmbd will check the source
1428 address of any packets coming in on the broadcast sockets and
1429 discard any that don't match the broadcast addresses of the
1430 interfaces in the interfaces parameter list. As unicast packets are
1431 received on the other sockets it allows nmbd to refuse to serve
1432 names to machines that send packets that arrive through any
1433 interfaces not listed in the interfaces list. IP Source address
1434 spoofing does defeat this simple check, however, so it must not be
1435 used seriously as a security feature for nmbd.
1436 For file service it causes smbd(8) to bind only to the interface
1438 list given in the interfaces parameter. This restricts the networks
1439 that smbd will serve, to packets coming in on those interfaces.
1440 Note that you should not use this parameter for machines that are
1441 serving PPP or other intermittent or non-broadcast network
1442 interfaces as it will not cope with non-permanent interfaces.
1443 If bind interfaces only is set and the network address 127.0.0.1 is
1445 not added to the interfaces parameter list smbpasswd(8) may not
1446 work as expected due to the reasons covered below.
1447 To change a users SMB password, the smbpasswd by default connects
1449 to the localhost - 127.0.0.1 address as an SMB client to issue the
1450 password change request. If bind interfaces only is set then unless
1451 the network address 127.0.0.1 is added to the interfaces parameter
1452 list then smbpasswd will fail to connect in it's default mode.
1453 smbpasswd can be forced to use the primary IP interface of the
1454 local host by using its smbpasswd(8) -r remote machine parameter,
1455 with remote machine set to the IP name of the primary interface of
1456 the local host.
1457 Default: bind interfaces only = no
1459 blocking locks (S)
1461 This parameter controls the behavior of smbd(8) when given a
1463 request by a client to obtain a byte range lock on a region of an
1464 open file, and the request has a time limit associated with it.
1465 If this parameter is set and the lock range requested cannot be
1467 immediately satisfied, samba will internally queue the lock
1468 request, and periodically attempt to obtain the lock until the
1469 timeout period expires.
1470 If this parameter is set to no, then samba will behave as previous
1472 versions of Samba would and will fail the lock request immediately
1473 if the lock range cannot be obtained.
1474 Default: blocking locks = yes
1476 block size (S)
1478 This parameter controls the behavior of smbd(8) when reporting disk
1480 free sizes. By default, this reports a disk block size of 1024
1481 bytes.
1482 Changing this parameter may have some effect on the efficiency of
1484 client writes, this is not yet confirmed. This parameter was added
1485 to allow advanced administrators to change it (usually to a higher
1486 value) and test the effect it has on client write performance
1487 without re-compiling the code. As this is an experimental option it
1488 may be removed in a future release.
1489 Changing this option does not change the disk free reporting size,
1491 just the block size unit reported to the client.
1492 Default: block size = 1024
1494 Example: block size = 4096
1496 browsable
1498 This parameter is a synonym for browseable.
1500 browseable (S)
1502 This controls whether this share is seen in the list of available
1504 shares in a net view and in the browse list.
1505 Default: browseable = yes
1507 browse list (G)
1509 This controls whether smbd(8) will serve a browse list to a client
1511 doing a NetServerEnum call. Normally set to yes. You should never
1512 need to change this.
1513 Default: browse list = yes
1515 cache directory (G)
1517 Usually, most of the TDB files are stored in the lock directory.
1519 Since Samba 3.4.0, it is possible to differentiate between TDB
1520 files with persistent data and TDB files with non-persistent data
1521 using the state directory and the cache directory options.
1522 This option specifies the directory for storing TDB files
1524 containing non-persistent data that will be kept across service
1525 restarts. The directory should be placed on persistent storage, but
1526 the data can be safely deleted by an administrator.
1527 Default: cache directory = /var/lib/samba
1529 Example: cache directory = /var/run/samba/locks/cache
1531 casesignames
1533 This parameter is a synonym for case sensitive.
1535 case sensitive (S)
1537 See the discussion in the section name mangling.
1539 Default: case sensitive = auto
1541 change notify (G)
1543 This parameter specifies whether Samba should reply to a client's
1545 file change notify requests.
1546 You should never need to change this parameter
1548 Default: change notify = yes
1550 change share command (G)
1552 Samba 2.2.0 introduced the ability to dynamically add and delete
1554 shares via the Windows NT 4.0 Server Manager. The change share
1555 command is used to define an external program or script which will
1556 modify an existing service definition in smb.conf.
1557 In order to successfully execute the change share command, smbd
1559 requires that the administrator connects using a root account (i.e.
1560 uid == 0) or has the SeDiskOperatorPrivilege. Scripts defined in
1561 the change share command parameter are executed as root.
1562 When executed, smbd will automatically invoke the change share
1564 command with six parameters.
1565 • configFile - the location of the global smb.conf file.
1567 • shareName - the name of the new share.
1569 • pathName - path to an **existing** directory on disk.
1571 • comment - comment string to associate with the new
1573 share.
1574 • max connections Number of maximum simultaneous
1576 connections to this share.
1577 • CSC policy - client side caching policy in string form.
1579 Valid values are: manual, documents, programs, disable.
1580 This parameter is only used to modify existing file share
1582 definitions. To modify printer shares, use the "Printers..." folder
1583 as seen when browsing the Samba host.
1584 Default: change share command =
1586 Example: change share command = /usr/local/bin/changeshare
1588 check parent directory delete on close (S)
1590 A Windows SMB server prevents the client from creating files in a
1592 directory that has the delete-on-close flag set. By default Samba
1593 doesn't perform this check as this check is a quite expensive
1594 operation in Samba.
1595 Default: check parent directory delete on close = no
1597 check password script (G)
1599 The name of a program that can be used to check password
1601 complexity. The password is sent to the program's standard input.
1602 The program must return 0 on a good password, or any other value if
1604 the password is bad. In case the password is considered weak (the
1605 program does not return 0) the user will be notified and the
1606 password change will fail.
1607 In Samba AD, this script will be run AS ROOT by samba(8) without
1609 any substitutions.
1610 Note that starting with Samba 4.11 the following environment
1612 variables are exported to the script:
1613 • SAMBA_CPS_ACCOUNT_NAME is always present and contains
1615 the sAMAccountName of user, the is the same as the %u
1616 substitutions in the none AD DC case.
1617 • SAMBA_CPS_USER_PRINCIPAL_NAME is optional in the AD DC
1619 case if the userPrincipalName is present.
1620 • SAMBA_CPS_FULL_NAME is optional if the displayName is
1622 present.
1623 Note: In the example directory is a sample program called
1625 crackcheck that uses cracklib to check the password quality.
1626 Default: check password script = # Disabled
1628 Example: check password script = /usr/local/sbin/crackcheck
1630 cldap port (G)
1632 This option controls the port used by the CLDAP protocol.
1634 Default: cldap port = 389
1636 Example: cldap port = 3389
1638 client ipc max protocol (G)
1640 The value of the parameter (a string) is the highest protocol level
1642 that will be supported for IPC$ connections as DCERPC transport.
1643 Normally this option should not be set as the automatic negotiation
1645 phase in the SMB protocol takes care of choosing the appropriate
1646 protocol.
1647 The value default refers to the latest supported protocol,
1649 currently SMB3_11.
1650 See client max protocol for a full list of available protocols. The
1652 values CORE, COREPLUS, LANMAN1, LANMAN2 are silently upgraded to
1653 NT1.
1654 Default: client ipc max protocol = default
1656 Example: client ipc max protocol = SMB2_10
1658 client ipc min protocol (G)
1660 This setting controls the minimum protocol version that the will be
1662 attempted to use for IPC$ connections as DCERPC transport.
1663 Normally this option should not be set as the automatic negotiation
1665 phase in the SMB protocol takes care of choosing the appropriate
1666 protocol.
1667 The value default refers to the higher value of NT1 and the
1669 effective value of client min protocol.
1670 See client max protocol for a full list of available protocols. The
1672 values CORE, COREPLUS, LANMAN1, LANMAN2 are silently upgraded to
1673 NT1.
1674 Default: client ipc min protocol = default
1676 Example: client ipc min protocol = SMB3_11
1678 client ipc signing (G)
1680 This controls whether the client is allowed or required to use SMB
1682 signing for IPC$ connections as DCERPC transport. Possible values
1683 are desired, required and disabled.
1684 When set to required or default, SMB signing is mandatory.
1686 When set to desired, SMB signing is offered, but not enforced and
1688 if set to disabled, SMB signing is not offered either.
1689 Connections from winbindd to Active Directory Domain Controllers
1691 always enforce signing.
1692 Default: client ipc signing = default
1694 client lanman auth (G)
1696 This parameter has been deprecated since Samba 4.13 and support for
1698 LanMan (as distinct from NTLM, NTLMv2 or Kerberos) authentication
1699 as a client will be removed in a future Samba release.
1700 That is, in the future, the current default of client NTLMv2 auth =
1702 yes will be the enforced behaviour.
1703 This parameter determines whether or not smbclient(8) and other
1705 samba client tools will attempt to authenticate itself to servers
1706 using the weaker LANMAN password hash. If disabled, only server
1707 which support NT password hashes (e.g. Windows NT/2000, Samba,
1708 etc... but not Windows 95/98) will be able to be connected from the
1709 Samba client.
1710 The LANMAN encrypted response is easily broken, due to its
1712 case-insensitive nature, and the choice of algorithm. Clients
1713 without Windows 95/98 servers are advised to disable this option.
1714 Disabling this option will also disable the client plaintext auth
1716 option.
1717 Likewise, if the client ntlmv2 auth parameter is enabled, then only
1719 NTLMv2 logins will be attempted.
1720 Default: client lanman auth = no
1722 client ldap sasl wrapping (G)
1724 The client ldap sasl wrapping defines whether ldap traffic will be
1726 signed or signed and encrypted (sealed). Possible values are plain,
1727 sign and seal.
1728 The values sign and seal are only available if Samba has been
1730 compiled against a modern OpenLDAP version (2.3.x or higher).
1731 This option is needed firstly to secure the privacy of
1733 administrative connections from samba-tool, including in particular
1734 new or reset passwords for users. For this reason the default is
1735 seal.
1736 Additionally, winbindd and the net tool can use LDAP to communicate
1738 with Domain Controllers, so this option also controls the level of
1739 privacy for those connections. All supported AD DC versions will
1740 enforce the usage of at least signed LDAP connections by default,
1741 so a value of at least sign is required in practice.
1742 The default value is seal. That implies synchronizing the time with
1744 the KDC in the case of using Kerberos.
1745 Default: client ldap sasl wrapping = seal
1747 client max protocol (G)
1749 The value of the parameter (a string) is the highest protocol level
1751 that will be supported by the client.
1752 Possible values are :
1754 • CORE: Earliest version. No concept of user names.
1756 • COREPLUS: Slight improvements on CORE for efficiency.
1758 • LANMAN1: First modern version of the protocol. Long
1760 filename support.
1761 • LANMAN2: Updates to Lanman1 protocol.
1763 • NT1: Current up to date version of the protocol. Used by
1765 Windows NT. Known as CIFS.
1766 • SMB2: Re-implementation of the SMB protocol. Used by
1768 Windows Vista and later versions of Windows. SMB2 has
1769 sub protocols available.
1770 • SMB2_02: The earliest SMB2 version.
1772 • SMB2_10: Windows 7 SMB2 version.
1774 By default SMB2 selects the SMB2_10 variant.
1776 • SMB3: The same as SMB2. Used by Windows 8. SMB3 has sub
1778 protocols available.
1779 • SMB3_00: Windows 8 SMB3 version.
1781 • SMB3_02: Windows 8.1 SMB3 version.
1783 • SMB3_11: Windows 10 SMB3 version.
1785 By default SMB3 selects the SMB3_11 variant.
1787 Normally this option should not be set as the automatic negotiation
1789 phase in the SMB protocol takes care of choosing the appropriate
1790 protocol.
1791 The value default refers to SMB3_11.
1793 IPC$ connections for DCERPC e.g. in winbindd, are handled by the
1795 client ipc max protocol option.
1796 Default: client max protocol = default
1798 Example: client max protocol = LANMAN1
1800 client min protocol (G)
1802 This setting controls the minimum protocol version that the client
1804 will attempt to use.
1805 Normally this option should not be set as the automatic negotiation
1807 phase in the SMB protocol takes care of choosing the appropriate
1808 protocol unless you connect to a legacy SMB1-only server.
1809 See Related command: client max protocol for a full list of
1811 available protocols.
1812 IPC$ connections for DCERPC e.g. in winbindd, are handled by the
1814 client ipc min protocol option.
1815 Note that most command line tools support --option='client min
1817 protocol=NT1', so it may not be required to enable SMB1 protocols
1818 globally in smb.conf.
1819 Default: client min protocol = SMB2_02
1821 Example: client min protocol = NT1
1823 client NTLMv2 auth (G)
1825 This parameter has been deprecated since Samba 4.13 and support for
1827 NTLM and LanMan (as distinct from NTLMv2 or Kerberos
1828 authentication) will be removed in a future Samba release.
1829 That is, in the future, the current default of client NTLMv2 auth =
1831 yes will be the enforced behaviour.
1832 This parameter determines whether or not smbclient(8) will attempt
1834 to authenticate itself to servers using the NTLMv2 encrypted
1835 password response.
1836 If enabled, only an NTLMv2 and LMv2 response (both much more secure
1838 than earlier versions) will be sent. Older servers (including NT4 <
1839 SP4, Win9x and Samba 2.2) are not compatible with NTLMv2 when not
1840 in an NTLMv2 supporting domain
1841 Similarly, if enabled, NTLMv1, client lanman auth and client
1843 plaintext auth authentication will be disabled. This also disables
1844 share-level authentication.
1845 If disabled, an NTLM response (and possibly a LANMAN response) will
1847 be sent by the client, depending on the value of client lanman
1848 auth.
1849 Note that Windows Vista and later versions already use NTLMv2 by
1851 default, and some sites (particularly those following 'best
1852 practice' security polices) only allow NTLMv2 responses, and not
1853 the weaker LM or NTLM.
1854 When client use spnego is also set to yes extended security
1856 (SPNEGO) is required in order to use NTLMv2 only within NTLMSSP.
1857 This behavior was introduced with the patches for CVE-2016-2111.
1858 Default: client NTLMv2 auth = yes
1860 client plaintext auth (G)
1862 This parameter has been deprecated since Samba 4.13 and support for
1864 plaintext (as distinct from NTLM, NTLMv2 or Kerberos
1865 authentication) will be removed in a future Samba release.
1866 That is, in the future, the current default of client plaintext
1868 auth = no will be the enforced behaviour.
1869 Specifies whether a client should send a plaintext password if the
1871 server does not support encrypted passwords.
1872 Default: client plaintext auth = no
1874 client protection (G)
1876 This parameter defines which protection Samba client tools should
1878 use by default.
1879 Possible client settings are:
1881 • default - Use the individual default values of the
1883 options:
1884 • client signing
1886 • client smb encrypt
1888 • plain - This will send everything just as plaintext,
1891 signing or encryption are turned off.
1892 • sign - This will enable integrity checking.
1894 • encrypt - This will enable integrity checks and force
1896 encryption for privacy.
1897 Default: client protection = default
1899 client schannel (G)
1901 This option is deprecated with Samba 4.8 and will be removed in
1903 future. At the same time the default changed to yes, which will be
1904 the hardcoded behavior in future.
1905 This controls whether the client offers or even demands the use of
1907 the netlogon schannel. client schannel = no does not offer the
1908 schannel, client schannel = auto offers the schannel but does not
1909 enforce it, and client schannel = yes denies access if the server
1910 is not able to speak netlogon schannel.
1911 Note that for active directory domains this is hardcoded to client
1913 schannel = yes.
1914 This option is over-ridden by the require strong key option.
1916 Default: client schannel = yes
1918 Example: client schannel = auto
1920 client signing (G)
1922 This controls whether the client is allowed or required to use SMB
1924 signing. Possible values are desired, required and disabled.
1925 When set to desired or default, SMB signing is offered, but not
1927 enforced.
1928 When set to required, SMB signing is mandatory and if set to
1930 disabled, SMB signing is not offered either.
1931 IPC$ connections for DCERPC e.g. in winbindd, are handled by the
1933 client ipc signing option.
1934 Default: client signing = default
1936 client smb encrypt (G)
1938 This parameter controls whether a client should try or is required
1940 to use SMB encryption. It has different effects depending on
1941 whether the connection uses SMB1 or SMB3:
1942 • If the connection uses SMB1, then this option controls
1944 the use of a Samba-specific extension to the SMB
1945 protocol introduced in Samba 3.2 that makes use of the
1946 Unix extensions.
1947 • If the connection uses SMB2 or newer, then this option
1949 controls the use of the SMB-level encryption that is
1950 supported in SMB version 3.0 and above and available in
1951 Windows 8 and newer.
1952 This parameter can be set globally. Possible values are off,
1954 if_required, desired, and required. A special value is default
1955 which is the implicit default setting of if_required.
1956 Effects for SMB1
1958 The Samba-specific encryption of SMB1 connections is an
1959 extension to the SMB protocol negotiated as part of the UNIX
1960 extensions. SMB encryption uses the GSSAPI (SSPI on Windows)
1961 ability to encrypt and sign every request/response in a SMB
1962 protocol stream. When enabled it provides a secure method of
1963 SMB/CIFS communication, similar to an ssh protected session,
1964 but using SMB/CIFS authentication to negotiate encryption and
1965 signing keys. Currently this is only supported smbclient of by
1966 Samba 3.2 and newer. Windows does not support this feature.
1967 When set to default, SMB encryption is probed, but not
1969 enforced. When set to required, SMB encryption is required and
1970 if set to disabled, SMB encryption can not be negotiated.
1971 Effects for SMB3 and newer
1973 Native SMB transport encryption is available in SMB version 3.0
1974 or newer. It is only used by Samba if client max protocol is
1975 set to SMB3 or newer.
1976 These features can be controlled with settings of client smb
1978 encrypt as follows:
1979 • Leaving it as default, explicitly setting default,
1981 or setting it to if_required globally will enable
1982 negotiation of encryption but will not turn on data
1983 encryption globally.
1984 • Setting it to desired globally will enable
1986 negotiation and will turn on data encryption on
1987 sessions and share connections for those servers
1988 that support it.
1989 • Setting it to required globally will enable
1991 negotiation and turn on data encryption on sessions
1992 and share connections. Clients that do not support
1993 encryption will be denied access to the server.
1994 • Setting it to off globally will completely disable
1996 the encryption feature for all connections.
1997 Default: client smb encrypt = default
2000 client smb3 encryption algorithms (G)
2002 This parameter specifies the availability and order of encryption
2004 algorithms which are available for negotiation in the SMB3_11
2005 dialect.
2006 It is also possible to remove individual algorithms from the
2008 default list, by prefixing them with '-'. This can avoid having to
2009 specify a hardcoded list.
2010 Note: that the removal of AES-128-CCM from the list will result in
2012 SMB3_00 and SMB3_02 being unavailable, as it is the default and
2013 only available algorithm for these dialects.
2014 Default: client smb3 encryption algorithms = AES-128-GCM,
2016 AES-128-CCM, AES-256-GCM, AES-256-CCM
2017 Example: client smb3 encryption algorithms = AES-256-GCM
2019 Example: client smb3 encryption algorithms = -AES-128-GCM
2021 -AES-128-CCM
2022 client smb3 signing algorithms (G)
2024 This parameter specifies the availability and order of signing
2026 algorithms which are available for negotiation in the SMB3_11
2027 dialect.
2028 It is also possible to remove individual algorithms from the
2030 default list, by prefixing them with '-'. This can avoid having to
2031 specify a hardcoded list.
2032 Note: that the removal of AES-128-CMAC from the list will result in
2034 SMB3_00 and SMB3_02 being unavailable, and the removal of
2035 HMAC-SHA256 will result in SMB2_02 and SMB2_10 being unavailable,
2036 as these are the default and only available algorithms for these
2037 dialects.
2038 Default: client smb3 signing algorithms = AES-128-GMAC,
2040 AES-128-CMAC, HMAC-SHA256
2041 Example: client smb3 signing algorithms = AES-128-CMAC, HMAC-SHA256
2043 Example: client smb3 signing algorithms = -AES-128-CMAC
2045 client use kerberos (G)
2047 This parameter determines whether Samba client tools will try to
2049 authenticate using Kerberos. For Kerberos authentication you need
2050 to use dns names instead of IP addresses when connecting to a
2051 service.
2052 Possible option settings are:
2054 • desired - Kerberos authentication will be tried first
2056 and if it fails it automatically fallback to NTLM.
2057 • required - Kerberos authentication will be required.
2059 There will be no falllback to NTLM or a different
2060 alternative.
2061 • off - Don't use Kerberos, use NTLM instead or another
2063 alternative.
2064 In case that weak cryptography is not allowed (e.g. FIPS mode) the
2066 default will be forced to required.
2067 Default: client use kerberos = desired
2069 client use spnego principal (G)
2071 This parameter determines whether or not smbclient(8) and other
2073 samba components acting as a client will attempt to use the
2074 server-supplied principal sometimes given in the SPNEGO exchange.
2075 If enabled, Samba can attempt to use Kerberos to contact servers
2077 known only by IP address. Kerberos relies on names, so ordinarily
2078 cannot function in this situation.
2079 This is a VERY BAD IDEA for security reasons, and so this parameter
2081 SHOULD NOT BE USED. It will be removed in a future version of
2082 Samba.
2083 If disabled, Samba will use the name used to look up the server
2085 when asking the KDC for a ticket. This avoids situations where a
2086 server may impersonate another, soliciting authentication as one
2087 principal while being known on the network as another.
2088 Note that Windows XP SP2 and later versions already follow this
2090 behaviour, and Windows Vista and later servers no longer supply
2091 this 'rfc4178 hint' principal on the server side.
2092 This parameter is deprecated in Samba 4.2.1 and will be removed
2094 (along with the functionality) in a later release of Samba.
2095 Default: client use spnego principal = no
2097 client use spnego (G)
2099 This parameter has been deprecated since Samba 4.13 and support for
2101 NTLMv2, NTLM and LanMan authentication outside NTLMSSP will be
2102 removed in a future Samba release.
2103 That is, in the future, the current default of client use spnego =
2105 yes will be the enforced behaviour.
2106 This variable controls whether Samba clients will try to use Simple
2108 and Protected NEGOtiation (as specified by rfc2478) with supporting
2109 servers (including WindowsXP, Windows2000 and Samba 3.0) to agree
2110 upon an authentication mechanism. This enables Kerberos
2111 authentication in particular.
2112 When client NTLMv2 auth is also set to yes extended security
2114 (SPNEGO) is required in order to use NTLMv2 only within NTLMSSP.
2115 This behavior was introduced with the patches for CVE-2016-2111.
2116 Default: client use spnego = yes
2118 cluster addresses (G)
2120 With this parameter you can add additional addresses that nmbd will
2122 register with a WINS server. Similarly, these addresses will be
2123 registered by default when net ads dns register is called with
2124 clustering = yes configured.
2125 Default: cluster addresses =
2127 Example: cluster addresses = 10.0.0.1 10.0.0.2 10.0.0.3
2129 clustering (G)
2131 This parameter specifies whether Samba should contact ctdb for
2133 accessing its tdb files and use ctdb as a backend for its messaging
2134 backend.
2135 Set this parameter to yes only if you have a cluster setup with
2137 ctdb running.
2138 Default: clustering = no
2140 comment (S)
2142 This is a text field that is seen next to a share when a client
2144 does a queries the server, either via the network neighborhood or
2145 via net view to list what shares are available.
2146 If you want to set the string that is displayed next to the machine
2148 name then see the server string parameter.
2149 Default: comment = # No comment
2151 Example: comment = Fred's Files
2153 config backend (G)
2155 This controls the backend for storing the configuration. Possible
2157 values are file (the default) and registry. When config backend =
2158 registry is encountered while loading smb.conf, the configuration
2159 read so far is dropped and the global options are read from
2160 registry instead. So this triggers a registry only configuration.
2161 Share definitions are not read immediately but instead registry
2162 shares is set to yes.
2163 Note: This option can not be set inside the registry configuration
2165 itself.
2166 Default: config backend = file
2168 Example: config backend = registry
2170 config file (G)
2172 This allows you to override the config file to use, instead of the
2174 default (usually smb.conf). There is a chicken and egg problem here
2175 as this option is set in the config file!
2176 For this reason, if the name of the config file has changed when
2178 the parameters are loaded then it will reload them from the new
2179 config file.
2180 This option takes the usual substitutions, which can be very
2182 useful.
2183 If the config file doesn't exist then it won't be loaded (allowing
2185 you to special case the config files of just a few clients).
2186 No default
2188 Example: config file = /usr/local/samba/lib/smb.conf.%m
2190 copy (S)
2192 This parameter allows you to "clone" service entries. The specified
2194 service is simply duplicated under the current service's name. Any
2195 parameters specified in the current section will override those in
2196 the section being copied.
2197 This feature lets you set up a 'template' service and create
2199 similar services easily. Note that the service being copied must
2200 occur earlier in the configuration file than the service doing the
2201 copying.
2202 Default: copy =
2204 Example: copy = otherservice
2206 create krb5 conf (G)
2208 Setting this parameter to no prevents winbind from creating custom
2210 krb5.conf files. Winbind normally does this because the krb5
2211 libraries are not AD-site-aware and thus would pick any domain
2212 controller out of potentially very many. Winbind is site-aware and
2213 makes the krb5 libraries use a local DC by creating its own
2214 krb5.conf files.
2215 Preventing winbind from doing this might become necessary if you
2217 have to add special options into your system-krb5.conf that winbind
2218 does not see.
2219 Default: create krb5 conf = yes
2221 create mode
2223 This parameter is a synonym for create mask.
2225 create mask (S)
2227 When a file is created, the necessary permissions are calculated
2229 according to the mapping from DOS modes to UNIX permissions, and
2230 the resulting UNIX mode is then bit-wise 'AND'ed with this
2231 parameter. This parameter may be thought of as a bit-wise MASK for
2232 the UNIX modes of a file. Any bit not set here will be removed from
2233 the modes set on a file when it is created.
2234 The default value of this parameter removes the group and other
2236 write and execute bits from the UNIX modes.
2237 Following this Samba will bit-wise 'OR' the UNIX mode created from
2239 this parameter with the value of the force create mode parameter
2240 which is set to 000 by default.
2241 This parameter does not affect directory masks. See the parameter
2243 directory mask for details.
2244 Default: create mask = 0744
2246 Example: create mask = 0775
2248 csc policy (S)
2250 This stands for client-side caching policy, and specifies how
2252 clients capable of offline caching will cache the files in the
2253 share. The valid values are: manual, documents, programs, disable.
2254 These values correspond to those used on Windows servers.
2256 For example, shares containing roaming profiles can have offline
2258 caching disabled using csc policy = disable.
2259 Default: csc policy = manual
2261 Example: csc policy = programs
2263 ctdbd socket (G)
2265 If you set clustering=yes, you need to tell Samba where ctdbd
2267 listens on its unix domain socket. The default path as of ctdb 1.0
2268 is /tmp/ctdb.socket which you have to explicitly set for Samba in
2269 smb.conf.
2270 Default: ctdbd socket =
2272 Example: ctdbd socket = /tmp/ctdb.socket
2274 ctdb locktime warn threshold (G)
2276 In a cluster environment using Samba and ctdb it is critical that
2278 locks on central ctdb-hosted databases like locking.tdb are not
2279 held for long. With the current Samba architecture it happens that
2280 Samba takes a lock and while holding that lock makes file system
2281 calls into the shared cluster file system. This option makes Samba
2282 warn if it detects that it has held locks for the specified number
2283 of milliseconds. If this happens, smbd will emit a debug level 0
2284 message into its logs and potentially into syslog. The most likely
2285 reason for such a log message is that an operation of the cluster
2286 file system Samba exports is taking longer than expected. The
2287 messages are meant as a debugging aid for potential cluster
2288 problems.
2289 The default value of 0 disables this logging.
2291 Default: ctdb locktime warn threshold = 0
2293 ctdb timeout (G)
2295 This parameter specifies a timeout in milliseconds for the
2297 connection between Samba and ctdb. It is only valid if you have
2298 compiled Samba with clustering and if you have set clustering=yes.
2299 When something in the cluster blocks, it can happen that we wait
2301 indefinitely long for ctdb, just adding to the blocking condition.
2302 In a well-running cluster this should never happen, but there are
2303 too many components in a cluster that might have hickups. Choosing
2304 the right balance for this value is very tricky, because on a busy
2305 cluster long service times to transfer something across the cluster
2306 might be valid. Setting it too short will degrade the service your
2307 cluster presents, setting it too long might make the cluster itself
2308 not recover from something severely broken for too long.
2309 Be aware that if you set this parameter, this needs to be in the
2311 file smb.conf, it is not really helpful to put this into a registry
2312 configuration (typical on a cluster), because to access the
2313 registry contact to ctdb is required.
2314 Setting ctdb timeout to n makes any process waiting longer than n
2316 milliseconds for a reply by the cluster panic. Setting it to 0 (the
2317 default) makes Samba block forever, which is the highly recommended
2318 default.
2319 Default: ctdb timeout = 0
2321 cups connection timeout (G)
2323 This parameter is only applicable if printing is set to cups.
2325 If set, this option specifies the number of seconds that smbd will
2327 wait whilst trying to contact to the CUPS server. The connection
2328 will fail if it takes longer than this number of seconds.
2329 Default: cups connection timeout = 30
2331 Example: cups connection timeout = 60
2333 cups encrypt (G)
2335 This parameter is only applicable if printing is set to cups and if
2337 you use CUPS newer than 1.0.x.It is used to define whether or not
2338 Samba should use encryption when talking to the CUPS server.
2339 Possible values are auto, yes and no
2340 When set to auto we will try to do a TLS handshake on each CUPS
2342 connection setup. If that fails, we will fall back to unencrypted
2343 operation.
2344 Default: cups encrypt = no
2346 cups options (S)
2348 This parameter is only applicable if printing is set to cups. Its
2350 value is a free form string of options passed directly to the cups
2351 library.
2352 You can pass any generic print option known to CUPS (as listed in
2354 the CUPS "Software Users' Manual"). You can also pass any printer
2355 specific option (as listed in "lpoptions -d printername -l") valid
2356 for the target queue. Multiple parameters should be space-delimited
2357 name/value pairs according to the PAPI text option ABNF
2358 specification. Collection values ("name={a=... b=... c=...}") are
2359 stored with the curley brackets intact.
2360 You should set this parameter to raw if your CUPS server error_log
2362 file contains messages such as "Unsupported format
2363 'application/octet-stream'" when printing from a Windows client
2364 through Samba. It is no longer necessary to enable system wide raw
2365 printing in /etc/cups/mime.{convs,types}.
2366 Default: cups options = ""
2368 Example: cups options = "raw media=a4"
2370 cups server (G)
2372 This parameter is only applicable if printing is set to cups.
2374 If set, this option overrides the ServerName option in the CUPS
2376 client.conf. This is necessary if you have virtual samba servers
2377 that connect to different CUPS daemons.
2378 Optionally, a port can be specified by separating the server name
2380 and port number with a colon. If no port was specified, the default
2381 port for IPP (631) will be used.
2382 Default: cups server = ""
2384 Example: cups server = mycupsserver
2386 Example: cups server = mycupsserver:1631
2388 dcerpc endpoint servers (G)
2390 Specifies which DCE/RPC endpoint servers should be run.
2392 Default: dcerpc endpoint servers = epmapper, wkssvc, samr,
2394 netlogon, lsarpc, drsuapi, dssetup, unixinfo, browser, eventlog6,
2395 backupkey, dnsserver
2396 Example: dcerpc endpoint servers = rpcecho
2398 deadtime (G)
2400 The value of the parameter (a decimal integer) represents the
2402 number of minutes of inactivity before a connection is considered
2403 dead, and it is disconnected. The deadtime only takes effect if the
2404 number of open files is zero.
2405 This is useful to stop a server's resources being exhausted by a
2407 large number of inactive connections.
2408 Most clients have an auto-reconnect feature when a connection is
2410 broken so in most cases this parameter should be transparent to
2411 users.
2412 Using this parameter with a timeout of a few minutes is recommended
2414 for most systems.
2415 A deadtime of zero indicates that no auto-disconnection should be
2417 performed.
2418 Default: deadtime = 10080
2420 Example: deadtime = 15
2422 debug class (G)
2424 With this boolean parameter enabled, the debug class (DBGC_CLASS)
2426 will be displayed in the debug header.
2427 For more information about currently available debug classes, see
2429 section about log level.
2430 Default: debug class = no
2432 debug encryption (G)
2434 This option will make the smbd server and client code using libsmb
2436 (smbclient, smbget, smbspool, ...) dump the Session Id, the
2437 decrypted Session Key, the Signing Key, the Application Key, the
2438 Encryption Key and the Decryption Key every time an SMB3+ session
2439 is established. This information will be printed in logs at level
2440 0.
2441 Warning: access to these values enables the decryption of any
2443 encrypted traffic on the dumped sessions. This option should only
2444 be enabled for debugging purposes.
2445 Default: debug encryption = no
2447 debug hires timestamp (G)
2449 Sometimes the timestamps in the log messages are needed with a
2451 resolution of higher that seconds, this boolean parameter adds
2452 microsecond resolution to the timestamp message header when turned
2453 on.
2454 Note that the parameter debug timestamp or debug syslog format must
2456 be on for this to have an effect.
2457 Default: debug hires timestamp = yes
2459 debug pid (G)
2461 When using only one log file for more then one forked
2463 smbd(8)-process there may be hard to follow which process outputs
2464 which message. This boolean parameter is adds the process-id to the
2465 timestamp message headers in the logfile when turned on.
2466 Note that the parameter debug timestamp must be on for this to have
2468 an effect.
2469 Default: debug pid = no
2471 debug prefix timestamp (G)
2473 With this option enabled, the timestamp message header is prefixed
2475 to the debug message without the filename and function information
2476 that is included with the debug timestamp parameter. This gives
2477 timestamps to the messages without adding an additional line.
2478 Note that this parameter overrides the debug timestamp parameter.
2480 Default: debug prefix timestamp = no
2482 debug syslog format (G)
2484 With this option enabled (yes (alias in_logs) or always), debug
2486 messages are printed in a single-line format like that
2487 traditionally produced by syslog. The timestamp consists of an
2488 abbreviated month, space-padded date, and time including seconds.
2489 This is followed by the hostname and the program name, with the
2490 process-ID in square brackets.
2491 The value always produces this log format even to STDOUT or STDERR
2493 The value no defers to other parameters and typically produces
2495 traditional two-line Samba logs to log files.
2496 If debug hires timestamp is also enabled then an RFC5424 timestamp
2498 is used instead.
2499 Default: debug syslog format = no
2501 winbind debug traceid (G)
2503 With this boolean parameter enabled, the per request unique traceid
2505 will be displayed in the debug header for winbind processes.
2506 Default: winbind debug traceid = no
2508 debug uid (G)
2510 Samba is sometimes run as root and sometime run as the connected
2512 user, this boolean parameter inserts the current euid, egid, uid
2513 and gid to the timestamp message headers in the log file if turned
2514 on.
2515 Note that the parameter debug timestamp must be on for this to have
2517 an effect.
2518 Default: debug uid = no
2520 dedicated keytab file (G)
2522 Specifies the absolute path to the kerberos keytab file when
2524 kerberos method is set to "dedicated keytab".
2525 Default: dedicated keytab file =
2527 Example: dedicated keytab file = /usr/local/etc/krb5.keytab
2529 default case (S)
2531 See the section on name mangling. Also note the short preserve case
2533 parameter.
2534 Default: default case = lower
2536 default devmode (S)
2538 This parameter is only applicable to printable services. When smbd
2540 is serving Printer Drivers to Windows NT/2k/XP clients, each
2541 printer on the Samba server has a Device Mode which defines things
2542 such as paper size and orientation and duplex settings. The device
2543 mode can only correctly be generated by the printer driver itself
2544 (which can only be executed on a Win32 platform). Because smbd is
2545 unable to execute the driver code to generate the device mode, the
2546 default behavior is to set this field to NULL.
2547 Most problems with serving printer drivers to Windows NT/2k/XP
2549 clients can be traced to a problem with the generated device mode.
2550 Certain drivers will do things such as crashing the client's
2551 Explorer.exe with a NULL devmode. However, other printer drivers
2552 can cause the client's spooler service (spoolsv.exe) to die if the
2553 devmode was not created by the driver itself (i.e. smbd generates a
2554 default devmode).
2555 This parameter should be used with care and tested with the printer
2557 driver in question. It is better to leave the device mode to NULL
2558 and let the Windows client set the correct values. Because drivers
2559 do not do this all the time, setting default devmode = yes will
2560 instruct smbd to generate a default one.
2561 For more information on Windows NT/2k printing and Device Modes,
2563 see the MSDN documentation.
2564 Default: default devmode = yes
2566 default
2568 This parameter is a synonym for default service.
2570 default service (G)
2572 This parameter specifies the name of a service which will be
2574 connected to if the service actually requested cannot be found.
2575 Note that the square brackets are NOT given in the parameter value
2576 (see example below).
2577 There is no default value for this parameter. If this parameter is
2579 not given, attempting to connect to a nonexistent service results
2580 in an error.
2581 Typically the default service would be a guest ok, read only
2583 service.
2584 Also note that the apparent service name will be changed to equal
2586 that of the requested service, this is very useful as it allows you
2587 to use macros like %S to make a wildcard service.
2588 Note also that any "_" characters in the name of the service used
2590 in the default service will get mapped to a "/". This allows for
2591 interesting things.
2592 Default: default service =
2594 Example: default service = pub
2596 defer sharing violations (G)
2598 Windows allows specifying how a file will be shared with other
2600 processes when it is opened. Sharing violations occur when a file
2601 is opened by a different process using options that violate the
2602 share settings specified by other processes. This parameter causes
2603 smbd to act as a Windows server does, and defer returning a
2604 "sharing violation" error message for up to one second, allowing
2605 the client to close the file causing the violation in the meantime.
2606 UNIX by default does not have this behaviour.
2608 There should be no reason to turn off this parameter, as it is
2610 designed to enable Samba to more correctly emulate Windows.
2611 Default: defer sharing violations = yes
2613 delete group script (G)
2615 This is the full pathname to a script that will be run AS ROOT by
2617 smbd(8) when a group is requested to be deleted. It will expand any
2618 %g to the group name passed. This script is only useful for
2619 installations using the Windows NT domain administration tools.
2620 Default: delete group script =
2622 deleteprinter command (G)
2624 With the introduction of MS-RPC based printer support for Windows
2626 NT/2000 clients in Samba 2.2, it is now possible to delete a
2627 printer at run time by issuing the DeletePrinter() RPC call.
2628 For a Samba host this means that the printer must be physically
2630 deleted from the underlying printing system. The deleteprinter
2631 command defines a script to be run which will perform the necessary
2632 operations for removing the printer from the print system and from
2633 smb.conf.
2634 The deleteprinter command is automatically called with only one
2636 parameter: printer name.
2637 Once the deleteprinter command has been executed, smbd will reparse
2639 the smb.conf to check that the associated printer no longer exists.
2640 If the sharename is still valid, then smbd will return an
2641 ACCESS_DENIED error to the client.
2642 Default: deleteprinter command =
2644 Example: deleteprinter command = /usr/bin/removeprinter
2646 delete readonly (S)
2648 This parameter allows readonly files to be deleted. This is not
2650 normal DOS semantics, but is allowed by UNIX.
2651 This option may be useful for running applications such as rcs,
2653 where UNIX file ownership prevents changing file permissions, and
2654 DOS semantics prevent deletion of a read only file.
2655 Default: delete readonly = no
2657 delete share command (G)
2659 Samba 2.2.0 introduced the ability to dynamically add and delete
2661 shares via the Windows NT 4.0 Server Manager. The delete share
2662 command is used to define an external program or script which will
2663 remove an existing service definition from smb.conf.
2664 In order to successfully execute the delete share command, smbd
2666 requires that the administrator connects using a root account (i.e.
2667 uid == 0) or has the SeDiskOperatorPrivilege. Scripts defined in
2668 the delete share command parameter are executed as root.
2669 When executed, smbd will automatically invoke the delete share
2671 command with two parameters.
2672 • configFile - the location of the global smb.conf file.
2674 • shareName - the name of the existing service.
2676 This parameter is only used to remove file shares. To delete
2678 printer shares, see the deleteprinter command.
2679 Default: delete share command =
2681 Example: delete share command = /usr/local/bin/delshare
2683 delete user from group script (G)
2685 Full path to the script that will be called when a user is removed
2687 from a group using the Windows NT domain administration tools. It
2688 will be run by smbd(8) AS ROOT. Any %g will be replaced with the
2689 group name and any %u will be replaced with the user name.
2690 Default: delete user from group script =
2692 Example: delete user from group script = /usr/sbin/deluser %u %g
2694 delete user script (G)
2696 This is the full pathname to a script that will be run by smbd(8)
2698 when managing users with remote RPC (NT) tools.
2699 This script is called when a remote client removes a user from the
2701 server, normally using 'User Manager for Domains' or rpcclient.
2702 This script should delete the given UNIX username.
2704 Default: delete user script =
2706 Example: delete user script = /usr/local/samba/bin/del_user %u
2708 delete veto files (S)
2710 This option is used when Samba is attempting to delete a directory
2712 that contains one or more vetoed files or directories or
2713 non-visible files or directories (such as dangling symlinks that
2714 point nowhere). (see the veto files, hide special files, hide
2715 unreadable, hide unwriteable files options). If this option is set
2716 to no (the default) then if a vetoed directory contains any
2717 non-vetoed files or directories then the directory delete will
2718 fail. This is usually what you want.
2719 If this option is set to yes, then Samba will attempt to
2721 recursively delete any files and directories within the vetoed
2722 directory. This can be useful for integration with file serving
2723 systems such as NetAtalk which create meta-files within directories
2724 you might normally veto DOS/Windows users from seeing (e.g.
2725 .AppleDouble)
2726 Setting delete veto files = yes allows these directories to be
2728 transparently deleted when the parent directory is deleted (so long
2729 as the user has permissions to do so).
2730 Default: delete veto files = no
2732 dfree cache time (S)
2734 The dfree cache time should only be used on systems where a problem
2736 occurs with the internal disk space calculations. This has been
2737 known to happen with Ultrix, but may occur with other operating
2738 systems. The symptom that was seen was an error of "Abort Retry
2739 Ignore" at the end of each directory listing.
2740 This is a new parameter introduced in Samba version 3.0.21. It
2742 specifies in seconds the time that smbd will cache the output of a
2743 disk free query. If set to zero (the default) no caching is done.
2744 This allows a heavily loaded server to prevent rapid spawning of
2745 dfree command scripts increasing the load.
2746 By default this parameter is zero, meaning no caching will be done.
2748 No default
2750 Example: dfree cache time = 60
2752 dfree command (S)
2754 The dfree command setting should only be used on systems where a
2756 problem occurs with the internal disk space calculations. This has
2757 been known to happen with Ultrix, but may occur with other
2758 operating systems. The symptom that was seen was an error of "Abort
2759 Retry Ignore" at the end of each directory listing.
2760 This setting allows the replacement of the internal routines to
2762 calculate the total disk space and amount available with an
2763 external routine. The example below gives a possible script that
2764 might fulfill this function.
2765 In Samba version 3.0.21 this parameter has been changed to be a
2767 per-share parameter, and in addition the parameter dfree cache time
2768 was added to allow the output of this script to be cached for
2769 systems under heavy load.
2770 The external program will be passed a single parameter indicating a
2772 directory in the filesystem being queried. This will typically
2773 consist of the string ./. The script should return two integers in
2774 ASCII. The first should be the total disk space in blocks, and the
2775 second should be the number of available blocks. An optional third
2776 return value can give the block size in bytes. The default
2777 blocksize is 1024 bytes.
2778 Note: Your script should NOT be setuid or setgid and should be
2780 owned by (and writeable only by) root!
2781 Where the script dfree (which must be made executable) could be:
2783 #!/bin/sh
2786 df "$1" | tail -1 | awk '{print $(NF-4),$(NF-2)}'
2787 or perhaps (on Sys V based systems):
2789 #!/bin/sh
2792 /usr/bin/df -k "$1" | tail -1 | awk '{print $3" "$5}'
2793 Note that you may have to replace the command names with full path
2795 names on some systems. Also note the arguments passed into the
2796 script should be quoted inside the script in case they contain
2797 special characters such as spaces or newlines.
2798 By default internal routines for determining the disk capacity and
2800 remaining space will be used.
2801 No default
2803 Example: dfree command = /usr/local/samba/bin/dfree
2805 dgram port (G)
2807 Specifies which ports the server should listen on for NetBIOS
2809 datagram traffic.
2810 Default: dgram port = 138
2812 directory mode
2814 This parameter is a synonym for directory mask.
2816 directory mask (S)
2818 This parameter is the octal modes which are used when converting
2820 DOS modes to UNIX modes when creating UNIX directories.
2821 When a directory is created, the necessary permissions are
2823 calculated according to the mapping from DOS modes to UNIX
2824 permissions, and the resulting UNIX mode is then bit-wise 'AND'ed
2825 with this parameter. This parameter may be thought of as a bit-wise
2826 MASK for the UNIX modes of a directory. Any bit not set here will
2827 be removed from the modes set on a directory when it is created.
2828 The default value of this parameter removes the 'group' and 'other'
2830 write bits from the UNIX mode, allowing only the user who owns the
2831 directory to modify it.
2832 Following this Samba will bit-wise 'OR' the UNIX mode created from
2834 this parameter with the value of the force directory mode
2835 parameter. This parameter is set to 000 by default (i.e. no extra
2836 mode bits are added).
2837 Default: directory mask = 0755
2839 Example: directory mask = 0775
2841 directory security mask (S)
2843 This parameter has been removed for Samba 4.0.0.
2845 No default
2847 disable netbios (G)
2849 Enabling this parameter will disable netbios support in Samba.
2851 Netbios is the only available form of browsing in Windows versions
2852 prior to Windows 2000.
2853 Note
2855 Clients that only support netbios won't be able to see your
2856 samba server when netbios support is disabled.
2857 Default: disable netbios = no
2858 disable spoolss (G)
2860 Enabling this parameter will disable Samba's support for the
2862 SPOOLSS set of MS-RPC's and will yield identical behavior as Samba
2863 2.0.x. Windows NT/2000 clients will downgrade to using Lanman style
2864 printing commands. Windows 9x/ME will be unaffected by the
2865 parameter. However, this will also disable the ability to upload
2866 printer drivers to a Samba server via the Windows NT Add Printer
2867 Wizard or by using the NT printer properties dialog window. It will
2868 also disable the capability of Windows NT/2000 clients to download
2869 print drivers from the Samba host upon demand. Be very careful
2870 about enabling this parameter.
2871 Default: disable spoolss = no
2873 dmapi support (S)
2875 This parameter specifies whether Samba should use DMAPI to
2877 determine whether a file is offline or not. This would typically be
2878 used in conjunction with a hierarchical storage system that
2879 automatically migrates files to tape.
2880 Note that Samba infers the status of a file by examining the events
2882 that a DMAPI application has registered interest in. This heuristic
2883 is satisfactory for a number of hierarchical storage systems, but
2884 there may be system for which it will fail. In this case, Samba may
2885 erroneously report files to be offline.
2886 This parameter is only available if a supported DMAPI
2888 implementation was found at compilation time. It will only be used
2889 if DMAPI is found to enabled on the system at run time.
2890 Default: dmapi support = no
2892 dns forwarder (G)
2894 This option specifies the list of DNS servers that DNS requests
2896 will be forwarded to if they can not be handled by Samba itself.
2897 The DNS forwarder is only used if the internal DNS server in Samba
2899 is used. Port numbers can be appended by separating them from the
2900 address by using a colon (':'). When specifying a port, IPv6
2901 addresses must be enclosed in square brackets ('[' and ']'). IPv6
2902 forwarder addresses with no port specified, don't need the square
2903 brackets, and default to port 53.
2904 Default: dns forwarder =
2906 Example: dns forwarder = 192.168.0.1 192.168.0.2 ::1 [2001:db8::1]
2908 [2001:db8:1:2::1]:54
2909 dns port (G)
2911 Specifies which ports the server should listen on for DNS traffic.
2913 It makes possible to use another DNS server as a front and forward
2915 to Samba.
2916 Warning
2918 Dynamic DNS updates may not be proxied by the front DNS server
2919 when forwarding to Samba. Dynamic DNS update proxying depends
2920 on the features of the other DNS server used as a front.
2921 Default: dns port = 53
2922 dns proxy (G)
2924 Specifies that nmbd(8) when acting as a WINS server and finding
2926 that a NetBIOS name has not been registered, should treat the
2927 NetBIOS name word-for-word as a DNS name and do a lookup with the
2928 DNS server for that name on behalf of the name-querying client.
2929 Note that the maximum length for a NetBIOS name is 15 characters,
2931 so the DNS name (or DNS alias) can likewise only be 15 characters,
2932 maximum.
2933 nmbd spawns a second copy of itself to do the DNS name lookup
2935 requests, as doing a name lookup is a blocking action.
2936 Default: dns proxy = yes
2938 dns update command (G)
2940 This option sets the command that is called when there are DNS
2942 updates. It should update the local machines DNS names using
2943 TSIG-GSS.
2944 Default: dns update command =
2946 /builddir/build/BUILD/samba-4.19.3/source4/scripting/bin/samba_dnsupdate
2947 Example: dns update command = /usr/local/sbin/dnsupdate
2949 dns zone scavenging (G)
2951 When enabled (the default is disabled) unused dynamic dns records
2953 are periodically removed.
2954 Warning
2956 This option should not be enabled for installations created
2957 with versions of samba before 4.9. Doing this will result in
2958 the loss of static DNS entries. This is due to a bug in
2959 previous versions of samba (BUG 12451) which marked dynamic DNS
2960 records as static and static records as dynamic.
2961 Note
2963 If one record for a DNS name is static (non-aging) then no
2964 other record for that DNS name will be scavenged.
2965 Default: dns zone scavenging = no
2966 dns zone transfer clients allow (G)
2968 This option specifies the list of IPs authorized to ask for dns
2970 zone transfer from bind DLZ module.
2971 The IP list is comma and space separated and specified in the same
2973 syntax as used in hosts allow, specifically including IP address,
2974 IP prefixes and IP address masks.
2975 As this is a DNS server option, hostnames are naturally not
2977 permitted.
2978 The default behaviour is to deny any request. A request will be
2980 authorized only if the emitting client is identified in this list,
2981 and not in dns zone transfer clients deny
2982 Default: dns zone transfer clients allow =
2984 Example: dns zone transfer clients allow = 192.168.0.1
2986 dns zone transfer clients deny (G)
2988 This option specifies the list of IPs denied to ask for dns zone
2990 transfer from bind DLZ module.
2991 The IP list is comma and space separated and specified in the same
2993 syntax as used in hosts allow, specifically including IP address,
2994 IP prefixes and IP address masks.
2995 As this is a DNS server option, hostnames are naturally not
2997 permitted.
2998 If a client identified in this list sends a zone transfer request,
3000 it will always be denied, even if they are in dns zone transfer
3001 clients allow. This allows the definition of specific denied
3002 clients within an authorized subnet.
3003 Default: dns zone transfer clients deny =
3005 Example: dns zone transfer clients deny = 192.168.0.1
3007 domain logons (G)
3009 This parameter has been deprecated since Samba 4.13 and support for
3011 NT4-style domain logons(as distinct from the Samba AD DC) will be
3012 removed in a future Samba release.
3013 That is, in the future, the current default of domain logons = no
3015 will be the enforced behaviour.
3016 If set to yes, the Samba server will provide the netlogon service
3018 for Windows 9X network logons for the workgroup it is in. This will
3019 also cause the Samba server to act as a domain controller for NT4
3020 style domain services. For more details on setting up this feature
3021 see the Domain Control chapter of the Samba HOWTO Collection.
3022 Default: domain logons = no
3024 domain master (G)
3026 Tell smbd(8) to enable WAN-wide browse list collation. Setting this
3028 option causes nmbd to claim a special domain specific NetBIOS name
3029 that identifies it as a domain master browser for its given
3030 workgroup. Local master browsers in the same workgroup on
3031 broadcast-isolated subnets will give this nmbd their local browse
3032 lists, and then ask smbd(8) for a complete copy of the browse list
3033 for the whole wide area network. Browser clients will then contact
3034 their local master browser, and will receive the domain-wide browse
3035 list, instead of just the list for their broadcast-isolated subnet.
3036 Note that Windows NT Primary Domain Controllers expect to be able
3038 to claim this workgroup specific special NetBIOS name that
3039 identifies them as domain master browsers for that workgroup by
3040 default (i.e. there is no way to prevent a Windows NT PDC from
3041 attempting to do this). This means that if this parameter is set
3042 and nmbd claims the special name for a workgroup before a Windows
3043 NT PDC is able to do so then cross subnet browsing will behave
3044 strangely and may fail.
3045 If domain logons = yes, then the default behavior is to enable the
3047 domain master parameter. If domain logons is not enabled (the
3048 default setting), then neither will domain master be enabled by
3049 default.
3050 When domain logons = Yes the default setting for this parameter is
3052 Yes, with the result that Samba will be a PDC. If domain master =
3053 No, Samba will function as a BDC. In general, this parameter should
3054 be set to 'No' only on a BDC.
3055 Default: domain master = auto
3057 dont descend (S)
3059 There are certain directories on some systems (e.g., the /proc tree
3061 under Linux) that are either not of interest to clients or are
3062 infinitely deep (recursive). This parameter allows you to specify a
3063 comma-delimited list of directories that the server should always
3064 show as empty.
3065 Note that Samba can be very fussy about the exact format of the
3067 "dont descend" entries. For example you may need ./proc instead of
3068 just /proc. Experimentation is the best policy :-)
3069 Default: dont descend =
3071 Example: dont descend = /proc,/dev
3073 dos charset (G)
3075 DOS SMB clients assume the server has the same charset as they do.
3077 This option specifies which charset Samba should use to talk to DOS
3078 clients.
3079 The default depends on which charsets you have installed. Samba
3081 tries to use charset 850 but falls back to ASCII in case it is not
3082 available. Run testparm(1) to check the default on your system.
3083 No default
3085 dos filemode (S)
3087 The default behavior in Samba is to provide UNIX-like behavior
3089 where only the owner of a file/directory is able to change the
3090 permissions on it. However, this behavior is often confusing to
3091 DOS/Windows users. Enabling this parameter allows a user who has
3092 write access to the file (by whatever means, including an ACL
3093 permission) to modify the permissions (including ACL) on it. Note
3094 that a user belonging to the group owning the file will not be
3095 allowed to change permissions if the group is only granted read
3096 access. Ownership of the file/directory may also be changed. Note
3097 that using the VFS modules acl_xattr or acl_tdb which store native
3098 Windows as meta-data will automatically turn this option on for any
3099 share for which they are loaded, as they require this option to
3100 emulate Windows ACLs correctly.
3101 Default: dos filemode = no
3103 dos filetime resolution (S)
3105 Under the DOS and Windows FAT filesystem, the finest granularity on
3107 time resolution is two seconds. Setting this parameter for a share
3108 causes Samba to round the reported time down to the nearest two
3109 second boundary when a query call that requires one second
3110 resolution is made to smbd(8).
3111 This option is mainly used as a compatibility option for Visual C++
3113 when used against Samba shares. If oplocks are enabled on a share,
3114 Visual C++ uses two different time reading calls to check if a file
3115 has changed since it was last read. One of these calls uses a
3116 one-second granularity, the other uses a two second granularity. As
3117 the two second call rounds any odd second down, then if the file
3118 has a timestamp of an odd number of seconds then the two timestamps
3119 will not match and Visual C++ will keep reporting the file has
3120 changed. Setting this option causes the two timestamps to match,
3121 and Visual C++ is happy.
3122 Default: dos filetime resolution = no
3124 dos filetimes (S)
3126 Under DOS and Windows, if a user can write to a file they can
3128 change the timestamp on it. Under POSIX semantics, only the owner
3129 of the file or root may change the timestamp. By default, Samba
3130 emulates the DOS semantics and allows one to change the timestamp
3131 on a file if the user smbd is acting on behalf has write
3132 permissions. Due to changes in Microsoft Office 2000 and beyond,
3133 the default for this parameter has been changed from "no" to "yes"
3134 in Samba 3.0.14 and above. Microsoft Excel will display dialog box
3135 warnings about the file being changed by another user if this
3136 parameter is not set to "yes" and files are being shared between
3137 users.
3138 Default: dos filetimes = yes
3140 dsdb event notification (G)
3142 When enabled, this option causes Samba (acting as an Active
3144 Directory Domain Controller) to stream Samba database events across
3145 the internal message bus. Scripts built using Samba's python
3146 bindings can listen to these events by registering as the service
3147 dsdb_event.
3148 This is not needed for the audit logging described in log level.
3150 Instead, this should instead be considered a developer option (it
3152 assists in the Samba testsuite) rather than a facility for external
3153 auditing, as message delivery is not guaranteed (a feature that the
3154 testsuite works around).
3155 The Samba database events are also logged via the normal logging
3157 methods when the log level is set appropriately, say to
3158 dsdb_json_audit:5.
3159 Default: dsdb event notification = no
3161 dsdb group change notification (G)
3163 When enabled, this option causes Samba (acting as an Active
3165 Directory Domain Controller) to stream group membership change
3166 events across the internal message bus. Scripts built using Samba's
3167 python bindings can listen to these events by registering as the
3168 service dsdb_group_event.
3169 This is not needed for the audit logging described in log level.
3171 Instead, this should instead be considered a developer option (it
3173 assists in the Samba testsuite) rather than a facility for external
3174 auditing, as message delivery is not guaranteed (a feature that the
3175 testsuite works around).
3176 The Samba database events are also logged via the normal logging
3178 methods when the log level is set appropriately, say to
3179 dsdb_group_json_audit:5.
3180 Default: dsdb group change notification = no
3182 dsdb password event notification (G)
3184 When enabled, this option causes Samba (acting as an Active
3186 Directory Domain Controller) to stream password change and reset
3187 events across the internal message bus. Scripts built using Samba's
3188 python bindings can listen to these events by registering as the
3189 service password_event.
3190 This is not needed for the audit logging described in log level.
3192 Instead, this should instead be considered a developer option (it
3194 assists in the Samba testsuite) rather than a facility for external
3195 auditing, as message delivery is not guaranteed (a feature that the
3196 testsuite works around).
3197 The Samba database events are also logged via the normal logging
3199 methods when the log level is set appropriately, say to
3200 dsdb_password_json_audit:5.
3201 Default: dsdb password event notification = no
3203 durable handles (S)
3205 This boolean parameter controls whether Samba can grant SMB2
3207 durable file handles on a share.
3208 Note that durable handles are only enabled if kernel oplocks = no,
3210 kernel share modes = no, and posix locking = no, i.e. if the share
3211 is configured for CIFS/SMB2 only access, not supporting
3212 interoperability features with local UNIX processes or NFS
3213 operations.
3214 Also note that, for the time being, durability is not granted for a
3216 handle that has the delete on close flag set.
3217 Default: durable handles = yes
3219 ea support (S)
3221 This boolean parameter controls whether smbd(8) will allow clients
3223 to attempt to access extended attributes on a share. In order to
3224 enable this parameter on a setup with default VFS modules:
3225 • Samba must have been built with extended attributes
3227 support.
3228 • The underlying filesystem exposed by the share must
3230 support extended attributes (e.g. the getfattr(1) /
3231 setfattr(1) utilities must work).
3232 • Access to extended user attributes must be allowed by
3234 the underlying filesystem (e.g. when mounted with a
3235 system-dependent option like user_xattr on Linux).
3236 This option exposes the "user" attribute namespace from the
3238 underlying filesystem to clients. In order to match Windows
3239 conventions, the namespace prefix ("user.") is stripped from the
3240 attribute name on the client side. The handling of further
3241 attribute namespaces (like "security", "system", or "trusted") is
3242 not affected by this option.
3243 Note that the SMB protocol allows setting attributes whose value is
3245 64K bytes long, and that on NTFS, the maximum storage space for
3246 extended attributes per file is 64K. On some filesystem the limits
3247 may be lower. Filesystems with too limited EA space may experience
3248 unexpected weird effects. The default has changed to yes in Samba
3249 release 4.9.0 and above to allow better Windows fileserver
3250 compatibility in a default install.
3251 Default: ea support = yes
3253 elasticsearch:address (S)
3255 Specifies the name of the Elasticsearch server to use for Spotlight
3257 queries when using the Elasticsearch backend.
3258 Default: elasticsearch:address = localhost
3260 Example: elasticsearch:address = needle.haystack.samba.org
3262 elasticsearch:ignore unknown attribute (G)
3264 Ignore unknown Spotlight attributes in search queries. An example
3266 query using the unsupported attribute "kMDItemTopic" would be
3267 kMDItemTopic=="hotstuff". By default any query using such a type
3268 would completely fail. By enabling this option, if the type match
3269 is a subexpression of a larger expression, then this subexpression
3270 is just ignored.
3271 Default: elasticsearch:ignore unknown attribute = no
3273 Example: elasticsearch:ignore unknown attribute = yes
3275 elasticsearch:ignore unknown type (G)
3277 Ignore unknown Spotlight types in search queries. An example query
3279 using the unsupported type "public.calendar-event" would be
3280 kMDItemContentType=="public.calendar-event". By default any query
3281 using such a type would completely fail. By enabling this option,
3282 if the type match is a subexpression of a larger expression, then
3283 this subexpression is just ignored.
3284 Default: elasticsearch:ignore unknown type = no
3286 Example: elasticsearch:ignore unknown type = yes
3288 elasticsearch:index (S)
3290 Specifies the name of the Elasticsearch index to use for Spotlight
3292 queries when using the Elasticsearch backend. The default value of
3293 "_all" is a special Elasticsearch value that performs the search
3294 operation on all indices.
3295 Default: elasticsearch:index = _all
3297 Example: elasticsearch:index = spotlight
3299 elasticsearch:mappings (G)
3301 Path to a file specifying metadata attribute mappings in JSON
3303 format. Use by the Elasticsearch backend of the Spotlight RPC
3304 service.
3305 Default: elasticsearch:mappings =
3307 /usr/share/samba/elasticsearch_mappings.json
3308 Example: elasticsearch:mappings = /usr/share/foo/mymappings.json
3310 elasticsearch:max results (S)
3312 Path to a file specifying metadata attribute mappings in JSON
3314 format. Used by the Elasticsearch backend of the Spotlight RPC
3315 service. A value of 0 means no limit.
3316 Default: elasticsearch:max results = 100
3318 Example: elasticsearch:max results = 10
3320 elasticsearch:port (S)
3322 Specifies the TCP port of the Elasticsearch server to use for
3324 Spotlight queries when using the Elasticsearch backend.
3325 Default: elasticsearch:port = 9200
3327 Example: elasticsearch:port = 9201
3329 elasticsearch:use tls (S)
3331 Specifies whether to use HTTPS when talking to the Elasticsearch
3333 server used for Spotlight queries when using the Elasticsearch
3334 backend.
3335 Default: elasticsearch:use tls = no
3337 Example: elasticsearch:use tls = yes
3339 enable asu support (G)
3341 Hosts running the "Advanced Server for Unix (ASU)" product require
3343 some special accommodations such as creating a builtin [ADMIN$]
3344 share that only supports IPC connections. The has been the default
3345 behavior in smbd for many years. However, certain Microsoft
3346 applications such as the Print Migrator tool require that the
3347 remote server support an [ADMIN$] file share. Disabling this
3348 parameter allows for creating an [ADMIN$] file share in smb.conf.
3349 Default: enable asu support = no
3351 enable core files (G)
3353 This parameter specifies whether core dumps should be written on
3355 internal exits. Normally set to yes. You should never need to
3356 change this.
3357 Default: enable core files = yes
3359 Example: enable core files = no
3361 enable privileges (G)
3363 This deprecated parameter controls whether or not smbd will honor
3365 privileges assigned to specific SIDs via either net rpc rights or
3366 one of the Windows user and group manager tools. This parameter is
3367 enabled by default. It can be disabled to prevent members of the
3368 Domain Admins group from being able to assign privileges to users
3369 or groups which can then result in certain smbd operations running
3370 as root that would normally run under the context of the connected
3371 user.
3372 An example of how privileges can be used is to assign the right to
3374 join clients to a Samba controlled domain without providing root
3375 access to the server via smbd.
3376 Please read the extended description provided in the Samba HOWTO
3378 documentation.
3379 Default: enable privileges = yes
3381 enable spoolss (G)
3383 Inverted synonym for disable spoolss.
3385 Default: enable spoolss = yes
3387 encrypt passwords (G)
3389 This parameter has been deprecated since Samba 4.11 and support for
3391 plaintext (as distinct from NTLM, NTLMv2 or Kerberos
3392 authentication) will be removed in a future Samba release.
3393 That is, in the future, the current default of encrypt passwords =
3395 yes will be the enforced behaviour.
3396 This boolean controls whether encrypted passwords will be
3398 negotiated with the client. Note that Windows NT 4.0 SP3 and above
3399 and also Windows 98 will by default expect encrypted passwords
3400 unless a registry entry is changed. To use encrypted passwords in
3401 Samba see the chapter "User Database" in the Samba HOWTO
3402 Collection.
3403 MS Windows clients that expect Microsoft encrypted passwords and
3405 that do not have plain text password support enabled will be able
3406 to connect only to a Samba server that has encrypted password
3407 support enabled and for which the user accounts have a valid
3408 encrypted password. Refer to the smbpasswd command man page for
3409 information regarding the creation of encrypted passwords for user
3410 accounts.
3411 The use of plain text passwords is NOT advised as support for this
3413 feature is no longer maintained in Microsoft Windows products. If
3414 you want to use plain text passwords you must set this parameter to
3415 no.
3416 In order for encrypted passwords to work correctly smbd(8) must
3418 either have access to a local smbpasswd(5) file (see the
3419 smbpasswd(8) program for information on how to set up and maintain
3420 this file), or set the security = [domain|ads] parameter which
3421 causes smbd to authenticate against another server.
3422 Default: encrypt passwords = yes
3424 enhanced browsing (G)
3426 This option enables a couple of enhancements to cross-subnet browse
3428 propagation that have been added in Samba but which are not
3429 standard in Microsoft implementations.
3430 The first enhancement to browse propagation consists of a regular
3432 wildcard query to a Samba WINS server for all Domain Master
3433 Browsers, followed by a browse synchronization with each of the
3434 returned DMBs. The second enhancement consists of a regular
3435 randomised browse synchronization with all currently known DMBs.
3436 You may wish to disable this option if you have a problem with
3438 empty workgroups not disappearing from browse lists. Due to the
3439 restrictions of the browse protocols, these enhancements can cause
3440 a empty workgroup to stay around forever which can be annoying.
3441 In general you should leave this option enabled as it makes
3443 cross-subnet browse propagation much more reliable.
3444 Default: enhanced browsing = yes
3446 enumports command (G)
3448 The concept of a "port" is fairly foreign to UNIX hosts. Under
3450 Windows NT/2000 print servers, a port is associated with a port
3451 monitor and generally takes the form of a local port (i.e. LPT1:,
3452 COM1:, FILE:) or a remote port (i.e. LPD Port Monitor, etc...). By
3453 default, Samba has only one port defined--"Samba Printer Port".
3454 Under Windows NT/2000, all printers must have a valid port name. If
3455 you wish to have a list of ports displayed (smbd does not use a
3456 port name for anything) other than the default "Samba Printer
3457 Port", you can define enumports command to point to a program which
3458 should generate a list of ports, one per line, to standard output.
3459 This listing will then be used in response to the level 1 and 2
3460 EnumPorts() RPC.
3461 Default: enumports command =
3463 Example: enumports command = /usr/bin/listports
3465 eventlog list (G)
3467 This option defines a list of log names that Samba will report to
3469 the Microsoft EventViewer utility. The listed eventlogs will be
3470 associated with tdb file on disk in the $(statedir)/eventlog.
3471 The administrator must use an external process to parse the normal
3473 Unix logs such as /var/log/messages and write then entries to the
3474 eventlog tdb files. Refer to the eventlogadm(8) utility for how to
3475 write eventlog entries.
3476 Default: eventlog list =
3478 Example: eventlog list = Security Application Syslog Apache
3480 fake directory create times (S)
3482 NTFS and Windows VFAT file systems keep a create time for all files
3484 and directories. This is not the same as the ctime - status change
3485 time - that Unix keeps, so Samba by default reports the earliest of
3486 the various times Unix does keep. Setting this parameter for a
3487 share causes Samba to always report midnight 1-1-1980 as the create
3488 time for directories.
3489 This option is mainly used as a compatibility option for Visual C++
3491 when used against Samba shares. Visual C++ generated makefiles have
3492 the object directory as a dependency for each object file, and a
3493 make rule to create the directory. Also, when NMAKE compares
3494 timestamps it uses the creation time when examining a directory.
3495 Thus the object directory will be created if it does not exist, but
3496 once it does exist it will always have an earlier timestamp than
3497 the object files it contains.
3498 However, Unix time semantics mean that the create time reported by
3500 Samba will be updated whenever a file is created or deleted in the
3501 directory. NMAKE finds all object files in the object directory.
3502 The timestamp of the last one built is then compared to the
3503 timestamp of the object directory. If the directory's timestamp if
3504 newer, then all object files will be rebuilt. Enabling this option
3505 ensures directories always predate their contents and an NMAKE
3506 build will proceed as expected.
3507 Default: fake directory create times = no
3509 fake oplocks (S)
3511 Oplocks are the way that SMB clients get permission from a server
3513 to locally cache file operations. If a server grants an oplock
3514 (opportunistic lock) then the client is free to assume that it is
3515 the only one accessing the file and it will aggressively cache file
3516 data. With some oplock types the client may even cache file
3517 open/close operations. This can give enormous performance benefits.
3518 When you set fake oplocks = yes, smbd(8) will always grant oplock
3520 requests no matter how many clients are using the file.
3521 It is generally much better to use the real oplocks support rather
3523 than this parameter.
3524 If you enable this option on all read-only shares or shares that
3526 you know will only be accessed from one client at a time such as
3527 physically read-only media like CDROMs, you will see a big
3528 performance improvement on many operations. If you enable this
3529 option on shares where multiple clients may be accessing the files
3530 read-write at the same time you can get data corruption. Use this
3531 option carefully!
3532 Default: fake oplocks = no
3534 follow symlinks (S)
3536 This parameter allows the Samba administrator to stop smbd(8) from
3538 following symbolic links in a particular share. Setting this
3539 parameter to no prevents any file or directory that is a symbolic
3540 link from being followed (the user will get an error). This option
3541 is very useful to stop users from adding a symbolic link to
3542 /etc/passwd in their home directory for instance. However it will
3543 slow filename lookups down slightly.
3544 This option is enabled (i.e. smbd will follow symbolic links) by
3546 default.
3547 Default: follow symlinks = yes
3549 smbd force process locks (S)
3551 This boolean option tells smbd whether to forcefully disable the
3553 use of Open File Description locks on Linux.
3554 This option should not be changed from the default unless you know
3556 what you're doing.
3557 Default: smbd force process locks = no
3559 force create mode (S)
3561 This parameter specifies a set of UNIX mode bit permissions that
3563 will always be set on a file created by Samba. This is done by
3564 bitwise 'OR'ing these bits onto the mode bits of a file that is
3565 being created. The default for this parameter is (in octal) 000.
3566 The modes in this parameter are bitwise 'OR'ed onto the file mode
3567 after the mask set in the create mask parameter is applied.
3568 The example below would force all newly created files to have read
3570 and execute permissions set for 'group' and 'other' as well as the
3571 read/write/execute bits set for the 'user'.
3572 Default: force create mode = 0000
3574 Example: force create mode = 0755
3576 force directory mode (S)
3578 This parameter specifies a set of UNIX mode bit permissions that
3580 will always be set on a directory created by Samba. This is done by
3581 bitwise 'OR'ing these bits onto the mode bits of a directory that
3582 is being created. The default for this parameter is (in octal) 0000
3583 which will not add any extra permission bits to a created
3584 directory. This operation is done after the mode mask in the
3585 parameter directory mask is applied.
3586 The example below would force all created directories to have read
3588 and execute permissions set for 'group' and 'other' as well as the
3589 read/write/execute bits set for the 'user'.
3590 Default: force directory mode = 0000
3592 Example: force directory mode = 0755
3594 force directory security mode (S)
3596 This parameter has been removed for Samba 4.0.0.
3598 No default
3600 group
3602 This parameter is a synonym for force group.
3604 force group (S)
3606 This specifies a UNIX group name that will be assigned as the
3608 default primary group for all users connecting to this service.
3609 This is useful for sharing files by ensuring that all access to
3610 files on service will use the named group for their permissions
3611 checking. Thus, by assigning permissions for this group to the
3612 files and directories within this service the Samba administrator
3613 can restrict or allow sharing of these files.
3614 In Samba 2.0.5 and above this parameter has extended functionality
3616 in the following way. If the group name listed here has a '+'
3617 character prepended to it then the current user accessing the share
3618 only has the primary group default assigned to this group if they
3619 are already assigned as a member of that group. This allows an
3620 administrator to decide that only users who are already in a
3621 particular group will create files with group ownership set to that
3622 group. This gives a finer granularity of ownership assignment. For
3623 example, the setting force group = +sys means that only users who
3624 are already in group sys will have their default primary group
3625 assigned to sys when accessing this Samba share. All other users
3626 will retain their ordinary primary group.
3627 If the force user parameter is also set the group specified in
3629 force group will override the primary group set in force user.
3630 Default: force group =
3632 Example: force group = agroup
3634 force printername (S)
3636 When printing from Windows NT (or later), each printer in smb.conf
3638 has two associated names which can be used by the client. The first
3639 is the sharename (or shortname) defined in smb.conf. This is the
3640 only printername available for use by Windows 9x clients. The
3641 second name associated with a printer can be seen when browsing to
3642 the "Printers" (or "Printers and Faxes") folder on the Samba
3643 server. This is referred to simply as the printername (not to be
3644 confused with the printer name option).
3645 When assigning a new driver to a printer on a remote Windows
3647 compatible print server such as Samba, the Windows client will
3648 rename the printer to match the driver name just uploaded. This can
3649 result in confusion for users when multiple printers are bound to
3650 the same driver. To prevent Samba from allowing the printer's
3651 printername to differ from the sharename defined in smb.conf, set
3652 force printername = yes.
3653 Be aware that enabling this parameter may affect migrating printers
3655 from a Windows server to Samba since Windows has no way to force
3656 the sharename and printername to match.
3657 It is recommended that this parameter's value not be changed once
3659 the printer is in use by clients as this could cause a user not be
3660 able to delete printer connections from their local Printers
3661 folder.
3662 Default: force printername = no
3664 force security mode (S)
3666 This parameter has been removed for Samba 4.0.0.
3668 No default
3670 force unknown acl user (S)
3672 If this parameter is set, a Windows NT ACL that contains an unknown
3674 SID (security descriptor, or representation of a user or group id)
3675 as the owner or group owner of the file will be silently mapped
3676 into the current UNIX uid or gid of the currently connected user.
3677 This is designed to allow Windows NT clients to copy files and
3679 folders containing ACLs that were created locally on the client
3680 machine and contain users local to that machine only (no domain
3681 users) to be copied to a Samba server (usually with XCOPY /O) and
3682 have the unknown userid and groupid of the file owner map to the
3683 current connected user. This can only be fixed correctly when
3684 winbindd allows arbitrary mapping from any Windows NT SID to a UNIX
3685 uid or gid.
3686 Try using this parameter when XCOPY /O gives an ACCESS_DENIED
3688 error.
3689 Default: force unknown acl user = no
3691 force user (S)
3693 This specifies a UNIX user name that will be assigned as the
3695 default user for all users connecting to this service. This is
3696 useful for sharing files. You should also use it carefully as using
3697 it incorrectly can cause security problems.
3698 This user name only gets used once a connection is established.
3700 Thus clients still need to connect as a valid user and supply a
3701 valid password. Once connected, all file operations will be
3702 performed as the "forced user", no matter what username the client
3703 connected as. This can be very useful.
3704 In Samba 2.0.5 and above this parameter also causes the primary
3706 group of the forced user to be used as the primary group for all
3707 file activity. Prior to 2.0.5 the primary group was left as the
3708 primary group of the connecting user (this was a bug).
3709 Default: force user =
3711 Example: force user = auser
3713 fss: prune stale (G)
3715 When enabled, Samba's File Server Remote VSS Protocol (FSRVP)
3717 server checks all FSRVP initiated snapshots on startup, and removes
3718 any corresponding state (including share definitions) for
3719 nonexistent snapshot paths.
3720 Default: fss: prune stale = no
3722 Example: fss: prune stale = yes
3724 fss: sequence timeout (G)
3726 The File Server Remote VSS Protocol (FSRVP) server includes a
3728 message sequence timer to ensure cleanup on unexpected client
3729 disconnect. This parameter overrides the default timeout between
3730 FSRVP operations. FSRVP timeouts can be completely disabled via a
3731 value of 0.
3732 Default: fss: sequence timeout = 180 or 1800, depending on
3734 operation
3735 Example: fss: sequence timeout = 0
3737 fstype (S)
3739 This parameter allows the administrator to configure the string
3741 that specifies the type of filesystem a share is using that is
3742 reported by smbd(8) when a client queries the filesystem type for a
3743 share. The default type is NTFS for compatibility with Windows NT
3744 but this can be changed to other strings such as Samba or FAT if
3745 required.
3746 Default: fstype = NTFS
3748 Example: fstype = Samba
3750 get quota command (G)
3752 The get quota command should only be used whenever there is no
3754 operating system API available from the OS that samba can use.
3755 This option is only available Samba was compiled with quotas
3757 support.
3758 This parameter should specify the path to a script that queries the
3760 quota information for the specified user/group for the partition
3761 that the specified directory is on.
3762 Such a script is being given 3 arguments:
3764 • directory
3766 • type of query
3768 • uid of user or gid of group
3770 The directory is actually mostly just "." - It needs to be treated
3772 relatively to the current working directory that the script can
3773 also query.
3774 The type of query can be one of:
3776 • 1 - user quotas
3778 • 2 - user default quotas (uid = -1)
3780 • 3 - group quotas
3782 • 4 - group default quotas (gid = -1)
3784 This script should print one line as output with spaces between the
3786 columns. The printed columns should be:
3787 • 1 - quota flags (0 = no quotas, 1 = quotas enabled, 2 =
3789 quotas enabled and enforced)
3790 • 2 - number of currently used blocks
3792 • 3 - the softlimit number of blocks
3794 • 4 - the hardlimit number of blocks
3796 • 5 - currently used number of inodes
3798 • 6 - the softlimit number of inodes
3800 • 7 - the hardlimit number of inodes
3802 • 8 (optional) - the number of bytes in a block(default is
3804 1024)
3805 Default: get quota command =
3807 Example: get quota command = /usr/local/sbin/query_quota
3809 getwd cache (G)
3811 This is a tuning option. When this is enabled a caching algorithm
3813 will be used to reduce the time taken for getwd() calls. This can
3814 have a significant impact on performance, especially when the wide
3815 links parameter is set to no.
3816 Default: getwd cache = yes
3818 gpo update command (G)
3820 This option sets the command that is called to apply GPO policies.
3822 The samba-gpupdate script applies System Access and Kerberos
3823 Policies to the KDC. System Access policies set minPwdAge,
3824 maxPwdAge, minPwdLength, and pwdProperties in the samdb. Kerberos
3825 Policies set kdc:service ticket lifetime, kdc:user ticket lifetime,
3826 and kdc:renewal lifetime in smb.conf.
3827 Default: gpo update command =
3829 /builddir/build/BUILD/samba-4.19.3/source4/scripting/bin/samba-gpupdate
3830 Example: gpo update command = /usr/local/sbin/gpoupdate
3832 guest account (G)
3834 This is a username which will be used for access to services which
3836 are specified as guest ok (see below). Whatever privileges this
3837 user has will be available to any client connecting to the guest
3838 service. This user must exist in the password file, but does not
3839 require a valid login. The user account "ftp" is often a good
3840 choice for this parameter.
3841 On some systems the default guest account "nobody" may not be able
3843 to print. Use another account in this case. You should test this by
3844 trying to log in as your guest user (perhaps by using the su -
3845 command) and trying to print using the system print command such as
3846 lpr(1) or lp(1).
3847 This parameter does not accept % macros, because many parts of the
3849 system require this value to be constant for correct operation.
3850 Default: guest account = nobody # default can be changed at
3852 compile-time
3853 Example: guest account = ftp
3855 public
3857 This parameter is a synonym for guest ok.
3859 guest ok (S)
3861 If this parameter is yes for a service, then no password is
3863 required to connect to the service. Privileges will be those of the
3864 guest account.
3865 This parameter nullifies the benefits of setting restrict anonymous
3867 = 2
3868 See the section below on security for more information about this
3870 option.
3871 Default: guest ok = no
3873 only guest
3875 This parameter is a synonym for guest only.
3877 guest only (S)
3879 If this parameter is yes for a service, then only guest connections
3881 to the service are permitted. This parameter will have no effect if
3882 guest ok is not set for the service.
3883 See the section below on security for more information about this
3885 option.
3886 Default: guest only = no
3888 hide dot files (S)
3890 This is a boolean parameter that controls whether files starting
3892 with a dot appear as hidden files.
3893 Default: hide dot files = yes
3895 hide files (S)
3897 This is a list of files or directories that are not visible but are
3899 accessible. The DOS 'hidden' attribute is applied to any files or
3900 directories that match.
3901 Each entry in the list must be separated by a '/', which allows
3903 spaces to be included in the entry. '*' and '?' can be used to
3904 specify multiple files or directories as in DOS wildcards.
3905 Each entry must be a Unix path, not a DOS path and must not include
3907 the Unix directory separator '/'.
3908 Note that the case sensitivity option is applicable in hiding
3910 files.
3911 Setting this parameter will affect the performance of Samba, as it
3913 will be forced to check all files and directories for a match as
3914 they are scanned.
3915 The example shown above is based on files that the Macintosh SMB
3917 client (DAVE) available from Thursby creates for internal use, and
3918 also still hides all files beginning with a dot.
3919 An example of us of this parameter is:
3921 hide files = /.*/DesktopFolderDB/TrashFor%m/resource.frk/
3923 Default: hide files = # no file are hidden
3925 hide new files timeout (S)
3927 Setting this parameter to something but 0 hides files that have
3929 been modified less than N seconds ago.
3930 It can be used for ingest/process queue style workloads. A
3932 processing application should only see files that are definitely
3933 finished. As many applications do not have proper external workflow
3934 control, this can be a way to make sure processing does not
3935 interfere with file ingest.
3936 Default: hide new files timeout = 0
3938 hide special files (S)
3940 This parameter prevents clients from seeing special files such as
3942 sockets, devices and fifo's in directory listings.
3943 Default: hide special files = no
3945 hide unreadable (S)
3947 This parameter prevents clients from seeing the existence of files
3949 that cannot be read. Defaults to off.
3950 Please note that enabling this can slow down listing large
3952 directories significantly. Samba has to evaluate the ACLs of all
3953 directory members, which can be a lot of effort.
3954 Default: hide unreadable = no
3956 hide unwriteable files (S)
3958 This parameter prevents clients from seeing the existence of files
3960 that cannot be written to. Defaults to off. Note that unwriteable
3961 directories are shown as usual.
3962 Please note that enabling this can slow down listing large
3964 directories significantly. Samba has to evaluate the ACLs of all
3965 directory members, which can be a lot of effort.
3966 Default: hide unwriteable files = no
3968 honor change notify privilege (S)
3970 This option can be used to make use of the change notify privilege.
3972 By default notify results are not checked against the file system
3973 permissions.
3974 If "honor change notify privilege" is enabled, a user will only
3976 receive notify results, if he has change notify privilege or
3977 sufficient file system permissions. If a user has the change notify
3978 privilege, he will receive all requested notify results, even if
3979 the user does not have the permissions on the file system.
3980 Default: honor change notify privilege = no
3982 host msdfs (G)
3984 If set to yes, Samba will act as a Dfs server, and allow Dfs-aware
3986 clients to browse Dfs trees hosted on the server.
3987 See also the msdfs root share level parameter. For more information
3989 on setting up a Dfs tree on Samba, refer to the MSFDS chapter in
3990 the book Samba3-HOWTO.
3991 Default: host msdfs = yes
3993 hostname lookups (G)
3995 Specifies whether samba should use (expensive) hostname lookups or
3997 use the ip addresses instead. An example place where hostname
3998 lookups are currently used is when checking the hosts deny and
3999 hosts allow.
4000 Default: hostname lookups = no
4002 Example: hostname lookups = yes
4004 allow hosts
4006 This parameter is a synonym for hosts allow.
4008 hosts allow (S)
4010 A synonym for this parameter is allow hosts.
4012 This parameter is a comma, space, or tab delimited set of hosts
4014 which are permitted to access a service.
4015 If specified in the [global] section then it will apply to all
4017 services, regardless of whether the individual service has a
4018 different setting.
4019 You can specify the hosts by name or IP number. For example, you
4021 could restrict access to only the hosts on a Class C subnet with
4022 something like allow hosts = 150.203.5.. The full syntax of the
4023 list is described in the man page hosts_access(5). Note that this
4024 man page may not be present on your system, so a brief description
4025 will be given here also.
4026 Note that the localhost address 127.0.0.1 will always be allowed
4028 access unless specifically denied by a hosts deny option.
4029 You can also specify hosts by network/netmask pairs and by netgroup
4031 names if your system supports netgroups. The EXCEPT keyword can
4032 also be used to limit a wildcard list. The following examples may
4033 provide some help:
4034 Example 1: allow all IPs in 150.203.*.*; except one
4036 hosts allow = 150.203. EXCEPT 150.203.6.66
4038 Example 2: allow hosts that match the given network/netmask
4040 hosts allow = 150.203.15.0/255.255.255.0
4042 Example 3: allow a couple of hosts
4044 hosts allow = lapland, arvidsjaur
4046 Example 4: allow only hosts in NIS netgroup "foonet", but deny
4048 access from one particular host
4049 hosts allow = @foonet
4051 hosts deny = pirate
4053 Note
4055 Note that access still requires suitable user-level passwords.
4056 See testparm(1) for a way of testing your host access to see if it
4057 does what you expect.
4058 Default: hosts allow = # none (i.e., all hosts permitted access)
4060 Example: hosts allow = 150.203.5. myhost.mynet.edu.au
4062 deny hosts
4064 This parameter is a synonym for hosts deny.
4066 hosts deny (S)
4068 The opposite of hosts allow - hosts listed here are NOT permitted
4070 access to services unless the specific services have their own
4071 lists to override this one. Where the lists conflict, the allow
4072 list takes precedence.
4073 In the event that it is necessary to deny all by default, use the
4075 keyword ALL (or the netmask 0.0.0.0/0) and then explicitly specify
4076 to the hosts allow = hosts allow parameter those hosts that should
4077 be permitted access.
4078 Default: hosts deny = # none (i.e., no hosts specifically
4080 excluded)
4081 Example: hosts deny = 150.203.4. badhost.mynet.edu.au
4083 idmap backend (G)
4085 The idmap backend provides a plugin interface for Winbind to use
4087 varying backends to store SID/uid/gid mapping tables.
4088 This option specifies the default backend that is used when no
4090 special configuration set, but it is now deprecated in favour of
4091 the new spelling idmap config * : backend.
4092 Default: idmap backend = tdb
4094 idmap cache time (G)
4096 This parameter specifies the number of seconds that Winbind's idmap
4098 interface will cache positive SID/uid/gid query results. By
4099 default, Samba will cache these results for one week.
4100 Default: idmap cache time = 604800
4102 idmap config DOMAIN : OPTION (G)
4104 ID mapping in Samba is the mapping between Windows SIDs and Unix
4106 user and group IDs. This is performed by Winbindd with a
4107 configurable plugin interface. Samba's ID mapping is configured by
4108 options starting with the idmap config prefix. An idmap option
4109 consists of the idmap config prefix, followed by a domain name or
4110 the asterisk character (*), a colon, and the name of an idmap
4111 setting for the chosen domain.
4112 The idmap configuration is hence divided into groups, one group for
4114 each domain to be configured, and one group with the asterisk
4115 instead of a proper domain name, which specifies the default
4116 configuration that is used to catch all domains that do not have an
4117 explicit idmap configuration of their own.
4118 There are three general options available:
4120 backend = backend_name
4122 This specifies the name of the idmap plugin to use as the
4123 SID/uid/gid backend for this domain. The standard backends are
4124 tdb (idmap_tdb(8)), tdb2 (idmap_tdb2(8)), ldap (idmap_ldap(8)),
4125 rid (idmap_rid(8)), hash (idmap_hash(8)), autorid
4126 (idmap_autorid(8)), ad (idmap_ad(8)) and nss (idmap_nss(8)).
4127 The corresponding manual pages contain the details, but here is
4128 a summary.
4129 The first three of these create mappings of their own using
4131 internal unixid counters and store the mappings in a database.
4132 These are suitable for use in the default idmap configuration.
4133 The rid and hash backends use a pure algorithmic calculation to
4134 determine the unixid for a SID. The autorid module is a mixture
4135 of the tdb and rid backend. It creates ranges for each domain
4136 encountered and then uses the rid algorithm for each of these
4137 automatically configured domains individually. The ad backend
4138 uses unix ids stored in Active Directory via the standard
4139 schema extensions. The nss backend reverses the standard
4140 winbindd setup and gets the unix ids via names from nsswitch
4141 which can be useful in an ldap setup.
4142 range = low - high
4144 Defines the available matching uid and gid range for which the
4145 backend is authoritative. For allocating backends, this also
4146 defines the start and the end of the range for allocating new
4147 unique IDs.
4148 winbind uses this parameter to find the backend that is
4150 authoritative for a unix ID to SID mapping, so it must be set
4151 for each individually configured domain and for the default
4152 configuration. The configured ranges must be mutually disjoint.
4153 Note that the low value interacts with the min domain uid
4155 option!
4156 read only = yes|no
4158 This option can be used to turn the writing backends tdb, tdb2,
4159 and ldap into read only mode. This can be useful e.g. in cases
4160 where a pre-filled database exists that should not be extended
4161 automatically.
4162 The following example illustrates how to configure the idmap_ad(8)
4164 backend for the CORP domain and the idmap_tdb(8) backend for all
4165 other domains. This configuration assumes that the admin of CORP
4166 assigns unix ids below 1000000 via the SFU extensions, and winbind
4167 is supposed to use the next million entries for its own mappings
4168 from trusted domains and for local groups for example.
4169 idmap config * : backend = tdb
4171 idmap config * : range = 1000000-1999999
4172 idmap config CORP : backend = ad
4174 idmap config CORP : range = 1000-999999
4175 No default
4178 winbind gid
4180 This parameter is a synonym for idmap gid.
4182 idmap gid (G)
4184 The idmap gid parameter specifies the range of group ids for the
4186 default idmap configuration. It is now deprecated in favour of
4187 idmap config * : range.
4188 See the idmap config option.
4190 Default: idmap gid =
4192 Example: idmap gid = 10000-20000
4194 idmap negative cache time (G)
4196 This parameter specifies the number of seconds that Winbind's idmap
4198 interface will cache negative SID/uid/gid query results.
4199 Default: idmap negative cache time = 120
4201 winbind uid
4203 This parameter is a synonym for idmap uid.
4205 idmap uid (G)
4207 The idmap uid parameter specifies the range of user ids for the
4209 default idmap configuration. It is now deprecated in favour of
4210 idmap config * : range.
4211 See the idmap config option.
4213 Default: idmap uid =
4215 Example: idmap uid = 10000-20000
4217 include (S)
4219 This allows you to include one config file inside another. The file
4221 is included literally, as though typed in place.
4222 It takes the standard substitutions, except %u, %P and %S.
4224 The parameter include = registry has a special meaning: It does not
4226 include a file named registry from the current working directory,
4227 but instead reads the global configuration options from the
4228 registry. See the section on registry-based configuration for
4229 details. Note that this option automatically activates registry
4230 shares.
4231 Default: include =
4233 Example: include = /usr/local/samba/lib/admin_smb.conf
4235 include system krb5 conf (G)
4237 Setting this parameter to no will prevent winbind to include the
4239 system /etc/krb5.conf file into the krb5.conf file it creates. See
4240 also create krb5 conf. This option only applies to Samba built with
4241 MIT Kerberos.
4242 Default: include system krb5 conf = yes
4244 inherit acls (S)
4246 This parameter is only relevant for filesystems that do not support
4248 standardized NFS4 ACLs but only a POSIX draft ACL implementation
4249 and which implements default ACLs like most filesystems on Linux.
4250 It can be used to ensure that if default ACLs exist on parent
4251 directories, they are always honored when creating a new file or
4252 subdirectory in these parent directories. The default behavior is
4253 to use the unix mode specified when creating the directory.
4254 Enabling this option sets the unix mode to 0777, thus guaranteeing
4255 that the default directory ACLs are propagated. Note that using the
4256 VFS modules acl_xattr or acl_tdb which store native Windows as
4257 meta-data will automatically turn this option on for any share for
4258 which they are loaded, as they require this option to emulate
4259 Windows ACLs correctly.
4260 Default: inherit acls = no
4262 inherit owner (S)
4264 The ownership of new files and directories is normally governed by
4266 effective uid of the connected user. This option allows the Samba
4267 administrator to specify that the ownership for new files and
4268 directories should be controlled by the ownership of the parent
4269 directory.
4270 Valid options are:
4272 • no - Both the Windows (SID) owner and the UNIX (uid)
4274 owner of the file are governed by the identity of the
4275 user that created the file.
4276 • windows and unix - The Windows (SID) owner and the UNIX
4278 (uid) owner of new files and directories are set to the
4279 respective owner of the parent directory.
4280 • yes - a synonym for windows and unix.
4282 • unix only - Only the UNIX owner is set to the UNIX owner
4284 of the parent directory.
4285 Common scenarios where this behavior is useful is in implementing
4287 drop-boxes, where users can create and edit files but not delete
4288 them and ensuring that newly created files in a user's roaming
4289 profile directory are actually owned by the user.
4290 The unix only option effectively breaks the tie between the Windows
4292 owner of a file and the UNIX owner. As a logical consequence, in
4293 this mode, setting the Windows owner of a file does not modify the
4294 UNIX owner. Using this mode should typically be combined with a
4295 backing store that can emulate the full NT ACL model without
4296 affecting the POSIX permissions, such as the acl_xattr VFS module,
4297 coupled with acl_xattr:ignore system acls = yes. This can be used
4298 to emulate folder quotas, when files are exposed only via SMB
4299 (without UNIX extensions). The UNIX owner of a directory is locally
4300 set and inherited by all subdirectories and files, and they all
4301 consume the same quota.
4302 Default: inherit owner = no
4304 inherit permissions (S)
4306 The permissions on new files and directories are normally governed
4308 by create mask, directory mask, force create mode and force
4309 directory mode but the boolean inherit permissions parameter
4310 overrides this.
4311 New directories inherit the mode of the parent directory, including
4313 bits such as setgid.
4314 New files inherit their read/write bits from the parent directory.
4316 Their execute bits continue to be determined by map archive, map
4317 hidden and map system as usual.
4318 Note that the setuid bit is never set via inheritance (the code
4320 explicitly prohibits this).
4321 This can be particularly useful on large systems with many users,
4323 perhaps several thousand, to allow a single [homes] share to be
4324 used flexibly by each user.
4325 Default: inherit permissions = no
4327 init logon delay (G)
4329 This parameter specifies a delay in milliseconds for the hosts
4331 configured for delayed initial samlogon with init logon delayed
4332 hosts.
4333 Default: init logon delay = 100
4335 init logon delayed hosts (G)
4337 This parameter takes a list of host names, addresses or networks
4339 for which the initial samlogon reply should be delayed (so other
4340 DCs get preferred by XP workstations if there are any).
4341 The length of the delay can be specified with the init logon delay
4343 parameter.
4344 Default: init logon delayed hosts =
4346 Example: init logon delayed hosts = 150.203.5. myhost.mynet.de
4348 interfaces (G)
4350 This option allows you to override the default network interfaces
4352 list that Samba will use for browsing, name registration and other
4353 NetBIOS over TCP/IP (NBT) traffic. By default Samba will query the
4354 kernel for the list of all active interfaces and use any interfaces
4355 except 127.0.0.1 that are broadcast capable.
4356 The option takes a list of interface strings. Each string can be in
4358 any of the following forms:
4359 • a network interface name (such as eth0). This may
4361 include shell-like wildcards so eth* will match any
4362 interface starting with the substring "eth"
4363 • an IP address. In this case the netmask is determined
4365 from the list of interfaces obtained from the kernel
4366 • an IP/mask pair.
4368 • a broadcast/mask pair.
4370 The "mask" parameters can either be a bit length (such as 24 for a
4372 C class network) or a full netmask in dotted decimal form.
4373 The "IP" parameters above can either be a full dotted decimal IP
4375 address or a hostname which will be looked up via the OS's normal
4376 hostname resolution mechanisms.
4377 By default Samba enables all active interfaces that are broadcast
4379 capable except the loopback adaptor (IP address 127.0.0.1).
4380 In order to support SMB3 multi-channel configurations, smbd
4382 understands some extra parameters which can be appended after the
4383 actual interface with this extended syntax (note that the quoting
4384 is important in order to handle the ; and , characters):
4385 "interface[;key1=value1[,key2=value2[...]]]"
4387 Known keys are speed, capability, and if_index. Speed is specified
4389 in bits per second. Known capabilities are RSS and RDMA. The
4390 if_index should be used with care: the values must not coincide
4391 with indexes used by the kernel. Note that these options are mainly
4392 intended for testing and development rather than for production
4393 use. At least on Linux systems, these values should be
4394 auto-detected, but the settings can serve as last a resort when
4395 autodetection is not working or is not available. The specified
4396 values overwrite the auto-detected values.
4397 The first two example below configures three network interfaces
4399 corresponding to the eth0 device and IP addresses 192.168.2.10 and
4400 192.168.3.10. The netmasks of the latter two interfaces would be
4401 set to 255.255.255.0.
4402 The other examples show how per interface extra parameters can be
4404 specified. Notice the possible usage of "," and ";", which makes
4405 the double quoting necessary.
4406 Default: interfaces =
4408 Example: interfaces = eth0 192.168.2.10/24
4410 192.168.3.10/255.255.255.0
4411 Example: interfaces = eth0, 192.168.2.10/24;
4413 192.168.3.10/255.255.255.0
4414 Example: interfaces =
4416 "eth0;if_index=65,speed=1000000000,capability=RSS"
4417 Example: interfaces = "lo;speed=1000000000" "eth0;capability=RSS"
4419 Example: interfaces = "lo;speed=1000000000" , "eth0;capability=RSS"
4421 Example: interfaces = "eth0;capability=RSS" ,
4423 "rdma1;capability=RDMA" ; "rdma2;capability=RSS,capability=RDMA"
4424 invalid users (S)
4426 This is a list of users that should not be allowed to login to this
4428 service. This is really a paranoid check to absolutely ensure an
4429 improper setting does not breach your security.
4430 A name starting with a '@' is interpreted as an NIS netgroup first
4432 (if your system supports NIS), and then as a UNIX group if the name
4433 was not found in the NIS netgroup database.
4434 A name starting with '+' is interpreted only by looking in the UNIX
4436 group database via the NSS getgrnam() interface. A name starting
4437 with '&' is interpreted only by looking in the NIS netgroup
4438 database (this requires NIS to be working on your system). The
4439 characters '+' and '&' may be used at the start of the name in
4440 either order so the value +&group means check the UNIX group
4441 database, followed by the NIS netgroup database, and the value
4442 &+group means check the NIS netgroup database, followed by the UNIX
4443 group database (the same as the '@' prefix).
4444 The current servicename is substituted for %S. This is useful in
4446 the [homes] section.
4447 Default: invalid users = # no invalid users
4449 Example: invalid users = root fred admin @wheel
4451 iprint server (G)
4453 This parameter is only applicable if printing is set to iprint.
4455 If set, this option overrides the ServerName option in the CUPS
4457 client.conf. This is necessary if you have virtual samba servers
4458 that connect to different CUPS daemons.
4459 Default: iprint server = ""
4461 Example: iprint server = MYCUPSSERVER
4463 kdc default domain supported enctypes (G)
4465 Set the default value of msDS-SupportedEncryptionTypes for service
4467 accounts in Active Directory that are missing this value or where
4468 msDS-SupportedEncryptionTypes is set to 0.
4469 This allows Samba administrators to match the configuration
4471 flexibility provided by the
4472 HKEY_LOCAL_MACHINE\System\CurrentControlSet\services\KDC\DefaultDomainSupportedEncTypes
4473 Registry Value on Windows.
4474 Unlike the Windows registry key (which only takes an base-10
4476 number), in Samba this may also be expressed in hexadecimal or as a
4477 list of Kerberos encryption type names.
4478 Specified values are ORed together bitwise, and those currently
4480 supported consist of:
4481 • arcfour-hmac-md5, rc4-hmac, 0x4, or 4
4483 Known on Windows as Kerberos RC4 encryption
4485 • aes128-cts-hmac-sha1-96, aes128-cts, 0x8, or 8
4487 Known on Windows as Kerberos AES 128 bit encryption
4489 • aes256-cts-hmac-sha1-96, aes256-cts, 0x10, or 16
4491 Known on Windows as Kerberos AES 256 bit encryption
4493 • aes256-cts-hmac-sha1-96-sk, aes256-cts-sk, 0x20, or 32
4495 Allow AES session keys. When this is set, it indicates
4497 to the KDC that AES session keys can be used, even when
4498 aes256-cts and aes128-cts are not set. This allows use
4499 of AES keys against hosts otherwise only configured with
4500 RC4 for ticket keys (which is the default).
4501 Default: kdc default domain supported enctypes = 0 # maps to what
4503 the software supports currently: arcfour-hmac-md5
4504 aes256-cts-hmac-sha1-96-sk
4505 kdc enable fast (G)
4507 With the Samba 4.16 the embedded Heimdal KDC brings support for
4509 RFC6113 FAST, which wasn't available in older Samba versions.
4510 This option is mostly for testing and currently only applies if the
4512 embedded Heimdal KDC is used.
4513 Default: kdc enable fast = yes
4515 kdc force enable rc4 weak session keys (G)
4517 RFC8429 declares that rc4-hmac Kerberos ciphers are weak and there
4519 are known attacks on Active Directory use of this cipher suite.
4520 However for compatibility with Microsoft Windows this option allows
4522 the KDC to assume that regardless of the value set in a service
4523 account's msDS-SupportedEncryptionTypes attribute that a rc4-hmac
4524 Kerberos session key (as distinct from the ticket key, as found in
4525 a service keytab) can be used if the potentially older client
4526 requests it.
4527 Default: kdc force enable rc4 weak session keys = no
4529 kdc supported enctypes (G)
4531 On an active directory domain controller, this is the list of
4533 supported encryption types for local running kdc.
4534 This allows Samba administrators to remove support for weak/unused
4536 encryption types, similar the configuration flexibility provided by
4537 the Network security: Configure encryption types allowed for
4538 Kerberos GPO/Local Policies/Security Options Value, which results
4539 in the
4540 HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Policies\System\Kerberos\Parameters\SupportedEncryptionTypes
4541 Registry Value on Windows.
4542 Unlike the Windows registry key (which only takes an base-10
4544 number), in Samba this may also be expressed as hexadecimal or a
4545 list of Kerberos encryption type names.
4546 Specified values are ORed together bitwise, and those currently
4548 supported consist of:
4549 • arcfour-hmac-md5, rc4-hmac, 0x4, or 4
4551 Known on Windows as Kerberos RC4 encryption
4553 • aes128-cts-hmac-sha1-96, aes128-cts, 0x8, or 8
4555 Known on Windows as Kerberos AES 128 bit encryption
4557 • aes256-cts-hmac-sha1-96, aes256-cts, 0x10, or 16
4559 Known on Windows as Kerberos AES 256 bit encryption
4561 Default: kdc supported enctypes = 0 # maps to what the software
4563 supports currently: arcfour-hmac-md5 aes128-cts-hmac-sha1-96
4564 aes256-cts-hmac-sha1-96
4565 keepalive (G)
4567 The value of the parameter (an integer) represents the number of
4569 seconds between keepalive packets. If this parameter is zero, no
4570 keepalive packets will be sent. Keepalive packets, if sent, allow
4571 the server to tell whether a client is still present and
4572 responding.
4573 Keepalives should, in general, not be needed if the socket has the
4575 SO_KEEPALIVE attribute set on it by default. (see socket options).
4576 Basically you should only use this option if you strike
4577 difficulties.
4578 Please note this option only applies to SMB1 client connections,
4580 and has no effect on SMB2 clients.
4581 Default: keepalive = 300
4583 Example: keepalive = 600
4585 kerberos encryption types (G)
4587 This parameter determines the encryption types to use when
4589 operating as a Kerberos client. Possible values are all, strong,
4590 and legacy.
4591 Samba uses a Kerberos library (MIT or Heimdal) to obtain Kerberos
4593 tickets. This library is normally configured outside of Samba,
4594 using the krb5.conf file. This file may also include directives to
4595 configure the encryption types to be used. However, Samba
4596 implements Active Directory protocols and algorithms to locate a
4597 domain controller. In order to force the Kerberos library into
4598 using the correct domain controller, some Samba processes, such as
4599 winbindd(8) and net(8), build a private krb5.conf file for use by
4600 the Kerberos library while being invoked from Samba. This private
4601 file controls all aspects of the Kerberos library operation, and
4602 this parameter controls how the encryption types are configured
4603 within this generated file, and therefore also controls the
4604 encryption types negotiable by Samba.
4605 When set to all, all active directory encryption types are allowed.
4607 When set to strong, only AES-based encryption types are offered.
4609 This can be used in hardened environments to prevent downgrade
4610 attacks.
4611 When set to legacy, only RC4-HMAC-MD5 is allowed. AVOID using this
4613 option, because of CVE-2022-37966 see
4614 https://bugzilla.samba.org/show_bug.cgi?id=15237.
4615 Default: kerberos encryption types = all
4617 kerberos method (G)
4619 Controls how kerberos tickets are verified.
4621 Valid options are:
4623 • secrets only - use only the secrets.tdb for ticket
4625 verification (default)
4626 • system keytab - use only the system keytab for ticket
4628 verification
4629 • dedicated keytab - use a dedicated keytab for ticket
4631 verification
4632 • secrets and keytab - use the secrets.tdb first, then the
4634 system keytab
4635 The major difference between "system keytab" and "dedicated keytab"
4637 is that the latter method relies on kerberos to find the correct
4638 keytab entry instead of filtering based on expected principals.
4639 When the kerberos method is in "dedicated keytab" mode, dedicated
4641 keytab file must be set to specify the location of the keytab file.
4642 Default: kerberos method = default
4644 kernel change notify (G)
4646 This parameter specifies whether Samba should ask the kernel for
4648 change notifications in directories so that SMB clients can refresh
4649 whenever the data on the server changes.
4650 This parameter is only used when your kernel supports change
4652 notification to user programs using the inotify interface.
4653 Default: kernel change notify = yes
4655 kernel oplocks (S)
4657 For UNIXes that support kernel based oplocks (currently only
4659 Linux), this parameter allows the use of them to be turned on or
4660 off. However, this disables Level II oplocks for clients as the
4661 Linux kernel does not support them properly.
4662 Kernel oplocks support allows Samba oplocks to be broken whenever a
4664 local UNIX process or NFS operation accesses a file that smbd(8)
4665 has oplocked. This allows complete data consistency between
4666 SMB/CIFS, NFS and local file access (and is a very cool feature
4667 :-).
4668 If you do not need this interaction, you should disable the
4670 parameter on Linux to get Level II oplocks and the associated
4671 performance benefit.
4672 This parameter defaults to no and is translated to a no-op on
4674 systems that do not have the necessary kernel support.
4675 Default: kernel oplocks = no
4677 kernel share modes (S)
4679 This parameter controls whether SMB share modes are translated into
4681 file system specific sharemode calls.
4682 Kernel share modes provide a minimal level of interoperability with
4684 local UNIX processes and NFS operations by preventing access
4685 corresponding to the SMB share modes. This requires a file system
4686 specific VFS module with proper support.
4687 Note that in order to use SMB2 durable file handles on a share, you
4689 have to turn kernel share modes off.
4690 This parameter defaults to no. Setting it to yes requires a file
4692 system module that supports file system sharemodes, otherwise
4693 attempts to access files will fail with a sharing violation.
4694 Default: kernel share modes = no
4696 kpasswd port (G)
4698 Specifies which ports the Kerberos server should listen on for
4700 password changes.
4701 Default: kpasswd port = 464
4703 krb5 port (G)
4705 Specifies which port the KDC should listen on for Kerberos traffic.
4707 Default: krb5 port = 88
4709 lanman auth (G)
4711 This parameter has been deprecated since Samba 4.11 and support for
4713 LanMan (as distinct from NTLM, NTLMv2 or Kerberos authentication)
4714 will be removed in a future Samba release.
4715 That is, in the future, the current default of lanman auth = no
4717 will be the enforced behaviour.
4718 This parameter determines whether or not smbd(8) will attempt to
4720 authenticate users or permit password changes using the LANMAN
4721 password hash. If disabled, only clients which support NT password
4722 hashes (e.g. Windows NT/2000 clients, smbclient, but not Windows
4723 95/98 or the MS DOS network client) will be able to connect to the
4724 Samba host.
4725 The LANMAN encrypted response is easily broken, due to its
4727 case-insensitive nature, and the choice of algorithm. Servers
4728 without Windows 95/98/ME or MS DOS clients are advised to disable
4729 this option.
4730 When this parameter is set to no this will also result in
4732 sambaLMPassword in Samba's passdb being blanked after the next
4733 password change. As a result of that lanman clients won't be able
4734 to authenticate, even if lanman auth is re-enabled later on.
4735 Unlike the encrypt passwords option, this parameter cannot alter
4737 client behaviour, and the LANMAN response will still be sent over
4738 the network. See the client lanman auth to disable this for Samba's
4739 clients (such as smbclient)
4740 This parameter is overridden by ntlm auth, so unless that it is
4742 also set to ntlmv1-permitted or yes, then only NTLMv2 logins will
4743 be permitted and no LM hash will be stored. All modern clients
4744 support NTLMv2, and but some older clients require special
4745 configuration to use it.
4746 This parameter has no impact on the Samba AD DC, LM authentication
4748 is always disabled and no LM password is ever stored.
4749 Default: lanman auth = no
4751 large readwrite (G)
4753 This parameter determines whether or not smbd(8) supports the new
4755 64k streaming read and write variant SMB requests introduced with
4756 Windows 2000. Note that due to Windows 2000 client redirector bugs
4757 this requires Samba to be running on a 64-bit capable operating
4758 system such as IRIX, Solaris or a Linux 2.4 kernel. Can improve
4759 performance by 10% with Windows 2000 clients. Defaults to on. Not
4760 as tested as some other Samba code paths.
4761 Default: large readwrite = yes
4763 ldap admin dn (G)
4765 The ldap admin dn defines the Distinguished Name (DN) name used by
4767 Samba to contact the ldap server when retrieving user account
4768 information. The ldap admin dn is used in conjunction with the
4769 admin dn password stored in the private/secrets.tdb file. See the
4770 smbpasswd(8) man page for more information on how to accomplish
4771 this.
4772 The ldap admin dn requires a fully specified DN. The ldap suffix is
4774 not appended to the ldap admin dn.
4775 No default
4777 ldap connection timeout (G)
4779 This parameter tells the LDAP library calls which timeout in
4781 seconds they should honor during initial connection establishments
4782 to LDAP servers. It is very useful in failover scenarios in
4783 particular. If one or more LDAP servers are not reachable at all,
4784 we do not have to wait until TCP timeouts are over. This feature
4785 must be supported by your LDAP library.
4786 This parameter is different from ldap timeout which affects
4788 operations on LDAP servers using an existing connection and not
4789 establishing an initial connection.
4790 Default: ldap connection timeout = 2
4792 ldap debug level (G)
4794 This parameter controls the debug level of the LDAP library calls.
4796 In the case of OpenLDAP, it is the same bit-field as understood by
4797 the server and documented in the slapd.conf(5) manpage. A typical
4798 useful value will be 1 for tracing function calls.
4799 The debug output from the LDAP libraries appears with the prefix
4801 [LDAP] in Samba's logging output. The level at which LDAP logging
4802 is printed is controlled by the parameter ldap debug threshold.
4803 Default: ldap debug level = 0
4805 Example: ldap debug level = 1
4807 ldap debug threshold (G)
4809 This parameter controls the Samba debug level at which the ldap
4811 library debug output is printed in the Samba logs. See the
4812 description of ldap debug level for details.
4813 Default: ldap debug threshold = 10
4815 Example: ldap debug threshold = 5
4817 ldap delete dn (G)
4819 This parameter specifies whether a delete operation in the ldapsam
4821 deletes the complete entry or only the attributes specific to
4822 Samba.
4823 Default: ldap delete dn = no
4825 ldap deref (G)
4827 This option controls whether Samba should tell the LDAP library to
4829 use a certain alias dereferencing method. The default is auto,
4830 which means that the default setting of the ldap client library
4831 will be kept. Other possible values are never, finding, searching
4832 and always. Grab your LDAP manual for more information.
4833 Default: ldap deref = auto
4835 Example: ldap deref = searching
4837 ldap follow referral (G)
4839 This option controls whether to follow LDAP referrals or not when
4841 searching for entries in the LDAP database. Possible values are on
4842 to enable following referrals, off to disable this, and auto, to
4843 use the libldap default settings. libldap's choice of following
4844 referrals or not is set in /etc/openldap/ldap.conf with the
4845 REFERRALS parameter as documented in ldap.conf(5).
4846 Default: ldap follow referral = auto
4848 Example: ldap follow referral = off
4850 ldap group suffix (G)
4852 This parameter specifies the suffix that is used for groups when
4854 these are added to the LDAP directory. If this parameter is unset,
4855 the value of ldap suffix will be used instead. The suffix string is
4856 prepended to the ldap suffix string so use a partial DN.
4857 Default: ldap group suffix =
4859 Example: ldap group suffix = ou=Groups
4861 ldap idmap suffix (G)
4863 This parameters specifies the suffix that is used when storing
4865 idmap mappings. If this parameter is unset, the value of ldap
4866 suffix will be used instead. The suffix string is prepended to the
4867 ldap suffix string so use a partial DN.
4868 Default: ldap idmap suffix =
4870 Example: ldap idmap suffix = ou=Idmap
4872 ldap machine suffix (G)
4874 It specifies where machines should be added to the ldap tree. If
4876 this parameter is unset, the value of ldap suffix will be used
4877 instead. The suffix string is prepended to the ldap suffix string
4878 so use a partial DN.
4879 Default: ldap machine suffix =
4881 Example: ldap machine suffix = ou=Computers
4883 ldap max anonymous request size (G)
4885 This parameter specifies the maximum permitted size (in bytes) for
4887 an LDAP request received on an anonymous connection.
4888 If the request size exceeds this limit the request will be
4890 rejected.
4891 Default: ldap max anonymous request size = 256000
4893 Example: ldap max anonymous request size = 500000
4895 ldap max authenticated request size (G)
4897 This parameter specifies the maximum permitted size (in bytes) for
4899 an LDAP request received on an authenticated connection.
4900 If the request size exceeds this limit the request will be
4902 rejected.
4903 Default: ldap max authenticated request size = 16777216
4905 Example: ldap max authenticated request size = 4194304
4907 ldap max search request size (G)
4909 This parameter specifies the maximum permitted size (in bytes) for
4911 an LDAP search request.
4912 If the request size exceeds this limit the request will be
4914 rejected.
4915 Default: ldap max search request size = 256000
4917 Example: ldap max search request size = 4194304
4919 ldap page size (G)
4921 This parameter specifies the number of entries per page.
4923 If the LDAP server supports paged results, clients can request
4925 subsets of search results (pages) instead of the entire list. This
4926 parameter specifies the size of these pages.
4927 Default: ldap page size = 1000
4929 Example: ldap page size = 512
4931 ldap password sync
4933 This parameter is a synonym for ldap passwd sync.
4935 ldap passwd sync (G)
4937 This option is used to define whether or not Samba should sync the
4939 LDAP password with the NT and LM hashes for normal accounts (NOT
4940 for workstation, server or domain trusts) on a password change via
4941 SAMBA.
4942 The ldap passwd sync can be set to one of three values:
4944 • Yes = Try to update the LDAP, NT and LM passwords and
4946 update the pwdLastSet time.
4947 • No = Update NT and LM passwords and update the
4949 pwdLastSet time.
4950 • Only = Only update the LDAP password and let the LDAP
4952 server do the rest.
4953 Default: ldap passwd sync = no
4955 ldap replication sleep (G)
4957 When Samba is asked to write to a read-only LDAP replica, we are
4959 redirected to talk to the read-write master server. This server
4960 then replicates our changes back to the 'local' server, however the
4961 replication might take some seconds, especially over slow links.
4962 Certain client activities, particularly domain joins, can become
4963 confused by the 'success' that does not immediately change the LDAP
4964 back-end's data.
4965 This option simply causes Samba to wait a short time, to allow the
4967 LDAP server to catch up. If you have a particularly high-latency
4968 network, you may wish to time the LDAP replication with a network
4969 sniffer, and increase this value accordingly. Be aware that no
4970 checking is performed that the data has actually replicated.
4971 The value is specified in milliseconds, the maximum value is 5000
4973 (5 seconds).
4974 Default: ldap replication sleep = 1000
4976 ldapsam:editposix (G)
4978 Editposix is an option that leverages ldapsam:trusted to make it
4980 simpler to manage a domain controller eliminating the need to set
4981 up custom scripts to add and manage the posix users and groups.
4982 This option will instead directly manipulate the ldap tree to
4983 create, remove and modify user and group entries. This option also
4984 requires a running winbindd as it is used to allocate new uids/gids
4985 on user/group creation. The allocation range must be therefore
4986 configured.
4987 To use this option, a basic ldap tree must be provided and the ldap
4989 suffix parameters must be properly configured. On virgin servers
4990 the default users and groups (Administrator, Guest, Domain Users,
4991 Domain Admins, Domain Guests) can be precreated with the command
4992 net sam provision. To run this command the ldap server must be
4993 running, Winbindd must be running and the smb.conf ldap options
4994 must be properly configured. The typical ldap setup used with the
4995 ldapsam:trusted = yes option is usually sufficient to use
4996 ldapsam:editposix = yes as well.
4997 An example configuration can be the following:
4999 encrypt passwords = true
5001 passdb backend = ldapsam
5002 ldapsam:trusted=yes
5004 ldapsam:editposix=yes
5005 ldap admin dn = cn=admin,dc=samba,dc=org
5007 ldap delete dn = yes
5008 ldap group suffix = ou=groups
5009 ldap idmap suffix = ou=idmap
5010 ldap machine suffix = ou=computers
5011 ldap user suffix = ou=users
5012 ldap suffix = dc=samba,dc=org
5013 idmap backend = ldap:"ldap://localhost"
5015 idmap uid = 5000-50000
5017 idmap gid = 5000-50000
5018 This configuration assumes a directory layout like described in the
5021 following ldif:
5022 dn: dc=samba,dc=org
5024 objectClass: top
5025 objectClass: dcObject
5026 objectClass: organization
5027 o: samba.org
5028 dc: samba
5029 dn: cn=admin,dc=samba,dc=org
5031 objectClass: simpleSecurityObject
5032 objectClass: organizationalRole
5033 cn: admin
5034 description: LDAP administrator
5035 userPassword: secret
5036 dn: ou=users,dc=samba,dc=org
5038 objectClass: top
5039 objectClass: organizationalUnit
5040 ou: users
5041 dn: ou=groups,dc=samba,dc=org
5043 objectClass: top
5044 objectClass: organizationalUnit
5045 ou: groups
5046 dn: ou=idmap,dc=samba,dc=org
5048 objectClass: top
5049 objectClass: organizationalUnit
5050 ou: idmap
5051 dn: ou=computers,dc=samba,dc=org
5053 objectClass: top
5054 objectClass: organizationalUnit
5055 ou: computers
5056 Default: ldapsam:editposix = no
5059 ldapsam:trusted (G)
5061 By default, Samba as a Domain Controller with an LDAP backend needs
5063 to use the Unix-style NSS subsystem to access user and group
5064 information. Due to the way Unix stores user information in
5065 /etc/passwd and /etc/group this inevitably leads to inefficiencies.
5066 One important question a user needs to know is the list of groups
5067 he is member of. The plain UNIX model involves a complete
5068 enumeration of the file /etc/group and its NSS counterparts in
5069 LDAP. UNIX has optimized functions to enumerate group membership.
5070 Sadly, other functions that are used to deal with user and group
5071 attributes lack such optimization.
5072 To make Samba scale well in large environments, the ldapsam:trusted
5074 = yes option assumes that the complete user and group database that
5075 is relevant to Samba is stored in LDAP with the standard
5076 posixAccount/posixGroup attributes. It further assumes that the
5077 Samba auxiliary object classes are stored together with the POSIX
5078 data in the same LDAP object. If these assumptions are met,
5079 ldapsam:trusted = yes can be activated and Samba can bypass the NSS
5080 system to query user group memberships. Optimized LDAP queries can
5081 greatly speed up domain logon and administration tasks. Depending
5082 on the size of the LDAP database a factor of 100 or more for common
5083 queries is easily achieved.
5084 Default: ldapsam:trusted = no
5086 ldap server require strong auth (G)
5088 The ldap server require strong auth defines whether the ldap server
5090 requires ldap traffic to be signed or signed and encrypted
5091 (sealed). Possible values are no, allow_sasl_over_tls and yes.
5092 A value of no allows simple and sasl binds over all transports.
5094 A value of allow_sasl_over_tls allows simple and sasl binds
5096 (without sign or seal) over TLS encrypted connections. Unencrypted
5097 connections only allow sasl binds with sign or seal.
5098 A value of yes allows only simple binds over TLS encrypted
5100 connections. Unencrypted connections only allow sasl binds with
5101 sign or seal.
5102 Default: ldap server require strong auth = yes
5104 ldap ssl (G)
5106 This option is used to define whether or not Samba should use SSL
5108 when connecting to the ldap server This is NOT related to Samba's
5109 previous SSL support which was enabled by specifying the --with-ssl
5110 option to the configure script.
5111 LDAP connections should be secured where possible. This may be done
5113 setting either this parameter to start tls or by specifying
5114 ldaps:// in the URL argument of passdb backend.
5115 The ldap ssl can be set to one of two values:
5117 • Off = Never use SSL when querying the directory.
5119 • start tls = Use the LDAPv3 StartTLS extended operation
5121 (RFC2830) for communicating with the directory server.
5122 Please note that this parameter does only affect rpc methods.
5124 Default: ldap ssl = start tls
5126 ldap suffix (G)
5128 Specifies the base for all ldap suffixes and for storing the
5130 sambaDomain object.
5131 The ldap suffix will be appended to the values specified for the
5133 ldap user suffix, ldap group suffix, ldap machine suffix, and the
5134 ldap idmap suffix. Each of these should be given only a DN relative
5135 to the ldap suffix.
5136 Default: ldap suffix =
5138 Example: ldap suffix = dc=samba,dc=org
5140 ldap timeout (G)
5142 This parameter defines the number of seconds that Samba should use
5144 as timeout for LDAP operations.
5145 Default: ldap timeout = 15
5147 ldap user suffix (G)
5149 This parameter specifies where users are added to the tree. If this
5151 parameter is unset, the value of ldap suffix will be used instead.
5152 The suffix string is prepended to the ldap suffix string so use a
5153 partial DN.
5154 Default: ldap user suffix =
5156 Example: ldap user suffix = ou=people
5158 level2 oplocks (S)
5160 This parameter controls whether Samba supports level2 (read-only)
5162 oplocks on a share.
5163 Level2, or read-only oplocks allow Windows NT clients that have an
5165 oplock on a file to downgrade from a read-write oplock to a
5166 read-only oplock once a second client opens the file (instead of
5167 releasing all oplocks on a second open, as in traditional,
5168 exclusive oplocks). This allows all openers of the file that
5169 support level2 oplocks to cache the file for read-ahead only (ie.
5170 they may not cache writes or lock requests) and increases
5171 performance for many accesses of files that are not commonly
5172 written (such as application .EXE files).
5173 Once one of the clients which have a read-only oplock writes to the
5175 file all clients are notified (no reply is needed or waited for)
5176 and told to break their oplocks to "none" and delete any read-ahead
5177 caches.
5178 It is recommended that this parameter be turned on to speed access
5180 to shared executables.
5181 For more discussions on level2 oplocks see the CIFS spec.
5183 Currently, if kernel oplocks are supported then level2 oplocks are
5185 not granted (even if this parameter is set to yes). Note also, the
5186 oplocks parameter must be set to yes on this share in order for
5187 this parameter to have any effect.
5188 Default: level2 oplocks = yes
5190 lm announce (G)
5192 This parameter determines if nmbd(8) will produce Lanman announce
5194 broadcasts that are needed by OS/2 clients in order for them to see
5195 the Samba server in their browse list. This parameter can have
5196 three values, yes, no, or auto. The default is auto. If set to no
5197 Samba will never produce these broadcasts. If set to yes Samba will
5198 produce Lanman announce broadcasts at a frequency set by the
5199 parameter lm interval. If set to auto Samba will not send Lanman
5200 announce broadcasts by default but will listen for them. If it
5201 hears such a broadcast on the wire it will then start sending them
5202 at a frequency set by the parameter lm interval.
5203 Default: lm announce = auto
5205 Example: lm announce = yes
5207 lm interval (G)
5209 If Samba is set to produce Lanman announce broadcasts needed by
5211 OS/2 clients (see the lm announce parameter) then this parameter
5212 defines the frequency in seconds with which they will be made. If
5213 this is set to zero then no Lanman announcements will be made
5214 despite the setting of the lm announce parameter.
5215 Default: lm interval = 60
5217 Example: lm interval = 120
5219 load printers (G)
5221 A boolean variable that controls whether all printers in the
5223 printcap will be loaded for browsing by default. See the printers
5224 section for more details.
5225 Default: load printers = yes
5227 local master (G)
5229 This option allows nmbd(8) to try and become a local master browser
5231 on a subnet. If set to no then nmbd will not attempt to become a
5232 local master browser on a subnet and will also lose in all browsing
5233 elections. By default this value is set to yes. Setting this value
5234 to yes doesn't mean that Samba will become the local master browser
5235 on a subnet, just that nmbd will participate in elections for local
5236 master browser.
5237 Setting this value to no will cause nmbd never to become a local
5239 master browser.
5240 Default: local master = yes
5242 lock dir
5244 This parameter is a synonym for lock directory.
5246 lock directory (G)
5248 This option specifies the directory where lock files will be
5250 placed. The lock files are used to implement the max connections
5251 option.
5252 Note: This option can not be set inside registry configurations.
5254 The files placed in this directory are not required across service
5256 restarts and can be safely placed on volatile storage (e.g. tmpfs
5257 in Linux)
5258 Default: lock directory = /var/lib/samba/lock
5260 Example: lock directory = /var/run/samba/locks
5262 locking (S)
5264 This controls whether or not locking will be performed by the
5266 server in response to lock requests from the client.
5267 If locking = no, all lock and unlock requests will appear to
5269 succeed and all lock queries will report that the file in question
5270 is available for locking.
5271 If locking = yes, real locking will be performed by the server.
5273 This option may be useful for read-only filesystems which may not
5275 need locking (such as CDROM drives), although setting this
5276 parameter of no is not really recommended even in this case.
5277 Be careful about disabling locking either globally or in a specific
5279 service, as lack of locking may result in data corruption. You
5280 should never need to set this parameter.
5281 Default: locking = yes
5283 lock spin time (G)
5285 The time in milliseconds that smbd should keep waiting to see if a
5287 failed lock request can be granted. This parameter has changed in
5288 default value from Samba 3.0.23 from 10 to 200. The associated lock
5289 spin count parameter is no longer used in Samba 3.0.24. You should
5290 not need to change the value of this parameter.
5291 Default: lock spin time = 200
5293 log file (G)
5295 This option allows you to override the name of the Samba log file
5297 (also known as the debug file).
5298 This option takes the standard substitutions, allowing you to have
5300 separate log files for each user or machine.
5301 No default
5303 Example: log file = /usr/local/samba/var/log.%m
5305 logging (G)
5307 This parameter configures logging backends. Multiple backends can
5309 be specified at the same time, with different log levels for each
5310 backend. The parameter is a list of backends, where each backend is
5311 specified as backend[:option][@loglevel].
5312 The 'option' parameter can be used to pass backend-specific
5314 options.
5315 The log level for a backend is optional, if it is not set for a
5317 backend, all messages are sent to this backend. The parameter log
5318 level determines overall log levels, while the log levels specified
5319 here define what is sent to the individual backends.
5320 When logging is set, it overrides the syslog and syslog only
5322 parameters.
5323 Some backends are only available when Samba has been compiled with
5325 the additional libraries. The overall list of logging backends:
5326 • syslog
5328 • file
5330 • systemd
5332 • lttng
5334 • gpfs
5336 • ringbuf
5338 The ringbuf backend supports an optional size argument to change
5340 the buffer size used, the default is 1 MB: ringbuf:size=NBYTES
5341 Default: logging =
5343 Example: logging = syslog@1 file
5345 debuglevel
5347 This parameter is a synonym for log level.
5349 log level (G)
5351 The value of the parameter (a string) allows the debug level
5353 (logging level) to be specified in the smb.conf file.
5354 This parameter has been extended since the 2.2.x series, now it
5356 allows one to specify the debug level for multiple debug classes
5357 and distinct logfiles for debug classes. This is to give greater
5358 flexibility in the configuration of the system. The following debug
5359 classes are currently implemented:
5360 • all
5362 • tdb
5364 • printdrivers
5366 • lanman
5368 • smb
5370 • rpc_parse
5372 • rpc_srv
5374 • rpc_cli
5376 • passdb
5378 • sam
5380 • auth
5382 • winbind
5384 • vfs
5386 • idmap
5388 • quota
5390 • acls
5392 • locking
5394 • msdfs
5396 • dmapi
5398 • registry
5400 • scavenger
5402 • dns
5404 • ldb
5406 • tevent
5408 • auth_audit
5410 • auth_json_audit
5412 • kerberos
5414 • drs_repl
5416 • smb2
5418 • smb2_credits
5420 • dsdb_audit
5422 • dsdb_json_audit
5424 • dsdb_password_audit
5426 • dsdb_password_json_audit
5428 • dsdb_transaction_audit
5430 • dsdb_transaction_json_audit
5432 • dsdb_group_audit
5434 • dsdb_group_json_audit
5436 Various modules register dynamic debug classes at first usage:
5438 • catia
5440 • dfs_samba4
5442 • extd_audit
5444 • fileid
5446 • fruit
5448 • full_audit
5450 • media_harmony
5452 • preopen
5454 • recycle
5456 • shadow_copy
5458 • shadow_copy
5460 • unityed_media
5462 • virusfilter
5464 To configure the logging for specific classes to go into a
5466 different file then log file, you can append @PATH to the class, eg
5467 log level = 1 full_audit:1@/var/log/audit.log.
5468 Authentication and authorization audit information is logged under
5470 the auth_audit, and if Samba was not compiled with --without-json,
5471 a JSON representation is logged under auth_json_audit.
5472 Support is comprehensive for all authentication and authorisation
5474 of user accounts in the Samba Active Directory Domain Controller,
5475 as well as the implicit authentication in password changes. In the
5476 file server, NTLM authentication, SMB and RPC authorization is
5477 covered.
5478 Log levels for auth_audit and auth_audit_json are:
5480 • 2: Authentication Failure
5482 • 3: Authentication Success
5484 • 4: Authorization Success
5486 • 5: Anonymous Authentication and Authorization Success
5488 Changes to the AD DC sam.ldb database are logged under the
5490 dsdb_audit and a JSON representation is logged under
5491 dsdb_json_audit.
5492 Group membership changes to the AD DC sam.ldb database are logged
5494 under the dsdb_group_audit and a JSON representation is logged
5495 under dsdb_group_json_audit.
5496 Log levels for dsdb_audit, dsdb_json_audit, dsdb_group_audit,
5498 dsdb_group_json_audit and dsdb_json_audit are:
5499 • 5: Database modifications
5501 • 5: Replicated updates from another DC
5503 Password changes and Password resets in the AD DC are logged under
5505 dsdb_password_audit and a JSON representation is logged under the
5506 dsdb_password_json_audit. Password changes will also appears as
5507 authentication events via auth_audit and auth_audit_json.
5508 Log levels for dsdb_password_audit and dsdb_password_json_audit
5510 are:
5511 • 5: Successful password changes and resets
5513 Transaction rollbacks and prepare commit failures are logged under
5515 the dsdb_transaction_audit and a JSON representation is logged
5516 under the dsdb_transaction_json_audit.
5517 Log levels for dsdb_transaction_audit and dsdb_transaction_json
5519 are:
5520 • 5: Transaction failure (rollback)
5522 • 10: Transaction success (commit)
5524 Transaction roll-backs are possible in Samba, and whilst they
5526 rarely reflect anything more than the failure of an individual
5527 operation (say due to the add of a conflicting record), they are
5528 possible. Audit logs are already generated and sent to the system
5529 logs before the transaction is complete. Logging the transaction
5530 details allows the identification of password and sam.ldb
5531 operations that have been rolled back, and so have not actually
5532 persisted.
5533 Warning
5535 Changes to sam.ldb made locally by the root user with direct
5536 access to the database are not logged to the system logs, but
5537 to the administrator's own console. While less than ideal, any
5538 user able to make such modifications could disable the audit
5539 logging in any case.
5540 Default: log level = 0
5541 Example: log level = 3 passdb:5 auth:10 winbind:2
5543 Example: log level = 1 full_audit:1@/var/log/audit.log winbind:2
5545 log nt token command (G)
5547 This option can be set to a command that will be called when new nt
5549 tokens are created.
5550 This is only useful for development purposes.
5552 Default: log nt token command =
5554 logon drive (G)
5556 This parameter specifies the local path to which the home directory
5558 will be connected (see logon home) and is only used by NT
5559 Workstations.
5560 Note that this option is only useful if Samba is set up as a logon
5562 server.
5563 Default: logon drive =
5565 Example: logon drive = h:
5567 logon home (G)
5569 This parameter specifies the home directory location when a
5571 Win95/98 or NT Workstation logs into a Samba PDC. It allows you to
5572 do
5573 C:\>NET USE H: /HOME
5575 from a command prompt, for example.
5577 This option takes the standard substitutions, allowing you to have
5579 separate logon scripts for each user or machine.
5580 This parameter can be used with Win9X workstations to ensure that
5582 roaming profiles are stored in a subdirectory of the user's home
5583 directory. This is done in the following way:
5584 logon home = \\%N\%U\profile
5586 This tells Samba to return the above string, with substitutions
5588 made when a client requests the info, generally in a NetUserGetInfo
5589 request. Win9X clients truncate the info to \\server\share when a
5590 user does net use /home but use the whole string when dealing with
5591 profiles.
5592 Note that in prior versions of Samba, the logon path was returned
5594 rather than logon home. This broke net use /home but allowed
5595 profiles outside the home directory. The current implementation is
5596 correct, and can be used for profiles if you use the above trick.
5597 Disable this feature by setting logon home = "" - using the empty
5599 string.
5600 This option is only useful if Samba is set up as a logon server.
5602 Default: logon home = \\%N\%U
5604 Example: logon home = \\remote_smb_server\%U
5606 logon path (G)
5608 This parameter specifies the directory where roaming profiles
5610 (Desktop, NTuser.dat, etc) are stored. Contrary to previous
5611 versions of these manual pages, it has nothing to do with Win 9X
5612 roaming profiles. To find out how to handle roaming profiles for
5613 Win 9X system, see the logon home parameter.
5614 This option takes the standard substitutions, allowing you to have
5616 separate logon scripts for each user or machine. It also specifies
5617 the directory from which the "Application Data", desktop, start
5618 menu, network neighborhood, programs and other folders, and their
5619 contents, are loaded and displayed on your Windows NT client.
5620 The share and the path must be readable by the user for the
5622 preferences and directories to be loaded onto the Windows NT
5623 client. The share must be writeable when the user logs in for the
5624 first time, in order that the Windows NT client can create the
5625 NTuser.dat and other directories. Thereafter, the directories and
5626 any of the contents can, if required, be made read-only. It is not
5627 advisable that the NTuser.dat file be made read-only - rename it to
5628 NTuser.man to achieve the desired effect (a MANdatory profile).
5629 Windows clients can sometimes maintain a connection to the [homes]
5631 share, even though there is no user logged in. Therefore, it is
5632 vital that the logon path does not include a reference to the homes
5633 share (i.e. setting this parameter to \\%N\homes\profile_path will
5634 cause problems).
5635 This option takes the standard substitutions, allowing you to have
5637 separate logon scripts for each user or machine.
5638 Warning
5640 Do not quote the value. Setting this as “\\%N\profile\%U” will
5641 break profile handling. Where the tdbsam or ldapsam passdb
5642 backend is used, at the time the user account is created the
5643 value configured for this parameter is written to the passdb
5644 backend and that value will over-ride the parameter value
5645 present in the smb.conf file. Any error present in the passdb
5646 backend account record must be edited using the appropriate
5647 tool (pdbedit on the command-line, or any other locally
5648 provided system tool).
5649 Note that this option is only useful if Samba is set up as a domain
5650 controller.
5651 Disable the use of roaming profiles by setting the value of this
5653 parameter to the empty string. For example, logon path = "". Take
5654 note that even if the default setting in the smb.conf file is the
5655 empty string, any value specified in the user account settings in
5656 the passdb backend will over-ride the effect of setting this
5657 parameter to null. Disabling of all roaming profile use requires
5658 that the user account settings must also be blank.
5659 An example of use is:
5661 logon path = \\PROFILESERVER\PROFILE\%U
5663 Default: logon path = \\%N\%U\profile
5665 logon script (G)
5667 This parameter specifies the batch file (.bat) or NT command file
5669 (.cmd) to be downloaded and run on a machine when a user
5670 successfully logs in. The file must contain the DOS style CR/LF
5671 line endings. Using a DOS-style editor to create the file is
5672 recommended.
5673 The script must be a relative path to the [netlogon] service. If
5675 the [netlogon] service specifies a path of
5676 /usr/local/samba/netlogon, and logon script = STARTUP.BAT, then the
5677 file that will be downloaded is:
5678 /usr/local/samba/netlogon/STARTUP.BAT
5680 The contents of the batch file are entirely your choice. A
5682 suggested command would be to add NET TIME \\SERVER /SET /YES, to
5683 force every machine to synchronize clocks with the same time
5684 server. Another use would be to add NET USE U: \\SERVER\UTILS for
5685 commonly used utilities, or
5686 NET USE Q: \\SERVER\ISO9001_QA
5688 for example.
5690 Note that it is particularly important not to allow write access to
5692 the [netlogon] share, or to grant users write permission on the
5693 batch files in a secure environment, as this would allow the batch
5694 files to be arbitrarily modified and security to be breached.
5695 This option takes the standard substitutions, allowing you to have
5697 separate logon scripts for each user or machine.
5698 This option is only useful if Samba is set up as a logon server in
5700 a classic domain controller role. If Samba is set up as an Active
5701 Directory domain controller, LDAP attribute scriptPath is used
5702 instead. For configurations where passdb backend = ldapsam is in
5703 use, this option only defines a default value in case LDAP
5704 attribute sambaLogonScript is missing.
5705 Default: logon script =
5707 Example: logon script = scripts\%U.bat
5709 log writeable files on exit (G)
5711 When the network connection between a CIFS client and Samba dies,
5713 Samba has no option but to simply shut down the server side of the
5714 network connection. If this happens, there is a risk of data
5715 corruption because the Windows client did not complete all write
5716 operations that the Windows application requested. Setting this
5717 option to "yes" makes smbd log with a level 0 message a list of all
5718 files that have been opened for writing when the network connection
5719 died. Those are the files that are potentially corrupted. It is
5720 meant as an aid for the administrator to give him a list of files
5721 to do consistency checks on.
5722 Default: log writeable files on exit = no
5724 lppause command (S)
5726 This parameter specifies the command to be executed on the server
5728 host in order to stop printing or spooling a specific print job.
5729 This command should be a program or script which takes a printer
5731 name and job number to pause the print job. One way of implementing
5732 this is by using job priorities, where jobs having a too low
5733 priority won't be sent to the printer.
5734 If a %p is given then the printer name is put in its place. A %j is
5736 replaced with the job number (an integer). On HPUX (see
5737 printing=hpux ), if the -p%p option is added to the lpq command,
5738 the job will show up with the correct status, i.e. if the job
5739 priority is lower than the set fence priority it will have the
5740 PAUSED status, whereas if the priority is equal or higher it will
5741 have the SPOOLED or PRINTING status.
5742 Note that it is good practice to include the absolute path in the
5744 lppause command as the PATH may not be available to the server.
5745 Currently no default value is given to this string, unless the
5747 value of the printing parameter is SYSV, in which case the default
5748 is : lp -i %p-%j -H hold or if the value of the printing parameter
5749 is SOFTQ, then the default is: qstat -s -j%j -h.
5750 Default: lppause command = # determined by printing parameter
5752 Example: lppause command = /usr/bin/lpalt %p-%j -p0
5754 lpq cache time (G)
5756 This controls how long lpq info will be cached for to prevent the
5758 lpq command being called too often. A separate cache is kept for
5759 each variation of the lpq command used by the system, so if you use
5760 different lpq commands for different users then they won't share
5761 cache information.
5762 The cache files are stored in /tmp/lpq.xxxx where xxxx is a hash of
5764 the lpq command in use.
5765 The default is 30 seconds, meaning that the cached results of a
5767 previous identical lpq command will be used if the cached data is
5768 less than 30 seconds old. A large value may be advisable if your
5769 lpq command is very slow.
5770 A value of 0 will disable caching completely.
5772 Default: lpq cache time = 30
5774 Example: lpq cache time = 10
5776 lpq command (S)
5778 This parameter specifies the command to be executed on the server
5780 host in order to obtain lpq-style printer status information.
5781 This command should be a program or script which takes a printer
5783 name as its only parameter and outputs printer status information.
5784 Currently nine styles of printer status information are supported;
5786 BSD, AIX, LPRNG, PLP, SYSV, HPUX, QNX, CUPS, and SOFTQ. This covers
5787 most UNIX systems. You control which type is expected using the
5788 printing = option.
5789 Some clients (notably Windows for Workgroups) may not correctly
5791 send the connection number for the printer they are requesting
5792 status information about. To get around this, the server reports on
5793 the first printer service connected to by the client. This only
5794 happens if the connection number sent is invalid.
5795 If a %p is given then the printer name is put in its place.
5797 Otherwise it is placed at the end of the command.
5798 Note that it is good practice to include the absolute path in the
5800 lpq command as the $PATH may not be available to the server. When
5801 compiled with the CUPS libraries, no lpq command is needed because
5802 smbd will make a library call to obtain the print queue listing.
5803 Default: lpq command = # determined by printing parameter
5805 Example: lpq command = /usr/bin/lpq -P%p
5807 lpresume command (S)
5809 This parameter specifies the command to be executed on the server
5811 host in order to restart or continue printing or spooling a
5812 specific print job.
5813 This command should be a program or script which takes a printer
5815 name and job number to resume the print job. See also the lppause
5816 command parameter.
5817 If a %p is given then the printer name is put in its place. A %j is
5819 replaced with the job number (an integer).
5820 Note that it is good practice to include the absolute path in the
5822 lpresume command as the PATH may not be available to the server.
5823 See also the printing parameter.
5825 Default: Currently no default value is given to this string, unless
5827 the value of the printing parameter is SYSV, in which case the
5828 default is:
5829 lp -i %p-%j -H resume
5831 or if the value of the printing parameter is SOFTQ, then the
5833 default is:
5834 qstat -s -j%j -r
5836 Default: lpresume command = # determined by printing parameter
5838 Example: lpresume command = /usr/bin/lpalt %p-%j -p2
5840 lprm command (S)
5842 This parameter specifies the command to be executed on the server
5844 host in order to delete a print job.
5845 This command should be a program or script which takes a printer
5847 name and job number, and deletes the print job.
5848 If a %p is given then the printer name is put in its place. A %j is
5850 replaced with the job number (an integer).
5851 Note that it is good practice to include the absolute path in the
5853 lprm command as the PATH may not be available to the server.
5854 Examples of use are:
5856 lprm command = /usr/bin/lprm -P%p %j
5858 or
5860 lprm command = /usr/bin/cancel %p-%j
5862 Default: lprm command = # determined by printing parameter
5864 lsa over netlogon (G)
5866 Setting this deprecated option will allow the RPC server in the AD
5868 DC to answer the LSARPC interface on the \pipe\netlogon IPC pipe.
5869 When enabled, this matches the behaviour of Microsoft's Windows,
5871 due to their internal implementation choices.
5872 If it is disabled (the default), the AD DC can offer improved
5874 performance, as the netlogon server is decoupled and can run as
5875 multiple processes.
5876 Default: lsa over netlogon = no
5878 machine password timeout (G)
5880 If a Samba server is a member of a Windows NT or Active Directory
5882 Domain (see the security = domain and security = ads parameters),
5883 then periodically a running winbindd process will try and change
5884 the MACHINE ACCOUNT PASSWORD stored in the TDB called secrets.tdb.
5885 This parameter specifies how often this password will be changed,
5886 in seconds. The default is one week (expressed in seconds), the
5887 same as a Windows NT Domain member server.
5888 See also smbpasswd(8), and the security = domain and security = ads
5890 parameters.
5891 Default: machine password timeout = 604800
5893 magic output (S)
5895 This parameter specifies the name of a file which will contain
5897 output created by a magic script (see the magic script parameter
5898 below).
5899 Warning
5901 If two clients use the same magic script in the same directory
5902 the output file content is undefined.
5903 Default: magic output = # <magic script name>.out
5904 Example: magic output = myfile.txt
5906 magic script (S)
5908 This parameter specifies the name of a file which, if opened, will
5910 be executed by the server when the file is closed. This allows a
5911 UNIX script to be sent to the Samba host and executed on behalf of
5912 the connected user.
5913 Scripts executed in this way will be deleted upon completion
5915 assuming that the user has the appropriate level of privilege and
5916 the file permissions allow the deletion.
5917 If the script generates output, output will be sent to the file
5919 specified by the magic output parameter (see above).
5920 Note that some shells are unable to interpret scripts containing
5922 CR/LF instead of CR as the end-of-line marker. Magic scripts must
5923 be executable as is on the host, which for some hosts and some
5924 shells will require filtering at the DOS end.
5925 Magic scripts are EXPERIMENTAL and should NOT be relied upon.
5927 Default: magic script =
5929 Example: magic script = user.csh
5931 mangled names (S)
5933 This controls whether non-DOS names under UNIX should be mapped to
5935 DOS-compatible names ("mangled") and made visible, or whether
5936 non-DOS names should simply be ignored.
5937 See the section on name mangling for details on how to control the
5939 mangling process.
5940 Possible option settings are
5942 • yes - enables name mangling for all not DOS 8.3
5944 conforming names.
5945 • no - disables any name mangling.
5947 • illegal (default) - does mangling for names with illegal
5949 NTFS characters. This is the most sensible setting for
5950 modern clients that don't use the shortname anymore.
5951 If mangling is used then the mangling method is as follows:
5953 • The first (up to) five alphanumeric characters before
5955 the rightmost dot of the filename are preserved, forced
5956 to upper case, and appear as the first (up to) five
5957 characters of the mangled name.
5958 • A tilde "~" is appended to the first part of the mangled
5960 name, followed by a two-character unique sequence, based
5961 on the original root name (i.e., the original filename
5962 minus its final extension). The final extension is
5963 included in the hash calculation only if it contains any
5964 upper case characters or is longer than three
5965 characters.
5966 Note that the character to use may be specified using
5968 the mangling char option, if you don't like '~'.
5969 • Files whose UNIX name begins with a dot will be
5971 presented as DOS hidden files. The mangled name will be
5972 created as for other filenames, but with the leading dot
5973 removed and "___" as its extension regardless of actual
5974 original extension (that's three underscores).
5975 The two-digit hash value consists of upper case alphanumeric
5977 characters.
5978 This algorithm can cause name collisions only if files in a
5980 directory share the same first five alphanumeric characters. The
5981 probability of such a clash is 1/1300.
5982 The name mangling (if enabled) allows a file to be copied between
5984 UNIX directories from Windows/DOS while retaining the long UNIX
5985 filename. UNIX files can be renamed to a new extension from
5986 Windows/DOS and will retain the same basename. Mangled names do not
5987 change between sessions.
5988 Default: mangled names = illegal
5990 Example: mangled names = no
5992 mangle prefix (G)
5994 controls the number of prefix characters from the original name
5996 used when generating the mangled names. A larger value will give a
5997 weaker hash and therefore more name collisions. The minimum value
5998 is 1 and the maximum value is 6.
5999 mangle prefix is effective only when mangling method is hash2.
6001 Default: mangle prefix = 1
6003 Example: mangle prefix = 4
6005 mangling char (S)
6007 This controls what character is used as the magic character in name
6009 mangling. The default is a '~' but this may interfere with some
6010 software. Use this option to set it to whatever you prefer. This is
6011 effective only when mangling method is hash.
6012 Default: mangling char = ~
6014 Example: mangling char = ^
6016 mangling method (G)
6018 controls the algorithm used for the generating the mangled names.
6020 Can take two different values, "hash" and "hash2". "hash" is the
6021 algorithm that was used in Samba for many years and was the default
6022 in Samba 2.2.x "hash2" is now the default and is newer and
6023 considered a better algorithm (generates less collisions) in the
6024 names. Many Win32 applications store the mangled names and so
6025 changing to algorithms must not be done lightly as these
6026 applications may break unless reinstalled.
6027 Default: mangling method = hash2
6029 Example: mangling method = hash
6031 map acl inherit (S)
6033 This boolean parameter is only relevant for systems that do not
6035 support standardized NFS4 ACLs but only a POSIX draft
6036 implementation of ACLs. Linux is the only common UNIX system which
6037 does still not offer standardized NFS4 ACLs actually. On such
6038 systems this parameter controls whether smbd(8) will attempt to map
6039 the 'protected' (don't inherit) flags of the Windows ACLs into an
6040 extended attribute called user.SAMBA_PAI (POSIX draft ACL
6041 Inheritance). This parameter requires support for extended
6042 attributes on the filesystem and allows the Windows ACL editor to
6043 store (non-)inheritance information while NT ACLs are mapped
6044 best-effort to the POSIX draft ACLs that the OS and filesystem
6045 implements.
6046 Default: map acl inherit = no
6048 map archive (S)
6050 This controls whether the DOS archive attribute should be mapped to
6052 the UNIX owner execute bit. The DOS archive bit is set when a file
6053 has been modified since its last backup. One motivation for this
6054 option is to keep Samba/your PC from making any file it touches
6055 from becoming executable under UNIX. This can be quite annoying for
6056 shared source code, documents, etc...
6057 Note that this parameter will be ignored if the store dos
6059 attributes parameter is set, as the DOS archive attribute will then
6060 be stored inside a UNIX extended attribute.
6061 Note that this requires the create mask parameter to be set such
6063 that owner execute bit is not masked out (i.e. it must include
6064 100). See the parameter create mask for details.
6065 Default: map archive = yes
6067 map hidden (S)
6069 This controls whether DOS style hidden files should be mapped to
6071 the UNIX world execute bit.
6072 Note that this parameter will be ignored if the store dos
6074 attributes parameter is set, as the DOS hidden attribute will then
6075 be stored inside a UNIX extended attribute.
6076 Note that this requires the create mask to be set such that the
6078 world execute bit is not masked out (i.e. it must include 001). See
6079 the parameter create mask for details.
6080 Default: map hidden = no
6082 map readonly (S)
6084 This controls how the DOS read only attribute should be mapped from
6086 a UNIX filesystem.
6087 This parameter can take three different values, which tell smbd(8)
6089 how to display the read only attribute on files, where either store
6090 dos attributes is set to No, or no extended attribute is present.
6091 If store dos attributes is set to yes then this parameter is
6092 ignored. This is a new parameter introduced in Samba version
6093 3.0.21.
6094 The three settings are :
6096 • Yes - The read only DOS attribute is mapped to the
6098 inverse of the user or owner write bit in the unix
6099 permission mode set. If the owner write bit is not set,
6100 the read only attribute is reported as being set on the
6101 file. If the read only DOS attribute is set, Samba sets
6102 the owner, group and others write bits to zero. Write
6103 bits set in an ACL are ignored by Samba. If the read
6104 only DOS attribute is unset, Samba simply sets the write
6105 bit of the owner to one.
6106 • Permissions - The read only DOS attribute is mapped to
6108 the effective permissions of the connecting user, as
6109 evaluated by smbd(8) by reading the unix permissions and
6110 filesystem ACL (if present). If the connecting user does
6111 not have permission to modify the file, the read only
6112 attribute is reported as being set on the file.
6113 • No - The read only DOS attribute is unaffected by
6115 permissions, and can only be set by the store dos
6116 attributes method. This may be useful for exporting
6117 mounted CDs.
6118 Note that this parameter will be ignored if the store dos
6120 attributes parameter is set, as the DOS 'read-only' attribute will
6121 then be stored inside a UNIX extended attribute.
6122 The default has changed to no in Samba release 4.9.0 and above to
6124 allow better Windows fileserver compatibility in a default install.
6125 In addition the default setting of store dos attributes has been
6126 changed to Yes in Samba release 4.9.0 and above.
6127 Default: map readonly = no
6129 map system (S)
6131 This controls whether DOS style system files should be mapped to
6133 the UNIX group execute bit.
6134 Note that this parameter will be ignored if the store dos
6136 attributes parameter is set, as the DOS system attribute will then
6137 be stored inside a UNIX extended attribute.
6138 Note that this requires the create mask to be set such that the
6140 group execute bit is not masked out (i.e. it must include 010). See
6141 the parameter create mask for details.
6142 Default: map system = no
6144 map to guest (G)
6146 This parameter can take four different values, which tell smbd(8)
6148 what to do with user login requests that don't match a valid UNIX
6149 user in some way.
6150 The four settings are :
6152 • Never - Means user login requests with an invalid
6154 password are rejected. This is the default.
6155 • Bad User - Means user logins with an invalid password
6157 are rejected, unless the username does not exist, in
6158 which case it is treated as a guest login and mapped
6159 into the guest account.
6160 • Bad Password - Means user logins with an invalid
6162 password are treated as a guest login and mapped into
6163 the guest account. Note that this can cause problems as
6164 it means that any user incorrectly typing their password
6165 will be silently logged on as "guest" - and will not
6166 know the reason they cannot access files they think they
6167 should - there will have been no message given to them
6168 that they got their password wrong. Helpdesk services
6169 will hate you if you set the map to guest parameter this
6170 way :-).
6171 • Bad Uid - Is only applicable when Samba is configured in
6173 some type of domain mode security (security =
6174 {domain|ads}) and means that user logins which are
6175 successfully authenticated but which have no valid Unix
6176 user account (and smbd is unable to create one) should
6177 be mapped to the defined guest account. This was the
6178 default behavior of Samba 2.x releases. Note that if a
6179 member server is running winbindd, this option should
6180 never be required because the nss_winbind library will
6181 export the Windows domain users and groups to the
6182 underlying OS via the Name Service Switch interface.
6183 Note that this parameter is needed to set up "Guest" share
6185 services. This is because in these modes the name of the resource
6186 being requested is not sent to the server until after the server
6187 has successfully authenticated the client so the server cannot make
6188 authentication decisions at the correct time (connection to the
6189 share) for "Guest" shares.
6190 Default: map to guest = Never
6192 Example: map to guest = Bad User
6194 max connections (S)
6196 This option allows the number of simultaneous connections to a
6198 service to be limited. If max connections is greater than 0 then
6199 connections will be refused if this number of connections to the
6200 service are already open. A value of zero mean an unlimited number
6201 of connections may be made.
6202 Record lock files are used to implement this feature. The lock
6204 files will be stored in the directory specified by the lock
6205 directory option.
6206 Default: max connections = 0
6208 Example: max connections = 10
6210 max disk size (G)
6212 This option allows you to put an upper limit on the apparent size
6214 of disks. If you set this option to 100 then all shares will appear
6215 to be not larger than 100 MB in size.
6216 Note that this option does not limit the amount of data you can put
6218 on the disk. In the above case you could still store much more than
6219 100 MB on the disk, but if a client ever asks for the amount of
6220 free disk space or the total disk size then the result will be
6221 bounded by the amount specified in max disk size.
6222 This option is primarily useful to work around bugs in some pieces
6224 of software that can't handle very large disks, particularly disks
6225 over 1GB in size.
6226 A max disk size of 0 means no limit.
6228 Default: max disk size = 0
6230 Example: max disk size = 1000
6232 max log size (G)
6234 This option (an integer in kilobytes) specifies the max size the
6236 log file should grow to. Samba periodically checks the size and if
6237 it is exceeded it will rename the file, adding a .old extension.
6238 A size of 0 means no limit.
6240 Default: max log size = 5000
6242 Example: max log size = 1000
6244 max mux (G)
6246 This option controls the maximum number of outstanding simultaneous
6248 SMB operations that Samba tells the client it will allow. You
6249 should never need to set this parameter.
6250 Default: max mux = 50
6252 max open files (G)
6254 This parameter limits the maximum number of open files that one
6256 smbd(8) file serving process may have open for a client at any one
6257 time. This parameter can be set very high (16384) as Samba uses
6258 only one bit per unopened file. Setting this parameter lower than
6259 16384 will cause Samba to complain and set this value back to the
6260 minimum of 16384, as Windows 7 depends on this number of open file
6261 handles being available.
6262 The limit of the number of open files is usually set by the UNIX
6264 per-process file descriptor limit rather than this parameter so you
6265 should never need to touch this parameter.
6266 Default: max open files = 16384
6268 max print jobs (S)
6270 This parameter limits the maximum number of jobs allowable in a
6272 Samba printer queue at any given moment. If this number is
6273 exceeded, smbd(8) will remote "Out of Space" to the client.
6274 Default: max print jobs = 1000
6276 Example: max print jobs = 5000
6278 max reported print jobs (S)
6280 This parameter limits the maximum number of jobs displayed in a
6282 port monitor for Samba printer queue at any given moment. If this
6283 number is exceeded, the excess jobs will not be shown. A value of
6284 zero means there is no limit on the number of print jobs reported.
6285 Default: max reported print jobs = 0
6287 Example: max reported print jobs = 1000
6289 max smbd processes (G)
6291 This parameter limits the maximum number of smbd(8) processes
6293 concurrently running on a system and is intended as a stopgap to
6294 prevent degrading service to clients in the event that the server
6295 has insufficient resources to handle more than this number of
6296 connections. Remember that under normal operating conditions, each
6297 user will have an smbd(8) associated with him or her to handle
6298 connections to all shares from a given host.
6299 For a Samba ADDC running the standard process model this option
6301 limits the number of processes forked to handle requests. Currently
6302 new processes are only forked for ldap and netlogon requests.
6303 Default: max smbd processes = 0
6305 Example: max smbd processes = 1000
6307 max stat cache size (G)
6309 This parameter limits the size in memory of any stat cache being
6311 used to speed up case insensitive name mappings. It represents the
6312 number of kilobyte (1024) units the stat cache can use. A value of
6313 zero, meaning unlimited, is not advisable due to increased memory
6314 usage. You should not need to change this parameter.
6315 Default: max stat cache size = 512
6317 Example: max stat cache size = 100
6319 max ttl (G)
6321 This option tells nmbd(8) what the default 'time to live' of
6323 NetBIOS names should be (in seconds) when nmbd is requesting a name
6324 using either a broadcast packet or from a WINS server. You should
6325 never need to change this parameter. The default is 3 days.
6326 Default: max ttl = 259200
6328 max wins ttl (G)
6330 This option tells smbd(8) when acting as a WINS server (wins
6332 support = yes) what the maximum 'time to live' of NetBIOS names
6333 that nmbd will grant will be (in seconds). You should never need to
6334 change this parameter. The default is 6 days (518400 seconds).
6335 Default: max wins ttl = 518400
6337 max xmit (G)
6339 This option controls the maximum packet size that will be
6341 negotiated by Samba's smbd(8) for the SMB1 protocol. The default is
6342 16644, which matches the behavior of Windows 2000. A value below
6343 2048 is likely to cause problems. You should never need to change
6344 this parameter from its default value.
6345 Default: max xmit = 16644
6347 Example: max xmit = 8192
6349 mdns name (G)
6351 This parameter controls the name that multicast DNS support
6353 advertises as its' hostname.
6354 The default is to use the NETBIOS name which is typically the
6356 hostname in all capital letters.
6357 A setting of mdns will defer the hostname configuration to the MDNS
6359 library that is used.
6360 Default: mdns name = netbios
6362 message command (G)
6364 This specifies what command to run when the server receives a
6366 WinPopup style message.
6367 This would normally be a command that would deliver the message
6369 somehow. How this is to be done is up to your imagination.
6370 An example is:
6372 message command = csh -c 'xedit %s;rm %s' &
6374 This delivers the message using xedit, then removes it afterwards.
6376 NOTE THAT IT IS VERY IMPORTANT THAT THIS COMMAND RETURN
6377 IMMEDIATELY. That's why I have the '&' on the end. If it doesn't
6378 return immediately then your PCs may freeze when sending messages
6379 (they should recover after 30 seconds, hopefully).
6380 All messages are delivered as the global guest user. The command
6382 takes the standard substitutions, although
6383 %u won't work (%U may be better in this case).
6384 Apart from the standard substitutions, some additional ones apply.
6386 In particular:
6387 • %s = the filename containing the message.
6389 • %t = the destination that the message was sent to
6391 (probably the server name).
6392 • %f = who the message is from.
6394 You could make this command send mail, or whatever else takes your
6396 fancy. Please let us know of any really interesting ideas you have.
6397 Here's a way of sending the messages as mail to root:
6399 message command = /bin/mail -s 'message from %f on %m' root < %s; rm %s
6401 If you don't have a message command then the message won't be
6403 delivered and Samba will tell the sender there was an error.
6404 Unfortunately WfWg totally ignores the error code and carries on
6405 regardless, saying that the message was delivered.
6406 If you want to silently delete it then try:
6408 message command = rm %s
6410 Default: message command =
6412 Example: message command = csh -c 'xedit %s; rm %s' &
6414 min domain uid (G)
6416 The integer parameter specifies the minimum uid allowed when
6418 mapping a local account to a domain account.
6419 Note that this option interacts with the configured idmap ranges!
6421 Default: min domain uid = 1000
6423 min print space (S)
6425 This sets the minimum amount of free disk space that must be
6427 available before a user will be able to spool a print job. It is
6428 specified in kilobytes. The default is 0, which means a user can
6429 always spool a print job.
6430 Default: min print space = 0
6432 Example: min print space = 2000
6434 min receivefile size (G)
6436 This option changes the behavior of smbd(8) when processing
6438 SMBwriteX calls. Any incoming SMBwriteX call on a non-signed
6439 SMB/CIFS connection greater than this value will not be processed
6440 in the normal way but will be passed to any underlying kernel
6441 recvfile or splice system call (if there is no such call Samba will
6442 emulate in user space). This allows zero-copy writes directly from
6443 network socket buffers into the filesystem buffer cache, if
6444 available. It may improve performance but user testing is
6445 recommended. If set to zero Samba processes SMBwriteX calls in the
6446 normal way. To enable POSIX large write support (SMB/CIFS writes up
6447 to 16Mb) this option must be nonzero. The maximum value is 128k.
6448 Values greater than 128k will be silently set to 128k.
6449 Note this option will have NO EFFECT if set on a SMB signed
6451 connection.
6452 The default is zero, which disables this option.
6454 Default: min receivefile size = 0
6456 min wins ttl (G)
6458 This option tells nmbd(8) when acting as a WINS server (wins
6460 support = yes) what the minimum 'time to live' of NetBIOS names
6461 that nmbd will grant will be (in seconds). You should never need to
6462 change this parameter. The default is 6 hours (21600 seconds).
6463 Default: min wins ttl = 21600
6465 mit kdc command (G)
6467 This option specifies the path to the MIT kdc binary.
6469 If the KDC is not installed in the default location and wasn't
6471 correctly detected during build then you should modify this
6472 variable and point it to the correct binary.
6473 Default: mit kdc command = /usr/sbin/krb5kdc
6475 Example: mit kdc command = /opt/mit/sbin/krb5kdc
6477 msdfs proxy (S)
6479 This parameter indicates that the share is a stand-in for another
6481 CIFS share whose location is specified by the value of the
6482 parameter. When clients attempt to connect to this share, they are
6483 redirected to one or multiple, comma separated proxied shares using
6484 the SMB-Dfs protocol.
6485 Only Dfs roots can act as proxy shares. Take a look at the msdfs
6487 root and host msdfs options to find out how to set up a Dfs root
6488 share.
6489 No default
6491 Example: msdfs proxy =
6493 \otherserver\someshare,\otherserver2\someshare
6494 msdfs root (S)
6496 If set to yes, Samba treats the share as a Dfs root and allows
6498 clients to browse the distributed file system tree rooted at the
6499 share directory. Dfs links are specified in the share directory by
6500 symbolic links of the form msdfs:serverA\\shareA,serverB\\shareB
6501 and so on. For more information on setting up a Dfs tree on Samba,
6502 refer to the MSDFS chapter in the Samba3-HOWTO book.
6503 Default: msdfs root = no
6505 msdfs shuffle referrals (S)
6507 If set to yes, Samba will shuffle Dfs referrals for a given Dfs
6509 link if multiple are available, allowing for load balancing across
6510 clients. For more information on setting up a Dfs tree on Samba,
6511 refer to the MSDFS chapter in the Samba3-HOWTO book.
6512 Default: msdfs shuffle referrals = no
6514 multicast dns register (G)
6516 If compiled with proper support for it, Samba will announce itself
6518 with multicast DNS services like for example provided by the Avahi
6519 daemon.
6520 This parameter allows disabling Samba to register itself.
6522 Default: multicast dns register = yes
6524 name cache timeout (G)
6526 Specifies the number of seconds it takes before entries in samba's
6528 hostname resolve cache time out. If the timeout is set to 0. the
6529 caching is disabled.
6530 Default: name cache timeout = 660
6532 Example: name cache timeout = 0
6534 name resolve order (G)
6536 This option is used by the programs in the Samba suite to determine
6538 what naming services to use and in what order to resolve host names
6539 to IP addresses. Its main purpose to is to control how netbios name
6540 resolution is performed. The option takes a space separated string
6541 of name resolution options.
6542 The options are: "lmhosts", "host", "wins" and "bcast". They cause
6544 names to be resolved as follows:
6545 • lmhosts : Lookup an IP address in the Samba lmhosts
6547 file. If the line in lmhosts has no name type attached
6548 to the NetBIOS name (see the manpage for lmhosts for
6549 details) then any name type matches for lookup.
6550 • host : Do a standard host name to IP address resolution,
6552 using the system /etc/hosts or DNS lookups. This method
6553 of name resolution is operating system depended for
6554 instance on IRIX or Solaris this may be controlled by
6555 the /etc/nsswitch.conf file. Note that this method is
6556 used only if the NetBIOS name type being queried is the
6557 0x20 (server) name type or 0x1c (domain controllers).
6558 The latter case is only useful for active directory
6559 domains and results in a DNS query for the SRV RR entry
6560 matching _ldap._tcp.domain.
6561 • wins : Query a name with the IP address listed in the
6563 WINSSERVER parameter. If no WINS server has been
6564 specified this method will be ignored.
6565 • bcast : Do a broadcast on each of the known local
6567 interfaces listed in the interfaces parameter. This is
6568 the least reliable of the name resolution methods as it
6569 depends on the target host being on a locally connected
6570 subnet.
6571 The example below will cause the local lmhosts file to be examined
6573 first, followed by a broadcast attempt, followed by a normal system
6574 hostname lookup.
6575 When Samba is functioning in ADS security mode (security = ads) it
6577 is advised to use following settings for name resolve order:
6578 name resolve order = wins bcast
6580 DC lookups will still be done via DNS, but fallbacks to netbios
6582 names will not inundate your DNS servers with needless queries for
6583 DOMAIN<0x1c> lookups.
6584 Default: name resolve order = lmhosts wins host bcast
6586 Example: name resolve order = lmhosts bcast host
6588 socket address
6590 This parameter is a synonym for nbt client socket address.
6592 nbt client socket address (G)
6594 This option allows you to control what address Samba will send NBT
6596 client packets from, and process replies using, including in nmbd.
6597 Setting this option should never be necessary on usual Samba
6599 servers running only one nmbd.
6600 By default Samba will send UDP packets from the OS default address
6602 for the destination, and accept replies on 0.0.0.0.
6603 This parameter is deprecated. See bind interfaces only = Yes and
6605 interfaces for the previous behaviour of controlling the normal
6606 listening sockets.
6607 Default: nbt client socket address = 0.0.0.0
6609 Example: nbt client socket address = 192.168.2.20
6611 nbtd:wins_prepend1Bto1Cqueries (G)
6613 Normally queries for 0x1C names (all logon servers for a domain)
6615 will return the first address of the 0x1B names (domain master
6616 browser and PDC) as first address in the result list. As many
6617 client only use the first address in the list by default, all
6618 clients will use the same server (the PDC). Windows servers have an
6619 option to disable this behavior (since Windows 2000 Service Pack
6620 2).
6621 Default: nbtd:wins_prepend1Bto1Cqueries = yes
6623 nbtd:wins_wins_randomize1Clist (G)
6625 Normally queries for 0x1C names will return the addresses in the
6627 same order as they're stored in the database, that means first all
6628 addresses which have been directly registered at the local wins
6629 server and then all addresses registered at other servers. Windows
6630 servers have an option to change this behavior and randomize the
6631 returned addresses. Set this parameter to "yes" and Samba will sort
6632 the address list depending on the client address and the matching
6633 bits of the addresses, the first address is randomized based on
6634 depending on the "nbtd:wins_randomize1Clist_mask" parameter.
6635 Default: nbtd:wins_wins_randomize1Clist = no
6637 nbtd:wins_randomize1Clist_mask (G)
6639 If the "nbtd:wins_randomize1Clist" parameter is set to "yes", then
6641 randomizing of the first returned address is based on the specified
6642 netmask. If there are addresses which are in the same subnet as the
6643 client address, the first returned address is randomly chosen out
6644 them. Otherwise the first returned address is randomly chosen out
6645 of all addresses.
6646 Default: nbtd:wins_randomize1Clist_mask = 255.255.255.0
6648 nbt port (G)
6650 Specifies which port the server should use for NetBIOS over IP name
6652 services traffic.
6653 Default: nbt port = 137
6655 ncalrpc dir (G)
6657 This directory will hold a series of named pipes to allow RPC over
6659 inter-process communication.
6660 This will allow Samba and other unix processes to interact over
6662 DCE/RPC without using TCP/IP. Additionally a sub-directory 'np' has
6663 restricted permissions, and allows a trusted communication channel
6664 between Samba processes
6665 Default: ncalrpc dir = /run/samba/ncalrpc
6667 Example: ncalrpc dir = /var/run/samba/ncalrpc
6669 netbios aliases (G)
6671 This is a list of NetBIOS names that nmbd will advertise as
6673 additional names by which the Samba server is known. This allows
6674 one machine to appear in browse lists under multiple names. If a
6675 machine is acting as a browse server or logon server none of these
6676 names will be advertised as either browse server or logon servers,
6677 only the primary name of the machine will be advertised with these
6678 capabilities.
6679 Default: netbios aliases = # empty string (no additional names)
6681 Example: netbios aliases = TEST TEST1 TEST2
6683 netbios name (G)
6685 This sets the NetBIOS name by which a Samba server is known. By
6687 default it is the same as the first component of the host's DNS
6688 name. If a machine is a browse server or logon server this name (or
6689 the first component of the hosts DNS name) will be the name that
6690 these services are advertised under.
6691 Note that the maximum length for a NetBIOS name is 15 characters.
6693 There is a bug in Samba that breaks operation of browsing and
6695 access to shares if the netbios name is set to the literal name
6696 PIPE. To avoid this problem, do not name your Samba server PIPE.
6697 Default: netbios name = # machine DNS name
6699 Example: netbios name = MYNAME
6701 netbios scope (G)
6703 This sets the NetBIOS scope that Samba will operate under. This
6705 should not be set unless every machine on your LAN also sets this
6706 value.
6707 Default: netbios scope =
6709 neutralize nt4 emulation (G)
6711 This option controls whether winbindd sends the
6713 NETLOGON_NEG_NEUTRALIZE_NT4_EMULATION flag in order to bypass the
6714 NT4 emulation of a domain controller.
6715 Typically you should not need set this. It can be useful for
6717 upgrades from NT4 to AD domains.
6718 The behavior can be controlled per netbios domain by using
6720 'neutralize nt4 emulation:NETBIOSDOMAIN = yes' as option.
6721 Default: neutralize nt4 emulation = no
6723 nmbd bind explicit broadcast (G)
6725 This option causes nmbd(8) to explicitly bind to the broadcast
6727 address of the local subnets. This is needed to make nmbd work
6728 correctly in combination with the socket address option. You should
6729 not need to unset this option.
6730 Default: nmbd bind explicit broadcast = yes
6732 nsupdate command (G)
6734 This option sets the path to the nsupdate command which is used for
6736 GSS-TSIG dynamic DNS updates.
6737 Default: nsupdate command = /usr/bin/nsupdate -g
6739 nt hash store (G)
6741 This parameter determines whether or not samba(8) will, as an AD
6743 DC, attempt to store the NT password hash used in NTLM and NTLMv2
6744 authentication for users in this domain.
6745 If so configured, the Samba Active Directory Domain Controller,
6747 will, except for trust accounts (computers, domain controllers and
6748 inter-domain trusts) the NOT store the NT hash for new and changed
6749 accounts in the sam.ldb database.
6750 This avoids the storage of an unsalted hash for these user-created
6752 passwords. As a consequence the arcfour-hmac-md5 Kerberos key type
6753 is also unavailable in the KDC for these users - thankfully modern
6754 clients will select an AES based key instead.
6755 NOTE: As the password history in Active Directory is stored as an
6757 NT hash (and thus unavailable), a workaround is used, relying
6758 instead on Kerberos password hash values. This stores three
6759 passwords, the current, previous and second previous password. This
6760 allows some checking against reuse.
6761 However as these values are salted, changing the sAMAccountName,
6763 userAccountControl or userPrincipalName of an account will cause
6764 the salt to change. After the rare combination of both a rename and
6765 a password change only the current password will be recognised for
6766 password history purposes.
6767 The available settings are:
6769 • always - Always store the NT hash (as machine accounts
6771 will also always store an NT hash, a hash will be stored
6772 for all accounts).
6773 This setting may be useful if ntlm auth is set to
6775 disabled for a trial period
6776 • never - Never store the NT hash for user accounts, only
6778 for machine accounts
6779 • auto - Store an NT hash if ntlm auth is not set to
6781 disabled.
6782 Default: nt hash store = always
6784 nt acl support (S)
6786 This boolean parameter controls whether smbd(8) will attempt to map
6788 UNIX permissions into Windows NT access control lists. The UNIX
6789 permissions considered are the traditional UNIX owner and group
6790 permissions, as well as filesystem ACLs set on any files or
6791 directories. This parameter was formally a global parameter in
6792 releases prior to 2.2.2.
6793 Default: nt acl support = yes
6795 ntlm auth (G)
6797 This parameter determines whether or not smbd(8) will attempt to
6799 authenticate users using the NTLM encrypted password response for
6800 this local passdb (SAM or account database).
6801 If disabled, both NTLM and LanMan authentication against the local
6803 passdb is disabled.
6804 Note that these settings apply only to local users, authentication
6806 will still be forwarded to and NTLM authentication accepted against
6807 any domain we are joined to, and any trusted domain, even if
6808 disabled or if NTLMv2-only is enforced here. To control NTLM
6809 authentiation for domain users, this must option must be configured
6810 on each DC.
6811 By default with ntlm auth set to ntlmv2-only only NTLMv2 logins
6813 will be permitted. All modern clients support NTLMv2 by default,
6814 but some older clients will require special configuration to use
6815 it.
6816 The primary user of NTLMv1 is MSCHAPv2 for VPNs and 802.1x.
6818 The available settings are:
6820 • ntlmv1-permitted (alias yes) - Allow NTLMv1 and above
6822 for all clients.
6823 This is the required setting for to enable the lanman
6825 auth parameter.
6826 • ntlmv2-only (alias no) - Do not allow NTLMv1 to be used,
6828 but permit NTLMv2.
6829 • mschapv2-and-ntlmv2-only - Only allow NTLMv1 when the
6831 client promises that it is providing MSCHAPv2
6832 authentication (such as the ntlm_auth tool).
6833 • disabled - Do not accept NTLM (or LanMan) authentication
6835 of any level, nor permit NTLM password changes.
6836 WARNING: Both Microsoft Windows and Samba Read Only
6838 Domain Controllers (RODCs) convert a plain-text LDAP
6839 Simple Bind into an NTLMv2 authentication to forward to
6840 a full DC. Setting this option to disabled will cause
6841 these forwarded authentications to fail.
6842 Additionally, for Samba acting as an Active Directory
6844 Domain Controller, for user accounts, if nt hash store
6845 is set to the default setting of auto, the NT hash will
6846 not be stored in the sam.ldb database for new users and
6847 after a password change.
6848 The default changed from yes to no with Samba 4.5. The default
6850 changed again to ntlmv2-only with Samba 4.7, however the behaviour
6851 is unchanged.
6852 Default: ntlm auth = ntlmv2-only
6854 nt pipe support (G)
6856 This boolean parameter controls whether smbd(8) will allow Windows
6858 NT clients to connect to the NT SMB specific IPC$ pipes. This is a
6859 developer debugging option and can be left alone.
6860 Default: nt pipe support = yes
6862 ntp signd socket directory (G)
6864 This setting controls the location of the socket that the NTP
6866 daemon uses to communicate with Samba for signing packets.
6867 If a non-default path is specified here, then it is also necessary
6869 to make NTP aware of the new path using the ntpsigndsocket
6870 directive in ntp.conf.
6871 Default: ntp signd socket directory = /var/lib/samba/ntp_signd
6873 nt status support (G)
6875 This boolean parameter controls whether smbd(8) will negotiate NT
6877 specific status support with Windows NT/2k/XP clients. This is a
6878 developer debugging option and should be left alone. If this option
6879 is set to no then Samba offers exactly the same DOS error codes
6880 that versions prior to Samba 2.2.3 reported.
6881 You should not need to ever disable this parameter.
6883 Default: nt status support = yes
6885 ntvfs handler (S)
6887 This specifies the NTVFS handlers for this share.
6889 • unixuid: Sets up user credentials based on POSIX
6891 gid/uid.
6892 • cifs: Proxies a remote CIFS FS. Mainly useful for
6894 testing.
6895 • nbench: Filter module that saves data useful to the
6897 nbench benchmark suite.
6898 • ipc: Allows using SMB for inter process communication.
6900 Only used for the IPC$ share.
6901 • posix: Maps POSIX FS semantics to NT semantics
6903 • print: Allows printing over SMB. This is LANMAN-style
6905 printing, not the be confused with the spoolss DCE/RPC
6906 interface used by later versions of Windows.
6907 Note that this option is only used when the NTVFS file server is in
6909 use. It is not used with the (default) s3fs file server.
6910 Default: ntvfs handler = unixuid, default
6912 null passwords (G)
6914 Allow or disallow client access to accounts that have null
6916 passwords.
6917 See also smbpasswd(5).
6919 Default: null passwords = no
6921 obey pam restrictions (G)
6923 When Samba 3.0 is configured to enable PAM support (i.e.
6925 --with-pam), this parameter will control whether or not Samba
6926 should obey PAM's account and session management directives. The
6927 default behavior is to use PAM for clear text authentication only
6928 and to ignore any account or session management. Note that Samba
6929 always ignores PAM for authentication in the case of encrypt
6930 passwords = yes. The reason is that PAM modules cannot support the
6931 challenge/response authentication mechanism needed in the presence
6932 of SMB password encryption.
6933 Default: obey pam restrictions = no
6935 old password allowed period (G)
6937 Number of minutes to permit an NTLM login after a password change
6939 or reset using the old password. This allows the user to re-cache
6940 the new password on multiple clients without disrupting a network
6941 reconnection in the meantime.
6942 This parameter only applies when server role is set to Active
6944 Directory Domain Controller.
6945 Default: old password allowed period = 60
6947 oplock break wait time (G)
6949 This is a tuning parameter added due to bugs in both Windows 9x and
6951 WinNT. If Samba responds to a client too quickly when that client
6952 issues an SMB that can cause an oplock break request, then the
6953 network client can fail and not respond to the break request. This
6954 tuning parameter (which is set in milliseconds) is the amount of
6955 time Samba will wait before sending an oplock break request to such
6956 (broken) clients.
6957 Warning
6959 DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ AND
6960 UNDERSTOOD THE SAMBA OPLOCK CODE.
6961 Default: oplock break wait time = 0
6962 oplocks (S)
6964 This boolean option tells smbd whether to issue oplocks
6966 (opportunistic locks) to file open requests on this share. The
6967 oplock code can dramatically (approx. 30% or more) improve the
6968 speed of access to files on Samba servers. It allows the clients to
6969 aggressively cache files locally and you may want to disable this
6970 option for unreliable network environments (it is turned on by
6971 default in Windows NT Servers).
6972 Oplocks may be selectively turned off on certain files with a
6974 share. See the veto oplock files parameter. On some systems oplocks
6975 are recognized by the underlying operating system. This allows data
6976 synchronization between all access to oplocked files, whether it be
6977 via Samba or NFS or a local UNIX process. See the kernel oplocks
6978 parameter for details.
6979 Default: oplocks = yes
6981 os2 driver map (G)
6983 The parameter is used to define the absolute path to a file
6985 containing a mapping of Windows NT printer driver names to OS/2
6986 printer driver names. The format is:
6987 <nt driver name> = <os2 driver name>.<device name>
6989 For example, a valid entry using the HP LaserJet 5 printer driver
6991 would appear as HP LaserJet 5L = LASERJET.HP LaserJet 5L.
6992 The need for the file is due to the printer driver namespace
6994 problem described in the chapter on Classical Printing in the
6995 Samba3-HOWTO book. For more details on OS/2 clients, please refer
6996 to chapter on other clients in the Samba3-HOWTO book.
6997 Default: os2 driver map =
6999 os level (G)
7001 This integer value controls what level Samba advertises itself as
7003 for browse elections. The value of this parameter determines
7004 whether nmbd(8) has a chance of becoming a local master browser for
7005 the workgroup in the local broadcast area.
7006 Note: By default, Samba will win a local master browsing election
7008 over all Microsoft operating systems except a Windows NT 4.0/2000
7009 Domain Controller. This means that a misconfigured Samba host can
7010 effectively isolate a subnet for browsing purposes. This parameter
7011 is largely auto-configured in the Samba-3 release series and it is
7012 seldom necessary to manually override the default setting. Please
7013 refer to the chapter on Network Browsing in the Samba-3 HOWTO
7014 document for further information regarding the use of this
7015 parameter. Note: The maximum value for this parameter is 255. If
7016 you use higher values, counting will start at 0!
7017 Default: os level = 20
7019 Example: os level = 65
7021 pam password change (G)
7023 With the addition of better PAM support in Samba 2.2, this
7025 parameter, it is possible to use PAM's password change control flag
7026 for Samba. If enabled, then PAM will be used for password changes
7027 when requested by an SMB client instead of the program listed in
7028 passwd program. It should be possible to enable this without
7029 changing your passwd chat parameter for most setups.
7030 Default: pam password change = no
7032 panic action (G)
7034 This is a Samba developer option that allows a system command to be
7036 called when either smbd(8) or nmbd(8) crashes. This is usually used
7037 to draw attention to the fact that a problem occurred.
7038 Default: panic action =
7040 Example: panic action = /bin/sleep 90000
7042 passdb backend (G)
7044 This option allows the administrator to chose which backend will be
7046 used for storing user and possibly group information. This allows
7047 you to swap between different storage mechanisms without recompile.
7048 The parameter value is divided into two parts, the backend's name,
7050 and a 'location' string that has meaning only to that particular
7051 backed. These are separated by a : character.
7052 Available backends can include:
7054 • smbpasswd - The old plaintext passdb backend. Some Samba
7056 features will not work if this passdb backend is used.
7057 Takes a path to the smbpasswd file as an optional
7058 argument.
7059 • tdbsam - The TDB based password storage backend. Takes a
7061 path to the TDB as an optional argument (defaults to
7062 passdb.tdb in the private dir directory.
7063 • ldapsam - The LDAP based passdb backend. Takes an LDAP
7065 URL as an optional argument (defaults to
7066 ldap://localhost)
7067 LDAP connections should be secured where possible. This
7069 may be done using either Start-TLS (see ldap ssl) or by
7070 specifying ldaps:// in the URL argument.
7071 Multiple servers may also be specified in double-quotes.
7073 Whether multiple servers are supported or not and the
7074 exact syntax depends on the LDAP library you use.
7075 Examples of use are:
7078 passdb backend = tdbsam:/etc/samba/private/passdb.tdb
7080 or multi server LDAP URL with OpenLDAP library:
7082 passdb backend = ldapsam:"ldap://ldap-1.example.com ldap://ldap-2.example.com"
7084 or multi server LDAP URL with Netscape based LDAP library:
7086 passdb backend = ldapsam:"ldap://ldap-1.example.com ldap-2.example.com"
7088 Default: passdb backend = tdbsam
7090 passdb expand explicit (G)
7092 This parameter controls whether Samba substitutes %-macros in the
7094 passdb fields if they are explicitly set. We used to expand macros
7095 here, but this turned out to be a bug because the Windows client
7096 can expand a variable %G_osver% in which %G would have been
7097 substituted by the user's primary group.
7098 Default: passdb expand explicit = no
7100 passwd chat (G)
7102 This string controls the "chat" conversation that takes places
7104 between smbd(8) and the local password changing program to change
7105 the user's password. The string describes a sequence of
7106 response-receive pairs that smbd(8) uses to determine what to send
7107 to the passwd program and what to expect back. If the expected
7108 output is not received then the password is not changed.
7109 This chat sequence is often quite site specific, depending on what
7111 local methods are used for password control.
7112 Note that this parameter only is used if the unix password sync
7114 parameter is set to yes. This sequence is then called AS ROOT when
7115 the SMB password in the smbpasswd file is being changed, without
7116 access to the old password cleartext. This means that root must be
7117 able to reset the user's password without knowing the text of the
7118 previous password.
7119 The string can contain the macro %n which is substituted for the
7121 new password. The old password (%o) is only available when encrypt
7122 passwords has been disabled. The chat sequence can also contain the
7123 standard macros \n, \r, \t and \s to give line-feed,
7124 carriage-return, tab and space. The chat sequence string can also
7125 contain a '*' which matches any sequence of characters. Double
7126 quotes can be used to collect strings with spaces in them into a
7127 single string.
7128 If the send string in any part of the chat sequence is a full stop
7130 ".", then no string is sent. Similarly, if the expect string is a
7131 full stop then no string is expected.
7132 If the pam password change parameter is set to yes, the chat pairs
7134 may be matched in any order, and success is determined by the PAM
7135 result, not any particular output. The \n macro is ignored for PAM
7136 conversions.
7137 Default: passwd chat = *new*password* %n\n *new*password* %n\n
7139 *changed*
7140 Example: passwd chat = "*Enter NEW password*" %n\n "*Reenter NEW
7142 password*" %n\n "*Password changed*"
7143 passwd chat debug (G)
7145 This boolean specifies if the passwd chat script parameter is run
7147 in debug mode. In this mode the strings passed to and received from
7148 the passwd chat are printed in the smbd(8) log with a debug level
7149 of 100. This is a dangerous option as it will allow plaintext
7150 passwords to be seen in the smbd log. It is available to help Samba
7151 admins debug their passwd chat scripts when calling the passwd
7152 program and should be turned off after this has been done. This
7153 option has no effect if the pam password change parameter is set.
7154 This parameter is off by default.
7155 Default: passwd chat debug = no
7157 passwd chat timeout (G)
7159 This integer specifies the number of seconds smbd will wait for an
7161 initial answer from a passwd chat script being run. Once the
7162 initial answer is received the subsequent answers must be received
7163 in one tenth of this time. The default it two seconds.
7164 Default: passwd chat timeout = 2
7166 passwd program (G)
7168 The name of a program that can be used to set UNIX user passwords.
7170 Any occurrences of %u will be replaced with the user name. The user
7171 name is checked for existence before calling the password changing
7172 program.
7173 Also note that many passwd programs insist in reasonable passwords,
7175 such as a minimum length, or the inclusion of mixed case chars and
7176 digits. This can pose a problem as some clients (such as Windows
7177 for Workgroups) uppercase the password before sending it.
7178 Note that if the unix password sync parameter is set to yes then
7180 this program is called AS ROOT before the SMB password in the
7181 smbpasswd file is changed. If this UNIX password change fails, then
7182 smbd will fail to change the SMB password also (this is by design).
7183 If the unix password sync parameter is set this parameter MUST USE
7185 ABSOLUTE PATHS for ALL programs called, and must be examined for
7186 security implications. Note that by default unix password sync is
7187 set to no.
7188 Default: passwd program =
7190 Example: passwd program = /bin/passwd %u
7192 password hash gpg key ids (G)
7194 If samba is running as an active directory domain controller, it is
7196 possible to store the cleartext password of accounts in a
7197 PGP/OpenGPG encrypted form.
7198 You can specify one or more recipients by key id or user id. Note
7200 that 32bit key ids are not allowed, specify at least 64bit.
7201 The value is stored as 'Primary:SambaGPG' in the
7203 supplementalCredentials attribute.
7204 As password changes can occur on any domain controller, you should
7206 configure this on each of them. Note that this feature is currently
7207 available only on Samba domain controllers.
7208 This option is only available if samba was compiled with gpgme
7210 support.
7211 You may need to export the GNUPGHOME environment variable before
7213 starting samba. It is strongly recommended to only store the
7214 public key in this location. The private key is not used for
7215 encryption and should be only stored where decryption is required.
7216 Being able to restore the cleartext password helps, when they need
7218 to be imported into other authentication systems later (see
7219 samba-tool user getpassword) or you want to keep the passwords in
7220 sync with another system, e.g. an OpenLDAP server (see samba-tool
7221 user syncpasswords).
7222 While this option needs to be configured on all domain controllers,
7224 the samba-tool user syncpasswords command should run on a single
7225 domain controller only (typically the PDC-emulator).
7226 Default: password hash gpg key ids =
7228 Example: password hash gpg key ids = 4952E40301FAB41A
7230 Example: password hash gpg key ids = selftest@samba.example.com
7232 Example: password hash gpg key ids = selftest@samba.example.com,
7234 4952E40301FAB41A
7235 password hash userPassword schemes (G)
7237 This parameter determines whether or not samba(8) acting as an
7239 Active Directory Domain Controller will attempt to store additional
7240 passwords hash types for the user
7241 The values are stored as 'Primary:userPassword' in the
7243 supplementalCredentials attribute. The value of this option is a
7244 hash type.
7245 The currently supported hash types are:
7247 • CryptSHA256
7249 • CryptSHA512
7251 Multiple instances of a hash type may be computed and stored. The
7253 password hashes are calculated using the crypt(3) call. The number
7254 of rounds used to compute the hash can be specified by adding
7255 ':rounds=xxxx' to the hash type, i.e. CryptSHA512:rounds=4500 would
7256 calculate an SHA512 hash using 4500 rounds. If not specified the
7257 Operating System defaults for crypt(3) are used.
7258 As password changes can occur on any domain controller, you should
7260 configure this on each of them. Note that this feature is currently
7261 available only on Samba domain controllers.
7262 Currently the NT Hash of the password is recorded when these hashes
7264 are calculated and stored. When retrieving the hashes the current
7265 value of the NT Hash is checked against the stored NT Hash. This
7266 detects password changes that have not updated the password hashes.
7267 In this case samba-tool user will ignore the stored hash values.
7268 Being able to obtain the hashed password helps, when they need to
7270 be imported into other authentication systems later (see samba-tool
7271 user getpassword) or you want to keep the passwords in sync with
7272 another system, e.g. an OpenLDAP server (see samba-tool user
7273 syncpasswords).
7274 Related command: unix password sync
7276 Default: password hash userPassword schemes =
7278 Example: password hash userPassword schemes = CryptSHA256
7280 Example: password hash userPassword schemes = CryptSHA256
7282 CryptSHA512
7283 Example: password hash userPassword schemes =
7285 CryptSHA256:rounds=5000 CryptSHA512:rounds=7000
7286 password server (G)
7288 By specifying the name of a domain controller with this option, and
7290 using security = [ads|domain] it is possible to get Samba to do all
7291 its username/password validation using a specific remote server.
7292 Ideally, this option should not be used, as the default '*'
7294 indicates to Samba to determine the best DC to contact dynamically,
7295 just as all other hosts in an AD domain do. This allows the domain
7296 to be maintained (addition and removal of domain controllers)
7297 without modification to the smb.conf file. The cryptographic
7298 protection on the authenticated RPC calls used to verify passwords
7299 ensures that this default is safe.
7300 It is strongly recommended that you use the default of '*', however
7302 if in your particular environment you have reason to specify a
7303 particular DC list, then the list of machines in this option must
7304 be a list of names or IP addresses of Domain controllers for the
7305 Domain. If you use the default of '*', or list several hosts in the
7306 password server option then smbd will try each in turn till it
7307 finds one that responds. This is useful in case your primary server
7308 goes down.
7309 If the list of servers contains both names/IP's and the '*'
7311 character, the list is treated as a list of preferred domain
7312 controllers, but an auto lookup of all remaining DC's will be added
7313 to the list as well. Samba will not attempt to optimize this list
7314 by locating the closest DC.
7315 If parameter is a name, it is looked up using the parameter name
7317 resolve order and so may resolved by any method and order described
7318 in that parameter.
7319 Default: password server = *
7321 Example: password server = NT-PDC, NT-BDC1, NT-BDC2, *
7323 Example: password server = windc.mydomain.com:389 192.168.1.101 *
7325 directory
7327 This parameter is a synonym for path.
7329 path (S)
7331 This parameter specifies a directory to which the user of the
7333 service is to be given access. In the case of printable services,
7334 this is where print data will spool prior to being submitted to the
7335 host for printing.
7336 For a printable service offering guest access, the service should
7338 be readonly and the path should be world-writeable and have the
7339 sticky bit set. This is not mandatory of course, but you probably
7340 won't get the results you expect if you do otherwise.
7341 Any occurrences of %u in the path will be replaced with the UNIX
7343 username that the client is using on this connection. Any
7344 occurrences of %m will be replaced by the NetBIOS name of the
7345 machine they are connecting from. These replacements are very
7346 useful for setting up pseudo home directories for users.
7347 Note that this path will be based on root dir if one was specified.
7349 Default: path =
7351 Example: path = /home/fred
7353 perfcount module (G)
7355 This parameter specifies the perfcount backend to be used when
7357 monitoring SMB operations. Only one perfcount module may be used,
7358 and it must implement all of the apis contained in the
7359 smb_perfcount_handler structure defined in smb.h.
7360 No default
7362 pid directory (G)
7364 This option specifies the directory where pid files will be placed.
7366 Default: pid directory = /run
7368 Example: pid directory = /var/run/
7370 posix locking (S)
7372 The smbd(8) daemon maintains an database of file locks obtained by
7374 SMB clients. The default behavior is to map this internal database
7375 to POSIX locks. This means that file locks obtained by SMB clients
7376 are consistent with those seen by POSIX compliant applications
7377 accessing the files via a non-SMB method (e.g. NFS or local file
7378 access). It is very unlikely that you need to set this parameter to
7379 "no", unless you are sharing from an NFS mount, which is not a good
7380 idea in the first place.
7381 Default: posix locking = yes
7383 postexec (S)
7385 This option specifies a command to be run whenever the service is
7387 disconnected. It takes the usual substitutions. The command may be
7388 run as the root on some systems.
7389 An interesting example may be to unmount server resources:
7391 postexec = /etc/umount /cdrom
7393 Default: postexec =
7395 Example: postexec = echo \"%u disconnected from %S from %m (%I)\"
7397 >> /tmp/log
7398 exec
7400 This parameter is a synonym for preexec.
7402 preexec (S)
7404 This option specifies a command to be run whenever the service is
7406 connected to. It takes the usual substitutions.
7407 An interesting example is to send the users a welcome message every
7409 time they log in. Maybe a message of the day? Here is an example:
7410 preexec = csh -c 'echo \"Welcome to %S!\" |
7412 /usr/local/samba/bin/smbclient -M %m -I %I' &
7413 Of course, this could get annoying after a while :-)
7415 See also preexec close and postexec.
7417 Default: preexec =
7419 Example: preexec = echo \"%u connected to %S from %m (%I)\" >>
7421 /tmp/log
7422 preexec close (S)
7424 This boolean option controls whether a non-zero return code from
7426 preexec should close the service being connected to.
7427 Default: preexec close = no
7429 prefered master
7431 This parameter is a synonym for preferred master.
7433 preferred master (G)
7435 This boolean parameter controls if nmbd(8) is a preferred master
7437 browser for its workgroup.
7438 If this is set to yes, on startup, nmbd will force an election, and
7440 it will have a slight advantage in winning the election. It is
7441 recommended that this parameter is used in conjunction with domain
7442 master = yes, so that nmbd can guarantee becoming a domain master.
7443 Use this option with caution, because if there are several hosts
7445 (whether Samba servers, Windows 95 or NT) that are preferred master
7446 browsers on the same subnet, they will each periodically and
7447 continuously attempt to become the local master browser. This will
7448 result in unnecessary broadcast traffic and reduced browsing
7449 capabilities.
7450 Default: preferred master = auto
7452 prefork backoff increment (G)
7454 This option specifies the number of seconds added to the delay
7456 before a prefork master or worker process is restarted. The restart
7457 is initially zero, the prefork backoff increment is added to the
7458 delay on each restart up to the value specified by "prefork maximum
7459 backoff".
7460 Additionally set the backoff for an individual service by using
7462 "prefork backoff increment: service name" i.e. "prefork backoff
7463 increment:ldap = 2" to set the backoff increment to 2.
7464 If the backoff increment is 2 and the maximum backoff is 5. There
7466 will be a zero second delay for the first restart. A two second
7467 delay for the second restart. A four second delay for the third and
7468 any subsequent restarts
7469 Default: prefork backoff increment = 10
7471 prefork children (G)
7473 This option controls the number of worker processes that are
7475 started for each service when prefork process model is enabled (see
7476 samba(8) -M) The prefork children are only started for those
7477 services that support prefork (currently ldap, kdc and netlogon).
7478 For processes that don't support preforking all requests are
7479 handled by a single process for that service.
7480 This should be set to a small multiple of the number of CPU's
7482 available on the server
7483 Additionally the number of prefork children can be specified for an
7485 individual service by using "prefork children: service name" i.e.
7486 "prefork children:ldap = 8" to set the number of ldap worker
7487 processes.
7488 Default: prefork children = 4
7490 prefork maximum backoff (G)
7492 This option controls the maximum delay before a failed pre-fork
7494 process is restarted.
7495 Default: prefork maximum backoff = 120
7497 preload modules (G)
7499 This is a list of paths to modules that should be loaded into smbd
7501 before a client connects. This improves the speed of smbd when
7502 reacting to new connections somewhat.
7503 Default: preload modules =
7505 Example: preload modules = /usr/lib/samba/passdb/mysql.so
7507 preserve case (S)
7509 This controls if new filenames are created with the case that the
7511 client passes, or if they are forced to be the default case.
7512 See the section on NAME MANGLING for a fuller discussion.
7514 Default: preserve case = yes
7516 print ok
7518 This parameter is a synonym for printable.
7520 printable (S)
7522 If this parameter is yes, then clients may open, write to and
7524 submit spool files on the directory specified for the service.
7525 Note that a printable service will ALWAYS allow writing to the
7527 service path (user privileges permitting) via the spooling of print
7528 data. The read only parameter controls only non-printing access to
7529 the resource.
7530 Default: printable = no
7532 printcap cache time (G)
7534 This option specifies the number of seconds before the printing
7536 subsystem is again asked for the known printers.
7537 Setting this parameter to 0 disables any rescanning for new or
7539 removed printers after the initial startup.
7540 Default: printcap cache time = 750
7542 Example: printcap cache time = 600
7544 printcap
7546 This parameter is a synonym for printcap name.
7548 printcap name (G)
7550 This parameter may be used to override the compiled-in default
7552 printcap name used by the server (usually /etc/printcap). See the
7553 discussion of the [printers] section above for reasons why you
7554 might want to do this.
7555 To use the CUPS printing interface set printcap name = cups. This
7557 should be supplemented by an additional setting printing = cups in
7558 the [global] section. printcap name = cups will use the "dummy"
7559 printcap created by CUPS, as specified in your CUPS configuration
7560 file.
7561 On System V systems that use lpstat to list available printers you
7563 can use printcap name = lpstat to automatically obtain lists of
7564 available printers. This is the default for systems that define
7565 SYSV at configure time in Samba (this includes most System V based
7566 systems). If
7567 printcap name is set to lpstat on these systems then Samba will
7568 launch lpstat -v and attempt to parse the output to obtain a
7569 printer list.
7570 A minimal printcap file would look something like this:
7572 print1|My Printer 1
7574 print2|My Printer 2
7575 print3|My Printer 3
7576 print4|My Printer 4
7577 print5|My Printer 5
7578 where the '|' separates aliases of a printer. The fact that the
7580 second alias has a space in it gives a hint to Samba that it's a
7581 comment.
7582 Note
7584 Under AIX the default printcap name is /etc/qconfig. Samba will
7585 assume the file is in AIX qconfig format if the string qconfig
7586 appears in the printcap filename.
7587 Default: printcap name = /etc/printcap
7588 Example: printcap name = /etc/myprintcap
7590 print command (S)
7592 After a print job has finished spooling to a service, this command
7594 will be used via a system() call to process the spool file.
7595 Typically the command specified will submit the spool file to the
7596 host's printing subsystem, but there is no requirement that this be
7597 the case. The server will not remove the spool file, so whatever
7598 command you specify should remove the spool file when it has been
7599 processed, otherwise you will need to manually remove old spool
7600 files.
7601 The print command is simply a text string. It will be used verbatim
7603 after macro substitutions have been made:
7604 %s, %f - the path to the spool file name
7606 %p - the appropriate printer name
7608 %J - the job name as transmitted by the client.
7610 %c - The number of printed pages of the spooled job (if known).
7612 %z - the size of the spooled print job (in bytes)
7614 The print command MUST contain at least one occurrence of %s or %f
7616 - the %p is optional. At the time a job is submitted, if no printer
7617 name is supplied the %p will be silently removed from the printer
7618 command.
7619 If specified in the [global] section, the print command given will
7621 be used for any printable service that does not have its own print
7622 command specified.
7623 If there is neither a specified print command for a printable
7625 service nor a global print command, spool files will be created but
7626 not processed and (most importantly) not removed.
7627 Note that printing may fail on some UNIXes from the nobody account.
7629 If this happens then create an alternative guest account that can
7630 print and set the guest account in the [global] section.
7631 You can form quite complex print commands by realizing that they
7633 are just passed to a shell. For example the following will log a
7634 print job, print the file, then remove it. Note that ';' is the
7635 usual separator for command in shell scripts.
7636 print command = echo Printing %s >> /tmp/print.log; lpr -P %p %s;
7638 rm %s
7639 You may have to vary this command considerably depending on how you
7641 normally print files on your system. The default for the parameter
7642 varies depending on the setting of the printing parameter.
7643 Default: For printing = BSD, AIX, QNX, LPRNG or PLP :
7645 print command = lpr -r -P%p %s
7647 For printing = SYSV or HPUX :
7649 print command = lp -c -d%p %s; rm %s
7651 For printing = SOFTQ :
7653 print command = lp -d%p -s %s; rm %s
7655 For printing = CUPS : If SAMBA is compiled against libcups, then
7657 printcap = cups uses the CUPS API to submit jobs, etc. Otherwise it
7658 maps to the System V commands with the -oraw option for printing,
7659 i.e. it uses lp -c -d%p -oraw; rm %s. With printing = cups, and if
7660 SAMBA is compiled against libcups, any manually set print command
7661 will be ignored.
7662 No default
7664 Example: print command = /usr/local/samba/bin/myprintscript %p %s
7666 printer
7668 This parameter is a synonym for printer name.
7670 printer name (S)
7672 This parameter specifies the name of the printer to which print
7674 jobs spooled through a printable service will be sent.
7675 If specified in the [global] section, the printer name given will
7677 be used for any printable service that does not have its own
7678 printer name specified.
7679 The default value of the printer name may be lp on many systems.
7681 Default: printer name =
7683 Example: printer name = laserwriter
7685 printing (S)
7687 This parameters controls how printer status information is
7689 interpreted on your system. It also affects the default values for
7690 the print command, lpq command, lppause command , lpresume command,
7691 and lprm command if specified in the [global] section.
7692 Currently nine printing styles are supported. They are BSD, AIX,
7694 LPRNG, PLP, SYSV, HPUX, QNX, SOFTQ, CUPS and IPRINT.
7695 Be aware that CUPS and IPRINT are only available if the CUPS
7697 development library was available at the time Samba was compiled or
7698 packaged.
7699 To see what the defaults are for the other print commands when
7701 using the various options use the testparm(1) program.
7702 This option can be set on a per printer basis. Please be aware
7704 however, that you must place any of the various printing commands
7705 (e.g. print command, lpq command, etc...) after defining the value
7706 for the printing option since it will reset the printing commands
7707 to default values.
7708 See also the discussion in the [printers] section.
7710 See testparm -v. for the default value on your system
7712 Default: printing = # Depends on the operating system
7714 printjob username (S)
7716 This parameter specifies which user information will be passed to
7718 the printing system. Usually, the username is sent, but in some
7719 cases, e.g. the domain prefix is useful, too.
7720 Default: printjob username = %U
7722 Example: printjob username = %D\%U
7724 print notify backchannel (S)
7726 Windows print clients can update print queue status by expecting
7728 the server to open a backchannel SMB connection to them. Due to
7729 client firewall settings this can cause considerable timeouts and
7730 will often fail, as there is no guarantee the client is even
7731 running an SMB server. By default, the Samba print server will not
7732 try to connect back to clients, and will treat corresponding
7733 requests as if the connection back to the client failed.
7734 Default: print notify backchannel = no
7736 private directory
7738 This parameter is a synonym for private dir.
7740 private dir (G)
7742 This parameters defines the directory smbd will use for storing
7744 such files as smbpasswd and secrets.tdb.
7745 Default: private dir = /var/lib/samba/private
7747 queuepause command (S)
7749 This parameter specifies the command to be executed on the server
7751 host in order to pause the printer queue.
7752 This command should be a program or script which takes a printer
7754 name as its only parameter and stops the printer queue, such that
7755 no longer jobs are submitted to the printer.
7756 This command is not supported by Windows for Workgroups, but can be
7758 issued from the Printers window under Windows 95 and NT.
7759 If a %p is given then the printer name is put in its place.
7761 Otherwise it is placed at the end of the command.
7762 Note that it is good practice to include the absolute path in the
7764 command as the PATH may not be available to the server.
7765 Default: queuepause command = # determined by printing parameter
7767 Example: queuepause command = disable %p
7769 queueresume command (S)
7771 This parameter specifies the command to be executed on the server
7773 host in order to resume the printer queue. It is the command to
7774 undo the behavior that is caused by the previous parameter
7775 (queuepause command).
7776 This command should be a program or script which takes a printer
7778 name as its only parameter and resumes the printer queue, such that
7779 queued jobs are resubmitted to the printer.
7780 This command is not supported by Windows for Workgroups, but can be
7782 issued from the Printers window under Windows 95 and NT.
7783 If a %p is given then the printer name is put in its place.
7785 Otherwise it is placed at the end of the command.
7786 Note that it is good practice to include the absolute path in the
7788 command as the PATH may not be available to the server.
7789 Default: queueresume command = # determined by printing parameter
7791 Example: queueresume command = enable %p
7793 raw NTLMv2 auth (G)
7795 This parameter has been deprecated since Samba 4.13 and support for
7797 NTLMv2 authentication without NTLMSSP will be removed in a future
7798 Samba release.
7799 That is, in the future, the current default of raw NTLMv2 auth = no
7801 will be the enforced behaviour.
7802 This parameter determines whether or not smbd(8) will allow SMB1
7804 clients without extended security (without SPNEGO) to use NTLMv2
7805 authentication.
7806 If this option, lanman auth and ntlm auth are all disabled, then
7808 only clients with SPNEGO support will be permitted. That means
7809 NTLMv2 is only supported within NTLMSSP.
7810 Default: raw NTLMv2 auth = no
7812 read list (S)
7814 This is a list of users that are given read-only access to a
7816 service. If the connecting user is in this list then they will not
7817 be given write access, no matter what the read only option is set
7818 to. The list can include group names using the syntax described in
7819 the invalid users parameter.
7820 Default: read list =
7822 Example: read list = mary, @students
7824 read only (S)
7826 An inverted synonym is writeable.
7828 If this parameter is yes, then users of a service may not create or
7830 modify files in the service's directory.
7831 Note that a printable service (printable = yes) will ALWAYS allow
7833 writing to the directory (user privileges permitting), but only via
7834 spooling operations.
7835 Default: read only = yes
7837 read raw (G)
7839 This is ignored if async smb echo handler is set, because this
7841 feature is incompatible with raw read SMB requests
7842 If enabled, raw reads allow reads of 65535 bytes in one packet.
7844 This typically provides a major performance benefit for some very,
7845 very old clients.
7846 However, some clients either negotiate the allowable block size
7848 incorrectly or are incapable of supporting larger block sizes, and
7849 for these clients you may need to disable raw reads.
7850 In general this parameter should be viewed as a system tuning tool
7852 and left severely alone.
7853 Default: read raw = yes
7855 realm (G)
7857 This option specifies the kerberos realm to use. The realm is used
7859 as the ADS equivalent of the NT4 domain. It is usually set to the
7860 DNS name of the kerberos server.
7861 Default: realm =
7863 Example: realm = mysambabox.mycompany.com
7865 registry shares (G)
7867 This turns on or off support for share definitions read from
7869 registry. Shares defined in smb.conf take precedence over shares
7870 with the same name defined in registry. See the section on
7871 registry-based configuration for details.
7872 Note that this parameter defaults to no, but it is set to yes when
7874 config backend is set to registry.
7875 Default: registry shares = no
7877 Example: registry shares = yes
7879 reject md5 clients (G)
7881 This option is deprecated and will be removed in a future release,
7883 as it is a security problem if not set to "yes" (which will be the
7884 hardcoded behavior in the future).
7885 This option controls whether the netlogon server (currently only in
7887 'active directory domain controller' mode), will reject clients
7888 which does not support NETLOGON_NEG_SUPPORTS_AES.
7889 Support for NETLOGON_NEG_SUPPORTS_AES was added in Windows starting
7891 with Server 2008R2 and Windows 7, it's available in Samba starting
7892 with 4.0, however third party domain members like NetApp ONTAP
7893 still uses RC4 (HMAC-MD5), see
7894 https://www.samba.org/samba/security/CVE-2022-38023.html for more
7895 details.
7896 The default changed from 'no' to 'yes', with the patches for
7898 CVE-2022-38023 see
7899 https://bugzilla.samba.org/show_bug.cgi?id=15240.
7900 Avoid using this option! Use an explicit per machine account
7902 'server reject md5 schannel:COMPUTERACCOUNT' instead! Which is
7903 available with the patches for CVE-2022-38023 see
7904 https://bugzilla.samba.org/show_bug.cgi?id=15240.
7905 Samba will log an error in the log files at log level 0 if legacy a
7907 client is rejected or allowed without an explicit, 'server reject
7908 md5 schannel:COMPUTERACCOUNT = no' option for the client. The
7909 message will indicate the explicit 'server reject md5
7910 schannel:COMPUTERACCOUNT = no' line to be added, if the legacy
7911 client software requires it. (The log level can be adjusted with
7912 'CVE_2022_38023:error_debug_level = 1' in order to complain only at
7913 a higher log level).
7914 This allows admins to use "no" only for a short grace period, in
7916 order to collect the explicit 'server reject md5
7917 schannel:COMPUTERACCOUNT = no' options.
7918 When set to 'yes' this option overrides the 'allow nt4
7920 crypto:COMPUTERACCOUNT' and 'allow nt4 crypto' options and implies
7921 'allow nt4 crypto:COMPUTERACCOUNT = no'.
7922 Default: reject md5 clients = yes
7924 server reject md5 schannel:COMPUTERACCOUNT (G)
7926 If you still have legacy domain members or trusted domains, which
7928 required "reject md5 clients = no" before, it is possible to
7929 specify an explicit exception per computer account by setting
7930 'server reject md5 schannel:COMPUTERACCOUNT = no'. Note that
7931 COMPUTERACCOUNT has to be the sAMAccountName value of the computer
7932 account (including the trailing '$' sign).
7933 Samba will log a complaint in the log files at log level 0 about
7935 the security problem if the option is set to "no", but the related
7936 computer does not require it. (The log level can be adjusted with
7937 'CVE_2022_38023:warn_about_unused_debug_level = 1' in order to
7938 complain only at a higher log level).
7939 Samba will log a warning in the log files at log level 5 if a
7941 setting is still needed for the specified computer account.
7942 See CVE-2022-38023,
7944 https://bugzilla.samba.org/show_bug.cgi?id=15240.
7945 This option overrides the reject md5 clients option.
7947 When set to 'yes' this option overrides the 'allow nt4
7949 crypto:COMPUTERACCOUNT' and 'allow nt4 crypto' options and implies
7950 'allow nt4 crypto:COMPUTERACCOUNT = no'.
7951 server reject md5 schannel:LEGACYCOMPUTER1$ = no
7953 server reject md5 schannel:NASBOX$ = no
7954 server reject md5 schannel:LEGACYCOMPUTER2$ = no
7955 No default
7958 reject md5 servers (G)
7960 This option controls whether winbindd requires support for aes
7962 support for the netlogon secure channel.
7963 The following flags will be required NETLOGON_NEG_ARCFOUR,
7965 NETLOGON_NEG_SUPPORTS_AES, NETLOGON_NEG_PASSWORD_SET2 and
7966 NETLOGON_NEG_AUTHENTICATED_RPC.
7967 You can set this to yes if all domain controllers support aes. This
7969 will prevent downgrade attacks.
7970 The behavior can be controlled per netbios domain by using 'reject
7972 md5 servers:NETBIOSDOMAIN = no' as option.
7973 The default changed from 'no' to 'yes, with the patches for
7975 CVE-2022-38023, see
7976 https://bugzilla.samba.org/show_bug.cgi?id=15240
7977 This option overrides the require strong key option.
7979 Default: reject md5 servers = yes
7981 remote announce (G)
7983 This option allows you to setup nmbd(8) to periodically announce
7985 itself to arbitrary IP addresses with an arbitrary workgroup name.
7986 This is useful if you want your Samba server to appear in a remote
7988 workgroup for which the normal browse propagation rules don't work.
7989 The remote workgroup can be anywhere that you can send IP packets
7990 to.
7991 For example:
7993 remote announce = 192.168.2.255/SERVERS 192.168.4.255/STAFF
7995 the above line would cause nmbd to announce itself to the two given
7997 IP addresses using the given workgroup names. If you leave out the
7998 workgroup name, then the one given in the workgroup parameter is
7999 used instead.
8000 The IP addresses you choose would normally be the broadcast
8002 addresses of the remote networks, but can also be the IP addresses
8003 of known browse masters if your network config is that stable.
8004 See the chapter on Network Browsing in the Samba-HOWTO book.
8006 Default: remote announce =
8008 remote browse sync (G)
8010 This option allows you to setup nmbd(8) to periodically request
8012 synchronization of browse lists with the master browser of a Samba
8013 server that is on a remote segment. This option will allow you to
8014 gain browse lists for multiple workgroups across routed networks.
8015 This is done in a manner that does not work with any non-Samba
8016 servers.
8017 This is useful if you want your Samba server and all local clients
8019 to appear in a remote workgroup for which the normal browse
8020 propagation rules don't work. The remote workgroup can be anywhere
8021 that you can send IP packets to.
8022 For example:
8024 remote browse sync = 192.168.2.255 192.168.4.255
8026 the above line would cause nmbd to request the master browser on
8028 the specified subnets or addresses to synchronize their browse
8029 lists with the local server.
8030 The IP addresses you choose would normally be the broadcast
8032 addresses of the remote networks, but can also be the IP addresses
8033 of known browse masters if your network config is that stable. If a
8034 machine IP address is given Samba makes NO attempt to validate that
8035 the remote machine is available, is listening, nor that it is in
8036 fact the browse master on its segment.
8037 The remote browse sync may be used on networks where there is no
8039 WINS server, and may be used on disjoint networks where each
8040 network has its own WINS server.
8041 Default: remote browse sync =
8043 rename user script (G)
8045 This is the full pathname to a script that will be run as root by
8047 smbd(8) under special circumstances described below.
8048 When a user with admin authority or SeAddUserPrivilege rights
8050 renames a user (e.g.: from the NT4 User Manager for Domains), this
8051 script will be run to rename the POSIX user. Two variables, %uold
8052 and %unew, will be substituted with the old and new usernames,
8053 respectively. The script should return 0 upon successful
8054 completion, and nonzero otherwise.
8055 Note
8057 The script has all responsibility to rename all the necessary
8058 data that is accessible in this posix method. This can mean
8059 different requirements for different backends. The tdbsam and
8060 smbpasswd backends will take care of the contents of their
8061 respective files, so the script is responsible only for
8062 changing the POSIX username, and other data that may required
8063 for your circumstances, such as home directory. Please also
8064 consider whether or not you need to rename the actual home
8065 directories themselves. The ldapsam backend will not make any
8066 changes, because of the potential issues with renaming the LDAP
8067 naming attribute. In this case the script is responsible for
8068 changing the attribute that samba uses (uid) for locating
8069 users, as well as any data that needs to change for other
8070 applications using the same directory.
8071 Default: rename user script =
8072 require strong key (G)
8074 This option controls whether winbindd requires support for md5
8076 strong key support for the netlogon secure channel.
8077 The following flags will be required NETLOGON_NEG_STRONG_KEYS,
8079 NETLOGON_NEG_ARCFOUR and NETLOGON_NEG_AUTHENTICATED_RPC.
8080 You can set this to no if some domain controllers only support des.
8082 This might allows weak crypto to be negotiated, may via downgrade
8083 attacks.
8084 The behavior can be controlled per netbios domain by using 'require
8086 strong key:NETBIOSDOMAIN = no' as option.
8087 Note for active directory domain this option is hardcoded to 'yes'
8089 This option is over-ridden by the reject md5 servers option.
8091 This option overrides the client schannel option.
8093 Default: require strong key = yes
8095 reset on zero vc (G)
8097 This boolean option controls whether an incoming SMB1 session setup
8099 should kill other connections coming from the same IP. This matches
8100 the default Windows 2003 behaviour. Setting this parameter to yes
8101 becomes necessary when you have a flaky network and windows decides
8102 to reconnect while the old connection still has files with share
8103 modes open. These files become inaccessible over the new
8104 connection. The client sends a zero VC on the new connection, and
8105 Windows 2003 kills all other connections coming from the same IP.
8106 This way the locked files are accessible again. Please be aware
8107 that enabling this option will kill connections behind a
8108 masquerading router, and will not trigger for clients that only use
8109 SMB2 or SMB3.
8110 Default: reset on zero vc = no
8112 restrict anonymous (G)
8114 The setting of this parameter determines whether SAMR and LSA
8116 DCERPC services can be accessed anonymously. This corresponds to
8117 the following Windows Server registry options:
8118 HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Lsa\RestrictAnonymous
8120 The option also affects the browse option which is required by
8123 legacy clients which rely on Netbios browsing. While modern Windows
8124 version should be fine with restricting the access there could
8125 still be applications relying on anonymous access.
8126 Setting restrict anonymous = 1 will disable anonymous SAMR access.
8128 Setting restrict anonymous = 2 will, in addition to restricting
8130 SAMR access, disallow anonymous connections to the IPC$ share in
8131 general. Setting guest ok = yes on any share will remove the
8132 security advantage.
8133 Default: restrict anonymous = 0
8135 root
8137 This parameter is a synonym for root directory.
8139 root dir
8141 This parameter is a synonym for root directory.
8143 root directory (G)
8145 The server will chroot() (i.e. Change its root directory) to this
8147 directory on startup. This is not strictly necessary for secure
8148 operation. Even without it the server will deny access to files not
8149 in one of the service entries. It may also check for, and deny
8150 access to, soft links to other parts of the filesystem, or attempts
8151 to use ".." in file names to access other directories (depending on
8152 the setting of the wide links parameter).
8153 Adding a root directory entry other than "/" adds an extra level of
8155 security, but at a price. It absolutely ensures that no access is
8156 given to files not in the sub-tree specified in the root directory
8157 option, including some files needed for complete operation of the
8158 server. To maintain full operability of the server you will need to
8159 mirror some system files into the root directory tree. In
8160 particular you will need to mirror /etc/passwd (or a subset of it),
8161 and any binaries or configuration files needed for printing (if
8162 required). The set of files that must be mirrored is operating
8163 system dependent.
8164 Default: root directory =
8166 Example: root directory = /homes/smb
8168 root postexec (S)
8170 This is the same as the postexec parameter except that the command
8172 is run as root. This is useful for unmounting filesystems (such as
8173 CDROMs) after a connection is closed.
8174 Default: root postexec =
8176 root preexec (S)
8178 This is the same as the preexec parameter except that the command
8180 is run as root. This is useful for mounting filesystems (such as
8181 CDROMs) when a connection is opened.
8182 Default: root preexec =
8184 root preexec close (S)
8186 This is the same as the preexec close parameter except that the
8188 command is run as root.
8189 Default: root preexec close = no
8191 rpc big endian (G)
8193 Setting this option will force the RPC client and server to
8195 transfer data in big endian.
8196 If it is disabled, data will be transferred in little endian.
8198 The behaviour is independent of the endianness of the host machine.
8200 Default: rpc big endian = no
8202 rpc server dynamic port range (G)
8204 This parameter tells the RPC server which port range it is allowed
8206 to use to create a listening socket for LSA, SAM, Netlogon and
8207 others without wellknown tcp ports. The first value is the lowest
8208 number of the port range and the second the highest.
8209 This applies to RPC servers in all server roles.
8211 Default: rpc server dynamic port range = 49152-65535
8213 rpc server port (G)
8215 Specifies which port the server should listen on for DCE/RPC over
8217 TCP/IP traffic.
8218 This controls the default port for all protocols, except for
8220 NETLOGON.
8221 If unset, the first available port from rpc server dynamic port
8223 range is used, e.g. 49152.
8224 The NETLOGON server will use the next available port, e.g. 49153.
8226 To change this port use (eg) rpc server port:netlogon = 4000.
8227 Furthermore, all RPC servers can have the port they use specified
8229 independenty, with (for example) rpc server port:drsuapi = 5000.
8230 This option applies currently only when samba(8) runs as an active
8232 directory domain controller.
8233 The default value 0 causes Samba to select the first available port
8235 from rpc server dynamic port range.
8236 Default: rpc server port = 0
8238 rpc start on demand helpers (G)
8240 This global parameter determines if samba-dcerpcd should be started
8242 on demand to service named pipe (np) DCE-RPC requests from smbd or
8243 winbindd. This is the normal case where no startup scripts have
8244 been modified to start samba-dcerpcd as a daemon.
8245 If samba-dcerpcd is started as a daemon or via a system service
8247 manager such as systemd, this parameter MUST be set to "no",
8248 otherwise samba-dcerpcd will fail to start.
8249 Default: rpc start on demand helpers = yes
8251 samba kcc command (G)
8253 This option specifies the path to the Samba KCC command. This
8255 script is used for replication topology replication.
8256 It should not be necessary to modify this option except for testing
8258 purposes or if the samba_kcc was installed in a non-default
8259 location.
8260 Default: samba kcc command =
8262 /builddir/build/BUILD/samba-4.19.3/source4/scripting/bin/samba_kcc
8263 Example: samba kcc command = /usr/local/bin/kcc
8265 security (G)
8267 This option affects how clients respond to Samba and is one of the
8269 most important settings in the smb.conf file.
8270 Unless server role is specified, the default is security = user, as
8272 this is the most common setting, used for a standalone file server
8273 or a DC.
8274 The alternatives to security = user are security = ads or security
8276 = domain, which support joining Samba to a Windows domain
8277 You should use security = user and map to guest if you want to
8279 mainly setup shares without a password (guest shares). This is
8280 commonly used for a shared printer server.
8281 The different settings will now be explained.
8283 SECURITY = AUTO
8285 This is the default security setting in Samba, and causes Samba to
8287 consult the server role parameter (if set) to determine the
8288 security mode.
8289 SECURITY = USER
8291 If server role is not specified, this is the default security
8293 setting in Samba. With user-level security a client must first
8294 "log-on" with a valid username and password (which can be mapped
8295 using the username map parameter). Encrypted passwords (see the
8296 encrypt passwords parameter) can also be used in this security
8297 mode. Parameters such as force user and guest only if set are then
8298 applied and may change the UNIX user to use on this connection, but
8299 only after the user has been successfully authenticated.
8300 Note that the name of the resource being requested is not sent to
8302 the server until after the server has successfully authenticated
8303 the client. This is why guest shares don't work in user level
8304 security without allowing the server to automatically map unknown
8305 users into the guest account. See the map to guest parameter for
8306 details on doing this.
8307 SECURITY = DOMAIN
8309 This mode will only work correctly if net(8) has been used to add
8311 this machine into a Windows NT Domain. It expects the encrypt
8312 passwords parameter to be set to yes. In this mode Samba will try
8313 to validate the username/password by passing it to a Windows NT
8314 Primary or Backup Domain Controller, in exactly the same way that a
8315 Windows NT Server would do.
8316 Note that a valid UNIX user must still exist as well as the account
8318 on the Domain Controller to allow Samba to have a valid UNIX
8319 account to map file access to.
8320 Note that from the client's point of view security = domain is the
8322 same as security = user. It only affects how the server deals with
8323 the authentication, it does not in any way affect what the client
8324 sees.
8325 Note that the name of the resource being requested is not sent to
8327 the server until after the server has successfully authenticated
8328 the client. This is why guest shares don't work in user level
8329 security without allowing the server to automatically map unknown
8330 users into the guest account. See the map to guest parameter for
8331 details on doing this.
8332 See also the password server parameter and the encrypt passwords
8334 parameter.
8335 SECURITY = ADS
8337 In this mode, Samba will act as a domain member in an ADS realm. To
8339 operate in this mode, the machine running Samba will need to have
8340 Kerberos installed and configured and Samba will need to be joined
8341 to the ADS realm using the net utility.
8342 Note that this mode does NOT make Samba operate as a Active
8344 Directory Domain Controller.
8345 Note that this forces require strong key = yes and client schannel
8347 = yes for the primary domain.
8348 Read the chapter about Domain Membership in the HOWTO for details.
8350 Default: security = AUTO
8352 Example: security = DOMAIN
8354 security mask (S)
8356 This parameter has been removed for Samba 4.0.0.
8358 No default
8360 server addresses (S)
8362 This is a per-share parameter to limit share visibility and
8364 accessibility to specific server IP addresses. Multi-homed servers
8365 can offer a different set of shares per interface.
8366 An empty list means to offer a share on all interfaces.
8368 Default: server addresses =
8370 max protocol
8372 This parameter is a synonym for server max protocol.
8374 protocol
8376 This parameter is a synonym for server max protocol.
8378 server max protocol (G)
8380 The value of the parameter (a string) is the highest protocol level
8382 that will be supported by the server.
8383 Possible values are :
8385 • LANMAN1: First modern version of the protocol. Long
8387 filename support.
8388 • LANMAN2: Updates to Lanman1 protocol.
8390 • NT1: Current up to date version of the protocol. Used by
8392 Windows NT. Known as CIFS.
8393 • SMB2: Re-implementation of the SMB protocol. Used by
8395 Windows Vista and later versions of Windows. SMB2 has
8396 sub protocols available.
8397 • SMB2_02: The earliest SMB2 version.
8399 • SMB2_10: Windows 7 SMB2 version.
8401 By default SMB2 selects the SMB2_10 variant.
8403 • SMB3: The same as SMB2. Used by Windows 8. SMB3 has sub
8405 protocols available.
8406 • SMB3_00: Windows 8 SMB3 version.
8408 • SMB3_02: Windows 8.1 SMB3 version.
8410 • SMB3_11: Windows 10 SMB3 version.
8412 By default SMB3 selects the SMB3_11 variant.
8414 Normally this option should not be set as the automatic negotiation
8416 phase in the SMB protocol takes care of choosing the appropriate
8417 protocol.
8418 Default: server max protocol = SMB3
8420 Example: server max protocol = LANMAN1
8422 min protocol
8424 This parameter is a synonym for server min protocol.
8426 server min protocol (G)
8428 This setting controls the minimum protocol version that the server
8430 will allow the client to use.
8431 Normally this option should not be set as the automatic negotiation
8433 phase in the SMB protocol takes care of choosing the appropriate
8434 protocol unless you have legacy clients which are SMB1 capable
8435 only.
8436 See Related command: server max protocol for a full list of
8438 available protocols.
8439 Default: server min protocol = SMB2_02
8441 Example: server min protocol = NT1
8443 server multi channel support (G)
8445 This boolean parameter controls whether smbd(8) will support SMB3
8447 multi-channel.
8448 This parameter was added with version 4.4.
8450 Note that this feature was still considered experimental up to
8452 4.14.
8453 Due to dependencies to kernel APIs of Linux or FreeBSD, it's only
8455 possible to use this feature on Linux and FreeBSD for now. For
8456 testing this restriction can be overwritten by specifying
8457 force:server multi channel support=yes in addition.
8458 This option is enabled by default starting with to 4.15 (on Linux
8460 and FreeBSD).
8461 Default: server multi channel support = yes
8463 server role (G)
8465 This option determines the basic operating mode of a Samba server
8467 and is one of the most important settings in the smb.conf file.
8468 The default is server role = auto, as causes Samba to operate
8470 according to the security setting, or if not specified as a simple
8471 file server that is not connected to any domain.
8472 The alternatives are server role = standalone or server role =
8474 member server, which support joining Samba to a Windows domain,
8475 along with server role = domain controller, which run Samba as a
8476 Windows domain controller.
8477 You should use server role = standalone and map to guest if you
8479 want to mainly setup shares without a password (guest shares). This
8480 is commonly used for a shared printer server.
8481 SERVER ROLE = AUTO
8483 This is the default server role in Samba, and causes Samba to
8485 consult the security parameter (if set) to determine the server
8486 role, giving compatible behaviours to previous Samba versions.
8487 SERVER ROLE = STANDALONE
8489 If security is also not specified, this is the default security
8491 setting in Samba. In standalone operation, a client must first
8492 "log-on" with a valid username and password (which can be mapped
8493 using the username map parameter) stored on this machine. Encrypted
8494 passwords (see the encrypt passwords parameter) are by default used
8495 in this security mode. Parameters such as force user and guest only
8496 if set are then applied and may change the UNIX user to use on this
8497 connection, but only after the user has been successfully
8498 authenticated.
8499 SERVER ROLE = MEMBER SERVER
8501 This mode will only work correctly if net(8) has been used to add
8503 this machine into a Windows Domain. It expects the encrypt
8504 passwords parameter to be set to yes. In this mode Samba will try
8505 to validate the username/password by passing it to a Windows or
8506 Samba Domain Controller, in exactly the same way that a Windows
8507 Server would do.
8508 Note that a valid UNIX user must still exist as well as the account
8510 on the Domain Controller to allow Samba to have a valid UNIX
8511 account to map file access to. Winbind can provide this.
8512 SERVER ROLE = CLASSIC PRIMARY DOMAIN CONTROLLER
8514 This mode of operation runs a classic Samba primary domain
8516 controller, providing domain logon services to Windows and Samba
8517 clients of an NT4-like domain. Clients must be joined to the domain
8518 to create a secure, trusted path across the network. There must be
8519 only one PDC per NetBIOS scope (typically a broadcast network or
8520 clients served by a single WINS server).
8521 SERVER ROLE = CLASSIC BACKUP DOMAIN CONTROLLER
8523 This mode of operation runs a classic Samba backup domain
8525 controller, providing domain logon services to Windows and Samba
8526 clients of an NT4-like domain. As a BDC, this allows multiple Samba
8527 servers to provide redundant logon services to a single NetBIOS
8528 scope.
8529 SERVER ROLE = ACTIVE DIRECTORY DOMAIN CONTROLLER
8531 This mode of operation runs Samba as an active directory domain
8533 controller, providing domain logon services to Windows and Samba
8534 clients of the domain. This role requires special configuration,
8535 see the Samba4 HOWTO
8536 SERVER ROLE = IPA DOMAIN CONTROLLER
8538 This mode of operation runs Samba in a hybrid mode for IPA domain
8540 controller, providing forest trust to Active Directory. This role
8541 requires special configuration performed by IPA installers and
8542 should not be used manually by any administrator.
8543 Default: server role = AUTO
8545 Example: server role = ACTIVE DIRECTORY DOMAIN CONTROLLER
8547 server schannel (G)
8549 This option is deprecated and will be removed in future, as it is a
8551 security problem if not set to "yes" (which will be the hardcoded
8552 behavior in future).
8553 Avoid using this option! Use explicit 'server require
8555 schannel:COMPUTERACCOUNT = no' instead!
8556 Samba will log an error in the log files at log level 0 if legacy a
8558 client is rejected or allowed without an explicit, 'server require
8559 schannel:COMPUTERACCOUNT = no' option for the client. The message
8560 will indicate the explicit 'server require schannel:COMPUTERACCOUNT
8561 = no' line to be added, if the legacy client software requires it.
8562 (The log level can be adjusted with
8563 'CVE_2020_1472:error_debug_level = 1' in order to complain only at
8564 a higher log level).
8565 This allows admins to use "auto" only for a short grace period, in
8567 order to collect the explicit 'server require
8568 schannel:COMPUTERACCOUNT = no' options.
8569 See CVE-2020-1472(ZeroLogon),
8571 https://bugzilla.samba.org/show_bug.cgi?id=14497.
8572 This option is over-ridden by the server require
8574 schannel:COMPUTERACCOUNT option.
8575 This option is over-ridden by the effective value of 'yes' from the
8577 'server schannel require seal:COMPUTERACCOUNT' and/or 'server
8578 schannel require seal' options.
8579 Default: server schannel = yes
8581 server require schannel:COMPUTERACCOUNT (G)
8583 If you still have legacy domain members, which required "server
8585 schannel = auto" before, it is possible to specify explicit
8586 exception per computer account by using 'server require
8587 schannel:COMPUTERACCOUNT = no' as option. Note that COMPUTERACCOUNT
8588 has to be the sAMAccountName value of the computer account
8589 (including the trailing '$' sign).
8590 Samba will complain in the log files at log level 0, about the
8592 security problem if the option is not set to "no", but the related
8593 computer is actually using the netlogon secure channel (schannel)
8594 feature. (The log level can be adjusted with
8595 'CVE_2020_1472:warn_about_unused_debug_level = 1' in order to
8596 complain only at a higher log level).
8597 Samba will warn in the log files at log level 5, if a setting is
8599 still needed for the specified computer account.
8600 See CVE-2020-1472(ZeroLogon),
8602 https://bugzilla.samba.org/show_bug.cgi?id=14497.
8603 This option overrides the server schannel option.
8605 This option is over-ridden by the effective value of 'yes' from the
8607 'server schannel require seal:COMPUTERACCOUNT' and/or 'server
8608 schannel require seal' options.
8609 Which means 'server require schannel:COMPUTERACCOUNT = no' is only
8611 useful in combination with 'server schannel require
8612 seal:COMPUTERACCOUNT = no'
8613 server require schannel:LEGACYCOMPUTER1$ = no
8615 server require schannel seal:LEGACYCOMPUTER1$ = no
8616 server require schannel:NASBOX$ = no
8617 server require schannel seal:NASBOX$ = no
8618 server require schannel:LEGACYCOMPUTER2$ = no
8619 server require schannel seal:LEGACYCOMPUTER2$ = no
8620 No default
8623 server schannel require seal (G)
8625 This option is deprecated and will be removed in future, as it is a
8627 security problem if not set to "yes" (which will be the hardcoded
8628 behavior in future).
8629 This option controls whether the netlogon server, will reject the
8631 usage of netlogon secure channel without privacy/enryption.
8632 The option is modelled after the registry key available on Windows.
8634 HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Netlogon\Parameters\RequireSeal=2
8636 Avoid using this option! Use the per computer account specific
8639 option 'server schannel require seal:COMPUTERACCOUNT' instead!
8640 Which is available with the patches for CVE-2022-38023 see
8641 https://bugzilla.samba.org/show_bug.cgi?id=15240.
8642 Samba will log an error in the log files at log level 0 if legacy a
8644 client is rejected or allowed without an explicit, 'server schannel
8645 require seal:COMPUTERACCOUNT = no' option for the client. The
8646 message will indicate the explicit 'server schannel require
8647 seal:COMPUTERACCOUNT = no' line to be added, if the legacy client
8648 software requires it. (The log level can be adjusted with
8649 'CVE_2022_38023:error_debug_level = 1' in order to complain only at
8650 a higher log level).
8651 This allows admins to use "no" only for a short grace period, in
8653 order to collect the explicit 'server schannel require
8654 seal:COMPUTERACCOUNT = no' options.
8655 When set to 'yes' this option overrides the 'server require
8657 schannel:COMPUTERACCOUNT' and 'server schannel' options and implies
8658 'server require schannel:COMPUTERACCOUNT = yes'.
8659 This option is over-ridden by the server schannel require
8661 seal:COMPUTERACCOUNT option.
8662 Default: server schannel require seal = yes
8664 server schannel require seal:COMPUTERACCOUNT (G)
8666 If you still have legacy domain members, which required "server
8668 schannel require seal = no" before, it is possible to specify
8669 explicit exception per computer account by using 'server schannel
8670 require seal:COMPUTERACCOUNT = no' as option. Note that
8671 COMPUTERACCOUNT has to be the sAMAccountName value of the computer
8672 account (including the trailing '$' sign).
8673 Samba will log a complaint in the log files at log level 0 about
8675 the security problem if the option is set to "no", but the related
8676 computer does not require it. (The log level can be adjusted with
8677 'CVE_2022_38023:warn_about_unused_debug_level = 1' in order to
8678 complain only at a higher log level).
8679 Samba will warn in the log files at log level 5, if a setting is
8681 still needed for the specified computer account.
8682 See CVE-2022-38023,
8684 https://bugzilla.samba.org/show_bug.cgi?id=15240.
8685 This option overrides the 'server schannel require seal' option.
8687 When set to 'yes' this option overrides the 'server require
8689 schannel:COMPUTERACCOUNT' and 'server schannel' options and implies
8690 'server require schannel:COMPUTERACCOUNT = yes'.
8691 server require schannel seal:LEGACYCOMPUTER1$ = no
8693 server require schannel seal:NASBOX$ = no
8694 server require schannel seal:LEGACYCOMPUTER2$ = no
8695 No default
8698 server services (G)
8700 This option contains the services that the Samba daemon will run.
8702 An entry in the smb.conf file can either override the previous
8704 value completely or entries can be removed from or added to it by
8705 prefixing them with + or -.
8706 Default: server services = s3fs, rpc, nbt, wrepl, ldap, cldap, kdc,
8708 drepl, winbindd, ntp_signd, kcc, dnsupdate, dns
8709 Example: server services = -s3fs, +smb
8711 server signing (G)
8713 This controls whether the client is allowed or required to use SMB1
8715 and SMB2 signing. Possible values are default, auto, mandatory and
8716 disabled.
8717 By default, and when smb signing is set to default, smb signing is
8719 required when server role is active directory domain controller and
8720 disabled otherwise.
8721 When set to auto, SMB1 signing is offered, but not enforced. When
8723 set to mandatory, SMB1 signing is required and if set to disabled,
8724 SMB signing is not offered either.
8725 For the SMB2 protocol, by design, signing cannot be disabled. In
8727 the case where SMB2 is negotiated, if this parameter is set to
8728 disabled, it will be treated as auto. Setting it to mandatory will
8729 still require SMB2 clients to use signing.
8730 Default: server signing = default
8732 server smb encrypt (S)
8734 This parameter controls whether a remote client is allowed or
8736 required to use SMB encryption. It has different effects depending
8737 on whether the connection uses SMB1 or SMB2 and newer:
8738 • If the connection uses SMB1, then this option controls
8740 the use of a Samba-specific extension to the SMB
8741 protocol introduced in Samba 3.2 that makes use of the
8742 Unix extensions.
8743 • If the connection uses SMB2 or newer, then this option
8745 controls the use of the SMB-level encryption that is
8746 supported in SMB version 3.0 and above and available in
8747 Windows 8 and newer.
8748 This parameter can be set globally and on a per-share bases.
8750 Possible values are off, if_required, desired, and required. A
8751 special value is default which is the implicit default setting of
8752 if_required.
8753 Effects for SMB1
8755 The Samba-specific encryption of SMB1 connections is an
8756 extension to the SMB protocol negotiated as part of the UNIX
8757 extensions. SMB encryption uses the GSSAPI (SSPI on Windows)
8758 ability to encrypt and sign every request/response in a SMB
8759 protocol stream. When enabled it provides a secure method of
8760 SMB/CIFS communication, similar to an ssh protected session,
8761 but using SMB/CIFS authentication to negotiate encryption and
8762 signing keys. Currently this is only supported smbclient of by
8763 Samba 3.2 and newer, and hopefully soon Linux CIFSFS and
8764 MacOS/X clients. Windows clients do not support this feature.
8765 This may be set on a per-share basis, but clients may chose to
8767 encrypt the entire session, not just traffic to a specific
8768 share. If this is set to mandatory then all traffic to a share
8769 must be encrypted once the connection has been made to the
8770 share. The server would return "access denied" to all
8771 non-encrypted requests on such a share. Selecting encrypted
8772 traffic reduces throughput as smaller packet sizes must be used
8773 (no huge UNIX style read/writes allowed) as well as the
8774 overhead of encrypting and signing all the data.
8775 If SMB encryption is selected, Windows style SMB signing (see
8777 the server signing option) is no longer necessary, as the
8778 GSSAPI flags use select both signing and sealing of the data.
8779 When set to auto or default, SMB encryption is offered, but not
8781 enforced. When set to mandatory, SMB encryption is required and
8782 if set to disabled, SMB encryption can not be negotiated.
8783 Effects for SMB2 and newer
8785 Native SMB transport encryption is available in SMB version 3.0
8786 or newer. It is only offered by Samba if server max protocol is
8787 set to SMB3 or newer. Clients supporting this type of
8788 encryption include Windows 8 and newer, Windows server 2012 and
8789 newer, and smbclient of Samba 4.1 and newer.
8790 The protocol implementation offers various options:
8792 • The capability to perform SMB encryption can be
8794 negotiated during protocol negotiation.
8795 • Data encryption can be enabled globally. In that
8797 case, an encryption-capable connection will have all
8798 traffic in all its sessions encrypted. In particular
8799 all share connections will be encrypted.
8800 • Data encryption can also be enabled per share if not
8802 enabled globally. For an encryption-capable
8803 connection, all connections to an encryption-enabled
8804 share will be encrypted.
8805 • Encryption can be enforced. This means that session
8807 setups will be denied on non-encryption-capable
8808 connections if data encryption has been enabled
8809 globally. And tree connections will be denied for
8810 non-encryption capable connections to shares with
8811 data encryption enabled.
8812 These features can be controlled with settings of server smb
8814 encrypt as follows:
8815 • Leaving it as default, explicitly setting default,
8817 or setting it to if_required globally will enable
8818 negotiation of encryption but will not turn on data
8819 encryption globally or per share.
8820 • Setting it to desired globally will enable
8822 negotiation and will turn on data encryption on
8823 sessions and share connections for those clients
8824 that support it.
8825 • Setting it to required globally will enable
8827 negotiation and turn on data encryption on sessions
8828 and share connections. Clients that do not support
8829 encryption will be denied access to the server.
8830 • Setting it to off globally will completely disable
8832 the encryption feature for all connections. Setting
8833 server smb encrypt = required for individual shares
8834 (while it's globally off) will deny access to this
8835 shares for all clients.
8836 • Setting it to desired on a share will turn on data
8838 encryption for this share for clients that support
8839 encryption if negotiation has been enabled globally.
8840 • Setting it to required on a share will enforce data
8842 encryption for this share if negotiation has been
8843 enabled globally. I.e. clients that do not support
8844 encryption will be denied access to the share.
8845 Note that this allows per-share enforcing to be
8847 controlled in Samba differently from Windows: In
8848 Windows, RejectUnencryptedAccess is a global
8849 setting, and if it is set, all shares with data
8850 encryption turned on are automatically enforcing
8851 encryption. In order to achieve the same effect in
8852 Samba, one has to globally set server smb encrypt to
8853 if_required, and then set all shares that should be
8854 encrypted to required. Additionally, it is possible
8855 in Samba to have some shares with encryption
8856 required and some other shares with encryption only
8857 desired, which is not possible in Windows.
8858 • Setting it to off or if_required for a share has no
8860 effect.
8861 Default: server smb encrypt = default
8864 server smb3 encryption algorithms (G)
8866 This parameter specifies the availability and order of encryption
8868 algorithms which are available for negotiation in the SMB3_11
8869 dialect.
8870 It is also possible to remove individual algorithms from the
8872 default list, by prefixing them with '-'. This can avoid having to
8873 specify a hardcoded list.
8874 Note: that the removal of AES-128-CCM from the list will result in
8876 SMB3_00 and SMB3_02 being unavailable, as it is the default and
8877 only available algorithm for these dialects.
8878 Default: server smb3 encryption algorithms = AES-128-GCM,
8880 AES-128-CCM, AES-256-GCM, AES-256-CCM
8881 Example: server smb3 encryption algorithms = AES-256-GCM
8883 Example: server smb3 encryption algorithms = -AES-128-GCM
8885 -AES-128-CCM
8886 server smb3 signing algorithms (G)
8888 This parameter specifies the availability and order of signing
8890 algorithms which are available for negotiation in the SMB3_11
8891 dialect.
8892 It is also possible to remove individual algorithms from the
8894 default list, by prefixing them with '-'. This can avoid having to
8895 specify a hardcoded list.
8896 Note: that the removal of AES-128-CMAC from the list will result in
8898 SMB3_00 and SMB3_02 being unavailable, and the removal of
8899 HMAC-SHA256 will result in SMB2_02 and SMB2_10 being unavailable,
8900 as these are the default and only available algorithms for these
8901 dialects.
8902 Default: server smb3 signing algorithms = AES-128-GMAC,
8904 AES-128-CMAC, HMAC-SHA256
8905 Example: server smb3 signing algorithms = AES-128-CMAC, HMAC-SHA256
8907 Example: server smb3 signing algorithms = -AES-128-CMAC
8909 server string (G)
8911 This controls what string will show up in the printer comment box
8913 in print manager and next to the IPC connection in net view. It can
8914 be any string that you wish to show to your users.
8915 It also sets what will appear in browse lists next to the machine
8917 name.
8918 A %v will be replaced with the Samba version number.
8920 A %h will be replaced with the hostname.
8922 Default: server string = Samba %v
8924 Example: server string = University of GNUs Samba Server
8926 set primary group script (G)
8928 Thanks to the Posix subsystem in NT a Windows User has a primary
8930 group in addition to the auxiliary groups. This script sets the
8931 primary group in the unix user database when an administrator sets
8932 the primary group from the windows user manager or when fetching a
8933 SAM with net rpc vampire. %u will be replaced with the user whose
8934 primary group is to be set. %g will be replaced with the group to
8935 set.
8936 Default: set primary group script =
8938 Example: set primary group script = /usr/sbin/usermod -g '%g' '%u'
8940 set quota command (G)
8942 The set quota command should only be used whenever there is no
8944 operating system API available from the OS that samba can use.
8945 This option is only available if Samba was compiled with quota
8947 support.
8948 This parameter should specify the path to a script that can set
8950 quota for the specified arguments.
8951 The specified script should take the following arguments:
8953 • 1 - path to where the quota needs to be set. This needs
8955 to be interpreted relative to the current working
8956 directory that the script may also check for.
8957 • 2 - quota type
8959 • 1 - user quotas
8961 • 2 - user default quotas (uid = -1)
8963 • 3 - group quotas
8965 • 4 - group default quotas (gid = -1)
8967 • 3 - id (uid for user, gid for group, -1 if N/A)
8970 • 4 - quota state (0 = disable, 1 = enable, 2 = enable and
8972 enforce)
8973 • 5 - block softlimit
8975 • 6 - block hardlimit
8977 • 7 - inode softlimit
8979 • 8 - inode hardlimit
8981 • 9(optional) - block size, defaults to 1024
8983 The script should output at least one line of data on success. And
8985 nothing on failure.
8986 Default: set quota command =
8988 Example: set quota command = /usr/local/sbin/set_quota
8990 share:fake_fscaps (G)
8992 This is needed to support some special application that makes
8994 QFSINFO calls to check whether we set the SPARSE_FILES bit (0x40).
8995 If this bit is not set that particular application refuses to work
8996 against Samba. With share:fake_fscaps = 64 the SPARSE_FILES file
8997 system capability flag is set. Use other decimal values to specify
8998 the bitmask you need to fake.
8999 Default: share:fake_fscaps = 0
9001 short preserve case (S)
9003 This boolean parameter controls if new files which conform to 8.3
9005 syntax, that is all in upper case and of suitable length, are
9006 created upper case, or if they are forced to be the default case.
9007 This option can be use with preserve case = yes to permit long
9008 filenames to retain their case, while short names are lowered.
9009 See the section on NAME MANGLING.
9011 Default: short preserve case = yes
9013 show add printer wizard (G)
9015 With the introduction of MS-RPC based printing support for Windows
9017 NT/2000 client in Samba 2.2, a "Printers..." folder will appear on
9018 Samba hosts in the share listing. Normally this folder will contain
9019 an icon for the MS Add Printer Wizard (APW). However, it is
9020 possible to disable this feature regardless of the level of
9021 privilege of the connected user.
9022 Under normal circumstances, the Windows NT/2000 client will open a
9024 handle on the printer server with OpenPrinterEx() asking for
9025 Administrator privileges. If the user does not have administrative
9026 access on the print server (i.e is not root or has granted the
9027 SePrintOperatorPrivilege), the OpenPrinterEx() call fails and the
9028 client makes another open call with a request for a lower privilege
9029 level. This should succeed, however the APW icon will not be
9030 displayed.
9031 Disabling the show add printer wizard parameter will always cause
9033 the OpenPrinterEx() on the server to fail. Thus the APW icon will
9034 never be displayed.
9035 Note
9037 This does not prevent the same user from having administrative
9038 privilege on an individual printer.
9039 Default: show add printer wizard = yes
9040 shutdown script (G)
9042 This a full path name to a script called by smbd(8) that should
9044 start a shutdown procedure.
9045 If the connected user possesses the SeRemoteShutdownPrivilege,
9047 right, this command will be run as root.
9048 The %z %t %r %f variables are expanded as follows:
9050 • %z will be substituted with the shutdown message sent to
9052 the server.
9053 • %t will be substituted with the number of seconds to
9055 wait before effectively starting the shutdown procedure.
9056 • %r will be substituted with the switch -r. It means
9058 reboot after shutdown for NT.
9059 • %f will be substituted with the switch -f. It means
9061 force the shutdown even if applications do not respond
9062 for NT.
9063 Shutdown script example:
9065 #!/bin/bash
9067 time=$2
9069 let time="${time} / 60"
9070 let time="${time} + 1"
9071 /sbin/shutdown $3 $4 +$time $1 &
9073 Shutdown does not return so we need to launch it in background.
9076 Default: shutdown script =
9078 Example: shutdown script = /usr/local/samba/sbin/shutdown %m %t %r
9080 %f
9081 unix extensions
9083 This parameter is a synonym for smb1 unix extensions.
9085 smb1 unix extensions (G)
9087 This boolean parameter controls whether Samba implements the
9089 SMB1/CIFS UNIX extensions, as defined by HP. These extensions
9090 enable Samba to better serve UNIX SMB1/CIFS clients by supporting
9091 features such as symbolic links, hard links, etc... These
9092 extensions require a similarly enabled client, and are of no
9093 current use to Windows clients.
9094 Note if this parameter is turned on, the wide links parameter will
9096 automatically be disabled.
9097 See the parameter allow insecure wide links if you wish to change
9099 this coupling between the two parameters.
9100 Default: smb1 unix extensions = yes
9102 smb2 disable lock sequence checking (G)
9104 This boolean parameter controls whether smbd(8) will disable lock
9106 sequence checking even for multi-channel connections as well as
9107 durable handles.
9108 The [MS-SMB2] specification (under 3.3.5.14 Receiving an SMB2 LOCK
9110 Request) documents that a server should do lock sequence if
9111 Open.IsResilient or Open.IsDurable or Open.IsPersistent is TRUE or
9112 if Connection.Dialect belongs to the SMB 3.x dialect family and
9113 Connection.ServerCapabilities includes
9114 SMB2_GLOBAL_CAP_MULTI_CHANNEL.
9115 But Windows Server (at least up to v2004) only does these checks
9117 for the Open.IsResilient and Open.IsPersistent. That means they do
9118 not implement the behavior specified in [MS-SMB2].
9119 By default Samba behaves according to the specification and
9121 implements lock sequence checking when multi-channel is used.
9122 Warning: Only enable this option if existing clients can't handle
9124 lock sequence checking for handles without Open.IsResilient and
9125 Open.IsPersistent. And it turns out that the Windows Server
9126 behavior is required.
9127 Note: it's likely that this option will be removed again if future
9129 Windows versions change their behavior.
9130 Note: Samba does not implement Open.IsResilient and
9132 Open.IsPersistent yet.
9133 Default: smb2 disable lock sequence checking = no
9135 Example: smb2 disable lock sequence checking = yes
9137 smb2 disable oplock break retry (G)
9139 This boolean parameter controls whether smbd(8) will trigger smb2
9141 oplock break notification retries when using server multi channel
9142 support = yes.
9143 The [MS-SMB2] specification documents that a server should send
9145 smb2 oplock break notification retries on all available channel to
9146 the given client.
9147 But Windows Server versions (at least up to 2019) do not send smb2
9149 oplock break notification retries on channel failures. That means
9150 they do not implement the behavior specified in [MS-SMB2].
9151 By default Samba behaves according to the specification and send
9153 smb2 oplock break notification retries.
9154 Warning: Only enable this option if existing clients can't handle
9156 possible retries and it turns out that the Windows Server behavior
9157 is required.
9158 Note: it's likely that this option gets removed again if future
9160 Windows versions change their behavior.
9161 Note: this only applies to oplocks and not SMB2 leases.
9163 Default: smb2 disable oplock break retry = no
9165 Example: smb2 disable oplock break retry = yes
9167 smb2 leases (G)
9169 This boolean option tells smbd whether to globally negotiate SMB2
9171 leases on file open requests. Leasing is an SMB2-only feature which
9172 allows clients to aggressively cache files locally above and beyond
9173 the caching allowed by SMB1 oplocks.
9174 This is only available with oplocks = yes and kernel oplocks = no.
9176 Default: smb2 leases = yes
9178 smb2 max credits (G)
9180 This option controls the maximum number of outstanding simultaneous
9182 SMB2 operations that Samba tells the client it will allow. This is
9183 similar to the max mux parameter for SMB1. You should never need to
9184 set this parameter.
9185 The default is 8192 credits, which is the same as a Windows 2008R2
9187 SMB2 server.
9188 Default: smb2 max credits = 8192
9190 smb2 max read (G)
9192 This option specifies the protocol value that smbd(8) will return
9194 to a client, informing the client of the largest size that may be
9195 returned by a single SMB2 read call.
9196 The maximum is 8388608 bytes (8MiB), which is the same as a Windows
9198 Server 2012 r2.
9199 Please note that the default is 8MiB, but it's limit is based on
9201 the smb2 dialect (64KiB for SMB == 2.0, 8MiB for SMB >= 2.1 with
9202 LargeMTU). Large MTU is not supported over NBT (tcp port 139).
9203 Default: smb2 max read = 8388608
9205 smb2 max trans (G)
9207 This option specifies the protocol value that smbd(8) will return
9209 to a client, informing the client of the largest size of buffer
9210 that may be used in querying file meta-data via QUERY_INFO and
9211 related SMB2 calls.
9212 The maximum is 8388608 bytes (8MiB), which is the same as a Windows
9214 Server 2012 r2.
9215 Please note that the default is 8MiB, but it's limit is based on
9217 the smb2 dialect (64KiB for SMB == 2.0, 1MiB for SMB >= 2.1 with
9218 LargeMTU). Large MTU is not supported over NBT (tcp port 139).
9219 Default: smb2 max trans = 8388608
9221 smb2 max write (G)
9223 This option specifies the protocol value that smbd(8) will return
9225 to a client, informing the client of the largest size that may be
9226 sent to the server by a single SMB2 write call.
9227 The maximum is 8388608 bytes (8MiB), which is the same as a Windows
9229 Server 2012 r2.
9230 Please note that the default is 8MiB, but it's limit is based on
9232 the smb2 dialect (64KiB for SMB == 2.0, 8MiB for SMB => 2.1 with
9233 LargeMTU). Large MTU is not supported over NBT (tcp port 139).
9234 Default: smb2 max write = 8388608
9236 smb3 unix extensions (G)
9238 Incomplete SMB 3.11 Unix Extensions. This is only available if
9240 Samba is compiled in DEVELOPER mode.
9241 Default: smb3 unix extensions = no
9243 smbd async dosmode (S)
9245 This parameter control whether the fileserver will use sync or
9247 async methods for fetching the DOS attributes when doing a
9248 directory listing. By default sync methods will be used.
9249 Default: smbd async dosmode = no
9251 smbd getinfo ask sharemode (S)
9253 This parameter allows disabling fetching file write time from the
9255 open file handle database locking.tdb when a client requests file
9256 or directory metadata. It's a performance optimisation at the
9257 expense of protocol correctness.
9258 Default: smbd getinfo ask sharemode = yes
9260 smbd max async dosmode (S)
9262 This parameter controls how many async operations to fetch the DOS
9264 attributes the fileserver will queue when doing directory listings.
9265 Default: smbd max async dosmode = aio max threads * 2
9267 smbd max xattr size (S)
9269 This parameter controls the maximum size of extended attributes
9271 that may be written to the server as EAs or as alternate data
9272 streams if vfs_streams_xattr is enabled. The maximum size of
9273 extended attributes depends on the Samba server's operating system
9274 and the underlying filesystem. The Linux VFS currently sets an
9275 upper boundary of 64 KiB per extended attribute. FreeBSD does not
9276 set a practical upper limit, but since pread() and pwrite() are not
9277 possible via the extattr on FreeBSD, it is not recommended to
9278 increase this value above a few MiB. If a client attempts to write
9279 an overly-large alternate datastream, the Samba server will return
9280 STATUS_FILESYSTEM_LIMITATION. If this error is encountered, users
9281 may try increasing the maximum size supported for xattr writes. If
9282 this is not possible, and writes are from a MacOS client and to an
9283 AFP_Resource extended attribute, the user may enable the vfs_fruit
9284 module and configure to allow stream writes for AFP_Resource to an
9285 alternative storage location. See vfs_fruit documentation for
9286 further details.
9287 Default: smbd max xattr size = 65536
9289 smbd profiling level (G)
9291 This parameter allows the administrator to enable profiling
9293 support.
9294 Possible values are off, count and on.
9296 Default: smbd profiling level = off
9298 Example: smbd profiling level = on
9300 smbd search ask sharemode (S)
9302 This parameter allows disabling fetching file write time from the
9304 open file handle database locking.tdb. It's a performance
9305 optimisation at the expense of protocol correctness.
9306 Default: smbd search ask sharemode = yes
9308 smb encrypt (S)
9310 This is a synonym for server smb encrypt.
9312 Default: smb encrypt = default
9314 smb passwd file (G)
9316 This option sets the path to the encrypted smbpasswd file. By
9318 default the path to the smbpasswd file is compiled into Samba.
9319 An example of use is:
9321 smb passwd file = /etc/samba/smbpasswd
9323 Default: smb passwd file = /var/lib/samba/private/smbpasswd
9325 smb ports (G)
9327 Specifies which ports the server should listen on for SMB traffic.
9329 Default: smb ports = 445 139
9331 socket options (G)
9333 Warning
9335 Modern server operating systems are tuned for high network
9336 performance in the majority of situations; when you set socket
9337 options you are overriding those settings. Linux in particular
9338 has an auto-tuning mechanism for buffer sizes that will be
9339 disabled if you specify a socket buffer size. This can
9340 potentially cripple your TCP/IP stack.
9341 Getting the socket options correct can make a big difference to
9343 your performance, but getting them wrong can degrade it by just
9344 as much. As with any other low level setting, if you must make
9345 changes to it, make small changes and test the effect before
9346 making any large changes.
9347 This option allows you to set socket options to be used when
9349 talking with the client.
9350 Socket options are controls on the networking layer of the
9352 operating systems which allow the connection to be tuned.
9353 This option will typically be used to tune your Samba server for
9355 optimal performance for your local network. There is no way that
9356 Samba can know what the optimal parameters are for your net, so you
9357 must experiment and choose them yourself. We strongly suggest you
9358 read the appropriate documentation for your operating system first
9359 (perhaps man setsockopt will help).
9360 You may find that on some systems Samba will say "Unknown socket
9362 option" when you supply an option. This means you either
9363 incorrectly typed it or you need to add an include file to
9364 includes.h for your OS. If the latter is the case please send the
9365 patch to samba-technical@lists.samba.org.
9366 Any of the supported socket options may be combined in any way you
9368 like, as long as your OS allows it.
9369 This is the list of socket options currently settable using this
9371 option:
9372 • SO_KEEPALIVE
9374 • SO_REUSEADDR
9376 • SO_BROADCAST
9378 • TCP_NODELAY
9380 • TCP_KEEPCNT *
9382 • TCP_KEEPIDLE *
9384 • TCP_KEEPINTVL *
9386 • IPTOS_LOWDELAY
9388 • IPTOS_THROUGHPUT
9390 • SO_REUSEPORT
9392 • SO_SNDBUF *
9394 • SO_RCVBUF *
9396 • SO_SNDLOWAT *
9398 • SO_RCVLOWAT *
9400 • SO_SNDTIMEO *
9402 • SO_RCVTIMEO *
9404 • TCP_FASTACK *
9406 • TCP_QUICKACK
9408 • TCP_NODELAYACK
9410 • TCP_KEEPALIVE_THRESHOLD *
9412 • TCP_KEEPALIVE_ABORT_THRESHOLD *
9414 • TCP_DEFER_ACCEPT *
9416 • TCP_USER_TIMEOUT *
9418 Those marked with a '*' take an integer argument. The others can
9420 optionally take a 1 or 0 argument to enable or disable the option,
9421 by default they will be enabled if you don't specify 1 or 0.
9422 To specify an argument use the syntax SOME_OPTION = VALUE for
9424 example SO_SNDBUF = 8192. Note that you must not have any spaces
9425 before or after the = sign.
9426 If you are on a local network then a sensible option might be:
9428 socket options = IPTOS_LOWDELAY
9430 If you have a local network then you could try:
9432 socket options = IPTOS_LOWDELAY TCP_NODELAY
9434 If you are on a wide area network then perhaps try setting
9436 IPTOS_THROUGHPUT.
9437 Note that several of the options may cause your Samba server to
9439 fail completely. Use these options with caution!
9440 Default: socket options = TCP_NODELAY
9442 Example: socket options = IPTOS_LOWDELAY
9444 spn update command (G)
9446 This option sets the command that for updating servicePrincipalName
9448 names from spn_update_list.
9449 Default: spn update command =
9451 /builddir/build/BUILD/samba-4.19.3/source4/scripting/bin/samba_spnupdate
9452 Example: spn update command = /usr/local/sbin/spnupdate
9454 spoolss: architecture (G)
9456 Windows spoolss print clients only allow association of server-side
9458 drivers with printers when the driver architecture matches the
9459 advertised print server architecture. Samba's spoolss print server
9460 architecture can be changed using this parameter.
9461 Default: spoolss: architecture = Windows x64
9463 Example: spoolss: architecture = Windows NT x86
9465 spoolss: os_major (G)
9467 Windows might require a new os version number. This option allows
9469 to modify the build number. The complete default version number is:
9470 5.0.2195 (Windows 2000). The example is 6.1.7601 (Windows 2008 R2).
9471 Default: spoolss: os_major = 5
9473 Example: spoolss: os_major = 6
9475 spoolss: os_minor (G)
9477 Windows might require a new os version number. This option allows
9479 to modify the build number. The complete default version number is:
9480 5.0.2195 (Windows 2000). The example is 6.1.7601 (Windows 2008 R2).
9481 Default: spoolss: os_minor = 0
9483 Example: spoolss: os_minor = 1
9485 spoolss: os_build (G)
9487 Windows might require a new os version number. This option allows
9489 to modify the build number. The complete default version number is:
9490 5.0.2195 (Windows 2000). The example is 6.1.7601 (Windows 2008 R2).
9491 Default: spoolss: os_build = 2195
9493 Example: spoolss: os_build = 7601
9495 spoolss_client: os_major (G)
9497 Windows might require a new os version number. This option allows
9499 to modify the build number. The complete default version number is:
9500 6.1.7007 (Windows 7 and Windows Server 2008 R2).
9501 Default: spoolss_client: os_major = 6
9503 spoolss_client: os_minor (G)
9505 Windows might require a new os version number. This option allows
9507 to modify the build number. The complete default version number is:
9508 6.1.7007 (Windows 7 and Windows Server 2008 R2).
9509 Default: spoolss_client: os_minor = 1
9511 spoolss_client: os_build (G)
9513 Windows might require a new os version number. This option allows
9515 to modify the build number. The complete default version number is:
9516 6.1.7007 (Windows 7 and Windows Server 2008 R2).
9517 Default: spoolss_client: os_build = 7007
9519 spotlight (S)
9521 This parameter controls whether Samba allows Spotlight queries on a
9523 share. For controlling indexing of filesystems you also have to use
9524 Tracker's own configuration system.
9525 Spotlight has several prerequisites:
9527 • Samba must be configured and built with Spotlight
9529 support.
9530 • Tracker integration must be setup and the share must be
9532 indexed by Tracker.
9533 For a detailed set of instructions please see
9535 https://wiki.samba.org/index.php/Spotlight.
9536 Default: spotlight = no
9538 spotlight backend (S)
9540 Spotlight search backend. Available backends:
9542 • noindex - a backend that returns no results.
9544 • tracker - Gnome Tracker.
9547 • elasticsearch - a backend that uses JSON and REST over
9549 HTTP(s) to query an Elasticsearch server.
9550 Default: spotlight backend = noindex
9553 stat cache (G)
9555 This parameter determines if smbd(8) will use a cache in order to
9557 speed up case insensitive name mappings. You should never need to
9558 change this parameter.
9559 Default: stat cache = yes
9561 state directory (G)
9563 Usually, most of the TDB files are stored in the lock directory.
9565 Since Samba 3.4.0, it is possible to differentiate between TDB
9566 files with persistent data and TDB files with non-persistent data
9567 using the state directory and the cache directory options.
9568 This option specifies the directory where TDB files containing
9570 important persistent data will be stored.
9571 Default: state directory = /var/lib/samba
9573 Example: state directory = /var/run/samba/locks/state
9575 store dos attributes (S)
9577 If this parameter is set Samba attempts to first read DOS
9579 attributes (SYSTEM, HIDDEN, ARCHIVE or READ-ONLY) from a filesystem
9580 extended attribute, before mapping DOS attributes to UNIX
9581 permission bits (such as occurs with map hidden and map readonly).
9582 When set, DOS attributes will be stored onto an extended attribute
9583 in the UNIX filesystem, associated with the file or directory. When
9584 this parameter is set it will override the parameters map hidden,
9585 map system, map archive and map readonly and they will behave as if
9586 they were set to off. This parameter writes the DOS attributes as a
9587 string into the extended attribute named "user.DOSATTRIB". This
9588 extended attribute is explicitly hidden from smbd clients
9589 requesting an EA list. On Linux the filesystem must have been
9590 mounted with the mount option user_xattr in order for extended
9591 attributes to work, also extended attributes must be compiled into
9592 the Linux kernel. In Samba 3.5.0 and above the "user.DOSATTRIB"
9593 extended attribute has been extended to store the create time for a
9594 file as well as the DOS attributes. This is done in a backwards
9595 compatible way so files created by Samba 3.5.0 and above can still
9596 have the DOS attribute read from this extended attribute by earlier
9597 versions of Samba, but they will not be able to read the create
9598 time stored there. Storing the create time separately from the
9599 normal filesystem meta-data allows Samba to faithfully reproduce
9600 NTFS semantics on top of a POSIX filesystem. The default has
9601 changed to yes in Samba release 4.9.0 and above to allow better
9602 Windows fileserver compatibility in a default install.
9603 Default: store dos attributes = yes
9605 strict allocate (S)
9607 This is a boolean that controls the handling of disk space
9609 allocation in the server. When this is set to yes the server will
9610 change from UNIX behaviour of not committing real disk storage
9611 blocks when a file is extended to the Windows behaviour of actually
9612 forcing the disk system to allocate real storage blocks when a file
9613 is created or extended to be a given size. In UNIX terminology this
9614 means that Samba will stop creating sparse files.
9615 This option is really designed for file systems that support fast
9617 allocation of large numbers of blocks such as extent-based file
9618 systems. On file systems that don't support extents (most notably
9619 ext3) this can make Samba slower. When you work with large files
9620 over >100MB on file systems without extents you may even run into
9621 problems with clients running into timeouts.
9622 When you have an extent based filesystem it's likely that we can
9624 make use of unwritten extents which allows Samba to allocate even
9625 large amounts of space very fast and you will not see any timeout
9626 problems caused by strict allocate. With strict allocate in use you
9627 will also get much better out of quota messages in case you use
9628 quotas. Another advantage of activating this setting is that it
9629 will help to reduce file fragmentation.
9630 To give you an idea on which filesystems this setting might
9632 currently be a good option for you: XFS, ext4, btrfs, ocfs2 on
9633 Linux and JFS2 on AIX support unwritten extents. On Filesystems
9634 that do not support it, preallocation is probably an expensive
9635 operation where you will see reduced performance and risk to let
9636 clients run into timeouts when creating large files. Examples are
9637 ext3, ZFS, HFS+ and most others, so be aware if you activate this
9638 setting on those filesystems.
9639 Default: strict allocate = no
9641 strict locking (S)
9643 This is an enumerated type that controls the handling of file
9645 locking in the server. When this is set to yes, the server will
9646 check every read and write access for file locks, and deny access
9647 if locks exist. This can be slow on some systems.
9648 When strict locking is set to Auto (the default), the server
9650 performs file lock checks only on non-oplocked files. As most
9651 Windows redirectors perform file locking checks locally on oplocked
9652 files this is a good trade off for improved performance.
9653 When strict locking is disabled, the server performs file lock
9655 checks only when the client explicitly asks for them.
9656 Well-behaved clients always ask for lock checks when it is
9658 important. So in the vast majority of cases, strict locking = Auto
9659 or strict locking = no is acceptable.
9660 Default: strict locking = Auto
9662 strict rename (S)
9664 By default a Windows SMB server prevents directory renames when
9666 there are open file or directory handles below it in the filesystem
9667 hierarchy. Historically Samba has always allowed this as POSIX
9668 filesystem semantics require it.
9669 This boolean parameter allows Samba to match the Windows behavior.
9671 Setting this to "yes" is a very expensive change, as it forces
9672 Samba to travers the entire open file handle database on every
9673 directory rename request. In a clustered Samba system the cost is
9674 even greater than the non-clustered case.
9675 When set to "no" smbd only checks the local process the client is
9677 attached to for open files below a directory being renamed, instead
9678 of checking for open files across all smbd processes.
9679 Because of the expense in fully searching the database, the default
9681 is "no", and it is recommended to be left that way unless a
9682 specific Windows application requires it to be changed.
9683 If the client has requested UNIX extensions (POSIX pathnames) then
9685 renames are always allowed and this parameter has no effect.
9686 Default: strict rename = no
9688 strict sync (S)
9690 This parameter controls whether Samba honors a request from an SMB
9692 client to ensure any outstanding operating system buffer contents
9693 held in memory are safely written onto stable storage on disk. If
9694 set to yes, which is the default, then Windows applications can
9695 force the smbd server to synchronize unwritten data onto the disk.
9696 If set to no then smbd will ignore client requests to synchronize
9697 unwritten data onto stable storage on disk.
9698 In Samba 4.7.0, the default for this parameter changed from no to
9700 yes to better match the expectations of SMB2/3 clients and improve
9701 application safety when running against smbd.
9702 The flush request from SMB2/3 clients is handled asynchronously
9704 inside smbd, so leaving the parameter as the default value of yes
9705 does not block the processing of other requests to the smbd
9706 process.
9707 Legacy Windows applications (such as the Windows 98 explorer shell)
9709 seemed to confuse writing buffer contents to the operating system
9710 with synchronously writing outstanding data onto stable storage on
9711 disk. Changing this parameter to no means that smbd(8) will ignore
9712 the Windows applications request to synchronize unwritten data onto
9713 disk. Only consider changing this if smbd is serving obsolete SMB1
9714 Windows clients prior to Windows XP (Windows 98 and below). There
9715 should be no need to change this setting for normal operations.
9716 Default: strict sync = yes
9718 svcctl list (G)
9720 This option defines a list of init scripts that smbd will use for
9722 starting and stopping Unix services via the Win32 ServiceControl
9723 API. This allows Windows administrators to utilize the MS
9724 Management Console plug-ins to manage a Unix server running Samba.
9725 The administrator must create a directory name svcctl in Samba's
9727 $(libdir) and create symbolic links to the init scripts in
9728 /etc/init.d/. The name of the links must match the names given as
9729 part of the svcctl list.
9730 Default: svcctl list =
9732 Example: svcctl list = cups postfix portmap httpd
9734 sync always (S)
9736 This is a boolean parameter that controls whether writes will
9738 always be written to stable storage before the write call returns.
9739 If this is no then the server will be guided by the client's
9740 request in each write call (clients can set a bit indicating that a
9741 particular write should be synchronous). If this is yes then every
9742 write will be followed by a fsync() call to ensure the data is
9743 written to disk. Note that the strict sync parameter must be set to
9744 yes in order for this parameter to have any effect.
9745 Default: sync always = no
9747 syslog (G)
9749 This parameter maps how Samba debug messages are logged onto the
9751 system syslog logging levels. Samba debug level zero maps onto
9752 syslog LOG_ERR, debug level one maps onto LOG_WARNING, debug level
9753 two maps onto LOG_NOTICE, debug level three maps onto LOG_INFO. All
9754 higher levels are mapped to LOG_DEBUG.
9755 This parameter sets the threshold for sending messages to syslog.
9757 Only messages with debug level less than this value will be sent to
9758 syslog. There still will be some logging to log.[sn]mbd even if
9759 syslog only is enabled.
9760 The logging parameter should be used instead. When logging is set,
9762 it overrides the syslog parameter.
9763 Default: syslog = 1
9765 syslog only (G)
9767 If this parameter is set then Samba debug messages are logged into
9769 the system syslog only, and not to the debug log files. There still
9770 will be some logging to log.[sn]mbd even if syslog only is enabled.
9771 The logging parameter should be used instead. When logging is set,
9773 it overrides the syslog only parameter.
9774 Default: syslog only = no
9776 template homedir (G)
9778 When filling out the user information for a Windows NT user, the
9780 winbindd(8) daemon uses this parameter to fill in the home
9781 directory for that user. If the string %D is present it is
9782 substituted with the user's Windows NT domain name. If the string
9783 %U is present it is substituted with the user's Windows NT user
9784 name.
9785 Default: template homedir = /home/%D/%U
9787 template shell (G)
9789 When filling out the user information for a Windows NT user, the
9791 winbindd(8) daemon uses this parameter to fill in the login shell
9792 for that user.
9793 Default: template shell = /bin/false
9795 time server (G)
9797 This parameter determines if nmbd(8) advertises itself as a time
9799 server to Windows clients.
9800 Default: time server = no
9802 debug timestamp
9804 This parameter is a synonym for timestamp logs.
9806 timestamp logs (G)
9808 Samba debug log messages are timestamped by default. If you are
9810 running at a high debug level these timestamps can be distracting.
9811 This boolean parameter allows timestamping to be turned off.
9812 Default: timestamp logs = yes
9814 tls cafile (G)
9816 This option can be set to a file (PEM format) containing CA
9818 certificates of root CAs to trust to sign certificates or
9819 intermediate CA certificates.
9820 This path is relative to private dir if the path does not start
9822 with a /.
9823 Default: tls cafile = tls/ca.pem
9825 tls certfile (G)
9827 This option can be set to a file (PEM format) containing the RSA
9829 certificate.
9830 This path is relative to private dir if the path does not start
9832 with a /.
9833 Default: tls certfile = tls/cert.pem
9835 tls crlfile (G)
9837 This option can be set to a file containing a certificate
9839 revocation list (CRL).
9840 This path is relative to private dir if the path does not start
9842 with a /.
9843 Default: tls crlfile =
9845 tls dh params file (G)
9847 This option can be set to a file with Diffie-Hellman parameters
9849 which will be used with DH ciphers.
9850 This path is relative to private dir if the path does not start
9852 with a /.
9853 Default: tls dh params file =
9855 tls enabled (G)
9857 If this option is set to yes, then Samba will use TLS when possible
9859 in communication.
9860 Default: tls enabled = yes
9862 tls keyfile (G)
9864 This option can be set to a file (PEM format) containing the RSA
9866 private key. This file must be accessible without a pass-phrase,
9867 i.e. it must not be encrypted.
9868 This path is relative to private dir if the path does not start
9870 with a /.
9871 Default: tls keyfile = tls/key.pem
9873 tls priority (G)
9875 This option can be set to a string describing the TLS protocols to
9877 be supported in the parts of Samba that use GnuTLS, specifically
9878 the AD DC.
9879 The string is appended to the default priority list of GnuTLS.
9881 The valid options are described in the GNUTLS Priority-Strings
9883 documentation at
9884 http://gnutls.org/manual/html_node/Priority-Strings.html
9885 The SSL3.0 protocol will be disabled.
9887 Default: tls priority = NORMAL:-VERS-SSL3.0
9889 tls verify peer (G)
9891 This controls if and how strict the client will verify the peer's
9893 certificate and name. Possible values are (in increasing order):
9894 no_check, ca_only, ca_and_name_if_available, ca_and_name and
9895 as_strict_as_possible.
9896 When set to no_check the certificate is not verified at all, which
9898 allows trivial man in the middle attacks.
9899 When set to ca_only the certificate is verified to be signed from a
9901 ca specified in the tls ca file option. Setting tls ca file to a
9902 valid file is required. The certificate lifetime is also verified.
9903 If the tls crl file option is configured, the certificate is also
9904 verified against the ca crl.
9905 When set to ca_and_name_if_available all checks from ca_only are
9907 performed. In addition, the peer hostname is verified against the
9908 certificate's name, if it is provided by the application layer and
9909 not given as an ip address string.
9910 When set to ca_and_name all checks from ca_and_name_if_available
9912 are performed. In addition the peer hostname needs to be provided
9913 and even an ip address is checked against the certificate's name.
9914 When set to as_strict_as_possible all checks from ca_and_name are
9916 performed. In addition the tls crl file needs to be configured.
9917 Future versions of Samba may implement additional checks.
9918 Default: tls verify peer = as_strict_as_possible
9920 unicode (G)
9922 Specifies whether the server and client should support unicode.
9924 If this option is set to false, the use of ASCII will be forced.
9926 Default: unicode = yes
9928 unix charset (G)
9930 Specifies the charset the unix machine Samba runs on uses. Samba
9932 needs to know this in order to be able to convert text to the
9933 charsets other SMB clients use.
9934 This is also the charset Samba will use when specifying arguments
9936 to scripts that it invokes.
9937 Default: unix charset = UTF-8
9939 Example: unix charset = ASCII
9941 unix password sync (G)
9943 This boolean parameter controls whether Samba attempts to
9945 synchronize the UNIX password with the SMB password when the
9946 encrypted SMB password in the smbpasswd file is changed. If this is
9947 set to yes the program specified in the passwd program parameter is
9948 called AS ROOT - to allow the new UNIX password to be set without
9949 access to the old UNIX password (as the SMB password change code
9950 has no access to the old password cleartext, only the new).
9951 This option has no effect if samba is running as an active
9953 directory domain controller, in that case have a look at the
9954 password hash gpg key ids option and the samba-tool user
9955 syncpasswords command.
9956 Default: unix password sync = no
9958 use client driver (S)
9960 This parameter applies only to Windows NT/2000 clients. It has no
9962 effect on Windows 95/98/ME clients. When serving a printer to
9963 Windows NT/2000 clients without first installing a valid printer
9964 driver on the Samba host, the client will be required to install a
9965 local printer driver. From this point on, the client will treat the
9966 print as a local printer and not a network printer connection. This
9967 is much the same behavior that will occur when disable spoolss =
9968 yes.
9969 The differentiating factor is that under normal circumstances, the
9971 NT/2000 client will attempt to open the network printer using
9972 MS-RPC. The problem is that because the client considers the
9973 printer to be local, it will attempt to issue the OpenPrinterEx()
9974 call requesting access rights associated with the logged on user.
9975 If the user possesses local administrator rights but not root
9976 privilege on the Samba host (often the case), the OpenPrinterEx()
9977 call will fail. The result is that the client will now display an
9978 "Access Denied; Unable to connect" message in the printer queue
9979 window (even though jobs may successfully be printed).
9980 If this parameter is enabled for a printer, then any attempt to
9982 open the printer with the PRINTER_ACCESS_ADMINISTER right is mapped
9983 to PRINTER_ACCESS_USE instead. Thus allowing the OpenPrinterEx()
9984 call to succeed. This parameter MUST not be enabled on a print
9985 share which has valid print driver installed on the Samba server.
9986 Default: use client driver = no
9988 use mmap (G)
9990 This global parameter determines if the tdb internals of Samba can
9992 depend on mmap working correctly on the running system. Samba
9993 requires a coherent mmap/read-write system memory cache. Currently
9994 only OpenBSD and HPUX do not have such a coherent cache, and on
9995 those platforms this parameter is overridden internally to be
9996 effectively no. On all systems this parameter should be left alone.
9997 This parameter is provided to help the Samba developers track down
9998 problems with the tdb internal code.
9999 Default: use mmap = yes
10001 username level (G)
10003 This option helps Samba to try and 'guess' at the real UNIX
10005 username, as many DOS clients send an all-uppercase username. By
10006 default Samba tries all lowercase, followed by the username with
10007 the first letter capitalized, and fails if the username is not
10008 found on the UNIX machine.
10009 If this parameter is set to non-zero the behavior changes. This
10011 parameter is a number that specifies the number of uppercase
10012 combinations to try while trying to determine the UNIX user name.
10013 The higher the number the more combinations will be tried, but the
10014 slower the discovery of usernames will be. Use this parameter when
10015 you have strange usernames on your UNIX machine, such as
10016 AstrangeUser .
10017 This parameter is needed only on UNIX systems that have case
10019 sensitive usernames.
10020 Default: username level = 0
10022 Example: username level = 5
10024 username map (G)
10026 This option allows you to specify a file containing a mapping of
10028 usernames from the clients to the server. This can be used for
10029 several purposes. The most common is to map usernames that users
10030 use on DOS or Windows machines to those that the UNIX box uses. The
10031 other is to map multiple users to a single username so that they
10032 can more easily share files.
10033 Please note that for user mode security, the username map is
10035 applied prior to validating the user credentials. Domain member
10036 servers (domain or ads) apply the username map after the user has
10037 been successfully authenticated by the domain controller and
10038 require fully qualified entries in the map table (e.g. biddle =
10039 DOMAIN\foo).
10040 The map file is parsed line by line. Each line should contain a
10042 single UNIX username on the left then a '=' followed by a list of
10043 usernames on the right. The list of usernames on the right may
10044 contain names of the form @group in which case they will match any
10045 UNIX username in that group. The special client name '*' is a
10046 wildcard and matches any name. Each line of the map file may be up
10047 to 1023 characters long.
10048 The file is processed on each line by taking the supplied username
10050 and comparing it with each username on the right hand side of the
10051 '=' signs. If the supplied name matches any of the names on the
10052 right hand side then it is replaced with the name on the left.
10053 Processing then continues with the next line.
10054 If any line begins with a '#' or a ';' then it is ignored.
10056 If any line begins with an '!' then the processing will stop after
10058 that line if a mapping was done by the line. Otherwise mapping
10059 continues with every line being processed. Using '!' is most useful
10060 when you have a wildcard mapping line later in the file.
10061 For example to map from the name admin or administrator to the UNIX
10063 name
10064 root you would use:
10065 root = admin administrator
10067 Or to map anyone in the UNIX group system to the UNIX name sys you
10069 would use:
10070 sys = @system
10072 You can have as many mappings as you like in a username map file.
10074 If your system supports the NIS NETGROUP option then the netgroup
10076 database is checked before the /etc/group database for matching
10077 groups.
10078 You can map Windows usernames that have spaces in them by using
10080 double quotes around the name. For example:
10081 tridge = "Andrew Tridgell"
10083 would map the windows username "Andrew Tridgell" to the unix
10085 username "tridge".
10086 The following example would map mary and fred to the unix user sys,
10088 and map the rest to guest. Note the use of the '!' to tell Samba to
10089 stop processing if it gets a match on that line:
10090 !sys = mary fred
10092 guest = *
10093 Note that the remapping is applied to all occurrences of usernames.
10095 Thus if you connect to \\server\fred and fred is remapped to mary
10096 then you will actually be connecting to \\server\mary and will need
10097 to supply a password suitable for mary not fred. The only exception
10098 to this is the username passed to a Domain Controller (if you have
10099 one). The DC will receive whatever username the client supplies
10100 without modification.
10101 Also note that no reverse mapping is done. The main effect this has
10103 is with printing. Users who have been mapped may have trouble
10104 deleting print jobs as PrintManager under WfWg will think they
10105 don't own the print job.
10106 Samba versions prior to 3.0.8 would only support reading the fully
10108 qualified username (e.g.: DOMAIN\user) from the username map when
10109 performing a kerberos login from a client. However, when looking up
10110 a map entry for a user authenticated by NTLM[SSP], only the login
10111 name would be used for matches. This resulted in inconsistent
10112 behavior sometimes even on the same server.
10113 The following functionality is obeyed in version 3.0.8 and later:
10115 When performing local authentication, the username map is applied
10117 to the login name before attempting to authenticate the connection.
10118 When relying upon a external domain controller for validating
10120 authentication requests, smbd will apply the username map to the
10121 fully qualified username (i.e. DOMAIN\user) only after the user
10122 has been successfully authenticated.
10123 An example of use is:
10125 username map = /usr/local/samba/lib/users.map
10127 Default: username map = # no username map
10129 username map cache time (G)
10131 Mapping usernames with the username map or username map script
10133 features of Samba can be relatively expensive. During login of a
10134 user, the mapping is done several times. In particular, calling the
10135 username map script can slow down logins if external databases have
10136 to be queried from the script being called.
10137 The parameter username map cache time controls a mapping cache. It
10139 specifies the number of seconds a mapping from the username map
10140 file or script is to be efficiently cached. The default of 0 means
10141 no caching is done.
10142 Default: username map cache time = 0
10144 Example: username map cache time = 60
10146 username map script (G)
10148 This script is a mutually exclusive alternative to the username map
10150 parameter. This parameter specifies an external program or script
10151 that must accept a single command line option (the username
10152 transmitted in the authentication request) and return a line on
10153 standard output (the name to which the account should mapped). In
10154 this way, it is possible to store username map tables in an LDAP
10155 directory services.
10156 Default: username map script =
10158 Example: username map script = /etc/samba/scripts/mapusers.sh
10160 usershare allow guests (G)
10162 This parameter controls whether user defined shares are allowed to
10164 be accessed by non-authenticated users or not. It is the equivalent
10165 of allowing people who can create a share the option of setting
10166 guest ok = yes in a share definition. Due to its security sensitive
10167 nature, the default is set to off.
10168 Default: usershare allow guests = no
10170 usershare max shares (G)
10172 This parameter specifies the number of user defined shares that are
10174 allowed to be created by users belonging to the group owning the
10175 usershare directory. If set to zero (the default) user defined
10176 shares are ignored.
10177 Default: usershare max shares = 0
10179 usershare owner only (G)
10181 This parameter controls whether the pathname exported by a user
10183 defined shares must be owned by the user creating the user defined
10184 share or not. If set to True (the default) then smbd checks that
10185 the directory path being shared is owned by the user who owns the
10186 usershare file defining this share and refuses to create the share
10187 if not. If set to False then no such check is performed and any
10188 directory path may be exported regardless of who owns it.
10189 Default: usershare owner only = yes
10191 usershare path (G)
10193 This parameter specifies the absolute path of the directory on the
10195 filesystem used to store the user defined share definition files.
10196 This directory must be owned by root, and have no access for other,
10197 and be writable only by the group owner. In addition the "sticky"
10198 bit must also be set, restricting rename and delete to owners of a
10199 file (in the same way the /tmp directory is usually configured).
10200 Members of the group owner of this directory are the users allowed
10201 to create usershares.
10202 For example, a valid usershare directory might be
10204 /usr/local/samba/lib/usershares, set up as follows.
10205 ls -ld /usr/local/samba/lib/usershares/
10207 drwxrwx--T 2 root power_users 4096 2006-05-05 12:27 /usr/local/samba/lib/usershares/
10208 In this case, only members of the group "power_users" can create
10211 user defined shares.
10212 Default: usershare path = /var/lib/samba/usershares
10214 usershare prefix allow list (G)
10216 This parameter specifies a list of absolute pathnames the root of
10218 which are allowed to be exported by user defined share definitions.
10219 If the pathname to be exported doesn't start with one of the
10220 strings in this list, the user defined share will not be allowed.
10221 This allows the Samba administrator to restrict the directories on
10222 the system that can be exported by user defined shares.
10223 If there is a "usershare prefix deny list" and also a "usershare
10225 prefix allow list" the deny list is processed first, followed by
10226 the allow list, thus leading to the most restrictive
10227 interpretation.
10228 Default: usershare prefix allow list =
10230 Example: usershare prefix allow list = /home /data /space
10232 usershare prefix deny list (G)
10234 This parameter specifies a list of absolute pathnames the root of
10236 which are NOT allowed to be exported by user defined share
10237 definitions. If the pathname exported starts with one of the
10238 strings in this list the user defined share will not be allowed.
10239 Any pathname not starting with one of these strings will be allowed
10240 to be exported as a usershare. This allows the Samba administrator
10241 to restrict the directories on the system that can be exported by
10242 user defined shares.
10243 If there is a "usershare prefix deny list" and also a "usershare
10245 prefix allow list" the deny list is processed first, followed by
10246 the allow list, thus leading to the most restrictive
10247 interpretation.
10248 Default: usershare prefix deny list =
10250 Example: usershare prefix deny list = /etc /dev /private
10252 usershare template share (G)
10254 User defined shares only have limited possible parameters such as
10256 path, guest ok, etc. This parameter allows usershares to "cloned"
10257 from an existing share. If "usershare template share" is set to the
10258 name of an existing share, then all usershares created have their
10259 defaults set from the parameters set on this share.
10260 The target share may be set to be invalid for real file sharing by
10262 setting the parameter "-valid = False" on the template share
10263 definition. This causes it not to be seen as a real exported share
10264 but to be able to be used as a template for usershares.
10265 Default: usershare template share =
10267 Example: usershare template share = template_share
10269 use sendfile (S)
10271 If this parameter is yes, and the sendfile() system call is
10273 supported by the underlying operating system, then some SMB read
10274 calls (mainly ReadAndX and ReadRaw) will use the more efficient
10275 sendfile system call for files that are exclusively oplocked. This
10276 may make more efficient use of the system CPU's and cause Samba to
10277 be faster. Samba automatically turns this off for clients that use
10278 protocol levels lower than NT LM 0.12 and when it detects a client
10279 is Windows 9x (using sendfile from Linux will cause these clients
10280 to fail).
10281 Default: use sendfile = no
10283 utmp (G)
10285 This boolean parameter is only available if Samba has been
10287 configured and compiled with the option --with-utmp. If set to yes
10288 then Samba will attempt to add utmp or utmpx records (depending on
10289 the UNIX system) whenever a connection is made to a Samba server.
10290 Sites may use this to record the user connecting to a Samba share.
10291 Due to the requirements of the utmp record, we are required to
10293 create a unique identifier for the incoming user. Enabling this
10294 option creates an n^2 algorithm to find this number. This may
10295 impede performance on large installations.
10296 Default: utmp = no
10298 utmp directory (G)
10300 This parameter is only available if Samba has been configured and
10302 compiled with the option --with-utmp. It specifies a directory
10303 pathname that is used to store the utmp or utmpx files (depending
10304 on the UNIX system) that record user connections to a Samba server.
10305 By default this is not set, meaning the system will use whatever
10306 utmp file the native system is set to use (usually /var/run/utmp on
10307 Linux).
10308 Default: utmp directory = # Determined automatically
10310 Example: utmp directory = /var/run/utmp
10312 -valid (S)
10314 This parameter indicates whether a share is valid and thus can be
10316 used. When this parameter is set to false, the share will be in no
10317 way visible nor accessible.
10318 This option should not be used by regular users but might be of
10320 help to developers. Samba uses this option internally to mark
10321 shares as deleted.
10322 Default: -valid = yes
10324 valid users (S)
10326 This is a list of users that should be allowed to login to this
10328 service. Names starting with '@', '+' and '&' are interpreted using
10329 the same rules as described in the invalid users parameter.
10330 If this is empty (the default) then any user can login. If a
10332 username is in both this list and the invalid users list then
10333 access is denied for that user.
10334 The current servicename is substituted for %S. This is useful in
10336 the [homes] section.
10337 Note: When used in the [global] section this parameter may have
10339 unwanted side effects. For example: If samba is configured as a
10340 MASTER BROWSER (see local master, os level, domain master,
10341 preferred master) this option will prevent workstations from being
10342 able to browse the network.
10343 Default: valid users = # No valid users list (anyone can login)
10345 Example: valid users = greg, @pcusers
10347 veto files (S)
10349 This is a list of files and directories that are neither visible
10351 nor accessible. Each entry in the list must be separated by a '/',
10352 which allows spaces to be included in the entry. '*' and '?' can be
10353 used to specify multiple files or directories as in DOS wildcards.
10354 Each entry must be a unix path, not a DOS path and must not include
10356 the unix directory separator '/'.
10357 Note that the case sensitive option is applicable in vetoing files.
10359 One feature of the veto files parameter that it is important to be
10361 aware of is Samba's behaviour when trying to delete a directory. If
10362 a directory that is to be deleted contains nothing but veto files
10363 this deletion will fail unless you also set the delete veto files
10364 parameter to yes.
10365 Setting this parameter will affect the performance of Samba, as it
10367 will be forced to check all files and directories for a match as
10368 they are scanned.
10369 Examples of use include:
10371 ; Veto any files containing the word Security,
10373 ; any ending in .tmp, and any directory containing the
10374 ; word root.
10375 veto files = /*Security*/*.tmp/*root*/
10376 ; Veto the Apple specific files that a NetAtalk server
10378 ; creates.
10379 veto files = /.AppleDouble/.bin/.AppleDesktop/Network Trash Folder/
10380 Default: veto files = # No files or directories are vetoed
10382 veto oplock files (S)
10384 This parameter is only valid when the oplocks parameter is turned
10386 on for a share. It allows the Samba administrator to selectively
10387 turn off the granting of oplocks on selected files that match a
10388 wildcarded list, similar to the wildcarded list used in the veto
10389 files parameter.
10390 You might want to do this on files that you know will be heavily
10392 contended for by clients. A good example of this is in the NetBench
10393 SMB benchmark program, which causes heavy client contention for
10394 files ending in .SEM. To cause Samba not to grant oplocks on these
10395 files you would use the line (either in the [global] section or in
10396 the section for the particular NetBench share.
10397 An example of use is:
10399 veto oplock files = /.*SEM/
10401 Default: veto oplock files = # No files are vetoed for oplock
10403 grants
10404 vfs object
10406 This parameter is a synonym for vfs objects.
10408 vfs objects (S)
10410 This parameter specifies the backend names which are used for Samba
10412 VFS I/O operations. By default, normal disk I/O operations are used
10413 but these can be overloaded with one or more VFS objects. Be aware
10414 that the definition of this parameter will overwrite a possible
10415 previous definition of the vfs objects parameter.
10416 Default: vfs objects =
10418 Example: vfs objects = extd_audit recycle
10420 volume (S)
10422 This allows you to override the volume label returned for a share.
10424 Useful for CDROMs with installation programs that insist on a
10425 particular volume label.
10426 Default: volume = # the name of the share
10428 volume serial number (S)
10430 This allows to override the volume serial number (a 32bit value)
10432 reported for a share.
10433 The special value -1 (default) stands for a unique number that is
10435 calculated for each share.
10436 Default: volume serial number = -1
10438 Example: volume serial number = 0xabcdefgh
10440 wide links (S)
10442 This parameter controls whether or not links in the UNIX file
10444 system may be followed by the server. Links that point to areas
10445 within the directory tree exported by the server are always
10446 allowed; this parameter controls access only to areas that are
10447 outside the directory tree being exported.
10448 Note: Turning this parameter on when UNIX extensions are enabled
10450 will allow UNIX clients to create symbolic links on the share that
10451 can point to files or directories outside restricted path exported
10452 by the share definition. This can cause access to areas outside of
10453 the share. Due to this problem, this parameter will be
10454 automatically disabled (with a message in the log file) if the unix
10455 extensions option is on.
10456 See the parameter allow insecure wide links if you wish to change
10458 this coupling between the two parameters.
10459 Default: wide links = no
10461 winbind cache time (G)
10463 This parameter specifies the number of seconds the winbindd(8)
10465 daemon will cache user and group information before querying a
10466 Windows NT server again.
10467 This does not apply to authentication requests, these are always
10469 evaluated in real time unless the winbind offline logon option has
10470 been enabled.
10471 Default: winbind cache time = 300
10473 winbindd socket directory (G)
10475 This setting controls the location of the winbind daemon's socket.
10477 Except within automated test scripts, this should not be altered,
10479 as the client tools (nss_winbind etc) do not honour this parameter.
10480 Client tools must then be advised of the altered path with the
10481 WINBINDD_SOCKET_DIR environment variable.
10482 Default: winbindd socket directory = /run/samba/winbindd
10484 winbind enum groups (G)
10486 On large installations using winbindd(8) it may be necessary to
10488 suppress the enumeration of groups through the setgrent(),
10489 getgrent() and endgrent() group of system calls. If the winbind
10490 enum groups parameter is no, calls to the getgrent() system call
10491 will not return any data.
10492 Warning
10494 Turning off group enumeration may cause some programs to behave
10495 oddly.
10496 Default: winbind enum groups = no
10497 winbind enum users (G)
10499 On large installations using winbindd(8) it may be necessary to
10501 suppress the enumeration of users through the setpwent(),
10502 getpwent() and endpwent() group of system calls. If the winbind
10503 enum users parameter is no, calls to the getpwent system call will
10504 not return any data.
10505 Warning
10507 Turning off user enumeration may cause some programs to behave
10508 oddly. For example, the finger program relies on having access
10509 to the full user list when searching for matching usernames.
10510 Default: winbind enum users = no
10511 winbind expand groups (G)
10513 This option controls the maximum depth that winbindd will traverse
10515 when flattening nested group memberships of Windows domain groups.
10516 This is different from the winbind nested groups option which
10517 implements the Windows NT4 model of local group nesting. The
10518 "winbind expand groups" parameter specifically applies to the
10519 membership of domain groups.
10520 This option also affects the return of non nested group memberships
10522 of Windows domain users. With the new default "winbind expand
10523 groups = 0" winbind does not query group memberships at all.
10524 Be aware that a high value for this parameter can result in system
10526 slowdown as the main parent winbindd daemon must perform the group
10527 unrolling and will be unable to answer incoming NSS or
10528 authentication requests during this time.
10529 The default value was changed from 1 to 0 with Samba 4.2. Some
10531 broken applications (including some implementations of newgrp and
10532 sg) calculate the group memberships of users by traversing groups,
10533 such applications will require "winbind expand groups = 1". But the
10534 new default makes winbindd more reliable as it doesn't require SAMR
10535 access to domain controllers of trusted domains.
10536 Default: winbind expand groups = 0
10538 winbind:ignore domains (G)
10540 Allows one to enter a list of trusted domains winbind should ignore
10542 (untrust). This can avoid the overhead of resources from attempting
10543 to login to DCs that should not be communicated with.
10544 Default: winbind:ignore domains =
10546 Example: winbind:ignore domains = DOMAIN1, DOMAIN2
10548 winbind max clients (G)
10550 This parameter specifies the maximum number of clients the
10552 winbindd(8) daemon can connect with. The parameter is not a hard
10553 limit. The winbindd(8) daemon configures itself to be able to
10554 accept at least that many connections, and if the limit is reached,
10555 an attempt is made to disconnect idle clients.
10556 Default: winbind max clients = 200
10558 winbind max domain connections (G)
10560 This parameter specifies the maximum number of simultaneous
10562 connections that the winbindd(8) daemon should open to the domain
10563 controller of one domain. Setting this parameter to a value greater
10564 than 1 can improve scalability with many simultaneous winbind
10565 requests, some of which might be slow.
10566 Note that if winbind offline logon is set to Yes, then only one DC
10568 connection is allowed per domain, regardless of this setting.
10569 Default: winbind max domain connections = 1
10571 Example: winbind max domain connections = 10
10573 winbind nested groups (G)
10575 If set to yes, this parameter activates the support for nested
10577 groups. Nested groups are also called local groups or aliases. They
10578 work like their counterparts in Windows: Nested groups are defined
10579 locally on any machine (they are shared between DC's through their
10580 SAM) and can contain users and global groups from any trusted SAM.
10581 To be able to use nested groups, you need to run nss_winbind.
10582 Default: winbind nested groups = yes
10584 winbind normalize names (G)
10586 This parameter controls whether winbindd will replace whitespace in
10588 user and group names with an underscore (_) character. For example,
10589 whether the name "Space Kadet" should be replaced with the string
10590 "space_kadet". Frequently Unix shell scripts will have difficulty
10591 with usernames contains whitespace due to the default field
10592 separator in the shell. If your domain possesses names containing
10593 the underscore character, this option may cause problems unless the
10594 name aliasing feature is supported by your nss_info plugin.
10595 This feature also enables the name aliasing API which can be used
10597 to make domain user and group names to a non-qualified version.
10598 Please refer to the manpage for the configured idmap and nss_info
10599 plugin for the specifics on how to configure name aliasing for a
10600 specific configuration. Name aliasing takes precedence (and is
10601 mutually exclusive) over the whitespace replacement mechanism
10602 discussed previously.
10603 Default: winbind normalize names = no
10605 Example: winbind normalize names = yes
10607 winbind nss info (G)
10609 This parameter is designed to control how Winbind retrieves Name
10611 Service Information to construct a user's home directory and login
10612 shell. Currently the following settings are available:
10613 • template - The default, using the parameters of template
10615 shell and template homedir)
10616 • <sfu | sfu20 | rfc2307 > - When Samba is running in
10618 security = ads and your Active Directory Domain
10619 Controller does support the Microsoft "Services for
10620 Unix" (SFU) LDAP schema, winbind can retrieve the login
10621 shell and the home directory attributes directly from
10622 your Directory Server. For SFU 3.0 or 3.5 simply choose
10623 "sfu", if you use SFU 2.0 please choose "sfu20".
10624 Note that for the idmap backend idmap_ad you need to
10626 configure those settings in the idmap configuration
10627 section. Make sure to consult the documentation of the
10628 idmap backend that you are using.
10629 Default: winbind nss info = template
10632 Example: winbind nss info = sfu
10634 winbind offline logon (G)
10636 This parameter is designed to control whether Winbind should allow
10638 one to login with the pam_winbind module using Cached Credentials.
10639 If enabled, winbindd will store user credentials from successful
10640 logins encrypted in a local cache.
10641 Default: winbind offline logon = no
10643 Example: winbind offline logon = yes
10645 winbind reconnect delay (G)
10647 This parameter specifies the number of seconds the winbindd(8)
10649 daemon will wait between attempts to contact a Domain controller
10650 for a domain that is determined to be down or not contactable.
10651 Default: winbind reconnect delay = 30
10653 winbind refresh tickets (G)
10655 This parameter is designed to control whether Winbind should
10657 refresh Kerberos Tickets retrieved using the pam_winbind module.
10658 Default: winbind refresh tickets = no
10660 Example: winbind refresh tickets = yes
10662 winbind request timeout (G)
10664 This parameter specifies the number of seconds the winbindd(8)
10666 daemon will wait before disconnecting either a client connection
10667 with no outstanding requests (idle) or a client connection with a
10668 request that has remained outstanding (hung) for longer than this
10669 number of seconds.
10670 Default: winbind request timeout = 60
10672 winbind rpc only (G)
10674 Setting this parameter to yes forces winbindd to use RPC instead of
10676 LDAP to retrieve information from Domain Controllers.
10677 Default: winbind rpc only = no
10679 winbind scan trusted domains (G)
10681 This option only takes effect when the security option is set to
10683 domain or ads. If it is set to yes, winbindd periodically tries to
10684 scan for new trusted domains and adds them to a global list inside
10685 of winbindd. The list can be extracted with wbinfo
10686 --trusted-domains --verbose. Setting it to yes matches the
10687 behaviour of Samba 4.7 and older.
10688 The construction of that global list is not reliable and often
10690 incomplete in complex trust setups. In most situations the list is
10691 not needed any more for winbindd to operate correctly. E.g. for
10692 plain file serving via SMB using a simple idmap setup with autorid,
10693 tdb or ad. However some more complex setups require the list, e.g.
10694 if you specify idmap backends for specific domains. Some
10695 pam_winbind setups may also require the global list.
10696 If you have a setup that doesn't require the global list, you
10698 should set winbind scan trusted domains = no.
10699 Default: winbind scan trusted domains = no
10701 winbind sealed pipes (G)
10703 This option controls whether any requests from winbindd to domain
10705 controllers pipe will be sealed. Disabling sealing can be useful
10706 for debugging purposes.
10707 The behavior can be controlled per netbios domain by using 'winbind
10709 sealed pipes:NETBIOSDOMAIN = no' as option.
10710 Default: winbind sealed pipes = yes
10712 winbind separator (G)
10714 This parameter allows an admin to define the character used when
10716 listing a username of the form of DOMAIN \user. This parameter is
10717 only applicable when using the pam_winbind.so and nss_winbind.so
10718 modules for UNIX services.
10719 Please note that setting this parameter to + causes problems with
10721 group membership at least on glibc systems, as the character + is
10722 used as a special character for NIS in /etc/group.
10723 Default: winbind separator = \
10725 Example: winbind separator = +
10727 winbind use default domain (G)
10729 This parameter specifies whether the winbindd(8) daemon should
10731 operate on users without domain component in their username. Users
10732 without a domain component are treated as is part of the winbindd
10733 server's own domain. While this does not benefit Windows users, it
10734 makes SSH, FTP and e-mail function in a way much closer to the way
10735 they would in a native unix system.
10736 This option should be avoided if possible. It can cause confusion
10738 about responsibilities for a user or group. In many situations it
10739 is not clear whether winbind or /etc/passwd should be seen as
10740 authoritative for a user, likewise for groups.
10741 Default: winbind use default domain = no
10743 Example: winbind use default domain = yes
10745 winbind use krb5 enterprise principals (G)
10747 winbindd is able to get kerberos tickets for pam_winbind with
10749 krb5_auth or wbinfo -K/--krb5auth=.
10750 winbindd (at least on a domain member) is never be able to have a
10752 complete picture of the trust topology (which is managed by the
10753 DCs). There might be uPNSuffixes and msDS-SPNSuffixes values, which
10754 don't belong to any AD domain at all.
10755 With winbind scan trusted domains = no winbindd doesn't even get a
10757 complete picture of the topology.
10758 It is not really required to know about the trust topology. We can
10760 just rely on the [K]DCs of our primary domain (e.g.
10761 PRIMARY.A.EXAMPLE.COM) and use enterprise principals e.g.
10762 upnfromB@B.EXAMPLE.COM@PRIMARY.A.EXAMPLE.COM and follow the
10763 WRONG_REALM referrals in order to find the correct DC. The final
10764 principal might be userfromB@INTERNALB.EXAMPLE.PRIVATE.
10765 With winbind use krb5 enterprise principals = yes winbindd
10767 enterprise principals will be used.
10768 Default: winbind use krb5 enterprise principals = yes
10770 Example: winbind use krb5 enterprise principals = no
10772 winsdb:local_owner (G)
10774 This specifies the address that is stored in the winsOwner
10776 attribute, of locally registered winsRecord-objects. The default is
10777 to use the ip-address of the first network interface.
10778 No default
10780 winsdb:dbnosync (G)
10782 This parameter disables fsync() after changes of the WINS database.
10784 Default: winsdb:dbnosync = no
10786 wins hook (G)
10788 When Samba is running as a WINS server this allows you to call an
10790 external program for all changes to the WINS database. The primary
10791 use for this option is to allow the dynamic update of external name
10792 resolution databases such as dynamic DNS.
10793 The wins hook parameter specifies the name of a script or
10795 executable that will be called as follows:
10796 wins_hook operation name nametype ttl IP_list
10798 • The first argument is the operation and is one of "add",
10800 "delete", or "refresh". In most cases the operation can
10801 be ignored as the rest of the parameters provide
10802 sufficient information. Note that "refresh" may
10803 sometimes be called when the name has not previously
10804 been added, in that case it should be treated as an add.
10805 • The second argument is the NetBIOS name. If the name is
10807 not a legal name then the wins hook is not called. Legal
10808 names contain only letters, digits, hyphens, underscores
10809 and periods.
10810 • The third argument is the NetBIOS name type as a 2 digit
10812 hexadecimal number.
10813 • The fourth argument is the TTL (time to live) for the
10815 name in seconds.
10816 • The fifth and subsequent arguments are the IP addresses
10818 currently registered for that name. If this list is
10819 empty then the name should be deleted.
10820 An example script that calls the BIND dynamic DNS update program
10822 nsupdate is provided in the examples directory of the Samba source
10823 code.
10824 No default
10826 wins proxy (G)
10828 This is a boolean that controls if nmbd(8) will respond to
10830 broadcast name queries on behalf of other hosts. You may need to
10831 set this to yes for some older clients.
10832 Default: wins proxy = no
10834 wins server (G)
10836 This specifies the IP address (or DNS name: IP address for
10838 preference) of the WINS server that nmbd(8) should register with.
10839 If you have a WINS server on your network then you should set this
10840 to the WINS server's IP.
10841 You should point this at your WINS server if you have a
10843 multi-subnetted network.
10844 If you want to work in multiple namespaces, you can give every wins
10846 server a 'tag'. For each tag, only one (working) server will be
10847 queried for a name. The tag should be separated from the ip address
10848 by a colon.
10849 Note
10851 You need to set up Samba to point to a WINS server if you have
10852 multiple subnets and wish cross-subnet browsing to work
10853 correctly.
10854 See the chapter in the Samba3-HOWTO on Network Browsing.
10855 Default: wins server =
10857 Example: wins server = mary:192.9.200.1 fred:192.168.3.199
10859 mary:192.168.2.61 # For this example when querying a certain name,
10860 192.19.200.1 will be asked first and if that doesn't respond
10861 192.168.2.61. If either of those doesn't know the name
10862 192.168.3.199 will be queried.
10863 Example: wins server = 192.9.200.1 192.168.2.61
10865 wins support (G)
10867 This boolean controls if the nmbd(8) process in Samba will act as a
10869 WINS server. You should not set this to yes unless you have a
10870 multi-subnetted network and you wish a particular nmbd to be your
10871 WINS server. Note that you should NEVER set this to yes on more
10872 than one machine in your network.
10873 Default: wins support = no
10875 workgroup (G)
10877 This controls what workgroup your server will appear to be in when
10879 queried by clients. Note that this parameter also controls the
10880 Domain name used with the security = domain setting.
10881 Default: workgroup = WORKGROUP
10883 Example: workgroup = MYGROUP
10885 wreplsrv:periodic_interval (G)
10887 This maximum interval in seconds between 2 periodically scheduled
10889 runs where we check for wins.ldb changes and do push notifications
10890 to our push partners. Also wins_config.ldb changes are checked in
10891 that interval and partner configuration reloads are done.
10892 Default: wreplsrv:periodic_interval = 15
10894 wreplsrv:propagate name releases (G)
10896 If this parameter is enabled, then explicit (from the client) and
10898 implicit (via the scavenging) name releases are propagated to the
10899 other servers directly, even if there are still other addresses
10900 active, this applies to SPECIAL GROUP (2) and MULTIHOMED (3)
10901 entries. Also the replication conflict merge algorithm for SPECIAL
10902 GROUP (2) entries discards replica addresses where the address
10903 owner is the local server, if the address was not stored locally
10904 before. The merge result is propagated directly in case an address
10905 was discarded. A Windows servers doesn't propagate name releases of
10906 SPECIAL GROUP (2) and MULTIHOMED (3) entries directly, which means
10907 that Windows servers may return different results to name queries
10908 for SPECIAL GROUP (2) and MULTIHOMED (3) names. The option doesn't
10909 have much negative impact if Windows servers are around, but be
10910 aware that they might return unexpected results.
10911 Default: wreplsrv:propagate name releases = no
10913 wreplsrv:scavenging_interval (G)
10915 This is the interval in s between 2 scavenging runs which clean up
10917 the WINS database and changes the states of expired name records.
10918 Defaults to half of the value of wreplsrv:renew_interval.
10919 No default
10921 wreplsrv:tombstone_extra_timeout (G)
10923 This is the time in s the server needs to be up till we'll remove
10925 tombstone records from our database. Defaults to 3 days.
10926 Default: wreplsrv:tombstone_extra_timeout = 259200
10928 wreplsrv:tombstone_interval (G)
10930 This is the interval in s till released records of the WINS server
10932 become tombstone. Defaults to 6 days.
10933 Default: wreplsrv:tombstone_interval = 518400
10935 wreplsrv:tombstone_timeout (G)
10937 This is the interval in s till tombstone records are deleted from
10939 the WINS database. Defaults to 1 day.
10940 Default: wreplsrv:tombstone_timeout = 86400
10942 wreplsrv:verify_interval (G)
10944 This is the interval in s till we verify active replica records
10946 with the owning WINS server. Unfortunately not implemented yet.
10947 Defaults to 24 days.
10948 Default: wreplsrv:verify_interval = 2073600
10950 writable
10952 This parameter is a synonym for writeable.
10954 write ok
10956 This parameter is a synonym for writeable.
10958 writeable (S)
10960 Inverted synonym for read only.
10962 Default: writeable = no
10964 write list (S)
10966 This is a list of users that are given read-write access to a
10968 service. If the connecting user is in this list then they will be
10969 given write access, no matter what the read only option is set to.
10970 The list can include group names using the @group syntax.
10971 Note that if a user is in both the read list and the write list
10973 then they will be given write access.
10974 Default: write list =
10976 Example: write list = admin, root, @staff
10978 write raw (G)
10980 This is ignored if async smb echo handler is set, because this
10982 feature is incompatible with raw write SMB requests
10983 If enabled, raw writes allow writes of 65535 bytes in one packet.
10985 This typically provides a major performance benefit for some very,
10986 very old clients.
10987 However, some clients either negotiate the allowable block size
10989 incorrectly or are incapable of supporting larger block sizes, and
10990 for these clients you may need to disable raw writes.
10991 In general this parameter should be viewed as a system tuning tool
10993 and left severely alone.
10994 Default: write raw = yes
10996 wtmp directory (G)
10998 This parameter is only available if Samba has been configured and
11000 compiled with the option --with-utmp. It specifies a directory
11001 pathname that is used to store the wtmp or wtmpx files (depending
11002 on the UNIX system) that record user connections to a Samba server.
11003 The difference with the utmp directory is the fact that user info
11004 is kept after a user has logged out.
11005 By default this is not set, meaning the system will use whatever
11007 utmp file the native system is set to use (usually /var/run/wtmp on
11008 Linux).
11009 Default: wtmp directory =
11011 Example: wtmp directory = /var/log/wtmp
11013
11015 Although the configuration file permits service names to contain
11016 spaces, your client software may not. Spaces will be ignored in
11017 comparisons anyway, so it shouldn't be a problem - but be aware of the
11018 possibility.
11019 On a similar note, many clients - especially DOS clients - limit
11021 service names to eight characters. smbd(8) has no such limitation, but
11022 attempts to connect from such clients will fail if they truncate the
11023 service names. For this reason you should probably keep your service
11024 names down to eight characters in length.
11025 Use of the [homes] and [printers] special sections make life for an
11027 administrator easy, but the various combinations of default attributes
11028 can be tricky. Take extreme care when designing these sections. In
11029 particular, ensure that the permissions on spool directories are
11030 correct.
11031
11033 This man page is part of version 4.19.3 of the Samba suite.
11034
11036 samba(7), smbpasswd(8), smbd(8), nmbd(8), winbindd(8), samba(8), samba-
11037 tool(8), smbclient(1), nmblookup(1), testparm(1).
11038
11040 The original Samba software and related utilities were created by
11041 Andrew Tridgell. Samba is now developed by the Samba Team as an Open
11042 Source project similar to the way the Linux kernel is developed.
11043Samba 4.19.3 11/27/2023 SMB.CONF(5)