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 = /usr/spool/public
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 = /usr/spool/public
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 add group script (G)
744 This is the full pathname to a script that will be run AS ROOT by
746 smbd(8) when a new group is requested. It will expand any %g to the
747 group name passed. This script is only useful for installations
748 using the Windows NT domain administration tools. The script is
749 free to create a group with an arbitrary name to circumvent unix
750 group name restrictions. In that case the script must print the
751 numeric gid of the created group on stdout.
752 Default: add group script =
754 Example: add group script = /usr/sbin/groupadd %g
756 additional dns hostnames (G)
758 A list of additional DNS names by which this host can be identified
760 Default: additional dns hostnames = # empty string (no additional
762 dns names)
763 Example: additional dns hostnames = host2.example.com
765 host3.other.com
766 add machine script (G)
768 This is the full pathname to a script that will be run by smbd(8)
770 when a machine is added to Samba's domain and a Unix account
771 matching the machine's name appended with a "$" does not already
772 exist.
773 This option is very similar to the add user script, and likewise
775 uses the %u substitution for the account name. Do not use the %m
776 substitution.
777 Default: add machine script =
779 Example: add machine script = /usr/sbin/adduser -n -g machines -c
781 Machine -d /var/lib/nobody -s /bin/false %u
782 addport command (G)
784 Samba 3.0.23 introduced support for adding printer ports remotely
786 using the Windows "Add Standard TCP/IP Port Wizard". This option
787 defines an external program to be executed when smbd receives a
788 request to add a new Port to the system. The script is passed two
789 parameters:
790 • port name
792 • device URI
794 The deviceURI is in the format of
796 socket://<hostname>[:<portnumber>] or lpd://<hostname>/<queuename>.
797 Default: addport command =
799 Example: addport command = /etc/samba/scripts/addport.sh
801 addprinter command (G)
803 With the introduction of MS-RPC based printing support for Windows
805 NT/2000 clients in Samba 2.2, The MS Add Printer Wizard (APW) icon
806 is now also available in the "Printers..." folder displayed a share
807 listing. The APW allows for printers to be add remotely to a Samba
808 or Windows NT/2000 print server.
809 For a Samba host this means that the printer must be physically
811 added to the underlying printing system. The addprinter command
812 defines a script to be run which will perform the necessary
813 operations for adding the printer to the print system and to add
814 the appropriate service definition to the smb.conf file in order
815 that it can be shared by smbd(8).
816 The addprinter command is automatically invoked with the following
818 parameter (in order):
819 • printer name
821 • share name
823 • port name
825 • driver name
827 • location
829 • Windows 9x driver location
831 All parameters are filled in from the PRINTER_INFO_2 structure sent
833 by the Windows NT/2000 client with one exception. The "Windows 9x
834 driver location" parameter is included for backwards compatibility
835 only. The remaining fields in the structure are generated from
836 answers to the APW questions.
837 Once the addprinter command has been executed, smbd will reparse
839 the smb.conf to determine if the share defined by the APW exists.
840 If the sharename is still invalid, then smbd will return an
841 ACCESS_DENIED error to the client.
842 The addprinter command program can output a single line of text,
844 which Samba will set as the port the new printer is connected to.
845 If this line isn't output, Samba won't reload its printer shares.
846 Default: addprinter command =
848 Example: addprinter command = /usr/bin/addprinter
850 add share command (G)
852 Samba 2.2.0 introduced the ability to dynamically add and delete
854 shares via the Windows NT 4.0 Server Manager. The add share command
855 is used to define an external program or script which will add a
856 new service definition to smb.conf.
857 In order to successfully execute the add share command, smbd
859 requires that the administrator connects using a root account (i.e.
860 uid == 0) or has the SeDiskOperatorPrivilege. Scripts defined in
861 the add share command parameter are executed as root.
862 When executed, smbd will automatically invoke the add share command
864 with five parameters.
865 • configFile - the location of the global smb.conf file.
867 • shareName - the name of the new share.
869 • pathName - path to an **existing** directory on disk.
871 • comment - comment string to associate with the new
873 share.
874 • max connections Number of maximum simultaneous
876 connections to this share.
877 This parameter is only used to add file shares. To add printer
879 shares, see the addprinter command.
880 Default: add share command =
882 Example: add share command = /usr/local/bin/addshare
884 add user script (G)
886 This is the full pathname to a script that will be run AS ROOT by
888 smbd(8) under special circumstances described below.
889 Normally, a Samba server requires that UNIX users are created for
891 all users accessing files on this server. For sites that use
892 Windows NT account databases as their primary user database
893 creating these users and keeping the user list in sync with the
894 Windows NT PDC is an onerous task. This option allows smbd to
895 create the required UNIX users ON DEMAND when a user accesses the
896 Samba server.
897 When the Windows user attempts to access the Samba server, at login
899 (session setup in the SMB protocol) time, smbd(8) contacts the
900 password server and attempts to authenticate the given user with
901 the given password. If the authentication succeeds then smbd
902 attempts to find a UNIX user in the UNIX password database to map
903 the Windows user into. If this lookup fails, and add user script is
904 set then smbd will call the specified script AS ROOT, expanding any
905 %u argument to be the user name to create.
906 If this script successfully creates the user then smbd will
908 continue on as though the UNIX user already existed. In this way,
909 UNIX users are dynamically created to match existing Windows NT
910 accounts.
911 See also security, password server, delete user script.
913 Default: add user script =
915 Example: add user script = /usr/local/samba/bin/add_user %u
917 add user to group script (G)
919 Full path to the script that will be called when a user is added to
921 a group using the Windows NT domain administration tools. It will
922 be run by smbd(8) AS ROOT. Any %g will be replaced with the group
923 name and any %u will be replaced with the user name.
924 Note that the adduser command used in the example below does not
926 support the used syntax on all systems.
927 Default: add user to group script =
929 Example: add user to group script = /usr/sbin/adduser %u %g
931 administrative share (S)
933 If this parameter is set to yes for a share, then the share will be
935 an administrative share. The Administrative Shares are the default
936 network shares created by all Windows NT-based operating systems.
937 These are shares like C$, D$ or ADMIN$. The type of these shares is
938 STYPE_DISKTREE_HIDDEN.
939 See the section below on security for more information about this
941 option.
942 Default: administrative share = no
944 admin users (S)
946 This is a list of users who will be granted administrative
948 privileges on the share. This means that they will do all file
949 operations as the super-user (root).
950 You should use this option very carefully, as any user in this list
952 will be able to do anything they like on the share, irrespective of
953 file permissions.
954 Default: admin users =
956 Example: admin users = jason
958 afs share (S)
960 This parameter controls whether special AFS features are enabled
962 for this share. If enabled, it assumes that the directory exported
963 via the path parameter is a local AFS import. The special AFS
964 features include the attempt to hand-craft an AFS token if you
965 enabled --with-fake-kaserver in configure.
966 Default: afs share = no
968 afs token lifetime (G)
970 This parameter controls the lifetime of tokens that the AFS
972 fake-kaserver claims. In reality these never expire but this
973 lifetime controls when the afs client will forget the token.
974 Set this parameter to 0 to get NEVERDATE.
976 Default: afs token lifetime = 604800
978 afs username map (G)
980 If you are using the fake kaserver AFS feature, you might want to
982 hand-craft the usernames you are creating tokens for. For example
983 this is necessary if you have users from several domain in your AFS
984 Protection Database. One possible scheme to code users as
985 DOMAIN+User as it is done by winbind with the + as a separator.
986 The mapped user name must contain the cell name to log into, so
988 without setting this parameter there will be no token.
989 Default: afs username map =
991 Example: afs username map = %u@afs.samba.org
993 aio max threads (G)
995 The integer parameter specifies the maximum number of threads each
997 smbd process will create when doing parallel asynchronous IO calls.
998 If the number of outstanding calls is greater than this number the
999 requests will not be refused but go onto a queue and will be
1000 scheduled in turn as outstanding requests complete.
1001 Related command: aio read size
1003 Related command: aio write size
1005 Default: aio max threads = 100
1007 aio read size (S)
1009 If this integer parameter is set to a non-zero value, Samba will
1011 read from files asynchronously when the request size is bigger than
1012 this value. Note that it happens only for non-chained and
1013 non-chaining reads and when not using write cache.
1014 The only reasonable values for this parameter are 0 (no async I/O)
1016 and 1 (always do async I/O).
1017 Related command: write cache size
1019 Related command: aio write size
1021 Default: aio read size = 1
1023 Example: aio read size = 0 # Always do reads synchronously
1025 aio write behind (S)
1027 If Samba has been built with asynchronous I/O support, Samba will
1029 not wait until write requests are finished before returning the
1030 result to the client for files listed in this parameter. Instead,
1031 Samba will immediately return that the write request has been
1032 finished successfully, no matter if the operation will succeed or
1033 not. This might speed up clients without aio support, but is really
1034 dangerous, because data could be lost and files could be damaged.
1035 The syntax is identical to the veto files parameter.
1037 Default: aio write behind =
1039 Example: aio write behind = /*.tmp/
1041 aio write size (S)
1043 If this integer parameter is set to a non-zero value, Samba will
1045 write to files asynchronously when the request size is bigger than
1046 this value. Note that it happens only for non-chained and
1047 non-chaining reads and when not using write cache.
1048 The only reasonable values for this parameter are 0 (no async I/O)
1050 and 1 (always do async I/O).
1051 Compared to aio read size this parameter has a smaller effect, most
1053 writes should end up in the file system cache. Writes that require
1054 space allocation might benefit most from going asynchronous.
1055 Related command: write cache size
1057 Related command: aio read size
1059 Default: aio write size = 1
1061 Example: aio write size = 0 # Always do writes synchronously
1063 algorithmic rid base (G)
1065 This determines how Samba will use its algorithmic mapping from
1067 uids/gid to the RIDs needed to construct NT Security Identifiers.
1068 Setting this option to a larger value could be useful to sites
1070 transitioning from WinNT and Win2k, as existing user and group rids
1071 would otherwise clash with system users etc.
1072 All UIDs and GIDs must be able to be resolved into SIDs for the
1074 correct operation of ACLs on the server. As such the algorithmic
1075 mapping can't be 'turned off', but pushing it 'out of the way'
1076 should resolve the issues. Users and groups can then be assigned
1077 'low' RIDs in arbitrary-rid supporting backends.
1078 Default: algorithmic rid base = 1000
1080 Example: algorithmic rid base = 100000
1082 allocation roundup size (S)
1084 This parameter allows an administrator to tune the allocation size
1086 reported to Windows clients. This is only useful for old SMB1
1087 clients because modern SMB dialects eliminated that bottleneck and
1088 have better performance by default. Using this parameter may cause
1089 difficulties for some applications, e.g. MS Visual Studio. If the
1090 MS Visual Studio compiler starts to crash with an internal error,
1091 set this parameter to zero for this share. Settings this parameter
1092 to a large value can also cause small files to allocate more space
1093 on the disk than needed.
1094 This parameter is deprecated and will be removed in one of the next
1096 Samba releases.
1097 The integer parameter specifies the roundup size in bytes.
1099 Default: allocation roundup size = 0
1101 Example: allocation roundup size = 1048576 # (to set it to the
1103 former default of 1 MiB)
1104 allow dcerpc auth level connect (G)
1106 This option controls whether DCERPC services are allowed to be used
1108 with DCERPC_AUTH_LEVEL_CONNECT, which provides authentication, but
1109 no per message integrity nor privacy protection.
1110 Some interfaces like samr, lsarpc and netlogon have a hard-coded
1112 default of no and epmapper, mgmt and rpcecho have a hard-coded
1113 default of yes.
1114 The behavior can be overwritten per interface name (e.g. lsarpc,
1116 netlogon, samr, srvsvc, winreg, wkssvc ...) by using 'allow dcerpc
1117 auth level connect:interface = yes' as option.
1118 This option yields precedence to the implementation specific
1120 restrictions. E.g. the drsuapi and backupkey protocols require
1121 DCERPC_AUTH_LEVEL_PRIVACY. The dnsserver protocol requires
1122 DCERPC_AUTH_LEVEL_INTEGRITY.
1123 Default: allow dcerpc auth level connect = no
1125 Example: allow dcerpc auth level connect = yes
1127 allow dns updates (G)
1129 This option determines what kind of updates to the DNS are allowed.
1131 DNS updates can either be disallowed completely by setting it to
1133 disabled, enabled over secure connections only by setting it to
1134 secure only or allowed in all cases by setting it to nonsecure.
1135 Default: allow dns updates = secure only
1137 Example: allow dns updates = disabled
1139 allow insecure wide links (G)
1141 In normal operation the option wide links which allows the server
1143 to follow symlinks outside of a share path is automatically
1144 disabled when unix extensions are enabled on a Samba server. This
1145 is done for security purposes to prevent UNIX clients creating
1146 symlinks to areas of the server file system that the administrator
1147 does not wish to export.
1148 Setting allow insecure wide links to true disables the link between
1150 these two parameters, removing this protection and allowing a site
1151 to configure the server to follow symlinks (by setting wide links
1152 to "true") even when unix extensions is turned on.
1153 It is not recommended to enable this option unless you fully
1155 understand the implications of allowing the server to follow
1156 symbolic links created by UNIX clients. For most normal Samba
1157 configurations this would be considered a security hole and setting
1158 this parameter is not recommended.
1159 This option was added at the request of sites who had deliberately
1161 set Samba up in this way and needed to continue supporting this
1162 functionality without having to patch the Samba code.
1163 Default: allow insecure wide links = no
1165 allow nt4 crypto (G)
1167 This option controls whether the netlogon server (currently only in
1169 'active directory domain controller' mode), will reject clients
1170 which does not support NETLOGON_NEG_STRONG_KEYS nor
1171 NETLOGON_NEG_SUPPORTS_AES.
1172 This option was added with Samba 4.2.0. It may lock out clients
1174 which worked fine with Samba versions up to 4.1.x. as the effective
1175 default was "yes" there, while it is "no" now.
1176 If you have clients without RequireStrongKey = 1 in the registry,
1178 you may need to set "allow nt4 crypto = yes", until you have fixed
1179 all clients.
1180 "allow nt4 crypto = yes" allows weak crypto to be negotiated, maybe
1182 via downgrade attacks.
1183 This option yields precedence to the 'reject md5 clients' option.
1185 Default: allow nt4 crypto = no
1187 allow trusted domains (G)
1189 This option only takes effect when the security option is set to
1191 server, domain or ads. If it is set to no, then attempts to connect
1192 to a resource from a domain or workgroup other than the one which
1193 smbd is running in will fail, even if that domain is trusted by the
1194 remote server doing the authentication.
1195 This is useful if you only want your Samba server to serve
1197 resources to users in the domain it is a member of. As an example,
1198 suppose that there are two domains DOMA and DOMB. DOMB is trusted
1199 by DOMA, which contains the Samba server. Under normal
1200 circumstances, a user with an account in DOMB can then access the
1201 resources of a UNIX account with the same account name on the Samba
1202 server even if they do not have an account in DOMA. This can make
1203 implementing a security boundary difficult.
1204 Default: allow trusted domains = yes
1206 allow unsafe cluster upgrade (G)
1208 If set to no (the default), smbd checks at startup if other smbd
1210 versions are running in the cluster and refuses to start if so.
1211 This is done to protect data corruption in internal data structures
1212 due to incompatible Samba versions running concurrently in the same
1213 cluster. Setting this parameter to yes disables this safety check.
1214 Default: allow unsafe cluster upgrade = no
1216 apply group policies (G)
1218 This option controls whether winbind will execute the gpupdate
1220 command defined in gpo update command on the Group Policy update
1221 interval. The Group Policy update interval is defined as every 90
1222 minutes, plus a random offset between 0 and 30 minutes. This
1223 applies Group Policy Machine polices to the client or KDC and
1224 machine policies to a server.
1225 Default: apply group policies = no
1227 Example: apply group policies = yes
1229 async dns timeout (G)
1231 The number of seconds the asynchronous DNS resolver code in Samba
1233 will wait for responses. Some of the Samba client library code uses
1234 internal asynchronous DNS resolution for A and AAAA records when
1235 trying to find Active Directory Domain controllers. This value
1236 prevents this name resolution code from waiting for DNS server
1237 timeouts.
1238 The minimum value of this parameter is clamped at 1 second.
1240 Default: async dns timeout = 10
1242 Example: async dns timeout = 20
1244 async smb echo handler (G)
1246 This parameter specifies whether Samba should fork the async smb
1248 echo handler. It can be beneficial if your file system can block
1249 syscalls for a very long time. In some circumstances, it prolongs
1250 the timeout that Windows uses to determine whether a connection is
1251 dead. This parameter is only for SMB1. For SMB2 and above TCP
1252 keepalives can be used instead.
1253 Default: async smb echo handler = no
1255 auth event notification (G)
1257 When enabled, this option causes Samba (acting as an Active
1259 Directory Domain Controller) to stream authentication events across
1260 the internal message bus. Scripts built using Samba's python
1261 bindings can listen to these events by registering as the service
1262 auth_event.
1263 This is not needed for the audit logging described in log level.
1265 Instead, this should instead be considered a developer option (it
1267 assists in the Samba testsuite) rather than a facility for external
1268 auditing, as message delivery is not guaranteed (a feature that the
1269 testsuite works around).
1270 The authentication events are also logged via the normal logging
1272 methods when the log level is set appropriately, say to
1273 auth_json_audit:3.
1274 Default: auth event notification = no
1276 preload
1278 This parameter is a synonym for auto services.
1280 auto services (G)
1282 This is a list of services that you want to be automatically added
1284 to the browse lists. This is most useful for homes and printers
1285 services that would otherwise not be visible.
1286 Note that if you just want all printers in your printcap file
1288 loaded then the load printers option is easier.
1289 Default: auto services =
1291 Example: auto services = fred lp colorlp
1293 available (S)
1295 This parameter lets you "turn off" a service. If available = no,
1297 then ALL attempts to connect to the service will fail. Such
1298 failures are logged.
1299 Default: available = yes
1301 bind dns directory
1303 This parameter is a synonym for binddns dir.
1305 binddns dir (G)
1307 This parameters defines the directory samba will use to store the
1309 configuration files for bind, such as named.conf. NOTE: The bind
1310 dns directory needs to be on the same mount point as the private
1311 directory!
1312 Default: binddns dir = /var/lib/samba/bind-dns
1314 bind interfaces only (G)
1316 This global parameter allows the Samba admin to limit what
1318 interfaces on a machine will serve SMB requests. It affects file
1319 service smbd(8) and name service nmbd(8) in a slightly different
1320 ways.
1321 For name service it causes nmbd to bind to ports 137 and 138 on the
1323 interfaces listed in the interfaces parameter. nmbd also binds to
1324 the "all addresses" interface (0.0.0.0) on ports 137 and 138 for
1325 the purposes of reading broadcast messages. If this option is not
1326 set then nmbd will service name requests on all of these sockets.
1327 If bind interfaces only is set then nmbd will check the source
1328 address of any packets coming in on the broadcast sockets and
1329 discard any that don't match the broadcast addresses of the
1330 interfaces in the interfaces parameter list. As unicast packets are
1331 received on the other sockets it allows nmbd to refuse to serve
1332 names to machines that send packets that arrive through any
1333 interfaces not listed in the interfaces list. IP Source address
1334 spoofing does defeat this simple check, however, so it must not be
1335 used seriously as a security feature for nmbd.
1336 For file service it causes smbd(8) to bind only to the interface
1338 list given in the interfaces parameter. This restricts the networks
1339 that smbd will serve, to packets coming in on those interfaces.
1340 Note that you should not use this parameter for machines that are
1341 serving PPP or other intermittent or non-broadcast network
1342 interfaces as it will not cope with non-permanent interfaces.
1343 If bind interfaces only is set and the network address 127.0.0.1 is
1345 not added to the interfaces parameter list smbpasswd(8) may not
1346 work as expected due to the reasons covered below.
1347 To change a users SMB password, the smbpasswd by default connects
1349 to the localhost - 127.0.0.1 address as an SMB client to issue the
1350 password change request. If bind interfaces only is set then unless
1351 the network address 127.0.0.1 is added to the interfaces parameter
1352 list then smbpasswd will fail to connect in it's default mode.
1353 smbpasswd can be forced to use the primary IP interface of the
1354 local host by using its smbpasswd(8) -r remote machine parameter,
1355 with remote machine set to the IP name of the primary interface of
1356 the local host.
1357 Default: bind interfaces only = no
1359 blocking locks (S)
1361 This parameter controls the behavior of smbd(8) when given a
1363 request by a client to obtain a byte range lock on a region of an
1364 open file, and the request has a time limit associated with it.
1365 If this parameter is set and the lock range requested cannot be
1367 immediately satisfied, samba will internally queue the lock
1368 request, and periodically attempt to obtain the lock until the
1369 timeout period expires.
1370 If this parameter is set to no, then samba will behave as previous
1372 versions of Samba would and will fail the lock request immediately
1373 if the lock range cannot be obtained.
1374 Default: blocking locks = yes
1376 block size (S)
1378 This parameter controls the behavior of smbd(8) when reporting disk
1380 free sizes. By default, this reports a disk block size of 1024
1381 bytes.
1382 Changing this parameter may have some effect on the efficiency of
1384 client writes, this is not yet confirmed. This parameter was added
1385 to allow advanced administrators to change it (usually to a higher
1386 value) and test the effect it has on client write performance
1387 without re-compiling the code. As this is an experimental option it
1388 may be removed in a future release.
1389 Changing this option does not change the disk free reporting size,
1391 just the block size unit reported to the client.
1392 Default: block size = 1024
1394 Example: block size = 4096
1396 browsable
1398 This parameter is a synonym for browseable.
1400 browseable (S)
1402 This controls whether this share is seen in the list of available
1404 shares in a net view and in the browse list.
1405 Default: browseable = yes
1407 browse list (G)
1409 This controls whether smbd(8) will serve a browse list to a client
1411 doing a NetServerEnum call. Normally set to yes. You should never
1412 need to change this.
1413 Default: browse list = yes
1415 cache directory (G)
1417 Usually, most of the TDB files are stored in the lock directory.
1419 Since Samba 3.4.0, it is possible to differentiate between TDB
1420 files with persistent data and TDB files with non-persistent data
1421 using the state directory and the cache directory options.
1422 This option specifies the directory for storing TDB files
1424 containing non-persistent data that will be kept across service
1425 restarts. The directory should be placed on persistent storage, but
1426 the data can be safely deleted by an administrator.
1427 Default: cache directory = /var/lib/samba
1429 Example: cache directory = /var/run/samba/locks/cache
1431 casesignames
1433 This parameter is a synonym for case sensitive.
1435 case sensitive (S)
1437 See the discussion in the section name mangling.
1439 Default: case sensitive = auto
1441 change notify (G)
1443 This parameter specifies whether Samba should reply to a client's
1445 file change notify requests.
1446 You should never need to change this parameter
1448 Default: change notify = yes
1450 change share command (G)
1452 Samba 2.2.0 introduced the ability to dynamically add and delete
1454 shares via the Windows NT 4.0 Server Manager. The change share
1455 command is used to define an external program or script which will
1456 modify an existing service definition in smb.conf.
1457 In order to successfully execute the change share command, smbd
1459 requires that the administrator connects using a root account (i.e.
1460 uid == 0) or has the SeDiskOperatorPrivilege. Scripts defined in
1461 the change share command parameter are executed as root.
1462 When executed, smbd will automatically invoke the change share
1464 command with six parameters.
1465 • configFile - the location of the global smb.conf file.
1467 • shareName - the name of the new share.
1469 • pathName - path to an **existing** directory on disk.
1471 • comment - comment string to associate with the new
1473 share.
1474 • max connections Number of maximum simultaneous
1476 connections to this share.
1477 • CSC policy - client side caching policy in string form.
1479 Valid values are: manual, documents, programs, disable.
1480 This parameter is only used to modify existing file share
1482 definitions. To modify printer shares, use the "Printers..." folder
1483 as seen when browsing the Samba host.
1484 Default: change share command =
1486 Example: change share command = /usr/local/bin/changeshare
1488 check parent directory delete on close (S)
1490 A Windows SMB server prevents the client from creating files in a
1492 directory that has the delete-on-close flag set. By default Samba
1493 doesn't perform this check as this check is a quite expensive
1494 operation in Samba.
1495 Default: check parent directory delete on close = no
1497 check password script (G)
1499 The name of a program that can be used to check password
1501 complexity. The password is sent to the program's standard input.
1502 The program must return 0 on a good password, or any other value if
1504 the password is bad. In case the password is considered weak (the
1505 program does not return 0) the user will be notified and the
1506 password change will fail.
1507 In Samba AD, this script will be run AS ROOT by samba(8) without
1509 any substitutions.
1510 Note that starting with Samba 4.11 the following environment
1512 variables are exported to the script:
1513 • SAMBA_CPS_ACCOUNT_NAME is always present and contains
1515 the sAMAccountName of user, the is the same as the %u
1516 substitutions in the none AD DC case.
1517 • SAMBA_CPS_USER_PRINCIPAL_NAME is optional in the AD DC
1519 case if the userPrincipalName is present.
1520 • SAMBA_CPS_FULL_NAME is optional if the displayName is
1522 present.
1523 Note: In the example directory is a sample program called
1525 crackcheck that uses cracklib to check the password quality.
1526 Default: check password script = # Disabled
1528 Example: check password script = /usr/local/sbin/crackcheck
1530 cldap port (G)
1532 This option controls the port used by the CLDAP protocol.
1534 Default: cldap port = 389
1536 Example: cldap port = 3389
1538 client ipc max protocol (G)
1540 The value of the parameter (a string) is the highest protocol level
1542 that will be supported for IPC$ connections as DCERPC transport.
1543 Normally this option should not be set as the automatic negotiation
1545 phase in the SMB protocol takes care of choosing the appropriate
1546 protocol.
1547 The value default refers to the latest supported protocol,
1549 currently SMB3_11.
1550 See client max protocol for a full list of available protocols. The
1552 values CORE, COREPLUS, LANMAN1, LANMAN2 are silently upgraded to
1553 NT1.
1554 Default: client ipc max protocol = default
1556 Example: client ipc max protocol = SMB2_10
1558 client ipc min protocol (G)
1560 This setting controls the minimum protocol version that the will be
1562 attempted to use for IPC$ connections as DCERPC transport.
1563 Normally this option should not be set as the automatic negotiation
1565 phase in the SMB protocol takes care of choosing the appropriate
1566 protocol.
1567 The value default refers to the higher value of NT1 and the
1569 effective value of client min protocol.
1570 See client max protocol for a full list of available protocols. The
1572 values CORE, COREPLUS, LANMAN1, LANMAN2 are silently upgraded to
1573 NT1.
1574 Default: client ipc min protocol = default
1576 Example: client ipc min protocol = SMB3_11
1578 client ipc signing (G)
1580 This controls whether the client is allowed or required to use SMB
1582 signing for IPC$ connections as DCERPC transport. Possible values
1583 are desired, required and disabled.
1584 When set to required or default, SMB signing is mandatory.
1586 When set to desired, SMB signing is offered, but not enforced and
1588 if set to disabled, SMB signing is not offered either.
1589 Connections from winbindd to Active Directory Domain Controllers
1591 always enforce signing.
1592 Default: client ipc signing = default
1594 client lanman auth (G)
1596 This parameter has been deprecated since Samba 4.13 and support for
1598 LanMan (as distinct from NTLM, NTLMv2 or Kerberos) authentication
1599 as a client will be removed in a future Samba release.
1600 That is, in the future, the current default of client NTLMv2 auth =
1602 yes will be the enforced behaviour.
1603 This parameter determines whether or not smbclient(8) and other
1605 samba client tools will attempt to authenticate itself to servers
1606 using the weaker LANMAN password hash. If disabled, only server
1607 which support NT password hashes (e.g. Windows NT/2000, Samba,
1608 etc... but not Windows 95/98) will be able to be connected from the
1609 Samba client.
1610 The LANMAN encrypted response is easily broken, due to its
1612 case-insensitive nature, and the choice of algorithm. Clients
1613 without Windows 95/98 servers are advised to disable this option.
1614 Disabling this option will also disable the client plaintext auth
1616 option.
1617 Likewise, if the client ntlmv2 auth parameter is enabled, then only
1619 NTLMv2 logins will be attempted.
1620 Default: client lanman auth = no
1622 client ldap sasl wrapping (G)
1624 The client ldap sasl wrapping defines whether ldap traffic will be
1626 signed or signed and encrypted (sealed). Possible values are plain,
1627 sign and seal.
1628 The values sign and seal are only available if Samba has been
1630 compiled against a modern OpenLDAP version (2.3.x or higher).
1631 This option is needed in the case of Domain Controllers enforcing
1633 the usage of signed LDAP connections (e.g. Windows 2000 SP3 or
1634 higher). LDAP sign and seal can be controlled with the registry key
1635 "HKLM\System\CurrentControlSet\Services\
1636 NTDS\Parameters\LDAPServerIntegrity" on the Windows server side.
1637 Depending on the used KRB5 library (MIT and older Heimdal versions)
1639 it is possible that the message "integrity only" is not supported.
1640 In this case, sign is just an alias for seal.
1641 The default value is sign. That implies synchronizing the time with
1643 the KDC in the case of using Kerberos.
1644 Default: client ldap sasl wrapping = sign
1646 client max protocol (G)
1648 The value of the parameter (a string) is the highest protocol level
1650 that will be supported by the client.
1651 Possible values are :
1653 • CORE: Earliest version. No concept of user names.
1655 • COREPLUS: Slight improvements on CORE for efficiency.
1657 • LANMAN1: First modern version of the protocol. Long
1659 filename support.
1660 • LANMAN2: Updates to Lanman1 protocol.
1662 • NT1: Current up to date version of the protocol. Used by
1664 Windows NT. Known as CIFS.
1665 • SMB2: Re-implementation of the SMB protocol. Used by
1667 Windows Vista and later versions of Windows. SMB2 has
1668 sub protocols available.
1669 • SMB2_02: The earliest SMB2 version.
1671 • SMB2_10: Windows 7 SMB2 version.
1673 By default SMB2 selects the SMB2_10 variant.
1675 • SMB3: The same as SMB2. Used by Windows 8. SMB3 has sub
1677 protocols available.
1678 • SMB3_00: Windows 8 SMB3 version.
1680 • SMB3_02: Windows 8.1 SMB3 version.
1682 • SMB3_11: Windows 10 SMB3 version.
1684 By default SMB3 selects the SMB3_11 variant.
1686 Normally this option should not be set as the automatic negotiation
1688 phase in the SMB protocol takes care of choosing the appropriate
1689 protocol.
1690 The value default refers to SMB3_11.
1692 IPC$ connections for DCERPC e.g. in winbindd, are handled by the
1694 client ipc max protocol option.
1695 Default: client max protocol = default
1697 Example: client max protocol = LANMAN1
1699 client min protocol (G)
1701 This setting controls the minimum protocol version that the client
1703 will attempt to use.
1704 Normally this option should not be set as the automatic negotiation
1706 phase in the SMB protocol takes care of choosing the appropriate
1707 protocol unless you connect to a legacy SMB1-only server.
1708 See Related command: client max protocol for a full list of
1710 available protocols.
1711 IPC$ connections for DCERPC e.g. in winbindd, are handled by the
1713 client ipc min protocol option.
1714 Note that most command line tools support --option='client min
1716 protocol=NT1', so it may not be required to enable SMB1 protocols
1717 globally in smb.conf.
1718 Default: client min protocol = SMB2_02
1720 Example: client min protocol = NT1
1722 client NTLMv2 auth (G)
1724 This parameter has been deprecated since Samba 4.13 and support for
1726 NTLM and LanMan (as distinct from NTLMv2 or Kerberos
1727 authentication) will be removed in a future Samba release.
1728 That is, in the future, the current default of client NTLMv2 auth =
1730 yes will be the enforced behaviour.
1731 This parameter determines whether or not smbclient(8) will attempt
1733 to authenticate itself to servers using the NTLMv2 encrypted
1734 password response.
1735 If enabled, only an NTLMv2 and LMv2 response (both much more secure
1737 than earlier versions) will be sent. Older servers (including NT4 <
1738 SP4, Win9x and Samba 2.2) are not compatible with NTLMv2 when not
1739 in an NTLMv2 supporting domain
1740 Similarly, if enabled, NTLMv1, client lanman auth and client
1742 plaintext auth authentication will be disabled. This also disables
1743 share-level authentication.
1744 If disabled, an NTLM response (and possibly a LANMAN response) will
1746 be sent by the client, depending on the value of client lanman
1747 auth.
1748 Note that Windows Vista and later versions already use NTLMv2 by
1750 default, and some sites (particularly those following 'best
1751 practice' security polices) only allow NTLMv2 responses, and not
1752 the weaker LM or NTLM.
1753 When client use spnego is also set to yes extended security
1755 (SPNEGO) is required in order to use NTLMv2 only within NTLMSSP.
1756 This behavior was introduced with the patches for CVE-2016-2111.
1757 Default: client NTLMv2 auth = yes
1759 client plaintext auth (G)
1761 This parameter has been deprecated since Samba 4.13 and support for
1763 plaintext (as distinct from NTLM, NTLMv2 or Kerberos
1764 authentication) will be removed in a future Samba release.
1765 That is, in the future, the current default of client plaintext
1767 auth = no will be the enforced behaviour.
1768 Specifies whether a client should send a plaintext password if the
1770 server does not support encrypted passwords.
1771 Default: client plaintext auth = no
1773 client protection (G)
1775 This parameter defines which protection Samba client tools should
1777 use by default.
1778 Possible client settings are:
1780 • default - Use the individual default values of the
1782 options:
1783 • client signing
1785 • client smb encrypt
1787 • plain - This will send everything just as plaintext,
1790 signing or encryption are turned off.
1791 • sign - This will enable integrity checking.
1793 • encrypt - This will enable integrity checks and force
1795 encryption for privacy.
1796 Default: client protection = default
1798 client schannel (G)
1800 This option is deprecated with Samba 4.8 and will be removed in
1802 future. At the same time the default changed to yes, which will be
1803 the hardcoded behavior in future.
1804 This controls whether the client offers or even demands the use of
1806 the netlogon schannel. client schannel = no does not offer the
1807 schannel, client schannel = auto offers the schannel but does not
1808 enforce it, and client schannel = yes denies access if the server
1809 is not able to speak netlogon schannel.
1810 Note that for active directory domains this is hardcoded to client
1812 schannel = yes.
1813 This option yields precedence to the require strong key option.
1815 Default: client schannel = yes
1817 Example: client schannel = auto
1819 client signing (G)
1821 This controls whether the client is allowed or required to use SMB
1823 signing. Possible values are desired, required and disabled.
1824 When set to desired or default, SMB signing is offered, but not
1826 enforced.
1827 When set to required, SMB signing is mandatory and if set to
1829 disabled, SMB signing is not offered either.
1830 IPC$ connections for DCERPC e.g. in winbindd, are handled by the
1832 client ipc signing option.
1833 Default: client signing = default
1835 client smb encrypt (G)
1837 This parameter controls whether a client should try or is required
1839 to use SMB encryption. It has different effects depending on
1840 whether the connection uses SMB1 or SMB3:
1841 • If the connection uses SMB1, then this option controls
1843 the use of a Samba-specific extension to the SMB
1844 protocol introduced in Samba 3.2 that makes use of the
1845 Unix extensions.
1846 • If the connection uses SMB2 or newer, then this option
1848 controls the use of the SMB-level encryption that is
1849 supported in SMB version 3.0 and above and available in
1850 Windows 8 and newer.
1851 This parameter can be set globally. Possible values are off,
1853 if_required, desired, and required. A special value is default
1854 which is the implicit default setting of if_required.
1855 Effects for SMB1
1857 The Samba-specific encryption of SMB1 connections is an
1858 extension to the SMB protocol negotiated as part of the UNIX
1859 extensions. SMB encryption uses the GSSAPI (SSPI on Windows)
1860 ability to encrypt and sign every request/response in a SMB
1861 protocol stream. When enabled it provides a secure method of
1862 SMB/CIFS communication, similar to an ssh protected session,
1863 but using SMB/CIFS authentication to negotiate encryption and
1864 signing keys. Currently this is only supported smbclient of by
1865 Samba 3.2 and newer. Windows does not support this feature.
1866 When set to default, SMB encryption is probed, but not
1868 enforced. When set to required, SMB encryption is required and
1869 if set to disabled, SMB encryption can not be negotiated.
1870 Effects for SMB3 and newer
1872 Native SMB transport encryption is available in SMB version 3.0
1873 or newer. It is only used by Samba if client max protocol is
1874 set to SMB3 or newer.
1875 These features can be controlled with settings of client smb
1877 encrypt as follows:
1878 • Leaving it as default, explicitly setting default,
1880 or setting it to if_required globally will enable
1881 negotiation of encryption but will not turn on data
1882 encryption globally.
1883 • Setting it to desired globally will enable
1885 negotiation and will turn on data encryption on
1886 sessions and share connections for those servers
1887 that support it.
1888 • Setting it to required globally will enable
1890 negotiation and turn on data encryption on sessions
1891 and share connections. Clients that do not support
1892 encryption will be denied access to the server.
1893 • Setting it to off globally will completely disable
1895 the encryption feature for all connections.
1896 Default: client smb encrypt = default
1899 client smb3 encryption algorithms (G)
1901 This parameter specifies the availability and order of encryption
1903 algorithms which are available for negotiation in the SMB3_11
1904 dialect.
1905 It is also possible to remove individual algorithms from the
1907 default list, by prefixing them with '-'. This can avoid having to
1908 specify a hardcoded list.
1909 Note: that the removal of AES-128-CCM from the list will result in
1911 SMB3_00 and SMB3_02 being unavailable, as it is the default and
1912 only available algorithm for these dialects.
1913 Default: client smb3 encryption algorithms = AES-128-GCM,
1915 AES-128-CCM, AES-256-GCM, AES-256-CCM
1916 Example: client smb3 encryption algorithms = AES-256-GCM
1918 Example: client smb3 encryption algorithms = -AES-128-GCM
1920 -AES-128-CCM
1921 client smb3 signing algorithms (G)
1923 This parameter specifies the availability and order of signing
1925 algorithms which are available for negotiation in the SMB3_11
1926 dialect.
1927 It is also possible to remove individual algorithms from the
1929 default list, by prefixing them with '-'. This can avoid having to
1930 specify a hardcoded list.
1931 Note: that the removal of AES-128-CMAC from the list will result in
1933 SMB3_00 and SMB3_02 being unavailable, and the removal of
1934 HMAC-SHA256 will result in SMB2_02 and SMB2_10 being unavailable,
1935 as these are the default and only available algorithms for these
1936 dialects.
1937 Default: client smb3 signing algorithms = AES-128-GMAC,
1939 AES-128-CMAC, HMAC-SHA256
1940 Example: client smb3 signing algorithms = AES-128-CMAC, HMAC-SHA256
1942 Example: client smb3 signing algorithms = -AES-128-CMAC
1944 client use kerberos (G)
1946 This parameter determines whether Samba client tools will try to
1948 authenticate using Kerberos. For Kerberos authentication you need
1949 to use dns names instead of IP addresses when connnecting to a
1950 service.
1951 Possible option settings are:
1953 • desired - Kerberos authentication will be tried first
1955 and if it fails it automatically fallback to NTLM.
1956 • required - Kerberos authentication will be required.
1958 There will be no falllback to NTLM or a different
1959 alternative.
1960 • off - Don't use Kerberos, use NTLM instead or another
1962 alternative.
1963 In case that weak cryptography is not allowed (e.g. FIPS mode) the
1965 default will be forced to required.
1966 Default: client use kerberos = desired
1968 client use spnego principal (G)
1970 This parameter determines whether or not smbclient(8) and other
1972 samba components acting as a client will attempt to use the
1973 server-supplied principal sometimes given in the SPNEGO exchange.
1974 If enabled, Samba can attempt to use Kerberos to contact servers
1976 known only by IP address. Kerberos relies on names, so ordinarily
1977 cannot function in this situation.
1978 This is a VERY BAD IDEA for security reasons, and so this parameter
1980 SHOULD NOT BE USED. It will be removed in a future version of
1981 Samba.
1982 If disabled, Samba will use the name used to look up the server
1984 when asking the KDC for a ticket. This avoids situations where a
1985 server may impersonate another, soliciting authentication as one
1986 principal while being known on the network as another.
1987 Note that Windows XP SP2 and later versions already follow this
1989 behaviour, and Windows Vista and later servers no longer supply
1990 this 'rfc4178 hint' principal on the server side.
1991 This parameter is deprecated in Samba 4.2.1 and will be removed
1993 (along with the functionality) in a later release of Samba.
1994 Default: client use spnego principal = no
1996 client use spnego (G)
1998 This parameter has been deprecated since Samba 4.13 and support for
2000 NTLMv2, NTLM and LanMan authentication outside NTLMSSP will be
2001 removed in a future Samba release.
2002 That is, in the future, the current default of client use spnego =
2004 yes will be the enforced behaviour.
2005 This variable controls whether Samba clients will try to use Simple
2007 and Protected NEGOciation (as specified by rfc2478) with supporting
2008 servers (including WindowsXP, Windows2000 and Samba 3.0) to agree
2009 upon an authentication mechanism. This enables Kerberos
2010 authentication in particular.
2011 When client NTLMv2 auth is also set to yes extended security
2013 (SPNEGO) is required in order to use NTLMv2 only within NTLMSSP.
2014 This behavior was introduced with the patches for CVE-2016-2111.
2015 Default: client use spnego = yes
2017 cluster addresses (G)
2019 With this parameter you can add additional addresses that nmbd will
2021 register with a WINS server. Similarly, these addresses will be
2022 registered by default when net ads dns register is called with
2023 clustering = yes configured.
2024 Default: cluster addresses =
2026 Example: cluster addresses = 10.0.0.1 10.0.0.2 10.0.0.3
2028 clustering (G)
2030 This parameter specifies whether Samba should contact ctdb for
2032 accessing its tdb files and use ctdb as a backend for its messaging
2033 backend.
2034 Set this parameter to yes only if you have a cluster setup with
2036 ctdb running.
2037 Default: clustering = no
2039 comment (S)
2041 This is a text field that is seen next to a share when a client
2043 does a queries the server, either via the network neighborhood or
2044 via net view to list what shares are available.
2045 If you want to set the string that is displayed next to the machine
2047 name then see the server string parameter.
2048 Default: comment = # No comment
2050 Example: comment = Fred's Files
2052 config backend (G)
2054 This controls the backend for storing the configuration. Possible
2056 values are file (the default) and registry. When config backend =
2057 registry is encountered while loading smb.conf, the configuration
2058 read so far is dropped and the global options are read from
2059 registry instead. So this triggers a registry only configuration.
2060 Share definitions are not read immediately but instead registry
2061 shares is set to yes.
2062 Note: This option can not be set inside the registry configuration
2064 itself.
2065 Default: config backend = file
2067 Example: config backend = registry
2069 config file (G)
2071 This allows you to override the config file to use, instead of the
2073 default (usually smb.conf). There is a chicken and egg problem here
2074 as this option is set in the config file!
2075 For this reason, if the name of the config file has changed when
2077 the parameters are loaded then it will reload them from the new
2078 config file.
2079 This option takes the usual substitutions, which can be very
2081 useful.
2082 If the config file doesn't exist then it won't be loaded (allowing
2084 you to special case the config files of just a few clients).
2085 No default
2087 Example: config file = /usr/local/samba/lib/smb.conf.%m
2089 copy (S)
2091 This parameter allows you to "clone" service entries. The specified
2093 service is simply duplicated under the current service's name. Any
2094 parameters specified in the current section will override those in
2095 the section being copied.
2096 This feature lets you set up a 'template' service and create
2098 similar services easily. Note that the service being copied must
2099 occur earlier in the configuration file than the service doing the
2100 copying.
2101 Default: copy =
2103 Example: copy = otherservice
2105 create krb5 conf (G)
2107 Setting this parameter to no prevents winbind from creating custom
2109 krb5.conf files. Winbind normally does this because the krb5
2110 libraries are not AD-site-aware and thus would pick any domain
2111 controller out of potentially very many. Winbind is site-aware and
2112 makes the krb5 libraries use a local DC by creating its own
2113 krb5.conf files.
2114 Preventing winbind from doing this might become necessary if you
2116 have to add special options into your system-krb5.conf that winbind
2117 does not see.
2118 Default: create krb5 conf = yes
2120 create mode
2122 This parameter is a synonym for create mask.
2124 create mask (S)
2126 When a file is created, the necessary permissions are calculated
2128 according to the mapping from DOS modes to UNIX permissions, and
2129 the resulting UNIX mode is then bit-wise 'AND'ed with this
2130 parameter. This parameter may be thought of as a bit-wise MASK for
2131 the UNIX modes of a file. Any bit not set here will be removed from
2132 the modes set on a file when it is created.
2133 The default value of this parameter removes the group and other
2135 write and execute bits from the UNIX modes.
2136 Following this Samba will bit-wise 'OR' the UNIX mode created from
2138 this parameter with the value of the force create mode parameter
2139 which is set to 000 by default.
2140 This parameter does not affect directory masks. See the parameter
2142 directory mask for details.
2143 Default: create mask = 0744
2145 Example: create mask = 0775
2147 csc policy (S)
2149 This stands for client-side caching policy, and specifies how
2151 clients capable of offline caching will cache the files in the
2152 share. The valid values are: manual, documents, programs, disable.
2153 These values correspond to those used on Windows servers.
2155 For example, shares containing roaming profiles can have offline
2157 caching disabled using csc policy = disable.
2158 Default: csc policy = manual
2160 Example: csc policy = programs
2162 ctdbd socket (G)
2164 If you set clustering=yes, you need to tell Samba where ctdbd
2166 listens on its unix domain socket. The default path as of ctdb 1.0
2167 is /tmp/ctdb.socket which you have to explicitly set for Samba in
2168 smb.conf.
2169 Default: ctdbd socket =
2171 Example: ctdbd socket = /tmp/ctdb.socket
2173 ctdb locktime warn threshold (G)
2175 In a cluster environment using Samba and ctdb it is critical that
2177 locks on central ctdb-hosted databases like locking.tdb are not
2178 held for long. With the current Samba architecture it happens that
2179 Samba takes a lock and while holding that lock makes file system
2180 calls into the shared cluster file system. This option makes Samba
2181 warn if it detects that it has held locks for the specified number
2182 of milliseconds. If this happens, smbd will emit a debug level 0
2183 message into its logs and potentially into syslog. The most likely
2184 reason for such a log message is that an operation of the cluster
2185 file system Samba exports is taking longer than expected. The
2186 messages are meant as a debugging aid for potential cluster
2187 problems.
2188 The default value of 0 disables this logging.
2190 Default: ctdb locktime warn threshold = 0
2192 ctdb timeout (G)
2194 This parameter specifies a timeout in milliseconds for the
2196 connection between Samba and ctdb. It is only valid if you have
2197 compiled Samba with clustering and if you have set clustering=yes.
2198 When something in the cluster blocks, it can happen that we wait
2200 indefinitely long for ctdb, just adding to the blocking condition.
2201 In a well-running cluster this should never happen, but there are
2202 too many components in a cluster that might have hickups. Choosing
2203 the right balance for this value is very tricky, because on a busy
2204 cluster long service times to transfer something across the cluster
2205 might be valid. Setting it too short will degrade the service your
2206 cluster presents, setting it too long might make the cluster itself
2207 not recover from something severely broken for too long.
2208 Be aware that if you set this parameter, this needs to be in the
2210 file smb.conf, it is not really helpful to put this into a registry
2211 configuration (typical on a cluster), because to access the
2212 registry contact to ctdb is required.
2213 Setting ctdb timeout to n makes any process waiting longer than n
2215 milliseconds for a reply by the cluster panic. Setting it to 0 (the
2216 default) makes Samba block forever, which is the highly recommended
2217 default.
2218 Default: ctdb timeout = 0
2220 cups connection timeout (G)
2222 This parameter is only applicable if printing is set to cups.
2224 If set, this option specifies the number of seconds that smbd will
2226 wait whilst trying to contact to the CUPS server. The connection
2227 will fail if it takes longer than this number of seconds.
2228 Default: cups connection timeout = 30
2230 Example: cups connection timeout = 60
2232 cups encrypt (G)
2234 This parameter is only applicable if printing is set to cups and if
2236 you use CUPS newer than 1.0.x.It is used to define whether or not
2237 Samba should use encryption when talking to the CUPS server.
2238 Possible values are auto, yes and no
2239 When set to auto we will try to do a TLS handshake on each CUPS
2241 connection setup. If that fails, we will fall back to unencrypted
2242 operation.
2243 Default: cups encrypt = no
2245 cups options (S)
2247 This parameter is only applicable if printing is set to cups. Its
2249 value is a free form string of options passed directly to the cups
2250 library.
2251 You can pass any generic print option known to CUPS (as listed in
2253 the CUPS "Software Users' Manual"). You can also pass any printer
2254 specific option (as listed in "lpoptions -d printername -l") valid
2255 for the target queue. Multiple parameters should be space-delimited
2256 name/value pairs according to the PAPI text option ABNF
2257 specification. Collection values ("name={a=... b=... c=...}") are
2258 stored with the curley brackets intact.
2259 You should set this parameter to raw if your CUPS server error_log
2261 file contains messages such as "Unsupported format
2262 'application/octet-stream'" when printing from a Windows client
2263 through Samba. It is no longer necessary to enable system wide raw
2264 printing in /etc/cups/mime.{convs,types}.
2265 Default: cups options = ""
2267 Example: cups options = "raw media=a4"
2269 cups server (G)
2271 This parameter is only applicable if printing is set to cups.
2273 If set, this option overrides the ServerName option in the CUPS
2275 client.conf. This is necessary if you have virtual samba servers
2276 that connect to different CUPS daemons.
2277 Optionally, a port can be specified by separating the server name
2279 and port number with a colon. If no port was specified, the default
2280 port for IPP (631) will be used.
2281 Default: cups server = ""
2283 Example: cups server = mycupsserver
2285 Example: cups server = mycupsserver:1631
2287 dcerpc endpoint servers (G)
2289 Specifies which DCE/RPC endpoint servers should be run.
2291 Default: dcerpc endpoint servers = epmapper, wkssvc, rpcecho, samr,
2293 netlogon, lsarpc, drsuapi, dssetup, unixinfo, browser, eventlog6,
2294 backupkey, dnsserver
2295 Example: dcerpc endpoint servers = rpcecho
2297 deadtime (G)
2299 The value of the parameter (a decimal integer) represents the
2301 number of minutes of inactivity before a connection is considered
2302 dead, and it is disconnected. The deadtime only takes effect if the
2303 number of open files is zero.
2304 This is useful to stop a server's resources being exhausted by a
2306 large number of inactive connections.
2307 Most clients have an auto-reconnect feature when a connection is
2309 broken so in most cases this parameter should be transparent to
2310 users.
2311 Using this parameter with a timeout of a few minutes is recommended
2313 for most systems.
2314 A deadtime of zero indicates that no auto-disconnection should be
2316 performed.
2317 Default: deadtime = 10080
2319 Example: deadtime = 15
2321 debug class (G)
2323 With this boolean parameter enabled, the debug class (DBGC_CLASS)
2325 will be displayed in the debug header.
2326 For more information about currently available debug classes, see
2328 section about log level.
2329 Default: debug class = no
2331 debug encryption (G)
2333 This option will make the smbd server and client code using libsmb
2335 (smbclient, smbget, smbspool, ...) dump the Session Id, the
2336 decrypted Session Key, the Signing Key, the Application Key, the
2337 Encryption Key and the Decryption Key every time an SMB3+ session
2338 is established. This information will be printed in logs at level
2339 0.
2340 Warning: access to these values enables the decryption of any
2342 encrypted traffic on the dumped sessions. This option should only
2343 be enabled for debugging purposes.
2344 Default: debug encryption = no
2346 debug hires timestamp (G)
2348 Sometimes the timestamps in the log messages are needed with a
2350 resolution of higher that seconds, this boolean parameter adds
2351 microsecond resolution to the timestamp message header when turned
2352 on.
2353 Note that the parameter debug timestamp must be on for this to have
2355 an effect.
2356 Default: debug hires timestamp = yes
2358 debug pid (G)
2360 When using only one log file for more then one forked
2362 smbd(8)-process there may be hard to follow which process outputs
2363 which message. This boolean parameter is adds the process-id to the
2364 timestamp message headers in the logfile when turned on.
2365 Note that the parameter debug timestamp must be on for this to have
2367 an effect.
2368 Default: debug pid = no
2370 debug prefix timestamp (G)
2372 With this option enabled, the timestamp message header is prefixed
2374 to the debug message without the filename and function information
2375 that is included with the debug timestamp parameter. This gives
2376 timestamps to the messages without adding an additional line.
2377 Note that this parameter overrides the debug timestamp parameter.
2379 Default: debug prefix timestamp = no
2381 debug uid (G)
2383 Samba is sometimes run as root and sometime run as the connected
2385 user, this boolean parameter inserts the current euid, egid, uid
2386 and gid to the timestamp message headers in the log file if turned
2387 on.
2388 Note that the parameter debug timestamp must be on for this to have
2390 an effect.
2391 Default: debug uid = no
2393 dedicated keytab file (G)
2395 Specifies the absolute path to the kerberos keytab file when
2397 kerberos method is set to "dedicated keytab".
2398 Default: dedicated keytab file =
2400 Example: dedicated keytab file = /usr/local/etc/krb5.keytab
2402 default case (S)
2404 See the section on name mangling. Also note the short preserve case
2406 parameter.
2407 Default: default case = lower
2409 default devmode (S)
2411 This parameter is only applicable to printable services. When smbd
2413 is serving Printer Drivers to Windows NT/2k/XP clients, each
2414 printer on the Samba server has a Device Mode which defines things
2415 such as paper size and orientation and duplex settings. The device
2416 mode can only correctly be generated by the printer driver itself
2417 (which can only be executed on a Win32 platform). Because smbd is
2418 unable to execute the driver code to generate the device mode, the
2419 default behavior is to set this field to NULL.
2420 Most problems with serving printer drivers to Windows NT/2k/XP
2422 clients can be traced to a problem with the generated device mode.
2423 Certain drivers will do things such as crashing the client's
2424 Explorer.exe with a NULL devmode. However, other printer drivers
2425 can cause the client's spooler service (spoolsv.exe) to die if the
2426 devmode was not created by the driver itself (i.e. smbd generates a
2427 default devmode).
2428 This parameter should be used with care and tested with the printer
2430 driver in question. It is better to leave the device mode to NULL
2431 and let the Windows client set the correct values. Because drivers
2432 do not do this all the time, setting default devmode = yes will
2433 instruct smbd to generate a default one.
2434 For more information on Windows NT/2k printing and Device Modes,
2436 see the MSDN documentation.
2437 Default: default devmode = yes
2439 default
2441 This parameter is a synonym for default service.
2443 default service (G)
2445 This parameter specifies the name of a service which will be
2447 connected to if the service actually requested cannot be found.
2448 Note that the square brackets are NOT given in the parameter value
2449 (see example below).
2450 There is no default value for this parameter. If this parameter is
2452 not given, attempting to connect to a nonexistent service results
2453 in an error.
2454 Typically the default service would be a guest ok, read-only
2456 service.
2457 Also note that the apparent service name will be changed to equal
2459 that of the requested service, this is very useful as it allows you
2460 to use macros like %S to make a wildcard service.
2461 Note also that any "_" characters in the name of the service used
2463 in the default service will get mapped to a "/". This allows for
2464 interesting things.
2465 Default: default service =
2467 Example: default service = pub
2469 defer sharing violations (G)
2471 Windows allows specifying how a file will be shared with other
2473 processes when it is opened. Sharing violations occur when a file
2474 is opened by a different process using options that violate the
2475 share settings specified by other processes. This parameter causes
2476 smbd to act as a Windows server does, and defer returning a
2477 "sharing violation" error message for up to one second, allowing
2478 the client to close the file causing the violation in the meantime.
2479 UNIX by default does not have this behaviour.
2481 There should be no reason to turn off this parameter, as it is
2483 designed to enable Samba to more correctly emulate Windows.
2484 Default: defer sharing violations = yes
2486 delete group script (G)
2488 This is the full pathname to a script that will be run AS ROOT by
2490 smbd(8) when a group is requested to be deleted. It will expand any
2491 %g to the group name passed. This script is only useful for
2492 installations using the Windows NT domain administration tools.
2493 Default: delete group script =
2495 deleteprinter command (G)
2497 With the introduction of MS-RPC based printer support for Windows
2499 NT/2000 clients in Samba 2.2, it is now possible to delete a
2500 printer at run time by issuing the DeletePrinter() RPC call.
2501 For a Samba host this means that the printer must be physically
2503 deleted from the underlying printing system. The deleteprinter
2504 command defines a script to be run which will perform the necessary
2505 operations for removing the printer from the print system and from
2506 smb.conf.
2507 The deleteprinter command is automatically called with only one
2509 parameter: printer name.
2510 Once the deleteprinter command has been executed, smbd will reparse
2512 the smb.conf to check that the associated printer no longer exists.
2513 If the sharename is still valid, then smbd will return an
2514 ACCESS_DENIED error to the client.
2515 Default: deleteprinter command =
2517 Example: deleteprinter command = /usr/bin/removeprinter
2519 delete readonly (S)
2521 This parameter allows readonly files to be deleted. This is not
2523 normal DOS semantics, but is allowed by UNIX.
2524 This option may be useful for running applications such as rcs,
2526 where UNIX file ownership prevents changing file permissions, and
2527 DOS semantics prevent deletion of a read only file.
2528 Default: delete readonly = no
2530 delete share command (G)
2532 Samba 2.2.0 introduced the ability to dynamically add and delete
2534 shares via the Windows NT 4.0 Server Manager. The delete share
2535 command is used to define an external program or script which will
2536 remove an existing service definition from smb.conf.
2537 In order to successfully execute the delete share command, smbd
2539 requires that the administrator connects using a root account (i.e.
2540 uid == 0) or has the SeDiskOperatorPrivilege. Scripts defined in
2541 the delete share command parameter are executed as root.
2542 When executed, smbd will automatically invoke the delete share
2544 command with two parameters.
2545 • configFile - the location of the global smb.conf file.
2547 • shareName - the name of the existing service.
2549 This parameter is only used to remove file shares. To delete
2551 printer shares, see the deleteprinter command.
2552 Default: delete share command =
2554 Example: delete share command = /usr/local/bin/delshare
2556 delete user from group script (G)
2558 Full path to the script that will be called when a user is removed
2560 from a group using the Windows NT domain administration tools. It
2561 will be run by smbd(8) AS ROOT. Any %g will be replaced with the
2562 group name and any %u will be replaced with the user name.
2563 Default: delete user from group script =
2565 Example: delete user from group script = /usr/sbin/deluser %u %g
2567 delete user script (G)
2569 This is the full pathname to a script that will be run by smbd(8)
2571 when managing users with remote RPC (NT) tools.
2572 This script is called when a remote client removes a user from the
2574 server, normally using 'User Manager for Domains' or rpcclient.
2575 This script should delete the given UNIX username.
2577 Default: delete user script =
2579 Example: delete user script = /usr/local/samba/bin/del_user %u
2581 delete veto files (S)
2583 This option is used when Samba is attempting to delete a directory
2585 that contains one or more vetoed directories (see the veto files
2586 option). If this option is set to no (the default) then if a vetoed
2587 directory contains any non-vetoed files or directories then the
2588 directory delete will fail. This is usually what you want.
2589 If this option is set to yes, then Samba will attempt to
2591 recursively delete any files and directories within the vetoed
2592 directory. This can be useful for integration with file serving
2593 systems such as NetAtalk which create meta-files within directories
2594 you might normally veto DOS/Windows users from seeing (e.g.
2595 .AppleDouble)
2596 Setting delete veto files = yes allows these directories to be
2598 transparently deleted when the parent directory is deleted (so long
2599 as the user has permissions to do so).
2600 Default: delete veto files = no
2602 dfree cache time (S)
2604 The dfree cache time should only be used on systems where a problem
2606 occurs with the internal disk space calculations. This has been
2607 known to happen with Ultrix, but may occur with other operating
2608 systems. The symptom that was seen was an error of "Abort Retry
2609 Ignore" at the end of each directory listing.
2610 This is a new parameter introduced in Samba version 3.0.21. It
2612 specifies in seconds the time that smbd will cache the output of a
2613 disk free query. If set to zero (the default) no caching is done.
2614 This allows a heavily loaded server to prevent rapid spawning of
2615 dfree command scripts increasing the load.
2616 By default this parameter is zero, meaning no caching will be done.
2618 No default
2620 Example: dfree cache time = 60
2622 dfree command (S)
2624 The dfree command setting should only be used on systems where a
2626 problem occurs with the internal disk space calculations. This has
2627 been known to happen with Ultrix, but may occur with other
2628 operating systems. The symptom that was seen was an error of "Abort
2629 Retry Ignore" at the end of each directory listing.
2630 This setting allows the replacement of the internal routines to
2632 calculate the total disk space and amount available with an
2633 external routine. The example below gives a possible script that
2634 might fulfill this function.
2635 In Samba version 3.0.21 this parameter has been changed to be a
2637 per-share parameter, and in addition the parameter dfree cache time
2638 was added to allow the output of this script to be cached for
2639 systems under heavy load.
2640 The external program will be passed a single parameter indicating a
2642 directory in the filesystem being queried. This will typically
2643 consist of the string ./. The script should return two integers in
2644 ASCII. The first should be the total disk space in blocks, and the
2645 second should be the number of available blocks. An optional third
2646 return value can give the block size in bytes. The default
2647 blocksize is 1024 bytes.
2648 Note: Your script should NOT be setuid or setgid and should be
2650 owned by (and writeable only by) root!
2651 Where the script dfree (which must be made executable) could be:
2653 #!/bin/sh
2656 df "$1" | tail -1 | awk '{print $(NF-4),$(NF-2)}'
2657 or perhaps (on Sys V based systems):
2659 #!/bin/sh
2662 /usr/bin/df -k "$1" | tail -1 | awk '{print $3" "$5}'
2663 Note that you may have to replace the command names with full path
2665 names on some systems. Also note the arguments passed into the
2666 script should be quoted inside the script in case they contain
2667 special characters such as spaces or newlines.
2668 By default internal routines for determining the disk capacity and
2670 remaining space will be used.
2671 No default
2673 Example: dfree command = /usr/local/samba/bin/dfree
2675 dgram port (G)
2677 Specifies which ports the server should listen on for NetBIOS
2679 datagram traffic.
2680 Default: dgram port = 138
2682 directory mode
2684 This parameter is a synonym for directory mask.
2686 directory mask (S)
2688 This parameter is the octal modes which are used when converting
2690 DOS modes to UNIX modes when creating UNIX directories.
2691 When a directory is created, the necessary permissions are
2693 calculated according to the mapping from DOS modes to UNIX
2694 permissions, and the resulting UNIX mode is then bit-wise 'AND'ed
2695 with this parameter. This parameter may be thought of as a bit-wise
2696 MASK for the UNIX modes of a directory. Any bit not set here will
2697 be removed from the modes set on a directory when it is created.
2698 The default value of this parameter removes the 'group' and 'other'
2700 write bits from the UNIX mode, allowing only the user who owns the
2701 directory to modify it.
2702 Following this Samba will bit-wise 'OR' the UNIX mode created from
2704 this parameter with the value of the force directory mode
2705 parameter. This parameter is set to 000 by default (i.e. no extra
2706 mode bits are added).
2707 Default: directory mask = 0755
2709 Example: directory mask = 0775
2711 directory name cache size (S)
2713 This parameter specifies the size of the directory name cache for
2715 SMB1 connections. It is not used for SMB2. It will be needed to
2716 turn this off for *BSD systems.
2717 Default: directory name cache size = 100
2719 directory security mask (S)
2721 This parameter has been removed for Samba 4.0.0.
2723 No default
2725 disable netbios (G)
2727 Enabling this parameter will disable netbios support in Samba.
2729 Netbios is the only available form of browsing in all windows
2730 versions except for 2000 and XP.
2731 Note
2733 Clients that only support netbios won't be able to see your
2734 samba server when netbios support is disabled.
2735 Default: disable netbios = no
2736 disable spoolss (G)
2738 Enabling this parameter will disable Samba's support for the
2740 SPOOLSS set of MS-RPC's and will yield identical behavior as Samba
2741 2.0.x. Windows NT/2000 clients will downgrade to using Lanman style
2742 printing commands. Windows 9x/ME will be unaffected by the
2743 parameter. However, this will also disable the ability to upload
2744 printer drivers to a Samba server via the Windows NT Add Printer
2745 Wizard or by using the NT printer properties dialog window. It will
2746 also disable the capability of Windows NT/2000 clients to download
2747 print drivers from the Samba host upon demand. Be very careful
2748 about enabling this parameter.
2749 Default: disable spoolss = no
2751 dmapi support (S)
2753 This parameter specifies whether Samba should use DMAPI to
2755 determine whether a file is offline or not. This would typically be
2756 used in conjunction with a hierarchical storage system that
2757 automatically migrates files to tape.
2758 Note that Samba infers the status of a file by examining the events
2760 that a DMAPI application has registered interest in. This heuristic
2761 is satisfactory for a number of hierarchical storage systems, but
2762 there may be system for which it will fail. In this case, Samba may
2763 erroneously report files to be offline.
2764 This parameter is only available if a supported DMAPI
2766 implementation was found at compilation time. It will only be used
2767 if DMAPI is found to enabled on the system at run time.
2768 Default: dmapi support = no
2770 dns forwarder (G)
2772 This option specifies the list of DNS servers that DNS requests
2774 will be forwarded to if they can not be handled by Samba itself.
2775 The DNS forwarder is only used if the internal DNS server in Samba
2777 is used.
2778 Default: dns forwarder =
2780 Example: dns forwarder = 192.168.0.1 192.168.0.2
2782 dns proxy (G)
2784 Specifies that nmbd(8) when acting as a WINS server and finding
2786 that a NetBIOS name has not been registered, should treat the
2787 NetBIOS name word-for-word as a DNS name and do a lookup with the
2788 DNS server for that name on behalf of the name-querying client.
2789 Note that the maximum length for a NetBIOS name is 15 characters,
2791 so the DNS name (or DNS alias) can likewise only be 15 characters,
2792 maximum.
2793 nmbd spawns a second copy of itself to do the DNS name lookup
2795 requests, as doing a name lookup is a blocking action.
2796 Default: dns proxy = yes
2798 dns update command (G)
2800 This option sets the command that is called when there are DNS
2802 updates. It should update the local machines DNS names using
2803 TSIG-GSS.
2804 Default: dns update command =
2806 /builddir/build/BUILD/samba-4.15.2/source4/scripting/bin/samba_dnsupdate
2807 Example: dns update command = /usr/local/sbin/dnsupdate
2809 dns zone scavenging (G)
2811 When enabled (the default is disabled) unused dynamic dns records
2813 are periodically removed.
2814 Warning
2816 This option should not be enabled for installations created
2817 with versions of samba before 4.9. Doing this will result in
2818 the loss of static DNS entries. This is due to a bug in
2819 previous versions of samba (BUG 12451) which marked dynamic DNS
2820 records as static and static records as dynamic.
2821 Note
2823 If one record for a DNS name is static (non-aging) then no
2824 other record for that DNS name will be scavenged.
2825 Default: dns zone scavenging = no
2826 dns zone transfer clients allow (G)
2828 This option specifies the list of IPs authorized to ask for dns
2830 zone transfer from bind DLZ module.
2831 The IP list is comma and space separated and specified in the same
2833 syntax as used in hosts allow, specifically including IP address,
2834 IP prefixes and IP address masks.
2835 As this is a DNS server option, hostnames are naturally not
2837 permitted.
2838 The default behaviour is to deny any request. A request will be
2840 authorized only if the emitting client is identified in this list,
2841 and not in dns zone transfer clients deny
2842 Default: dns zone transfer clients allow =
2844 Example: dns zone transfer clients allow = 192.168.0.1
2846 dns zone transfer clients deny (G)
2848 This option specifies the list of IPs denied to ask for dns zone
2850 transfer from bind DLZ module.
2851 The IP list is comma and space separated and specified in the same
2853 syntax as used in hosts allow, specifically including IP address,
2854 IP prefixes and IP address masks.
2855 As this is a DNS server option, hostnames are naturally not
2857 permitted.
2858 If a client identified in this list sends a zone transfer request,
2860 it will always be denied, even if they are in dns zone transfer
2861 clients allow. This allows the definition of specific denied
2862 clients within an authorized subnet.
2863 Default: dns zone transfer clients deny =
2865 Example: dns zone transfer clients deny = 192.168.0.1
2867 domain logons (G)
2869 This parameter has been deprecated since Samba 4.13 and support for
2871 NT4-style domain logons(as distinct from the Samba AD DC) will be
2872 removed in a future Samba release.
2873 That is, in the future, the current default of domain logons = no
2875 will be the enforced behaviour.
2876 If set to yes, the Samba server will provide the netlogon service
2878 for Windows 9X network logons for the workgroup it is in. This will
2879 also cause the Samba server to act as a domain controller for NT4
2880 style domain services. For more details on setting up this feature
2881 see the Domain Control chapter of the Samba HOWTO Collection.
2882 Default: domain logons = no
2884 domain master (G)
2886 Tell smbd(8) to enable WAN-wide browse list collation. Setting this
2888 option causes nmbd to claim a special domain specific NetBIOS name
2889 that identifies it as a domain master browser for its given
2890 workgroup. Local master browsers in the same workgroup on
2891 broadcast-isolated subnets will give this nmbd their local browse
2892 lists, and then ask smbd(8) for a complete copy of the browse list
2893 for the whole wide area network. Browser clients will then contact
2894 their local master browser, and will receive the domain-wide browse
2895 list, instead of just the list for their broadcast-isolated subnet.
2896 Note that Windows NT Primary Domain Controllers expect to be able
2898 to claim this workgroup specific special NetBIOS name that
2899 identifies them as domain master browsers for that workgroup by
2900 default (i.e. there is no way to prevent a Windows NT PDC from
2901 attempting to do this). This means that if this parameter is set
2902 and nmbd claims the special name for a workgroup before a Windows
2903 NT PDC is able to do so then cross subnet browsing will behave
2904 strangely and may fail.
2905 If domain logons = yes, then the default behavior is to enable the
2907 domain master parameter. If domain logons is not enabled (the
2908 default setting), then neither will domain master be enabled by
2909 default.
2910 When domain logons = Yes the default setting for this parameter is
2912 Yes, with the result that Samba will be a PDC. If domain master =
2913 No, Samba will function as a BDC. In general, this parameter should
2914 be set to 'No' only on a BDC.
2915 Default: domain master = auto
2917 dont descend (S)
2919 There are certain directories on some systems (e.g., the /proc tree
2921 under Linux) that are either not of interest to clients or are
2922 infinitely deep (recursive). This parameter allows you to specify a
2923 comma-delimited list of directories that the server should always
2924 show as empty.
2925 Note that Samba can be very fussy about the exact format of the
2927 "dont descend" entries. For example you may need ./proc instead of
2928 just /proc. Experimentation is the best policy :-)
2929 Default: dont descend =
2931 Example: dont descend = /proc,/dev
2933 dos charset (G)
2935 DOS SMB clients assume the server has the same charset as they do.
2937 This option specifies which charset Samba should talk to DOS
2938 clients.
2939 The default depends on which charsets you have installed. Samba
2941 tries to use charset 850 but falls back to ASCII in case it is not
2942 available. Run testparm(1) to check the default on your system.
2943 No default
2945 dos filemode (S)
2947 The default behavior in Samba is to provide UNIX-like behavior
2949 where only the owner of a file/directory is able to change the
2950 permissions on it. However, this behavior is often confusing to
2951 DOS/Windows users. Enabling this parameter allows a user who has
2952 write access to the file (by whatever means, including an ACL
2953 permission) to modify the permissions (including ACL) on it. Note
2954 that a user belonging to the group owning the file will not be
2955 allowed to change permissions if the group is only granted read
2956 access. Ownership of the file/directory may also be changed. Note
2957 that using the VFS modules acl_xattr or acl_tdb which store native
2958 Windows as meta-data will automatically turn this option on for any
2959 share for which they are loaded, as they require this option to
2960 emulate Windows ACLs correctly.
2961 Default: dos filemode = no
2963 dos filetime resolution (S)
2965 Under the DOS and Windows FAT filesystem, the finest granularity on
2967 time resolution is two seconds. Setting this parameter for a share
2968 causes Samba to round the reported time down to the nearest two
2969 second boundary when a query call that requires one second
2970 resolution is made to smbd(8).
2971 This option is mainly used as a compatibility option for Visual C++
2973 when used against Samba shares. If oplocks are enabled on a share,
2974 Visual C++ uses two different time reading calls to check if a file
2975 has changed since it was last read. One of these calls uses a
2976 one-second granularity, the other uses a two second granularity. As
2977 the two second call rounds any odd second down, then if the file
2978 has a timestamp of an odd number of seconds then the two timestamps
2979 will not match and Visual C++ will keep reporting the file has
2980 changed. Setting this option causes the two timestamps to match,
2981 and Visual C++ is happy.
2982 Default: dos filetime resolution = no
2984 dos filetimes (S)
2986 Under DOS and Windows, if a user can write to a file they can
2988 change the timestamp on it. Under POSIX semantics, only the owner
2989 of the file or root may change the timestamp. By default, Samba
2990 emulates the DOS semantics and allows one to change the timestamp
2991 on a file if the user smbd is acting on behalf has write
2992 permissions. Due to changes in Microsoft Office 2000 and beyond,
2993 the default for this parameter has been changed from "no" to "yes"
2994 in Samba 3.0.14 and above. Microsoft Excel will display dialog box
2995 warnings about the file being changed by another user if this
2996 parameter is not set to "yes" and files are being shared between
2997 users.
2998 Default: dos filetimes = yes
3000 dsdb event notification (G)
3002 When enabled, this option causes Samba (acting as an Active
3004 Directory Domain Controller) to stream Samba database events across
3005 the internal message bus. Scripts built using Samba's python
3006 bindings can listen to these events by registering as the service
3007 dsdb_event.
3008 This is not needed for the audit logging described in log level.
3010 Instead, this should instead be considered a developer option (it
3012 assists in the Samba testsuite) rather than a facility for external
3013 auditing, as message delivery is not guaranteed (a feature that the
3014 testsuite works around).
3015 The Samba database events are also logged via the normal logging
3017 methods when the log level is set appropriately, say to
3018 dsdb_json_audit:5.
3019 Default: dsdb event notification = no
3021 dsdb group change notification (G)
3023 When enabled, this option causes Samba (acting as an Active
3025 Directory Domain Controller) to stream group membership change
3026 events across the internal message bus. Scripts built using Samba's
3027 python bindings can listen to these events by registering as the
3028 service dsdb_group_event.
3029 This is not needed for the audit logging described in log level.
3031 Instead, this should instead be considered a developer option (it
3033 assists in the Samba testsuite) rather than a facility for external
3034 auditing, as message delivery is not guaranteed (a feature that the
3035 testsuite works around).
3036 The Samba database events are also logged via the normal logging
3038 methods when the log level is set appropriately, say to
3039 dsdb_group_json_audit:5.
3040 Default: dsdb group change notification = no
3042 dsdb password event notification (G)
3044 When enabled, this option causes Samba (acting as an Active
3046 Directory Domain Controller) to stream password change and reset
3047 events across the internal message bus. Scripts built using Samba's
3048 python bindings can listen to these events by registering as the
3049 service password_event.
3050 This is not needed for the audit logging described in log level.
3052 Instead, this should instead be considered a developer option (it
3054 assists in the Samba testsuite) rather than a facility for external
3055 auditing, as message delivery is not guaranteed (a feature that the
3056 testsuite works around).
3057 The Samba database events are also logged via the normal logging
3059 methods when the log level is set appropriately, say to
3060 dsdb_password_json_audit:5.
3061 Default: dsdb password event notification = no
3063 durable handles (S)
3065 This boolean parameter controls whether Samba can grant SMB2
3067 durable file handles on a share.
3068 Note that durable handles are only enabled if kernel oplocks = no,
3070 kernel share modes = no, and posix locking = no, i.e. if the share
3071 is configured for CIFS/SMB2 only access, not supporting
3072 interoperability features with local UNIX processes or NFS
3073 operations.
3074 Also note that, for the time being, durability is not granted for a
3076 handle that has the delete on close flag set.
3077 Default: durable handles = yes
3079 ea support (S)
3081 This boolean parameter controls whether smbd(8) will allow clients
3083 to attempt to access extended attributes on a share. In order to
3084 enable this parameter on a setup with default VFS modules:
3085 • Samba must have been built with extended attributes
3087 support.
3088 • The underlying filesystem exposed by the share must
3090 support extended attributes (e.g. the getfattr(1) /
3091 setfattr(1) utilities must work).
3092 Note that the SMB protocol allows setting attributes whose value is
3094 64K bytes long, and that on NTFS, the maximum storage space for
3095 extended attributes per file is 64K. On most UNIX systems (Solaris
3096 and ZFS file system being the exception), the limits are much lower
3097 - typically 4K. Worse, the same 4K space is often used to store
3098 system metadata such as POSIX ACLs, or Samba's NT ACLs. Giving
3099 clients access to this tight space via extended attribute support
3100 could consume all of it by unsuspecting client applications, which
3101 would prevent changing system metadata due to lack of space. The
3102 default has changed to yes in Samba release 4.9.0 and above to
3103 allow better Windows fileserver compatibility in a default install.
3104 Default: ea support = yes
3106 elasticsearch:address (S)
3108 Specifies the name of the Elasticsearch server to use for Spotlight
3110 queries when using the Elasticsearch backend.
3111 Default: elasticsearch:address = localhost
3113 Example: elasticsearch:address = needle.haystack.samba.org
3115 elasticsearch:index (S)
3117 Specifies the name of the Elasticsearch index to use for Spotlight
3119 queries when using the Elasticsearch backend. The default value of
3120 "_all" is a special Elasticsearch value that performs the search
3121 operation on all indices.
3122 Default: elasticsearch:index = _all
3124 Example: elasticsearch:index = spotlight
3126 elasticsearch:mappings (G)
3128 Path to a file specifying metadata attribute mappings in JSON
3130 format. Use by the Elasticsearch backend of the Spotlight RPC
3131 service.
3132 Default: elasticsearch:mappings =
3134 /usr/share/samba/elasticsearch_mappings.json
3135 Example: elasticsearch:mappings = /usr/share/foo/mymappings.json
3137 elasticsearch:max results (S)
3139 Path to a file specifying metadata attribute mappings in JSON
3141 format. Used by the Elasticsearch backend of the Spotlight RPC
3142 service. A value of 0 means no limit.
3143 Default: elasticsearch:max results = 100
3145 Example: elasticsearch:max results = 10
3147 elasticsearch:port (S)
3149 Specifies the TCP port of the Elasticsearch server to use for
3151 Spotlight queries when using the Elasticsearch backend.
3152 Default: elasticsearch:port = 9200
3154 Example: elasticsearch:port = 9201
3156 elasticsearch:use tls (S)
3158 Specifies whether to use HTTPS when talking to the Elasticsearch
3160 server used for Spotlight queries when using the Elasticsearch
3161 backend.
3162 Default: elasticsearch:use tls = no
3164 Example: elasticsearch:use tls = yes
3166 enable asu support (G)
3168 Hosts running the "Advanced Server for Unix (ASU)" product require
3170 some special accommodations such as creating a builtin [ADMIN$]
3171 share that only supports IPC connections. The has been the default
3172 behavior in smbd for many years. However, certain Microsoft
3173 applications such as the Print Migrator tool require that the
3174 remote server support an [ADMIN$] file share. Disabling this
3175 parameter allows for creating an [ADMIN$] file share in smb.conf.
3176 Default: enable asu support = no
3178 enable core files (G)
3180 This parameter specifies whether core dumps should be written on
3182 internal exits. Normally set to yes. You should never need to
3183 change this.
3184 Default: enable core files = yes
3186 Example: enable core files = no
3188 enable privileges (G)
3190 This deprecated parameter controls whether or not smbd will honor
3192 privileges assigned to specific SIDs via either net rpc rights or
3193 one of the Windows user and group manager tools. This parameter is
3194 enabled by default. It can be disabled to prevent members of the
3195 Domain Admins group from being able to assign privileges to users
3196 or groups which can then result in certain smbd operations running
3197 as root that would normally run under the context of the connected
3198 user.
3199 An example of how privileges can be used is to assign the right to
3201 join clients to a Samba controlled domain without providing root
3202 access to the server via smbd.
3203 Please read the extended description provided in the Samba HOWTO
3205 documentation.
3206 Default: enable privileges = yes
3208 enable spoolss (G)
3210 Inverted synonym for disable spoolss.
3212 Default: enable spoolss = yes
3214 encrypt passwords (G)
3216 This parameter has been deprecated since Samba 4.11 and support for
3218 plaintext (as distinct from NTLM, NTLMv2 or Kerberos
3219 authentication) will be removed in a future Samba release.
3220 That is, in the future, the current default of encrypt passwords =
3222 yes will be the enforced behaviour.
3223 This boolean controls whether encrypted passwords will be
3225 negotiated with the client. Note that Windows NT 4.0 SP3 and above
3226 and also Windows 98 will by default expect encrypted passwords
3227 unless a registry entry is changed. To use encrypted passwords in
3228 Samba see the chapter "User Database" in the Samba HOWTO
3229 Collection.
3230 MS Windows clients that expect Microsoft encrypted passwords and
3232 that do not have plain text password support enabled will be able
3233 to connect only to a Samba server that has encrypted password
3234 support enabled and for which the user accounts have a valid
3235 encrypted password. Refer to the smbpasswd command man page for
3236 information regarding the creation of encrypted passwords for user
3237 accounts.
3238 The use of plain text passwords is NOT advised as support for this
3240 feature is no longer maintained in Microsoft Windows products. If
3241 you want to use plain text passwords you must set this parameter to
3242 no.
3243 In order for encrypted passwords to work correctly smbd(8) must
3245 either have access to a local smbpasswd(5) file (see the
3246 smbpasswd(8) program for information on how to set up and maintain
3247 this file), or set the security = [domain|ads] parameter which
3248 causes smbd to authenticate against another server.
3249 Default: encrypt passwords = yes
3251 enhanced browsing (G)
3253 This option enables a couple of enhancements to cross-subnet browse
3255 propagation that have been added in Samba but which are not
3256 standard in Microsoft implementations.
3257 The first enhancement to browse propagation consists of a regular
3259 wildcard query to a Samba WINS server for all Domain Master
3260 Browsers, followed by a browse synchronization with each of the
3261 returned DMBs. The second enhancement consists of a regular
3262 randomised browse synchronization with all currently known DMBs.
3263 You may wish to disable this option if you have a problem with
3265 empty workgroups not disappearing from browse lists. Due to the
3266 restrictions of the browse protocols, these enhancements can cause
3267 a empty workgroup to stay around forever which can be annoying.
3268 In general you should leave this option enabled as it makes
3270 cross-subnet browse propagation much more reliable.
3271 Default: enhanced browsing = yes
3273 enumports command (G)
3275 The concept of a "port" is fairly foreign to UNIX hosts. Under
3277 Windows NT/2000 print servers, a port is associated with a port
3278 monitor and generally takes the form of a local port (i.e. LPT1:,
3279 COM1:, FILE:) or a remote port (i.e. LPD Port Monitor, etc...). By
3280 default, Samba has only one port defined--"Samba Printer Port".
3281 Under Windows NT/2000, all printers must have a valid port name. If
3282 you wish to have a list of ports displayed (smbd does not use a
3283 port name for anything) other than the default "Samba Printer
3284 Port", you can define enumports command to point to a program which
3285 should generate a list of ports, one per line, to standard output.
3286 This listing will then be used in response to the level 1 and 2
3287 EnumPorts() RPC.
3288 Default: enumports command =
3290 Example: enumports command = /usr/bin/listports
3292 eventlog list (G)
3294 This option defines a list of log names that Samba will report to
3296 the Microsoft EventViewer utility. The listed eventlogs will be
3297 associated with tdb file on disk in the $(statedir)/eventlog.
3298 The administrator must use an external process to parse the normal
3300 Unix logs such as /var/log/messages and write then entries to the
3301 eventlog tdb files. Refer to the eventlogadm(8) utility for how to
3302 write eventlog entries.
3303 Default: eventlog list =
3305 Example: eventlog list = Security Application Syslog Apache
3307 fake directory create times (S)
3309 NTFS and Windows VFAT file systems keep a create time for all files
3311 and directories. This is not the same as the ctime - status change
3312 time - that Unix keeps, so Samba by default reports the earliest of
3313 the various times Unix does keep. Setting this parameter for a
3314 share causes Samba to always report midnight 1-1-1980 as the create
3315 time for directories.
3316 This option is mainly used as a compatibility option for Visual C++
3318 when used against Samba shares. Visual C++ generated makefiles have
3319 the object directory as a dependency for each object file, and a
3320 make rule to create the directory. Also, when NMAKE compares
3321 timestamps it uses the creation time when examining a directory.
3322 Thus the object directory will be created if it does not exist, but
3323 once it does exist it will always have an earlier timestamp than
3324 the object files it contains.
3325 However, Unix time semantics mean that the create time reported by
3327 Samba will be updated whenever a file is created or deleted in the
3328 directory. NMAKE finds all object files in the object directory.
3329 The timestamp of the last one built is then compared to the
3330 timestamp of the object directory. If the directory's timestamp if
3331 newer, then all object files will be rebuilt. Enabling this option
3332 ensures directories always predate their contents and an NMAKE
3333 build will proceed as expected.
3334 Default: fake directory create times = no
3336 fake oplocks (S)
3338 Oplocks are the way that SMB clients get permission from a server
3340 to locally cache file operations. If a server grants an oplock
3341 (opportunistic lock) then the client is free to assume that it is
3342 the only one accessing the file and it will aggressively cache file
3343 data. With some oplock types the client may even cache file
3344 open/close operations. This can give enormous performance benefits.
3345 When you set fake oplocks = yes, smbd(8) will always grant oplock
3347 requests no matter how many clients are using the file.
3348 It is generally much better to use the real oplocks support rather
3350 than this parameter.
3351 If you enable this option on all read-only shares or shares that
3353 you know will only be accessed from one client at a time such as
3354 physically read-only media like CDROMs, you will see a big
3355 performance improvement on many operations. If you enable this
3356 option on shares where multiple clients may be accessing the files
3357 read-write at the same time you can get data corruption. Use this
3358 option carefully!
3359 Default: fake oplocks = no
3361 follow symlinks (S)
3363 This parameter allows the Samba administrator to stop smbd(8) from
3365 following symbolic links in a particular share. Setting this
3366 parameter to no prevents any file or directory that is a symbolic
3367 link from being followed (the user will get an error). This option
3368 is very useful to stop users from adding a symbolic link to
3369 /etc/passwd in their home directory for instance. However it will
3370 slow filename lookups down slightly.
3371 This option is enabled (i.e. smbd will follow symbolic links) by
3373 default.
3374 Default: follow symlinks = yes
3376 smbd force process locks (S)
3378 This boolean option tells smbd whether to forcefully disable the
3380 use of Open File Description locks on Linux.
3381 This option should not be changed from the default unless you know
3383 what you're doing.
3384 Default: smbd force process locks = no
3386 force create mode (S)
3388 This parameter specifies a set of UNIX mode bit permissions that
3390 will always be set on a file created by Samba. This is done by
3391 bitwise 'OR'ing these bits onto the mode bits of a file that is
3392 being created. The default for this parameter is (in octal) 000.
3393 The modes in this parameter are bitwise 'OR'ed onto the file mode
3394 after the mask set in the create mask parameter is applied.
3395 The example below would force all newly created files to have read
3397 and execute permissions set for 'group' and 'other' as well as the
3398 read/write/execute bits set for the 'user'.
3399 Default: force create mode = 0000
3401 Example: force create mode = 0755
3403 force directory mode (S)
3405 This parameter specifies a set of UNIX mode bit permissions that
3407 will always be set on a directory created by Samba. This is done by
3408 bitwise 'OR'ing these bits onto the mode bits of a directory that
3409 is being created. The default for this parameter is (in octal) 0000
3410 which will not add any extra permission bits to a created
3411 directory. This operation is done after the mode mask in the
3412 parameter directory mask is applied.
3413 The example below would force all created directories to have read
3415 and execute permissions set for 'group' and 'other' as well as the
3416 read/write/execute bits set for the 'user'.
3417 Default: force directory mode = 0000
3419 Example: force directory mode = 0755
3421 force directory security mode (S)
3423 This parameter has been removed for Samba 4.0.0.
3425 No default
3427 group
3429 This parameter is a synonym for force group.
3431 force group (S)
3433 This specifies a UNIX group name that will be assigned as the
3435 default primary group for all users connecting to this service.
3436 This is useful for sharing files by ensuring that all access to
3437 files on service will use the named group for their permissions
3438 checking. Thus, by assigning permissions for this group to the
3439 files and directories within this service the Samba administrator
3440 can restrict or allow sharing of these files.
3441 In Samba 2.0.5 and above this parameter has extended functionality
3443 in the following way. If the group name listed here has a '+'
3444 character prepended to it then the current user accessing the share
3445 only has the primary group default assigned to this group if they
3446 are already assigned as a member of that group. This allows an
3447 administrator to decide that only users who are already in a
3448 particular group will create files with group ownership set to that
3449 group. This gives a finer granularity of ownership assignment. For
3450 example, the setting force group = +sys means that only users who
3451 are already in group sys will have their default primary group
3452 assigned to sys when accessing this Samba share. All other users
3453 will retain their ordinary primary group.
3454 If the force user parameter is also set the group specified in
3456 force group will override the primary group set in force user.
3457 Default: force group =
3459 Example: force group = agroup
3461 force printername (S)
3463 When printing from Windows NT (or later), each printer in smb.conf
3465 has two associated names which can be used by the client. The first
3466 is the sharename (or shortname) defined in smb.conf. This is the
3467 only printername available for use by Windows 9x clients. The
3468 second name associated with a printer can be seen when browsing to
3469 the "Printers" (or "Printers and Faxes") folder on the Samba
3470 server. This is referred to simply as the printername (not to be
3471 confused with the printer name option).
3472 When assigning a new driver to a printer on a remote Windows
3474 compatible print server such as Samba, the Windows client will
3475 rename the printer to match the driver name just uploaded. This can
3476 result in confusion for users when multiple printers are bound to
3477 the same driver. To prevent Samba from allowing the printer's
3478 printername to differ from the sharename defined in smb.conf, set
3479 force printername = yes.
3480 Be aware that enabling this parameter may affect migrating printers
3482 from a Windows server to Samba since Windows has no way to force
3483 the sharename and printername to match.
3484 It is recommended that this parameter's value not be changed once
3486 the printer is in use by clients as this could cause a user not be
3487 able to delete printer connections from their local Printers
3488 folder.
3489 Default: force printername = no
3491 force security mode (S)
3493 This parameter has been removed for Samba 4.0.0.
3495 No default
3497 force unknown acl user (S)
3499 If this parameter is set, a Windows NT ACL that contains an unknown
3501 SID (security descriptor, or representation of a user or group id)
3502 as the owner or group owner of the file will be silently mapped
3503 into the current UNIX uid or gid of the currently connected user.
3504 This is designed to allow Windows NT clients to copy files and
3506 folders containing ACLs that were created locally on the client
3507 machine and contain users local to that machine only (no domain
3508 users) to be copied to a Samba server (usually with XCOPY /O) and
3509 have the unknown userid and groupid of the file owner map to the
3510 current connected user. This can only be fixed correctly when
3511 winbindd allows arbitrary mapping from any Windows NT SID to a UNIX
3512 uid or gid.
3513 Try using this parameter when XCOPY /O gives an ACCESS_DENIED
3515 error.
3516 Default: force unknown acl user = no
3518 force user (S)
3520 This specifies a UNIX user name that will be assigned as the
3522 default user for all users connecting to this service. This is
3523 useful for sharing files. You should also use it carefully as using
3524 it incorrectly can cause security problems.
3525 This user name only gets used once a connection is established.
3527 Thus clients still need to connect as a valid user and supply a
3528 valid password. Once connected, all file operations will be
3529 performed as the "forced user", no matter what username the client
3530 connected as. This can be very useful.
3531 In Samba 2.0.5 and above this parameter also causes the primary
3533 group of the forced user to be used as the primary group for all
3534 file activity. Prior to 2.0.5 the primary group was left as the
3535 primary group of the connecting user (this was a bug).
3536 Default: force user =
3538 Example: force user = auser
3540 fss: prune stale (G)
3542 When enabled, Samba's File Server Remote VSS Protocol (FSRVP)
3544 server checks all FSRVP initiated snapshots on startup, and removes
3545 any corresponding state (including share definitions) for
3546 nonexistent snapshot paths.
3547 Default: fss: prune stale = no
3549 Example: fss: prune stale = yes
3551 fss: sequence timeout (G)
3553 The File Server Remote VSS Protocol (FSRVP) server includes a
3555 message sequence timer to ensure cleanup on unexpected client
3556 disconnect. This parameter overrides the default timeout between
3557 FSRVP operations. FSRVP timeouts can be completely disabled via a
3558 value of 0.
3559 Default: fss: sequence timeout = 180 or 1800, depending on
3561 operation
3562 Example: fss: sequence timeout = 0
3564 fstype (S)
3566 This parameter allows the administrator to configure the string
3568 that specifies the type of filesystem a share is using that is
3569 reported by smbd(8) when a client queries the filesystem type for a
3570 share. The default type is NTFS for compatibility with Windows NT
3571 but this can be changed to other strings such as Samba or FAT if
3572 required.
3573 Default: fstype = NTFS
3575 Example: fstype = Samba
3577 get quota command (G)
3579 The get quota command should only be used whenever there is no
3581 operating system API available from the OS that samba can use.
3582 This option is only available Samba was compiled with quotas
3584 support.
3585 This parameter should specify the path to a script that queries the
3587 quota information for the specified user/group for the partition
3588 that the specified directory is on.
3589 Such a script is being given 3 arguments:
3591 • directory
3593 • type of query
3595 • uid of user or gid of group
3597 The directory is actually mostly just "." - It needs to be treated
3599 relatively to the current working directory that the script can
3600 also query.
3601 The type of query can be one of:
3603 • 1 - user quotas
3605 • 2 - user default quotas (uid = -1)
3607 • 3 - group quotas
3609 • 4 - group default quotas (gid = -1)
3611 This script should print one line as output with spaces between the
3613 columns. The printed columns should be:
3614 • 1 - quota flags (0 = no quotas, 1 = quotas enabled, 2 =
3616 quotas enabled and enforced)
3617 • 2 - number of currently used blocks
3619 • 3 - the softlimit number of blocks
3621 • 4 - the hardlimit number of blocks
3623 • 5 - currently used number of inodes
3625 • 6 - the softlimit number of inodes
3627 • 7 - the hardlimit number of inodes
3629 • 8 (optional) - the number of bytes in a block(default is
3631 1024)
3632 Default: get quota command =
3634 Example: get quota command = /usr/local/sbin/query_quota
3636 getwd cache (G)
3638 This is a tuning option. When this is enabled a caching algorithm
3640 will be used to reduce the time taken for getwd() calls. This can
3641 have a significant impact on performance, especially when the wide
3642 links parameter is set to no.
3643 Default: getwd cache = yes
3645 gpo update command (G)
3647 This option sets the command that is called to apply GPO policies.
3649 The samba-gpupdate script applies System Access and Kerberos
3650 Policies to the KDC. System Access policies set minPwdAge,
3651 maxPwdAge, minPwdLength, and pwdProperties in the samdb. Kerberos
3652 Policies set kdc:service ticket lifetime, kdc:user ticket lifetime,
3653 and kdc:renewal lifetime in smb.conf.
3654 Default: gpo update command =
3656 /builddir/build/BUILD/samba-4.15.2/source4/scripting/bin/samba-gpupdate
3657 Example: gpo update command = /usr/local/sbin/gpoupdate
3659 guest account (G)
3661 This is a username which will be used for access to services which
3663 are specified as guest ok (see below). Whatever privileges this
3664 user has will be available to any client connecting to the guest
3665 service. This user must exist in the password file, but does not
3666 require a valid login. The user account "ftp" is often a good
3667 choice for this parameter.
3668 On some systems the default guest account "nobody" may not be able
3670 to print. Use another account in this case. You should test this by
3671 trying to log in as your guest user (perhaps by using the su -
3672 command) and trying to print using the system print command such as
3673 lpr(1) or lp(1).
3674 This parameter does not accept % macros, because many parts of the
3676 system require this value to be constant for correct operation.
3677 Default: guest account = nobody # default can be changed at
3679 compile-time
3680 Example: guest account = ftp
3682 public
3684 This parameter is a synonym for guest ok.
3686 guest ok (S)
3688 If this parameter is yes for a service, then no password is
3690 required to connect to the service. Privileges will be those of the
3691 guest account.
3692 This parameter nullifies the benefits of setting restrict anonymous
3694 = 2
3695 See the section below on security for more information about this
3697 option.
3698 Default: guest ok = no
3700 only guest
3702 This parameter is a synonym for guest only.
3704 guest only (S)
3706 If this parameter is yes for a service, then only guest connections
3708 to the service are permitted. This parameter will have no effect if
3709 guest ok is not set for the service.
3710 See the section below on security for more information about this
3712 option.
3713 Default: guest only = no
3715 hide dot files (S)
3717 This is a boolean parameter that controls whether files starting
3719 with a dot appear as hidden files.
3720 Default: hide dot files = yes
3722 hide files (S)
3724 This is a list of files or directories that are not visible but are
3726 accessible. The DOS 'hidden' attribute is applied to any files or
3727 directories that match.
3728 Each entry in the list must be separated by a '/', which allows
3730 spaces to be included in the entry. '*' and '?' can be used to
3731 specify multiple files or directories as in DOS wildcards.
3732 Each entry must be a Unix path, not a DOS path and must not include
3734 the Unix directory separator '/'.
3735 Note that the case sensitivity option is applicable in hiding
3737 files.
3738 Setting this parameter will affect the performance of Samba, as it
3740 will be forced to check all files and directories for a match as
3741 they are scanned.
3742 The example shown above is based on files that the Macintosh SMB
3744 client (DAVE) available from Thursby creates for internal use, and
3745 also still hides all files beginning with a dot.
3746 An example of us of this parameter is:
3748 hide files = /.*/DesktopFolderDB/TrashFor%m/resource.frk/
3750 Default: hide files = # no file are hidden
3752 hide new files timeout (S)
3754 Setting this parameter to something but 0 hides files that have
3756 been modified less than N seconds ago.
3757 It can be used for ingest/process queue style workloads. A
3759 processing application should only see files that are definitely
3760 finished. As many applications do not have proper external workflow
3761 control, this can be a way to make sure processing does not
3762 interfere with file ingest.
3763 Default: hide new files timeout = 0
3765 hide special files (S)
3767 This parameter prevents clients from seeing special files such as
3769 sockets, devices and fifo's in directory listings.
3770 Default: hide special files = no
3772 hide unreadable (S)
3774 This parameter prevents clients from seeing the existence of files
3776 that cannot be read. Defaults to off.
3777 Please note that enabling this can slow down listing large
3779 directories significantly. Samba has to evaluate the ACLs of all
3780 directory members, which can be a lot of effort.
3781 Default: hide unreadable = no
3783 hide unwriteable files (S)
3785 This parameter prevents clients from seeing the existence of files
3787 that cannot be written to. Defaults to off. Note that unwriteable
3788 directories are shown as usual.
3789 Please note that enabling this can slow down listing large
3791 directories significantly. Samba has to evaluate the ACLs of all
3792 directory members, which can be a lot of effort.
3793 Default: hide unwriteable files = no
3795 honor change notify privilege (S)
3797 This option can be used to make use of the change notify privilege.
3799 By default notify results are not checked against the file system
3800 permissions.
3801 If "honor change notify privilege" is enabled, a user will only
3803 receive notify results, if he has change notify privilege or
3804 sufficient file system permissions. If a user has the change notify
3805 privilege, he will receive all requested notify results, even if
3806 the user does not have the permissions on the file system.
3807 Default: honor change notify privilege = no
3809 host msdfs (G)
3811 If set to yes, Samba will act as a Dfs server, and allow Dfs-aware
3813 clients to browse Dfs trees hosted on the server.
3814 See also the msdfs root share level parameter. For more information
3816 on setting up a Dfs tree on Samba, refer to the MSFDS chapter in
3817 the book Samba3-HOWTO.
3818 Default: host msdfs = yes
3820 hostname lookups (G)
3822 Specifies whether samba should use (expensive) hostname lookups or
3824 use the ip addresses instead. An example place where hostname
3825 lookups are currently used is when checking the hosts deny and
3826 hosts allow.
3827 Default: hostname lookups = no
3829 Example: hostname lookups = yes
3831 allow hosts
3833 This parameter is a synonym for hosts allow.
3835 hosts allow (S)
3837 A synonym for this parameter is allow hosts.
3839 This parameter is a comma, space, or tab delimited set of hosts
3841 which are permitted to access a service.
3842 If specified in the [global] section then it will apply to all
3844 services, regardless of whether the individual service has a
3845 different setting.
3846 You can specify the hosts by name or IP number. For example, you
3848 could restrict access to only the hosts on a Class C subnet with
3849 something like allow hosts = 150.203.5.. The full syntax of the
3850 list is described in the man page hosts_access(5). Note that this
3851 man page may not be present on your system, so a brief description
3852 will be given here also.
3853 Note that the localhost address 127.0.0.1 will always be allowed
3855 access unless specifically denied by a hosts deny option.
3856 You can also specify hosts by network/netmask pairs and by netgroup
3858 names if your system supports netgroups. The EXCEPT keyword can
3859 also be used to limit a wildcard list. The following examples may
3860 provide some help:
3861 Example 1: allow all IPs in 150.203.*.*; except one
3863 hosts allow = 150.203. EXCEPT 150.203.6.66
3865 Example 2: allow hosts that match the given network/netmask
3867 hosts allow = 150.203.15.0/255.255.255.0
3869 Example 3: allow a couple of hosts
3871 hosts allow = lapland, arvidsjaur
3873 Note
3875 Note that access still requires suitable user-level passwords.
3876 See testparm(1) for a way of testing your host access to see if it
3877 does what you expect.
3878 Default: hosts allow = # none (i.e., all hosts permitted access)
3880 Example: hosts allow = 150.203.5. myhost.mynet.edu.au
3882 deny hosts
3884 This parameter is a synonym for hosts deny.
3886 hosts deny (S)
3888 The opposite of hosts allow - hosts listed here are NOT permitted
3890 access to services unless the specific services have their own
3891 lists to override this one. Where the lists conflict, the allow
3892 list takes precedence.
3893 In the event that it is necessary to deny all by default, use the
3895 keyword ALL (or the netmask 0.0.0.0/0) and then explicitly specify
3896 to the hosts allow = hosts allow parameter those hosts that should
3897 be permitted access.
3898 Default: hosts deny = # none (i.e., no hosts specifically
3900 excluded)
3901 Example: hosts deny = 150.203.4. badhost.mynet.edu.au
3903 idmap backend (G)
3905 The idmap backend provides a plugin interface for Winbind to use
3907 varying backends to store SID/uid/gid mapping tables.
3908 This option specifies the default backend that is used when no
3910 special configuration set, but it is now deprecated in favour of
3911 the new spelling idmap config * : backend.
3912 Default: idmap backend = tdb
3914 idmap cache time (G)
3916 This parameter specifies the number of seconds that Winbind's idmap
3918 interface will cache positive SID/uid/gid query results. By
3919 default, Samba will cache these results for one week.
3920 Default: idmap cache time = 604800
3922 idmap config DOMAIN : OPTION (G)
3924 ID mapping in Samba is the mapping between Windows SIDs and Unix
3926 user and group IDs. This is performed by Winbindd with a
3927 configurable plugin interface. Samba's ID mapping is configured by
3928 options starting with the idmap config prefix. An idmap option
3929 consists of the idmap config prefix, followed by a domain name or
3930 the asterisk character (*), a colon, and the name of an idmap
3931 setting for the chosen domain.
3932 The idmap configuration is hence divided into groups, one group for
3934 each domain to be configured, and one group with the asterisk
3935 instead of a proper domain name, which specifies the default
3936 configuration that is used to catch all domains that do not have an
3937 explicit idmap configuration of their own.
3938 There are three general options available:
3940 backend = backend_name
3942 This specifies the name of the idmap plugin to use as the
3943 SID/uid/gid backend for this domain. The standard backends are
3944 tdb (idmap_tdb(8)), tdb2 (idmap_tdb2(8)), ldap (idmap_ldap(8)),
3945 rid (idmap_rid(8)), hash (idmap_hash(8)), autorid
3946 (idmap_autorid(8)), ad (idmap_ad(8)) and nss (idmap_nss(8)).
3947 The corresponding manual pages contain the details, but here is
3948 a summary.
3949 The first three of these create mappings of their own using
3951 internal unixid counters and store the mappings in a database.
3952 These are suitable for use in the default idmap configuration.
3953 The rid and hash backends use a pure algorithmic calculation to
3954 determine the unixid for a SID. The autorid module is a mixture
3955 of the tdb and rid backend. It creates ranges for each domain
3956 encountered and then uses the rid algorithm for each of these
3957 automatically configured domains individually. The ad backend
3958 uses unix ids stored in Active Directory via the standard
3959 schema extensions. The nss backend reverses the standard
3960 winbindd setup and gets the unix ids via names from nsswitch
3961 which can be useful in an ldap setup.
3962 range = low - high
3964 Defines the available matching uid and gid range for which the
3965 backend is authoritative. For allocating backends, this also
3966 defines the start and the end of the range for allocating new
3967 unique IDs.
3968 winbind uses this parameter to find the backend that is
3970 authoritative for a unix ID to SID mapping, so it must be set
3971 for each individually configured domain and for the default
3972 configuration. The configured ranges must be mutually disjoint.
3973 Note that the low value interacts with the min domain uid
3975 option!
3976 read only = yes|no
3978 This option can be used to turn the writing backends tdb, tdb2,
3979 and ldap into read only mode. This can be useful e.g. in cases
3980 where a pre-filled database exists that should not be extended
3981 automatically.
3982 The following example illustrates how to configure the idmap_ad(8)
3984 backend for the CORP domain and the idmap_tdb(8) backend for all
3985 other domains. This configuration assumes that the admin of CORP
3986 assigns unix ids below 1000000 via the SFU extensions, and winbind
3987 is supposed to use the next million entries for its own mappings
3988 from trusted domains and for local groups for example.
3989 idmap config * : backend = tdb
3991 idmap config * : range = 1000000-1999999
3992 idmap config CORP : backend = ad
3994 idmap config CORP : range = 1000-999999
3995 No default
3998 winbind gid
4000 This parameter is a synonym for idmap gid.
4002 idmap gid (G)
4004 The idmap gid parameter specifies the range of group ids for the
4006 default idmap configuration. It is now deprecated in favour of
4007 idmap config * : range.
4008 See the idmap config option.
4010 Default: idmap gid =
4012 Example: idmap gid = 10000-20000
4014 idmap negative cache time (G)
4016 This parameter specifies the number of seconds that Winbind's idmap
4018 interface will cache negative SID/uid/gid query results.
4019 Default: idmap negative cache time = 120
4021 winbind uid
4023 This parameter is a synonym for idmap uid.
4025 idmap uid (G)
4027 The idmap uid parameter specifies the range of user ids for the
4029 default idmap configuration. It is now deprecated in favour of
4030 idmap config * : range.
4031 See the idmap config option.
4033 Default: idmap uid =
4035 Example: idmap uid = 10000-20000
4037 include (S)
4039 This allows you to include one config file inside another. The file
4041 is included literally, as though typed in place.
4042 It takes the standard substitutions, except %u, %P and %S.
4044 The parameter include = registry has a special meaning: It does not
4046 include a file named registry from the current working directory,
4047 but instead reads the global configuration options from the
4048 registry. See the section on registry-based configuration for
4049 details. Note that this option automatically activates registry
4050 shares.
4051 Default: include =
4053 Example: include = /usr/local/samba/lib/admin_smb.conf
4055 include system krb5 conf (G)
4057 Setting this parameter to no will prevent winbind to include the
4059 system /etc/krb5.conf file into the krb5.conf file it creates. See
4060 also create krb5 conf. This option only applies to Samba built with
4061 MIT Kerberos.
4062 Default: include system krb5 conf = yes
4064 inherit acls (S)
4066 This parameter can be used to ensure that if default acls exist on
4068 parent directories, they are always honored when creating a new
4069 file or subdirectory in these parent directories. The default
4070 behavior is to use the unix mode specified when creating the
4071 directory. Enabling this option sets the unix mode to 0777, thus
4072 guaranteeing that default directory acls are propagated. Note that
4073 using the VFS modules acl_xattr or acl_tdb which store native
4074 Windows as meta-data will automatically turn this option on for any
4075 share for which they are loaded, as they require this option to
4076 emulate Windows ACLs correctly.
4077 Default: inherit acls = no
4079 inherit owner (S)
4081 The ownership of new files and directories is normally governed by
4083 effective uid of the connected user. This option allows the Samba
4084 administrator to specify that the ownership for new files and
4085 directories should be controlled by the ownership of the parent
4086 directory.
4087 Valid options are:
4089 • no - Both the Windows (SID) owner and the UNIX (uid)
4091 owner of the file are governed by the identity of the
4092 user that created the file.
4093 • windows and unix - The Windows (SID) owner and the UNIX
4095 (uid) owner of new files and directories are set to the
4096 respective owner of the parent directory.
4097 • yes - a synonym for windows and unix.
4099 • unix only - Only the UNIX owner is set to the UNIX owner
4101 of the parent directory.
4102 Common scenarios where this behavior is useful is in implementing
4104 drop-boxes, where users can create and edit files but not delete
4105 them and ensuring that newly created files in a user's roaming
4106 profile directory are actually owned by the user.
4107 The unix only option effectively breaks the tie between the Windows
4109 owner of a file and the UNIX owner. As a logical consequence, in
4110 this mode, setting the the Windows owner of a file does not modify
4111 the UNIX owner. Using this mode should typically be combined with a
4112 backing store that can emulate the full NT ACL model without
4113 affecting the POSIX permissions, such as the acl_xattr VFS module,
4114 coupled with acl_xattr:ignore system acls = yes. This can be used
4115 to emulate folder quotas, when files are exposed only via SMB
4116 (without UNIX extensions). The UNIX owner of a directory is locally
4117 set and inherited by all subdirectories and files, and they all
4118 consume the same quota.
4119 Default: inherit owner = no
4121 inherit permissions (S)
4123 The permissions on new files and directories are normally governed
4125 by create mask, directory mask, force create mode and force
4126 directory mode but the boolean inherit permissions parameter
4127 overrides this.
4128 New directories inherit the mode of the parent directory, including
4130 bits such as setgid.
4131 New files inherit their read/write bits from the parent directory.
4133 Their execute bits continue to be determined by map archive, map
4134 hidden and map system as usual.
4135 Note that the setuid bit is never set via inheritance (the code
4137 explicitly prohibits this).
4138 This can be particularly useful on large systems with many users,
4140 perhaps several thousand, to allow a single [homes] share to be
4141 used flexibly by each user.
4142 Default: inherit permissions = no
4144 init logon delay (G)
4146 This parameter specifies a delay in milliseconds for the hosts
4148 configured for delayed initial samlogon with init logon delayed
4149 hosts.
4150 Default: init logon delay = 100
4152 init logon delayed hosts (G)
4154 This parameter takes a list of host names, addresses or networks
4156 for which the initial samlogon reply should be delayed (so other
4157 DCs get preferred by XP workstations if there are any).
4158 The length of the delay can be specified with the init logon delay
4160 parameter.
4161 Default: init logon delayed hosts =
4163 Example: init logon delayed hosts = 150.203.5. myhost.mynet.de
4165 interfaces (G)
4167 This option allows you to override the default network interfaces
4169 list that Samba will use for browsing, name registration and other
4170 NetBIOS over TCP/IP (NBT) traffic. By default Samba will query the
4171 kernel for the list of all active interfaces and use any interfaces
4172 except 127.0.0.1 that are broadcast capable.
4173 The option takes a list of interface strings. Each string can be in
4175 any of the following forms:
4176 • a network interface name (such as eth0). This may
4178 include shell-like wildcards so eth* will match any
4179 interface starting with the substring "eth"
4180 • an IP address. In this case the netmask is determined
4182 from the list of interfaces obtained from the kernel
4183 • an IP/mask pair.
4185 • a broadcast/mask pair.
4187 The "mask" parameters can either be a bit length (such as 24 for a
4189 C class network) or a full netmask in dotted decimal form.
4190 The "IP" parameters above can either be a full dotted decimal IP
4192 address or a hostname which will be looked up via the OS's normal
4193 hostname resolution mechanisms.
4194 By default Samba enables all active interfaces that are broadcast
4196 capable except the loopback adaptor (IP address 127.0.0.1).
4197 In order to support SMB3 multi-channel configurations, smbd
4199 understands some extra parameters which can be appended after the
4200 actual interface with this extended syntax (note that the quoting
4201 is important in order to handle the ; and , characters):
4202 "interface[;key1=value1[,key2=value2[...]]]"
4204 Known keys are speed, capability, and if_index. Speed is specified
4206 in bits per second. Known capabilities are RSS and RDMA. The
4207 if_index should be used with care: the values must not coincide
4208 with indexes used by the kernel. Note that these options are mainly
4209 intended for testing and development rather than for production
4210 use. At least on Linux systems, these values should be
4211 auto-detected, but the settings can serve as last a resort when
4212 autodetection is not working or is not available. The specified
4213 values overwrite the auto-detected values.
4214 The first two example below configures three network interfaces
4216 corresponding to the eth0 device and IP addresses 192.168.2.10 and
4217 192.168.3.10. The netmasks of the latter two interfaces would be
4218 set to 255.255.255.0.
4219 The other examples show how per interface extra parameters can be
4221 specified. Notice the possible usage of "," and ";", which makes
4222 the double quoting necessary.
4223 Default: interfaces =
4225 Example: interfaces = eth0 192.168.2.10/24
4227 192.168.3.10/255.255.255.0
4228 Example: interfaces = eth0, 192.168.2.10/24;
4230 192.168.3.10/255.255.255.0
4231 Example: interfaces =
4233 "eth0;if_index=65,speed=1000000000,capability=RSS"
4234 Example: interfaces = "lo;speed=1000000000" "eth0;capability=RSS"
4236 Example: interfaces = "lo;speed=1000000000" , "eth0;capability=RSS"
4238 Example: interfaces = "eth0;capability=RSS" ,
4240 "rdma1;capability=RDMA" ; "rdma2;capability=RSS,capability=RDMA"
4241 invalid users (S)
4243 This is a list of users that should not be allowed to login to this
4245 service. This is really a paranoid check to absolutely ensure an
4246 improper setting does not breach your security.
4247 A name starting with a '@' is interpreted UNIX group.
4249 The current servicename is substituted for %S. This is useful in
4251 the [homes] section.
4252 Default: invalid users = # no invalid users
4254 Example: invalid users = root fred admin @wheel
4256 iprint server (G)
4258 This parameter is only applicable if printing is set to iprint.
4260 If set, this option overrides the ServerName option in the CUPS
4262 client.conf. This is necessary if you have virtual samba servers
4263 that connect to different CUPS daemons.
4264 Default: iprint server = ""
4266 Example: iprint server = MYCUPSSERVER
4268 keepalive (G)
4270 The value of the parameter (an integer) represents the number of
4272 seconds between keepalive packets. If this parameter is zero, no
4273 keepalive packets will be sent. Keepalive packets, if sent, allow
4274 the server to tell whether a client is still present and
4275 responding.
4276 Keepalives should, in general, not be needed if the socket has the
4278 SO_KEEPALIVE attribute set on it by default. (see socket options).
4279 Basically you should only use this option if you strike
4280 difficulties.
4281 Please note this option only applies to SMB1 client connections,
4283 and has no effect on SMB2 clients.
4284 Default: keepalive = 300
4286 Example: keepalive = 600
4288 kerberos encryption types (G)
4290 This parameter determines the encryption types to use when
4292 operating as a Kerberos client. Possible values are all, strong,
4293 and legacy.
4294 Samba uses a Kerberos library (MIT or Heimdal) to obtain Kerberos
4296 tickets. This library is normally configured outside of Samba,
4297 using the krb5.conf file. This file may also include directives to
4298 configure the encryption types to be used. However, Samba
4299 implements Active Directory protocols and algorithms to locate a
4300 domain controller. In order to force the Kerberos library into
4301 using the correct domain controller, some Samba processes, such as
4302 winbindd(8) and net(8), build a private krb5.conf file for use by
4303 the Kerberos library while being invoked from Samba. This private
4304 file controls all aspects of the Kerberos library operation, and
4305 this parameter controls how the encryption types are configured
4306 within this generated file, and therefore also controls the
4307 encryption types negotiable by Samba.
4308 When set to all, all active directory encryption types are allowed.
4310 When set to strong, only AES-based encryption types are offered.
4312 This can be used in hardened environments to prevent downgrade
4313 attacks.
4314 When set to legacy, only RC4-HMAC-MD5 is allowed. Avoiding AES this
4316 way has one a very specific use. Normally, the encryption type is
4317 negotiated between the peers. However, there is one scenario in
4318 which a Windows read-only domain controller (RODC) advertises AES
4319 encryption, but then proxies the request to a writeable DC which
4320 may not support AES encryption, leading to failure of the
4321 handshake. Setting this parameter to legacy would cause samba not
4322 to negotiate AES encryption. It is assumed of course that the
4323 weaker legacy encryption types are acceptable for the setup.
4324 Default: kerberos encryption types = all
4326 kerberos method (G)
4328 Controls how kerberos tickets are verified.
4330 Valid options are:
4332 • secrets only - use only the secrets.tdb for ticket
4334 verification (default)
4335 • system keytab - use only the system keytab for ticket
4337 verification
4338 • dedicated keytab - use a dedicated keytab for ticket
4340 verification
4341 • secrets and keytab - use the secrets.tdb first, then the
4343 system keytab
4344 The major difference between "system keytab" and "dedicated keytab"
4346 is that the latter method relies on kerberos to find the correct
4347 keytab entry instead of filtering based on expected principals.
4348 When the kerberos method is in "dedicated keytab" mode, dedicated
4350 keytab file must be set to specify the location of the keytab file.
4351 Default: kerberos method = default
4353 kernel change notify (G)
4355 This parameter specifies whether Samba should ask the kernel for
4357 change notifications in directories so that SMB clients can refresh
4358 whenever the data on the server changes.
4359 This parameter is only used when your kernel supports change
4361 notification to user programs using the inotify interface.
4362 Default: kernel change notify = yes
4364 kernel oplocks (S)
4366 For UNIXes that support kernel based oplocks (currently only
4368 Linux), this parameter allows the use of them to be turned on or
4369 off. However, this disables Level II oplocks for clients as the
4370 Linux kernel does not support them properly.
4371 Kernel oplocks support allows Samba oplocks to be broken whenever a
4373 local UNIX process or NFS operation accesses a file that smbd(8)
4374 has oplocked. This allows complete data consistency between
4375 SMB/CIFS, NFS and local file access (and is a very cool feature
4376 :-).
4377 If you do not need this interaction, you should disable the
4379 parameter on Linux to get Level II oplocks and the associated
4380 performance benefit.
4381 This parameter defaults to no and is translated to a no-op on
4383 systems that do not have the necessary kernel support.
4384 Default: kernel oplocks = no
4386 kernel share modes (S)
4388 This parameter controls whether SMB share modes are translated into
4390 UNIX flocks.
4391 Kernel share modes provide a minimal level of interoperability with
4393 local UNIX processes and NFS operations by preventing access with
4394 flocks corresponding to the SMB share modes. Generally, it is very
4395 desirable to leave this enabled.
4396 Note that in order to use SMB2 durable file handles on a share, you
4398 have to turn kernel share modes off.
4399 This parameter defaults to yes and is translated to a no-op on
4401 systems that do not have the necessary kernel flock support.
4402 Default: kernel share modes = yes
4404 kpasswd port (G)
4406 Specifies which ports the Kerberos server should listen on for
4408 password changes.
4409 Default: kpasswd port = 464
4411 krb5 port (G)
4413 Specifies which port the KDC should listen on for Kerberos traffic.
4415 Default: krb5 port = 88
4417 lanman auth (G)
4419 This parameter has been deprecated since Samba 4.11 and support for
4421 LanMan (as distinct from NTLM, NTLMv2 or Kerberos authentication)
4422 will be removed in a future Samba release.
4423 That is, in the future, the current default of lanman auth = no
4425 will be the enforced behaviour.
4426 This parameter determines whether or not smbd(8) will attempt to
4428 authenticate users or permit password changes using the LANMAN
4429 password hash. If disabled, only clients which support NT password
4430 hashes (e.g. Windows NT/2000 clients, smbclient, but not Windows
4431 95/98 or the MS DOS network client) will be able to connect to the
4432 Samba host.
4433 The LANMAN encrypted response is easily broken, due to its
4435 case-insensitive nature, and the choice of algorithm. Servers
4436 without Windows 95/98/ME or MS DOS clients are advised to disable
4437 this option.
4438 When this parameter is set to no this will also result in
4440 sambaLMPassword in Samba's passdb being blanked after the next
4441 password change. As a result of that lanman clients won't be able
4442 to authenticate, even if lanman auth is re-enabled later on.
4443 Unlike the encrypt passwords option, this parameter cannot alter
4445 client behaviour, and the LANMAN response will still be sent over
4446 the network. See the client lanman auth to disable this for Samba's
4447 clients (such as smbclient)
4448 This parameter is overridden by ntlm auth, so unless that it is
4450 also set to ntlmv1-permitted or yes, then only NTLMv2 logins will
4451 be permitted and no LM hash will be stored. All modern clients
4452 support NTLMv2, and but some older clients require special
4453 configuration to use it.
4454 Default: lanman auth = no
4456 large readwrite (G)
4458 This parameter determines whether or not smbd(8) supports the new
4460 64k streaming read and write variant SMB requests introduced with
4461 Windows 2000. Note that due to Windows 2000 client redirector bugs
4462 this requires Samba to be running on a 64-bit capable operating
4463 system such as IRIX, Solaris or a Linux 2.4 kernel. Can improve
4464 performance by 10% with Windows 2000 clients. Defaults to on. Not
4465 as tested as some other Samba code paths.
4466 Default: large readwrite = yes
4468 ldap admin dn (G)
4470 The ldap admin dn defines the Distinguished Name (DN) name used by
4472 Samba to contact the ldap server when retrieving user account
4473 information. The ldap admin dn is used in conjunction with the
4474 admin dn password stored in the private/secrets.tdb file. See the
4475 smbpasswd(8) man page for more information on how to accomplish
4476 this.
4477 The ldap admin dn requires a fully specified DN. The ldap suffix is
4479 not appended to the ldap admin dn.
4480 No default
4482 ldap connection timeout (G)
4484 This parameter tells the LDAP library calls which timeout in
4486 seconds they should honor during initial connection establishments
4487 to LDAP servers. It is very useful in failover scenarios in
4488 particular. If one or more LDAP servers are not reachable at all,
4489 we do not have to wait until TCP timeouts are over. This feature
4490 must be supported by your LDAP library.
4491 This parameter is different from ldap timeout which affects
4493 operations on LDAP servers using an existing connection and not
4494 establishing an initial connection.
4495 Default: ldap connection timeout = 2
4497 ldap debug level (G)
4499 This parameter controls the debug level of the LDAP library calls.
4501 In the case of OpenLDAP, it is the same bit-field as understood by
4502 the server and documented in the slapd.conf(5) manpage. A typical
4503 useful value will be 1 for tracing function calls.
4504 The debug output from the LDAP libraries appears with the prefix
4506 [LDAP] in Samba's logging output. The level at which LDAP logging
4507 is printed is controlled by the parameter ldap debug threshold.
4508 Default: ldap debug level = 0
4510 Example: ldap debug level = 1
4512 ldap debug threshold (G)
4514 This parameter controls the Samba debug level at which the ldap
4516 library debug output is printed in the Samba logs. See the
4517 description of ldap debug level for details.
4518 Default: ldap debug threshold = 10
4520 Example: ldap debug threshold = 5
4522 ldap delete dn (G)
4524 This parameter specifies whether a delete operation in the ldapsam
4526 deletes the complete entry or only the attributes specific to
4527 Samba.
4528 Default: ldap delete dn = no
4530 ldap deref (G)
4532 This option controls whether Samba should tell the LDAP library to
4534 use a certain alias dereferencing method. The default is auto,
4535 which means that the default setting of the ldap client library
4536 will be kept. Other possible values are never, finding, searching
4537 and always. Grab your LDAP manual for more information.
4538 Default: ldap deref = auto
4540 Example: ldap deref = searching
4542 ldap follow referral (G)
4544 This option controls whether to follow LDAP referrals or not when
4546 searching for entries in the LDAP database. Possible values are on
4547 to enable following referrals, off to disable this, and auto, to
4548 use the libldap default settings. libldap's choice of following
4549 referrals or not is set in /etc/openldap/ldap.conf with the
4550 REFERRALS parameter as documented in ldap.conf(5).
4551 Default: ldap follow referral = auto
4553 Example: ldap follow referral = off
4555 ldap group suffix (G)
4557 This parameter specifies the suffix that is used for groups when
4559 these are added to the LDAP directory. If this parameter is unset,
4560 the value of ldap suffix will be used instead. The suffix string is
4561 pre-pended to the ldap suffix string so use a partial DN.
4562 Default: ldap group suffix =
4564 Example: ldap group suffix = ou=Groups
4566 ldap idmap suffix (G)
4568 This parameters specifies the suffix that is used when storing
4570 idmap mappings. If this parameter is unset, the value of ldap
4571 suffix will be used instead. The suffix string is pre-pended to the
4572 ldap suffix string so use a partial DN.
4573 Default: ldap idmap suffix =
4575 Example: ldap idmap suffix = ou=Idmap
4577 ldap machine suffix (G)
4579 It specifies where machines should be added to the ldap tree. If
4581 this parameter is unset, the value of ldap suffix will be used
4582 instead. The suffix string is pre-pended to the ldap suffix string
4583 so use a partial DN.
4584 Default: ldap machine suffix =
4586 Example: ldap machine suffix = ou=Computers
4588 ldap max anonymous request size (G)
4590 This parameter specifies the maximum permitted size (in bytes) for
4592 an LDAP request received on an anonymous connection.
4593 If the request size exceeds this limit the request will be
4595 rejected.
4596 Default: ldap max anonymous request size = 256000
4598 Example: ldap max anonymous request size = 500000
4600 ldap max authenticated request size (G)
4602 This parameter specifies the maximum permitted size (in bytes) for
4604 an LDAP request received on an authenticated connection.
4605 If the request size exceeds this limit the request will be
4607 rejected.
4608 Default: ldap max authenticated request size = 16777216
4610 Example: ldap max authenticated request size = 4194304
4612 ldap max search request size (G)
4614 This parameter specifies the maximum permitted size (in bytes) for
4616 an LDAP search request.
4617 If the request size exceeds this limit the request will be
4619 rejected.
4620 Default: ldap max search request size = 256000
4622 Example: ldap max search request size = 4194304
4624 ldap page size (G)
4626 This parameter specifies the number of entries per page.
4628 If the LDAP server supports paged results, clients can request
4630 subsets of search results (pages) instead of the entire list. This
4631 parameter specifies the size of these pages.
4632 Default: ldap page size = 1000
4634 Example: ldap page size = 512
4636 ldap password sync
4638 This parameter is a synonym for ldap passwd sync.
4640 ldap passwd sync (G)
4642 This option is used to define whether or not Samba should sync the
4644 LDAP password with the NT and LM hashes for normal accounts (NOT
4645 for workstation, server or domain trusts) on a password change via
4646 SAMBA.
4647 The ldap passwd sync can be set to one of three values:
4649 • Yes = Try to update the LDAP, NT and LM passwords and
4651 update the pwdLastSet time.
4652 • No = Update NT and LM passwords and update the
4654 pwdLastSet time.
4655 • Only = Only update the LDAP password and let the LDAP
4657 server do the rest.
4658 Default: ldap passwd sync = no
4660 ldap replication sleep (G)
4662 When Samba is asked to write to a read-only LDAP replica, we are
4664 redirected to talk to the read-write master server. This server
4665 then replicates our changes back to the 'local' server, however the
4666 replication might take some seconds, especially over slow links.
4667 Certain client activities, particularly domain joins, can become
4668 confused by the 'success' that does not immediately change the LDAP
4669 back-end's data.
4670 This option simply causes Samba to wait a short time, to allow the
4672 LDAP server to catch up. If you have a particularly high-latency
4673 network, you may wish to time the LDAP replication with a network
4674 sniffer, and increase this value accordingly. Be aware that no
4675 checking is performed that the data has actually replicated.
4676 The value is specified in milliseconds, the maximum value is 5000
4678 (5 seconds).
4679 Default: ldap replication sleep = 1000
4681 ldapsam:editposix (G)
4683 Editposix is an option that leverages ldapsam:trusted to make it
4685 simpler to manage a domain controller eliminating the need to set
4686 up custom scripts to add and manage the posix users and groups.
4687 This option will instead directly manipulate the ldap tree to
4688 create, remove and modify user and group entries. This option also
4689 requires a running winbindd as it is used to allocate new uids/gids
4690 on user/group creation. The allocation range must be therefore
4691 configured.
4692 To use this option, a basic ldap tree must be provided and the ldap
4694 suffix parameters must be properly configured. On virgin servers
4695 the default users and groups (Administrator, Guest, Domain Users,
4696 Domain Admins, Domain Guests) can be precreated with the command
4697 net sam provision. To run this command the ldap server must be
4698 running, Winbindd must be running and the smb.conf ldap options
4699 must be properly configured. The typical ldap setup used with the
4700 ldapsam:trusted = yes option is usually sufficient to use
4701 ldapsam:editposix = yes as well.
4702 An example configuration can be the following:
4704 encrypt passwords = true
4706 passdb backend = ldapsam
4707 ldapsam:trusted=yes
4709 ldapsam:editposix=yes
4710 ldap admin dn = cn=admin,dc=samba,dc=org
4712 ldap delete dn = yes
4713 ldap group suffix = ou=groups
4714 ldap idmap suffix = ou=idmap
4715 ldap machine suffix = ou=computers
4716 ldap user suffix = ou=users
4717 ldap suffix = dc=samba,dc=org
4718 idmap backend = ldap:"ldap://localhost"
4720 idmap uid = 5000-50000
4722 idmap gid = 5000-50000
4723 This configuration assumes a directory layout like described in the
4726 following ldif:
4727 dn: dc=samba,dc=org
4729 objectClass: top
4730 objectClass: dcObject
4731 objectClass: organization
4732 o: samba.org
4733 dc: samba
4734 dn: cn=admin,dc=samba,dc=org
4736 objectClass: simpleSecurityObject
4737 objectClass: organizationalRole
4738 cn: admin
4739 description: LDAP administrator
4740 userPassword: secret
4741 dn: ou=users,dc=samba,dc=org
4743 objectClass: top
4744 objectClass: organizationalUnit
4745 ou: users
4746 dn: ou=groups,dc=samba,dc=org
4748 objectClass: top
4749 objectClass: organizationalUnit
4750 ou: groups
4751 dn: ou=idmap,dc=samba,dc=org
4753 objectClass: top
4754 objectClass: organizationalUnit
4755 ou: idmap
4756 dn: ou=computers,dc=samba,dc=org
4758 objectClass: top
4759 objectClass: organizationalUnit
4760 ou: computers
4761 Default: ldapsam:editposix = no
4764 ldapsam:trusted (G)
4766 By default, Samba as a Domain Controller with an LDAP backend needs
4768 to use the Unix-style NSS subsystem to access user and group
4769 information. Due to the way Unix stores user information in
4770 /etc/passwd and /etc/group this inevitably leads to inefficiencies.
4771 One important question a user needs to know is the list of groups
4772 he is member of. The plain UNIX model involves a complete
4773 enumeration of the file /etc/group and its NSS counterparts in
4774 LDAP. UNIX has optimized functions to enumerate group membership.
4775 Sadly, other functions that are used to deal with user and group
4776 attributes lack such optimization.
4777 To make Samba scale well in large environments, the ldapsam:trusted
4779 = yes option assumes that the complete user and group database that
4780 is relevant to Samba is stored in LDAP with the standard
4781 posixAccount/posixGroup attributes. It further assumes that the
4782 Samba auxiliary object classes are stored together with the POSIX
4783 data in the same LDAP object. If these assumptions are met,
4784 ldapsam:trusted = yes can be activated and Samba can bypass the NSS
4785 system to query user group memberships. Optimized LDAP queries can
4786 greatly speed up domain logon and administration tasks. Depending
4787 on the size of the LDAP database a factor of 100 or more for common
4788 queries is easily achieved.
4789 Default: ldapsam:trusted = no
4791 ldap server require strong auth (G)
4793 The ldap server require strong auth defines whether the ldap server
4795 requires ldap traffic to be signed or signed and encrypted
4796 (sealed). Possible values are no, allow_sasl_over_tls and yes.
4797 A value of no allows simple and sasl binds over all transports.
4799 A value of allow_sasl_over_tls allows simple and sasl binds
4801 (without sign or seal) over TLS encrypted connections. Unencrypted
4802 connections only allow sasl binds with sign or seal.
4803 A value of yes allows only simple binds over TLS encrypted
4805 connections. Unencrypted connections only allow sasl binds with
4806 sign or seal.
4807 Default: ldap server require strong auth = yes
4809 ldap ssl (G)
4811 This option is used to define whether or not Samba should use SSL
4813 when connecting to the ldap server This is NOT related to Samba's
4814 previous SSL support which was enabled by specifying the --with-ssl
4815 option to the configure script.
4816 LDAP connections should be secured where possible. This may be done
4818 setting either this parameter to start tls or by specifying
4819 ldaps:// in the URL argument of passdb backend.
4820 The ldap ssl can be set to one of two values:
4822 • Off = Never use SSL when querying the directory.
4824 • start tls = Use the LDAPv3 StartTLS extended operation
4826 (RFC2830) for communicating with the directory server.
4827 Please note that this parameter does only affect rpc methods. To
4829 enable the LDAPv3 StartTLS extended operation (RFC2830) for ads,
4830 set ldap ssl = start tls and ldap ssl ads = yes. See smb.conf(5)
4831 for more information on ldap ssl ads.
4832 Default: ldap ssl = start tls
4834 ldap suffix (G)
4836 Specifies the base for all ldap suffixes and for storing the
4838 sambaDomain object.
4839 The ldap suffix will be appended to the values specified for the
4841 ldap user suffix, ldap group suffix, ldap machine suffix, and the
4842 ldap idmap suffix. Each of these should be given only a DN relative
4843 to the ldap suffix.
4844 Default: ldap suffix =
4846 Example: ldap suffix = dc=samba,dc=org
4848 ldap timeout (G)
4850 This parameter defines the number of seconds that Samba should use
4852 as timeout for LDAP operations.
4853 Default: ldap timeout = 15
4855 ldap user suffix (G)
4857 This parameter specifies where users are added to the tree. If this
4859 parameter is unset, the value of ldap suffix will be used instead.
4860 The suffix string is pre-pended to the ldap suffix string so use a
4861 partial DN.
4862 Default: ldap user suffix =
4864 Example: ldap user suffix = ou=people
4866 level2 oplocks (S)
4868 This parameter controls whether Samba supports level2 (read-only)
4870 oplocks on a share.
4871 Level2, or read-only oplocks allow Windows NT clients that have an
4873 oplock on a file to downgrade from a read-write oplock to a
4874 read-only oplock once a second client opens the file (instead of
4875 releasing all oplocks on a second open, as in traditional,
4876 exclusive oplocks). This allows all openers of the file that
4877 support level2 oplocks to cache the file for read-ahead only (ie.
4878 they may not cache writes or lock requests) and increases
4879 performance for many accesses of files that are not commonly
4880 written (such as application .EXE files).
4881 Once one of the clients which have a read-only oplock writes to the
4883 file all clients are notified (no reply is needed or waited for)
4884 and told to break their oplocks to "none" and delete any read-ahead
4885 caches.
4886 It is recommended that this parameter be turned on to speed access
4888 to shared executables.
4889 For more discussions on level2 oplocks see the CIFS spec.
4891 Currently, if kernel oplocks are supported then level2 oplocks are
4893 not granted (even if this parameter is set to yes). Note also, the
4894 oplocks parameter must be set to yes on this share in order for
4895 this parameter to have any effect.
4896 Default: level2 oplocks = yes
4898 lm announce (G)
4900 This parameter determines if nmbd(8) will produce Lanman announce
4902 broadcasts that are needed by OS/2 clients in order for them to see
4903 the Samba server in their browse list. This parameter can have
4904 three values, yes, no, or auto. The default is auto. If set to no
4905 Samba will never produce these broadcasts. If set to yes Samba will
4906 produce Lanman announce broadcasts at a frequency set by the
4907 parameter lm interval. If set to auto Samba will not send Lanman
4908 announce broadcasts by default but will listen for them. If it
4909 hears such a broadcast on the wire it will then start sending them
4910 at a frequency set by the parameter lm interval.
4911 Default: lm announce = auto
4913 Example: lm announce = yes
4915 lm interval (G)
4917 If Samba is set to produce Lanman announce broadcasts needed by
4919 OS/2 clients (see the lm announce parameter) then this parameter
4920 defines the frequency in seconds with which they will be made. If
4921 this is set to zero then no Lanman announcements will be made
4922 despite the setting of the lm announce parameter.
4923 Default: lm interval = 60
4925 Example: lm interval = 120
4927 load printers (G)
4929 A boolean variable that controls whether all printers in the
4931 printcap will be loaded for browsing by default. See the printers
4932 section for more details.
4933 Default: load printers = yes
4935 local master (G)
4937 This option allows nmbd(8) to try and become a local master browser
4939 on a subnet. If set to no then nmbd will not attempt to become a
4940 local master browser on a subnet and will also lose in all browsing
4941 elections. By default this value is set to yes. Setting this value
4942 to yes doesn't mean that Samba will become the local master browser
4943 on a subnet, just that nmbd will participate in elections for local
4944 master browser.
4945 Setting this value to no will cause nmbd never to become a local
4947 master browser.
4948 Default: local master = yes
4950 lock dir
4952 This parameter is a synonym for lock directory.
4954 lock directory (G)
4956 This option specifies the directory where lock files will be
4958 placed. The lock files are used to implement the max connections
4959 option.
4960 Note: This option can not be set inside registry configurations.
4962 The files placed in this directory are not required across service
4964 restarts and can be safely placed on volatile storage (e.g. tmpfs
4965 in Linux)
4966 Default: lock directory = /var/lib/samba/lock
4968 Example: lock directory = /var/run/samba/locks
4970 locking (S)
4972 This controls whether or not locking will be performed by the
4974 server in response to lock requests from the client.
4975 If locking = no, all lock and unlock requests will appear to
4977 succeed and all lock queries will report that the file in question
4978 is available for locking.
4979 If locking = yes, real locking will be performed by the server.
4981 This option may be useful for read-only filesystems which may not
4983 need locking (such as CDROM drives), although setting this
4984 parameter of no is not really recommended even in this case.
4985 Be careful about disabling locking either globally or in a specific
4987 service, as lack of locking may result in data corruption. You
4988 should never need to set this parameter.
4989 Default: locking = yes
4991 lock spin time (G)
4993 The time in milliseconds that smbd should keep waiting to see if a
4995 failed lock request can be granted. This parameter has changed in
4996 default value from Samba 3.0.23 from 10 to 200. The associated lock
4997 spin count parameter is no longer used in Samba 3.0.24. You should
4998 not need to change the value of this parameter.
4999 Default: lock spin time = 200
5001 log file (G)
5003 This option allows you to override the name of the Samba log file
5005 (also known as the debug file).
5006 This option takes the standard substitutions, allowing you to have
5008 separate log files for each user or machine.
5009 No default
5011 Example: log file = /usr/local/samba/var/log.%m
5013 logging (G)
5015 This parameter configures logging backends. Multiple backends can
5017 be specified at the same time, with different log levels for each
5018 backend. The parameter is a list of backends, where each backend is
5019 specified as backend[:option][@loglevel].
5020 The 'option' parameter can be used to pass backend-specific
5022 options.
5023 The log level for a backend is optional, if it is not set for a
5025 backend, all messages are sent to this backend. The parameter log
5026 level determines overall log levels, while the log levels specified
5027 here define what is sent to the individual backends.
5028 When logging is set, it overrides the syslog and syslog only
5030 parameters.
5031 Some backends are only available when Samba has been compiled with
5033 the additional libraries. The overall list of logging backends:
5034 • syslog
5036 • file
5038 • systemd
5040 • lttng
5042 • gpfs
5044 • ringbuf
5046 The ringbuf backend supports an optional size argument to change
5048 the buffer size used, the default is 1 MB: ringbuf:size=NBYTES
5049 Default: logging =
5051 Example: logging = syslog@1 file
5053 debuglevel
5055 This parameter is a synonym for log level.
5057 log level (G)
5059 The value of the parameter (a string) allows the debug level
5061 (logging level) to be specified in the smb.conf file.
5062 This parameter has been extended since the 2.2.x series, now it
5064 allows one to specify the debug level for multiple debug classes
5065 and distinct logfiles for debug classes. This is to give greater
5066 flexibility in the configuration of the system. The following debug
5067 classes are currently implemented:
5068 • all
5070 • tdb
5072 • printdrivers
5074 • lanman
5076 • smb
5078 • rpc_parse
5080 • rpc_srv
5082 • rpc_cli
5084 • passdb
5086 • sam
5088 • auth
5090 • winbind
5092 • vfs
5094 • idmap
5096 • quota
5098 • acls
5100 • locking
5102 • msdfs
5104 • dmapi
5106 • registry
5108 • scavenger
5110 • dns
5112 • ldb
5114 • tevent
5116 • auth_audit
5118 • auth_json_audit
5120 • kerberos
5122 • drs_repl
5124 • smb2
5126 • smb2_credits
5128 • dsdb_audit
5130 • dsdb_json_audit
5132 • dsdb_password_audit
5134 • dsdb_password_json_audit
5136 • dsdb_transaction_audit
5138 • dsdb_transaction_json_audit
5140 • dsdb_group_audit
5142 • dsdb_group_json_audit
5144 Various modules register dynamic debug classes at first usage:
5146 • catia
5148 • dfs_samba4
5150 • extd_audit
5152 • fileid
5154 • fruit
5156 • full_audit
5158 • media_harmony
5160 • preopen
5162 • recycle
5164 • shadow_copy
5166 • shadow_copy
5168 • unityed_media
5170 • virusfilter
5172 To configure the logging for specific classes to go into a
5174 different file then log file, you can append @PATH to the class, eg
5175 log level = 1 full_audit:1@/var/log/audit.log.
5176 Authentication and authorization audit information is logged under
5178 the auth_audit, and if Samba was not compiled with --without-json,
5179 a JSON representation is logged under auth_json_audit.
5180 Support is comprehensive for all authentication and authorisation
5182 of user accounts in the Samba Active Directory Domain Controller,
5183 as well as the implicit authentication in password changes. In the
5184 file server, NTLM authentication, SMB and RPC authorization is
5185 covered.
5186 Log levels for auth_audit and auth_audit_json are:
5188 • 2: Authentication Failure
5190 • 3: Authentication Success
5192 • 4: Authorization Success
5194 • 5: Anonymous Authentication and Authorization Success
5196 Changes to the AD DC sam.ldb database are logged under the
5198 dsdb_audit and a JSON representation is logged under
5199 dsdb_json_audit.
5200 Group membership changes to the AD DC sam.ldb database are logged
5202 under the dsdb_group_audit and a JSON representation is logged
5203 under dsdb_group_json_audit.
5204 Log levels for dsdb_audit, dsdb_json_audit, dsdb_group_audit,
5206 dsdb_group_json_audit and dsdb_json_audit are:
5207 • 5: Database modifications
5209 • 5: Replicated updates from another DC
5211 Password changes and Password resets in the AD DC are logged under
5213 dsdb_password_audit and a JSON representation is logged under the
5214 dsdb_password_json_audit. Password changes will also appears as
5215 authentication events via auth_audit and auth_audit_json.
5216 Log levels for dsdb_password_audit and dsdb_password_json_audit
5218 are:
5219 • 5: Successful password changes and resets
5221 Transaction rollbacks and prepare commit failures are logged under
5223 the dsdb_transaction_audit and a JSON representation is logged
5224 under the dsdb_transaction_json_audit.
5225 Log levels for dsdb_transaction_audit and dsdb_transaction_json
5227 are:
5228 • 5: Transaction failure (rollback)
5230 • 10: Transaction success (commit)
5232 Transaction roll-backs are possible in Samba, and whilst they
5234 rarely reflect anything more than the failure of an individual
5235 operation (say due to the add of a conflicting record), they are
5236 possible. Audit logs are already generated and sent to the system
5237 logs before the transaction is complete. Logging the transaction
5238 details allows the identification of password and sam.ldb
5239 operations that have been rolled back, and so have not actually
5240 persisted.
5241 Warning
5243 Changes to sam.ldb made locally by the root user with direct
5244 access to the database are not logged to the system logs, but
5245 to the administrator's own console. While less than ideal, any
5246 user able to make such modifications could disable the audit
5247 logging in any case.
5248 Default: log level = 0
5249 Example: log level = 3 passdb:5 auth:10 winbind:2
5251 Example: log level = 1 full_audit:1@/var/log/audit.log winbind:2
5253 log nt token command (G)
5255 This option can be set to a command that will be called when new nt
5257 tokens are created.
5258 This is only useful for development purposes.
5260 Default: log nt token command =
5262 logon drive (G)
5264 This parameter specifies the local path to which the home directory
5266 will be connected (see logon home) and is only used by NT
5267 Workstations.
5268 Note that this option is only useful if Samba is set up as a logon
5270 server.
5271 Default: logon drive =
5273 Example: logon drive = h:
5275 logon home (G)
5277 This parameter specifies the home directory location when a
5279 Win95/98 or NT Workstation logs into a Samba PDC. It allows you to
5280 do
5281 C:\>NET USE H: /HOME
5283 from a command prompt, for example.
5285 This option takes the standard substitutions, allowing you to have
5287 separate logon scripts for each user or machine.
5288 This parameter can be used with Win9X workstations to ensure that
5290 roaming profiles are stored in a subdirectory of the user's home
5291 directory. This is done in the following way:
5292 logon home = \\%N\%U\profile
5294 This tells Samba to return the above string, with substitutions
5296 made when a client requests the info, generally in a NetUserGetInfo
5297 request. Win9X clients truncate the info to \\server\share when a
5298 user does net use /home but use the whole string when dealing with
5299 profiles.
5300 Note that in prior versions of Samba, the logon path was returned
5302 rather than logon home. This broke net use /home but allowed
5303 profiles outside the home directory. The current implementation is
5304 correct, and can be used for profiles if you use the above trick.
5305 Disable this feature by setting logon home = "" - using the empty
5307 string.
5308 This option is only useful if Samba is set up as a logon server.
5310 Default: logon home = \\%N\%U
5312 Example: logon home = \\remote_smb_server\%U
5314 logon path (G)
5316 This parameter specifies the directory where roaming profiles
5318 (Desktop, NTuser.dat, etc) are stored. Contrary to previous
5319 versions of these manual pages, it has nothing to do with Win 9X
5320 roaming profiles. To find out how to handle roaming profiles for
5321 Win 9X system, see the logon home parameter.
5322 This option takes the standard substitutions, allowing you to have
5324 separate logon scripts for each user or machine. It also specifies
5325 the directory from which the "Application Data", desktop, start
5326 menu, network neighborhood, programs and other folders, and their
5327 contents, are loaded and displayed on your Windows NT client.
5328 The share and the path must be readable by the user for the
5330 preferences and directories to be loaded onto the Windows NT
5331 client. The share must be writeable when the user logs in for the
5332 first time, in order that the Windows NT client can create the
5333 NTuser.dat and other directories. Thereafter, the directories and
5334 any of the contents can, if required, be made read-only. It is not
5335 advisable that the NTuser.dat file be made read-only - rename it to
5336 NTuser.man to achieve the desired effect (a MANdatory profile).
5337 Windows clients can sometimes maintain a connection to the [homes]
5339 share, even though there is no user logged in. Therefore, it is
5340 vital that the logon path does not include a reference to the homes
5341 share (i.e. setting this parameter to \\%N\homes\profile_path will
5342 cause problems).
5343 This option takes the standard substitutions, allowing you to have
5345 separate logon scripts for each user or machine.
5346 Warning
5348 Do not quote the value. Setting this as “\\%N\profile\%U” will
5349 break profile handling. Where the tdbsam or ldapsam passdb
5350 backend is used, at the time the user account is created the
5351 value configured for this parameter is written to the passdb
5352 backend and that value will over-ride the parameter value
5353 present in the smb.conf file. Any error present in the passdb
5354 backend account record must be editted using the appropriate
5355 tool (pdbedit on the command-line, or any other locally
5356 provided system tool).
5357 Note that this option is only useful if Samba is set up as a domain
5358 controller.
5359 Disable the use of roaming profiles by setting the value of this
5361 parameter to the empty string. For example, logon path = "". Take
5362 note that even if the default setting in the smb.conf file is the
5363 empty string, any value specified in the user account settings in
5364 the passdb backend will over-ride the effect of setting this
5365 parameter to null. Disabling of all roaming profile use requires
5366 that the user account settings must also be blank.
5367 An example of use is:
5369 logon path = \\PROFILESERVER\PROFILE\%U
5371 Default: logon path = \\%N\%U\profile
5373 logon script (G)
5375 This parameter specifies the batch file (.bat) or NT command file
5377 (.cmd) to be downloaded and run on a machine when a user
5378 successfully logs in. The file must contain the DOS style CR/LF
5379 line endings. Using a DOS-style editor to create the file is
5380 recommended.
5381 The script must be a relative path to the [netlogon] service. If
5383 the [netlogon] service specifies a path of
5384 /usr/local/samba/netlogon, and logon script = STARTUP.BAT, then the
5385 file that will be downloaded is:
5386 /usr/local/samba/netlogon/STARTUP.BAT
5388 The contents of the batch file are entirely your choice. A
5390 suggested command would be to add NET TIME \\SERVER /SET /YES, to
5391 force every machine to synchronize clocks with the same time
5392 server. Another use would be to add NET USE U: \\SERVER\UTILS for
5393 commonly used utilities, or
5394 NET USE Q: \\SERVER\ISO9001_QA
5396 for example.
5398 Note that it is particularly important not to allow write access to
5400 the [netlogon] share, or to grant users write permission on the
5401 batch files in a secure environment, as this would allow the batch
5402 files to be arbitrarily modified and security to be breached.
5403 This option takes the standard substitutions, allowing you to have
5405 separate logon scripts for each user or machine.
5406 This option is only useful if Samba is set up as a logon server in
5408 a classic domain controller role. If Samba is set up as an Active
5409 Directory domain controller, LDAP attribute scriptPath is used
5410 instead. For configurations where passdb backend = ldapsam is in
5411 use, this option only defines a default value in case LDAP
5412 attribute sambaLogonScript is missing.
5413 Default: logon script =
5415 Example: logon script = scripts\%U.bat
5417 log writeable files on exit (G)
5419 When the network connection between a CIFS client and Samba dies,
5421 Samba has no option but to simply shut down the server side of the
5422 network connection. If this happens, there is a risk of data
5423 corruption because the Windows client did not complete all write
5424 operations that the Windows application requested. Setting this
5425 option to "yes" makes smbd log with a level 0 message a list of all
5426 files that have been opened for writing when the network connection
5427 died. Those are the files that are potentially corrupted. It is
5428 meant as an aid for the administrator to give him a list of files
5429 to do consistency checks on.
5430 Default: log writeable files on exit = no
5432 lppause command (S)
5434 This parameter specifies the command to be executed on the server
5436 host in order to stop printing or spooling a specific print job.
5437 This command should be a program or script which takes a printer
5439 name and job number to pause the print job. One way of implementing
5440 this is by using job priorities, where jobs having a too low
5441 priority won't be sent to the printer.
5442 If a %p is given then the printer name is put in its place. A %j is
5444 replaced with the job number (an integer). On HPUX (see
5445 printing=hpux ), if the -p%p option is added to the lpq command,
5446 the job will show up with the correct status, i.e. if the job
5447 priority is lower than the set fence priority it will have the
5448 PAUSED status, whereas if the priority is equal or higher it will
5449 have the SPOOLED or PRINTING status.
5450 Note that it is good practice to include the absolute path in the
5452 lppause command as the PATH may not be available to the server.
5453 Currently no default value is given to this string, unless the
5455 value of the printing parameter is SYSV, in which case the default
5456 is : lp -i %p-%j -H hold or if the value of the printing parameter
5457 is SOFTQ, then the default is: qstat -s -j%j -h.
5458 Default: lppause command = # determined by printing parameter
5460 Example: lppause command = /usr/bin/lpalt %p-%j -p0
5462 lpq cache time (G)
5464 This controls how long lpq info will be cached for to prevent the
5466 lpq command being called too often. A separate cache is kept for
5467 each variation of the lpq command used by the system, so if you use
5468 different lpq commands for different users then they won't share
5469 cache information.
5470 The cache files are stored in /tmp/lpq.xxxx where xxxx is a hash of
5472 the lpq command in use.
5473 The default is 30 seconds, meaning that the cached results of a
5475 previous identical lpq command will be used if the cached data is
5476 less than 30 seconds old. A large value may be advisable if your
5477 lpq command is very slow.
5478 A value of 0 will disable caching completely.
5480 Default: lpq cache time = 30
5482 Example: lpq cache time = 10
5484 lpq command (S)
5486 This parameter specifies the command to be executed on the server
5488 host in order to obtain lpq-style printer status information.
5489 This command should be a program or script which takes a printer
5491 name as its only parameter and outputs printer status information.
5492 Currently nine styles of printer status information are supported;
5494 BSD, AIX, LPRNG, PLP, SYSV, HPUX, QNX, CUPS, and SOFTQ. This covers
5495 most UNIX systems. You control which type is expected using the
5496 printing = option.
5497 Some clients (notably Windows for Workgroups) may not correctly
5499 send the connection number for the printer they are requesting
5500 status information about. To get around this, the server reports on
5501 the first printer service connected to by the client. This only
5502 happens if the connection number sent is invalid.
5503 If a %p is given then the printer name is put in its place.
5505 Otherwise it is placed at the end of the command.
5506 Note that it is good practice to include the absolute path in the
5508 lpq command as the $PATH may not be available to the server. When
5509 compiled with the CUPS libraries, no lpq command is needed because
5510 smbd will make a library call to obtain the print queue listing.
5511 Default: lpq command = # determined by printing parameter
5513 Example: lpq command = /usr/bin/lpq -P%p
5515 lpresume command (S)
5517 This parameter specifies the command to be executed on the server
5519 host in order to restart or continue printing or spooling a
5520 specific print job.
5521 This command should be a program or script which takes a printer
5523 name and job number to resume the print job. See also the lppause
5524 command parameter.
5525 If a %p is given then the printer name is put in its place. A %j is
5527 replaced with the job number (an integer).
5528 Note that it is good practice to include the absolute path in the
5530 lpresume command as the PATH may not be available to the server.
5531 See also the printing parameter.
5533 Default: Currently no default value is given to this string, unless
5535 the value of the printing parameter is SYSV, in which case the
5536 default is:
5537 lp -i %p-%j -H resume
5539 or if the value of the printing parameter is SOFTQ, then the
5541 default is:
5542 qstat -s -j%j -r
5544 Default: lpresume command = # determined by printing parameter
5546 Example: lpresume command = /usr/bin/lpalt %p-%j -p2
5548 lprm command (S)
5550 This parameter specifies the command to be executed on the server
5552 host in order to delete a print job.
5553 This command should be a program or script which takes a printer
5555 name and job number, and deletes the print job.
5556 If a %p is given then the printer name is put in its place. A %j is
5558 replaced with the job number (an integer).
5559 Note that it is good practice to include the absolute path in the
5561 lprm command as the PATH may not be available to the server.
5562 Examples of use are:
5564 lprm command = /usr/bin/lprm -P%p %j
5566 or
5568 lprm command = /usr/bin/cancel %p-%j
5570 Default: lprm command = # determined by printing parameter
5572 lsa over netlogon (G)
5574 Setting this deprecated option will allow the RPC server in the AD
5576 DC to answer the LSARPC interface on the \pipe\netlogon IPC pipe.
5577 When enabled, this matches the behaviour of Microsoft's Windows,
5579 due to their internal implementation choices.
5580 If it is disabled (the default), the AD DC can offer improved
5582 performance, as the netlogon server is decoupled and can run as
5583 multiple processes.
5584 Default: lsa over netlogon = no
5586 machine password timeout (G)
5588 If a Samba server is a member of a Windows NT or Active Directory
5590 Domain (see the security = domain and security = ads parameters),
5591 then periodically a running winbindd process will try and change
5592 the MACHINE ACCOUNT PASSWORD stored in the TDB called secrets.tdb.
5593 This parameter specifies how often this password will be changed,
5594 in seconds. The default is one week (expressed in seconds), the
5595 same as a Windows NT Domain member server.
5596 See also smbpasswd(8), and the security = domain and security = ads
5598 parameters.
5599 Default: machine password timeout = 604800
5601 magic output (S)
5603 This parameter specifies the name of a file which will contain
5605 output created by a magic script (see the magic script parameter
5606 below).
5607 Warning
5609 If two clients use the same magic script in the same directory
5610 the output file content is undefined.
5611 Default: magic output = # <magic script name>.out
5612 Example: magic output = myfile.txt
5614 magic script (S)
5616 This parameter specifies the name of a file which, if opened, will
5618 be executed by the server when the file is closed. This allows a
5619 UNIX script to be sent to the Samba host and executed on behalf of
5620 the connected user.
5621 Scripts executed in this way will be deleted upon completion
5623 assuming that the user has the appropriate level of privilege and
5624 the file permissions allow the deletion.
5625 If the script generates output, output will be sent to the file
5627 specified by the magic output parameter (see above).
5628 Note that some shells are unable to interpret scripts containing
5630 CR/LF instead of CR as the end-of-line marker. Magic scripts must
5631 be executable as is on the host, which for some hosts and some
5632 shells will require filtering at the DOS end.
5633 Magic scripts are EXPERIMENTAL and should NOT be relied upon.
5635 Default: magic script =
5637 Example: magic script = user.csh
5639 mangled names (S)
5641 This controls whether non-DOS names under UNIX should be mapped to
5643 DOS-compatible names ("mangled") and made visible, or whether
5644 non-DOS names should simply be ignored.
5645 See the section on name mangling for details on how to control the
5647 mangling process.
5648 Possible option settings are
5650 • yes - enables name mangling for all not DOS 8.3
5652 conforming names.
5653 • no - disables any name mangling.
5655 • illegal (default) - does mangling for names with illegal
5657 NTFS characters. This is the most sensible setting for
5658 modern clients that don't use the shortname anymore.
5659 If mangling is used then the mangling method is as follows:
5661 • The first (up to) five alphanumeric characters before
5663 the rightmost dot of the filename are preserved, forced
5664 to upper case, and appear as the first (up to) five
5665 characters of the mangled name.
5666 • A tilde "~" is appended to the first part of the mangled
5668 name, followed by a two-character unique sequence, based
5669 on the original root name (i.e., the original filename
5670 minus its final extension). The final extension is
5671 included in the hash calculation only if it contains any
5672 upper case characters or is longer than three
5673 characters.
5674 Note that the character to use may be specified using
5676 the mangling char option, if you don't like '~'.
5677 • Files whose UNIX name begins with a dot will be
5679 presented as DOS hidden files. The mangled name will be
5680 created as for other filenames, but with the leading dot
5681 removed and "___" as its extension regardless of actual
5682 original extension (that's three underscores).
5683 The two-digit hash value consists of upper case alphanumeric
5685 characters.
5686 This algorithm can cause name collisions only if files in a
5688 directory share the same first five alphanumeric characters. The
5689 probability of such a clash is 1/1300.
5690 The name mangling (if enabled) allows a file to be copied between
5692 UNIX directories from Windows/DOS while retaining the long UNIX
5693 filename. UNIX files can be renamed to a new extension from
5694 Windows/DOS and will retain the same basename. Mangled names do not
5695 change between sessions.
5696 Default: mangled names = illegal
5698 Example: mangled names = no
5700 mangle prefix (G)
5702 controls the number of prefix characters from the original name
5704 used when generating the mangled names. A larger value will give a
5705 weaker hash and therefore more name collisions. The minimum value
5706 is 1 and the maximum value is 6.
5707 mangle prefix is effective only when mangling method is hash2.
5709 Default: mangle prefix = 1
5711 Example: mangle prefix = 4
5713 mangling char (S)
5715 This controls what character is used as the magic character in name
5717 mangling. The default is a '~' but this may interfere with some
5718 software. Use this option to set it to whatever you prefer. This is
5719 effective only when mangling method is hash.
5720 Default: mangling char = ~
5722 Example: mangling char = ^
5724 mangling method (G)
5726 controls the algorithm used for the generating the mangled names.
5728 Can take two different values, "hash" and "hash2". "hash" is the
5729 algorithm that was used in Samba for many years and was the default
5730 in Samba 2.2.x "hash2" is now the default and is newer and
5731 considered a better algorithm (generates less collisions) in the
5732 names. Many Win32 applications store the mangled names and so
5733 changing to algorithms must not be done lightly as these
5734 applications may break unless reinstalled.
5735 Default: mangling method = hash2
5737 Example: mangling method = hash
5739 map acl inherit (S)
5741 This boolean parameter controls whether smbd(8) will attempt to map
5743 the 'inherit' and 'protected' access control entry flags stored in
5744 Windows ACLs into an extended attribute called user.SAMBA_PAI
5745 (POSIX ACL Inheritance). This parameter requires supports for
5746 extended attributes on the filesystem and allows the Windows ACL
5747 editor to store inheritance information while NT ACLs are mapped
5748 best-effort to the POSIX ACLs.
5749 Default: map acl inherit = no
5751 map archive (S)
5753 This controls whether the DOS archive attribute should be mapped to
5755 the UNIX owner execute bit. The DOS archive bit is set when a file
5756 has been modified since its last backup. One motivation for this
5757 option is to keep Samba/your PC from making any file it touches
5758 from becoming executable under UNIX. This can be quite annoying for
5759 shared source code, documents, etc...
5760 Note that this parameter will be ignored if the store dos
5762 attributes parameter is set, as the DOS archive attribute will then
5763 be stored inside a UNIX extended attribute.
5764 Note that this requires the create mask parameter to be set such
5766 that owner execute bit is not masked out (i.e. it must include
5767 100). See the parameter create mask for details.
5768 Default: map archive = yes
5770 map hidden (S)
5772 This controls whether DOS style hidden files should be mapped to
5774 the UNIX world execute bit.
5775 Note that this parameter will be ignored if the store dos
5777 attributes parameter is set, as the DOS hidden attribute will then
5778 be stored inside a UNIX extended attribute.
5779 Note that this requires the create mask to be set such that the
5781 world execute bit is not masked out (i.e. it must include 001). See
5782 the parameter create mask for details.
5783 Default: map hidden = no
5785 map readonly (S)
5787 This controls how the DOS read only attribute should be mapped from
5789 a UNIX filesystem.
5790 This parameter can take three different values, which tell smbd(8)
5792 how to display the read only attribute on files, where either store
5793 dos attributes is set to No, or no extended attribute is present.
5794 If store dos attributes is set to yes then this parameter is
5795 ignored. This is a new parameter introduced in Samba version
5796 3.0.21.
5797 The three settings are :
5799 • Yes - The read only DOS attribute is mapped to the
5801 inverse of the user or owner write bit in the unix
5802 permission mode set. If the owner write bit is not set,
5803 the read only attribute is reported as being set on the
5804 file. If the read only DOS attribute is set, Samba sets
5805 the owner, group and others write bits to zero. Write
5806 bits set in an ACL are ignored by Samba. If the read
5807 only DOS attribute is unset, Samba simply sets the write
5808 bit of the owner to one.
5809 • Permissions - The read only DOS attribute is mapped to
5811 the effective permissions of the connecting user, as
5812 evaluated by smbd(8) by reading the unix permissions and
5813 POSIX ACL (if present). If the connecting user does not
5814 have permission to modify the file, the read only
5815 attribute is reported as being set on the file.
5816 • No - The read only DOS attribute is unaffected by
5818 permissions, and can only be set by the store dos
5819 attributes method. This may be useful for exporting
5820 mounted CDs.
5821 Note that this parameter will be ignored if the store dos
5823 attributes parameter is set, as the DOS 'read-only' attribute will
5824 then be stored inside a UNIX extended attribute.
5825 The default has changed to no in Samba release 4.9.0 and above to
5827 allow better Windows fileserver compatibility in a default install.
5828 In addition the default setting of store dos attributes has been
5829 changed to Yes in Samba release 4.9.0 and above.
5830 Default: map readonly = no
5832 map system (S)
5834 This controls whether DOS style system files should be mapped to
5836 the UNIX group execute bit.
5837 Note that this parameter will be ignored if the store dos
5839 attributes parameter is set, as the DOS system attribute will then
5840 be stored inside a UNIX extended attribute.
5841 Note that this requires the create mask to be set such that the
5843 group execute bit is not masked out (i.e. it must include 010). See
5844 the parameter create mask for details.
5845 Default: map system = no
5847 map to guest (G)
5849 This parameter can take four different values, which tell smbd(8)
5851 what to do with user login requests that don't match a valid UNIX
5852 user in some way.
5853 The four settings are :
5855 • Never - Means user login requests with an invalid
5857 password are rejected. This is the default.
5858 • Bad User - Means user logins with an invalid password
5860 are rejected, unless the username does not exist, in
5861 which case it is treated as a guest login and mapped
5862 into the guest account.
5863 • Bad Password - Means user logins with an invalid
5865 password are treated as a guest login and mapped into
5866 the guest account. Note that this can cause problems as
5867 it means that any user incorrectly typing their password
5868 will be silently logged on as "guest" - and will not
5869 know the reason they cannot access files they think they
5870 should - there will have been no message given to them
5871 that they got their password wrong. Helpdesk services
5872 will hate you if you set the map to guest parameter this
5873 way :-).
5874 • Bad Uid - Is only applicable when Samba is configured in
5876 some type of domain mode security (security =
5877 {domain|ads}) and means that user logins which are
5878 successfully authenticated but which have no valid Unix
5879 user account (and smbd is unable to create one) should
5880 be mapped to the defined guest account. This was the
5881 default behavior of Samba 2.x releases. Note that if a
5882 member server is running winbindd, this option should
5883 never be required because the nss_winbind library will
5884 export the Windows domain users and groups to the
5885 underlying OS via the Name Service Switch interface.
5886 Note that this parameter is needed to set up "Guest" share
5888 services. This is because in these modes the name of the resource
5889 being requested is not sent to the server until after the server
5890 has successfully authenticated the client so the server cannot make
5891 authentication decisions at the correct time (connection to the
5892 share) for "Guest" shares.
5893 Default: map to guest = Never
5895 Example: map to guest = Bad User
5897 max connections (S)
5899 This option allows the number of simultaneous connections to a
5901 service to be limited. If max connections is greater than 0 then
5902 connections will be refused if this number of connections to the
5903 service are already open. A value of zero mean an unlimited number
5904 of connections may be made.
5905 Record lock files are used to implement this feature. The lock
5907 files will be stored in the directory specified by the lock
5908 directory option.
5909 Default: max connections = 0
5911 Example: max connections = 10
5913 max disk size (G)
5915 This option allows you to put an upper limit on the apparent size
5917 of disks. If you set this option to 100 then all shares will appear
5918 to be not larger than 100 MB in size.
5919 Note that this option does not limit the amount of data you can put
5921 on the disk. In the above case you could still store much more than
5922 100 MB on the disk, but if a client ever asks for the amount of
5923 free disk space or the total disk size then the result will be
5924 bounded by the amount specified in max disk size.
5925 This option is primarily useful to work around bugs in some pieces
5927 of software that can't handle very large disks, particularly disks
5928 over 1GB in size.
5929 A max disk size of 0 means no limit.
5931 Default: max disk size = 0
5933 Example: max disk size = 1000
5935 max log size (G)
5937 This option (an integer in kilobytes) specifies the max size the
5939 log file should grow to. Samba periodically checks the size and if
5940 it is exceeded it will rename the file, adding a .old extension.
5941 A size of 0 means no limit.
5943 Default: max log size = 5000
5945 Example: max log size = 1000
5947 max mux (G)
5949 This option controls the maximum number of outstanding simultaneous
5951 SMB operations that Samba tells the client it will allow. You
5952 should never need to set this parameter.
5953 Default: max mux = 50
5955 max open files (G)
5957 This parameter limits the maximum number of open files that one
5959 smbd(8) file serving process may have open for a client at any one
5960 time. This parameter can be set very high (16384) as Samba uses
5961 only one bit per unopened file. Setting this parameter lower than
5962 16384 will cause Samba to complain and set this value back to the
5963 minimum of 16384, as Windows 7 depends on this number of open file
5964 handles being available.
5965 The limit of the number of open files is usually set by the UNIX
5967 per-process file descriptor limit rather than this parameter so you
5968 should never need to touch this parameter.
5969 Default: max open files = 16384
5971 max print jobs (S)
5973 This parameter limits the maximum number of jobs allowable in a
5975 Samba printer queue at any given moment. If this number is
5976 exceeded, smbd(8) will remote "Out of Space" to the client.
5977 Default: max print jobs = 1000
5979 Example: max print jobs = 5000
5981 max reported print jobs (S)
5983 This parameter limits the maximum number of jobs displayed in a
5985 port monitor for Samba printer queue at any given moment. If this
5986 number is exceeded, the excess jobs will not be shown. A value of
5987 zero means there is no limit on the number of print jobs reported.
5988 Default: max reported print jobs = 0
5990 Example: max reported print jobs = 1000
5992 max smbd processes (G)
5994 This parameter limits the maximum number of smbd(8) processes
5996 concurrently running on a system and is intended as a stopgap to
5997 prevent degrading service to clients in the event that the server
5998 has insufficient resources to handle more than this number of
5999 connections. Remember that under normal operating conditions, each
6000 user will have an smbd(8) associated with him or her to handle
6001 connections to all shares from a given host.
6002 For a Samba ADDC running the standard process model this option
6004 limits the number of processes forked to handle requests. Currently
6005 new processes are only forked for ldap and netlogon requests.
6006 Default: max smbd processes = 0
6008 Example: max smbd processes = 1000
6010 max stat cache size (G)
6012 This parameter limits the size in memory of any stat cache being
6014 used to speed up case insensitive name mappings. It represents the
6015 number of kilobyte (1024) units the stat cache can use. A value of
6016 zero, meaning unlimited, is not advisable due to increased memory
6017 usage. You should not need to change this parameter.
6018 Default: max stat cache size = 512
6020 Example: max stat cache size = 100
6022 max ttl (G)
6024 This option tells nmbd(8) what the default 'time to live' of
6026 NetBIOS names should be (in seconds) when nmbd is requesting a name
6027 using either a broadcast packet or from a WINS server. You should
6028 never need to change this parameter. The default is 3 days.
6029 Default: max ttl = 259200
6031 max wins ttl (G)
6033 This option tells smbd(8) when acting as a WINS server (wins
6035 support = yes) what the maximum 'time to live' of NetBIOS names
6036 that nmbd will grant will be (in seconds). You should never need to
6037 change this parameter. The default is 6 days (518400 seconds).
6038 Default: max wins ttl = 518400
6040 max xmit (G)
6042 This option controls the maximum packet size that will be
6044 negotiated by Samba's smbd(8) for the SMB1 protocol. The default is
6045 16644, which matches the behavior of Windows 2000. A value below
6046 2048 is likely to cause problems. You should never need to change
6047 this parameter from its default value.
6048 Default: max xmit = 16644
6050 Example: max xmit = 8192
6052 mdns name (G)
6054 This parameter controls the name that multicast DNS support
6056 advertises as its' hostname.
6057 The default is to use the NETBIOS name which is typically the
6059 hostname in all capital letters.
6060 A setting of mdns will defer the hostname configuration to the MDNS
6062 library that is used.
6063 Default: mdns name = netbios
6065 message command (G)
6067 This specifies what command to run when the server receives a
6069 WinPopup style message.
6070 This would normally be a command that would deliver the message
6072 somehow. How this is to be done is up to your imagination.
6073 An example is:
6075 message command = csh -c 'xedit %s;rm %s' &
6077 This delivers the message using xedit, then removes it afterwards.
6079 NOTE THAT IT IS VERY IMPORTANT THAT THIS COMMAND RETURN
6080 IMMEDIATELY. That's why I have the '&' on the end. If it doesn't
6081 return immediately then your PCs may freeze when sending messages
6082 (they should recover after 30 seconds, hopefully).
6083 All messages are delivered as the global guest user. The command
6085 takes the standard substitutions, although
6086 %u won't work (%U may be better in this case).
6087 Apart from the standard substitutions, some additional ones apply.
6089 In particular:
6090 • %s = the filename containing the message.
6092 • %t = the destination that the message was sent to
6094 (probably the server name).
6095 • %f = who the message is from.
6097 You could make this command send mail, or whatever else takes your
6099 fancy. Please let us know of any really interesting ideas you have.
6100 Here's a way of sending the messages as mail to root:
6102 message command = /bin/mail -s 'message from %f on %m' root < %s; rm %s
6104 If you don't have a message command then the message won't be
6106 delivered and Samba will tell the sender there was an error.
6107 Unfortunately WfWg totally ignores the error code and carries on
6108 regardless, saying that the message was delivered.
6109 If you want to silently delete it then try:
6111 message command = rm %s
6113 Default: message command =
6115 Example: message command = csh -c 'xedit %s; rm %s' &
6117 min domain uid (G)
6119 The integer parameter specifies the minimum uid allowed when
6121 mapping a local account to a domain account.
6122 Note that this option interacts with the configured idmap ranges!
6124 Default: min domain uid = 1000
6126 min print space (S)
6128 This sets the minimum amount of free disk space that must be
6130 available before a user will be able to spool a print job. It is
6131 specified in kilobytes. The default is 0, which means a user can
6132 always spool a print job.
6133 Default: min print space = 0
6135 Example: min print space = 2000
6137 min receivefile size (G)
6139 This option changes the behavior of smbd(8) when processing
6141 SMBwriteX calls. Any incoming SMBwriteX call on a non-signed
6142 SMB/CIFS connection greater than this value will not be processed
6143 in the normal way but will be passed to any underlying kernel
6144 recvfile or splice system call (if there is no such call Samba will
6145 emulate in user space). This allows zero-copy writes directly from
6146 network socket buffers into the filesystem buffer cache, if
6147 available. It may improve performance but user testing is
6148 recommended. If set to zero Samba processes SMBwriteX calls in the
6149 normal way. To enable POSIX large write support (SMB/CIFS writes up
6150 to 16Mb) this option must be nonzero. The maximum value is 128k.
6151 Values greater than 128k will be silently set to 128k.
6152 Note this option will have NO EFFECT if set on a SMB signed
6154 connection.
6155 The default is zero, which disables this option.
6157 Default: min receivefile size = 0
6159 min wins ttl (G)
6161 This option tells nmbd(8) when acting as a WINS server (wins
6163 support = yes) what the minimum 'time to live' of NetBIOS names
6164 that nmbd will grant will be (in seconds). You should never need to
6165 change this parameter. The default is 6 hours (21600 seconds).
6166 Default: min wins ttl = 21600
6168 mit kdc command (G)
6170 This option specifies the path to the MIT kdc binary.
6172 If the KDC is not installed in the default location and wasn't
6174 correctly detected during build then you should modify this
6175 variable and point it to the correct binary.
6176 Default: mit kdc command = /usr/sbin/krb5kdc
6178 Example: mit kdc command = /opt/mit/sbin/krb5kdc
6180 msdfs proxy (S)
6182 This parameter indicates that the share is a stand-in for another
6184 CIFS share whose location is specified by the value of the
6185 parameter. When clients attempt to connect to this share, they are
6186 redirected to one or multiple, comma separated proxied shares using
6187 the SMB-Dfs protocol.
6188 Only Dfs roots can act as proxy shares. Take a look at the msdfs
6190 root and host msdfs options to find out how to set up a Dfs root
6191 share.
6192 No default
6194 Example: msdfs proxy =
6196 \otherserver\someshare,\otherserver2\someshare
6197 msdfs root (S)
6199 If set to yes, Samba treats the share as a Dfs root and allows
6201 clients to browse the distributed file system tree rooted at the
6202 share directory. Dfs links are specified in the share directory by
6203 symbolic links of the form msdfs:serverA\\shareA,serverB\\shareB
6204 and so on. For more information on setting up a Dfs tree on Samba,
6205 refer to the MSDFS chapter in the Samba3-HOWTO book.
6206 Default: msdfs root = no
6208 msdfs shuffle referrals (S)
6210 If set to yes, Samba will shuffle Dfs referrals for a given Dfs
6212 link if multiple are available, allowing for load balancing across
6213 clients. For more information on setting up a Dfs tree on Samba,
6214 refer to the MSDFS chapter in the Samba3-HOWTO book.
6215 Default: msdfs shuffle referrals = no
6217 multicast dns register (G)
6219 If compiled with proper support for it, Samba will announce itself
6221 with multicast DNS services like for example provided by the Avahi
6222 daemon.
6223 This parameter allows disabling Samba to register itself.
6225 Default: multicast dns register = yes
6227 name cache timeout (G)
6229 Specifies the number of seconds it takes before entries in samba's
6231 hostname resolve cache time out. If the timeout is set to 0. the
6232 caching is disabled.
6233 Default: name cache timeout = 660
6235 Example: name cache timeout = 0
6237 name resolve order (G)
6239 This option is used by the programs in the Samba suite to determine
6241 what naming services to use and in what order to resolve host names
6242 to IP addresses. Its main purpose to is to control how netbios name
6243 resolution is performed. The option takes a space separated string
6244 of name resolution options.
6245 The options are: "lmhosts", "host", "wins" and "bcast". They cause
6247 names to be resolved as follows:
6248 • lmhosts : Lookup an IP address in the Samba lmhosts
6250 file. If the line in lmhosts has no name type attached
6251 to the NetBIOS name (see the manpage for lmhosts for
6252 details) then any name type matches for lookup.
6253 • host : Do a standard host name to IP address resolution,
6255 using the system /etc/hosts or DNS lookups. This method
6256 of name resolution is operating system depended for
6257 instance on IRIX or Solaris this may be controlled by
6258 the /etc/nsswitch.conf file. Note that this method is
6259 used only if the NetBIOS name type being queried is the
6260 0x20 (server) name type or 0x1c (domain controllers).
6261 The latter case is only useful for active directory
6262 domains and results in a DNS query for the SRV RR entry
6263 matching _ldap._tcp.domain.
6264 • wins : Query a name with the IP address listed in the
6266 WINSSERVER parameter. If no WINS server has been
6267 specified this method will be ignored.
6268 • bcast : Do a broadcast on each of the known local
6270 interfaces listed in the interfaces parameter. This is
6271 the least reliable of the name resolution methods as it
6272 depends on the target host being on a locally connected
6273 subnet.
6274 The example below will cause the local lmhosts file to be examined
6276 first, followed by a broadcast attempt, followed by a normal system
6277 hostname lookup.
6278 When Samba is functioning in ADS security mode (security = ads) it
6280 is advised to use following settings for name resolve order:
6281 name resolve order = wins bcast
6283 DC lookups will still be done via DNS, but fallbacks to netbios
6285 names will not inundate your DNS servers with needless queries for
6286 DOMAIN<0x1c> lookups.
6287 Default: name resolve order = lmhosts wins host bcast
6289 Example: name resolve order = lmhosts bcast host
6291 socket address
6293 This parameter is a synonym for nbt client socket address.
6295 nbt client socket address (G)
6297 This option allows you to control what address Samba will send NBT
6299 client packets from, and process replies using, including in nmbd.
6300 Setting this option should never be necessary on usual Samba
6302 servers running only one nmbd.
6303 By default Samba will send UDP packets from the OS default address
6305 for the destination, and accept replies on 0.0.0.0.
6306 This parameter is deprecated. See bind interfaces only = Yes and
6308 interfaces for the previous behaviour of controlling the normal
6309 listening sockets.
6310 Default: nbt client socket address = 0.0.0.0
6312 Example: nbt client socket address = 192.168.2.20
6314 nbtd:wins_prepend1Bto1Cqueries (G)
6316 Normally queries for 0x1C names (all logon servers for a domain)
6318 will return the first address of the 0x1B names (domain master
6319 browser and PDC) as first address in the result list. As many
6320 client only use the first address in the list by default, all
6321 clients will use the same server (the PDC). Windows servers have an
6322 option to disable this behavior (since Windows 2000 Service Pack
6323 2).
6324 Default: nbtd:wins_prepend1Bto1Cqueries = yes
6326 nbtd:wins_wins_randomize1Clist (G)
6328 Normally queries for 0x1C names will return the addresses in the
6330 same order as they're stored in the database, that means first all
6331 addresses which have been directly registered at the local wins
6332 server and then all addresses registered at other servers. Windows
6333 servers have an option to change this behavior and randomize the
6334 returned addresses. Set this parameter to "yes" and Samba will sort
6335 the address list depending on the client address and the matching
6336 bits of the addresses, the first address is randomized based on
6337 depending on the "nbtd:wins_randomize1Clist_mask" parameter.
6338 Default: nbtd:wins_wins_randomize1Clist = no
6340 nbtd:wins_randomize1Clist_mask (G)
6342 If the "nbtd:wins_randomize1Clist" parameter is set to "yes", then
6344 randomizing of the first returned address is based on the specified
6345 netmask. If there are addresses which are in the same subnet as the
6346 client address, the first returned address is randomly chosen out
6347 them. Otherwise the first returned address is randomly chosen out
6348 of all addresses.
6349 Default: nbtd:wins_randomize1Clist_mask = 255.255.255.0
6351 nbt port (G)
6353 Specifies which port the server should use for NetBIOS over IP name
6355 services traffic.
6356 Default: nbt port = 137
6358 ncalrpc dir (G)
6360 This directory will hold a series of named pipes to allow RPC over
6362 inter-process communication.
6363 This will allow Samba and other unix processes to interact over
6365 DCE/RPC without using TCP/IP. Additionally a sub-directory 'np' has
6366 restricted permissions, and allows a trusted communication channel
6367 between Samba processes
6368 Default: ncalrpc dir = /run/samba/ncalrpc
6370 Example: ncalrpc dir = /var/run/samba/ncalrpc
6372 netbios aliases (G)
6374 This is a list of NetBIOS names that nmbd will advertise as
6376 additional names by which the Samba server is known. This allows
6377 one machine to appear in browse lists under multiple names. If a
6378 machine is acting as a browse server or logon server none of these
6379 names will be advertised as either browse server or logon servers,
6380 only the primary name of the machine will be advertised with these
6381 capabilities.
6382 Default: netbios aliases = # empty string (no additional names)
6384 Example: netbios aliases = TEST TEST1 TEST2
6386 netbios name (G)
6388 This sets the NetBIOS name by which a Samba server is known. By
6390 default it is the same as the first component of the host's DNS
6391 name. If a machine is a browse server or logon server this name (or
6392 the first component of the hosts DNS name) will be the name that
6393 these services are advertised under.
6394 Note that the maximum length for a NetBIOS name is 15 characters.
6396 There is a bug in Samba that breaks operation of browsing and
6398 access to shares if the netbios name is set to the literal name
6399 PIPE. To avoid this problem, do not name your Samba server PIPE.
6400 Default: netbios name = # machine DNS name
6402 Example: netbios name = MYNAME
6404 netbios scope (G)
6406 This sets the NetBIOS scope that Samba will operate under. This
6408 should not be set unless every machine on your LAN also sets this
6409 value.
6410 Default: netbios scope =
6412 neutralize nt4 emulation (G)
6414 This option controls whether winbindd sends the
6416 NETLOGON_NEG_NEUTRALIZE_NT4_EMULATION flag in order to bypass the
6417 NT4 emulation of a domain controller.
6418 Typically you should not need set this. It can be useful for
6420 upgrades from NT4 to AD domains.
6421 The behavior can be controlled per netbios domain by using
6423 'neutralize nt4 emulation:NETBIOSDOMAIN = yes' as option.
6424 Default: neutralize nt4 emulation = no
6426 nmbd bind explicit broadcast (G)
6428 This option causes nmbd(8) to explicitly bind to the broadcast
6430 address of the local subnets. This is needed to make nmbd work
6431 correctly in combination with the socket address option. You should
6432 not need to unset this option.
6433 Default: nmbd bind explicit broadcast = yes
6435 nsupdate command (G)
6437 This option sets the path to the nsupdate command which is used for
6439 GSS-TSIG dynamic DNS updates.
6440 Default: nsupdate command = /usr/bin/nsupdate -g
6442 nt acl support (S)
6444 This boolean parameter controls whether smbd(8) will attempt to map
6446 UNIX permissions into Windows NT access control lists. The UNIX
6447 permissions considered are the traditional UNIX owner and group
6448 permissions, as well as POSIX ACLs set on any files or directories.
6449 This parameter was formally a global parameter in releases prior to
6450 2.2.2.
6451 Default: nt acl support = yes
6453 ntlm auth (G)
6455 This parameter determines whether or not smbd(8) will attempt to
6457 authenticate users using the NTLM encrypted password response for
6458 this local passdb (SAM or account database).
6459 If disabled, both NTLM and LanMan authencication against the local
6461 passdb is disabled.
6462 Note that these settings apply only to local users, authentication
6464 will still be forwarded to and NTLM authentication accepted against
6465 any domain we are joined to, and any trusted domain, even if
6466 disabled or if NTLMv2-only is enforced here. To control NTLM
6467 authentiation for domain users, this must option must be configured
6468 on each DC.
6469 By default with ntlm auth set to ntlmv2-only only NTLMv2 logins
6471 will be permitted. All modern clients support NTLMv2 by default,
6472 but some older clients will require special configuration to use
6473 it.
6474 The primary user of NTLMv1 is MSCHAPv2 for VPNs and 802.1x.
6476 The available settings are:
6478 • ntlmv1-permitted (alias yes) - Allow NTLMv1 and above
6480 for all clients.
6481 This is the required setting for to enable the lanman
6483 auth parameter.
6484 • ntlmv2-only (alias no) - Do not allow NTLMv1 to be used,
6486 but permit NTLMv2.
6487 • mschapv2-and-ntlmv2-only - Only allow NTLMv1 when the
6489 client promises that it is providing MSCHAPv2
6490 authentication (such as the ntlm_auth tool).
6491 • disabled - Do not accept NTLM (or LanMan) authentication
6493 of any level, nor permit NTLM password changes.
6494 The default changed from yes to no with Samba 4.5. The default
6496 changed again to ntlmv2-only with Samba 4.7, however the behaviour
6497 is unchanged.
6498 Default: ntlm auth = ntlmv2-only
6500 nt pipe support (G)
6502 This boolean parameter controls whether smbd(8) will allow Windows
6504 NT clients to connect to the NT SMB specific IPC$ pipes. This is a
6505 developer debugging option and can be left alone.
6506 Default: nt pipe support = yes
6508 ntp signd socket directory (G)
6510 This setting controls the location of the socket that the NTP
6512 daemon uses to communicate with Samba for signing packets.
6513 If a non-default path is specified here, then it is also necessary
6515 to make NTP aware of the new path using the ntpsigndsocket
6516 directive in ntp.conf.
6517 Default: ntp signd socket directory = /var/lib/samba/ntp_signd
6519 nt status support (G)
6521 This boolean parameter controls whether smbd(8) will negotiate NT
6523 specific status support with Windows NT/2k/XP clients. This is a
6524 developer debugging option and should be left alone. If this option
6525 is set to no then Samba offers exactly the same DOS error codes
6526 that versions prior to Samba 2.2.3 reported.
6527 You should not need to ever disable this parameter.
6529 Default: nt status support = yes
6531 ntvfs handler (S)
6533 This specifies the NTVFS handlers for this share.
6535 • unixuid: Sets up user credentials based on POSIX
6537 gid/uid.
6538 • cifs: Proxies a remote CIFS FS. Mainly useful for
6540 testing.
6541 • nbench: Filter module that saves data useful to the
6543 nbench benchmark suite.
6544 • ipc: Allows using SMB for inter process communication.
6546 Only used for the IPC$ share.
6547 • posix: Maps POSIX FS semantics to NT semantics
6549 • print: Allows printing over SMB. This is LANMAN-style
6551 printing, not the be confused with the spoolss DCE/RPC
6552 interface used by later versions of Windows.
6553 Note that this option is only used when the NTVFS file server is in
6555 use. It is not used with the (default) s3fs file server.
6556 Default: ntvfs handler = unixuid, default
6558 null passwords (G)
6560 Allow or disallow client access to accounts that have null
6562 passwords.
6563 See also smbpasswd(5).
6565 Default: null passwords = no
6567 obey pam restrictions (G)
6569 When Samba 3.0 is configured to enable PAM support (i.e.
6571 --with-pam), this parameter will control whether or not Samba
6572 should obey PAM's account and session management directives. The
6573 default behavior is to use PAM for clear text authentication only
6574 and to ignore any account or session management. Note that Samba
6575 always ignores PAM for authentication in the case of encrypt
6576 passwords = yes. The reason is that PAM modules cannot support the
6577 challenge/response authentication mechanism needed in the presence
6578 of SMB password encryption.
6579 Default: obey pam restrictions = no
6581 old password allowed period (G)
6583 Number of minutes to permit an NTLM login after a password change
6585 or reset using the old password. This allows the user to re-cache
6586 the new password on multiple clients without disrupting a network
6587 reconnection in the meantime.
6588 This parameter only applies when server role is set to Active
6590 Directory Domain Controller.
6591 Default: old password allowed period = 60
6593 oplock break wait time (G)
6595 This is a tuning parameter added due to bugs in both Windows 9x and
6597 WinNT. If Samba responds to a client too quickly when that client
6598 issues an SMB that can cause an oplock break request, then the
6599 network client can fail and not respond to the break request. This
6600 tuning parameter (which is set in milliseconds) is the amount of
6601 time Samba will wait before sending an oplock break request to such
6602 (broken) clients.
6603 Warning
6605 DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ AND
6606 UNDERSTOOD THE SAMBA OPLOCK CODE.
6607 Default: oplock break wait time = 0
6608 oplocks (S)
6610 This boolean option tells smbd whether to issue oplocks
6612 (opportunistic locks) to file open requests on this share. The
6613 oplock code can dramatically (approx. 30% or more) improve the
6614 speed of access to files on Samba servers. It allows the clients to
6615 aggressively cache files locally and you may want to disable this
6616 option for unreliable network environments (it is turned on by
6617 default in Windows NT Servers).
6618 Oplocks may be selectively turned off on certain files with a
6620 share. See the veto oplock files parameter. On some systems oplocks
6621 are recognized by the underlying operating system. This allows data
6622 synchronization between all access to oplocked files, whether it be
6623 via Samba or NFS or a local UNIX process. See the kernel oplocks
6624 parameter for details.
6625 Default: oplocks = yes
6627 os2 driver map (G)
6629 The parameter is used to define the absolute path to a file
6631 containing a mapping of Windows NT printer driver names to OS/2
6632 printer driver names. The format is:
6633 <nt driver name> = <os2 driver name>.<device name>
6635 For example, a valid entry using the HP LaserJet 5 printer driver
6637 would appear as HP LaserJet 5L = LASERJET.HP LaserJet 5L.
6638 The need for the file is due to the printer driver namespace
6640 problem described in the chapter on Classical Printing in the
6641 Samba3-HOWTO book. For more details on OS/2 clients, please refer
6642 to chapter on other clients in the Samba3-HOWTO book.
6643 Default: os2 driver map =
6645 os level (G)
6647 This integer value controls what level Samba advertises itself as
6649 for browse elections. The value of this parameter determines
6650 whether nmbd(8) has a chance of becoming a local master browser for
6651 the workgroup in the local broadcast area.
6652 Note: By default, Samba will win a local master browsing election
6654 over all Microsoft operating systems except a Windows NT 4.0/2000
6655 Domain Controller. This means that a misconfigured Samba host can
6656 effectively isolate a subnet for browsing purposes. This parameter
6657 is largely auto-configured in the Samba-3 release series and it is
6658 seldom necessary to manually override the default setting. Please
6659 refer to the chapter on Network Browsing in the Samba-3 HOWTO
6660 document for further information regarding the use of this
6661 parameter. Note: The maximum value for this parameter is 255. If
6662 you use higher values, counting will start at 0!
6663 Default: os level = 20
6665 Example: os level = 65
6667 pam password change (G)
6669 With the addition of better PAM support in Samba 2.2, this
6671 parameter, it is possible to use PAM's password change control flag
6672 for Samba. If enabled, then PAM will be used for password changes
6673 when requested by an SMB client instead of the program listed in
6674 passwd program. It should be possible to enable this without
6675 changing your passwd chat parameter for most setups.
6676 Default: pam password change = no
6678 panic action (G)
6680 This is a Samba developer option that allows a system command to be
6682 called when either smbd(8) or nmbd(8) crashes. This is usually used
6683 to draw attention to the fact that a problem occurred.
6684 Default: panic action =
6686 Example: panic action = /bin/sleep 90000
6688 passdb backend (G)
6690 This option allows the administrator to chose which backend will be
6692 used for storing user and possibly group information. This allows
6693 you to swap between different storage mechanisms without recompile.
6694 The parameter value is divided into two parts, the backend's name,
6696 and a 'location' string that has meaning only to that particular
6697 backed. These are separated by a : character.
6698 Available backends can include:
6700 • smbpasswd - The old plaintext passdb backend. Some Samba
6702 features will not work if this passdb backend is used.
6703 Takes a path to the smbpasswd file as an optional
6704 argument.
6705 • tdbsam - The TDB based password storage backend. Takes a
6707 path to the TDB as an optional argument (defaults to
6708 passdb.tdb in the private dir directory.
6709 • ldapsam - The LDAP based passdb backend. Takes an LDAP
6711 URL as an optional argument (defaults to
6712 ldap://localhost)
6713 LDAP connections should be secured where possible. This
6715 may be done using either Start-TLS (see ldap ssl) or by
6716 specifying ldaps:// in the URL argument.
6717 Multiple servers may also be specified in double-quotes.
6719 Whether multiple servers are supported or not and the
6720 exact syntax depends on the LDAP library you use.
6721 Examples of use are:
6724 passdb backend = tdbsam:/etc/samba/private/passdb.tdb
6726 or multi server LDAP URL with OpenLDAP library:
6728 passdb backend = ldapsam:"ldap://ldap-1.example.com ldap://ldap-2.example.com"
6730 or multi server LDAP URL with Netscape based LDAP library:
6732 passdb backend = ldapsam:"ldap://ldap-1.example.com ldap-2.example.com"
6734 Default: passdb backend = tdbsam
6736 passdb expand explicit (G)
6738 This parameter controls whether Samba substitutes %-macros in the
6740 passdb fields if they are explicitly set. We used to expand macros
6741 here, but this turned out to be a bug because the Windows client
6742 can expand a variable %G_osver% in which %G would have been
6743 substituted by the user's primary group.
6744 Default: passdb expand explicit = no
6746 passwd chat (G)
6748 This string controls the "chat" conversation that takes places
6750 between smbd(8) and the local password changing program to change
6751 the user's password. The string describes a sequence of
6752 response-receive pairs that smbd(8) uses to determine what to send
6753 to the passwd program and what to expect back. If the expected
6754 output is not received then the password is not changed.
6755 This chat sequence is often quite site specific, depending on what
6757 local methods are used for password control.
6758 Note that this parameter only is used if the unix password sync
6760 parameter is set to yes. This sequence is then called AS ROOT when
6761 the SMB password in the smbpasswd file is being changed, without
6762 access to the old password cleartext. This means that root must be
6763 able to reset the user's password without knowing the text of the
6764 previous password.
6765 The string can contain the macro %n which is substituted for the
6767 new password. The old password (%o) is only available when encrypt
6768 passwords has been disabled. The chat sequence can also contain the
6769 standard macros \n, \r, \t and \s to give line-feed,
6770 carriage-return, tab and space. The chat sequence string can also
6771 contain a '*' which matches any sequence of characters. Double
6772 quotes can be used to collect strings with spaces in them into a
6773 single string.
6774 If the send string in any part of the chat sequence is a full stop
6776 ".", then no string is sent. Similarly, if the expect string is a
6777 full stop then no string is expected.
6778 If the pam password change parameter is set to yes, the chat pairs
6780 may be matched in any order, and success is determined by the PAM
6781 result, not any particular output. The \n macro is ignored for PAM
6782 conversions.
6783 Default: passwd chat = *new*password* %n\n *new*password* %n\n
6785 *changed*
6786 Example: passwd chat = "*Enter NEW password*" %n\n "*Reenter NEW
6788 password*" %n\n "*Password changed*"
6789 passwd chat debug (G)
6791 This boolean specifies if the passwd chat script parameter is run
6793 in debug mode. In this mode the strings passed to and received from
6794 the passwd chat are printed in the smbd(8) log with a debug level
6795 of 100. This is a dangerous option as it will allow plaintext
6796 passwords to be seen in the smbd log. It is available to help Samba
6797 admins debug their passwd chat scripts when calling the passwd
6798 program and should be turned off after this has been done. This
6799 option has no effect if the pam password change parameter is set.
6800 This parameter is off by default.
6801 Default: passwd chat debug = no
6803 passwd chat timeout (G)
6805 This integer specifies the number of seconds smbd will wait for an
6807 initial answer from a passwd chat script being run. Once the
6808 initial answer is received the subsequent answers must be received
6809 in one tenth of this time. The default it two seconds.
6810 Default: passwd chat timeout = 2
6812 passwd program (G)
6814 The name of a program that can be used to set UNIX user passwords.
6816 Any occurrences of %u will be replaced with the user name. The user
6817 name is checked for existence before calling the password changing
6818 program.
6819 Also note that many passwd programs insist in reasonable passwords,
6821 such as a minimum length, or the inclusion of mixed case chars and
6822 digits. This can pose a problem as some clients (such as Windows
6823 for Workgroups) uppercase the password before sending it.
6824 Note that if the unix password sync parameter is set to yes then
6826 this program is called AS ROOT before the SMB password in the
6827 smbpasswd file is changed. If this UNIX password change fails, then
6828 smbd will fail to change the SMB password also (this is by design).
6829 If the unix password sync parameter is set this parameter MUST USE
6831 ABSOLUTE PATHS for ALL programs called, and must be examined for
6832 security implications. Note that by default unix password sync is
6833 set to no.
6834 Default: passwd program =
6836 Example: passwd program = /bin/passwd %u
6838 password hash gpg key ids (G)
6840 If samba is running as an active directory domain controller, it is
6842 possible to store the cleartext password of accounts in a
6843 PGP/OpenGPG encrypted form.
6844 You can specify one or more recipients by key id or user id. Note
6846 that 32bit key ids are not allowed, specify at least 64bit.
6847 The value is stored as 'Primary:SambaGPG' in the
6849 supplementalCredentials attribute.
6850 As password changes can occur on any domain controller, you should
6852 configure this on each of them. Note that this feature is currently
6853 available only on Samba domain controllers.
6854 This option is only available if samba was compiled with gpgme
6856 support.
6857 You may need to export the GNUPGHOME environment variable before
6859 starting samba. It is strongly recommended to only store the
6860 public key in this location. The private key is not used for
6861 encryption and should be only stored where decryption is required.
6862 Being able to restore the cleartext password helps, when they need
6864 to be imported into other authentication systems later (see
6865 samba-tool user getpassword) or you want to keep the passwords in
6866 sync with another system, e.g. an OpenLDAP server (see samba-tool
6867 user syncpasswords).
6868 While this option needs to be configured on all domain controllers,
6870 the samba-tool user syncpasswords command should run on a single
6871 domain controller only (typically the PDC-emulator).
6872 Default: password hash gpg key ids =
6874 Example: password hash gpg key ids = 4952E40301FAB41A
6876 Example: password hash gpg key ids = selftest@samba.example.com
6878 Example: password hash gpg key ids = selftest@samba.example.com,
6880 4952E40301FAB41A
6881 password hash userPassword schemes (G)
6883 This parameter determines whether or not samba(8) acting as an
6885 Active Directory Domain Controller will attempt to store additional
6886 passwords hash types for the user
6887 The values are stored as 'Primary:userPassword' in the
6889 supplementalCredentials attribute. The value of this option is a
6890 hash type.
6891 The currently supported hash types are:
6893 • CryptSHA256
6895 • CryptSHA512
6897 Multiple instances of a hash type may be computed and stored. The
6899 password hashes are calculated using the crypt(3) call. The number
6900 of rounds used to compute the hash can be specified by adding
6901 ':rounds=xxxx' to the hash type, i.e. CryptSHA512:rounds=4500 would
6902 calculate an SHA512 hash using 4500 rounds. If not specified the
6903 Operating System defaults for crypt(3) are used.
6904 As password changes can occur on any domain controller, you should
6906 configure this on each of them. Note that this feature is currently
6907 available only on Samba domain controllers.
6908 Currently the NT Hash of the password is recorded when these hashes
6910 are calculated and stored. When retrieving the hashes the current
6911 value of the NT Hash is checked against the stored NT Hash. This
6912 detects password changes that have not updated the password hashes.
6913 In this case samba-tool user will ignore the stored hash values.
6914 Being able to obtain the hashed password helps, when they need to
6916 be imported into other authentication systems later (see samba-tool
6917 user getpassword) or you want to keep the passwords in sync with
6918 another system, e.g. an OpenLDAP server (see samba-tool user
6919 syncpasswords).
6920 Related command: unix password sync
6922 Default: password hash userPassword schemes =
6924 Example: password hash userPassword schemes = CryptSHA256
6926 Example: password hash userPassword schemes = CryptSHA256
6928 CryptSHA512
6929 Example: password hash userPassword schemes =
6931 CryptSHA256:rounds=5000 CryptSHA512:rounds=7000
6932 password server (G)
6934 By specifying the name of a domain controller with this option, and
6936 using security = [ads|domain] it is possible to get Samba to do all
6937 its username/password validation using a specific remote server.
6938 Ideally, this option should not be used, as the default '*'
6940 indicates to Samba to determine the best DC to contact dynamically,
6941 just as all other hosts in an AD domain do. This allows the domain
6942 to be maintained (addition and removal of domain controllers)
6943 without modification to the smb.conf file. The cryptographic
6944 protection on the authenticated RPC calls used to verify passwords
6945 ensures that this default is safe.
6946 It is strongly recommended that you use the default of '*', however
6948 if in your particular environment you have reason to specify a
6949 particular DC list, then the list of machines in this option must
6950 be a list of names or IP addresses of Domain controllers for the
6951 Domain. If you use the default of '*', or list several hosts in the
6952 password server option then smbd will try each in turn till it
6953 finds one that responds. This is useful in case your primary server
6954 goes down.
6955 If the list of servers contains both names/IP's and the '*'
6957 character, the list is treated as a list of preferred domain
6958 controllers, but an auto lookup of all remaining DC's will be added
6959 to the list as well. Samba will not attempt to optimize this list
6960 by locating the closest DC.
6961 If parameter is a name, it is looked up using the parameter name
6963 resolve order and so may resolved by any method and order described
6964 in that parameter.
6965 Default: password server = *
6967 Example: password server = NT-PDC, NT-BDC1, NT-BDC2, *
6969 Example: password server = windc.mydomain.com:389 192.168.1.101 *
6971 directory
6973 This parameter is a synonym for path.
6975 path (S)
6977 This parameter specifies a directory to which the user of the
6979 service is to be given access. In the case of printable services,
6980 this is where print data will spool prior to being submitted to the
6981 host for printing.
6982 For a printable service offering guest access, the service should
6984 be readonly and the path should be world-writeable and have the
6985 sticky bit set. This is not mandatory of course, but you probably
6986 won't get the results you expect if you do otherwise.
6987 Any occurrences of %u in the path will be replaced with the UNIX
6989 username that the client is using on this connection. Any
6990 occurrences of %m will be replaced by the NetBIOS name of the
6991 machine they are connecting from. These replacements are very
6992 useful for setting up pseudo home directories for users.
6993 Note that this path will be based on root dir if one was specified.
6995 Default: path =
6997 Example: path = /home/fred
6999 perfcount module (G)
7001 This parameter specifies the perfcount backend to be used when
7003 monitoring SMB operations. Only one perfcount module may be used,
7004 and it must implement all of the apis contained in the
7005 smb_perfcount_handler structure defined in smb.h.
7006 No default
7008 pid directory (G)
7010 This option specifies the directory where pid files will be placed.
7012 Default: pid directory = /run
7014 Example: pid directory = /var/run/
7016 posix locking (S)
7018 The smbd(8) daemon maintains an database of file locks obtained by
7020 SMB clients. The default behavior is to map this internal database
7021 to POSIX locks. This means that file locks obtained by SMB clients
7022 are consistent with those seen by POSIX compliant applications
7023 accessing the files via a non-SMB method (e.g. NFS or local file
7024 access). It is very unlikely that you need to set this parameter to
7025 "no", unless you are sharing from an NFS mount, which is not a good
7026 idea in the first place.
7027 Default: posix locking = yes
7029 postexec (S)
7031 This option specifies a command to be run whenever the service is
7033 disconnected. It takes the usual substitutions. The command may be
7034 run as the root on some systems.
7035 An interesting example may be to unmount server resources:
7037 postexec = /etc/umount /cdrom
7039 Default: postexec =
7041 Example: postexec = echo \"%u disconnected from %S from %m (%I)\"
7043 >> /tmp/log
7044 exec
7046 This parameter is a synonym for preexec.
7048 preexec (S)
7050 This option specifies a command to be run whenever the service is
7052 connected to. It takes the usual substitutions.
7053 An interesting example is to send the users a welcome message every
7055 time they log in. Maybe a message of the day? Here is an example:
7056 preexec = csh -c 'echo \"Welcome to %S!\" |
7058 /usr/local/samba/bin/smbclient -M %m -I %I' &
7059 Of course, this could get annoying after a while :-)
7061 See also preexec close and postexec.
7063 Default: preexec =
7065 Example: preexec = echo \"%u connected to %S from %m (%I)\" >>
7067 /tmp/log
7068 preexec close (S)
7070 This boolean option controls whether a non-zero return code from
7072 preexec should close the service being connected to.
7073 Default: preexec close = no
7075 prefered master
7077 This parameter is a synonym for preferred master.
7079 preferred master (G)
7081 This boolean parameter controls if nmbd(8) is a preferred master
7083 browser for its workgroup.
7084 If this is set to yes, on startup, nmbd will force an election, and
7086 it will have a slight advantage in winning the election. It is
7087 recommended that this parameter is used in conjunction with domain
7088 master = yes, so that nmbd can guarantee becoming a domain master.
7089 Use this option with caution, because if there are several hosts
7091 (whether Samba servers, Windows 95 or NT) that are preferred master
7092 browsers on the same subnet, they will each periodically and
7093 continuously attempt to become the local master browser. This will
7094 result in unnecessary broadcast traffic and reduced browsing
7095 capabilities.
7096 Default: preferred master = auto
7098 prefork backoff increment (G)
7100 This option specifies the number of seconds added to the delay
7102 before a prefork master or worker process is restarted. The restart
7103 is initially zero, the prefork backoff increment is added to the
7104 delay on each restart up to the value specified by "prefork maximum
7105 backoff".
7106 Additionally the the backoff for an individual service by using
7108 "prefork backoff increment: service name" i.e. "prefork backoff
7109 increment:ldap = 2" to set the backoff increment to 2.
7110 If the backoff increment is 2 and the maximum backoff is 5. There
7112 will be a zero second delay for the first restart. A two second
7113 delay for the second restart. A four second delay for the third and
7114 any subsequent restarts
7115 Default: prefork backoff increment = 10
7117 prefork children (G)
7119 This option controls the number of worker processes that are
7121 started for each service when prefork process model is enabled (see
7122 samba(8) -M) The prefork children are only started for those
7123 services that support prefork (currently ldap, kdc and netlogon).
7124 For processes that don't support preforking all requests are
7125 handled by a single process for that service.
7126 This should be set to a small multiple of the number of CPU's
7128 available on the server
7129 Additionally the number of prefork children can be specified for an
7131 individual service by using "prefork children: service name" i.e.
7132 "prefork children:ldap = 8" to set the number of ldap worker
7133 processes.
7134 Default: prefork children = 4
7136 prefork maximum backoff (G)
7138 This option controls the maximum delay before a failed pre-fork
7140 process is restarted.
7141 Default: prefork maximum backoff = 120
7143 preload modules (G)
7145 This is a list of paths to modules that should be loaded into smbd
7147 before a client connects. This improves the speed of smbd when
7148 reacting to new connections somewhat.
7149 Default: preload modules =
7151 Example: preload modules = /usr/lib/samba/passdb/mysql.so
7153 preserve case (S)
7155 This controls if new filenames are created with the case that the
7157 client passes, or if they are forced to be the default case.
7158 See the section on NAME MANGLING for a fuller discussion.
7160 Default: preserve case = yes
7162 print ok
7164 This parameter is a synonym for printable.
7166 printable (S)
7168 If this parameter is yes, then clients may open, write to and
7170 submit spool files on the directory specified for the service.
7171 Note that a printable service will ALWAYS allow writing to the
7173 service path (user privileges permitting) via the spooling of print
7174 data. The read only parameter controls only non-printing access to
7175 the resource.
7176 Default: printable = no
7178 printcap cache time (G)
7180 This option specifies the number of seconds before the printing
7182 subsystem is again asked for the known printers.
7183 Setting this parameter to 0 disables any rescanning for new or
7185 removed printers after the initial startup.
7186 Default: printcap cache time = 750
7188 Example: printcap cache time = 600
7190 printcap
7192 This parameter is a synonym for printcap name.
7194 printcap name (G)
7196 This parameter may be used to override the compiled-in default
7198 printcap name used by the server (usually /etc/printcap). See the
7199 discussion of the [printers] section above for reasons why you
7200 might want to do this.
7201 To use the CUPS printing interface set printcap name = cups. This
7203 should be supplemented by an additional setting printing = cups in
7204 the [global] section. printcap name = cups will use the "dummy"
7205 printcap created by CUPS, as specified in your CUPS configuration
7206 file.
7207 On System V systems that use lpstat to list available printers you
7209 can use printcap name = lpstat to automatically obtain lists of
7210 available printers. This is the default for systems that define
7211 SYSV at configure time in Samba (this includes most System V based
7212 systems). If
7213 printcap name is set to lpstat on these systems then Samba will
7214 launch lpstat -v and attempt to parse the output to obtain a
7215 printer list.
7216 A minimal printcap file would look something like this:
7218 print1|My Printer 1
7220 print2|My Printer 2
7221 print3|My Printer 3
7222 print4|My Printer 4
7223 print5|My Printer 5
7224 where the '|' separates aliases of a printer. The fact that the
7226 second alias has a space in it gives a hint to Samba that it's a
7227 comment.
7228 Note
7230 Under AIX the default printcap name is /etc/qconfig. Samba will
7231 assume the file is in AIX qconfig format if the string qconfig
7232 appears in the printcap filename.
7233 Default: printcap name = /etc/printcap
7234 Example: printcap name = /etc/myprintcap
7236 print command (S)
7238 After a print job has finished spooling to a service, this command
7240 will be used via a system() call to process the spool file.
7241 Typically the command specified will submit the spool file to the
7242 host's printing subsystem, but there is no requirement that this be
7243 the case. The server will not remove the spool file, so whatever
7244 command you specify should remove the spool file when it has been
7245 processed, otherwise you will need to manually remove old spool
7246 files.
7247 The print command is simply a text string. It will be used verbatim
7249 after macro substitutions have been made:
7250 %s, %f - the path to the spool file name
7252 %p - the appropriate printer name
7254 %J - the job name as transmitted by the client.
7256 %c - The number of printed pages of the spooled job (if known).
7258 %z - the size of the spooled print job (in bytes)
7260 The print command MUST contain at least one occurrence of %s or %f
7262 - the %p is optional. At the time a job is submitted, if no printer
7263 name is supplied the %p will be silently removed from the printer
7264 command.
7265 If specified in the [global] section, the print command given will
7267 be used for any printable service that does not have its own print
7268 command specified.
7269 If there is neither a specified print command for a printable
7271 service nor a global print command, spool files will be created but
7272 not processed and (most importantly) not removed.
7273 Note that printing may fail on some UNIXes from the nobody account.
7275 If this happens then create an alternative guest account that can
7276 print and set the guest account in the [global] section.
7277 You can form quite complex print commands by realizing that they
7279 are just passed to a shell. For example the following will log a
7280 print job, print the file, then remove it. Note that ';' is the
7281 usual separator for command in shell scripts.
7282 print command = echo Printing %s >> /tmp/print.log; lpr -P %p %s;
7284 rm %s
7285 You may have to vary this command considerably depending on how you
7287 normally print files on your system. The default for the parameter
7288 varies depending on the setting of the printing parameter.
7289 Default: For printing = BSD, AIX, QNX, LPRNG or PLP :
7291 print command = lpr -r -P%p %s
7293 For printing = SYSV or HPUX :
7295 print command = lp -c -d%p %s; rm %s
7297 For printing = SOFTQ :
7299 print command = lp -d%p -s %s; rm %s
7301 For printing = CUPS : If SAMBA is compiled against libcups, then
7303 printcap = cups uses the CUPS API to submit jobs, etc. Otherwise it
7304 maps to the System V commands with the -oraw option for printing,
7305 i.e. it uses lp -c -d%p -oraw; rm %s. With printing = cups, and if
7306 SAMBA is compiled against libcups, any manually set print command
7307 will be ignored.
7308 No default
7310 Example: print command = /usr/local/samba/bin/myprintscript %p %s
7312 printer
7314 This parameter is a synonym for printer name.
7316 printer name (S)
7318 This parameter specifies the name of the printer to which print
7320 jobs spooled through a printable service will be sent.
7321 If specified in the [global] section, the printer name given will
7323 be used for any printable service that does not have its own
7324 printer name specified.
7325 The default value of the printer name may be lp on many systems.
7327 Default: printer name =
7329 Example: printer name = laserwriter
7331 printing (S)
7333 This parameters controls how printer status information is
7335 interpreted on your system. It also affects the default values for
7336 the print command, lpq command, lppause command , lpresume command,
7337 and lprm command if specified in the [global] section.
7338 Currently nine printing styles are supported. They are BSD, AIX,
7340 LPRNG, PLP, SYSV, HPUX, QNX, SOFTQ, CUPS and IPRINT.
7341 Be aware that CUPS and IPRINT are only available if the CUPS
7343 development library was available at the time Samba was compiled or
7344 packaged.
7345 To see what the defaults are for the other print commands when
7347 using the various options use the testparm(1) program.
7348 This option can be set on a per printer basis. Please be aware
7350 however, that you must place any of the various printing commands
7351 (e.g. print command, lpq command, etc...) after defining the value
7352 for the printing option since it will reset the printing commands
7353 to default values.
7354 See also the discussion in the [printers] section.
7356 See testparm -v. for the default value on your system
7358 Default: printing = # Depends on the operating system
7360 printjob username (S)
7362 This parameter specifies which user information will be passed to
7364 the printing system. Usually, the username is sent, but in some
7365 cases, e.g. the domain prefix is useful, too.
7366 Default: printjob username = %U
7368 Example: printjob username = %D\%U
7370 print notify backchannel (S)
7372 Windows print clients can update print queue status by expecting
7374 the server to open a backchannel SMB connection to them. Due to
7375 client firewall settings this can cause considerable timeouts and
7376 will often fail, as there is no guarantee the client is even
7377 running an SMB server. By default, the Samba print server will not
7378 try to connect back to clients, and will treat corresponding
7379 requests as if the connection back to the client failed.
7380 Default: print notify backchannel = no
7382 private directory
7384 This parameter is a synonym for private dir.
7386 private dir (G)
7388 This parameters defines the directory smbd will use for storing
7390 such files as smbpasswd and secrets.tdb.
7391 Default: private dir = /var/lib/samba/private
7393 queuepause command (S)
7395 This parameter specifies the command to be executed on the server
7397 host in order to pause the printer queue.
7398 This command should be a program or script which takes a printer
7400 name as its only parameter and stops the printer queue, such that
7401 no longer jobs are submitted to the printer.
7402 This command is not supported by Windows for Workgroups, but can be
7404 issued from the Printers window under Windows 95 and NT.
7405 If a %p is given then the printer name is put in its place.
7407 Otherwise it is placed at the end of the command.
7408 Note that it is good practice to include the absolute path in the
7410 command as the PATH may not be available to the server.
7411 Default: queuepause command = # determined by printing parameter
7413 Example: queuepause command = disable %p
7415 queueresume command (S)
7417 This parameter specifies the command to be executed on the server
7419 host in order to resume the printer queue. It is the command to
7420 undo the behavior that is caused by the previous parameter
7421 (queuepause command).
7422 This command should be a program or script which takes a printer
7424 name as its only parameter and resumes the printer queue, such that
7425 queued jobs are resubmitted to the printer.
7426 This command is not supported by Windows for Workgroups, but can be
7428 issued from the Printers window under Windows 95 and NT.
7429 If a %p is given then the printer name is put in its place.
7431 Otherwise it is placed at the end of the command.
7432 Note that it is good practice to include the absolute path in the
7434 command as the PATH may not be available to the server.
7435 Default: queueresume command = # determined by printing parameter
7437 Example: queueresume command = enable %p
7439 raw NTLMv2 auth (G)
7441 This parameter has been deprecated since Samba 4.13 and support for
7443 NTLMv2 authentication without NTLMSSP will be removed in a future
7444 Samba release.
7445 That is, in the future, the current default of raw NTLMv2 auth = no
7447 will be the enforced behaviour.
7448 This parameter determines whether or not smbd(8) will allow SMB1
7450 clients without extended security (without SPNEGO) to use NTLMv2
7451 authentication.
7452 If this option, lanman auth and ntlm auth are all disabled, then
7454 only clients with SPNEGO support will be permitted. That means
7455 NTLMv2 is only supported within NTLMSSP.
7456 Default: raw NTLMv2 auth = no
7458 read list (S)
7460 This is a list of users that are given read-only access to a
7462 service. If the connecting user is in this list then they will not
7463 be given write access, no matter what the read only option is set
7464 to. The list can include group names using the syntax described in
7465 the invalid users parameter.
7466 Default: read list =
7468 Example: read list = mary, @students
7470 read only (S)
7472 An inverted synonym is writeable.
7474 If this parameter is yes, then users of a service may not create or
7476 modify files in the service's directory.
7477 Note that a printable service (printable = yes) will ALWAYS allow
7479 writing to the directory (user privileges permitting), but only via
7480 spooling operations.
7481 Default: read only = yes
7483 read raw (G)
7485 This is ignored if async smb echo handler is set, because this
7487 feature is incompatible with raw read SMB requests
7488 If enabled, raw reads allow reads of 65535 bytes in one packet.
7490 This typically provides a major performance benefit for some very,
7491 very old clients.
7492 However, some clients either negotiate the allowable block size
7494 incorrectly or are incapable of supporting larger block sizes, and
7495 for these clients you may need to disable raw reads.
7496 In general this parameter should be viewed as a system tuning tool
7498 and left severely alone.
7499 Default: read raw = yes
7501 realm (G)
7503 This option specifies the kerberos realm to use. The realm is used
7505 as the ADS equivalent of the NT4 domain. It is usually set to the
7506 DNS name of the kerberos server.
7507 Default: realm =
7509 Example: realm = mysambabox.mycompany.com
7511 registry shares (G)
7513 This turns on or off support for share definitions read from
7515 registry. Shares defined in smb.conf take precedence over shares
7516 with the same name defined in registry. See the section on
7517 registry-based configuration for details.
7518 Note that this parameter defaults to no, but it is set to yes when
7520 config backend is set to registry.
7521 Default: registry shares = no
7523 Example: registry shares = yes
7525 reject md5 clients (G)
7527 This option controls whether the netlogon server (currently only in
7529 'active directory domain controller' mode), will reject clients
7530 which does not support NETLOGON_NEG_SUPPORTS_AES.
7531 You can set this to yes if all domain members support aes. This
7533 will prevent downgrade attacks.
7534 This option takes precedence to the 'allow nt4 crypto' option.
7536 Default: reject md5 clients = no
7538 reject md5 servers (G)
7540 This option controls whether winbindd requires support for aes
7542 support for the netlogon secure channel.
7543 The following flags will be required NETLOGON_NEG_ARCFOUR,
7545 NETLOGON_NEG_SUPPORTS_AES, NETLOGON_NEG_PASSWORD_SET2 and
7546 NETLOGON_NEG_AUTHENTICATED_RPC.
7547 You can set this to yes if all domain controllers support aes. This
7549 will prevent downgrade attacks.
7550 The behavior can be controlled per netbios domain by using 'reject
7552 md5 servers:NETBIOSDOMAIN = yes' as option.
7553 This option takes precedence to the require strong key option.
7555 Default: reject md5 servers = no
7557 remote announce (G)
7559 This option allows you to setup nmbd(8) to periodically announce
7561 itself to arbitrary IP addresses with an arbitrary workgroup name.
7562 This is useful if you want your Samba server to appear in a remote
7564 workgroup for which the normal browse propagation rules don't work.
7565 The remote workgroup can be anywhere that you can send IP packets
7566 to.
7567 For example:
7569 remote announce = 192.168.2.255/SERVERS 192.168.4.255/STAFF
7571 the above line would cause nmbd to announce itself to the two given
7573 IP addresses using the given workgroup names. If you leave out the
7574 workgroup name, then the one given in the workgroup parameter is
7575 used instead.
7576 The IP addresses you choose would normally be the broadcast
7578 addresses of the remote networks, but can also be the IP addresses
7579 of known browse masters if your network config is that stable.
7580 See the chapter on Network Browsing in the Samba-HOWTO book.
7582 Default: remote announce =
7584 remote browse sync (G)
7586 This option allows you to setup nmbd(8) to periodically request
7588 synchronization of browse lists with the master browser of a Samba
7589 server that is on a remote segment. This option will allow you to
7590 gain browse lists for multiple workgroups across routed networks.
7591 This is done in a manner that does not work with any non-Samba
7592 servers.
7593 This is useful if you want your Samba server and all local clients
7595 to appear in a remote workgroup for which the normal browse
7596 propagation rules don't work. The remote workgroup can be anywhere
7597 that you can send IP packets to.
7598 For example:
7600 remote browse sync = 192.168.2.255 192.168.4.255
7602 the above line would cause nmbd to request the master browser on
7604 the specified subnets or addresses to synchronize their browse
7605 lists with the local server.
7606 The IP addresses you choose would normally be the broadcast
7608 addresses of the remote networks, but can also be the IP addresses
7609 of known browse masters if your network config is that stable. If a
7610 machine IP address is given Samba makes NO attempt to validate that
7611 the remote machine is available, is listening, nor that it is in
7612 fact the browse master on its segment.
7613 The remote browse sync may be used on networks where there is no
7615 WINS server, and may be used on disjoint networks where each
7616 network has its own WINS server.
7617 Default: remote browse sync =
7619 rename user script (G)
7621 This is the full pathname to a script that will be run as root by
7623 smbd(8) under special circumstances described below.
7624 When a user with admin authority or SeAddUserPrivilege rights
7626 renames a user (e.g.: from the NT4 User Manager for Domains), this
7627 script will be run to rename the POSIX user. Two variables, %uold
7628 and %unew, will be substituted with the old and new usernames,
7629 respectively. The script should return 0 upon successful
7630 completion, and nonzero otherwise.
7631 Note
7633 The script has all responsibility to rename all the necessary
7634 data that is accessible in this posix method. This can mean
7635 different requirements for different backends. The tdbsam and
7636 smbpasswd backends will take care of the contents of their
7637 respective files, so the script is responsible only for
7638 changing the POSIX username, and other data that may required
7639 for your circumstances, such as home directory. Please also
7640 consider whether or not you need to rename the actual home
7641 directories themselves. The ldapsam backend will not make any
7642 changes, because of the potential issues with renaming the LDAP
7643 naming attribute. In this case the script is responsible for
7644 changing the attribute that samba uses (uid) for locating
7645 users, as well as any data that needs to change for other
7646 applications using the same directory.
7647 Default: rename user script =
7648 require strong key (G)
7650 This option controls whether winbindd requires support for md5
7652 strong key support for the netlogon secure channel.
7653 The following flags will be required NETLOGON_NEG_STRONG_KEYS,
7655 NETLOGON_NEG_ARCFOUR and NETLOGON_NEG_AUTHENTICATED_RPC.
7656 You can set this to no if some domain controllers only support des.
7658 This might allows weak crypto to be negotiated, may via downgrade
7659 attacks.
7660 The behavior can be controlled per netbios domain by using 'require
7662 strong key:NETBIOSDOMAIN = no' as option.
7663 Note for active directory domain this option is hardcoded to 'yes'
7665 This option yields precedence to the reject md5 servers option.
7667 This option takes precedence to the client schannel option.
7669 Default: require strong key = yes
7671 reset on zero vc (G)
7673 This boolean option controls whether an incoming SMB1 session setup
7675 should kill other connections coming from the same IP. This matches
7676 the default Windows 2003 behaviour. Setting this parameter to yes
7677 becomes necessary when you have a flaky network and windows decides
7678 to reconnect while the old connection still has files with share
7679 modes open. These files become inaccessible over the new
7680 connection. The client sends a zero VC on the new connection, and
7681 Windows 2003 kills all other connections coming from the same IP.
7682 This way the locked files are accessible again. Please be aware
7683 that enabling this option will kill connections behind a
7684 masquerading router, and will not trigger for clients that only use
7685 SMB2 or SMB3.
7686 Default: reset on zero vc = no
7688 restrict anonymous (G)
7690 The setting of this parameter determines whether SAMR and LSA
7692 DCERPC services can be accessed anonymously. This corresponds to
7693 the following Windows Server registry options:
7694 HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Lsa\RestrictAnonymous
7696 The option also affects the browse option which is required by
7699 legacy clients which rely on Netbios browsing. While modern Windows
7700 version should be fine with restricting the access there could
7701 still be applications relying on anonymous access.
7702 Setting restrict anonymous = 1 will disable anonymous SAMR access.
7704 Setting restrict anonymous = 2 will, in addition to restricting
7706 SAMR access, disallow anonymous connections to the IPC$ share in
7707 general. Setting guest ok = yes on any share will remove the
7708 security advantage.
7709 Default: restrict anonymous = 0
7711 root
7713 This parameter is a synonym for root directory.
7715 root dir
7717 This parameter is a synonym for root directory.
7719 root directory (G)
7721 The server will chroot() (i.e. Change its root directory) to this
7723 directory on startup. This is not strictly necessary for secure
7724 operation. Even without it the server will deny access to files not
7725 in one of the service entries. It may also check for, and deny
7726 access to, soft links to other parts of the filesystem, or attempts
7727 to use ".." in file names to access other directories (depending on
7728 the setting of the wide smbconfoptions parameter).
7729 Adding a root directory entry other than "/" adds an extra level of
7731 security, but at a price. It absolutely ensures that no access is
7732 given to files not in the sub-tree specified in the root directory
7733 option, including some files needed for complete operation of the
7734 server. To maintain full operability of the server you will need to
7735 mirror some system files into the root directory tree. In
7736 particular you will need to mirror /etc/passwd (or a subset of it),
7737 and any binaries or configuration files needed for printing (if
7738 required). The set of files that must be mirrored is operating
7739 system dependent.
7740 Default: root directory =
7742 Example: root directory = /homes/smb
7744 root postexec (S)
7746 This is the same as the postexec parameter except that the command
7748 is run as root. This is useful for unmounting filesystems (such as
7749 CDROMs) after a connection is closed.
7750 Default: root postexec =
7752 root preexec (S)
7754 This is the same as the preexec parameter except that the command
7756 is run as root. This is useful for mounting filesystems (such as
7757 CDROMs) when a connection is opened.
7758 Default: root preexec =
7760 root preexec close (S)
7762 This is the same as the preexec close parameter except that the
7764 command is run as root.
7765 Default: root preexec close = no
7767 rpc big endian (G)
7769 Setting this option will force the RPC client and server to
7771 transfer data in big endian.
7772 If it is disabled, data will be transferred in little endian.
7774 The behaviour is independent of the endianness of the host machine.
7776 Default: rpc big endian = no
7778 rpc_daemon:DAEMON (G)
7780 Defines whether to use the embedded code or start a separate daemon
7782 for the defined rpc services. The rpc_daemon prefix must be
7783 followed by the server name, and a value.
7784 Two possible values are currently supported:
7786 disabled
7788 fork
7789 The classic method is to run rpc services as internal daemons
7792 embedded in smbd, therefore the external daemons are disabled by
7793 default.
7794 Choosing the fork option will cause samba to fork a separate
7796 process for each daemon configured this way. Each daemon may in
7797 turn fork a number of children used to handle requests from
7798 multiple smbds and direct tcp/ip connections (if the Endpoint
7799 Mapper is enabled). Communication with smbd happens over named
7800 pipes and require that said pipes are forward to the external
7801 daemon (see rpc_server).
7802 Forked RPC Daemons support dynamically forking children to handle
7804 connections. The heuristics about how many children to keep around
7805 and how fast to allow them to fork and also how many clients each
7806 child is allowed to handle concurrently is defined by parametrical
7807 options named after the daemon. Five options are currently
7808 supported:
7809 prefork_min_children
7811 prefork_max_children
7812 prefork_spawn_rate
7813 prefork_max_allowed_clients
7814 prefork_child_min_life
7815 To set one of these options use the following syntax:
7818 daemonname:prefork_min_children = 5
7820 Samba includes separate daemons for spoolss, lsarpc/lsass,
7823 netlogon, samr, FSRVP and mdssvc(Spotlight). Currently five daemons
7824 are available and they are called:
7825 epmd
7827 lsasd
7828 spoolssd
7829 fssd
7830 mdssd
7831 Example:
7834 rpc_daemon:spoolssd = fork
7836 Default: rpc_daemon:DAEMON = disabled
7839 rpc_server:SERVER (G)
7841 With this option you can define if a rpc service should be running
7843 internal/embedded in smbd or should be redirected to an external
7844 daemon like Samba4, the endpoint mapper daemon, the spoolss daemon
7845 or the new LSA service daemon. The rpc_server prefix must be
7846 followed by the pipe name, and a value.
7847 This option can be set for each available rpc service in Samba. The
7849 following list shows all available pipe names services you can
7850 modify with this option.
7851 • epmapper - Endpoint Mapper
7853 • winreg - Remote Registry Service
7855 • srvsvc - Remote Server Services
7857 • lsarpc - Local Security Authority
7859 • samr - Security Account Management
7861 • netlogon - Netlogon Remote Protocol
7863 • netdfs - Settings for Distributed File System
7865 • dssetup - Active Directory Setup
7867 • wkssvc - Workstation Services
7869 • spoolss - Network Printing Spooler
7871 • svcctl - Service Control
7873 • ntsvcs - Plug and Play Services
7875 • eventlog - Event Logger
7877 • initshutdown - Init Shutdown Service
7879 • mdssvc - Spotlight
7881 Three possible values currently supported are: embedded external
7883 disabled
7884 The classic method is to run every pipe as an internal function
7886 embedded in smbd. The defaults may vary depending on the service.
7887 Choosing the external option allows one to run a separate daemon or
7889 even a completely independent (3rd party) server capable of
7890 interfacing with samba via the MS-RPC interface over named pipes.
7891 Currently in Samba3 we support four daemons, spoolssd, epmd, lsasd
7893 and mdssd. These daemons can be enabled using the rpc_daemon
7894 option. For spoolssd you have to enable the daemon and proxy the
7895 named pipe with:
7896 Examples:
7898 rpc_daemon:lsasd = fork
7900 rpc_server:lsarpc = external
7901 rpc_server:samr = external
7902 rpc_server:netlogon = external
7903 rpc_server:spoolss = external
7905 rpc_server:epmapper = disabled
7906 rpc_daemon:mdssd = fork
7908 rpc_server:mdssvc = external
7909 There is one special option which allows you to enable rpc services
7912 to listen for ncacn_ip_tcp connections too. Currently this is only
7913 used for testing and doesn't scale!
7914 rpc_server:tcpip = yes
7916 Default: rpc_server:SERVER = embedded
7919 rpc server dynamic port range (G)
7921 This parameter tells the RPC server which port range it is allowed
7923 to use to create a listening socket for LSA, SAM, Netlogon and
7924 others without wellknown tcp ports. The first value is the lowest
7925 number of the port range and the second the highest.
7926 This applies to RPC servers in all server roles.
7928 Default: rpc server dynamic port range = 49152-65535
7930 rpc server port (G)
7932 Specifies which port the server should listen on for DCE/RPC over
7934 TCP/IP traffic.
7935 This controls the default port for all protocols, except for
7937 NETLOGON.
7938 If unset, the first available port from rpc server dynamic port
7940 range is used, e.g. 49152.
7941 The NETLOGON server will use the next available port, e.g. 49153.
7943 To change this port use (eg) rpc server port:netlogon = 4000.
7944 Furthermore, all RPC servers can have the port they use specified
7946 independenty, with (for example) rpc server port:drsuapi = 5000.
7947 This option applies currently only when samba(8) runs as an active
7949 directory domain controller.
7950 The default value 0 causes Samba to select the first available port
7952 from rpc server dynamic port range.
7953 Default: rpc server port = 0
7955 samba kcc command (G)
7957 This option specifies the path to the Samba KCC command. This
7959 script is used for replication topology replication.
7960 It should not be necessary to modify this option except for testing
7962 purposes or if the samba_kcc was installed in a non-default
7963 location.
7964 Default: samba kcc command =
7966 /builddir/build/BUILD/samba-4.15.2/source4/scripting/bin/samba_kcc
7967 Example: samba kcc command = /usr/local/bin/kcc
7969 security (G)
7971 This option affects how clients respond to Samba and is one of the
7973 most important settings in the smb.conf file.
7974 The default is security = user, as this is the most common setting,
7976 used for a standalone file server or a DC.
7977 The alternatives are security = ads or security = domain, which
7979 support joining Samba to a Windows domain
7980 You should use security = user and map to guest if you want to
7982 mainly setup shares without a password (guest shares). This is
7983 commonly used for a shared printer server.
7984 The different settings will now be explained.
7986 SECURITY = AUTO
7988 This is the default security setting in Samba, and causes Samba to
7990 consult the server role parameter (if set) to determine the
7991 security mode.
7992 SECURITY = USER
7994 If server role is not specified, this is the default security
7996 setting in Samba. With user-level security a client must first
7997 "log-on" with a valid username and password (which can be mapped
7998 using the username map parameter). Encrypted passwords (see the
7999 encrypted passwords parameter) can also be used in this security
8000 mode. Parameters such as user and guest only if set are then
8001 applied and may change the UNIX user to use on this connection, but
8002 only after the user has been successfully authenticated.
8003 Note that the name of the resource being requested is not sent to
8005 the server until after the server has successfully authenticated
8006 the client. This is why guest shares don't work in user level
8007 security without allowing the server to automatically map unknown
8008 users into the guest account. See the map to guest parameter for
8009 details on doing this.
8010 SECURITY = DOMAIN
8012 This mode will only work correctly if net(8) has been used to add
8014 this machine into a Windows NT Domain. It expects the encrypted
8015 passwords parameter to be set to yes. In this mode Samba will try
8016 to validate the username/password by passing it to a Windows NT
8017 Primary or Backup Domain Controller, in exactly the same way that a
8018 Windows NT Server would do.
8019 Note that a valid UNIX user must still exist as well as the account
8021 on the Domain Controller to allow Samba to have a valid UNIX
8022 account to map file access to.
8023 Note that from the client's point of view security = domain is the
8025 same as security = user. It only affects how the server deals with
8026 the authentication, it does not in any way affect what the client
8027 sees.
8028 Note that the name of the resource being requested is not sent to
8030 the server until after the server has successfully authenticated
8031 the client. This is why guest shares don't work in user level
8032 security without allowing the server to automatically map unknown
8033 users into the guest account. See the map to guest parameter for
8034 details on doing this.
8035 See also the password server parameter and the encrypted passwords
8037 parameter.
8038 SECURITY = ADS
8040 In this mode, Samba will act as a domain member in an ADS realm. To
8042 operate in this mode, the machine running Samba will need to have
8043 Kerberos installed and configured and Samba will need to be joined
8044 to the ADS realm using the net utility.
8045 Note that this mode does NOT make Samba operate as a Active
8047 Directory Domain Controller.
8048 Note that this forces require strong key = yes and client schannel
8050 = yes for the primary domain.
8051 Read the chapter about Domain Membership in the HOWTO for details.
8053 Default: security = AUTO
8055 Example: security = DOMAIN
8057 security mask (S)
8059 This parameter has been removed for Samba 4.0.0.
8061 No default
8063 max protocol
8065 This parameter is a synonym for server max protocol.
8067 protocol
8069 This parameter is a synonym for server max protocol.
8071 server max protocol (G)
8073 The value of the parameter (a string) is the highest protocol level
8075 that will be supported by the server.
8076 Possible values are :
8078 • LANMAN1: First modern version of the protocol. Long
8080 filename support.
8081 • LANMAN2: Updates to Lanman1 protocol.
8083 • NT1: Current up to date version of the protocol. Used by
8085 Windows NT. Known as CIFS.
8086 • SMB2: Re-implementation of the SMB protocol. Used by
8088 Windows Vista and later versions of Windows. SMB2 has
8089 sub protocols available.
8090 • SMB2_02: The earliest SMB2 version.
8092 • SMB2_10: Windows 7 SMB2 version.
8094 By default SMB2 selects the SMB2_10 variant.
8096 • SMB3: The same as SMB2. Used by Windows 8. SMB3 has sub
8098 protocols available.
8099 • SMB3_00: Windows 8 SMB3 version.
8101 • SMB3_02: Windows 8.1 SMB3 version.
8103 • SMB3_11: Windows 10 SMB3 version.
8105 By default SMB3 selects the SMB3_11 variant.
8107 Normally this option should not be set as the automatic negotiation
8109 phase in the SMB protocol takes care of choosing the appropriate
8110 protocol.
8111 Default: server max protocol = SMB3
8113 Example: server max protocol = LANMAN1
8115 min protocol
8117 This parameter is a synonym for server min protocol.
8119 server min protocol (G)
8121 This setting controls the minimum protocol version that the server
8123 will allow the client to use.
8124 Normally this option should not be set as the automatic negotiation
8126 phase in the SMB protocol takes care of choosing the appropriate
8127 protocol unless you have legacy clients which are SMB1 capable
8128 only.
8129 See Related command: server max protocol for a full list of
8131 available protocols.
8132 Default: server min protocol = SMB2_02
8134 Example: server min protocol = NT1
8136 server multi channel support (G)
8138 This boolean parameter controls whether smbd(8) will support SMB3
8140 multi-channel.
8141 This parameter was added with version 4.4.
8143 Note that this feature was still considered experimental up to
8145 4.14.
8146 Due to dependencies to kernel APIs of Linux or FreeBSD, it's only
8148 possible to use this feature on Linux and FreeBSD for now. For
8149 testing this restriction can be overwritten by specifying
8150 force:server multi channel support=yes in addition.
8151 This option is enabled by default starting with to 4.15 (on Linux
8153 and FreeBSD).
8154 Default: server multi channel support = yes
8156 server role (G)
8158 This option determines the basic operating mode of a Samba server
8160 and is one of the most important settings in the smb.conf file.
8161 The default is server role = auto, as causes Samba to operate
8163 according to the security setting, or if not specified as a simple
8164 file server that is not connected to any domain.
8165 The alternatives are server role = standalone or server role =
8167 member server, which support joining Samba to a Windows domain,
8168 along with server role = domain controller, which run Samba as a
8169 Windows domain controller.
8170 You should use server role = standalone and map to guest if you
8172 want to mainly setup shares without a password (guest shares). This
8173 is commonly used for a shared printer server.
8174 SERVER ROLE = AUTO
8176 This is the default server role in Samba, and causes Samba to
8178 consult the security parameter (if set) to determine the server
8179 role, giving compatible behaviours to previous Samba versions.
8180 SERVER ROLE = STANDALONE
8182 If security is also not specified, this is the default security
8184 setting in Samba. In standalone operation, a client must first
8185 "log-on" with a valid username and password (which can be mapped
8186 using the username map parameter) stored on this machine. Encrypted
8187 passwords (see the encrypted passwords parameter) are by default
8188 used in this security mode. Parameters such as user and guest only
8189 if set are then applied and may change the UNIX user to use on this
8190 connection, but only after the user has been successfully
8191 authenticated.
8192 SERVER ROLE = MEMBER SERVER
8194 This mode will only work correctly if net(8) has been used to add
8196 this machine into a Windows Domain. It expects the encrypted
8197 passwords parameter to be set to yes. In this mode Samba will try
8198 to validate the username/password by passing it to a Windows or
8199 Samba Domain Controller, in exactly the same way that a Windows
8200 Server would do.
8201 Note that a valid UNIX user must still exist as well as the account
8203 on the Domain Controller to allow Samba to have a valid UNIX
8204 account to map file access to. Winbind can provide this.
8205 SERVER ROLE = CLASSIC PRIMARY DOMAIN CONTROLLER
8207 This mode of operation runs a classic Samba primary domain
8209 controller, providing domain logon services to Windows and Samba
8210 clients of an NT4-like domain. Clients must be joined to the domain
8211 to create a secure, trusted path across the network. There must be
8212 only one PDC per NetBIOS scope (typcially a broadcast network or
8213 clients served by a single WINS server).
8214 SERVER ROLE = CLASSIC BACKUP DOMAIN CONTROLLER
8216 This mode of operation runs a classic Samba backup domain
8218 controller, providing domain logon services to Windows and Samba
8219 clients of an NT4-like domain. As a BDC, this allows multiple Samba
8220 servers to provide redundant logon services to a single NetBIOS
8221 scope.
8222 SERVER ROLE = ACTIVE DIRECTORY DOMAIN CONTROLLER
8224 This mode of operation runs Samba as an active directory domain
8226 controller, providing domain logon services to Windows and Samba
8227 clients of the domain. This role requires special configuration,
8228 see the Samba4 HOWTO
8229 SERVER ROLE = IPA DOMAIN CONTROLLER
8231 This mode of operation runs Samba in a hybrid mode for IPA domain
8233 controller, providing forest trust to Active Directory. This role
8234 requires special configuration performed by IPA installers and
8235 should not be used manually by any administrator.
8236 Default: server role = AUTO
8238 Example: server role = ACTIVE DIRECTORY DOMAIN CONTROLLER
8240 server schannel (G)
8242 This option is deprecated and will be removed in future, as it is a
8244 security problem if not set to "yes" (which will be the hardcoded
8245 behavior in future).
8246 Samba will complain in the log files at log level 0, about the
8248 security problem if the option is not set to "yes".
8249 See CVE-2020-1472(ZeroLogon)
8251 https://bugzilla.samba.org/show_bug.cgi?id=14497
8252 If you still have legacy domain members use the server require
8254 schannel:COMPUTERACCOUNT option.
8255 This option yields precedence to the server require
8257 schannel:COMPUTERACCOUNT option.
8258 Default: server schannel = yes
8260 server require schannel:COMPUTERACCOUNT (G)
8262 If you still have legacy domain members, which required "server
8264 schannel = auto" before, it is possible to specify explicit
8265 expection per computer account by using 'server require
8266 schannel:COMPUTERACCOUNT = no' as option. Note that COMPUTERACCOUNT
8267 has to be the sAMAccountName value of the computer account
8268 (including the trailing '$' sign).
8269 Samba will complain in the log files at log level 0, about the
8271 security problem if the option is not set to "no", but the related
8272 computer is actually using the netlogon secure channel (schannel)
8273 feature.
8274 Samba will warn in the log files at log level 5, if a setting is
8276 still needed for the specified computer account.
8277 See CVE-2020-1472(ZeroLogon)
8279 https://bugzilla.samba.org/show_bug.cgi?id=14497
8280 This option takes precedence to the server schannel option.
8282 server require schannel:LEGACYCOMPUTER1$ = no
8284 server require schannel:NASBOX$ = no
8285 server require schannel:LEGACYCOMPUTER2$ = no
8286 No default
8289 server services (G)
8291 This option contains the services that the Samba daemon will run.
8293 An entry in the smb.conf file can either override the previous
8295 value completely or entries can be removed from or added to it by
8296 prefixing them with + or -.
8297 Default: server services = s3fs, rpc, nbt, wrepl, ldap, cldap, kdc,
8299 drepl, winbindd, ntp_signd, kcc, dnsupdate, dns
8300 Example: server services = -s3fs, +smb
8302 server signing (G)
8304 This controls whether the client is allowed or required to use SMB1
8306 and SMB2 signing. Possible values are default, auto, mandatory and
8307 disabled.
8308 By default, and when smb signing is set to default, smb signing is
8310 required when server role is active directory domain controller and
8311 disabled otherwise.
8312 When set to auto, SMB1 signing is offered, but not enforced. When
8314 set to mandatory, SMB1 signing is required and if set to disabled,
8315 SMB signing is not offered either.
8316 For the SMB2 protocol, by design, signing cannot be disabled. In
8318 the case where SMB2 is negotiated, if this parameter is set to
8319 disabled, it will be treated as auto. Setting it to mandatory will
8320 still require SMB2 clients to use signing.
8321 Default: server signing = default
8323 server smb encrypt (S)
8325 This parameter controls whether a remote client is allowed or
8327 required to use SMB encryption. It has different effects depending
8328 on whether the connection uses SMB1 or SMB2 and newer:
8329 • If the connection uses SMB1, then this option controls
8331 the use of a Samba-specific extension to the SMB
8332 protocol introduced in Samba 3.2 that makes use of the
8333 Unix extensions.
8334 • If the connection uses SMB2 or newer, then this option
8336 controls the use of the SMB-level encryption that is
8337 supported in SMB version 3.0 and above and available in
8338 Windows 8 and newer.
8339 This parameter can be set globally and on a per-share bases.
8341 Possible values are off, if_required, desired, and required. A
8342 special value is default which is the implicit default setting of
8343 if_required.
8344 Effects for SMB1
8346 The Samba-specific encryption of SMB1 connections is an
8347 extension to the SMB protocol negotiated as part of the UNIX
8348 extensions. SMB encryption uses the GSSAPI (SSPI on Windows)
8349 ability to encrypt and sign every request/response in a SMB
8350 protocol stream. When enabled it provides a secure method of
8351 SMB/CIFS communication, similar to an ssh protected session,
8352 but using SMB/CIFS authentication to negotiate encryption and
8353 signing keys. Currently this is only supported smbclient of by
8354 Samba 3.2 and newer, and hopefully soon Linux CIFSFS and
8355 MacOS/X clients. Windows clients do not support this feature.
8356 This may be set on a per-share basis, but clients may chose to
8358 encrypt the entire session, not just traffic to a specific
8359 share. If this is set to mandatory then all traffic to a share
8360 must be encrypted once the connection has been made to the
8361 share. The server would return "access denied" to all
8362 non-encrypted requests on such a share. Selecting encrypted
8363 traffic reduces throughput as smaller packet sizes must be used
8364 (no huge UNIX style read/writes allowed) as well as the
8365 overhead of encrypting and signing all the data.
8366 If SMB encryption is selected, Windows style SMB signing (see
8368 the server signing option) is no longer necessary, as the
8369 GSSAPI flags use select both signing and sealing of the data.
8370 When set to auto or default, SMB encryption is offered, but not
8372 enforced. When set to mandatory, SMB encryption is required and
8373 if set to disabled, SMB encryption can not be negotiated.
8374 Effects for SMB2 and newer
8376 Native SMB transport encryption is available in SMB version 3.0
8377 or newer. It is only offered by Samba if server max protocol is
8378 set to SMB3 or newer. Clients supporting this type of
8379 encryption include Windows 8 and newer, Windows server 2012 and
8380 newer, and smbclient of Samba 4.1 and newer.
8381 The protocol implementation offers various options:
8383 • The capability to perform SMB encryption can be
8385 negotiated during protocol negotiation.
8386 • Data encryption can be enabled globally. In that
8388 case, an encryption-capable connection will have all
8389 traffic in all its sessions encrypted. In particular
8390 all share connections will be encrypted.
8391 • Data encryption can also be enabled per share if not
8393 enabled globally. For an encryption-capable
8394 connection, all connections to an encryption-enabled
8395 share will be encrypted.
8396 • Encryption can be enforced. This means that session
8398 setups will be denied on non-encryption-capable
8399 connections if data encryption has been enabled
8400 globally. And tree connections will be denied for
8401 non-encryption capable connections to shares with
8402 data encryption enabled.
8403 These features can be controlled with settings of server smb
8405 encrypt as follows:
8406 • Leaving it as default, explicitly setting default,
8408 or setting it to if_required globally will enable
8409 negotiation of encryption but will not turn on data
8410 encryption globally or per share.
8411 • Setting it to desired globally will enable
8413 negotiation and will turn on data encryption on
8414 sessions and share connections for those clients
8415 that support it.
8416 • Setting it to required globally will enable
8418 negotiation and turn on data encryption on sessions
8419 and share connections. Clients that do not support
8420 encryption will be denied access to the server.
8421 • Setting it to off globally will completely disable
8423 the encryption feature for all connections. Setting
8424 server smb encrypt = required for individual shares
8425 (while it's globally off) will deny access to this
8426 shares for all clients.
8427 • Setting it to desired on a share will turn on data
8429 encryption for this share for clients that support
8430 encryption if negotiation has been enabled globally.
8431 • Setting it to required on a share will enforce data
8433 encryption for this share if negotiation has been
8434 enabled globally. I.e. clients that do not support
8435 encryption will be denied access to the share.
8436 Note that this allows per-share enforcing to be
8438 controlled in Samba differently from Windows: In
8439 Windows, RejectUnencryptedAccess is a global
8440 setting, and if it is set, all shares with data
8441 encryption turned on are automatically enforcing
8442 encryption. In order to achieve the same effect in
8443 Samba, one has to globally set server smb encrypt to
8444 if_required, and then set all shares that should be
8445 encrypted to required. Additionally, it is possible
8446 in Samba to have some shares with encryption
8447 required and some other shares with encryption only
8448 desired, which is not possible in Windows.
8449 • Setting it to off or if_required for a share has no
8451 effect.
8452 Default: server smb encrypt = default
8455 server smb3 encryption algorithms (G)
8457 This parameter specifies the availability and order of encryption
8459 algorithms which are available for negotiation in the SMB3_11
8460 dialect.
8461 It is also possible to remove individual algorithms from the
8463 default list, by prefixing them with '-'. This can avoid having to
8464 specify a hardcoded list.
8465 Note: that the removal of AES-128-CCM from the list will result in
8467 SMB3_00 and SMB3_02 being unavailable, as it is the default and
8468 only available algorithm for these dialects.
8469 Default: server smb3 encryption algorithms = AES-128-GCM,
8471 AES-128-CCM, AES-256-GCM, AES-256-CCM
8472 Example: server smb3 encryption algorithms = AES-256-GCM
8474 Example: server smb3 encryption algorithms = -AES-128-GCM
8476 -AES-128-CCM
8477 server smb3 signing algorithms (G)
8479 This parameter specifies the availability and order of signing
8481 algorithms which are available for negotiation in the SMB3_11
8482 dialect.
8483 It is also possible to remove individual algorithms from the
8485 default list, by prefixing them with '-'. This can avoid having to
8486 specify a hardcoded list.
8487 Note: that the removal of AES-128-CMAC from the list will result in
8489 SMB3_00 and SMB3_02 being unavailable, and the removal of
8490 HMAC-SHA256 will result in SMB2_02 and SMB2_10 being unavailable,
8491 as these are the default and only available algorithms for these
8492 dialects.
8493 Default: server smb3 signing algorithms = AES-128-GMAC,
8495 AES-128-CMAC, HMAC-SHA256
8496 Example: server smb3 signing algorithms = AES-128-CMAC, HMAC-SHA256
8498 Example: server smb3 signing algorithms = -AES-128-CMAC
8500 server string (G)
8502 This controls what string will show up in the printer comment box
8504 in print manager and next to the IPC connection in net view. It can
8505 be any string that you wish to show to your users.
8506 It also sets what will appear in browse lists next to the machine
8508 name.
8509 A %v will be replaced with the Samba version number.
8511 A %h will be replaced with the hostname.
8513 Default: server string = Samba %v
8515 Example: server string = University of GNUs Samba Server
8517 set primary group script (G)
8519 Thanks to the Posix subsystem in NT a Windows User has a primary
8521 group in addition to the auxiliary groups. This script sets the
8522 primary group in the unix user database when an administrator sets
8523 the primary group from the windows user manager or when fetching a
8524 SAM with net rpc vampire. %u will be replaced with the user whose
8525 primary group is to be set. %g will be replaced with the group to
8526 set.
8527 Default: set primary group script =
8529 Example: set primary group script = /usr/sbin/usermod -g '%g' '%u'
8531 set quota command (G)
8533 The set quota command should only be used whenever there is no
8535 operating system API available from the OS that samba can use.
8536 This option is only available if Samba was compiled with quota
8538 support.
8539 This parameter should specify the path to a script that can set
8541 quota for the specified arguments.
8542 The specified script should take the following arguments:
8544 • 1 - path to where the quota needs to be set. This needs
8546 to be interpreted relative to the current working
8547 directory that the script may also check for.
8548 • 2 - quota type
8550 • 1 - user quotas
8552 • 2 - user default quotas (uid = -1)
8554 • 3 - group quotas
8556 • 4 - group default quotas (gid = -1)
8558 • 3 - id (uid for user, gid for group, -1 if N/A)
8561 • 4 - quota state (0 = disable, 1 = enable, 2 = enable and
8563 enforce)
8564 • 5 - block softlimit
8566 • 6 - block hardlimit
8568 • 7 - inode softlimit
8570 • 8 - inode hardlimit
8572 • 9(optional) - block size, defaults to 1024
8574 The script should output at least one line of data on success. And
8576 nothing on failure.
8577 Default: set quota command =
8579 Example: set quota command = /usr/local/sbin/set_quota
8581 share:fake_fscaps (G)
8583 This is needed to support some special application that makes
8585 QFSINFO calls to check whether we set the SPARSE_FILES bit (0x40).
8586 If this bit is not set that particular application refuses to work
8587 against Samba. With share:fake_fscaps = 64 the SPARSE_FILES file
8588 system capability flag is set. Use other decimal values to specify
8589 the bitmask you need to fake.
8590 Default: share:fake_fscaps = 0
8592 short preserve case (S)
8594 This boolean parameter controls if new files which conform to 8.3
8596 syntax, that is all in upper case and of suitable length, are
8597 created upper case, or if they are forced to be the default case.
8598 This option can be use with preserve case = yes to permit long
8599 filenames to retain their case, while short names are lowered.
8600 See the section on NAME MANGLING.
8602 Default: short preserve case = yes
8604 show add printer wizard (G)
8606 With the introduction of MS-RPC based printing support for Windows
8608 NT/2000 client in Samba 2.2, a "Printers..." folder will appear on
8609 Samba hosts in the share listing. Normally this folder will contain
8610 an icon for the MS Add Printer Wizard (APW). However, it is
8611 possible to disable this feature regardless of the level of
8612 privilege of the connected user.
8613 Under normal circumstances, the Windows NT/2000 client will open a
8615 handle on the printer server with OpenPrinterEx() asking for
8616 Administrator privileges. If the user does not have administrative
8617 access on the print server (i.e is not root or has granted the
8618 SePrintOperatorPrivilege), the OpenPrinterEx() call fails and the
8619 client makes another open call with a request for a lower privilege
8620 level. This should succeed, however the APW icon will not be
8621 displayed.
8622 Disabling the show add printer wizard parameter will always cause
8624 the OpenPrinterEx() on the server to fail. Thus the APW icon will
8625 never be displayed.
8626 Note
8628 This does not prevent the same user from having administrative
8629 privilege on an individual printer.
8630 Default: show add printer wizard = yes
8631 shutdown script (G)
8633 This a full path name to a script called by smbd(8) that should
8635 start a shutdown procedure.
8636 If the connected user possesses the SeRemoteShutdownPrivilege,
8638 right, this command will be run as root.
8639 The %z %t %r %f variables are expanded as follows:
8641 • %z will be substituted with the shutdown message sent to
8643 the server.
8644 • %t will be substituted with the number of seconds to
8646 wait before effectively starting the shutdown procedure.
8647 • %r will be substituted with the switch -r. It means
8649 reboot after shutdown for NT.
8650 • %f will be substituted with the switch -f. It means
8652 force the shutdown even if applications do not respond
8653 for NT.
8654 Shutdown script example:
8656 #!/bin/bash
8658 time=$2
8660 let time="${time} / 60"
8661 let time="${time} + 1"
8662 /sbin/shutdown $3 $4 +$time $1 &
8664 Shutdown does not return so we need to launch it in background.
8667 Default: shutdown script =
8669 Example: shutdown script = /usr/local/samba/sbin/shutdown %m %t %r
8671 %f
8672 smb2 disable lock sequence checking (G)
8674 This boolean parameter controls whether smbd(8) will disable lock
8676 sequence checking even for multi-channel connections as well as
8677 durable handles.
8678 The [MS-SMB2] specification (under 3.3.5.14 Receiving an SMB2 LOCK
8680 Request) documents that a server should do lock sequence if
8681 Open.IsResilient or Open.IsDurable or Open.IsPersistent is TRUE or
8682 if Connection.Dialect belongs to the SMB 3.x dialect family and
8683 Connection.ServerCapabilities includes
8684 SMB2_GLOBAL_CAP_MULTI_CHANNEL.
8685 But Windows Server (at least up to v2004) only does these checks
8687 for the Open.IsResilient and Open.IsPersistent. That means they do
8688 not implement the behavior specified in [MS-SMB2].
8689 By default Samba behaves according to the specification and
8691 implements lock sequence checking when multi-channel is used.
8692 Warning: Only enable this option if existing clients can't handle
8694 lock sequence checking for handles without Open.IsResilient and
8695 Open.IsPersistent. And it turns out that the Windows Server
8696 behavior is required.
8697 Note: it's likely that this option will be removed again if future
8699 Windows versions change their behavior.
8700 Note: Samba does not implement Open.IsResilient and
8702 Open.IsPersistent yet.
8703 Default: smb2 disable lock sequence checking = no
8705 Example: smb2 disable lock sequence checking = yes
8707 smb2 disable oplock break retry (G)
8709 This boolean parameter controls whether smbd(8) will trigger smb2
8711 oplock break notification retries when using server multi channel
8712 support = yes.
8713 The [MS-SMB2] specification documents that a server should send
8715 smb2 oplock break notification retries on all available channel to
8716 the given client.
8717 But Windows Server versions (at least up to 2019) do not send smb2
8719 oplock break notification retries on channel failures. That means
8720 they do not implement the behavior specified in [MS-SMB2].
8721 By default Samba behaves according to the specification and send
8723 smb2 oplock break notification retries.
8724 Warning: Only enable this option if existing clients can't handle
8726 possible retries and it turns out that the Windows Server behavior
8727 is required.
8728 Note: it's likely that this option gets removed again if future
8730 Windows versions change their behavior.
8731 Note: this only applies to oplocks and not SMB2 leases.
8733 Default: smb2 disable oplock break retry = no
8735 Example: smb2 disable oplock break retry = yes
8737 smb2 leases (G)
8739 This boolean option tells smbd whether to globally negotiate SMB2
8741 leases on file open requests. Leasing is an SMB2-only feature which
8742 allows clients to aggressively cache files locally above and beyond
8743 the caching allowed by SMB1 oplocks.
8744 This is only available with oplocks = yes and kernel oplocks = no.
8746 Note that the write cache won't be used for file handles with a
8748 smb2 write lease.
8749 Default: smb2 leases = yes
8751 smb2 max credits (G)
8753 This option controls the maximum number of outstanding simultaneous
8755 SMB2 operations that Samba tells the client it will allow. This is
8756 similar to the max mux parameter for SMB1. You should never need to
8757 set this parameter.
8758 The default is 8192 credits, which is the same as a Windows 2008R2
8760 SMB2 server.
8761 Default: smb2 max credits = 8192
8763 smb2 max read (G)
8765 This option specifies the protocol value that smbd(8) will return
8767 to a client, informing the client of the largest size that may be
8768 returned by a single SMB2 read call.
8769 The maximum is 8388608 bytes (8MiB), which is the same as a Windows
8771 Server 2012 r2.
8772 Please note that the default is 8MiB, but it's limit is based on
8774 the smb2 dialect (64KiB for SMB == 2.0, 8MiB for SMB >= 2.1 with
8775 LargeMTU). Large MTU is not supported over NBT (tcp port 139).
8776 Default: smb2 max read = 8388608
8778 smb2 max trans (G)
8780 This option specifies the protocol value that smbd(8) will return
8782 to a client, informing the client of the largest size of buffer
8783 that may be used in querying file meta-data via QUERY_INFO and
8784 related SMB2 calls.
8785 The maximum is 8388608 bytes (8MiB), which is the same as a Windows
8787 Server 2012 r2.
8788 Please note that the default is 8MiB, but it's limit is based on
8790 the smb2 dialect (64KiB for SMB == 2.0, 1MiB for SMB >= 2.1 with
8791 LargeMTU). Large MTU is not supported over NBT (tcp port 139).
8792 Default: smb2 max trans = 8388608
8794 smb2 max write (G)
8796 This option specifies the protocol value that smbd(8) will return
8798 to a client, informing the client of the largest size that may be
8799 sent to the server by a single SMB2 write call.
8800 The maximum is 8388608 bytes (8MiB), which is the same as a Windows
8802 Server 2012 r2.
8803 Please note that the default is 8MiB, but it's limit is based on
8805 the smb2 dialect (64KiB for SMB == 2.0, 8MiB for SMB => 2.1 with
8806 LargeMTU). Large MTU is not supported over NBT (tcp port 139).
8807 Default: smb2 max write = 8388608
8809 smbd async dosmode (S)
8811 This parameter control whether the fileserver will use sync or
8813 async methods for fetching the DOS attributes when doing a
8814 directory listing. By default sync methods will be used.
8815 Default: smbd async dosmode = no
8817 smbd getinfo ask sharemode (S)
8819 This parameter allows disabling fetching file write time from the
8821 open file handle database locking.tdb when a client requests file
8822 or directory metadata. It's a performance optimisation at the
8823 expense of protocol correctness.
8824 Default: smbd getinfo ask sharemode = yes
8826 smbd max async dosmode (S)
8828 This parameter controls how many async operations to fetch the DOS
8830 attributes the fileserver will queue when doing directory listings.
8831 Default: smbd max async dosmode = aio max threads * 2
8833 smbd max xattr size (S)
8835 This parameter controls the maximum size of extended attributes
8837 that may be written to the server as EAs or as alternate data
8838 streams if vfs_streams_xattr is enabled. The maximum size of
8839 extended attributes depends on the Samba server's operating system
8840 and the underlying filesystem. The Linux VFS currently sets an
8841 upper boundary of 64 KiB per extended attribute. FreeBSD does not
8842 set a practical upper limit, but since pread() and pwrite() are not
8843 possible via the extattr on FreeBSD, it is not recommended to
8844 increase this value above a few MiB. If a client attempts to write
8845 an overly-large alternate datastream, the Samba server will return
8846 STATUS_FILESYSTEM_LIMITATION. If this error is encountered, users
8847 may try increasing the maximum size supported for xattr writes. If
8848 this is not possible, and writes are from a MacOS client and to an
8849 AFP_Resource extended attribute, the user may enable the vfs_fruit
8850 module and configure to allow stream writes for AFP_Resource to an
8851 alternative storage location. See vfs_fruit documentation for
8852 further details.
8853 Default: smbd max xattr size = 65536
8855 smbd profiling level (G)
8857 This parameter allows the administrator to enable profiling
8859 support.
8860 Possible values are off, count and on.
8862 Default: smbd profiling level = off
8864 Example: smbd profiling level = on
8866 smbd search ask sharemode (S)
8868 This parameter allows disabling fetching file write time from the
8870 open file handle database locking.tdb. It's a performance
8871 optimisation at the expense of protocol correctness.
8872 Default: smbd search ask sharemode = yes
8874 smb encrypt (S)
8876 This is a synonym for server smb encrypt.
8878 Default: smb encrypt = default
8880 smb passwd file (G)
8882 This option sets the path to the encrypted smbpasswd file. By
8884 default the path to the smbpasswd file is compiled into Samba.
8885 An example of use is:
8887 smb passwd file = /etc/samba/smbpasswd
8889 Default: smb passwd file = /var/lib/samba/private/smbpasswd
8891 smb ports (G)
8893 Specifies which ports the server should listen on for SMB traffic.
8895 Default: smb ports = 445 139
8897 socket options (G)
8899 Warning
8901 Modern server operating systems are tuned for high network
8902 performance in the majority of situations; when you set socket
8903 options you are overriding those settings. Linux in particular
8904 has an auto-tuning mechanism for buffer sizes that will be
8905 disabled if you specify a socket buffer size. This can
8906 potentially cripple your TCP/IP stack.
8907 Getting the socket options correct can make a big difference to
8909 your performance, but getting them wrong can degrade it by just
8910 as much. As with any other low level setting, if you must make
8911 changes to it, make small changes and test the effect before
8912 making any large changes.
8913 This option allows you to set socket options to be used when
8915 talking with the client.
8916 Socket options are controls on the networking layer of the
8918 operating systems which allow the connection to be tuned.
8919 This option will typically be used to tune your Samba server for
8921 optimal performance for your local network. There is no way that
8922 Samba can know what the optimal parameters are for your net, so you
8923 must experiment and choose them yourself. We strongly suggest you
8924 read the appropriate documentation for your operating system first
8925 (perhaps man setsockopt will help).
8926 You may find that on some systems Samba will say "Unknown socket
8928 option" when you supply an option. This means you either
8929 incorrectly typed it or you need to add an include file to
8930 includes.h for your OS. If the latter is the case please send the
8931 patch to samba-technical@lists.samba.org.
8932 Any of the supported socket options may be combined in any way you
8934 like, as long as your OS allows it.
8935 This is the list of socket options currently settable using this
8937 option:
8938 • SO_KEEPALIVE
8940 • SO_REUSEADDR
8942 • SO_BROADCAST
8944 • TCP_NODELAY
8946 • TCP_KEEPCNT *
8948 • TCP_KEEPIDLE *
8950 • TCP_KEEPINTVL *
8952 • IPTOS_LOWDELAY
8954 • IPTOS_THROUGHPUT
8956 • SO_REUSEPORT
8958 • SO_SNDBUF *
8960 • SO_RCVBUF *
8962 • SO_SNDLOWAT *
8964 • SO_RCVLOWAT *
8966 • SO_SNDTIMEO *
8968 • SO_RCVTIMEO *
8970 • TCP_FASTACK *
8972 • TCP_QUICKACK
8974 • TCP_NODELAYACK
8976 • TCP_KEEPALIVE_THRESHOLD *
8978 • TCP_KEEPALIVE_ABORT_THRESHOLD *
8980 • TCP_DEFER_ACCEPT *
8982 • TCP_USER_TIMEOUT *
8984 Those marked with a '*' take an integer argument. The others can
8986 optionally take a 1 or 0 argument to enable or disable the option,
8987 by default they will be enabled if you don't specify 1 or 0.
8988 To specify an argument use the syntax SOME_OPTION = VALUE for
8990 example SO_SNDBUF = 8192. Note that you must not have any spaces
8991 before or after the = sign.
8992 If you are on a local network then a sensible option might be:
8994 socket options = IPTOS_LOWDELAY
8996 If you have a local network then you could try:
8998 socket options = IPTOS_LOWDELAY TCP_NODELAY
9000 If you are on a wide area network then perhaps try setting
9002 IPTOS_THROUGHPUT.
9003 Note that several of the options may cause your Samba server to
9005 fail completely. Use these options with caution!
9006 Default: socket options = TCP_NODELAY
9008 Example: socket options = IPTOS_LOWDELAY
9010 spn update command (G)
9012 This option sets the command that for updating servicePrincipalName
9014 names from spn_update_list.
9015 Default: spn update command =
9017 /builddir/build/BUILD/samba-4.15.2/source4/scripting/bin/samba_spnupdate
9018 Example: spn update command = /usr/local/sbin/spnupdate
9020 spoolss: architecture (G)
9022 Windows spoolss print clients only allow association of server-side
9024 drivers with printers when the driver architecture matches the
9025 advertised print server architecture. Samba's spoolss print server
9026 architecture can be changed using this parameter.
9027 Default: spoolss: architecture = Windows x64
9029 Example: spoolss: architecture = Windows NT x86
9031 spoolss: os_major (G)
9033 Windows might require a new os version number. This option allows
9035 to modify the build number. The complete default version number is:
9036 5.0.2195 (Windows 2000). The example is 6.1.7601 (Windows 2008 R2).
9037 Default: spoolss: os_major = 5
9039 Example: spoolss: os_major = 6
9041 spoolss: os_minor (G)
9043 Windows might require a new os version number. This option allows
9045 to modify the build number. The complete default version number is:
9046 5.0.2195 (Windows 2000). The example is 6.1.7601 (Windows 2008 R2).
9047 Default: spoolss: os_minor = 0
9049 Example: spoolss: os_minor = 1
9051 spoolss: os_build (G)
9053 Windows might require a new os version number. This option allows
9055 to modify the build number. The complete default version number is:
9056 5.0.2195 (Windows 2000). The example is 6.1.7601 (Windows 2008 R2).
9057 Default: spoolss: os_build = 2195
9059 Example: spoolss: os_build = 7601
9061 spoolss_client: os_major (G)
9063 Windows might require a new os version number. This option allows
9065 to modify the build number. The complete default version number is:
9066 6.1.7007 (Windows 7 and Windows Server 2008 R2).
9067 Default: spoolss_client: os_major = 6
9069 spoolss_client: os_minor (G)
9071 Windows might require a new os version number. This option allows
9073 to modify the build number. The complete default version number is:
9074 6.1.7007 (Windows 7 and Windows Server 2008 R2).
9075 Default: spoolss_client: os_minor = 1
9077 spoolss_client: os_build (G)
9079 Windows might require a new os version number. This option allows
9081 to modify the build number. The complete default version number is:
9082 6.1.7007 (Windows 7 and Windows Server 2008 R2).
9083 Default: spoolss_client: os_build = 7007
9085 spotlight (S)
9087 This parameter controls whether Samba allows Spotlight queries on a
9089 share. For controlling indexing of filesystems you also have to use
9090 Tracker's own configuration system.
9091 Spotlight has several prerequisites:
9093 • Samba must be configured and built with Spotlight
9095 support.
9096 • The mdssvc RPC service must be enabled, see below.
9098 • Tracker integration must be setup and the share must be
9100 indexed by Tracker.
9101 For a detailed set of instructions please see
9103 https://wiki.samba.org/index.php/Spotlight.
9104 The Spotlight RPC service can either be enabled as embedded RPC
9106 service:
9107 [Global]
9109 rpc_server:mdsvc = embedded
9110 Or it can be run in a separate RPC service daemon:
9112 [Global]
9114 rpc_server:mdssd = fork
9115 rpc_server:mdsvc = external
9116 Default: spotlight = no
9118 spotlight backend (S)
9120 Spotlight search backend. Available backends:
9122 • noindex - a backend that returns no results.
9124 • tracker - Gnome Tracker.
9127 • elasticsearch - a backend that uses JSON and REST over
9129 HTTP(s) to query an Elasticsearch server.
9130 Default: spotlight backend = noindex
9133 stat cache (G)
9135 This parameter determines if smbd(8) will use a cache in order to
9137 speed up case insensitive name mappings. You should never need to
9138 change this parameter.
9139 Default: stat cache = yes
9141 state directory (G)
9143 Usually, most of the TDB files are stored in the lock directory.
9145 Since Samba 3.4.0, it is possible to differentiate between TDB
9146 files with persistent data and TDB files with non-persistent data
9147 using the state directory and the cache directory options.
9148 This option specifies the directory where TDB files containing
9150 important persistent data will be stored.
9151 Default: state directory = /var/lib/samba
9153 Example: state directory = /var/run/samba/locks/state
9155 store dos attributes (S)
9157 If this parameter is set Samba attempts to first read DOS
9159 attributes (SYSTEM, HIDDEN, ARCHIVE or READ-ONLY) from a filesystem
9160 extended attribute, before mapping DOS attributes to UNIX
9161 permission bits (such as occurs with map hidden and map readonly).
9162 When set, DOS attributes will be stored onto an extended attribute
9163 in the UNIX filesystem, associated with the file or directory. When
9164 this parameter is set it will override the parameters map hidden,
9165 map system, map archive and map readonly and they will behave as if
9166 they were set to off. This parameter writes the DOS attributes as a
9167 string into the extended attribute named "user.DOSATTRIB". This
9168 extended attribute is explicitly hidden from smbd clients
9169 requesting an EA list. On Linux the filesystem must have been
9170 mounted with the mount option user_xattr in order for extended
9171 attributes to work, also extended attributes must be compiled into
9172 the Linux kernel. In Samba 3.5.0 and above the "user.DOSATTRIB"
9173 extended attribute has been extended to store the create time for a
9174 file as well as the DOS attributes. This is done in a backwards
9175 compatible way so files created by Samba 3.5.0 and above can still
9176 have the DOS attribute read from this extended attribute by earlier
9177 versions of Samba, but they will not be able to read the create
9178 time stored there. Storing the create time separately from the
9179 normal filesystem meta-data allows Samba to faithfully reproduce
9180 NTFS semantics on top of a POSIX filesystem. The default has
9181 changed to yes in Samba release 4.9.0 and above to allow better
9182 Windows fileserver compatibility in a default install.
9183 Default: store dos attributes = yes
9185 strict allocate (S)
9187 This is a boolean that controls the handling of disk space
9189 allocation in the server. When this is set to yes the server will
9190 change from UNIX behaviour of not committing real disk storage
9191 blocks when a file is extended to the Windows behaviour of actually
9192 forcing the disk system to allocate real storage blocks when a file
9193 is created or extended to be a given size. In UNIX terminology this
9194 means that Samba will stop creating sparse files.
9195 This option is really designed for file systems that support fast
9197 allocation of large numbers of blocks such as extent-based file
9198 systems. On file systems that don't support extents (most notably
9199 ext3) this can make Samba slower. When you work with large files
9200 over >100MB on file systems without extents you may even run into
9201 problems with clients running into timeouts.
9202 When you have an extent based filesystem it's likely that we can
9204 make use of unwritten extents which allows Samba to allocate even
9205 large amounts of space very fast and you will not see any timeout
9206 problems caused by strict allocate. With strict allocate in use you
9207 will also get much better out of quota messages in case you use
9208 quotas. Another advantage of activating this setting is that it
9209 will help to reduce file fragmentation.
9210 To give you an idea on which filesystems this setting might
9212 currently be a good option for you: XFS, ext4, btrfs, ocfs2 on
9213 Linux and JFS2 on AIX support unwritten extents. On Filesystems
9214 that do not support it, preallocation is probably an expensive
9215 operation where you will see reduced performance and risk to let
9216 clients run into timeouts when creating large files. Examples are
9217 ext3, ZFS, HFS+ and most others, so be aware if you activate this
9218 setting on those filesystems.
9219 Default: strict allocate = no
9221 strict locking (S)
9223 This is an enumerated type that controls the handling of file
9225 locking in the server. When this is set to yes, the server will
9226 check every read and write access for file locks, and deny access
9227 if locks exist. This can be slow on some systems.
9228 When strict locking is set to Auto (the default), the server
9230 performs file lock checks only on non-oplocked files. As most
9231 Windows redirectors perform file locking checks locally on oplocked
9232 files this is a good trade off for improved performance.
9233 When strict locking is disabled, the server performs file lock
9235 checks only when the client explicitly asks for them.
9236 Well-behaved clients always ask for lock checks when it is
9238 important. So in the vast majority of cases, strict locking = Auto
9239 or strict locking = no is acceptable.
9240 Default: strict locking = Auto
9242 strict rename (S)
9244 By default a Windows SMB server prevents directory renames when
9246 there are open file or directory handles below it in the filesystem
9247 hierarchy. Historically Samba has always allowed this as POSIX
9248 filesystem semantics require it.
9249 This boolean parameter allows Samba to match the Windows behavior.
9251 Setting this to "yes" is a very expensive change, as it forces
9252 Samba to travers the entire open file handle database on every
9253 directory rename request. In a clustered Samba system the cost is
9254 even greater than the non-clustered case.
9255 When set to "no" smbd only checks the local process the client is
9257 attached to for open files below a directory being renamed, instead
9258 of checking for open files across all smbd processes.
9259 Because of the expense in fully searching the database, the default
9261 is "no", and it is recommended to be left that way unless a
9262 specific Windows application requires it to be changed.
9263 If the client has requested UNIX extensions (POSIX pathnames) then
9265 renames are always allowed and this parameter has no effect.
9266 Default: strict rename = no
9268 strict sync (S)
9270 This parameter controls whether Samba honors a request from an SMB
9272 client to ensure any outstanding operating system buffer contents
9273 held in memory are safely written onto stable storage on disk. If
9274 set to yes, which is the default, then Windows applications can
9275 force the smbd server to synchronize unwritten data onto the disk.
9276 If set to no then smbd will ignore client requests to synchronize
9277 unwritten data onto stable storage on disk.
9278 In Samba 4.7.0, the default for this parameter changed from no to
9280 yes to better match the expectations of SMB2/3 clients and improve
9281 application safety when running against smbd.
9282 The flush request from SMB2/3 clients is handled asynchronously
9284 inside smbd, so leaving the parameter as the default value of yes
9285 does not block the processing of other requests to the smbd
9286 process.
9287 Legacy Windows applications (such as the Windows 98 explorer shell)
9289 seemed to confuse writing buffer contents to the operating system
9290 with synchronously writing outstanding data onto stable storage on
9291 disk. Changing this parameter to no means that smbd(8) will ignore
9292 the Windows applications request to synchronize unwritten data onto
9293 disk. Only consider changing this if smbd is serving obsolete SMB1
9294 Windows clients prior to Windows XP (Windows 98 and below). There
9295 should be no need to change this setting for normal operations.
9296 Default: strict sync = yes
9298 svcctl list (G)
9300 This option defines a list of init scripts that smbd will use for
9302 starting and stopping Unix services via the Win32 ServiceControl
9303 API. This allows Windows administrators to utilize the MS
9304 Management Console plug-ins to manage a Unix server running Samba.
9305 The administrator must create a directory name svcctl in Samba's
9307 $(libdir) and create symbolic links to the init scripts in
9308 /etc/init.d/. The name of the links must match the names given as
9309 part of the svcctl list.
9310 Default: svcctl list =
9312 Example: svcctl list = cups postfix portmap httpd
9314 sync always (S)
9316 This is a boolean parameter that controls whether writes will
9318 always be written to stable storage before the write call returns.
9319 If this is no then the server will be guided by the client's
9320 request in each write call (clients can set a bit indicating that a
9321 particular write should be synchronous). If this is yes then every
9322 write will be followed by a fsync() call to ensure the data is
9323 written to disk. Note that the strict sync parameter must be set to
9324 yes in order for this parameter to have any effect.
9325 Default: sync always = no
9327 syslog (G)
9329 This parameter maps how Samba debug messages are logged onto the
9331 system syslog logging levels. Samba debug level zero maps onto
9332 syslog LOG_ERR, debug level one maps onto LOG_WARNING, debug level
9333 two maps onto LOG_NOTICE, debug level three maps onto LOG_INFO. All
9334 higher levels are mapped to LOG_DEBUG.
9335 This parameter sets the threshold for sending messages to syslog.
9337 Only messages with debug level less than this value will be sent to
9338 syslog. There still will be some logging to log.[sn]mbd even if
9339 syslog only is enabled.
9340 The logging parameter should be used instead. When logging is set,
9342 it overrides the syslog parameter.
9343 Default: syslog = 1
9345 syslog only (G)
9347 If this parameter is set then Samba debug messages are logged into
9349 the system syslog only, and not to the debug log files. There still
9350 will be some logging to log.[sn]mbd even if syslog only is enabled.
9351 The logging parameter should be used instead. When logging is set,
9353 it overrides the syslog only parameter.
9354 Default: syslog only = no
9356 template homedir (G)
9358 When filling out the user information for a Windows NT user, the
9360 winbindd(8) daemon uses this parameter to fill in the home
9361 directory for that user. If the string %D is present it is
9362 substituted with the user's Windows NT domain name. If the string
9363 %U is present it is substituted with the user's Windows NT user
9364 name.
9365 Default: template homedir = /home/%D/%U
9367 template shell (G)
9369 When filling out the user information for a Windows NT user, the
9371 winbindd(8) daemon uses this parameter to fill in the login shell
9372 for that user.
9373 Default: template shell = /bin/false
9375 time server (G)
9377 This parameter determines if nmbd(8) advertises itself as a time
9379 server to Windows clients.
9380 Default: time server = no
9382 debug timestamp
9384 This parameter is a synonym for timestamp logs.
9386 timestamp logs (G)
9388 Samba debug log messages are timestamped by default. If you are
9390 running at a high debug level these timestamps can be distracting.
9391 This boolean parameter allows timestamping to be turned off.
9392 Default: timestamp logs = yes
9394 tls cafile (G)
9396 This option can be set to a file (PEM format) containing CA
9398 certificates of root CAs to trust to sign certificates or
9399 intermediate CA certificates.
9400 This path is relative to private dir if the path does not start
9402 with a /.
9403 Default: tls cafile = tls/ca.pem
9405 tls certfile (G)
9407 This option can be set to a file (PEM format) containing the RSA
9409 certificate.
9410 This path is relative to private dir if the path does not start
9412 with a /.
9413 Default: tls certfile = tls/cert.pem
9415 tls crlfile (G)
9417 This option can be set to a file containing a certificate
9419 revocation list (CRL).
9420 This path is relative to private dir if the path does not start
9422 with a /.
9423 Default: tls crlfile =
9425 tls dh params file (G)
9427 This option can be set to a file with Diffie-Hellman parameters
9429 which will be used with DH ciphers.
9430 This path is relative to private dir if the path does not start
9432 with a /.
9433 Default: tls dh params file =
9435 tls enabled (G)
9437 If this option is set to yes, then Samba will use TLS when possible
9439 in communication.
9440 Default: tls enabled = yes
9442 tls keyfile (G)
9444 This option can be set to a file (PEM format) containing the RSA
9446 private key. This file must be accessible without a pass-phrase,
9447 i.e. it must not be encrypted.
9448 This path is relative to private dir if the path does not start
9450 with a /.
9451 Default: tls keyfile = tls/key.pem
9453 tls priority (G)
9455 This option can be set to a string describing the TLS protocols to
9457 be supported in the parts of Samba that use GnuTLS, specifically
9458 the AD DC.
9459 The string is appended to the default priority list of GnuTLS.
9461 The valid options are described in the GNUTLS Priority-Strings
9463 documentation at
9464 http://gnutls.org/manual/html_node/Priority-Strings.html
9465 The SSL3.0 protocol will be disabled.
9467 Default: tls priority = NORMAL:-VERS-SSL3.0
9469 tls verify peer (G)
9471 This controls if and how strict the client will verify the peer's
9473 certificate and name. Possible values are (in increasing order):
9474 no_check, ca_only, ca_and_name_if_available, ca_and_name and
9475 as_strict_as_possible.
9476 When set to no_check the certificate is not verified at all, which
9478 allows trivial man in the middle attacks.
9479 When set to ca_only the certificate is verified to be signed from a
9481 ca specified in the tls ca file option. Setting tls ca file to a
9482 valid file is required. The certificate lifetime is also verified.
9483 If the tls crl file option is configured, the certificate is also
9484 verified against the ca crl.
9485 When set to ca_and_name_if_available all checks from ca_only are
9487 performed. In addition, the peer hostname is verified against the
9488 certificate's name, if it is provided by the application layer and
9489 not given as an ip address string.
9490 When set to ca_and_name all checks from ca_and_name_if_available
9492 are performed. In addition the peer hostname needs to be provided
9493 and even an ip address is checked against the certificate's name.
9494 When set to as_strict_as_possible all checks from ca_and_name are
9496 performed. In addition the tls crl file needs to be configured.
9497 Future versions of Samba may implement additional checks.
9498 Default: tls verify peer = as_strict_as_possible
9500 unicode (G)
9502 Specifies whether the server and client should support unicode.
9504 If this option is set to false, the use of ASCII will be forced.
9506 Default: unicode = yes
9508 unix charset (G)
9510 Specifies the charset the unix machine Samba runs on uses. Samba
9512 needs to know this in order to be able to convert text to the
9513 charsets other SMB clients use.
9514 This is also the charset Samba will use when specifying arguments
9516 to scripts that it invokes.
9517 Default: unix charset = UTF-8
9519 Example: unix charset = ASCII
9521 unix extensions (G)
9523 This boolean parameter controls whether Samba implements the CIFS
9525 UNIX extensions, as defined by HP. These extensions enable Samba to
9526 better serve UNIX CIFS clients by supporting features such as
9527 symbolic links, hard links, etc... These extensions require a
9528 similarly enabled client, and are of no current use to Windows
9529 clients.
9530 Note if this parameter is turned on, the wide links parameter will
9532 automatically be disabled.
9533 See the parameter allow insecure wide links if you wish to change
9535 this coupling between the two parameters.
9536 Default: unix extensions = yes
9538 unix password sync (G)
9540 This boolean parameter controls whether Samba attempts to
9542 synchronize the UNIX password with the SMB password when the
9543 encrypted SMB password in the smbpasswd file is changed. If this is
9544 set to yes the program specified in the passwd program parameter is
9545 called AS ROOT - to allow the new UNIX password to be set without
9546 access to the old UNIX password (as the SMB password change code
9547 has no access to the old password cleartext, only the new).
9548 This option has no effect if samba is running as an active
9550 directory domain controller, in that case have a look at the
9551 password hash gpg key ids option and the samba-tool user
9552 syncpasswords command.
9553 Default: unix password sync = no
9555 use client driver (S)
9557 This parameter applies only to Windows NT/2000 clients. It has no
9559 effect on Windows 95/98/ME clients. When serving a printer to
9560 Windows NT/2000 clients without first installing a valid printer
9561 driver on the Samba host, the client will be required to install a
9562 local printer driver. From this point on, the client will treat the
9563 print as a local printer and not a network printer connection. This
9564 is much the same behavior that will occur when disable spoolss =
9565 yes.
9566 The differentiating factor is that under normal circumstances, the
9568 NT/2000 client will attempt to open the network printer using
9569 MS-RPC. The problem is that because the client considers the
9570 printer to be local, it will attempt to issue the OpenPrinterEx()
9571 call requesting access rights associated with the logged on user.
9572 If the user possesses local administrator rights but not root
9573 privilege on the Samba host (often the case), the OpenPrinterEx()
9574 call will fail. The result is that the client will now display an
9575 "Access Denied; Unable to connect" message in the printer queue
9576 window (even though jobs may successfully be printed).
9577 If this parameter is enabled for a printer, then any attempt to
9579 open the printer with the PRINTER_ACCESS_ADMINISTER right is mapped
9580 to PRINTER_ACCESS_USE instead. Thus allowing the OpenPrinterEx()
9581 call to succeed. This parameter MUST not be enabled on a print
9582 share which has valid print driver installed on the Samba server.
9583 Default: use client driver = no
9585 use mmap (G)
9587 This global parameter determines if the tdb internals of Samba can
9589 depend on mmap working correctly on the running system. Samba
9590 requires a coherent mmap/read-write system memory cache. Currently
9591 only OpenBSD and HPUX do not have such a coherent cache, and on
9592 those platforms this paramter is overridden internally to be
9593 effeceively no. On all systems this parameter should be left alone.
9594 This parameter is provided to help the Samba developers track down
9595 problems with the tdb internal code.
9596 Default: use mmap = yes
9598 username level (G)
9600 This option helps Samba to try and 'guess' at the real UNIX
9602 username, as many DOS clients send an all-uppercase username. By
9603 default Samba tries all lowercase, followed by the username with
9604 the first letter capitalized, and fails if the username is not
9605 found on the UNIX machine.
9606 If this parameter is set to non-zero the behavior changes. This
9608 parameter is a number that specifies the number of uppercase
9609 combinations to try while trying to determine the UNIX user name.
9610 The higher the number the more combinations will be tried, but the
9611 slower the discovery of usernames will be. Use this parameter when
9612 you have strange usernames on your UNIX machine, such as
9613 AstrangeUser .
9614 This parameter is needed only on UNIX systems that have case
9616 sensitive usernames.
9617 Default: username level = 0
9619 Example: username level = 5
9621 username map (G)
9623 This option allows you to specify a file containing a mapping of
9625 usernames from the clients to the server. This can be used for
9626 several purposes. The most common is to map usernames that users
9627 use on DOS or Windows machines to those that the UNIX box uses. The
9628 other is to map multiple users to a single username so that they
9629 can more easily share files.
9630 Please note that for user mode security, the username map is
9632 applied prior to validating the user credentials. Domain member
9633 servers (domain or ads) apply the username map after the user has
9634 been successfully authenticated by the domain controller and
9635 require fully qualified entries in the map table (e.g. biddle =
9636 DOMAIN\foo).
9637 The map file is parsed line by line. Each line should contain a
9639 single UNIX username on the left then a '=' followed by a list of
9640 usernames on the right. The list of usernames on the right may
9641 contain names of the form @group in which case they will match any
9642 UNIX username in that group. The special client name '*' is a
9643 wildcard and matches any name. Each line of the map file may be up
9644 to 1023 characters long.
9645 The file is processed on each line by taking the supplied username
9647 and comparing it with each username on the right hand side of the
9648 '=' signs. If the supplied name matches any of the names on the
9649 right hand side then it is replaced with the name on the left.
9650 Processing then continues with the next line.
9651 If any line begins with a '#' or a ';' then it is ignored.
9653 If any line begins with an '!' then the processing will stop after
9655 that line if a mapping was done by the line. Otherwise mapping
9656 continues with every line being processed. Using '!' is most useful
9657 when you have a wildcard mapping line later in the file.
9658 For example to map from the name admin or administrator to the UNIX
9660 name
9661 root you would use:
9662 root = admin administrator
9664 Or to map anyone in the UNIX group system to the UNIX name sys you
9666 would use:
9667 sys = @system
9669 You can have as many mappings as you like in a username map file.
9671 You can map Windows usernames that have spaces in them by using
9673 double quotes around the name. For example:
9674 tridge = "Andrew Tridgell"
9676 would map the windows username "Andrew Tridgell" to the unix
9678 username "tridge".
9679 The following example would map mary and fred to the unix user sys,
9681 and map the rest to guest. Note the use of the '!' to tell Samba to
9682 stop processing if it gets a match on that line:
9683 !sys = mary fred
9685 guest = *
9686 Note that the remapping is applied to all occurrences of usernames.
9688 Thus if you connect to \\server\fred and fred is remapped to mary
9689 then you will actually be connecting to \\server\mary and will need
9690 to supply a password suitable for mary not fred. The only exception
9691 to this is the username passed to a Domain Controller (if you have
9692 one). The DC will receive whatever username the client supplies
9693 without modification.
9694 Also note that no reverse mapping is done. The main effect this has
9696 is with printing. Users who have been mapped may have trouble
9697 deleting print jobs as PrintManager under WfWg will think they
9698 don't own the print job.
9699 Samba versions prior to 3.0.8 would only support reading the fully
9701 qualified username (e.g.: DOMAIN\user) from the username map when
9702 performing a kerberos login from a client. However, when looking up
9703 a map entry for a user authenticated by NTLM[SSP], only the login
9704 name would be used for matches. This resulted in inconsistent
9705 behavior sometimes even on the same server.
9706 The following functionality is obeyed in version 3.0.8 and later:
9708 When performing local authentication, the username map is applied
9710 to the login name before attempting to authenticate the connection.
9711 When relying upon a external domain controller for validating
9713 authentication requests, smbd will apply the username map to the
9714 fully qualified username (i.e. DOMAIN\user) only after the user
9715 has been successfully authenticated.
9716 An example of use is:
9718 username map = /usr/local/samba/lib/users.map
9720 Default: username map = # no username map
9722 username map cache time (G)
9724 Mapping usernames with the username map or username map script
9726 features of Samba can be relatively expensive. During login of a
9727 user, the mapping is done several times. In particular, calling the
9728 username map script can slow down logins if external databases have
9729 to be queried from the script being called.
9730 The parameter username map cache time controls a mapping cache. It
9732 specifies the number of seconds a mapping from the username map
9733 file or script is to be efficiently cached. The default of 0 means
9734 no caching is done.
9735 Default: username map cache time = 0
9737 Example: username map cache time = 60
9739 username map script (G)
9741 This script is a mutually exclusive alternative to the username map
9743 parameter. This parameter specifies and external program or script
9744 that must accept a single command line option (the username
9745 transmitted in the authentication request) and return a line on
9746 standard output (the name to which the account should mapped). In
9747 this way, it is possible to store username map tables in an LDAP
9748 directory services.
9749 Default: username map script =
9751 Example: username map script = /etc/samba/scripts/mapusers.sh
9753 usershare allow guests (G)
9755 This parameter controls whether user defined shares are allowed to
9757 be accessed by non-authenticated users or not. It is the equivalent
9758 of allowing people who can create a share the option of setting
9759 guest ok = yes in a share definition. Due to its security sensitive
9760 nature, the default is set to off.
9761 Default: usershare allow guests = no
9763 usershare max shares (G)
9765 This parameter specifies the number of user defined shares that are
9767 allowed to be created by users belonging to the group owning the
9768 usershare directory. If set to zero (the default) user defined
9769 shares are ignored.
9770 Default: usershare max shares = 0
9772 usershare owner only (G)
9774 This parameter controls whether the pathname exported by a user
9776 defined shares must be owned by the user creating the user defined
9777 share or not. If set to True (the default) then smbd checks that
9778 the directory path being shared is owned by the user who owns the
9779 usershare file defining this share and refuses to create the share
9780 if not. If set to False then no such check is performed and any
9781 directory path may be exported regardless of who owns it.
9782 Default: usershare owner only = yes
9784 usershare path (G)
9786 This parameter specifies the absolute path of the directory on the
9788 filesystem used to store the user defined share definition files.
9789 This directory must be owned by root, and have no access for other,
9790 and be writable only by the group owner. In addition the "sticky"
9791 bit must also be set, restricting rename and delete to owners of a
9792 file (in the same way the /tmp directory is usually configured).
9793 Members of the group owner of this directory are the users allowed
9794 to create usershares.
9795 For example, a valid usershare directory might be
9797 /usr/local/samba/lib/usershares, set up as follows.
9798 ls -ld /usr/local/samba/lib/usershares/
9800 drwxrwx--T 2 root power_users 4096 2006-05-05 12:27 /usr/local/samba/lib/usershares/
9801 In this case, only members of the group "power_users" can create
9804 user defined shares.
9805 Default: usershare path = /var/lib/samba/usershares
9807 usershare prefix allow list (G)
9809 This parameter specifies a list of absolute pathnames the root of
9811 which are allowed to be exported by user defined share definitions.
9812 If the pathname to be exported doesn't start with one of the
9813 strings in this list, the user defined share will not be allowed.
9814 This allows the Samba administrator to restrict the directories on
9815 the system that can be exported by user defined shares.
9816 If there is a "usershare prefix deny list" and also a "usershare
9818 prefix allow list" the deny list is processed first, followed by
9819 the allow list, thus leading to the most restrictive
9820 interpretation.
9821 Default: usershare prefix allow list =
9823 Example: usershare prefix allow list = /home /data /space
9825 usershare prefix deny list (G)
9827 This parameter specifies a list of absolute pathnames the root of
9829 which are NOT allowed to be exported by user defined share
9830 definitions. If the pathname exported starts with one of the
9831 strings in this list the user defined share will not be allowed.
9832 Any pathname not starting with one of these strings will be allowed
9833 to be exported as a usershare. This allows the Samba administrator
9834 to restrict the directories on the system that can be exported by
9835 user defined shares.
9836 If there is a "usershare prefix deny list" and also a "usershare
9838 prefix allow list" the deny list is processed first, followed by
9839 the allow list, thus leading to the most restrictive
9840 interpretation.
9841 Default: usershare prefix deny list =
9843 Example: usershare prefix deny list = /etc /dev /private
9845 usershare template share (G)
9847 User defined shares only have limited possible parameters such as
9849 path, guest ok, etc. This parameter allows usershares to "cloned"
9850 from an existing share. If "usershare template share" is set to the
9851 name of an existing share, then all usershares created have their
9852 defaults set from the parameters set on this share.
9853 The target share may be set to be invalid for real file sharing by
9855 setting the parameter "-valid = False" on the template share
9856 definition. This causes it not to be seen as a real exported share
9857 but to be able to be used as a template for usershares.
9858 Default: usershare template share =
9860 Example: usershare template share = template_share
9862 use sendfile (S)
9864 If this parameter is yes, and the sendfile() system call is
9866 supported by the underlying operating system, then some SMB read
9867 calls (mainly ReadAndX and ReadRaw) will use the more efficient
9868 sendfile system call for files that are exclusively oplocked. This
9869 may make more efficient use of the system CPU's and cause Samba to
9870 be faster. Samba automatically turns this off for clients that use
9871 protocol levels lower than NT LM 0.12 and when it detects a client
9872 is Windows 9x (using sendfile from Linux will cause these clients
9873 to fail).
9874 Default: use sendfile = no
9876 utmp (G)
9878 This boolean parameter is only available if Samba has been
9880 configured and compiled with the option --with-utmp. If set to yes
9881 then Samba will attempt to add utmp or utmpx records (depending on
9882 the UNIX system) whenever a connection is made to a Samba server.
9883 Sites may use this to record the user connecting to a Samba share.
9884 Due to the requirements of the utmp record, we are required to
9886 create a unique identifier for the incoming user. Enabling this
9887 option creates an n^2 algorithm to find this number. This may
9888 impede performance on large installations.
9889 Default: utmp = no
9891 utmp directory (G)
9893 This parameter is only available if Samba has been configured and
9895 compiled with the option --with-utmp. It specifies a directory
9896 pathname that is used to store the utmp or utmpx files (depending
9897 on the UNIX system) that record user connections to a Samba server.
9898 By default this is not set, meaning the system will use whatever
9899 utmp file the native system is set to use (usually /var/run/utmp on
9900 Linux).
9901 Default: utmp directory = # Determined automatically
9903 Example: utmp directory = /var/run/utmp
9905 -valid (S)
9907 This parameter indicates whether a share is valid and thus can be
9909 used. When this parameter is set to false, the share will be in no
9910 way visible nor accessible.
9911 This option should not be used by regular users but might be of
9913 help to developers. Samba uses this option internally to mark
9914 shares as deleted.
9915 Default: -valid = yes
9917 valid users (S)
9919 This is a list of users that should be allowed to login to this
9921 service. Names starting with an '@' are interpreted using the same
9922 rules as described in the invalid users parameter.
9923 If this is empty (the default) then any user can login. If a
9925 username is in both this list and the invalid users list then
9926 access is denied for that user.
9927 The current servicename is substituted for %S. This is useful in
9929 the [homes] section.
9930 Note: When used in the [global] section this parameter may have
9932 unwanted side effects. For example: If samba is configured as a
9933 MASTER BROWSER (see local master, os level, domain master,
9934 preferred master) this option will prevent workstations from being
9935 able to browse the network.
9936 Default: valid users = # No valid users list (anyone can login)
9938 Example: valid users = greg, @pcusers
9940 veto files (S)
9942 This is a list of files and directories that are neither visible
9944 nor accessible. Each entry in the list must be separated by a '/',
9945 which allows spaces to be included in the entry. '*' and '?' can be
9946 used to specify multiple files or directories as in DOS wildcards.
9947 Each entry must be a unix path, not a DOS path and must not include
9949 the unix directory separator '/'.
9950 Note that the case sensitive option is applicable in vetoing files.
9952 One feature of the veto files parameter that it is important to be
9954 aware of is Samba's behaviour when trying to delete a directory. If
9955 a directory that is to be deleted contains nothing but veto files
9956 this deletion will fail unless you also set the delete veto files
9957 parameter to yes.
9958 Setting this parameter will affect the performance of Samba, as it
9960 will be forced to check all files and directories for a match as
9961 they are scanned.
9962 Examples of use include:
9964 ; Veto any files containing the word Security,
9966 ; any ending in .tmp, and any directory containing the
9967 ; word root.
9968 veto files = /*Security*/*.tmp/*root*/
9969 ; Veto the Apple specific files that a NetAtalk server
9971 ; creates.
9972 veto files = /.AppleDouble/.bin/.AppleDesktop/Network Trash Folder/
9973 Default: veto files = # No files or directories are vetoed
9975 veto oplock files (S)
9977 This parameter is only valid when the oplocks parameter is turned
9979 on for a share. It allows the Samba administrator to selectively
9980 turn off the granting of oplocks on selected files that match a
9981 wildcarded list, similar to the wildcarded list used in the veto
9982 files parameter.
9983 You might want to do this on files that you know will be heavily
9985 contended for by clients. A good example of this is in the NetBench
9986 SMB benchmark program, which causes heavy client contention for
9987 files ending in .SEM. To cause Samba not to grant oplocks on these
9988 files you would use the line (either in the [global] section or in
9989 the section for the particular NetBench share.
9990 An example of use is:
9992 veto oplock files = /.*SEM/
9994 Default: veto oplock files = # No files are vetoed for oplock
9996 grants
9997 vfs object
9999 This parameter is a synonym for vfs objects.
10001 vfs objects (S)
10003 This parameter specifies the backend names which are used for Samba
10005 VFS I/O operations. By default, normal disk I/O operations are used
10006 but these can be overloaded with one or more VFS objects. Be aware
10007 that the definition of this parameter will overwrite a possible
10008 previous definition of the vfs objects parameter.
10009 Default: vfs objects =
10011 Example: vfs objects = extd_audit recycle
10013 volume (S)
10015 This allows you to override the volume label returned for a share.
10017 Useful for CDROMs with installation programs that insist on a
10018 particular volume label.
10019 Default: volume = # the name of the share
10021 wide links (S)
10023 This parameter controls whether or not links in the UNIX file
10025 system may be followed by the server. Links that point to areas
10026 within the directory tree exported by the server are always
10027 allowed; this parameter controls access only to areas that are
10028 outside the directory tree being exported.
10029 Note: Turning this parameter on when UNIX extensions are enabled
10031 will allow UNIX clients to create symbolic links on the share that
10032 can point to files or directories outside restricted path exported
10033 by the share definition. This can cause access to areas outside of
10034 the share. Due to this problem, this parameter will be
10035 automatically disabled (with a message in the log file) if the unix
10036 extensions option is on.
10037 See the parameter allow insecure wide links if you wish to change
10039 this coupling between the two parameters.
10040 Default: wide links = no
10042 winbind cache time (G)
10044 This parameter specifies the number of seconds the winbindd(8)
10046 daemon will cache user and group information before querying a
10047 Windows NT server again.
10048 This does not apply to authentication requests, these are always
10050 evaluated in real time unless the winbind offline logon option has
10051 been enabled.
10052 Default: winbind cache time = 300
10054 winbindd socket directory (G)
10056 This setting controls the location of the winbind daemon's socket.
10058 Except within automated test scripts, this should not be altered,
10060 as the client tools (nss_winbind etc) do not honour this parameter.
10061 Client tools must then be advised of the altered path with the
10062 WINBINDD_SOCKET_DIR environment variable.
10063 Default: winbindd socket directory = /run/samba/winbindd
10065 winbind enum groups (G)
10067 On large installations using winbindd(8) it may be necessary to
10069 suppress the enumeration of groups through the setgrent(),
10070 getgrent() and endgrent() group of system calls. If the winbind
10071 enum groups parameter is no, calls to the getgrent() system call
10072 will not return any data.
10073 Warning
10075 Turning off group enumeration may cause some programs to behave
10076 oddly.
10077 Default: winbind enum groups = no
10078 winbind enum users (G)
10080 On large installations using winbindd(8) it may be necessary to
10082 suppress the enumeration of users through the setpwent(),
10083 getpwent() and endpwent() group of system calls. If the winbind
10084 enum users parameter is no, calls to the getpwent system call will
10085 not return any data.
10086 Warning
10088 Turning off user enumeration may cause some programs to behave
10089 oddly. For example, the finger program relies on having access
10090 to the full user list when searching for matching usernames.
10091 Default: winbind enum users = no
10092 winbind expand groups (G)
10094 This option controls the maximum depth that winbindd will traverse
10096 when flattening nested group memberships of Windows domain groups.
10097 This is different from the winbind nested groups option which
10098 implements the Windows NT4 model of local group nesting. The
10099 "winbind expand groups" parameter specifically applies to the
10100 membership of domain groups.
10101 This option also affects the return of non nested group memberships
10103 of Windows domain users. With the new default "winbind expand
10104 groups = 0" winbind does not query group memberships at all.
10105 Be aware that a high value for this parameter can result in system
10107 slowdown as the main parent winbindd daemon must perform the group
10108 unrolling and will be unable to answer incoming NSS or
10109 authentication requests during this time.
10110 The default value was changed from 1 to 0 with Samba 4.2. Some
10112 broken applications (including some implementations of newgrp and
10113 sg) calculate the group memberships of users by traversing groups,
10114 such applications will require "winbind expand groups = 1". But the
10115 new default makes winbindd more reliable as it doesn't require SAMR
10116 access to domain controllers of trusted domains.
10117 Default: winbind expand groups = 0
10119 winbind:ignore domains (G)
10121 Allows one to enter a list of trusted domains winbind should ignore
10123 (untrust). This can avoid the overhead of resources from attempting
10124 to login to DCs that should not be communicated with.
10125 Default: winbind:ignore domains =
10127 Example: winbind:ignore domains = DOMAIN1, DOMAIN2
10129 winbind max clients (G)
10131 This parameter specifies the maximum number of clients the
10133 winbindd(8) daemon can connect with. The parameter is not a hard
10134 limit. The winbindd(8) daemon configures itself to be able to
10135 accept at least that many connections, and if the limit is reached,
10136 an attempt is made to disconnect idle clients.
10137 Default: winbind max clients = 200
10139 winbind max domain connections (G)
10141 This parameter specifies the maximum number of simultaneous
10143 connections that the winbindd(8) daemon should open to the domain
10144 controller of one domain. Setting this parameter to a value greater
10145 than 1 can improve scalability with many simultaneous winbind
10146 requests, some of which might be slow.
10147 Note that if winbind offline logon is set to Yes, then only one DC
10149 connection is allowed per domain, regardless of this setting.
10150 Default: winbind max domain connections = 1
10152 Example: winbind max domain connections = 10
10154 winbind nested groups (G)
10156 If set to yes, this parameter activates the support for nested
10158 groups. Nested groups are also called local groups or aliases. They
10159 work like their counterparts in Windows: Nested groups are defined
10160 locally on any machine (they are shared between DC's through their
10161 SAM) and can contain users and global groups from any trusted SAM.
10162 To be able to use nested groups, you need to run nss_winbind.
10163 Default: winbind nested groups = yes
10165 winbind normalize names (G)
10167 This parameter controls whether winbindd will replace whitespace in
10169 user and group names with an underscore (_) character. For example,
10170 whether the name "Space Kadet" should be replaced with the string
10171 "space_kadet". Frequently Unix shell scripts will have difficulty
10172 with usernames contains whitespace due to the default field
10173 separator in the shell. If your domain possesses names containing
10174 the underscore character, this option may cause problems unless the
10175 name aliasing feature is supported by your nss_info plugin.
10176 This feature also enables the name aliasing API which can be used
10178 to make domain user and group names to a non-qualified version.
10179 Please refer to the manpage for the configured idmap and nss_info
10180 plugin for the specifics on how to configure name aliasing for a
10181 specific configuration. Name aliasing takes precedence (and is
10182 mutually exclusive) over the whitespace replacement mechanism
10183 discussed previously.
10184 Default: winbind normalize names = no
10186 Example: winbind normalize names = yes
10188 winbind nss info (G)
10190 This parameter is designed to control how Winbind retrieves Name
10192 Service Information to construct a user's home directory and login
10193 shell. Currently the following settings are available:
10194 • template - The default, using the parameters of template
10196 shell and template homedir)
10197 • <sfu | sfu20 | rfc2307 > - When Samba is running in
10199 security = ads and your Active Directory Domain
10200 Controller does support the Microsoft "Services for
10201 Unix" (SFU) LDAP schema, winbind can retrieve the login
10202 shell and the home directory attributes directly from
10203 your Directory Server. For SFU 3.0 or 3.5 simply choose
10204 "sfu", if you use SFU 2.0 please choose "sfu20".
10205 Note that for the idmap backend idmap_ad you need to
10207 configure those settings in the idmap configuration
10208 section. Make sure to consult the documentation of the
10209 idmap backend that you are using.
10210 Default: winbind nss info = template
10213 Example: winbind nss info = sfu
10215 winbind offline logon (G)
10217 This parameter is designed to control whether Winbind should allow
10219 one to login with the pam_winbind module using Cached Credentials.
10220 If enabled, winbindd will store user credentials from successful
10221 logins encrypted in a local cache.
10222 Default: winbind offline logon = no
10224 Example: winbind offline logon = yes
10226 winbind reconnect delay (G)
10228 This parameter specifies the number of seconds the winbindd(8)
10230 daemon will wait between attempts to contact a Domain controller
10231 for a domain that is determined to be down or not contactable.
10232 Default: winbind reconnect delay = 30
10234 winbind refresh tickets (G)
10236 This parameter is designed to control whether Winbind should
10238 refresh Kerberos Tickets retrieved using the pam_winbind module.
10239 Default: winbind refresh tickets = no
10241 Example: winbind refresh tickets = yes
10243 winbind request timeout (G)
10245 This parameter specifies the number of seconds the winbindd(8)
10247 daemon will wait before disconnecting either a client connection
10248 with no outstanding requests (idle) or a client connection with a
10249 request that has remained outstanding (hung) for longer than this
10250 number of seconds.
10251 Default: winbind request timeout = 60
10253 winbind rpc only (G)
10255 Setting this parameter to yes forces winbindd to use RPC instead of
10257 LDAP to retrieve information from Domain Controllers.
10258 Default: winbind rpc only = no
10260 winbind scan trusted domains (G)
10262 This option only takes effect when the security option is set to
10264 domain or ads. If it is set to yes, winbindd periodically tries to
10265 scan for new trusted domains and adds them to a global list inside
10266 of winbindd. The list can be extracted with wbinfo
10267 --trusted-domains --verbose. Setting it to yes matches the
10268 behaviour of Samba 4.7 and older.
10269 The construction of that global list is not reliable and often
10271 incomplete in complex trust setups. In most situations the list is
10272 not needed any more for winbindd to operate correctly. E.g. for
10273 plain file serving via SMB using a simple idmap setup with autorid,
10274 tdb or ad. However some more complex setups require the list, e.g.
10275 if you specify idmap backends for specific domains. Some
10276 pam_winbind setups may also require the global list.
10277 If you have a setup that doesn't require the global list, you
10279 should set winbind scan trusted domains = no.
10280 Default: winbind scan trusted domains = no
10282 winbind sealed pipes (G)
10284 This option controls whether any requests from winbindd to domain
10286 controllers pipe will be sealed. Disabling sealing can be useful
10287 for debugging purposes.
10288 The behavior can be controlled per netbios domain by using 'winbind
10290 sealed pipes:NETBIOSDOMAIN = no' as option.
10291 Default: winbind sealed pipes = yes
10293 winbind separator (G)
10295 This parameter allows an admin to define the character used when
10297 listing a username of the form of DOMAIN \user. This parameter is
10298 only applicable when using the pam_winbind.so and nss_winbind.so
10299 modules for UNIX services.
10300 Please note that setting this parameter to + can cause problems
10302 with group membership at least on glibc systems, as the character +
10303 was used as a special character for NIS in /etc/group.
10304 Default: winbind separator = \
10306 Example: winbind separator = +
10308 winbind use default domain (G)
10310 This parameter specifies whether the winbindd(8) daemon should
10312 operate on users without domain component in their username. Users
10313 without a domain component are treated as is part of the winbindd
10314 server's own domain. While this does not benefit Windows users, it
10315 makes SSH, FTP and e-mail function in a way much closer to the way
10316 they would in a native unix system.
10317 This option should be avoided if possible. It can cause confusion
10319 about responsibilities for a user or group. In many situations it
10320 is not clear whether winbind or /etc/passwd should be seen as
10321 authoritative for a user, likewise for groups.
10322 Default: winbind use default domain = no
10324 Example: winbind use default domain = yes
10326 winbind use krb5 enterprise principals (G)
10328 winbindd is able to get kerberos tickets for pam_winbind with
10330 krb5_auth or wbinfo -K/--krb5auth=.
10331 winbindd (at least on a domain member) is never be able to have a
10333 complete picture of the trust topology (which is managed by the
10334 DCs). There might be uPNSuffixes and msDS-SPNSuffixes values, which
10335 don't belong to any AD domain at all.
10336 With winbind scan trusted domains = no winbindd doesn't even get a
10338 complete picture of the topology.
10339 It is not really required to know about the trust topology. We can
10341 just rely on the [K]DCs of our primary domain (e.g.
10342 PRIMARY.A.EXAMPLE.COM) and use enterprise principals e.g.
10343 upnfromB@B.EXAMPLE.COM@PRIMARY.A.EXAMPLE.COM and follow the
10344 WRONG_REALM referrals in order to find the correct DC. The final
10345 principal might be userfromB@INTERNALB.EXAMPLE.PRIVATE.
10346 With winbind use krb5 enterprise principals = yes winbindd
10348 enterprise principals will be used.
10349 Default: winbind use krb5 enterprise principals = yes
10351 Example: winbind use krb5 enterprise principals = no
10353 winsdb:local_owner (G)
10355 This specifies the address that is stored in the winsOwner
10357 attribute, of locally registered winsRecord-objects. The default is
10358 to use the ip-address of the first network interface.
10359 No default
10361 winsdb:dbnosync (G)
10363 This parameter disables fsync() after changes of the WINS database.
10365 Default: winsdb:dbnosync = no
10367 wins hook (G)
10369 When Samba is running as a WINS server this allows you to call an
10371 external program for all changes to the WINS database. The primary
10372 use for this option is to allow the dynamic update of external name
10373 resolution databases such as dynamic DNS.
10374 The wins hook parameter specifies the name of a script or
10376 executable that will be called as follows:
10377 wins_hook operation name nametype ttl IP_list
10379 • The first argument is the operation and is one of "add",
10381 "delete", or "refresh". In most cases the operation can
10382 be ignored as the rest of the parameters provide
10383 sufficient information. Note that "refresh" may
10384 sometimes be called when the name has not previously
10385 been added, in that case it should be treated as an add.
10386 • The second argument is the NetBIOS name. If the name is
10388 not a legal name then the wins hook is not called. Legal
10389 names contain only letters, digits, hyphens, underscores
10390 and periods.
10391 • The third argument is the NetBIOS name type as a 2 digit
10393 hexadecimal number.
10394 • The fourth argument is the TTL (time to live) for the
10396 name in seconds.
10397 • The fifth and subsequent arguments are the IP addresses
10399 currently registered for that name. If this list is
10400 empty then the name should be deleted.
10401 An example script that calls the BIND dynamic DNS update program
10403 nsupdate is provided in the examples directory of the Samba source
10404 code.
10405 No default
10407 wins proxy (G)
10409 This is a boolean that controls if nmbd(8) will respond to
10411 broadcast name queries on behalf of other hosts. You may need to
10412 set this to yes for some older clients.
10413 Default: wins proxy = no
10415 wins server (G)
10417 This specifies the IP address (or DNS name: IP address for
10419 preference) of the WINS server that nmbd(8) should register with.
10420 If you have a WINS server on your network then you should set this
10421 to the WINS server's IP.
10422 You should point this at your WINS server if you have a
10424 multi-subnetted network.
10425 If you want to work in multiple namespaces, you can give every wins
10427 server a 'tag'. For each tag, only one (working) server will be
10428 queried for a name. The tag should be separated from the ip address
10429 by a colon.
10430 Note
10432 You need to set up Samba to point to a WINS server if you have
10433 multiple subnets and wish cross-subnet browsing to work
10434 correctly.
10435 See the chapter in the Samba3-HOWTO on Network Browsing.
10436 Default: wins server =
10438 Example: wins server = mary:192.9.200.1 fred:192.168.3.199
10440 mary:192.168.2.61 # For this example when querying a certain name,
10441 192.19.200.1 will be asked first and if that doesn't respond
10442 192.168.2.61. If either of those doesn't know the name
10443 192.168.3.199 will be queried.
10444 Example: wins server = 192.9.200.1 192.168.2.61
10446 wins support (G)
10448 This boolean controls if the nmbd(8) process in Samba will act as a
10450 WINS server. You should not set this to yes unless you have a
10451 multi-subnetted network and you wish a particular nmbd to be your
10452 WINS server. Note that you should NEVER set this to yes on more
10453 than one machine in your network.
10454 Default: wins support = no
10456 workgroup (G)
10458 This controls what workgroup your server will appear to be in when
10460 queried by clients. Note that this parameter also controls the
10461 Domain name used with the security = domain setting.
10462 Default: workgroup = WORKGROUP
10464 Example: workgroup = MYGROUP
10466 wreplsrv:periodic_interval (G)
10468 This maximum interval in seconds between 2 periodically scheduled
10470 runs where we check for wins.ldb changes and do push notifications
10471 to our push partners. Also wins_config.ldb changes are checked in
10472 that interval and partner configuration reloads are done.
10473 Default: wreplsrv:periodic_interval = 15
10475 wreplsrv:propagate name releases (G)
10477 If this parameter is enabled, then explicit (from the client) and
10479 implicit (via the scavenging) name releases are propagated to the
10480 other servers directly, even if there are still other addresses
10481 active, this applies to SPECIAL GROUP (2) and MULTIHOMED (3)
10482 entries. Also the replication conflict merge algorithm for SPECIAL
10483 GROUP (2) entries discards replica addresses where the address
10484 owner is the local server, if the address was not stored locally
10485 before. The merge result is propagated directly in case an address
10486 was discarded. A Windows servers doesn't propagate name releases of
10487 SPECIAL GROUP (2) and MULTIHOMED (3) entries directly, which means
10488 that Windows servers may return different results to name queries
10489 for SPECIAL GROUP (2) and MULTIHOMED (3) names. The option doesn't
10490 have much negative impact if Windows servers are around, but be
10491 aware that they might return unexpected results.
10492 Default: wreplsrv:propagate name releases = no
10494 wreplsrv:scavenging_interval (G)
10496 This is the interval in s between 2 scavenging runs which clean up
10498 the WINS database and changes the states of expired name records.
10499 Defaults to half of the value of wreplsrv:renew_interval.
10500 No default
10502 wreplsrv:tombstone_extra_timeout (G)
10504 This is the time in s the server needs to be up till we'll remove
10506 tombstone records from our database. Defaults to 3 days.
10507 Default: wreplsrv:tombstone_extra_timeout = 259200
10509 wreplsrv:tombstone_interval (G)
10511 This is the interval in s till released records of the WINS server
10513 become tombstone. Defaults to 6 days.
10514 Default: wreplsrv:tombstone_interval = 518400
10516 wreplsrv:tombstone_timeout (G)
10518 This is the interval in s till tombstone records are deleted from
10520 the WINS database. Defaults to 1 day.
10521 Default: wreplsrv:tombstone_timeout = 86400
10523 wreplsrv:verify_interval (G)
10525 This is the interval in s till we verify active replica records
10527 with the owning WINS server. Unfortunately not implemented yet.
10528 Defaults to 24 days.
10529 Default: wreplsrv:verify_interval = 2073600
10531 writable
10533 This parameter is a synonym for writeable.
10535 write ok
10537 This parameter is a synonym for writeable.
10539 writeable (S)
10541 Inverted synonym for read only.
10543 Default: writeable = no
10545 write list (S)
10547 This is a list of users that are given read-write access to a
10549 service. If the connecting user is in this list then they will be
10550 given write access, no matter what the read only option is set to.
10551 The list can include group names using the @group syntax.
10552 Note that if a user is in both the read list and the write list
10554 then they will be given write access.
10555 Default: write list =
10557 Example: write list = admin, root, @staff
10559 write raw (G)
10561 This is ignored if async smb echo handler is set, because this
10563 feature is incompatible with raw write SMB requests
10564 If enabled, raw writes allow writes of 65535 bytes in one packet.
10566 This typically provides a major performance benefit for some very,
10567 very old clients.
10568 However, some clients either negotiate the allowable block size
10570 incorrectly or are incapable of supporting larger block sizes, and
10571 for these clients you may need to disable raw writes.
10572 In general this parameter should be viewed as a system tuning tool
10574 and left severely alone.
10575 Default: write raw = yes
10577 wtmp directory (G)
10579 This parameter is only available if Samba has been configured and
10581 compiled with the option --with-utmp. It specifies a directory
10582 pathname that is used to store the wtmp or wtmpx files (depending
10583 on the UNIX system) that record user connections to a Samba server.
10584 The difference with the utmp directory is the fact that user info
10585 is kept after a user has logged out.
10586 By default this is not set, meaning the system will use whatever
10588 utmp file the native system is set to use (usually /var/run/wtmp on
10589 Linux).
10590 Default: wtmp directory =
10592 Example: wtmp directory = /var/log/wtmp
10594
10596 Although the configuration file permits service names to contain
10597 spaces, your client software may not. Spaces will be ignored in
10598 comparisons anyway, so it shouldn't be a problem - but be aware of the
10599 possibility.
10600 On a similar note, many clients - especially DOS clients - limit
10602 service names to eight characters. smbd(8) has no such limitation, but
10603 attempts to connect from such clients will fail if they truncate the
10604 service names. For this reason you should probably keep your service
10605 names down to eight characters in length.
10606 Use of the [homes] and [printers] special sections make life for an
10608 administrator easy, but the various combinations of default attributes
10609 can be tricky. Take extreme care when designing these sections. In
10610 particular, ensure that the permissions on spool directories are
10611 correct.
10612
10614 This man page is part of version 4.15.2 of the Samba suite.
10615
10617 samba(7), smbpasswd(8), smbd(8), nmbd(8), winbindd(8), samba(8), samba-
10618 tool(8), smbclient(1), nmblookup(1), testparm(1).
10619
10621 The original Samba software and related utilities were created by
10622 Andrew Tridgell. Samba is now developed by the Samba Team as an Open
10623 Source project similar to the way the Linux kernel is developed.
10624Samba 4.15.2 11/13/2021 SMB.CONF(5)