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 SMB2_22, SMB2_24, SMB3_00, SMB3_02, SMB3_10, 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 the name of your NIS home directory server. This is obtained from
432 your NIS auto.map entry. If you have not compiled Samba with the
433 --with-automount option, this value will be the same as %L.
434 %p
436 the path of the service's home directory, obtained from your NIS
437 auto.map entry. The NIS auto.map entry is split up as %N:%p.
438 There are some quite creative things that can be done with these
440 substitutions and other smb.conf options.
441
443 Samba supports name mangling so that DOS and Windows clients can use
444 files that don't conform to the 8.3 format. It can also be set to
445 adjust the case of 8.3 format filenames.
446 There are several options that control the way mangling is performed,
448 and they are grouped here rather than listed separately. For the
449 defaults look at the output of the testparm program.
450 These options can be set separately for each service.
452 The options are:
454 case sensitive = yes/no/auto
456 controls whether filenames are case sensitive. If they aren't,
457 Samba must do a filename search and match on passed names. The
458 default setting of auto allows clients that support case sensitive
459 filenames (Linux CIFSVFS and smbclient 3.0.5 and above currently)
460 to tell the Samba server on a per-packet basis that they wish to
461 access the file system in a case-sensitive manner (to support UNIX
462 case sensitive semantics). No Windows or DOS system supports
463 case-sensitive filename so setting this option to auto is that same
464 as setting it to no for them. Default auto.
465 default case = upper/lower
467 controls what the default case is for new filenames (ie. files that
468 don't currently exist in the filesystem). Default lower. IMPORTANT
469 NOTE: As part of the optimizations for directories containing large
470 numbers of files, the following special case applies. If the
471 options case sensitive = yes, preserve case = No, and short
472 preserve case = No are set, then the case of all incoming client
473 filenames, not just new filenames, will be modified. See additional
474 notes below.
475 preserve case = yes/no
477 controls whether new files (ie. files that don't currently exist in
478 the filesystem) are created with the case that the client passes,
479 or if they are forced to be the default case. Default yes.
480 short preserve case = yes/no
482 controls if new files (ie. files that don't currently exist in the
483 filesystem) which conform to 8.3 syntax, that is all in upper case
484 and of suitable length, are created upper case, or if they are
485 forced to be the default case. This option can be used with
486 preserve case = yes to permit long filenames to retain their case,
487 while short names are lowercased. Default yes.
488 By default, Samba 3.0 has the same semantics as a Windows NT server, in
490 that it is case insensitive but case preserving. As a special case for
491 directories with large numbers of files, if the case options are set as
492 follows, "case sensitive = yes", "case preserve = no", "short preserve
493 case = no" then the "default case" option will be applied and will
494 modify all filenames sent from the client when accessing this share.
495
497 Starting with Samba version 3.2.0, the capability to store Samba
498 configuration in the registry is available. The configuration is stored
499 in the registry key HKLM\Software\Samba\smbconf. There are two levels
500 of registry configuration:
501 1. Share definitions stored in registry are used. This is
503 triggered by setting the global parameter registry shares to
504 “yes” in smb.conf.
505 The registry shares are loaded not at startup but on demand
507 at runtime by smbd. Shares defined in smb.conf take priority
508 over shares of the same name defined in registry.
509 2. Global smb.conf options stored in registry are used. This
511 can be activated in two different ways:
512 Firstly, a registry only configuration is triggered by
514 setting config backend = registry in the [global] section of
515 smb.conf. This resets everything that has been read from
516 config files to this point and reads the content of the
517 global configuration section from the registry. This is the
518 recommended method of using registry based configuration.
519 Secondly, a mixed configuration can be activated by a
521 special new meaning of the parameter include = registry in
522 the [global] section of smb.conf. This reads the global
523 options from registry with the same priorities as for an
524 include of a text file. This may be especially useful in
525 cases where an initial configuration is needed to access the
526 registry.
527 Activation of global registry options automatically
529 activates registry shares. So in the registry only case,
530 shares are loaded on demand only.
531 Note: To make registry-based configurations foolproof at least to a
534 certain extent, the use of lock directory and config backend inside the
535 registry configuration has been disabled: Especially by changing the
536 lock directory inside the registry configuration, one would create a
537 broken setup where the daemons do not see the configuration they loaded
538 once it is active.
539 The registry configuration can be accessed with tools like regedit or
541 net (rpc) registry in the key HKLM\Software\Samba\smbconf. More
542 conveniently, the conf subcommand of the net(8) utility offers a
543 dedicated interface to read and write the registry based configuration
544 locally, i.e. directly accessing the database file, circumventing the
545 server.
546
548 In the SMB protocol, users, groups, and machines are represented by
549 their security identifiers (SIDs). On POSIX system Samba processes need
550 to run under corresponding POSIX user identities and with supplemental
551 POSIX groups to allow access to the files owned by those users and
552 groups. The process of mapping SIDs to POSIX users and groups is called
553 IDENTITY MAPPING or, in short, ID MAPPING.
554 Samba supports multiple ways to map SIDs to POSIX users and groups. The
556 configuration is driven by the idmap config DOMAIN : OPTION option
557 which allows one to specify identity mapping (idmap) options for each
558 domain separately.
559 Identity mapping modules implement different strategies for mapping of
561 SIDs to POSIX user and group identities. They are applicable to
562 different use cases and scenarios. It is advised to read the
563 documentation of the individual identity mapping modules before
564 choosing a specific scenario to use. Each identity management module is
565 documented in a separate manual page. The standard idmap backends are
566 tdb (idmap_tdb(8)), tdb2 (idmap_tdb2(8)), ldap (idmap_ldap(8)), rid
567 (idmap_rid(8)), hash (idmap_hash(8)), autorid (idmap_autorid(8)), ad
568 (idmap_ad(8)), nss (idmap_nss(8)), and rfc2307 (idmap_rfc2307(8)).
569 Overall, ID mapping configuration should be decided carefully. Changes
571 to the already deployed ID mapping configuration may create the risk of
572 losing access to the data or disclosing the data to the wrong parties.
573 This example shows how to configure two domains with idmap_rid(8), the
575 principal domain and a trusted domain, leaving the default id mapping
576 scheme at tdb.
577 [global]
579 security = domain
580 workgroup = MAIN
581 idmap config * : backend = tdb
583 idmap config * : range = 1000000-1999999
584 idmap config MAIN : backend = rid
586 idmap config MAIN : range = 5000000-5999999
587 idmap config TRUSTED : backend = rid
589 idmap config TRUSTED : range = 6000000-6999999
590
593 abort shutdown script (G)
594 This a full path name to a script called by smbd(8) that should
596 stop a shutdown procedure issued by the shutdown script.
597 If the connected user possesses the SeRemoteShutdownPrivilege,
599 right, this command will be run as root.
600 Default: abort shutdown script = ""
602 Example: abort shutdown script = /sbin/shutdown -c
604 access based share enum (S)
606 If this parameter is yes for a service, then the share hosted by
608 the service will only be visible to users who have read or write
609 access to the share during share enumeration (for example net view
610 \\sambaserver). The share ACLs which allow or deny the access to
611 the share can be modified using for example the sharesec command or
612 using the appropriate Windows tools. This has parallels to access
613 based enumeration, the main difference being that only share
614 permissions are evaluated, and security descriptors on files
615 contained on the share are not used in computing enumeration access
616 rights.
617 Default: access based share enum = no
619 acl allow execute always (S)
621 This boolean parameter controls the behaviour of smbd(8) when
623 receiving a protocol request of "open for execution" from a Windows
624 client. With Samba 3.6 and older, the execution right in the ACL
625 was not checked, so a client could execute a file even if it did
626 not have execute rights on the file. In Samba 4.0, this has been
627 fixed, so that by default, i.e. when this parameter is set to
628 "False", "open for execution" is now denied when execution
629 permissions are not present.
630 If this parameter is set to "True", Samba does not check execute
632 permissions on "open for execution", thus re-establishing the
633 behaviour of Samba 3.6. This can be useful to smoothen upgrades
634 from older Samba versions to 4.0 and newer. This setting is not
635 meant to be used as a permanent setting, but as a temporary relief:
636 It is recommended to fix the permissions in the ACLs and reset this
637 parameter to the default after a certain transition period.
638 Default: acl allow execute always = no
640 acl check permissions (S)
642 Please note this parameter is now deprecated in Samba 3.6.2 and
644 will be removed in a future version of Samba.
645 This boolean parameter controls what smbd(8) does on receiving a
647 protocol request of "open for delete" from a Windows client. If a
648 Windows client doesn't have permissions to delete a file then they
649 expect this to be denied at open time. POSIX systems normally only
650 detect restrictions on delete by actually attempting to delete the
651 file or directory. As Windows clients can (and do) "back out" a
652 delete request by unsetting the "delete on close" bit Samba cannot
653 delete the file immediately on "open for delete" request as we
654 cannot restore such a deleted file. With this parameter set to true
655 (the default) then smbd checks the file system permissions directly
656 on "open for delete" and denies the request without actually
657 deleting the file if the file system permissions would seem to deny
658 it. This is not perfect, as it's possible a user could have deleted
659 a file without Samba being able to check the permissions correctly,
660 but it is close enough to Windows semantics for mostly correct
661 behaviour. Samba will correctly check POSIX ACL semantics in this
662 case.
663 If this parameter is set to "false" Samba doesn't check permissions
665 on "open for delete" and allows the open. If the user doesn't have
666 permission to delete the file this will only be discovered at close
667 time, which is too late for the Windows user tools to display an
668 error message to the user. The symptom of this is files that appear
669 to have been deleted "magically" re-appearing on a Windows explorer
670 refresh. This is an extremely advanced protocol option which should
671 not need to be changed. This parameter was introduced in its final
672 form in 3.0.21, an earlier version with slightly different
673 semantics was introduced in 3.0.20. That older version is not
674 documented here.
675 Default: acl check permissions = yes
677 acl group control (S)
679 In a POSIX filesystem, only the owner of a file or directory and
681 the superuser can modify the permissions and ACLs on a file. If
682 this parameter is set, then Samba overrides this restriction, and
683 also allows the primary group owner of a file or directory to
684 modify the permissions and ACLs on that file.
685 On a Windows server, groups may be the owner of a file or directory
687 - thus allowing anyone in that group to modify the permissions on
688 it. This allows the delegation of security controls on a point in
689 the filesystem to the group owner of a directory and anything below
690 it also owned by that group. This means there are multiple people
691 with permissions to modify ACLs on a file or directory, easing
692 manageability.
693 This parameter allows Samba to also permit delegation of the
695 control over a point in the exported directory hierarchy in much
696 the same way as Windows. This allows all members of a UNIX group to
697 control the permissions on a file or directory they have group
698 ownership on.
699 This parameter is best used with the inherit owner option and also
701 on a share containing directories with the UNIX setgid bit set on
702 them, which causes new files and directories created within it to
703 inherit the group ownership from the containing directory.
704 This parameter was deprecated in Samba 3.0.23, but re-activated in
706 Samba 3.0.31 and above, as it now only controls permission changes
707 if the user is in the owning primary group. It is now no longer
708 equivalent to the dos filemode option.
709 Default: acl group control = no
711 acl map full control (S)
713 This boolean parameter controls whether smbd(8) maps a POSIX ACE
715 entry of "rwx" (read/write/execute), the maximum allowed POSIX
716 permission set, into a Windows ACL of "FULL CONTROL". If this
717 parameter is set to true any POSIX ACE entry of "rwx" will be
718 returned in a Windows ACL as "FULL CONTROL", is this parameter is
719 set to false any POSIX ACE entry of "rwx" will be returned as the
720 specific Windows ACL bits representing read, write and execute.
721 Default: acl map full control = yes
723 add group script (G)
725 This is the full pathname to a script that will be run AS ROOT by
727 smbd(8) when a new group is requested. It will expand any %g to the
728 group name passed. This script is only useful for installations
729 using the Windows NT domain administration tools. The script is
730 free to create a group with an arbitrary name to circumvent unix
731 group name restrictions. In that case the script must print the
732 numeric gid of the created group on stdout.
733 Default: add group script =
735 Example: add group script = /usr/sbin/groupadd %g
737 additional dns hostnames (G)
739 A list of additional DNS names by which this host can be identified
741 Default: additional dns hostnames = # empty string (no additional
743 dns names)
744 Example: additional dns hostnames = host2.example.com
746 host3.other.com
747 add machine script (G)
749 This is the full pathname to a script that will be run by smbd(8)
751 when a machine is added to Samba's domain and a Unix account
752 matching the machine's name appended with a "$" does not already
753 exist.
754 This option is very similar to the add user script, and likewise
756 uses the %u substitution for the account name. Do not use the %m
757 substitution.
758 Default: add machine script =
760 Example: add machine script = /usr/sbin/adduser -n -g machines -c
762 Machine -d /var/lib/nobody -s /bin/false %u
763 addport command (G)
765 Samba 3.0.23 introduced support for adding printer ports remotely
767 using the Windows "Add Standard TCP/IP Port Wizard". This option
768 defines an external program to be executed when smbd receives a
769 request to add a new Port to the system. The script is passed two
770 parameters:
771 • port name
773 • device URI
775 The deviceURI is in the format of
777 socket://<hostname>[:<portnumber>] or lpd://<hostname>/<queuename>.
778 Default: addport command =
780 Example: addport command = /etc/samba/scripts/addport.sh
782 addprinter command (G)
784 With the introduction of MS-RPC based printing support for Windows
786 NT/2000 clients in Samba 2.2, The MS Add Printer Wizard (APW) icon
787 is now also available in the "Printers..." folder displayed a share
788 listing. The APW allows for printers to be add remotely to a Samba
789 or Windows NT/2000 print server.
790 For a Samba host this means that the printer must be physically
792 added to the underlying printing system. The addprinter command
793 defines a script to be run which will perform the necessary
794 operations for adding the printer to the print system and to add
795 the appropriate service definition to the smb.conf file in order
796 that it can be shared by smbd(8).
797 The addprinter command is automatically invoked with the following
799 parameter (in order):
800 • printer name
802 • share name
804 • port name
806 • driver name
808 • location
810 • Windows 9x driver location
812 All parameters are filled in from the PRINTER_INFO_2 structure sent
814 by the Windows NT/2000 client with one exception. The "Windows 9x
815 driver location" parameter is included for backwards compatibility
816 only. The remaining fields in the structure are generated from
817 answers to the APW questions.
818 Once the addprinter command has been executed, smbd will reparse
820 the smb.conf to determine if the share defined by the APW exists.
821 If the sharename is still invalid, then smbd will return an
822 ACCESS_DENIED error to the client.
823 The addprinter command program can output a single line of text,
825 which Samba will set as the port the new printer is connected to.
826 If this line isn't output, Samba won't reload its printer shares.
827 Default: addprinter command =
829 Example: addprinter command = /usr/bin/addprinter
831 add share command (G)
833 Samba 2.2.0 introduced the ability to dynamically add and delete
835 shares via the Windows NT 4.0 Server Manager. The add share command
836 is used to define an external program or script which will add a
837 new service definition to smb.conf.
838 In order to successfully execute the add share command, smbd
840 requires that the administrator connects using a root account (i.e.
841 uid == 0) or has the SeDiskOperatorPrivilege. Scripts defined in
842 the add share command parameter are executed as root.
843 When executed, smbd will automatically invoke the add share command
845 with five parameters.
846 • configFile - the location of the global smb.conf file.
848 • shareName - the name of the new share.
850 • pathName - path to an **existing** directory on disk.
852 • comment - comment string to associate with the new
854 share.
855 • max connections Number of maximum simultaneous
857 connections to this share.
858 This parameter is only used to add file shares. To add printer
860 shares, see the addprinter command.
861 Default: add share command =
863 Example: add share command = /usr/local/bin/addshare
865 add user script (G)
867 This is the full pathname to a script that will be run AS ROOT by
869 smbd(8) under special circumstances described below.
870 Normally, a Samba server requires that UNIX users are created for
872 all users accessing files on this server. For sites that use
873 Windows NT account databases as their primary user database
874 creating these users and keeping the user list in sync with the
875 Windows NT PDC is an onerous task. This option allows smbd to
876 create the required UNIX users ON DEMAND when a user accesses the
877 Samba server.
878 When the Windows user attempts to access the Samba server, at login
880 (session setup in the SMB protocol) time, smbd(8) contacts the
881 password server and attempts to authenticate the given user with
882 the given password. If the authentication succeeds then smbd
883 attempts to find a UNIX user in the UNIX password database to map
884 the Windows user into. If this lookup fails, and add user script is
885 set then smbd will call the specified script AS ROOT, expanding any
886 %u argument to be the user name to create.
887 If this script successfully creates the user then smbd will
889 continue on as though the UNIX user already existed. In this way,
890 UNIX users are dynamically created to match existing Windows NT
891 accounts.
892 See also security, password server, delete user script.
894 Default: add user script =
896 Example: add user script = /usr/local/samba/bin/add_user %u
898 add user to group script (G)
900 Full path to the script that will be called when a user is added to
902 a group using the Windows NT domain administration tools. It will
903 be run by smbd(8) AS ROOT. Any %g will be replaced with the group
904 name and any %u will be replaced with the user name.
905 Note that the adduser command used in the example below does not
907 support the used syntax on all systems.
908 Default: add user to group script =
910 Example: add user to group script = /usr/sbin/adduser %u %g
912 administrative share (S)
914 If this parameter is set to yes for a share, then the share will be
916 an administrative share. The Administrative Shares are the default
917 network shares created by all Windows NT-based operating systems.
918 These are shares like C$, D$ or ADMIN$. The type of these shares is
919 STYPE_DISKTREE_HIDDEN.
920 See the section below on security for more information about this
922 option.
923 Default: administrative share = no
925 admin users (S)
927 This is a list of users who will be granted administrative
929 privileges on the share. This means that they will do all file
930 operations as the super-user (root).
931 You should use this option very carefully, as any user in this list
933 will be able to do anything they like on the share, irrespective of
934 file permissions.
935 Default: admin users =
937 Example: admin users = jason
939 afs share (S)
941 This parameter controls whether special AFS features are enabled
943 for this share. If enabled, it assumes that the directory exported
944 via the path parameter is a local AFS import. The special AFS
945 features include the attempt to hand-craft an AFS token if you
946 enabled --with-fake-kaserver in configure.
947 Default: afs share = no
949 afs token lifetime (G)
951 This parameter controls the lifetime of tokens that the AFS
953 fake-kaserver claims. In reality these never expire but this
954 lifetime controls when the afs client will forget the token.
955 Set this parameter to 0 to get NEVERDATE.
957 Default: afs token lifetime = 604800
959 afs username map (G)
961 If you are using the fake kaserver AFS feature, you might want to
963 hand-craft the usernames you are creating tokens for. For example
964 this is necessary if you have users from several domain in your AFS
965 Protection Database. One possible scheme to code users as
966 DOMAIN+User as it is done by winbind with the + as a separator.
967 The mapped user name must contain the cell name to log into, so
969 without setting this parameter there will be no token.
970 Default: afs username map =
972 Example: afs username map = %u@afs.samba.org
974 aio max threads (G)
976 The integer parameter specifies the maximum number of threads each
978 smbd process will create when doing parallel asynchronous IO calls.
979 If the number of outstanding calls is greater than this number the
980 requests will not be refused but go onto a queue and will be
981 scheduled in turn as outstanding requests complete.
982 Related command: aio read size
984 Related command: aio write size
986 Default: aio max threads = 100
988 aio read size (S)
990 If this integer parameter is set to a non-zero value, Samba will
992 read from files asynchronously when the request size is bigger than
993 this value. Note that it happens only for non-chained and
994 non-chaining reads and when not using write cache.
995 The only reasonable values for this parameter are 0 (no async I/O)
997 and 1 (always do async I/O).
998 Related command: write cache size
1000 Related command: aio write size
1002 Default: aio read size = 1
1004 Example: aio read size = 0 # Always do reads synchronously
1006 aio write behind (S)
1008 If Samba has been built with asynchronous I/O support, Samba will
1010 not wait until write requests are finished before returning the
1011 result to the client for files listed in this parameter. Instead,
1012 Samba will immediately return that the write request has been
1013 finished successfully, no matter if the operation will succeed or
1014 not. This might speed up clients without aio support, but is really
1015 dangerous, because data could be lost and files could be damaged.
1016 The syntax is identical to the veto files parameter.
1018 Default: aio write behind =
1020 Example: aio write behind = /*.tmp/
1022 aio write size (S)
1024 If this integer parameter is set to a non-zero value, Samba will
1026 write to files asynchronously when the request size is bigger than
1027 this value. Note that it happens only for non-chained and
1028 non-chaining reads and when not using write cache.
1029 The only reasonable values for this parameter are 0 (no async I/O)
1031 and 1 (always do async I/O).
1032 Compared to aio read size this parameter has a smaller effect, most
1034 writes should end up in the file system cache. Writes that require
1035 space allocation might benefit most from going asynchronous.
1036 Related command: write cache size
1038 Related command: aio read size
1040 Default: aio write size = 1
1042 Example: aio write size = 0 # Always do writes synchronously
1044 algorithmic rid base (G)
1046 This determines how Samba will use its algorithmic mapping from
1048 uids/gid to the RIDs needed to construct NT Security Identifiers.
1049 Setting this option to a larger value could be useful to sites
1051 transitioning from WinNT and Win2k, as existing user and group rids
1052 would otherwise clash with system users etc.
1053 All UIDs and GIDs must be able to be resolved into SIDs for the
1055 correct operation of ACLs on the server. As such the algorithmic
1056 mapping can't be 'turned off', but pushing it 'out of the way'
1057 should resolve the issues. Users and groups can then be assigned
1058 'low' RIDs in arbitrary-rid supporting backends.
1059 Default: algorithmic rid base = 1000
1061 Example: algorithmic rid base = 100000
1063 allocation roundup size (S)
1065 This parameter allows an administrator to tune the allocation size
1067 reported to Windows clients. This is only useful for old SMB1
1068 clients because modern SMB dialects eliminated that bottleneck and
1069 have better performance by default. Using this parameter may cause
1070 difficulties for some applications, e.g. MS Visual Studio. If the
1071 MS Visual Studio compiler starts to crash with an internal error,
1072 set this parameter to zero for this share. Settings this parameter
1073 to a large value can also cause small files to allocate more space
1074 on the disk than needed.
1075 This parameter is deprecated and will be removed in one of the next
1077 Samba releases.
1078 The integer parameter specifies the roundup size in bytes.
1080 Default: allocation roundup size = 0
1082 Example: allocation roundup size = 1048576 # (to set it to the
1084 former default of 1 MiB)
1085 allow dcerpc auth level connect (G)
1087 This option controls whether DCERPC services are allowed to be used
1089 with DCERPC_AUTH_LEVEL_CONNECT, which provides authentication, but
1090 no per message integrity nor privacy protection.
1091 Some interfaces like samr, lsarpc and netlogon have a hard-coded
1093 default of no and epmapper, mgmt and rpcecho have a hard-coded
1094 default of yes.
1095 The behavior can be overwritten per interface name (e.g. lsarpc,
1097 netlogon, samr, srvsvc, winreg, wkssvc ...) by using 'allow dcerpc
1098 auth level connect:interface = yes' as option.
1099 This option yields precedence to the implementation specific
1101 restrictions. E.g. the drsuapi and backupkey protocols require
1102 DCERPC_AUTH_LEVEL_PRIVACY. The dnsserver protocol requires
1103 DCERPC_AUTH_LEVEL_INTEGRITY.
1104 Default: allow dcerpc auth level connect = no
1106 Example: allow dcerpc auth level connect = yes
1108 allow dns updates (G)
1110 This option determines what kind of updates to the DNS are allowed.
1112 DNS updates can either be disallowed completely by setting it to
1114 disabled, enabled over secure connections only by setting it to
1115 secure only or allowed in all cases by setting it to nonsecure.
1116 Default: allow dns updates = secure only
1118 Example: allow dns updates = disabled
1120 allow insecure wide links (G)
1122 In normal operation the option wide links which allows the server
1124 to follow symlinks outside of a share path is automatically
1125 disabled when unix extensions are enabled on a Samba server. This
1126 is done for security purposes to prevent UNIX clients creating
1127 symlinks to areas of the server file system that the administrator
1128 does not wish to export.
1129 Setting allow insecure wide links to true disables the link between
1131 these two parameters, removing this protection and allowing a site
1132 to configure the server to follow symlinks (by setting wide links
1133 to "true") even when unix extensions is turned on.
1134 It is not recommended to enable this option unless you fully
1136 understand the implications of allowing the server to follow
1137 symbolic links created by UNIX clients. For most normal Samba
1138 configurations this would be considered a security hole and setting
1139 this parameter is not recommended.
1140 This option was added at the request of sites who had deliberately
1142 set Samba up in this way and needed to continue supporting this
1143 functionality without having to patch the Samba code.
1144 Default: allow insecure wide links = no
1146 allow nt4 crypto (G)
1148 This option controls whether the netlogon server (currently only in
1150 'active directory domain controller' mode), will reject clients
1151 which does not support NETLOGON_NEG_STRONG_KEYS nor
1152 NETLOGON_NEG_SUPPORTS_AES.
1153 This option was added with Samba 4.2.0. It may lock out clients
1155 which worked fine with Samba versions up to 4.1.x. as the effective
1156 default was "yes" there, while it is "no" now.
1157 If you have clients without RequireStrongKey = 1 in the registry,
1159 you may need to set "allow nt4 crypto = yes", until you have fixed
1160 all clients.
1161 "allow nt4 crypto = yes" allows weak crypto to be negotiated, maybe
1163 via downgrade attacks.
1164 This option yields precedence to the 'reject md5 clients' option.
1166 Default: allow nt4 crypto = no
1168 allow trusted domains (G)
1170 This option only takes effect when the security option is set to
1172 server, domain or ads. If it is set to no, then attempts to connect
1173 to a resource from a domain or workgroup other than the one which
1174 smbd is running in will fail, even if that domain is trusted by the
1175 remote server doing the authentication.
1176 This is useful if you only want your Samba server to serve
1178 resources to users in the domain it is a member of. As an example,
1179 suppose that there are two domains DOMA and DOMB. DOMB is trusted
1180 by DOMA, which contains the Samba server. Under normal
1181 circumstances, a user with an account in DOMB can then access the
1182 resources of a UNIX account with the same account name on the Samba
1183 server even if they do not have an account in DOMA. This can make
1184 implementing a security boundary difficult.
1185 Default: allow trusted domains = yes
1187 allow unsafe cluster upgrade (G)
1189 If set to no (the default), smbd checks at startup if other smbd
1191 versions are running in the cluster and refuses to start if so.
1192 This is done to protect data corruption in internal data structures
1193 due to incompatible Samba versions running concurrently in the same
1194 cluster. Setting this parameter to yes disables this safety check.
1195 Default: allow unsafe cluster upgrade = no
1197 apply group policies (G)
1199 This option controls whether winbind will execute the gpupdate
1201 command defined in gpo update command on the Group Policy update
1202 interval. The Group Policy update interval is defined as every 90
1203 minutes, plus a random offset between 0 and 30 minutes. This
1204 applies Group Policy Machine polices to the client or KDC and
1205 machine policies to a server.
1206 Default: apply group policies = no
1208 Example: apply group policies = yes
1210 async dns timeout (G)
1212 The number of seconds the asynchronous DNS resolver code in Samba
1214 will wait for responses. Some of the Samba client library code uses
1215 internal asynchronous DNS resolution for A and AAAA records when
1216 trying to find Active Directory Domain controllers. This value
1217 prevents this name resolution code from waiting for DNS server
1218 timeouts.
1219 The minimum value of this parameter is clamped at 1 second.
1221 Default: async dns timeout = 10
1223 Example: async dns timeout = 20
1225 async smb echo handler (G)
1227 This parameter specifies whether Samba should fork the async smb
1229 echo handler. It can be beneficial if your file system can block
1230 syscalls for a very long time. In some circumstances, it prolongs
1231 the timeout that Windows uses to determine whether a connection is
1232 dead. This parameter is only for SMB1. For SMB2 and above TCP
1233 keepalives can be used instead.
1234 Default: async smb echo handler = no
1236 auth event notification (G)
1238 When enabled, this option causes Samba (acting as an Active
1240 Directory Domain Controller) to stream authentication events across
1241 the internal message bus. Scripts built using Samba's python
1242 bindings can listen to these events by registering as the service
1243 auth_event.
1244 This is not needed for the audit logging described in log level.
1246 Instead, this should instead be considered a developer option (it
1248 assists in the Samba testsuite) rather than a facility for external
1249 auditing, as message delivery is not guaranteed (a feature that the
1250 testsuite works around).
1251 The authentication events are also logged via the normal logging
1253 methods when the log level is set appropriately, say to
1254 auth_json_audit:3.
1255 Default: auth event notification = no
1257 preload
1259 This parameter is a synonym for auto services.
1261 auto services (G)
1263 This is a list of services that you want to be automatically added
1265 to the browse lists. This is most useful for homes and printers
1266 services that would otherwise not be visible.
1267 Note that if you just want all printers in your printcap file
1269 loaded then the load printers option is easier.
1270 Default: auto services =
1272 Example: auto services = fred lp colorlp
1274 available (S)
1276 This parameter lets you "turn off" a service. If available = no,
1278 then ALL attempts to connect to the service will fail. Such
1279 failures are logged.
1280 Default: available = yes
1282 bind dns directory
1284 This parameter is a synonym for binddns dir.
1286 binddns dir (G)
1288 This parameters defines the directory samba will use to store the
1290 configuration files for bind, such as named.conf. NOTE: The bind
1291 dns directory needs to be on the same mount point as the private
1292 directory!
1293 Default: binddns dir = /var/lib/samba/bind-dns
1295 bind interfaces only (G)
1297 This global parameter allows the Samba admin to limit what
1299 interfaces on a machine will serve SMB requests. It affects file
1300 service smbd(8) and name service nmbd(8) in a slightly different
1301 ways.
1302 For name service it causes nmbd to bind to ports 137 and 138 on the
1304 interfaces listed in the interfaces parameter. nmbd also binds to
1305 the "all addresses" interface (0.0.0.0) on ports 137 and 138 for
1306 the purposes of reading broadcast messages. If this option is not
1307 set then nmbd will service name requests on all of these sockets.
1308 If bind interfaces only is set then nmbd will check the source
1309 address of any packets coming in on the broadcast sockets and
1310 discard any that don't match the broadcast addresses of the
1311 interfaces in the interfaces parameter list. As unicast packets are
1312 received on the other sockets it allows nmbd to refuse to serve
1313 names to machines that send packets that arrive through any
1314 interfaces not listed in the interfaces list. IP Source address
1315 spoofing does defeat this simple check, however, so it must not be
1316 used seriously as a security feature for nmbd.
1317 For file service it causes smbd(8) to bind only to the interface
1319 list given in the interfaces parameter. This restricts the networks
1320 that smbd will serve, to packets coming in on those interfaces.
1321 Note that you should not use this parameter for machines that are
1322 serving PPP or other intermittent or non-broadcast network
1323 interfaces as it will not cope with non-permanent interfaces.
1324 If bind interfaces only is set and the network address 127.0.0.1 is
1326 not added to the interfaces parameter list smbpasswd(8) may not
1327 work as expected due to the reasons covered below.
1328 To change a users SMB password, the smbpasswd by default connects
1330 to the localhost - 127.0.0.1 address as an SMB client to issue the
1331 password change request. If bind interfaces only is set then unless
1332 the network address 127.0.0.1 is added to the interfaces parameter
1333 list then smbpasswd will fail to connect in it's default mode.
1334 smbpasswd can be forced to use the primary IP interface of the
1335 local host by using its smbpasswd(8) -r remote machine parameter,
1336 with remote machine set to the IP name of the primary interface of
1337 the local host.
1338 Default: bind interfaces only = no
1340 blocking locks (S)
1342 This parameter controls the behavior of smbd(8) when given a
1344 request by a client to obtain a byte range lock on a region of an
1345 open file, and the request has a time limit associated with it.
1346 If this parameter is set and the lock range requested cannot be
1348 immediately satisfied, samba will internally queue the lock
1349 request, and periodically attempt to obtain the lock until the
1350 timeout period expires.
1351 If this parameter is set to no, then samba will behave as previous
1353 versions of Samba would and will fail the lock request immediately
1354 if the lock range cannot be obtained.
1355 Default: blocking locks = yes
1357 block size (S)
1359 This parameter controls the behavior of smbd(8) when reporting disk
1361 free sizes. By default, this reports a disk block size of 1024
1362 bytes.
1363 Changing this parameter may have some effect on the efficiency of
1365 client writes, this is not yet confirmed. This parameter was added
1366 to allow advanced administrators to change it (usually to a higher
1367 value) and test the effect it has on client write performance
1368 without re-compiling the code. As this is an experimental option it
1369 may be removed in a future release.
1370 Changing this option does not change the disk free reporting size,
1372 just the block size unit reported to the client.
1373 Default: block size = 1024
1375 Example: block size = 4096
1377 browsable
1379 This parameter is a synonym for browseable.
1381 browseable (S)
1383 This controls whether this share is seen in the list of available
1385 shares in a net view and in the browse list.
1386 Default: browseable = yes
1388 browse list (G)
1390 This controls whether smbd(8) will serve a browse list to a client
1392 doing a NetServerEnum call. Normally set to yes. You should never
1393 need to change this.
1394 Default: browse list = yes
1396 cache directory (G)
1398 Usually, most of the TDB files are stored in the lock directory.
1400 Since Samba 3.4.0, it is possible to differentiate between TDB
1401 files with persistent data and TDB files with non-persistent data
1402 using the state directory and the cache directory options.
1403 This option specifies the directory for storing TDB files
1405 containing non-persistent data that will be kept across service
1406 restarts. The directory should be placed on persistent storage, but
1407 the data can be safely deleted by an administrator.
1408 Default: cache directory = /var/lib/samba
1410 Example: cache directory = /var/run/samba/locks/cache
1412 casesignames
1414 This parameter is a synonym for case sensitive.
1416 case sensitive (S)
1418 See the discussion in the section name mangling.
1420 Default: case sensitive = auto
1422 change notify (G)
1424 This parameter specifies whether Samba should reply to a client's
1426 file change notify requests.
1427 You should never need to change this parameter
1429 Default: change notify = yes
1431 change share command (G)
1433 Samba 2.2.0 introduced the ability to dynamically add and delete
1435 shares via the Windows NT 4.0 Server Manager. The change share
1436 command is used to define an external program or script which will
1437 modify an existing service definition in smb.conf.
1438 In order to successfully execute the change share command, smbd
1440 requires that the administrator connects using a root account (i.e.
1441 uid == 0) or has the SeDiskOperatorPrivilege. Scripts defined in
1442 the change share command parameter are executed as root.
1443 When executed, smbd will automatically invoke the change share
1445 command with six parameters.
1446 • configFile - the location of the global smb.conf file.
1448 • shareName - the name of the new share.
1450 • pathName - path to an **existing** directory on disk.
1452 • comment - comment string to associate with the new
1454 share.
1455 • max connections Number of maximum simultaneous
1457 connections to this share.
1458 • CSC policy - client side caching policy in string form.
1460 Valid values are: manual, documents, programs, disable.
1461 This parameter is only used to modify existing file share
1463 definitions. To modify printer shares, use the "Printers..." folder
1464 as seen when browsing the Samba host.
1465 Default: change share command =
1467 Example: change share command = /usr/local/bin/changeshare
1469 check parent directory delete on close (S)
1471 A Windows SMB server prevents the client from creating files in a
1473 directory that has the delete-on-close flag set. By default Samba
1474 doesn't perform this check as this check is a quite expensive
1475 operation in Samba.
1476 Default: check parent directory delete on close = no
1478 check password script (G)
1480 The name of a program that can be used to check password
1482 complexity. The password is sent to the program's standard input.
1483 The program must return 0 on a good password, or any other value if
1485 the password is bad. In case the password is considered weak (the
1486 program does not return 0) the user will be notified and the
1487 password change will fail.
1488 In Samba AD, this script will be run AS ROOT by samba(8) without
1490 any substitutions.
1491 Note that starting with Samba 4.11 the following environment
1493 variables are exported to the script:
1494 • SAMBA_CPS_ACCOUNT_NAME is always present and contains
1496 the sAMAccountName of user, the is the same as the %u
1497 substitutions in the none AD DC case.
1498 • SAMBA_CPS_USER_PRINCIPAL_NAME is optional in the AD DC
1500 case if the userPrincipalName is present.
1501 • SAMBA_CPS_FULL_NAME is optional if the displayName is
1503 present.
1504 Note: In the example directory is a sample program called
1506 crackcheck that uses cracklib to check the password quality.
1507 Default: check password script = # Disabled
1509 Example: check password script = /usr/local/sbin/crackcheck
1511 cldap port (G)
1513 This option controls the port used by the CLDAP protocol.
1515 Default: cldap port = 389
1517 Example: cldap port = 3389
1519 client ipc max protocol (G)
1521 The value of the parameter (a string) is the highest protocol level
1523 that will be supported for IPC$ connections as DCERPC transport.
1524 Normally this option should not be set as the automatic negotiation
1526 phase in the SMB protocol takes care of choosing the appropriate
1527 protocol.
1528 The value default refers to the latest supported protocol,
1530 currently SMB3_11.
1531 See client max protocol for a full list of available protocols. The
1533 values CORE, COREPLUS, LANMAN1, LANMAN2 are silently upgraded to
1534 NT1.
1535 Default: client ipc max protocol = default
1537 Example: client ipc max protocol = SMB2_10
1539 client ipc min protocol (G)
1541 This setting controls the minimum protocol version that the will be
1543 attempted to use for IPC$ connections as DCERPC transport.
1544 Normally this option should not be set as the automatic negotiation
1546 phase in the SMB protocol takes care of choosing the appropriate
1547 protocol.
1548 The value default refers to the higher value of NT1 and the
1550 effective value of client min protocol.
1551 See client max protocol for a full list of available protocols. The
1553 values CORE, COREPLUS, LANMAN1, LANMAN2 are silently upgraded to
1554 NT1.
1555 Default: client ipc min protocol = default
1557 Example: client ipc min protocol = SMB3_11
1559 client ipc signing (G)
1561 This controls whether the client is allowed or required to use SMB
1563 signing for IPC$ connections as DCERPC transport. Possible values
1564 are auto, mandatory and disabled.
1565 When set to mandatory or default, SMB signing is required.
1567 When set to auto, SMB signing is offered, but not enforced and if
1569 set to disabled, SMB signing is not offered either.
1570 Connections from winbindd to Active Directory Domain Controllers
1572 always enforce signing.
1573 Default: client ipc signing = default
1575 client lanman auth (G)
1577 This parameter has been deprecated since Samba 4.13 and support for
1579 LanMan (as distinct from NTLM, NTLMv2 or Kerberos) authentication
1580 as a client will be removed in a future Samba release.
1581 That is, in the future, the current default of client NTLMv2 auth =
1583 yes will be the enforced behaviour.
1584 This parameter determines whether or not smbclient(8) and other
1586 samba client tools will attempt to authenticate itself to servers
1587 using the weaker LANMAN password hash. If disabled, only server
1588 which support NT password hashes (e.g. Windows NT/2000, Samba,
1589 etc... but not Windows 95/98) will be able to be connected from the
1590 Samba client.
1591 The LANMAN encrypted response is easily broken, due to its
1593 case-insensitive nature, and the choice of algorithm. Clients
1594 without Windows 95/98 servers are advised to disable this option.
1595 Disabling this option will also disable the client plaintext auth
1597 option.
1598 Likewise, if the client ntlmv2 auth parameter is enabled, then only
1600 NTLMv2 logins will be attempted.
1601 Default: client lanman auth = no
1603 client ldap sasl wrapping (G)
1605 The client ldap sasl wrapping defines whether ldap traffic will be
1607 signed or signed and encrypted (sealed). Possible values are plain,
1608 sign and seal.
1609 The values sign and seal are only available if Samba has been
1611 compiled against a modern OpenLDAP version (2.3.x or higher).
1612 This option is needed in the case of Domain Controllers enforcing
1614 the usage of signed LDAP connections (e.g. Windows 2000 SP3 or
1615 higher). LDAP sign and seal can be controlled with the registry key
1616 "HKLM\System\CurrentControlSet\Services\
1617 NTDS\Parameters\LDAPServerIntegrity" on the Windows server side.
1618 Depending on the used KRB5 library (MIT and older Heimdal versions)
1620 it is possible that the message "integrity only" is not supported.
1621 In this case, sign is just an alias for seal.
1622 The default value is sign. That implies synchronizing the time with
1624 the KDC in the case of using Kerberos.
1625 Default: client ldap sasl wrapping = sign
1627 client max protocol (G)
1629 The value of the parameter (a string) is the highest protocol level
1631 that will be supported by the client.
1632 Possible values are :
1634 • CORE: Earliest version. No concept of user names.
1636 • COREPLUS: Slight improvements on CORE for efficiency.
1638 • LANMAN1: First modern version of the protocol. Long
1640 filename support.
1641 • LANMAN2: Updates to Lanman1 protocol.
1643 • NT1: Current up to date version of the protocol. Used by
1645 Windows NT. Known as CIFS.
1646 • SMB2: Re-implementation of the SMB protocol. Used by
1648 Windows Vista and later versions of Windows. SMB2 has
1649 sub protocols available.
1650 • SMB2_02: The earliest SMB2 version.
1652 • SMB2_10: Windows 7 SMB2 version.
1654 • SMB2_22: Early Windows 8 SMB2 version.
1656 • SMB2_24: Windows 8 beta SMB2 version.
1658 By default SMB2 selects the SMB2_10 variant.
1660 • SMB3: The same as SMB2. Used by Windows 8. SMB3 has sub
1662 protocols available.
1663 • SMB3_00: Windows 8 SMB3 version. (mostly the
1665 same as SMB2_24)
1666 • SMB3_02: Windows 8.1 SMB3 version.
1668 • SMB3_10: early Windows 10 technical preview
1670 SMB3 version.
1671 • SMB3_11: Windows 10 technical preview SMB3
1673 version (maybe final).
1674 By default SMB3 selects the SMB3_11 variant.
1676 Normally this option should not be set as the automatic negotiation
1678 phase in the SMB protocol takes care of choosing the appropriate
1679 protocol.
1680 The value default refers to SMB3_11.
1682 IPC$ connections for DCERPC e.g. in winbindd, are handled by the
1684 client ipc max protocol option.
1685 Default: client max protocol = default
1687 Example: client max protocol = LANMAN1
1689 client min protocol (G)
1691 This setting controls the minimum protocol version that the client
1693 will attempt to use.
1694 Normally this option should not be set as the automatic negotiation
1696 phase in the SMB protocol takes care of choosing the appropriate
1697 protocol unless you connect to a legacy SMB1-only server.
1698 See Related command: client max protocol for a full list of
1700 available protocols.
1701 IPC$ connections for DCERPC e.g. in winbindd, are handled by the
1703 client ipc min protocol option.
1704 Note that most command line tools support --option='client min
1706 protocol=NT1', so it may not be required to enable SMB1 protocols
1707 globally in smb.conf.
1708 Default: client min protocol = SMB2_02
1710 Example: client min protocol = NT1
1712 client NTLMv2 auth (G)
1714 This parameter has been deprecated since Samba 4.13 and support for
1716 NTLM and LanMan (as distinct from NTLMv2 or Kerberos
1717 authentication) will be removed in a future Samba release.
1718 That is, in the future, the current default of client NTLMv2 auth =
1720 yes will be the enforced behaviour.
1721 This parameter determines whether or not smbclient(8) will attempt
1723 to authenticate itself to servers using the NTLMv2 encrypted
1724 password response.
1725 If enabled, only an NTLMv2 and LMv2 response (both much more secure
1727 than earlier versions) will be sent. Older servers (including NT4 <
1728 SP4, Win9x and Samba 2.2) are not compatible with NTLMv2 when not
1729 in an NTLMv2 supporting domain
1730 Similarly, if enabled, NTLMv1, client lanman auth and client
1732 plaintext auth authentication will be disabled. This also disables
1733 share-level authentication.
1734 If disabled, an NTLM response (and possibly a LANMAN response) will
1736 be sent by the client, depending on the value of client lanman
1737 auth.
1738 Note that Windows Vista and later versions already use NTLMv2 by
1740 default, and some sites (particularly those following 'best
1741 practice' security polices) only allow NTLMv2 responses, and not
1742 the weaker LM or NTLM.
1743 When client use spnego is also set to yes extended security
1745 (SPNEGO) is required in order to use NTLMv2 only within NTLMSSP.
1746 This behavior was introduced with the patches for CVE-2016-2111.
1747 Default: client NTLMv2 auth = yes
1749 client plaintext auth (G)
1751 This parameter has been deprecated since Samba 4.13 and support for
1753 plaintext (as distinct from NTLM, NTLMv2 or Kerberos
1754 authentication) will be removed in a future Samba release.
1755 That is, in the future, the current default of client plaintext
1757 auth = no will be the enforced behaviour.
1758 Specifies whether a client should send a plaintext password if the
1760 server does not support encrypted passwords.
1761 Default: client plaintext auth = no
1763 client schannel (G)
1765 This option is deprecated with Samba 4.8 and will be removed in
1767 future. At the same time the default changed to yes, which will be
1768 the hardcoded behavior in future.
1769 This controls whether the client offers or even demands the use of
1771 the netlogon schannel. client schannel = no does not offer the
1772 schannel, client schannel = auto offers the schannel but does not
1773 enforce it, and client schannel = yes denies access if the server
1774 is not able to speak netlogon schannel.
1775 Note that for active directory domains this is hardcoded to client
1777 schannel = yes.
1778 This option yields precedence to the require strong key option.
1780 Default: client schannel = yes
1782 Example: client schannel = auto
1784 client signing (G)
1786 This controls whether the client is allowed or required to use SMB
1788 signing. Possible values are auto, mandatory and disabled.
1789 When set to auto or default, SMB signing is offered, but not
1791 enforced.
1792 When set to mandatory, SMB signing is required and if set to
1794 disabled, SMB signing is not offered either.
1795 IPC$ connections for DCERPC e.g. in winbindd, are handled by the
1797 client ipc signing option.
1798 Default: client signing = default
1800 client smb encrypt (G)
1802 This parameter controls whether a client should try or is required
1804 to use SMB encryption. It has different effects depending on
1805 whether the connection uses SMB1 or SMB3:
1806 • If the connection uses SMB1, then this option controls
1808 the use of a Samba-specific extension to the SMB
1809 protocol introduced in Samba 3.2 that makes use of the
1810 Unix extensions.
1811 • If the connection uses SMB2 or newer, then this option
1813 controls the use of the SMB-level encryption that is
1814 supported in SMB version 3.0 and above and available in
1815 Windows 8 and newer.
1816 This parameter can be set globally. Possible values are off,
1818 if_required, desired, and required. A special value is default
1819 which is the implicit default setting of if_required.
1820 Effects for SMB1
1822 The Samba-specific encryption of SMB1 connections is an
1823 extension to the SMB protocol negotiated as part of the UNIX
1824 extensions. SMB encryption uses the GSSAPI (SSPI on Windows)
1825 ability to encrypt and sign every request/response in a SMB
1826 protocol stream. When enabled it provides a secure method of
1827 SMB/CIFS communication, similar to an ssh protected session,
1828 but using SMB/CIFS authentication to negotiate encryption and
1829 signing keys. Currently this is only supported smbclient of by
1830 Samba 3.2 and newer. Windows does not support this feature.
1831 When set to default, SMB encryption is probed, but not
1833 enforced. When set to required, SMB encryption is required and
1834 if set to disabled, SMB encryption can not be negotiated.
1835 Effects for SMB3 and newer
1837 Native SMB transport encryption is available in SMB version 3.0
1838 or newer. It is only used by Samba if client max protocol is
1839 set to SMB3 or newer.
1840 These features can be controlled with settings of client smb
1842 encrypt as follows:
1843 • Leaving it as default, explicitly setting default,
1845 or setting it to if_required globally will enable
1846 negotiation of encryption but will not turn on data
1847 encryption globally.
1848 • Setting it to desired globally will enable
1850 negotiation and will turn on data encryption on
1851 sessions and share connections for those servers
1852 that support it.
1853 • Setting it to required globally will enable
1855 negotiation and turn on data encryption on sessions
1856 and share connections. Clients that do not support
1857 encryption will be denied access to the server.
1858 • Setting it to off globally will completely disable
1860 the encryption feature for all connections.
1861 Default: client smb encrypt = default
1864 client use spnego principal (G)
1866 This parameter determines whether or not smbclient(8) and other
1868 samba components acting as a client will attempt to use the
1869 server-supplied principal sometimes given in the SPNEGO exchange.
1870 If enabled, Samba can attempt to use Kerberos to contact servers
1872 known only by IP address. Kerberos relies on names, so ordinarily
1873 cannot function in this situation.
1874 This is a VERY BAD IDEA for security reasons, and so this parameter
1876 SHOULD NOT BE USED. It will be removed in a future version of
1877 Samba.
1878 If disabled, Samba will use the name used to look up the server
1880 when asking the KDC for a ticket. This avoids situations where a
1881 server may impersonate another, soliciting authentication as one
1882 principal while being known on the network as another.
1883 Note that Windows XP SP2 and later versions already follow this
1885 behaviour, and Windows Vista and later servers no longer supply
1886 this 'rfc4178 hint' principal on the server side.
1887 This parameter is deprecated in Samba 4.2.1 and will be removed
1889 (along with the functionality) in a later release of Samba.
1890 Default: client use spnego principal = no
1892 client use spnego (G)
1894 This parameter has been deprecated since Samba 4.13 and support for
1896 NTLMv2, NTLM and LanMan authentication outside NTLMSSP will be
1897 removed in a future Samba release.
1898 That is, in the future, the current default of client use spnego =
1900 yes will be the enforced behaviour.
1901 This variable controls whether Samba clients will try to use Simple
1903 and Protected NEGOciation (as specified by rfc2478) with supporting
1904 servers (including WindowsXP, Windows2000 and Samba 3.0) to agree
1905 upon an authentication mechanism. This enables Kerberos
1906 authentication in particular.
1907 When client NTLMv2 auth is also set to yes extended security
1909 (SPNEGO) is required in order to use NTLMv2 only within NTLMSSP.
1910 This behavior was introduced with the patches for CVE-2016-2111.
1911 Default: client use spnego = yes
1913 cluster addresses (G)
1915 With this parameter you can add additional addresses that nmbd will
1917 register with a WINS server. Similarly, these addresses will be
1918 registered by default when net ads dns register is called with
1919 clustering = yes configured.
1920 Default: cluster addresses =
1922 Example: cluster addresses = 10.0.0.1 10.0.0.2 10.0.0.3
1924 clustering (G)
1926 This parameter specifies whether Samba should contact ctdb for
1928 accessing its tdb files and use ctdb as a backend for its messaging
1929 backend.
1930 Set this parameter to yes only if you have a cluster setup with
1932 ctdb running.
1933 Default: clustering = no
1935 comment (S)
1937 This is a text field that is seen next to a share when a client
1939 does a queries the server, either via the network neighborhood or
1940 via net view to list what shares are available.
1941 If you want to set the string that is displayed next to the machine
1943 name then see the server string parameter.
1944 Default: comment = # No comment
1946 Example: comment = Fred's Files
1948 config backend (G)
1950 This controls the backend for storing the configuration. Possible
1952 values are file (the default) and registry. When config backend =
1953 registry is encountered while loading smb.conf, the configuration
1954 read so far is dropped and the global options are read from
1955 registry instead. So this triggers a registry only configuration.
1956 Share definitions are not read immediately but instead registry
1957 shares is set to yes.
1958 Note: This option can not be set inside the registry configuration
1960 itself.
1961 Default: config backend = file
1963 Example: config backend = registry
1965 config file (G)
1967 This allows you to override the config file to use, instead of the
1969 default (usually smb.conf). There is a chicken and egg problem here
1970 as this option is set in the config file!
1971 For this reason, if the name of the config file has changed when
1973 the parameters are loaded then it will reload them from the new
1974 config file.
1975 This option takes the usual substitutions, which can be very
1977 useful.
1978 If the config file doesn't exist then it won't be loaded (allowing
1980 you to special case the config files of just a few clients).
1981 No default
1983 Example: config file = /usr/local/samba/lib/smb.conf.%m
1985 copy (S)
1987 This parameter allows you to "clone" service entries. The specified
1989 service is simply duplicated under the current service's name. Any
1990 parameters specified in the current section will override those in
1991 the section being copied.
1992 This feature lets you set up a 'template' service and create
1994 similar services easily. Note that the service being copied must
1995 occur earlier in the configuration file than the service doing the
1996 copying.
1997 Default: copy =
1999 Example: copy = otherservice
2001 create krb5 conf (G)
2003 Setting this parameter to no prevents winbind from creating custom
2005 krb5.conf files. Winbind normally does this because the krb5
2006 libraries are not AD-site-aware and thus would pick any domain
2007 controller out of potentially very many. Winbind is site-aware and
2008 makes the krb5 libraries use a local DC by creating its own
2009 krb5.conf files.
2010 Preventing winbind from doing this might become necessary if you
2012 have to add special options into your system-krb5.conf that winbind
2013 does not see.
2014 Default: create krb5 conf = yes
2016 create mode
2018 This parameter is a synonym for create mask.
2020 create mask (S)
2022 When a file is created, the necessary permissions are calculated
2024 according to the mapping from DOS modes to UNIX permissions, and
2025 the resulting UNIX mode is then bit-wise 'AND'ed with this
2026 parameter. This parameter may be thought of as a bit-wise MASK for
2027 the UNIX modes of a file. Any bit not set here will be removed from
2028 the modes set on a file when it is created.
2029 The default value of this parameter removes the group and other
2031 write and execute bits from the UNIX modes.
2032 Following this Samba will bit-wise 'OR' the UNIX mode created from
2034 this parameter with the value of the force create mode parameter
2035 which is set to 000 by default.
2036 This parameter does not affect directory masks. See the parameter
2038 directory mask for details.
2039 Default: create mask = 0744
2041 Example: create mask = 0775
2043 csc policy (S)
2045 This stands for client-side caching policy, and specifies how
2047 clients capable of offline caching will cache the files in the
2048 share. The valid values are: manual, documents, programs, disable.
2049 These values correspond to those used on Windows servers.
2051 For example, shares containing roaming profiles can have offline
2053 caching disabled using csc policy = disable.
2054 Default: csc policy = manual
2056 Example: csc policy = programs
2058 ctdbd socket (G)
2060 If you set clustering=yes, you need to tell Samba where ctdbd
2062 listens on its unix domain socket. The default path as of ctdb 1.0
2063 is /tmp/ctdb.socket which you have to explicitly set for Samba in
2064 smb.conf.
2065 Default: ctdbd socket =
2067 Example: ctdbd socket = /tmp/ctdb.socket
2069 ctdb locktime warn threshold (G)
2071 In a cluster environment using Samba and ctdb it is critical that
2073 locks on central ctdb-hosted databases like locking.tdb are not
2074 held for long. With the current Samba architecture it happens that
2075 Samba takes a lock and while holding that lock makes file system
2076 calls into the shared cluster file system. This option makes Samba
2077 warn if it detects that it has held locks for the specified number
2078 of milliseconds. If this happens, smbd will emit a debug level 0
2079 message into its logs and potentially into syslog. The most likely
2080 reason for such a log message is that an operation of the cluster
2081 file system Samba exports is taking longer than expected. The
2082 messages are meant as a debugging aid for potential cluster
2083 problems.
2084 The default value of 0 disables this logging.
2086 Default: ctdb locktime warn threshold = 0
2088 ctdb timeout (G)
2090 This parameter specifies a timeout in milliseconds for the
2092 connection between Samba and ctdb. It is only valid if you have
2093 compiled Samba with clustering and if you have set clustering=yes.
2094 When something in the cluster blocks, it can happen that we wait
2096 indefinitely long for ctdb, just adding to the blocking condition.
2097 In a well-running cluster this should never happen, but there are
2098 too many components in a cluster that might have hickups. Choosing
2099 the right balance for this value is very tricky, because on a busy
2100 cluster long service times to transfer something across the cluster
2101 might be valid. Setting it too short will degrade the service your
2102 cluster presents, setting it too long might make the cluster itself
2103 not recover from something severely broken for too long.
2104 Be aware that if you set this parameter, this needs to be in the
2106 file smb.conf, it is not really helpful to put this into a registry
2107 configuration (typical on a cluster), because to access the
2108 registry contact to ctdb is required.
2109 Setting ctdb timeout to n makes any process waiting longer than n
2111 milliseconds for a reply by the cluster panic. Setting it to 0 (the
2112 default) makes Samba block forever, which is the highly recommended
2113 default.
2114 Default: ctdb timeout = 0
2116 cups connection timeout (G)
2118 This parameter is only applicable if printing is set to cups.
2120 If set, this option specifies the number of seconds that smbd will
2122 wait whilst trying to contact to the CUPS server. The connection
2123 will fail if it takes longer than this number of seconds.
2124 Default: cups connection timeout = 30
2126 Example: cups connection timeout = 60
2128 cups encrypt (G)
2130 This parameter is only applicable if printing is set to cups and if
2132 you use CUPS newer than 1.0.x.It is used to define whether or not
2133 Samba should use encryption when talking to the CUPS server.
2134 Possible values are auto, yes and no
2135 When set to auto we will try to do a TLS handshake on each CUPS
2137 connection setup. If that fails, we will fall back to unencrypted
2138 operation.
2139 Default: cups encrypt = no
2141 cups options (S)
2143 This parameter is only applicable if printing is set to cups. Its
2145 value is a free form string of options passed directly to the cups
2146 library.
2147 You can pass any generic print option known to CUPS (as listed in
2149 the CUPS "Software Users' Manual"). You can also pass any printer
2150 specific option (as listed in "lpoptions -d printername -l") valid
2151 for the target queue. Multiple parameters should be space-delimited
2152 name/value pairs according to the PAPI text option ABNF
2153 specification. Collection values ("name={a=... b=... c=...}") are
2154 stored with the curley brackets intact.
2155 You should set this parameter to raw if your CUPS server error_log
2157 file contains messages such as "Unsupported format
2158 'application/octet-stream'" when printing from a Windows client
2159 through Samba. It is no longer necessary to enable system wide raw
2160 printing in /etc/cups/mime.{convs,types}.
2161 Default: cups options = ""
2163 Example: cups options = "raw media=a4"
2165 cups server (G)
2167 This parameter is only applicable if printing is set to cups.
2169 If set, this option overrides the ServerName option in the CUPS
2171 client.conf. This is necessary if you have virtual samba servers
2172 that connect to different CUPS daemons.
2173 Optionally, a port can be specified by separating the server name
2175 and port number with a colon. If no port was specified, the default
2176 port for IPP (631) will be used.
2177 Default: cups server = ""
2179 Example: cups server = mycupsserver
2181 Example: cups server = mycupsserver:1631
2183 dcerpc endpoint servers (G)
2185 Specifies which DCE/RPC endpoint servers should be run.
2187 Default: dcerpc endpoint servers = epmapper, wkssvc, rpcecho, samr,
2189 netlogon, lsarpc, drsuapi, dssetup, unixinfo, browser, eventlog6,
2190 backupkey, dnsserver
2191 Example: dcerpc endpoint servers = rpcecho
2193 deadtime (G)
2195 The value of the parameter (a decimal integer) represents the
2197 number of minutes of inactivity before a connection is considered
2198 dead, and it is disconnected. The deadtime only takes effect if the
2199 number of open files is zero.
2200 This is useful to stop a server's resources being exhausted by a
2202 large number of inactive connections.
2203 Most clients have an auto-reconnect feature when a connection is
2205 broken so in most cases this parameter should be transparent to
2206 users.
2207 Using this parameter with a timeout of a few minutes is recommended
2209 for most systems.
2210 A deadtime of zero indicates that no auto-disconnection should be
2212 performed.
2213 Default: deadtime = 10080
2215 Example: deadtime = 15
2217 debug class (G)
2219 With this boolean parameter enabled, the debug class (DBGC_CLASS)
2221 will be displayed in the debug header.
2222 For more information about currently available debug classes, see
2224 section about log level.
2225 Default: debug class = no
2227 debug encryption (G)
2229 This option will make the smbd server and client code using libsmb
2231 (smbclient, smbget, smbspool, ...) dump the Session Id, the
2232 decrypted Session Key, the Signing Key, the Application Key, the
2233 Encryption Key and the Decryption Key every time an SMB3+ session
2234 is established. This information will be printed in logs at level
2235 0.
2236 Warning: access to these values enables the decryption of any
2238 encrypted traffic on the dumped sessions. This option should only
2239 be enabled for debugging purposes.
2240 Default: debug encryption = no
2242 debug hires timestamp (G)
2244 Sometimes the timestamps in the log messages are needed with a
2246 resolution of higher that seconds, this boolean parameter adds
2247 microsecond resolution to the timestamp message header when turned
2248 on.
2249 Note that the parameter debug timestamp must be on for this to have
2251 an effect.
2252 Default: debug hires timestamp = yes
2254 debug pid (G)
2256 When using only one log file for more then one forked
2258 smbd(8)-process there may be hard to follow which process outputs
2259 which message. This boolean parameter is adds the process-id to the
2260 timestamp message headers in the logfile when turned on.
2261 Note that the parameter debug timestamp must be on for this to have
2263 an effect.
2264 Default: debug pid = no
2266 debug prefix timestamp (G)
2268 With this option enabled, the timestamp message header is prefixed
2270 to the debug message without the filename and function information
2271 that is included with the debug timestamp parameter. This gives
2272 timestamps to the messages without adding an additional line.
2273 Note that this parameter overrides the debug timestamp parameter.
2275 Default: debug prefix timestamp = no
2277 debug uid (G)
2279 Samba is sometimes run as root and sometime run as the connected
2281 user, this boolean parameter inserts the current euid, egid, uid
2282 and gid to the timestamp message headers in the log file if turned
2283 on.
2284 Note that the parameter debug timestamp must be on for this to have
2286 an effect.
2287 Default: debug uid = no
2289 dedicated keytab file (G)
2291 Specifies the absolute path to the kerberos keytab file when
2293 kerberos method is set to "dedicated keytab".
2294 Default: dedicated keytab file =
2296 Example: dedicated keytab file = /usr/local/etc/krb5.keytab
2298 default case (S)
2300 See the section on name mangling. Also note the short preserve case
2302 parameter.
2303 Default: default case = lower
2305 default devmode (S)
2307 This parameter is only applicable to printable services. When smbd
2309 is serving Printer Drivers to Windows NT/2k/XP clients, each
2310 printer on the Samba server has a Device Mode which defines things
2311 such as paper size and orientation and duplex settings. The device
2312 mode can only correctly be generated by the printer driver itself
2313 (which can only be executed on a Win32 platform). Because smbd is
2314 unable to execute the driver code to generate the device mode, the
2315 default behavior is to set this field to NULL.
2316 Most problems with serving printer drivers to Windows NT/2k/XP
2318 clients can be traced to a problem with the generated device mode.
2319 Certain drivers will do things such as crashing the client's
2320 Explorer.exe with a NULL devmode. However, other printer drivers
2321 can cause the client's spooler service (spoolsv.exe) to die if the
2322 devmode was not created by the driver itself (i.e. smbd generates a
2323 default devmode).
2324 This parameter should be used with care and tested with the printer
2326 driver in question. It is better to leave the device mode to NULL
2327 and let the Windows client set the correct values. Because drivers
2328 do not do this all the time, setting default devmode = yes will
2329 instruct smbd to generate a default one.
2330 For more information on Windows NT/2k printing and Device Modes,
2332 see the MSDN documentation.
2333 Default: default devmode = yes
2335 default
2337 This parameter is a synonym for default service.
2339 default service (G)
2341 This parameter specifies the name of a service which will be
2343 connected to if the service actually requested cannot be found.
2344 Note that the square brackets are NOT given in the parameter value
2345 (see example below).
2346 There is no default value for this parameter. If this parameter is
2348 not given, attempting to connect to a nonexistent service results
2349 in an error.
2350 Typically the default service would be a guest ok, read-only
2352 service.
2353 Also note that the apparent service name will be changed to equal
2355 that of the requested service, this is very useful as it allows you
2356 to use macros like %S to make a wildcard service.
2357 Note also that any "_" characters in the name of the service used
2359 in the default service will get mapped to a "/". This allows for
2360 interesting things.
2361 Default: default service =
2363 Example: default service = pub
2365 defer sharing violations (G)
2367 Windows allows specifying how a file will be shared with other
2369 processes when it is opened. Sharing violations occur when a file
2370 is opened by a different process using options that violate the
2371 share settings specified by other processes. This parameter causes
2372 smbd to act as a Windows server does, and defer returning a
2373 "sharing violation" error message for up to one second, allowing
2374 the client to close the file causing the violation in the meantime.
2375 UNIX by default does not have this behaviour.
2377 There should be no reason to turn off this parameter, as it is
2379 designed to enable Samba to more correctly emulate Windows.
2380 Default: defer sharing violations = yes
2382 delete group script (G)
2384 This is the full pathname to a script that will be run AS ROOT by
2386 smbd(8) when a group is requested to be deleted. It will expand any
2387 %g to the group name passed. This script is only useful for
2388 installations using the Windows NT domain administration tools.
2389 Default: delete group script =
2391 deleteprinter command (G)
2393 With the introduction of MS-RPC based printer support for Windows
2395 NT/2000 clients in Samba 2.2, it is now possible to delete a
2396 printer at run time by issuing the DeletePrinter() RPC call.
2397 For a Samba host this means that the printer must be physically
2399 deleted from the underlying printing system. The deleteprinter
2400 command defines a script to be run which will perform the necessary
2401 operations for removing the printer from the print system and from
2402 smb.conf.
2403 The deleteprinter command is automatically called with only one
2405 parameter: printer name.
2406 Once the deleteprinter command has been executed, smbd will reparse
2408 the smb.conf to check that the associated printer no longer exists.
2409 If the sharename is still valid, then smbd will return an
2410 ACCESS_DENIED error to the client.
2411 Default: deleteprinter command =
2413 Example: deleteprinter command = /usr/bin/removeprinter
2415 delete readonly (S)
2417 This parameter allows readonly files to be deleted. This is not
2419 normal DOS semantics, but is allowed by UNIX.
2420 This option may be useful for running applications such as rcs,
2422 where UNIX file ownership prevents changing file permissions, and
2423 DOS semantics prevent deletion of a read only file.
2424 Default: delete readonly = no
2426 delete share command (G)
2428 Samba 2.2.0 introduced the ability to dynamically add and delete
2430 shares via the Windows NT 4.0 Server Manager. The delete share
2431 command is used to define an external program or script which will
2432 remove an existing service definition from smb.conf.
2433 In order to successfully execute the delete share command, smbd
2435 requires that the administrator connects using a root account (i.e.
2436 uid == 0) or has the SeDiskOperatorPrivilege. Scripts defined in
2437 the delete share command parameter are executed as root.
2438 When executed, smbd will automatically invoke the delete share
2440 command with two parameters.
2441 • configFile - the location of the global smb.conf file.
2443 • shareName - the name of the existing service.
2445 This parameter is only used to remove file shares. To delete
2447 printer shares, see the deleteprinter command.
2448 Default: delete share command =
2450 Example: delete share command = /usr/local/bin/delshare
2452 delete user from group script (G)
2454 Full path to the script that will be called when a user is removed
2456 from a group using the Windows NT domain administration tools. It
2457 will be run by smbd(8) AS ROOT. Any %g will be replaced with the
2458 group name and any %u will be replaced with the user name.
2459 Default: delete user from group script =
2461 Example: delete user from group script = /usr/sbin/deluser %u %g
2463 delete user script (G)
2465 This is the full pathname to a script that will be run by smbd(8)
2467 when managing users with remote RPC (NT) tools.
2468 This script is called when a remote client removes a user from the
2470 server, normally using 'User Manager for Domains' or rpcclient.
2471 This script should delete the given UNIX username.
2473 Default: delete user script =
2475 Example: delete user script = /usr/local/samba/bin/del_user %u
2477 delete veto files (S)
2479 This option is used when Samba is attempting to delete a directory
2481 that contains one or more vetoed directories (see the veto files
2482 option). If this option is set to no (the default) then if a vetoed
2483 directory contains any non-vetoed files or directories then the
2484 directory delete will fail. This is usually what you want.
2485 If this option is set to yes, then Samba will attempt to
2487 recursively delete any files and directories within the vetoed
2488 directory. This can be useful for integration with file serving
2489 systems such as NetAtalk which create meta-files within directories
2490 you might normally veto DOS/Windows users from seeing (e.g.
2491 .AppleDouble)
2492 Setting delete veto files = yes allows these directories to be
2494 transparently deleted when the parent directory is deleted (so long
2495 as the user has permissions to do so).
2496 Default: delete veto files = no
2498 dfree cache time (S)
2500 The dfree cache time should only be used on systems where a problem
2502 occurs with the internal disk space calculations. This has been
2503 known to happen with Ultrix, but may occur with other operating
2504 systems. The symptom that was seen was an error of "Abort Retry
2505 Ignore" at the end of each directory listing.
2506 This is a new parameter introduced in Samba version 3.0.21. It
2508 specifies in seconds the time that smbd will cache the output of a
2509 disk free query. If set to zero (the default) no caching is done.
2510 This allows a heavily loaded server to prevent rapid spawning of
2511 dfree command scripts increasing the load.
2512 By default this parameter is zero, meaning no caching will be done.
2514 No default
2516 Example: dfree cache time = 60
2518 dfree command (S)
2520 The dfree command setting should only be used on systems where a
2522 problem occurs with the internal disk space calculations. This has
2523 been known to happen with Ultrix, but may occur with other
2524 operating systems. The symptom that was seen was an error of "Abort
2525 Retry Ignore" at the end of each directory listing.
2526 This setting allows the replacement of the internal routines to
2528 calculate the total disk space and amount available with an
2529 external routine. The example below gives a possible script that
2530 might fulfill this function.
2531 In Samba version 3.0.21 this parameter has been changed to be a
2533 per-share parameter, and in addition the parameter dfree cache time
2534 was added to allow the output of this script to be cached for
2535 systems under heavy load.
2536 The external program will be passed a single parameter indicating a
2538 directory in the filesystem being queried. This will typically
2539 consist of the string ./. The script should return two integers in
2540 ASCII. The first should be the total disk space in blocks, and the
2541 second should be the number of available blocks. An optional third
2542 return value can give the block size in bytes. The default
2543 blocksize is 1024 bytes.
2544 Note: Your script should NOT be setuid or setgid and should be
2546 owned by (and writeable only by) root!
2547 Where the script dfree (which must be made executable) could be:
2549 #!/bin/sh
2552 df "$1" | tail -1 | awk '{print $(NF-4),$(NF-2)}'
2553 or perhaps (on Sys V based systems):
2555 #!/bin/sh
2558 /usr/bin/df -k "$1" | tail -1 | awk '{print $3" "$5}'
2559 Note that you may have to replace the command names with full path
2561 names on some systems. Also note the arguments passed into the
2562 script should be quoted inside the script in case they contain
2563 special characters such as spaces or newlines.
2564 By default internal routines for determining the disk capacity and
2566 remaining space will be used.
2567 No default
2569 Example: dfree command = /usr/local/samba/bin/dfree
2571 dgram port (G)
2573 Specifies which ports the server should listen on for NetBIOS
2575 datagram traffic.
2576 Default: dgram port = 138
2578 directory mode
2580 This parameter is a synonym for directory mask.
2582 directory mask (S)
2584 This parameter is the octal modes which are used when converting
2586 DOS modes to UNIX modes when creating UNIX directories.
2587 When a directory is created, the necessary permissions are
2589 calculated according to the mapping from DOS modes to UNIX
2590 permissions, and the resulting UNIX mode is then bit-wise 'AND'ed
2591 with this parameter. This parameter may be thought of as a bit-wise
2592 MASK for the UNIX modes of a directory. Any bit not set here will
2593 be removed from the modes set on a directory when it is created.
2594 The default value of this parameter removes the 'group' and 'other'
2596 write bits from the UNIX mode, allowing only the user who owns the
2597 directory to modify it.
2598 Following this Samba will bit-wise 'OR' the UNIX mode created from
2600 this parameter with the value of the force directory mode
2601 parameter. This parameter is set to 000 by default (i.e. no extra
2602 mode bits are added).
2603 Default: directory mask = 0755
2605 Example: directory mask = 0775
2607 directory name cache size (S)
2609 This parameter specifies the size of the directory name cache for
2611 SMB1 connections. It is not used for SMB2. It will be needed to
2612 turn this off for *BSD systems.
2613 Default: directory name cache size = 100
2615 directory security mask (S)
2617 This parameter has been removed for Samba 4.0.0.
2619 No default
2621 disable netbios (G)
2623 Enabling this parameter will disable netbios support in Samba.
2625 Netbios is the only available form of browsing in all windows
2626 versions except for 2000 and XP.
2627 Note
2629 Clients that only support netbios won't be able to see your
2630 samba server when netbios support is disabled.
2631 Default: disable netbios = no
2632 disable spoolss (G)
2634 Enabling this parameter will disable Samba's support for the
2636 SPOOLSS set of MS-RPC's and will yield identical behavior as Samba
2637 2.0.x. Windows NT/2000 clients will downgrade to using Lanman style
2638 printing commands. Windows 9x/ME will be unaffected by the
2639 parameter. However, this will also disable the ability to upload
2640 printer drivers to a Samba server via the Windows NT Add Printer
2641 Wizard or by using the NT printer properties dialog window. It will
2642 also disable the capability of Windows NT/2000 clients to download
2643 print drivers from the Samba host upon demand. Be very careful
2644 about enabling this parameter.
2645 Default: disable spoolss = no
2647 dmapi support (S)
2649 This parameter specifies whether Samba should use DMAPI to
2651 determine whether a file is offline or not. This would typically be
2652 used in conjunction with a hierarchical storage system that
2653 automatically migrates files to tape.
2654 Note that Samba infers the status of a file by examining the events
2656 that a DMAPI application has registered interest in. This heuristic
2657 is satisfactory for a number of hierarchical storage systems, but
2658 there may be system for which it will fail. In this case, Samba may
2659 erroneously report files to be offline.
2660 This parameter is only available if a supported DMAPI
2662 implementation was found at compilation time. It will only be used
2663 if DMAPI is found to enabled on the system at run time.
2664 Default: dmapi support = no
2666 dns forwarder (G)
2668 This option specifies the list of DNS servers that DNS requests
2670 will be forwarded to if they can not be handled by Samba itself.
2671 The DNS forwarder is only used if the internal DNS server in Samba
2673 is used.
2674 Default: dns forwarder =
2676 Example: dns forwarder = 192.168.0.1 192.168.0.2
2678 dns proxy (G)
2680 Specifies that nmbd(8) when acting as a WINS server and finding
2682 that a NetBIOS name has not been registered, should treat the
2683 NetBIOS name word-for-word as a DNS name and do a lookup with the
2684 DNS server for that name on behalf of the name-querying client.
2685 Note that the maximum length for a NetBIOS name is 15 characters,
2687 so the DNS name (or DNS alias) can likewise only be 15 characters,
2688 maximum.
2689 nmbd spawns a second copy of itself to do the DNS name lookup
2691 requests, as doing a name lookup is a blocking action.
2692 Default: dns proxy = yes
2694 dns update command (G)
2696 This option sets the command that is called when there are DNS
2698 updates. It should update the local machines DNS names using
2699 TSIG-GSS.
2700 Default: dns update command =
2702 /builddir/build/BUILD/samba-4.14.5/source4/scripting/bin/samba_dnsupdate
2703 Example: dns update command = /usr/local/sbin/dnsupdate
2705 dns zone scavenging (G)
2707 When enabled (the default is disabled) unused dynamic dns records
2709 are periodically removed.
2710 Warning
2712 This option should not be enabled for installations created
2713 with versions of samba before 4.9. Doing this will result in
2714 the loss of static DNS entries. This is due to a bug in
2715 previous versions of samba (BUG 12451) which marked dynamic DNS
2716 records as static and static records as dynamic.
2717 Note
2719 If one record for a DNS name is static (non-aging) then no
2720 other record for that DNS name will be scavenged.
2721 Default: dns zone scavenging = no
2722 domain logons (G)
2724 This parameter has been deprecated since Samba 4.13 and support for
2726 NT4-style domain logons(as distinct from the Samba AD DC) will be
2727 removed in a future Samba release.
2728 That is, in the future, the current default of domain logons = no
2730 will be the enforced behaviour.
2731 If set to yes, the Samba server will provide the netlogon service
2733 for Windows 9X network logons for the workgroup it is in. This will
2734 also cause the Samba server to act as a domain controller for NT4
2735 style domain services. For more details on setting up this feature
2736 see the Domain Control chapter of the Samba HOWTO Collection.
2737 Default: domain logons = no
2739 domain master (G)
2741 Tell smbd(8) to enable WAN-wide browse list collation. Setting this
2743 option causes nmbd to claim a special domain specific NetBIOS name
2744 that identifies it as a domain master browser for its given
2745 workgroup. Local master browsers in the same workgroup on
2746 broadcast-isolated subnets will give this nmbd their local browse
2747 lists, and then ask smbd(8) for a complete copy of the browse list
2748 for the whole wide area network. Browser clients will then contact
2749 their local master browser, and will receive the domain-wide browse
2750 list, instead of just the list for their broadcast-isolated subnet.
2751 Note that Windows NT Primary Domain Controllers expect to be able
2753 to claim this workgroup specific special NetBIOS name that
2754 identifies them as domain master browsers for that workgroup by
2755 default (i.e. there is no way to prevent a Windows NT PDC from
2756 attempting to do this). This means that if this parameter is set
2757 and nmbd claims the special name for a workgroup before a Windows
2758 NT PDC is able to do so then cross subnet browsing will behave
2759 strangely and may fail.
2760 If domain logons = yes, then the default behavior is to enable the
2762 domain master parameter. If domain logons is not enabled (the
2763 default setting), then neither will domain master be enabled by
2764 default.
2765 When domain logons = Yes the default setting for this parameter is
2767 Yes, with the result that Samba will be a PDC. If domain master =
2768 No, Samba will function as a BDC. In general, this parameter should
2769 be set to 'No' only on a BDC.
2770 Default: domain master = auto
2772 dont descend (S)
2774 There are certain directories on some systems (e.g., the /proc tree
2776 under Linux) that are either not of interest to clients or are
2777 infinitely deep (recursive). This parameter allows you to specify a
2778 comma-delimited list of directories that the server should always
2779 show as empty.
2780 Note that Samba can be very fussy about the exact format of the
2782 "dont descend" entries. For example you may need ./proc instead of
2783 just /proc. Experimentation is the best policy :-)
2784 Default: dont descend =
2786 Example: dont descend = /proc,/dev
2788 dos charset (G)
2790 DOS SMB clients assume the server has the same charset as they do.
2792 This option specifies which charset Samba should talk to DOS
2793 clients.
2794 The default depends on which charsets you have installed. Samba
2796 tries to use charset 850 but falls back to ASCII in case it is not
2797 available. Run testparm(1) to check the default on your system.
2798 No default
2800 dos filemode (S)
2802 The default behavior in Samba is to provide UNIX-like behavior
2804 where only the owner of a file/directory is able to change the
2805 permissions on it. However, this behavior is often confusing to
2806 DOS/Windows users. Enabling this parameter allows a user who has
2807 write access to the file (by whatever means, including an ACL
2808 permission) to modify the permissions (including ACL) on it. Note
2809 that a user belonging to the group owning the file will not be
2810 allowed to change permissions if the group is only granted read
2811 access. Ownership of the file/directory may also be changed. Note
2812 that using the VFS modules acl_xattr or acl_tdb which store native
2813 Windows as meta-data will automatically turn this option on for any
2814 share for which they are loaded, as they require this option to
2815 emulate Windows ACLs correctly.
2816 Default: dos filemode = no
2818 dos filetime resolution (S)
2820 Under the DOS and Windows FAT filesystem, the finest granularity on
2822 time resolution is two seconds. Setting this parameter for a share
2823 causes Samba to round the reported time down to the nearest two
2824 second boundary when a query call that requires one second
2825 resolution is made to smbd(8).
2826 This option is mainly used as a compatibility option for Visual C++
2828 when used against Samba shares. If oplocks are enabled on a share,
2829 Visual C++ uses two different time reading calls to check if a file
2830 has changed since it was last read. One of these calls uses a
2831 one-second granularity, the other uses a two second granularity. As
2832 the two second call rounds any odd second down, then if the file
2833 has a timestamp of an odd number of seconds then the two timestamps
2834 will not match and Visual C++ will keep reporting the file has
2835 changed. Setting this option causes the two timestamps to match,
2836 and Visual C++ is happy.
2837 Default: dos filetime resolution = no
2839 dos filetimes (S)
2841 Under DOS and Windows, if a user can write to a file they can
2843 change the timestamp on it. Under POSIX semantics, only the owner
2844 of the file or root may change the timestamp. By default, Samba
2845 emulates the DOS semantics and allows one to change the timestamp
2846 on a file if the user smbd is acting on behalf has write
2847 permissions. Due to changes in Microsoft Office 2000 and beyond,
2848 the default for this parameter has been changed from "no" to "yes"
2849 in Samba 3.0.14 and above. Microsoft Excel will display dialog box
2850 warnings about the file being changed by another user if this
2851 parameter is not set to "yes" and files are being shared between
2852 users.
2853 Default: dos filetimes = yes
2855 dsdb event notification (G)
2857 When enabled, this option causes Samba (acting as an Active
2859 Directory Domain Controller) to stream Samba database events across
2860 the internal message bus. Scripts built using Samba's python
2861 bindings can listen to these events by registering as the service
2862 dsdb_event.
2863 This is not needed for the audit logging described in log level.
2865 Instead, this should instead be considered a developer option (it
2867 assists in the Samba testsuite) rather than a facility for external
2868 auditing, as message delivery is not guaranteed (a feature that the
2869 testsuite works around).
2870 The Samba database events are also logged via the normal logging
2872 methods when the log level is set appropriately, say to
2873 dsdb_json_audit:5.
2874 Default: dsdb event notification = no
2876 dsdb group change notification (G)
2878 When enabled, this option causes Samba (acting as an Active
2880 Directory Domain Controller) to stream group membership change
2881 events across the internal message bus. Scripts built using Samba's
2882 python bindings can listen to these events by registering as the
2883 service dsdb_group_event.
2884 This is not needed for the audit logging described in log level.
2886 Instead, this should instead be considered a developer option (it
2888 assists in the Samba testsuite) rather than a facility for external
2889 auditing, as message delivery is not guaranteed (a feature that the
2890 testsuite works around).
2891 The Samba database events are also logged via the normal logging
2893 methods when the log level is set appropriately, say to
2894 dsdb_group_json_audit:5.
2895 Default: dsdb group change notification = no
2897 dsdb password event notification (G)
2899 When enabled, this option causes Samba (acting as an Active
2901 Directory Domain Controller) to stream password change and reset
2902 events across the internal message bus. Scripts built using Samba's
2903 python bindings can listen to these events by registering as the
2904 service password_event.
2905 This is not needed for the audit logging described in log level.
2907 Instead, this should instead be considered a developer option (it
2909 assists in the Samba testsuite) rather than a facility for external
2910 auditing, as message delivery is not guaranteed (a feature that the
2911 testsuite works around).
2912 The Samba database events are also logged via the normal logging
2914 methods when the log level is set appropriately, say to
2915 dsdb_password_json_audit:5.
2916 Default: dsdb password event notification = no
2918 durable handles (S)
2920 This boolean parameter controls whether Samba can grant SMB2
2922 durable file handles on a share.
2923 Note that durable handles are only enabled if kernel oplocks = no,
2925 kernel share modes = no, and posix locking = no, i.e. if the share
2926 is configured for CIFS/SMB2 only access, not supporting
2927 interoperability features with local UNIX processes or NFS
2928 operations.
2929 Also note that, for the time being, durability is not granted for a
2931 handle that has the delete on close flag set.
2932 Default: durable handles = yes
2934 ea support (S)
2936 This boolean parameter controls whether smbd(8) will allow clients
2938 to attempt to access extended attributes on a share. In order to
2939 enable this parameter on a setup with default VFS modules:
2940 • Samba must have been built with extended attributes
2942 support.
2943 • The underlying filesystem exposed by the share must
2945 support extended attributes (e.g. the getfattr(1) /
2946 setfattr(1) utilities must work).
2947 Note that the SMB protocol allows setting attributes whose value is
2949 64K bytes long, and that on NTFS, the maximum storage space for
2950 extended attributes per file is 64K. On most UNIX systems (Solaris
2951 and ZFS file system being the exception), the limits are much lower
2952 - typically 4K. Worse, the same 4K space is often used to store
2953 system metadata such as POSIX ACLs, or Samba's NT ACLs. Giving
2954 clients access to this tight space via extended attribute support
2955 could consume all of it by unsuspecting client applications, which
2956 would prevent changing system metadata due to lack of space. The
2957 default has changed to yes in Samba release 4.9.0 and above to
2958 allow better Windows fileserver compatibility in a default install.
2959 Default: ea support = yes
2961 elasticsearch:address (S)
2963 Specifies the name of the Elasticsearch server to use for Spotlight
2965 queries when using the Elasticsearch backend.
2966 Default: elasticsearch:address = localhost
2968 Example: elasticsearch:address = needle.haystack.samba.org
2970 elasticsearch:index (S)
2972 Specifies the name of the Elasticsearch index to use for Spotlight
2974 queries when using the Elasticsearch backend. The default value of
2975 "_all" is a special Elasticsearch value that performs the search
2976 operation on all indices.
2977 Default: elasticsearch:index = _all
2979 Example: elasticsearch:index = spotlight
2981 elasticsearch:mappings (G)
2983 Path to a file specifying metadata attribute mappings in JSON
2985 format. Use by the Elasticsearch backend of the Spotlight RPC
2986 service.
2987 Default: elasticsearch:mappings =
2989 /usr/share/samba/elasticsearch_mappings.json
2990 Example: elasticsearch:mappings = /usr/share/foo/mymappings.json
2992 elasticsearch:max results (S)
2994 Path to a file specifying metadata attribute mappings in JSON
2996 format. Used by the Elasticsearch backend of the Spotlight RPC
2997 service. A value of 0 means no limit.
2998 Default: elasticsearch:max results = 100
3000 Example: elasticsearch:max results = 10
3002 elasticsearch:port (S)
3004 Specifies the TCP port of the Elasticsearch server to use for
3006 Spotlight queries when using the Elasticsearch backend.
3007 Default: elasticsearch:port = 9200
3009 Example: elasticsearch:port = 9201
3011 elasticsearch:use tls (S)
3013 Specifies whether to use HTTPS when talking to the Elasticsearch
3015 server used for Spotlight queries when using the Elasticsearch
3016 backend.
3017 Default: elasticsearch:use tls = no
3019 Example: elasticsearch:use tls = yes
3021 enable asu support (G)
3023 Hosts running the "Advanced Server for Unix (ASU)" product require
3025 some special accommodations such as creating a builtin [ADMIN$]
3026 share that only supports IPC connections. The has been the default
3027 behavior in smbd for many years. However, certain Microsoft
3028 applications such as the Print Migrator tool require that the
3029 remote server support an [ADMIN$] file share. Disabling this
3030 parameter allows for creating an [ADMIN$] file share in smb.conf.
3031 Default: enable asu support = no
3033 enable core files (G)
3035 This parameter specifies whether core dumps should be written on
3037 internal exits. Normally set to yes. You should never need to
3038 change this.
3039 Default: enable core files = yes
3041 Example: enable core files = no
3043 enable privileges (G)
3045 This deprecated parameter controls whether or not smbd will honor
3047 privileges assigned to specific SIDs via either net rpc rights or
3048 one of the Windows user and group manager tools. This parameter is
3049 enabled by default. It can be disabled to prevent members of the
3050 Domain Admins group from being able to assign privileges to users
3051 or groups which can then result in certain smbd operations running
3052 as root that would normally run under the context of the connected
3053 user.
3054 An example of how privileges can be used is to assign the right to
3056 join clients to a Samba controlled domain without providing root
3057 access to the server via smbd.
3058 Please read the extended description provided in the Samba HOWTO
3060 documentation.
3061 Default: enable privileges = yes
3063 enable spoolss (G)
3065 Inverted synonym for disable spoolss.
3067 Default: enable spoolss = yes
3069 encrypt passwords (G)
3071 This parameter has been deprecated since Samba 4.11 and support for
3073 plaintext (as distinct from NTLM, NTLMv2 or Kerberos
3074 authentication) will be removed in a future Samba release.
3075 That is, in the future, the current default of encrypt passwords =
3077 yes will be the enforced behaviour.
3078 This boolean controls whether encrypted passwords will be
3080 negotiated with the client. Note that Windows NT 4.0 SP3 and above
3081 and also Windows 98 will by default expect encrypted passwords
3082 unless a registry entry is changed. To use encrypted passwords in
3083 Samba see the chapter "User Database" in the Samba HOWTO
3084 Collection.
3085 MS Windows clients that expect Microsoft encrypted passwords and
3087 that do not have plain text password support enabled will be able
3088 to connect only to a Samba server that has encrypted password
3089 support enabled and for which the user accounts have a valid
3090 encrypted password. Refer to the smbpasswd command man page for
3091 information regarding the creation of encrypted passwords for user
3092 accounts.
3093 The use of plain text passwords is NOT advised as support for this
3095 feature is no longer maintained in Microsoft Windows products. If
3096 you want to use plain text passwords you must set this parameter to
3097 no.
3098 In order for encrypted passwords to work correctly smbd(8) must
3100 either have access to a local smbpasswd(5) file (see the
3101 smbpasswd(8) program for information on how to set up and maintain
3102 this file), or set the security = [domain|ads] parameter which
3103 causes smbd to authenticate against another server.
3104 Default: encrypt passwords = yes
3106 enhanced browsing (G)
3108 This option enables a couple of enhancements to cross-subnet browse
3110 propagation that have been added in Samba but which are not
3111 standard in Microsoft implementations.
3112 The first enhancement to browse propagation consists of a regular
3114 wildcard query to a Samba WINS server for all Domain Master
3115 Browsers, followed by a browse synchronization with each of the
3116 returned DMBs. The second enhancement consists of a regular
3117 randomised browse synchronization with all currently known DMBs.
3118 You may wish to disable this option if you have a problem with
3120 empty workgroups not disappearing from browse lists. Due to the
3121 restrictions of the browse protocols, these enhancements can cause
3122 a empty workgroup to stay around forever which can be annoying.
3123 In general you should leave this option enabled as it makes
3125 cross-subnet browse propagation much more reliable.
3126 Default: enhanced browsing = yes
3128 enumports command (G)
3130 The concept of a "port" is fairly foreign to UNIX hosts. Under
3132 Windows NT/2000 print servers, a port is associated with a port
3133 monitor and generally takes the form of a local port (i.e. LPT1:,
3134 COM1:, FILE:) or a remote port (i.e. LPD Port Monitor, etc...). By
3135 default, Samba has only one port defined--"Samba Printer Port".
3136 Under Windows NT/2000, all printers must have a valid port name. If
3137 you wish to have a list of ports displayed (smbd does not use a
3138 port name for anything) other than the default "Samba Printer
3139 Port", you can define enumports command to point to a program which
3140 should generate a list of ports, one per line, to standard output.
3141 This listing will then be used in response to the level 1 and 2
3142 EnumPorts() RPC.
3143 Default: enumports command =
3145 Example: enumports command = /usr/bin/listports
3147 eventlog list (G)
3149 This option defines a list of log names that Samba will report to
3151 the Microsoft EventViewer utility. The listed eventlogs will be
3152 associated with tdb file on disk in the $(statedir)/eventlog.
3153 The administrator must use an external process to parse the normal
3155 Unix logs such as /var/log/messages and write then entries to the
3156 eventlog tdb files. Refer to the eventlogadm(8) utility for how to
3157 write eventlog entries.
3158 Default: eventlog list =
3160 Example: eventlog list = Security Application Syslog Apache
3162 fake directory create times (S)
3164 NTFS and Windows VFAT file systems keep a create time for all files
3166 and directories. This is not the same as the ctime - status change
3167 time - that Unix keeps, so Samba by default reports the earliest of
3168 the various times Unix does keep. Setting this parameter for a
3169 share causes Samba to always report midnight 1-1-1980 as the create
3170 time for directories.
3171 This option is mainly used as a compatibility option for Visual C++
3173 when used against Samba shares. Visual C++ generated makefiles have
3174 the object directory as a dependency for each object file, and a
3175 make rule to create the directory. Also, when NMAKE compares
3176 timestamps it uses the creation time when examining a directory.
3177 Thus the object directory will be created if it does not exist, but
3178 once it does exist it will always have an earlier timestamp than
3179 the object files it contains.
3180 However, Unix time semantics mean that the create time reported by
3182 Samba will be updated whenever a file is created or deleted in the
3183 directory. NMAKE finds all object files in the object directory.
3184 The timestamp of the last one built is then compared to the
3185 timestamp of the object directory. If the directory's timestamp if
3186 newer, then all object files will be rebuilt. Enabling this option
3187 ensures directories always predate their contents and an NMAKE
3188 build will proceed as expected.
3189 Default: fake directory create times = no
3191 fake oplocks (S)
3193 Oplocks are the way that SMB clients get permission from a server
3195 to locally cache file operations. If a server grants an oplock
3196 (opportunistic lock) then the client is free to assume that it is
3197 the only one accessing the file and it will aggressively cache file
3198 data. With some oplock types the client may even cache file
3199 open/close operations. This can give enormous performance benefits.
3200 When you set fake oplocks = yes, smbd(8) will always grant oplock
3202 requests no matter how many clients are using the file.
3203 It is generally much better to use the real oplocks support rather
3205 than this parameter.
3206 If you enable this option on all read-only shares or shares that
3208 you know will only be accessed from one client at a time such as
3209 physically read-only media like CDROMs, you will see a big
3210 performance improvement on many operations. If you enable this
3211 option on shares where multiple clients may be accessing the files
3212 read-write at the same time you can get data corruption. Use this
3213 option carefully!
3214 Default: fake oplocks = no
3216 follow symlinks (S)
3218 This parameter allows the Samba administrator to stop smbd(8) from
3220 following symbolic links in a particular share. Setting this
3221 parameter to no prevents any file or directory that is a symbolic
3222 link from being followed (the user will get an error). This option
3223 is very useful to stop users from adding a symbolic link to
3224 /etc/passwd in their home directory for instance. However it will
3225 slow filename lookups down slightly.
3226 This option is enabled (i.e. smbd will follow symbolic links) by
3228 default.
3229 Default: follow symlinks = yes
3231 smbd force process locks (S)
3233 This boolean option tells smbd whether to forcefully disable the
3235 use of Open File Description locks on Linux.
3236 This option should not be changed from the default unless you know
3238 what you're doing.
3239 Default: smbd force process locks = no
3241 force create mode (S)
3243 This parameter specifies a set of UNIX mode bit permissions that
3245 will always be set on a file created by Samba. This is done by
3246 bitwise 'OR'ing these bits onto the mode bits of a file that is
3247 being created. The default for this parameter is (in octal) 000.
3248 The modes in this parameter are bitwise 'OR'ed onto the file mode
3249 after the mask set in the create mask parameter is applied.
3250 The example below would force all newly created files to have read
3252 and execute permissions set for 'group' and 'other' as well as the
3253 read/write/execute bits set for the 'user'.
3254 Default: force create mode = 0000
3256 Example: force create mode = 0755
3258 force directory mode (S)
3260 This parameter specifies a set of UNIX mode bit permissions that
3262 will always be set on a directory created by Samba. This is done by
3263 bitwise 'OR'ing these bits onto the mode bits of a directory that
3264 is being created. The default for this parameter is (in octal) 0000
3265 which will not add any extra permission bits to a created
3266 directory. This operation is done after the mode mask in the
3267 parameter directory mask is applied.
3268 The example below would force all created directories to have read
3270 and execute permissions set for 'group' and 'other' as well as the
3271 read/write/execute bits set for the 'user'.
3272 Default: force directory mode = 0000
3274 Example: force directory mode = 0755
3276 force directory security mode (S)
3278 This parameter has been removed for Samba 4.0.0.
3280 No default
3282 group
3284 This parameter is a synonym for force group.
3286 force group (S)
3288 This specifies a UNIX group name that will be assigned as the
3290 default primary group for all users connecting to this service.
3291 This is useful for sharing files by ensuring that all access to
3292 files on service will use the named group for their permissions
3293 checking. Thus, by assigning permissions for this group to the
3294 files and directories within this service the Samba administrator
3295 can restrict or allow sharing of these files.
3296 In Samba 2.0.5 and above this parameter has extended functionality
3298 in the following way. If the group name listed here has a '+'
3299 character prepended to it then the current user accessing the share
3300 only has the primary group default assigned to this group if they
3301 are already assigned as a member of that group. This allows an
3302 administrator to decide that only users who are already in a
3303 particular group will create files with group ownership set to that
3304 group. This gives a finer granularity of ownership assignment. For
3305 example, the setting force group = +sys means that only users who
3306 are already in group sys will have their default primary group
3307 assigned to sys when accessing this Samba share. All other users
3308 will retain their ordinary primary group.
3309 If the force user parameter is also set the group specified in
3311 force group will override the primary group set in force user.
3312 Default: force group =
3314 Example: force group = agroup
3316 force printername (S)
3318 When printing from Windows NT (or later), each printer in smb.conf
3320 has two associated names which can be used by the client. The first
3321 is the sharename (or shortname) defined in smb.conf. This is the
3322 only printername available for use by Windows 9x clients. The
3323 second name associated with a printer can be seen when browsing to
3324 the "Printers" (or "Printers and Faxes") folder on the Samba
3325 server. This is referred to simply as the printername (not to be
3326 confused with the printer name option).
3327 When assigning a new driver to a printer on a remote Windows
3329 compatible print server such as Samba, the Windows client will
3330 rename the printer to match the driver name just uploaded. This can
3331 result in confusion for users when multiple printers are bound to
3332 the same driver. To prevent Samba from allowing the printer's
3333 printername to differ from the sharename defined in smb.conf, set
3334 force printername = yes.
3335 Be aware that enabling this parameter may affect migrating printers
3337 from a Windows server to Samba since Windows has no way to force
3338 the sharename and printername to match.
3339 It is recommended that this parameter's value not be changed once
3341 the printer is in use by clients as this could cause a user not be
3342 able to delete printer connections from their local Printers
3343 folder.
3344 Default: force printername = no
3346 force security mode (S)
3348 This parameter has been removed for Samba 4.0.0.
3350 No default
3352 force unknown acl user (S)
3354 If this parameter is set, a Windows NT ACL that contains an unknown
3356 SID (security descriptor, or representation of a user or group id)
3357 as the owner or group owner of the file will be silently mapped
3358 into the current UNIX uid or gid of the currently connected user.
3359 This is designed to allow Windows NT clients to copy files and
3361 folders containing ACLs that were created locally on the client
3362 machine and contain users local to that machine only (no domain
3363 users) to be copied to a Samba server (usually with XCOPY /O) and
3364 have the unknown userid and groupid of the file owner map to the
3365 current connected user. This can only be fixed correctly when
3366 winbindd allows arbitrary mapping from any Windows NT SID to a UNIX
3367 uid or gid.
3368 Try using this parameter when XCOPY /O gives an ACCESS_DENIED
3370 error.
3371 Default: force unknown acl user = no
3373 force user (S)
3375 This specifies a UNIX user name that will be assigned as the
3377 default user for all users connecting to this service. This is
3378 useful for sharing files. You should also use it carefully as using
3379 it incorrectly can cause security problems.
3380 This user name only gets used once a connection is established.
3382 Thus clients still need to connect as a valid user and supply a
3383 valid password. Once connected, all file operations will be
3384 performed as the "forced user", no matter what username the client
3385 connected as. This can be very useful.
3386 In Samba 2.0.5 and above this parameter also causes the primary
3388 group of the forced user to be used as the primary group for all
3389 file activity. Prior to 2.0.5 the primary group was left as the
3390 primary group of the connecting user (this was a bug).
3391 Default: force user =
3393 Example: force user = auser
3395 fss: prune stale (G)
3397 When enabled, Samba's File Server Remote VSS Protocol (FSRVP)
3399 server checks all FSRVP initiated snapshots on startup, and removes
3400 any corresponding state (including share definitions) for
3401 nonexistent snapshot paths.
3402 Default: fss: prune stale = no
3404 Example: fss: prune stale = yes
3406 fss: sequence timeout (G)
3408 The File Server Remote VSS Protocol (FSRVP) server includes a
3410 message sequence timer to ensure cleanup on unexpected client
3411 disconnect. This parameter overrides the default timeout between
3412 FSRVP operations. FSRVP timeouts can be completely disabled via a
3413 value of 0.
3414 Default: fss: sequence timeout = 180 or 1800, depending on
3416 operation
3417 Example: fss: sequence timeout = 0
3419 fstype (S)
3421 This parameter allows the administrator to configure the string
3423 that specifies the type of filesystem a share is using that is
3424 reported by smbd(8) when a client queries the filesystem type for a
3425 share. The default type is NTFS for compatibility with Windows NT
3426 but this can be changed to other strings such as Samba or FAT if
3427 required.
3428 Default: fstype = NTFS
3430 Example: fstype = Samba
3432 get quota command (G)
3434 The get quota command should only be used whenever there is no
3436 operating system API available from the OS that samba can use.
3437 This option is only available Samba was compiled with quotas
3439 support.
3440 This parameter should specify the path to a script that queries the
3442 quota information for the specified user/group for the partition
3443 that the specified directory is on.
3444 Such a script is being given 3 arguments:
3446 • directory
3448 • type of query
3450 • uid of user or gid of group
3452 The directory is actually mostly just "." - It needs to be treated
3454 relatively to the current working directory that the script can
3455 also query.
3456 The type of query can be one of:
3458 • 1 - user quotas
3460 • 2 - user default quotas (uid = -1)
3462 • 3 - group quotas
3464 • 4 - group default quotas (gid = -1)
3466 This script should print one line as output with spaces between the
3468 columns. The printed columns should be:
3469 • 1 - quota flags (0 = no quotas, 1 = quotas enabled, 2 =
3471 quotas enabled and enforced)
3472 • 2 - number of currently used blocks
3474 • 3 - the softlimit number of blocks
3476 • 4 - the hardlimit number of blocks
3478 • 5 - currently used number of inodes
3480 • 6 - the softlimit number of inodes
3482 • 7 - the hardlimit number of inodes
3484 • 8 (optional) - the number of bytes in a block(default is
3486 1024)
3487 Default: get quota command =
3489 Example: get quota command = /usr/local/sbin/query_quota
3491 getwd cache (G)
3493 This is a tuning option. When this is enabled a caching algorithm
3495 will be used to reduce the time taken for getwd() calls. This can
3496 have a significant impact on performance, especially when the wide
3497 links parameter is set to no.
3498 Default: getwd cache = yes
3500 gpo update command (G)
3502 This option sets the command that is called to apply GPO policies.
3504 The samba-gpupdate script applies System Access and Kerberos
3505 Policies to the KDC. System Access policies set minPwdAge,
3506 maxPwdAge, minPwdLength, and pwdProperties in the samdb. Kerberos
3507 Policies set kdc:service ticket lifetime, kdc:user ticket lifetime,
3508 and kdc:renewal lifetime in smb.conf.
3509 Default: gpo update command =
3511 /builddir/build/BUILD/samba-4.14.5/source4/scripting/bin/samba-gpupdate
3512 Example: gpo update command = /usr/local/sbin/gpoupdate
3514 guest account (G)
3516 This is a username which will be used for access to services which
3518 are specified as guest ok (see below). Whatever privileges this
3519 user has will be available to any client connecting to the guest
3520 service. This user must exist in the password file, but does not
3521 require a valid login. The user account "ftp" is often a good
3522 choice for this parameter.
3523 On some systems the default guest account "nobody" may not be able
3525 to print. Use another account in this case. You should test this by
3526 trying to log in as your guest user (perhaps by using the su -
3527 command) and trying to print using the system print command such as
3528 lpr(1) or lp(1).
3529 This parameter does not accept % macros, because many parts of the
3531 system require this value to be constant for correct operation.
3532 Default: guest account = nobody # default can be changed at
3534 compile-time
3535 Example: guest account = ftp
3537 public
3539 This parameter is a synonym for guest ok.
3541 guest ok (S)
3543 If this parameter is yes for a service, then no password is
3545 required to connect to the service. Privileges will be those of the
3546 guest account.
3547 This parameter nullifies the benefits of setting restrict anonymous
3549 = 2
3550 See the section below on security for more information about this
3552 option.
3553 Default: guest ok = no
3555 only guest
3557 This parameter is a synonym for guest only.
3559 guest only (S)
3561 If this parameter is yes for a service, then only guest connections
3563 to the service are permitted. This parameter will have no effect if
3564 guest ok is not set for the service.
3565 See the section below on security for more information about this
3567 option.
3568 Default: guest only = no
3570 hide dot files (S)
3572 This is a boolean parameter that controls whether files starting
3574 with a dot appear as hidden files.
3575 Default: hide dot files = yes
3577 hide files (S)
3579 This is a list of files or directories that are not visible but are
3581 accessible. The DOS 'hidden' attribute is applied to any files or
3582 directories that match.
3583 Each entry in the list must be separated by a '/', which allows
3585 spaces to be included in the entry. '*' and '?' can be used to
3586 specify multiple files or directories as in DOS wildcards.
3587 Each entry must be a Unix path, not a DOS path and must not include
3589 the Unix directory separator '/'.
3590 Note that the case sensitivity option is applicable in hiding
3592 files.
3593 Setting this parameter will affect the performance of Samba, as it
3595 will be forced to check all files and directories for a match as
3596 they are scanned.
3597 The example shown above is based on files that the Macintosh SMB
3599 client (DAVE) available from Thursby creates for internal use, and
3600 also still hides all files beginning with a dot.
3601 An example of us of this parameter is:
3603 hide files = /.*/DesktopFolderDB/TrashFor%m/resource.frk/
3605 Default: hide files = # no file are hidden
3607 hide new files timeout (S)
3609 Setting this parameter to something but 0 hides files that have
3611 been modified less than N seconds ago.
3612 It can be used for ingest/process queue style workloads. A
3614 processing application should only see files that are definitely
3615 finished. As many applications do not have proper external workflow
3616 control, this can be a way to make sure processing does not
3617 interfere with file ingest.
3618 Default: hide new files timeout = 0
3620 hide special files (S)
3622 This parameter prevents clients from seeing special files such as
3624 sockets, devices and fifo's in directory listings.
3625 Default: hide special files = no
3627 hide unreadable (S)
3629 This parameter prevents clients from seeing the existence of files
3631 that cannot be read. Defaults to off.
3632 Please note that enabling this can slow down listing large
3634 directories significantly. Samba has to evaluate the ACLs of all
3635 directory members, which can be a lot of effort.
3636 Default: hide unreadable = no
3638 hide unwriteable files (S)
3640 This parameter prevents clients from seeing the existence of files
3642 that cannot be written to. Defaults to off. Note that unwriteable
3643 directories are shown as usual.
3644 Please note that enabling this can slow down listing large
3646 directories significantly. Samba has to evaluate the ACLs of all
3647 directory members, which can be a lot of effort.
3648 Default: hide unwriteable files = no
3650 homedir map (G)
3652 If nis homedir is yes, and smbd(8) is also acting as a Win95/98
3654 logon server then this parameter specifies the NIS (or YP) map from
3655 which the server for the user's home directory should be extracted.
3656 At present, only the Sun auto.home map format is understood. The
3657 form of the map is:
3658 username server:/some/file/system
3660 and the program will extract the servername from before the first
3662 ':'. There should probably be a better parsing system that copes
3663 with different map formats and also Amd (another automounter) maps.
3664 Note
3666 A working NIS client is required on the system for this option
3667 to work.
3668 Default: homedir map =
3669 Example: homedir map = amd.homedir
3671 honor change notify privilege (S)
3673 This option can be used to make use of the change notify privilege.
3675 By default notify results are not checked against the file system
3676 permissions.
3677 If "honor change notify privilege" is enabled, a user will only
3679 receive notify results, if he has change notify privilege or
3680 sufficient file system permissions. If a user has the change notify
3681 privilege, he will receive all requested notify results, even if
3682 the user does not have the permissions on the file system.
3683 Default: honor change notify privilege = no
3685 host msdfs (G)
3687 If set to yes, Samba will act as a Dfs server, and allow Dfs-aware
3689 clients to browse Dfs trees hosted on the server.
3690 See also the msdfs root share level parameter. For more information
3692 on setting up a Dfs tree on Samba, refer to the MSFDS chapter in
3693 the book Samba3-HOWTO.
3694 Default: host msdfs = yes
3696 hostname lookups (G)
3698 Specifies whether samba should use (expensive) hostname lookups or
3700 use the ip addresses instead. An example place where hostname
3701 lookups are currently used is when checking the hosts deny and
3702 hosts allow.
3703 Default: hostname lookups = no
3705 Example: hostname lookups = yes
3707 allow hosts
3709 This parameter is a synonym for hosts allow.
3711 hosts allow (S)
3713 A synonym for this parameter is allow hosts.
3715 This parameter is a comma, space, or tab delimited set of hosts
3717 which are permitted to access a service.
3718 If specified in the [global] section then it will apply to all
3720 services, regardless of whether the individual service has a
3721 different setting.
3722 You can specify the hosts by name or IP number. For example, you
3724 could restrict access to only the hosts on a Class C subnet with
3725 something like allow hosts = 150.203.5.. The full syntax of the
3726 list is described in the man page hosts_access(5). Note that this
3727 man page may not be present on your system, so a brief description
3728 will be given here also.
3729 Note that the localhost address 127.0.0.1 will always be allowed
3731 access unless specifically denied by a hosts deny option.
3732 You can also specify hosts by network/netmask pairs and by netgroup
3734 names if your system supports netgroups. The EXCEPT keyword can
3735 also be used to limit a wildcard list. The following examples may
3736 provide some help:
3737 Example 1: allow all IPs in 150.203.*.*; except one
3739 hosts allow = 150.203. EXCEPT 150.203.6.66
3741 Example 2: allow hosts that match the given network/netmask
3743 hosts allow = 150.203.15.0/255.255.255.0
3745 Example 3: allow a couple of hosts
3747 hosts allow = lapland, arvidsjaur
3749 Example 4: allow only hosts in NIS netgroup "foonet", but deny
3751 access from one particular host
3752 hosts allow = @foonet
3754 hosts deny = pirate
3756 Note
3758 Note that access still requires suitable user-level passwords.
3759 See testparm(1) for a way of testing your host access to see if it
3760 does what you expect.
3761 Default: hosts allow = # none (i.e., all hosts permitted access)
3763 Example: hosts allow = 150.203.5. myhost.mynet.edu.au
3765 deny hosts
3767 This parameter is a synonym for hosts deny.
3769 hosts deny (S)
3771 The opposite of hosts allow - hosts listed here are NOT permitted
3773 access to services unless the specific services have their own
3774 lists to override this one. Where the lists conflict, the allow
3775 list takes precedence.
3776 In the event that it is necessary to deny all by default, use the
3778 keyword ALL (or the netmask 0.0.0.0/0) and then explicitly specify
3779 to the hosts allow = hosts allow parameter those hosts that should
3780 be permitted access.
3781 Default: hosts deny = # none (i.e., no hosts specifically
3783 excluded)
3784 Example: hosts deny = 150.203.4. badhost.mynet.edu.au
3786 idmap backend (G)
3788 The idmap backend provides a plugin interface for Winbind to use
3790 varying backends to store SID/uid/gid mapping tables.
3791 This option specifies the default backend that is used when no
3793 special configuration set, but it is now deprecated in favour of
3794 the new spelling idmap config * : backend.
3795 Default: idmap backend = tdb
3797 idmap cache time (G)
3799 This parameter specifies the number of seconds that Winbind's idmap
3801 interface will cache positive SID/uid/gid query results. By
3802 default, Samba will cache these results for one week.
3803 Default: idmap cache time = 604800
3805 idmap config DOMAIN : OPTION (G)
3807 ID mapping in Samba is the mapping between Windows SIDs and Unix
3809 user and group IDs. This is performed by Winbindd with a
3810 configurable plugin interface. Samba's ID mapping is configured by
3811 options starting with the idmap config prefix. An idmap option
3812 consists of the idmap config prefix, followed by a domain name or
3813 the asterisk character (*), a colon, and the name of an idmap
3814 setting for the chosen domain.
3815 The idmap configuration is hence divided into groups, one group for
3817 each domain to be configured, and one group with the asterisk
3818 instead of a proper domain name, which specifies the default
3819 configuration that is used to catch all domains that do not have an
3820 explicit idmap configuration of their own.
3821 There are three general options available:
3823 backend = backend_name
3825 This specifies the name of the idmap plugin to use as the
3826 SID/uid/gid backend for this domain. The standard backends are
3827 tdb (idmap_tdb(8)), tdb2 (idmap_tdb2(8)), ldap (idmap_ldap(8)),
3828 rid (idmap_rid(8)), hash (idmap_hash(8)), autorid
3829 (idmap_autorid(8)), ad (idmap_ad(8)) and nss (idmap_nss(8)).
3830 The corresponding manual pages contain the details, but here is
3831 a summary.
3832 The first three of these create mappings of their own using
3834 internal unixid counters and store the mappings in a database.
3835 These are suitable for use in the default idmap configuration.
3836 The rid and hash backends use a pure algorithmic calculation to
3837 determine the unixid for a SID. The autorid module is a mixture
3838 of the tdb and rid backend. It creates ranges for each domain
3839 encountered and then uses the rid algorithm for each of these
3840 automatically configured domains individually. The ad backend
3841 uses unix ids stored in Active Directory via the standard
3842 schema extensions. The nss backend reverses the standard
3843 winbindd setup and gets the unix ids via names from nsswitch
3844 which can be useful in an ldap setup.
3845 range = low - high
3847 Defines the available matching uid and gid range for which the
3848 backend is authoritative. For allocating backends, this also
3849 defines the start and the end of the range for allocating new
3850 unique IDs.
3851 winbind uses this parameter to find the backend that is
3853 authoritative for a unix ID to SID mapping, so it must be set
3854 for each individually configured domain and for the default
3855 configuration. The configured ranges must be mutually disjoint.
3856 read only = yes|no
3858 This option can be used to turn the writing backends tdb, tdb2,
3859 and ldap into read only mode. This can be useful e.g. in cases
3860 where a pre-filled database exists that should not be extended
3861 automatically.
3862 The following example illustrates how to configure the idmap_ad(8)
3864 backend for the CORP domain and the idmap_tdb(8) backend for all
3865 other domains. This configuration assumes that the admin of CORP
3866 assigns unix ids below 1000000 via the SFU extensions, and winbind
3867 is supposed to use the next million entries for its own mappings
3868 from trusted domains and for local groups for example.
3869 idmap config * : backend = tdb
3871 idmap config * : range = 1000000-1999999
3872 idmap config CORP : backend = ad
3874 idmap config CORP : range = 1000-999999
3875 No default
3878 winbind gid
3880 This parameter is a synonym for idmap gid.
3882 idmap gid (G)
3884 The idmap gid parameter specifies the range of group ids for the
3886 default idmap configuration. It is now deprecated in favour of
3887 idmap config * : range.
3888 See the idmap config option.
3890 Default: idmap gid =
3892 Example: idmap gid = 10000-20000
3894 idmap negative cache time (G)
3896 This parameter specifies the number of seconds that Winbind's idmap
3898 interface will cache negative SID/uid/gid query results.
3899 Default: idmap negative cache time = 120
3901 winbind uid
3903 This parameter is a synonym for idmap uid.
3905 idmap uid (G)
3907 The idmap uid parameter specifies the range of user ids for the
3909 default idmap configuration. It is now deprecated in favour of
3910 idmap config * : range.
3911 See the idmap config option.
3913 Default: idmap uid =
3915 Example: idmap uid = 10000-20000
3917 include (S)
3919 This allows you to include one config file inside another. The file
3921 is included literally, as though typed in place.
3922 It takes the standard substitutions, except %u, %P and %S.
3924 The parameter include = registry has a special meaning: It does not
3926 include a file named registry from the current working directory,
3927 but instead reads the global configuration options from the
3928 registry. See the section on registry-based configuration for
3929 details. Note that this option automatically activates registry
3930 shares.
3931 Default: include =
3933 Example: include = /usr/local/samba/lib/admin_smb.conf
3935 include system krb5 conf (G)
3937 Setting this parameter to no will prevent winbind to include the
3939 system /etc/krb5.conf file into the krb5.conf file it creates. See
3940 also create krb5 conf. This option only applies to Samba built with
3941 MIT Kerberos.
3942 Default: include system krb5 conf = yes
3944 inherit acls (S)
3946 This parameter can be used to ensure that if default acls exist on
3948 parent directories, they are always honored when creating a new
3949 file or subdirectory in these parent directories. The default
3950 behavior is to use the unix mode specified when creating the
3951 directory. Enabling this option sets the unix mode to 0777, thus
3952 guaranteeing that default directory acls are propagated. Note that
3953 using the VFS modules acl_xattr or acl_tdb which store native
3954 Windows as meta-data will automatically turn this option on for any
3955 share for which they are loaded, as they require this option to
3956 emulate Windows ACLs correctly.
3957 Default: inherit acls = no
3959 inherit owner (S)
3961 The ownership of new files and directories is normally governed by
3963 effective uid of the connected user. This option allows the Samba
3964 administrator to specify that the ownership for new files and
3965 directories should be controlled by the ownership of the parent
3966 directory.
3967 Valid options are:
3969 • no - Both the Windows (SID) owner and the UNIX (uid)
3971 owner of the file are governed by the identity of the
3972 user that created the file.
3973 • windows and unix - The Windows (SID) owner and the UNIX
3975 (uid) owner of new files and directories are set to the
3976 respective owner of the parent directory.
3977 • yes - a synonym for windows and unix.
3979 • unix only - Only the UNIX owner is set to the UNIX owner
3981 of the parent directory.
3982 Common scenarios where this behavior is useful is in implementing
3984 drop-boxes, where users can create and edit files but not delete
3985 them and ensuring that newly created files in a user's roaming
3986 profile directory are actually owned by the user.
3987 The unix only option effectively breaks the tie between the Windows
3989 owner of a file and the UNIX owner. As a logical consequence, in
3990 this mode, setting the the Windows owner of a file does not modify
3991 the UNIX owner. Using this mode should typically be combined with a
3992 backing store that can emulate the full NT ACL model without
3993 affecting the POSIX permissions, such as the acl_xattr VFS module,
3994 coupled with acl_xattr:ignore system acls = yes. This can be used
3995 to emulate folder quotas, when files are exposed only via SMB
3996 (without UNIX extensions). The UNIX owner of a directory is locally
3997 set and inherited by all subdirectories and files, and they all
3998 consume the same quota.
3999 Default: inherit owner = no
4001 inherit permissions (S)
4003 The permissions on new files and directories are normally governed
4005 by create mask, directory mask, force create mode and force
4006 directory mode but the boolean inherit permissions parameter
4007 overrides this.
4008 New directories inherit the mode of the parent directory, including
4010 bits such as setgid.
4011 New files inherit their read/write bits from the parent directory.
4013 Their execute bits continue to be determined by map archive, map
4014 hidden and map system as usual.
4015 Note that the setuid bit is never set via inheritance (the code
4017 explicitly prohibits this).
4018 This can be particularly useful on large systems with many users,
4020 perhaps several thousand, to allow a single [homes] share to be
4021 used flexibly by each user.
4022 Default: inherit permissions = no
4024 init logon delay (G)
4026 This parameter specifies a delay in milliseconds for the hosts
4028 configured for delayed initial samlogon with init logon delayed
4029 hosts.
4030 Default: init logon delay = 100
4032 init logon delayed hosts (G)
4034 This parameter takes a list of host names, addresses or networks
4036 for which the initial samlogon reply should be delayed (so other
4037 DCs get preferred by XP workstations if there are any).
4038 The length of the delay can be specified with the init logon delay
4040 parameter.
4041 Default: init logon delayed hosts =
4043 Example: init logon delayed hosts = 150.203.5. myhost.mynet.de
4045 interfaces (G)
4047 This option allows you to override the default network interfaces
4049 list that Samba will use for browsing, name registration and other
4050 NetBIOS over TCP/IP (NBT) traffic. By default Samba will query the
4051 kernel for the list of all active interfaces and use any interfaces
4052 except 127.0.0.1 that are broadcast capable.
4053 The option takes a list of interface strings. Each string can be in
4055 any of the following forms:
4056 • a network interface name (such as eth0). This may
4058 include shell-like wildcards so eth* will match any
4059 interface starting with the substring "eth"
4060 • an IP address. In this case the netmask is determined
4062 from the list of interfaces obtained from the kernel
4063 • an IP/mask pair.
4065 • a broadcast/mask pair.
4067 The "mask" parameters can either be a bit length (such as 24 for a
4069 C class network) or a full netmask in dotted decimal form.
4070 The "IP" parameters above can either be a full dotted decimal IP
4072 address or a hostname which will be looked up via the OS's normal
4073 hostname resolution mechanisms.
4074 By default Samba enables all active interfaces that are broadcast
4076 capable except the loopback adaptor (IP address 127.0.0.1).
4077 In order to support SMB3 multi-channel configurations, smbd
4079 understands some extra parameters which can be appended after the
4080 actual interface with this extended syntax (note that the quoting
4081 is important in order to handle the ; and , characters):
4082 "interface[;key1=value1[,key2=value2[...]]]"
4084 Known keys are speed, capability, and if_index. Speed is specified
4086 in bits per second. Known capabilities are RSS and RDMA. The
4087 if_index should be used with care: the values must not coincide
4088 with indexes used by the kernel. Note that these options are mainly
4089 intended for testing and development rather than for production
4090 use. At least on Linux systems, these values should be
4091 auto-detected, but the settings can serve as last a resort when
4092 autodetection is not working or is not available. The specified
4093 values overwrite the auto-detected values.
4094 The first two example below configures three network interfaces
4096 corresponding to the eth0 device and IP addresses 192.168.2.10 and
4097 192.168.3.10. The netmasks of the latter two interfaces would be
4098 set to 255.255.255.0.
4099 The other examples show how per interface extra parameters can be
4101 specified. Notice the possible usage of "," and ";", which makes
4102 the double quoting necessary.
4103 Default: interfaces =
4105 Example: interfaces = eth0 192.168.2.10/24
4107 192.168.3.10/255.255.255.0
4108 Example: interfaces = eth0, 192.168.2.10/24;
4110 192.168.3.10/255.255.255.0
4111 Example: interfaces =
4113 "eth0;if_index=65,speed=1000000000,capability=RSS"
4114 Example: interfaces = "lo;speed=1000000000" "eth0;capability=RSS"
4116 Example: interfaces = "lo;speed=1000000000" , "eth0;capability=RSS"
4118 Example: interfaces = "eth0;capability=RSS" ,
4120 "rdma1;capability=RDMA" ; "rdma2;capability=RSS,capability=RDMA"
4121 invalid users (S)
4123 This is a list of users that should not be allowed to login to this
4125 service. This is really a paranoid check to absolutely ensure an
4126 improper setting does not breach your security.
4127 A name starting with a '@' is interpreted as an NIS netgroup first
4129 (if your system supports NIS), and then as a UNIX group if the name
4130 was not found in the NIS netgroup database.
4131 A name starting with '+' is interpreted only by looking in the UNIX
4133 group database via the NSS getgrnam() interface. A name starting
4134 with '&' is interpreted only by looking in the NIS netgroup
4135 database (this requires NIS to be working on your system). The
4136 characters '+' and '&' may be used at the start of the name in
4137 either order so the value +&group means check the UNIX group
4138 database, followed by the NIS netgroup database, and the value
4139 &+group means check the NIS netgroup database, followed by the UNIX
4140 group database (the same as the '@' prefix).
4141 The current servicename is substituted for %S. This is useful in
4143 the [homes] section.
4144 Default: invalid users = # no invalid users
4146 Example: invalid users = root fred admin @wheel
4148 iprint server (G)
4150 This parameter is only applicable if printing is set to iprint.
4152 If set, this option overrides the ServerName option in the CUPS
4154 client.conf. This is necessary if you have virtual samba servers
4155 that connect to different CUPS daemons.
4156 Default: iprint server = ""
4158 Example: iprint server = MYCUPSSERVER
4160 keepalive (G)
4162 The value of the parameter (an integer) represents the number of
4164 seconds between keepalive packets. If this parameter is zero, no
4165 keepalive packets will be sent. Keepalive packets, if sent, allow
4166 the server to tell whether a client is still present and
4167 responding.
4168 Keepalives should, in general, not be needed if the socket has the
4170 SO_KEEPALIVE attribute set on it by default. (see socket options).
4171 Basically you should only use this option if you strike
4172 difficulties.
4173 Please note this option only applies to SMB1 client connections,
4175 and has no effect on SMB2 clients.
4176 Default: keepalive = 300
4178 Example: keepalive = 600
4180 kerberos encryption types (G)
4182 This parameter determines the encryption types to use when
4184 operating as a Kerberos client. Possible values are all, strong,
4185 and legacy.
4186 Samba uses a Kerberos library (MIT or Heimdal) to obtain Kerberos
4188 tickets. This library is normally configured outside of Samba,
4189 using the krb5.conf file. This file may also include directives to
4190 configure the encryption types to be used. However, Samba
4191 implements Active Directory protocols and algorithms to locate a
4192 domain controller. In order to force the Kerberos library into
4193 using the correct domain controller, some Samba processes, such as
4194 winbindd(8) and net(8), build a private krb5.conf file for use by
4195 the Kerberos library while being invoked from Samba. This private
4196 file controls all aspects of the Kerberos library operation, and
4197 this parameter controls how the encryption types are configured
4198 within this generated file, and therefore also controls the
4199 encryption types negotiable by Samba.
4200 When set to all, all active directory encryption types are allowed.
4202 When set to strong, only AES-based encryption types are offered.
4204 This can be used in hardened environments to prevent downgrade
4205 attacks.
4206 When set to legacy, only RC4-HMAC-MD5 is allowed. Avoiding AES this
4208 way has one a very specific use. Normally, the encryption type is
4209 negotiated between the peers. However, there is one scenario in
4210 which a Windows read-only domain controller (RODC) advertises AES
4211 encryption, but then proxies the request to a writeable DC which
4212 may not support AES encryption, leading to failure of the
4213 handshake. Setting this parameter to legacy would cause samba not
4214 to negotiate AES encryption. It is assumed of course that the
4215 weaker legacy encryption types are acceptable for the setup.
4216 Default: kerberos encryption types = all
4218 kerberos method (G)
4220 Controls how kerberos tickets are verified.
4222 Valid options are:
4224 • secrets only - use only the secrets.tdb for ticket
4226 verification (default)
4227 • system keytab - use only the system keytab for ticket
4229 verification
4230 • dedicated keytab - use a dedicated keytab for ticket
4232 verification
4233 • secrets and keytab - use the secrets.tdb first, then the
4235 system keytab
4236 The major difference between "system keytab" and "dedicated keytab"
4238 is that the latter method relies on kerberos to find the correct
4239 keytab entry instead of filtering based on expected principals.
4240 When the kerberos method is in "dedicated keytab" mode, dedicated
4242 keytab file must be set to specify the location of the keytab file.
4243 Default: kerberos method = default
4245 kernel change notify (G)
4247 This parameter specifies whether Samba should ask the kernel for
4249 change notifications in directories so that SMB clients can refresh
4250 whenever the data on the server changes.
4251 This parameter is only used when your kernel supports change
4253 notification to user programs using the inotify interface.
4254 Default: kernel change notify = yes
4256 kernel oplocks (S)
4258 For UNIXes that support kernel based oplocks (currently only
4260 Linux), this parameter allows the use of them to be turned on or
4261 off. However, this disables Level II oplocks for clients as the
4262 Linux kernel does not support them properly.
4263 Kernel oplocks support allows Samba oplocks to be broken whenever a
4265 local UNIX process or NFS operation accesses a file that smbd(8)
4266 has oplocked. This allows complete data consistency between
4267 SMB/CIFS, NFS and local file access (and is a very cool feature
4268 :-).
4269 If you do not need this interaction, you should disable the
4271 parameter on Linux to get Level II oplocks and the associated
4272 performance benefit.
4273 This parameter defaults to no and is translated to a no-op on
4275 systems that do not have the necessary kernel support.
4276 Default: kernel oplocks = no
4278 kernel share modes (S)
4280 This parameter controls whether SMB share modes are translated into
4282 UNIX flocks.
4283 Kernel share modes provide a minimal level of interoperability with
4285 local UNIX processes and NFS operations by preventing access with
4286 flocks corresponding to the SMB share modes. Generally, it is very
4287 desirable to leave this enabled.
4288 Note that in order to use SMB2 durable file handles on a share, you
4290 have to turn kernel share modes off.
4291 This parameter defaults to yes and is translated to a no-op on
4293 systems that do not have the necessary kernel flock support.
4294 Default: kernel share modes = yes
4296 kpasswd port (G)
4298 Specifies which ports the Kerberos server should listen on for
4300 password changes.
4301 Default: kpasswd port = 464
4303 krb5 port (G)
4305 Specifies which port the KDC should listen on for Kerberos traffic.
4307 Default: krb5 port = 88
4309 lanman auth (G)
4311 This parameter has been deprecated since Samba 4.11 and support for
4313 LanMan (as distinct from NTLM, NTLMv2 or Kerberos authentication)
4314 will be removed in a future Samba release.
4315 That is, in the future, the current default of lanman auth = no
4317 will be the enforced behaviour.
4318 This parameter determines whether or not smbd(8) will attempt to
4320 authenticate users or permit password changes using the LANMAN
4321 password hash. If disabled, only clients which support NT password
4322 hashes (e.g. Windows NT/2000 clients, smbclient, but not Windows
4323 95/98 or the MS DOS network client) will be able to connect to the
4324 Samba host.
4325 The LANMAN encrypted response is easily broken, due to its
4327 case-insensitive nature, and the choice of algorithm. Servers
4328 without Windows 95/98/ME or MS DOS clients are advised to disable
4329 this option.
4330 When this parameter is set to no this will also result in
4332 sambaLMPassword in Samba's passdb being blanked after the next
4333 password change. As a result of that lanman clients won't be able
4334 to authenticate, even if lanman auth is re-enabled later on.
4335 Unlike the encrypt passwords option, this parameter cannot alter
4337 client behaviour, and the LANMAN response will still be sent over
4338 the network. See the client lanman auth to disable this for Samba's
4339 clients (such as smbclient)
4340 This parameter is overridden by ntlm auth, so unless that it is
4342 also set to ntlmv1-permitted or yes, then only NTLMv2 logins will
4343 be permitted and no LM hash will be stored. All modern clients
4344 support NTLMv2, and but some older clients require special
4345 configuration to use it.
4346 Default: lanman auth = no
4348 large readwrite (G)
4350 This parameter determines whether or not smbd(8) supports the new
4352 64k streaming read and write variant SMB requests introduced with
4353 Windows 2000. Note that due to Windows 2000 client redirector bugs
4354 this requires Samba to be running on a 64-bit capable operating
4355 system such as IRIX, Solaris or a Linux 2.4 kernel. Can improve
4356 performance by 10% with Windows 2000 clients. Defaults to on. Not
4357 as tested as some other Samba code paths.
4358 Default: large readwrite = yes
4360 ldap admin dn (G)
4362 The ldap admin dn defines the Distinguished Name (DN) name used by
4364 Samba to contact the ldap server when retrieving user account
4365 information. The ldap admin dn is used in conjunction with the
4366 admin dn password stored in the private/secrets.tdb file. See the
4367 smbpasswd(8) man page for more information on how to accomplish
4368 this.
4369 The ldap admin dn requires a fully specified DN. The ldap suffix is
4371 not appended to the ldap admin dn.
4372 No default
4374 ldap connection timeout (G)
4376 This parameter tells the LDAP library calls which timeout in
4378 seconds they should honor during initial connection establishments
4379 to LDAP servers. It is very useful in failover scenarios in
4380 particular. If one or more LDAP servers are not reachable at all,
4381 we do not have to wait until TCP timeouts are over. This feature
4382 must be supported by your LDAP library.
4383 This parameter is different from ldap timeout which affects
4385 operations on LDAP servers using an existing connection and not
4386 establishing an initial connection.
4387 Default: ldap connection timeout = 2
4389 ldap debug level (G)
4391 This parameter controls the debug level of the LDAP library calls.
4393 In the case of OpenLDAP, it is the same bit-field as understood by
4394 the server and documented in the slapd.conf(5) manpage. A typical
4395 useful value will be 1 for tracing function calls.
4396 The debug output from the LDAP libraries appears with the prefix
4398 [LDAP] in Samba's logging output. The level at which LDAP logging
4399 is printed is controlled by the parameter ldap debug threshold.
4400 Default: ldap debug level = 0
4402 Example: ldap debug level = 1
4404 ldap debug threshold (G)
4406 This parameter controls the Samba debug level at which the ldap
4408 library debug output is printed in the Samba logs. See the
4409 description of ldap debug level for details.
4410 Default: ldap debug threshold = 10
4412 Example: ldap debug threshold = 5
4414 ldap delete dn (G)
4416 This parameter specifies whether a delete operation in the ldapsam
4418 deletes the complete entry or only the attributes specific to
4419 Samba.
4420 Default: ldap delete dn = no
4422 ldap deref (G)
4424 This option controls whether Samba should tell the LDAP library to
4426 use a certain alias dereferencing method. The default is auto,
4427 which means that the default setting of the ldap client library
4428 will be kept. Other possible values are never, finding, searching
4429 and always. Grab your LDAP manual for more information.
4430 Default: ldap deref = auto
4432 Example: ldap deref = searching
4434 ldap follow referral (G)
4436 This option controls whether to follow LDAP referrals or not when
4438 searching for entries in the LDAP database. Possible values are on
4439 to enable following referrals, off to disable this, and auto, to
4440 use the libldap default settings. libldap's choice of following
4441 referrals or not is set in /etc/openldap/ldap.conf with the
4442 REFERRALS parameter as documented in ldap.conf(5).
4443 Default: ldap follow referral = auto
4445 Example: ldap follow referral = off
4447 ldap group suffix (G)
4449 This parameter specifies the suffix that is used for groups when
4451 these are added to the LDAP directory. If this parameter is unset,
4452 the value of ldap suffix will be used instead. The suffix string is
4453 pre-pended to the ldap suffix string so use a partial DN.
4454 Default: ldap group suffix =
4456 Example: ldap group suffix = ou=Groups
4458 ldap idmap suffix (G)
4460 This parameters specifies the suffix that is used when storing
4462 idmap mappings. If this parameter is unset, the value of ldap
4463 suffix will be used instead. The suffix string is pre-pended to the
4464 ldap suffix string so use a partial DN.
4465 Default: ldap idmap suffix =
4467 Example: ldap idmap suffix = ou=Idmap
4469 ldap machine suffix (G)
4471 It specifies where machines should be added to the ldap tree. If
4473 this parameter is unset, the value of ldap suffix will be used
4474 instead. The suffix string is pre-pended to the ldap suffix string
4475 so use a partial DN.
4476 Default: ldap machine suffix =
4478 Example: ldap machine suffix = ou=Computers
4480 ldap max anonymous request size (G)
4482 This parameter specifies the maximum permitted size (in bytes) for
4484 an LDAP request received on an anonymous connection.
4485 If the request size exceeds this limit the request will be
4487 rejected.
4488 Default: ldap max anonymous request size = 256000
4490 Example: ldap max anonymous request size = 500000
4492 ldap max authenticated request size (G)
4494 This parameter specifies the maximum permitted size (in bytes) for
4496 an LDAP request received on an authenticated connection.
4497 If the request size exceeds this limit the request will be
4499 rejected.
4500 Default: ldap max authenticated request size = 16777216
4502 Example: ldap max authenticated request size = 4194304
4504 ldap max search request size (G)
4506 This parameter specifies the maximum permitted size (in bytes) for
4508 an LDAP search request.
4509 If the request size exceeds this limit the request will be
4511 rejected.
4512 Default: ldap max search request size = 256000
4514 Example: ldap max search request size = 4194304
4516 ldap page size (G)
4518 This parameter specifies the number of entries per page.
4520 If the LDAP server supports paged results, clients can request
4522 subsets of search results (pages) instead of the entire list. This
4523 parameter specifies the size of these pages.
4524 Default: ldap page size = 1000
4526 Example: ldap page size = 512
4528 ldap password sync
4530 This parameter is a synonym for ldap passwd sync.
4532 ldap passwd sync (G)
4534 This option is used to define whether or not Samba should sync the
4536 LDAP password with the NT and LM hashes for normal accounts (NOT
4537 for workstation, server or domain trusts) on a password change via
4538 SAMBA.
4539 The ldap passwd sync can be set to one of three values:
4541 • Yes = Try to update the LDAP, NT and LM passwords and
4543 update the pwdLastSet time.
4544 • No = Update NT and LM passwords and update the
4546 pwdLastSet time.
4547 • Only = Only update the LDAP password and let the LDAP
4549 server do the rest.
4550 Default: ldap passwd sync = no
4552 ldap replication sleep (G)
4554 When Samba is asked to write to a read-only LDAP replica, we are
4556 redirected to talk to the read-write master server. This server
4557 then replicates our changes back to the 'local' server, however the
4558 replication might take some seconds, especially over slow links.
4559 Certain client activities, particularly domain joins, can become
4560 confused by the 'success' that does not immediately change the LDAP
4561 back-end's data.
4562 This option simply causes Samba to wait a short time, to allow the
4564 LDAP server to catch up. If you have a particularly high-latency
4565 network, you may wish to time the LDAP replication with a network
4566 sniffer, and increase this value accordingly. Be aware that no
4567 checking is performed that the data has actually replicated.
4568 The value is specified in milliseconds, the maximum value is 5000
4570 (5 seconds).
4571 Default: ldap replication sleep = 1000
4573 ldapsam:editposix (G)
4575 Editposix is an option that leverages ldapsam:trusted to make it
4577 simpler to manage a domain controller eliminating the need to set
4578 up custom scripts to add and manage the posix users and groups.
4579 This option will instead directly manipulate the ldap tree to
4580 create, remove and modify user and group entries. This option also
4581 requires a running winbindd as it is used to allocate new uids/gids
4582 on user/group creation. The allocation range must be therefore
4583 configured.
4584 To use this option, a basic ldap tree must be provided and the ldap
4586 suffix parameters must be properly configured. On virgin servers
4587 the default users and groups (Administrator, Guest, Domain Users,
4588 Domain Admins, Domain Guests) can be precreated with the command
4589 net sam provision. To run this command the ldap server must be
4590 running, Winbindd must be running and the smb.conf ldap options
4591 must be properly configured. The typical ldap setup used with the
4592 ldapsam:trusted = yes option is usually sufficient to use
4593 ldapsam:editposix = yes as well.
4594 An example configuration can be the following:
4596 encrypt passwords = true
4598 passdb backend = ldapsam
4599 ldapsam:trusted=yes
4601 ldapsam:editposix=yes
4602 ldap admin dn = cn=admin,dc=samba,dc=org
4604 ldap delete dn = yes
4605 ldap group suffix = ou=groups
4606 ldap idmap suffix = ou=idmap
4607 ldap machine suffix = ou=computers
4608 ldap user suffix = ou=users
4609 ldap suffix = dc=samba,dc=org
4610 idmap backend = ldap:"ldap://localhost"
4612 idmap uid = 5000-50000
4614 idmap gid = 5000-50000
4615 This configuration assumes a directory layout like described in the
4618 following ldif:
4619 dn: dc=samba,dc=org
4621 objectClass: top
4622 objectClass: dcObject
4623 objectClass: organization
4624 o: samba.org
4625 dc: samba
4626 dn: cn=admin,dc=samba,dc=org
4628 objectClass: simpleSecurityObject
4629 objectClass: organizationalRole
4630 cn: admin
4631 description: LDAP administrator
4632 userPassword: secret
4633 dn: ou=users,dc=samba,dc=org
4635 objectClass: top
4636 objectClass: organizationalUnit
4637 ou: users
4638 dn: ou=groups,dc=samba,dc=org
4640 objectClass: top
4641 objectClass: organizationalUnit
4642 ou: groups
4643 dn: ou=idmap,dc=samba,dc=org
4645 objectClass: top
4646 objectClass: organizationalUnit
4647 ou: idmap
4648 dn: ou=computers,dc=samba,dc=org
4650 objectClass: top
4651 objectClass: organizationalUnit
4652 ou: computers
4653 Default: ldapsam:editposix = no
4656 ldapsam:trusted (G)
4658 By default, Samba as a Domain Controller with an LDAP backend needs
4660 to use the Unix-style NSS subsystem to access user and group
4661 information. Due to the way Unix stores user information in
4662 /etc/passwd and /etc/group this inevitably leads to inefficiencies.
4663 One important question a user needs to know is the list of groups
4664 he is member of. The plain UNIX model involves a complete
4665 enumeration of the file /etc/group and its NSS counterparts in
4666 LDAP. UNIX has optimized functions to enumerate group membership.
4667 Sadly, other functions that are used to deal with user and group
4668 attributes lack such optimization.
4669 To make Samba scale well in large environments, the ldapsam:trusted
4671 = yes option assumes that the complete user and group database that
4672 is relevant to Samba is stored in LDAP with the standard
4673 posixAccount/posixGroup attributes. It further assumes that the
4674 Samba auxiliary object classes are stored together with the POSIX
4675 data in the same LDAP object. If these assumptions are met,
4676 ldapsam:trusted = yes can be activated and Samba can bypass the NSS
4677 system to query user group memberships. Optimized LDAP queries can
4678 greatly speed up domain logon and administration tasks. Depending
4679 on the size of the LDAP database a factor of 100 or more for common
4680 queries is easily achieved.
4681 Default: ldapsam:trusted = no
4683 ldap server require strong auth (G)
4685 The ldap server require strong auth defines whether the ldap server
4687 requires ldap traffic to be signed or signed and encrypted
4688 (sealed). Possible values are no, allow_sasl_over_tls and yes.
4689 A value of no allows simple and sasl binds over all transports.
4691 A value of allow_sasl_over_tls allows simple and sasl binds
4693 (without sign or seal) over TLS encrypted connections. Unencrypted
4694 connections only allow sasl binds with sign or seal.
4695 A value of yes allows only simple binds over TLS encrypted
4697 connections. Unencrypted connections only allow sasl binds with
4698 sign or seal.
4699 Default: ldap server require strong auth = yes
4701 ldap ssl (G)
4703 This option is used to define whether or not Samba should use SSL
4705 when connecting to the ldap server This is NOT related to Samba's
4706 previous SSL support which was enabled by specifying the --with-ssl
4707 option to the configure script.
4708 LDAP connections should be secured where possible. This may be done
4710 setting either this parameter to start tls or by specifying
4711 ldaps:// in the URL argument of passdb backend.
4712 The ldap ssl can be set to one of two values:
4714 • Off = Never use SSL when querying the directory.
4716 • start tls = Use the LDAPv3 StartTLS extended operation
4718 (RFC2830) for communicating with the directory server.
4719 Please note that this parameter does only affect rpc methods. To
4721 enable the LDAPv3 StartTLS extended operation (RFC2830) for ads,
4722 set ldap ssl = start tls and ldap ssl ads = yes. See smb.conf(5)
4723 for more information on ldap ssl ads.
4724 Default: ldap ssl = start tls
4726 ldap suffix (G)
4728 Specifies the base for all ldap suffixes and for storing the
4730 sambaDomain object.
4731 The ldap suffix will be appended to the values specified for the
4733 ldap user suffix, ldap group suffix, ldap machine suffix, and the
4734 ldap idmap suffix. Each of these should be given only a DN relative
4735 to the ldap suffix.
4736 Default: ldap suffix =
4738 Example: ldap suffix = dc=samba,dc=org
4740 ldap timeout (G)
4742 This parameter defines the number of seconds that Samba should use
4744 as timeout for LDAP operations.
4745 Default: ldap timeout = 15
4747 ldap user suffix (G)
4749 This parameter specifies where users are added to the tree. If this
4751 parameter is unset, the value of ldap suffix will be used instead.
4752 The suffix string is pre-pended to the ldap suffix string so use a
4753 partial DN.
4754 Default: ldap user suffix =
4756 Example: ldap user suffix = ou=people
4758 level2 oplocks (S)
4760 This parameter controls whether Samba supports level2 (read-only)
4762 oplocks on a share.
4763 Level2, or read-only oplocks allow Windows NT clients that have an
4765 oplock on a file to downgrade from a read-write oplock to a
4766 read-only oplock once a second client opens the file (instead of
4767 releasing all oplocks on a second open, as in traditional,
4768 exclusive oplocks). This allows all openers of the file that
4769 support level2 oplocks to cache the file for read-ahead only (ie.
4770 they may not cache writes or lock requests) and increases
4771 performance for many accesses of files that are not commonly
4772 written (such as application .EXE files).
4773 Once one of the clients which have a read-only oplock writes to the
4775 file all clients are notified (no reply is needed or waited for)
4776 and told to break their oplocks to "none" and delete any read-ahead
4777 caches.
4778 It is recommended that this parameter be turned on to speed access
4780 to shared executables.
4781 For more discussions on level2 oplocks see the CIFS spec.
4783 Currently, if kernel oplocks are supported then level2 oplocks are
4785 not granted (even if this parameter is set to yes). Note also, the
4786 oplocks parameter must be set to yes on this share in order for
4787 this parameter to have any effect.
4788 Default: level2 oplocks = yes
4790 lm announce (G)
4792 This parameter determines if nmbd(8) will produce Lanman announce
4794 broadcasts that are needed by OS/2 clients in order for them to see
4795 the Samba server in their browse list. This parameter can have
4796 three values, yes, no, or auto. The default is auto. If set to no
4797 Samba will never produce these broadcasts. If set to yes Samba will
4798 produce Lanman announce broadcasts at a frequency set by the
4799 parameter lm interval. If set to auto Samba will not send Lanman
4800 announce broadcasts by default but will listen for them. If it
4801 hears such a broadcast on the wire it will then start sending them
4802 at a frequency set by the parameter lm interval.
4803 Default: lm announce = auto
4805 Example: lm announce = yes
4807 lm interval (G)
4809 If Samba is set to produce Lanman announce broadcasts needed by
4811 OS/2 clients (see the lm announce parameter) then this parameter
4812 defines the frequency in seconds with which they will be made. If
4813 this is set to zero then no Lanman announcements will be made
4814 despite the setting of the lm announce parameter.
4815 Default: lm interval = 60
4817 Example: lm interval = 120
4819 load printers (G)
4821 A boolean variable that controls whether all printers in the
4823 printcap will be loaded for browsing by default. See the printers
4824 section for more details.
4825 Default: load printers = yes
4827 local master (G)
4829 This option allows nmbd(8) to try and become a local master browser
4831 on a subnet. If set to no then nmbd will not attempt to become a
4832 local master browser on a subnet and will also lose in all browsing
4833 elections. By default this value is set to yes. Setting this value
4834 to yes doesn't mean that Samba will become the local master browser
4835 on a subnet, just that nmbd will participate in elections for local
4836 master browser.
4837 Setting this value to no will cause nmbd never to become a local
4839 master browser.
4840 Default: local master = yes
4842 lock dir
4844 This parameter is a synonym for lock directory.
4846 lock directory (G)
4848 This option specifies the directory where lock files will be
4850 placed. The lock files are used to implement the max connections
4851 option.
4852 Note: This option can not be set inside registry configurations.
4854 The files placed in this directory are not required across service
4856 restarts and can be safely placed on volatile storage (e.g. tmpfs
4857 in Linux)
4858 Default: lock directory = /var/lib/samba/lock
4860 Example: lock directory = /var/run/samba/locks
4862 locking (S)
4864 This controls whether or not locking will be performed by the
4866 server in response to lock requests from the client.
4867 If locking = no, all lock and unlock requests will appear to
4869 succeed and all lock queries will report that the file in question
4870 is available for locking.
4871 If locking = yes, real locking will be performed by the server.
4873 This option may be useful for read-only filesystems which may not
4875 need locking (such as CDROM drives), although setting this
4876 parameter of no is not really recommended even in this case.
4877 Be careful about disabling locking either globally or in a specific
4879 service, as lack of locking may result in data corruption. You
4880 should never need to set this parameter.
4881 Default: locking = yes
4883 lock spin time (G)
4885 The time in milliseconds that smbd should keep waiting to see if a
4887 failed lock request can be granted. This parameter has changed in
4888 default value from Samba 3.0.23 from 10 to 200. The associated lock
4889 spin count parameter is no longer used in Samba 3.0.24. You should
4890 not need to change the value of this parameter.
4891 Default: lock spin time = 200
4893 log file (G)
4895 This option allows you to override the name of the Samba log file
4897 (also known as the debug file).
4898 This option takes the standard substitutions, allowing you to have
4900 separate log files for each user or machine.
4901 No default
4903 Example: log file = /usr/local/samba/var/log.%m
4905 logging (G)
4907 This parameter configures logging backends. Multiple backends can
4909 be specified at the same time, with different log levels for each
4910 backend. The parameter is a list of backends, where each backend is
4911 specified as backend[:option][@loglevel].
4912 The 'option' parameter can be used to pass backend-specific
4914 options.
4915 The log level for a backend is optional, if it is not set for a
4917 backend, all messages are sent to this backend. The parameter log
4918 level determines overall log levels, while the log levels specified
4919 here define what is sent to the individual backends.
4920 When logging is set, it overrides the syslog and syslog only
4922 parameters.
4923 Some backends are only available when Samba has been compiled with
4925 the additional libraries. The overall list of logging backends:
4926 • syslog
4928 • file
4930 • systemd
4932 • lttng
4934 • gpfs
4936 • ringbuf
4938 The ringbuf backend supports an optional size argument to change
4940 the buffer size used, the default is 1 MB: ringbuf:size=NBYTES
4941 Default: logging =
4943 Example: logging = syslog@1 file
4945 debuglevel
4947 This parameter is a synonym for log level.
4949 log level (G)
4951 The value of the parameter (a string) allows the debug level
4953 (logging level) to be specified in the smb.conf file.
4954 This parameter has been extended since the 2.2.x series, now it
4956 allows one to specify the debug level for multiple debug classes
4957 and distinct logfiles for debug classes. This is to give greater
4958 flexibility in the configuration of the system. The following debug
4959 classes are currently implemented:
4960 • all
4962 • tdb
4964 • printdrivers
4966 • lanman
4968 • smb
4970 • rpc_parse
4972 • rpc_srv
4974 • rpc_cli
4976 • passdb
4978 • sam
4980 • auth
4982 • winbind
4984 • vfs
4986 • idmap
4988 • quota
4990 • acls
4992 • locking
4994 • msdfs
4996 • dmapi
4998 • registry
5000 • scavenger
5002 • dns
5004 • ldb
5006 • tevent
5008 • auth_audit
5010 • auth_json_audit
5012 • kerberos
5014 • drs_repl
5016 • smb2
5018 • smb2_credits
5020 • dsdb_audit
5022 • dsdb_json_audit
5024 • dsdb_password_audit
5026 • dsdb_password_json_audit
5028 • dsdb_transaction_audit
5030 • dsdb_transaction_json_audit
5032 • dsdb_group_audit
5034 • dsdb_group_json_audit
5036 To configure the logging for specific classes to go into a
5038 different file then log file, you can append @PATH to the class, eg
5039 log level = 1 full_audit:1@/var/log/audit.log.
5040 Authentication and authorization audit information is logged under
5042 the auth_audit, and if Samba was not compiled with --without-json,
5043 a JSON representation is logged under auth_json_audit.
5044 Support is comprehensive for all authentication and authorisation
5046 of user accounts in the Samba Active Directory Domain Controller,
5047 as well as the implicit authentication in password changes. In the
5048 file server, NTLM authentication, SMB and RPC authorization is
5049 covered.
5050 Log levels for auth_audit and auth_audit_json are:
5052 • 2: Authentication Failure
5054 • 3: Authentication Success
5056 • 4: Authorization Success
5058 • 5: Anonymous Authentication and Authorization Success
5060 Changes to the AD DC sam.ldb database are logged under the
5062 dsdb_audit and a JSON representation is logged under
5063 dsdb_json_audit.
5064 Group membership changes to the AD DC sam.ldb database are logged
5066 under the dsdb_group_audit and a JSON representation is logged
5067 under dsdb_group_json_audit.
5068 Log levels for dsdb_audit, dsdb_json_audit, dsdb_group_audit,
5070 dsdb_group_json_audit and dsdb_json_audit are:
5071 • 5: Database modifications
5073 • 5: Replicated updates from another DC
5075 Password changes and Password resets in the AD DC are logged under
5077 dsdb_password_audit and a JSON representation is logged under the
5078 dsdb_password_json_audit. Password changes will also appears as
5079 authentication events via auth_audit and auth_audit_json.
5080 Log levels for dsdb_password_audit and dsdb_password_json_audit
5082 are:
5083 • 5: Successful password changes and resets
5085 Transaction rollbacks and prepare commit failures are logged under
5087 the dsdb_transaction_audit and a JSON representation is logged
5088 under the dsdb_transaction_json_audit.
5089 Log levels for dsdb_transaction_audit and dsdb_transaction_json
5091 are:
5092 • 5: Transaction failure (rollback)
5094 • 10: Transaction success (commit)
5096 Transaction roll-backs are possible in Samba, and whilst they
5098 rarely reflect anything more than the failure of an individual
5099 operation (say due to the add of a conflicting record), they are
5100 possible. Audit logs are already generated and sent to the system
5101 logs before the transaction is complete. Logging the transaction
5102 details allows the identification of password and sam.ldb
5103 operations that have been rolled back, and so have not actually
5104 persisted.
5105 Warning
5107 Changes to sam.ldb made locally by the root user with direct
5108 access to the database are not logged to the system logs, but
5109 to the administrator's own console. While less than ideal, any
5110 user able to make such modifications could disable the audit
5111 logging in any case.
5112 Default: log level = 0
5113 Example: log level = 3 passdb:5 auth:10 winbind:2
5115 Example: log level = 1 full_audit:1@/var/log/audit.log winbind:2
5117 log nt token command (G)
5119 This option can be set to a command that will be called when new nt
5121 tokens are created.
5122 This is only useful for development purposes.
5124 Default: log nt token command =
5126 logon drive (G)
5128 This parameter specifies the local path to which the home directory
5130 will be connected (see logon home) and is only used by NT
5131 Workstations.
5132 Note that this option is only useful if Samba is set up as a logon
5134 server.
5135 Default: logon drive =
5137 Example: logon drive = h:
5139 logon home (G)
5141 This parameter specifies the home directory location when a
5143 Win95/98 or NT Workstation logs into a Samba PDC. It allows you to
5144 do
5145 C:\>NET USE H: /HOME
5147 from a command prompt, for example.
5149 This option takes the standard substitutions, allowing you to have
5151 separate logon scripts for each user or machine.
5152 This parameter can be used with Win9X workstations to ensure that
5154 roaming profiles are stored in a subdirectory of the user's home
5155 directory. This is done in the following way:
5156 logon home = \\%N\%U\profile
5158 This tells Samba to return the above string, with substitutions
5160 made when a client requests the info, generally in a NetUserGetInfo
5161 request. Win9X clients truncate the info to \\server\share when a
5162 user does net use /home but use the whole string when dealing with
5163 profiles.
5164 Note that in prior versions of Samba, the logon path was returned
5166 rather than logon home. This broke net use /home but allowed
5167 profiles outside the home directory. The current implementation is
5168 correct, and can be used for profiles if you use the above trick.
5169 Disable this feature by setting logon home = "" - using the empty
5171 string.
5172 This option is only useful if Samba is set up as a logon server.
5174 Default: logon home = \\%N\%U
5176 Example: logon home = \\remote_smb_server\%U
5178 logon path (G)
5180 This parameter specifies the directory where roaming profiles
5182 (Desktop, NTuser.dat, etc) are stored. Contrary to previous
5183 versions of these manual pages, it has nothing to do with Win 9X
5184 roaming profiles. To find out how to handle roaming profiles for
5185 Win 9X system, see the logon home parameter.
5186 This option takes the standard substitutions, allowing you to have
5188 separate logon scripts for each user or machine. It also specifies
5189 the directory from which the "Application Data", desktop, start
5190 menu, network neighborhood, programs and other folders, and their
5191 contents, are loaded and displayed on your Windows NT client.
5192 The share and the path must be readable by the user for the
5194 preferences and directories to be loaded onto the Windows NT
5195 client. The share must be writeable when the user logs in for the
5196 first time, in order that the Windows NT client can create the
5197 NTuser.dat and other directories. Thereafter, the directories and
5198 any of the contents can, if required, be made read-only. It is not
5199 advisable that the NTuser.dat file be made read-only - rename it to
5200 NTuser.man to achieve the desired effect (a MANdatory profile).
5201 Windows clients can sometimes maintain a connection to the [homes]
5203 share, even though there is no user logged in. Therefore, it is
5204 vital that the logon path does not include a reference to the homes
5205 share (i.e. setting this parameter to \\%N\homes\profile_path will
5206 cause problems).
5207 This option takes the standard substitutions, allowing you to have
5209 separate logon scripts for each user or machine.
5210 Warning
5212 Do not quote the value. Setting this as “\\%N\profile\%U” will
5213 break profile handling. Where the tdbsam or ldapsam passdb
5214 backend is used, at the time the user account is created the
5215 value configured for this parameter is written to the passdb
5216 backend and that value will over-ride the parameter value
5217 present in the smb.conf file. Any error present in the passdb
5218 backend account record must be editted using the appropriate
5219 tool (pdbedit on the command-line, or any other locally
5220 provided system tool).
5221 Note that this option is only useful if Samba is set up as a domain
5222 controller.
5223 Disable the use of roaming profiles by setting the value of this
5225 parameter to the empty string. For example, logon path = "". Take
5226 note that even if the default setting in the smb.conf file is the
5227 empty string, any value specified in the user account settings in
5228 the passdb backend will over-ride the effect of setting this
5229 parameter to null. Disabling of all roaming profile use requires
5230 that the user account settings must also be blank.
5231 An example of use is:
5233 logon path = \\PROFILESERVER\PROFILE\%U
5235 Default: logon path = \\%N\%U\profile
5237 logon script (G)
5239 This parameter specifies the batch file (.bat) or NT command file
5241 (.cmd) to be downloaded and run on a machine when a user
5242 successfully logs in. The file must contain the DOS style CR/LF
5243 line endings. Using a DOS-style editor to create the file is
5244 recommended.
5245 The script must be a relative path to the [netlogon] service. If
5247 the [netlogon] service specifies a path of
5248 /usr/local/samba/netlogon, and logon script = STARTUP.BAT, then the
5249 file that will be downloaded is:
5250 /usr/local/samba/netlogon/STARTUP.BAT
5252 The contents of the batch file are entirely your choice. A
5254 suggested command would be to add NET TIME \\SERVER /SET /YES, to
5255 force every machine to synchronize clocks with the same time
5256 server. Another use would be to add NET USE U: \\SERVER\UTILS for
5257 commonly used utilities, or
5258 NET USE Q: \\SERVER\ISO9001_QA
5260 for example.
5262 Note that it is particularly important not to allow write access to
5264 the [netlogon] share, or to grant users write permission on the
5265 batch files in a secure environment, as this would allow the batch
5266 files to be arbitrarily modified and security to be breached.
5267 This option takes the standard substitutions, allowing you to have
5269 separate logon scripts for each user or machine.
5270 This option is only useful if Samba is set up as a logon server in
5272 a classic domain controller role. If Samba is set up as an Active
5273 Directory domain controller, LDAP attribute scriptPath is used
5274 instead. For configurations where passdb backend = ldapsam is in
5275 use, this option only defines a default value in case LDAP
5276 attribute sambaLogonScript is missing.
5277 Default: logon script =
5279 Example: logon script = scripts\%U.bat
5281 log writeable files on exit (G)
5283 When the network connection between a CIFS client and Samba dies,
5285 Samba has no option but to simply shut down the server side of the
5286 network connection. If this happens, there is a risk of data
5287 corruption because the Windows client did not complete all write
5288 operations that the Windows application requested. Setting this
5289 option to "yes" makes smbd log with a level 0 message a list of all
5290 files that have been opened for writing when the network connection
5291 died. Those are the files that are potentially corrupted. It is
5292 meant as an aid for the administrator to give him a list of files
5293 to do consistency checks on.
5294 Default: log writeable files on exit = no
5296 lppause command (S)
5298 This parameter specifies the command to be executed on the server
5300 host in order to stop printing or spooling a specific print job.
5301 This command should be a program or script which takes a printer
5303 name and job number to pause the print job. One way of implementing
5304 this is by using job priorities, where jobs having a too low
5305 priority won't be sent to the printer.
5306 If a %p is given then the printer name is put in its place. A %j is
5308 replaced with the job number (an integer). On HPUX (see
5309 printing=hpux ), if the -p%p option is added to the lpq command,
5310 the job will show up with the correct status, i.e. if the job
5311 priority is lower than the set fence priority it will have the
5312 PAUSED status, whereas if the priority is equal or higher it will
5313 have the SPOOLED or PRINTING status.
5314 Note that it is good practice to include the absolute path in the
5316 lppause command as the PATH may not be available to the server.
5317 Currently no default value is given to this string, unless the
5319 value of the printing parameter is SYSV, in which case the default
5320 is : lp -i %p-%j -H hold or if the value of the printing parameter
5321 is SOFTQ, then the default is: qstat -s -j%j -h.
5322 Default: lppause command = # determined by printing parameter
5324 Example: lppause command = /usr/bin/lpalt %p-%j -p0
5326 lpq cache time (G)
5328 This controls how long lpq info will be cached for to prevent the
5330 lpq command being called too often. A separate cache is kept for
5331 each variation of the lpq command used by the system, so if you use
5332 different lpq commands for different users then they won't share
5333 cache information.
5334 The cache files are stored in /tmp/lpq.xxxx where xxxx is a hash of
5336 the lpq command in use.
5337 The default is 30 seconds, meaning that the cached results of a
5339 previous identical lpq command will be used if the cached data is
5340 less than 30 seconds old. A large value may be advisable if your
5341 lpq command is very slow.
5342 A value of 0 will disable caching completely.
5344 Default: lpq cache time = 30
5346 Example: lpq cache time = 10
5348 lpq command (S)
5350 This parameter specifies the command to be executed on the server
5352 host in order to obtain lpq-style printer status information.
5353 This command should be a program or script which takes a printer
5355 name as its only parameter and outputs printer status information.
5356 Currently nine styles of printer status information are supported;
5358 BSD, AIX, LPRNG, PLP, SYSV, HPUX, QNX, CUPS, and SOFTQ. This covers
5359 most UNIX systems. You control which type is expected using the
5360 printing = option.
5361 Some clients (notably Windows for Workgroups) may not correctly
5363 send the connection number for the printer they are requesting
5364 status information about. To get around this, the server reports on
5365 the first printer service connected to by the client. This only
5366 happens if the connection number sent is invalid.
5367 If a %p is given then the printer name is put in its place.
5369 Otherwise it is placed at the end of the command.
5370 Note that it is good practice to include the absolute path in the
5372 lpq command as the $PATH may not be available to the server. When
5373 compiled with the CUPS libraries, no lpq command is needed because
5374 smbd will make a library call to obtain the print queue listing.
5375 Default: lpq command = # determined by printing parameter
5377 Example: lpq command = /usr/bin/lpq -P%p
5379 lpresume command (S)
5381 This parameter specifies the command to be executed on the server
5383 host in order to restart or continue printing or spooling a
5384 specific print job.
5385 This command should be a program or script which takes a printer
5387 name and job number to resume the print job. See also the lppause
5388 command parameter.
5389 If a %p is given then the printer name is put in its place. A %j is
5391 replaced with the job number (an integer).
5392 Note that it is good practice to include the absolute path in the
5394 lpresume command as the PATH may not be available to the server.
5395 See also the printing parameter.
5397 Default: Currently no default value is given to this string, unless
5399 the value of the printing parameter is SYSV, in which case the
5400 default is:
5401 lp -i %p-%j -H resume
5403 or if the value of the printing parameter is SOFTQ, then the
5405 default is:
5406 qstat -s -j%j -r
5408 Default: lpresume command = # determined by printing parameter
5410 Example: lpresume command = /usr/bin/lpalt %p-%j -p2
5412 lprm command (S)
5414 This parameter specifies the command to be executed on the server
5416 host in order to delete a print job.
5417 This command should be a program or script which takes a printer
5419 name and job number, and deletes the print job.
5420 If a %p is given then the printer name is put in its place. A %j is
5422 replaced with the job number (an integer).
5423 Note that it is good practice to include the absolute path in the
5425 lprm command as the PATH may not be available to the server.
5426 Examples of use are:
5428 lprm command = /usr/bin/lprm -P%p %j
5430 or
5432 lprm command = /usr/bin/cancel %p-%j
5434 Default: lprm command = # determined by printing parameter
5436 lsa over netlogon (G)
5438 Setting this deprecated option will allow the RPC server in the AD
5440 DC to answer the LSARPC interface on the \pipe\netlogon IPC pipe.
5441 When enabled, this matches the behaviour of Microsoft's Windows,
5443 due to their internal implementation choices.
5444 If it is disabled (the default), the AD DC can offer improved
5446 performance, as the netlogon server is decoupled and can run as
5447 multiple processes.
5448 Default: lsa over netlogon = no
5450 machine password timeout (G)
5452 If a Samba server is a member of a Windows NT or Active Directory
5454 Domain (see the security = domain and security = ads parameters),
5455 then periodically a running winbindd process will try and change
5456 the MACHINE ACCOUNT PASSWORD stored in the TDB called secrets.tdb.
5457 This parameter specifies how often this password will be changed,
5458 in seconds. The default is one week (expressed in seconds), the
5459 same as a Windows NT Domain member server.
5460 See also smbpasswd(8), and the security = domain and security = ads
5462 parameters.
5463 Default: machine password timeout = 604800
5465 magic output (S)
5467 This parameter specifies the name of a file which will contain
5469 output created by a magic script (see the magic script parameter
5470 below).
5471 Warning
5473 If two clients use the same magic script in the same directory
5474 the output file content is undefined.
5475 Default: magic output = # <magic script name>.out
5476 Example: magic output = myfile.txt
5478 magic script (S)
5480 This parameter specifies the name of a file which, if opened, will
5482 be executed by the server when the file is closed. This allows a
5483 UNIX script to be sent to the Samba host and executed on behalf of
5484 the connected user.
5485 Scripts executed in this way will be deleted upon completion
5487 assuming that the user has the appropriate level of privilege and
5488 the file permissions allow the deletion.
5489 If the script generates output, output will be sent to the file
5491 specified by the magic output parameter (see above).
5492 Note that some shells are unable to interpret scripts containing
5494 CR/LF instead of CR as the end-of-line marker. Magic scripts must
5495 be executable as is on the host, which for some hosts and some
5496 shells will require filtering at the DOS end.
5497 Magic scripts are EXPERIMENTAL and should NOT be relied upon.
5499 Default: magic script =
5501 Example: magic script = user.csh
5503 mangled names (S)
5505 This controls whether non-DOS names under UNIX should be mapped to
5507 DOS-compatible names ("mangled") and made visible, or whether
5508 non-DOS names should simply be ignored.
5509 See the section on name mangling for details on how to control the
5511 mangling process.
5512 Possible option settings are
5514 • yes - enables name mangling for all not DOS 8.3
5516 conforming names.
5517 • no - disables any name mangling.
5519 • illegal (default) - does mangling for names with illegal
5521 NTFS characters. This is the most sensible setting for
5522 modern clients that don't use the shortname anymore.
5523 If mangling is used then the mangling method is as follows:
5525 • The first (up to) five alphanumeric characters before
5527 the rightmost dot of the filename are preserved, forced
5528 to upper case, and appear as the first (up to) five
5529 characters of the mangled name.
5530 • A tilde "~" is appended to the first part of the mangled
5532 name, followed by a two-character unique sequence, based
5533 on the original root name (i.e., the original filename
5534 minus its final extension). The final extension is
5535 included in the hash calculation only if it contains any
5536 upper case characters or is longer than three
5537 characters.
5538 Note that the character to use may be specified using
5540 the mangling char option, if you don't like '~'.
5541 • Files whose UNIX name begins with a dot will be
5543 presented as DOS hidden files. The mangled name will be
5544 created as for other filenames, but with the leading dot
5545 removed and "___" as its extension regardless of actual
5546 original extension (that's three underscores).
5547 The two-digit hash value consists of upper case alphanumeric
5549 characters.
5550 This algorithm can cause name collisions only if files in a
5552 directory share the same first five alphanumeric characters. The
5553 probability of such a clash is 1/1300.
5554 The name mangling (if enabled) allows a file to be copied between
5556 UNIX directories from Windows/DOS while retaining the long UNIX
5557 filename. UNIX files can be renamed to a new extension from
5558 Windows/DOS and will retain the same basename. Mangled names do not
5559 change between sessions.
5560 Default: mangled names = illegal
5562 Example: mangled names = no
5564 mangle prefix (G)
5566 controls the number of prefix characters from the original name
5568 used when generating the mangled names. A larger value will give a
5569 weaker hash and therefore more name collisions. The minimum value
5570 is 1 and the maximum value is 6.
5571 mangle prefix is effective only when mangling method is hash2.
5573 Default: mangle prefix = 1
5575 Example: mangle prefix = 4
5577 mangling char (S)
5579 This controls what character is used as the magic character in name
5581 mangling. The default is a '~' but this may interfere with some
5582 software. Use this option to set it to whatever you prefer. This is
5583 effective only when mangling method is hash.
5584 Default: mangling char = ~
5586 Example: mangling char = ^
5588 mangling method (G)
5590 controls the algorithm used for the generating the mangled names.
5592 Can take two different values, "hash" and "hash2". "hash" is the
5593 algorithm that was used in Samba for many years and was the default
5594 in Samba 2.2.x "hash2" is now the default and is newer and
5595 considered a better algorithm (generates less collisions) in the
5596 names. Many Win32 applications store the mangled names and so
5597 changing to algorithms must not be done lightly as these
5598 applications may break unless reinstalled.
5599 Default: mangling method = hash2
5601 Example: mangling method = hash
5603 map acl inherit (S)
5605 This boolean parameter controls whether smbd(8) will attempt to map
5607 the 'inherit' and 'protected' access control entry flags stored in
5608 Windows ACLs into an extended attribute called user.SAMBA_PAI
5609 (POSIX ACL Inheritance). This parameter requires supports for
5610 extended attributes on the filesystem and allows the Windows ACL
5611 editor to store inheritance information while NT ACLs are mapped
5612 best-effort to the POSIX ACLs.
5613 Default: map acl inherit = no
5615 map archive (S)
5617 This controls whether the DOS archive attribute should be mapped to
5619 the UNIX owner execute bit. The DOS archive bit is set when a file
5620 has been modified since its last backup. One motivation for this
5621 option is to keep Samba/your PC from making any file it touches
5622 from becoming executable under UNIX. This can be quite annoying for
5623 shared source code, documents, etc...
5624 Note that this parameter will be ignored if the store dos
5626 attributes parameter is set, as the DOS archive attribute will then
5627 be stored inside a UNIX extended attribute.
5628 Note that this requires the create mask parameter to be set such
5630 that owner execute bit is not masked out (i.e. it must include
5631 100). See the parameter create mask for details.
5632 Default: map archive = yes
5634 map hidden (S)
5636 This controls whether DOS style hidden files should be mapped to
5638 the UNIX world execute bit.
5639 Note that this parameter will be ignored if the store dos
5641 attributes parameter is set, as the DOS hidden attribute will then
5642 be stored inside a UNIX extended attribute.
5643 Note that this requires the create mask to be set such that the
5645 world execute bit is not masked out (i.e. it must include 001). See
5646 the parameter create mask for details.
5647 Default: map hidden = no
5649 map readonly (S)
5651 This controls how the DOS read only attribute should be mapped from
5653 a UNIX filesystem.
5654 This parameter can take three different values, which tell smbd(8)
5656 how to display the read only attribute on files, where either store
5657 dos attributes is set to No, or no extended attribute is present.
5658 If store dos attributes is set to yes then this parameter is
5659 ignored. This is a new parameter introduced in Samba version
5660 3.0.21.
5661 The three settings are :
5663 • Yes - The read only DOS attribute is mapped to the
5665 inverse of the user or owner write bit in the unix
5666 permission mode set. If the owner write bit is not set,
5667 the read only attribute is reported as being set on the
5668 file. If the read only DOS attribute is set, Samba sets
5669 the owner, group and others write bits to zero. Write
5670 bits set in an ACL are ignored by Samba. If the read
5671 only DOS attribute is unset, Samba simply sets the write
5672 bit of the owner to one.
5673 • Permissions - The read only DOS attribute is mapped to
5675 the effective permissions of the connecting user, as
5676 evaluated by smbd(8) by reading the unix permissions and
5677 POSIX ACL (if present). If the connecting user does not
5678 have permission to modify the file, the read only
5679 attribute is reported as being set on the file.
5680 • No - The read only DOS attribute is unaffected by
5682 permissions, and can only be set by the store dos
5683 attributes method. This may be useful for exporting
5684 mounted CDs.
5685 Note that this parameter will be ignored if the store dos
5687 attributes parameter is set, as the DOS 'read-only' attribute will
5688 then be stored inside a UNIX extended attribute.
5689 The default has changed to no in Samba release 4.9.0 and above to
5691 allow better Windows fileserver compatibility in a default install.
5692 In addition the default setting of store dos attributes has been
5693 changed to Yes in Samba release 4.9.0 and above.
5694 Default: map readonly = no
5696 map system (S)
5698 This controls whether DOS style system files should be mapped to
5700 the UNIX group execute bit.
5701 Note that this parameter will be ignored if the store dos
5703 attributes parameter is set, as the DOS system attribute will then
5704 be stored inside a UNIX extended attribute.
5705 Note that this requires the create mask to be set such that the
5707 group execute bit is not masked out (i.e. it must include 010). See
5708 the parameter create mask for details.
5709 Default: map system = no
5711 map to guest (G)
5713 This parameter can take four different values, which tell smbd(8)
5715 what to do with user login requests that don't match a valid UNIX
5716 user in some way.
5717 The four settings are :
5719 • Never - Means user login requests with an invalid
5721 password are rejected. This is the default.
5722 • Bad User - Means user logins with an invalid password
5724 are rejected, unless the username does not exist, in
5725 which case it is treated as a guest login and mapped
5726 into the guest account.
5727 • Bad Password - Means user logins with an invalid
5729 password are treated as a guest login and mapped into
5730 the guest account. Note that this can cause problems as
5731 it means that any user incorrectly typing their password
5732 will be silently logged on as "guest" - and will not
5733 know the reason they cannot access files they think they
5734 should - there will have been no message given to them
5735 that they got their password wrong. Helpdesk services
5736 will hate you if you set the map to guest parameter this
5737 way :-).
5738 • Bad Uid - Is only applicable when Samba is configured in
5740 some type of domain mode security (security =
5741 {domain|ads}) and means that user logins which are
5742 successfully authenticated but which have no valid Unix
5743 user account (and smbd is unable to create one) should
5744 be mapped to the defined guest account. This was the
5745 default behavior of Samba 2.x releases. Note that if a
5746 member server is running winbindd, this option should
5747 never be required because the nss_winbind library will
5748 export the Windows domain users and groups to the
5749 underlying OS via the Name Service Switch interface.
5750 Note that this parameter is needed to set up "Guest" share
5752 services. This is because in these modes the name of the resource
5753 being requested is not sent to the server until after the server
5754 has successfully authenticated the client so the server cannot make
5755 authentication decisions at the correct time (connection to the
5756 share) for "Guest" shares.
5757 Default: map to guest = Never
5759 Example: map to guest = Bad User
5761 max connections (S)
5763 This option allows the number of simultaneous connections to a
5765 service to be limited. If max connections is greater than 0 then
5766 connections will be refused if this number of connections to the
5767 service are already open. A value of zero mean an unlimited number
5768 of connections may be made.
5769 Record lock files are used to implement this feature. The lock
5771 files will be stored in the directory specified by the lock
5772 directory option.
5773 Default: max connections = 0
5775 Example: max connections = 10
5777 max disk size (G)
5779 This option allows you to put an upper limit on the apparent size
5781 of disks. If you set this option to 100 then all shares will appear
5782 to be not larger than 100 MB in size.
5783 Note that this option does not limit the amount of data you can put
5785 on the disk. In the above case you could still store much more than
5786 100 MB on the disk, but if a client ever asks for the amount of
5787 free disk space or the total disk size then the result will be
5788 bounded by the amount specified in max disk size.
5789 This option is primarily useful to work around bugs in some pieces
5791 of software that can't handle very large disks, particularly disks
5792 over 1GB in size.
5793 A max disk size of 0 means no limit.
5795 Default: max disk size = 0
5797 Example: max disk size = 1000
5799 max log size (G)
5801 This option (an integer in kilobytes) specifies the max size the
5803 log file should grow to. Samba periodically checks the size and if
5804 it is exceeded it will rename the file, adding a .old extension.
5805 A size of 0 means no limit.
5807 Default: max log size = 5000
5809 Example: max log size = 1000
5811 max mux (G)
5813 This option controls the maximum number of outstanding simultaneous
5815 SMB operations that Samba tells the client it will allow. You
5816 should never need to set this parameter.
5817 Default: max mux = 50
5819 max open files (G)
5821 This parameter limits the maximum number of open files that one
5823 smbd(8) file serving process may have open for a client at any one
5824 time. This parameter can be set very high (16384) as Samba uses
5825 only one bit per unopened file. Setting this parameter lower than
5826 16384 will cause Samba to complain and set this value back to the
5827 minimum of 16384, as Windows 7 depends on this number of open file
5828 handles being available.
5829 The limit of the number of open files is usually set by the UNIX
5831 per-process file descriptor limit rather than this parameter so you
5832 should never need to touch this parameter.
5833 Default: max open files = 16384
5835 max print jobs (S)
5837 This parameter limits the maximum number of jobs allowable in a
5839 Samba printer queue at any given moment. If this number is
5840 exceeded, smbd(8) will remote "Out of Space" to the client.
5841 Default: max print jobs = 1000
5843 Example: max print jobs = 5000
5845 max reported print jobs (S)
5847 This parameter limits the maximum number of jobs displayed in a
5849 port monitor for Samba printer queue at any given moment. If this
5850 number is exceeded, the excess jobs will not be shown. A value of
5851 zero means there is no limit on the number of print jobs reported.
5852 Default: max reported print jobs = 0
5854 Example: max reported print jobs = 1000
5856 max smbd processes (G)
5858 This parameter limits the maximum number of smbd(8) processes
5860 concurrently running on a system and is intended as a stopgap to
5861 prevent degrading service to clients in the event that the server
5862 has insufficient resources to handle more than this number of
5863 connections. Remember that under normal operating conditions, each
5864 user will have an smbd(8) associated with him or her to handle
5865 connections to all shares from a given host.
5866 For a Samba ADDC running the standard process model this option
5868 limits the number of processes forked to handle requests. Currently
5869 new processes are only forked for ldap and netlogon requests.
5870 Default: max smbd processes = 0
5872 Example: max smbd processes = 1000
5874 max stat cache size (G)
5876 This parameter limits the size in memory of any stat cache being
5878 used to speed up case insensitive name mappings. It represents the
5879 number of kilobyte (1024) units the stat cache can use. A value of
5880 zero, meaning unlimited, is not advisable due to increased memory
5881 usage. You should not need to change this parameter.
5882 Default: max stat cache size = 512
5884 Example: max stat cache size = 100
5886 max ttl (G)
5888 This option tells nmbd(8) what the default 'time to live' of
5890 NetBIOS names should be (in seconds) when nmbd is requesting a name
5891 using either a broadcast packet or from a WINS server. You should
5892 never need to change this parameter. The default is 3 days.
5893 Default: max ttl = 259200
5895 max wins ttl (G)
5897 This option tells smbd(8) when acting as a WINS server (wins
5899 support = yes) what the maximum 'time to live' of NetBIOS names
5900 that nmbd will grant will be (in seconds). You should never need to
5901 change this parameter. The default is 6 days (518400 seconds).
5902 Default: max wins ttl = 518400
5904 max xmit (G)
5906 This option controls the maximum packet size that will be
5908 negotiated by Samba's smbd(8) for the SMB1 protocol. The default is
5909 16644, which matches the behavior of Windows 2000. A value below
5910 2048 is likely to cause problems. You should never need to change
5911 this parameter from its default value.
5912 Default: max xmit = 16644
5914 Example: max xmit = 8192
5916 mdns name (G)
5918 This parameter controls the name that multicast DNS support
5920 advertises as its' hostname.
5921 The default is to use the NETBIOS name which is typically the
5923 hostname in all capital letters.
5924 A setting of mdns will defer the hostname configuration to the MDNS
5926 library that is used.
5927 Default: mdns name = netbios
5929 message command (G)
5931 This specifies what command to run when the server receives a
5933 WinPopup style message.
5934 This would normally be a command that would deliver the message
5936 somehow. How this is to be done is up to your imagination.
5937 An example is:
5939 message command = csh -c 'xedit %s;rm %s' &
5941 This delivers the message using xedit, then removes it afterwards.
5943 NOTE THAT IT IS VERY IMPORTANT THAT THIS COMMAND RETURN
5944 IMMEDIATELY. That's why I have the '&' on the end. If it doesn't
5945 return immediately then your PCs may freeze when sending messages
5946 (they should recover after 30 seconds, hopefully).
5947 All messages are delivered as the global guest user. The command
5949 takes the standard substitutions, although
5950 %u won't work (%U may be better in this case).
5951 Apart from the standard substitutions, some additional ones apply.
5953 In particular:
5954 • %s = the filename containing the message.
5956 • %t = the destination that the message was sent to
5958 (probably the server name).
5959 • %f = who the message is from.
5961 You could make this command send mail, or whatever else takes your
5963 fancy. Please let us know of any really interesting ideas you have.
5964 Here's a way of sending the messages as mail to root:
5966 message command = /bin/mail -s 'message from %f on %m' root < %s; rm %s
5968 If you don't have a message command then the message won't be
5970 delivered and Samba will tell the sender there was an error.
5971 Unfortunately WfWg totally ignores the error code and carries on
5972 regardless, saying that the message was delivered.
5973 If you want to silently delete it then try:
5975 message command = rm %s
5977 Default: message command =
5979 Example: message command = csh -c 'xedit %s; rm %s' &
5981 min print space (S)
5983 This sets the minimum amount of free disk space that must be
5985 available before a user will be able to spool a print job. It is
5986 specified in kilobytes. The default is 0, which means a user can
5987 always spool a print job.
5988 Default: min print space = 0
5990 Example: min print space = 2000
5992 min receivefile size (G)
5994 This option changes the behavior of smbd(8) when processing
5996 SMBwriteX calls. Any incoming SMBwriteX call on a non-signed
5997 SMB/CIFS connection greater than this value will not be processed
5998 in the normal way but will be passed to any underlying kernel
5999 recvfile or splice system call (if there is no such call Samba will
6000 emulate in user space). This allows zero-copy writes directly from
6001 network socket buffers into the filesystem buffer cache, if
6002 available. It may improve performance but user testing is
6003 recommended. If set to zero Samba processes SMBwriteX calls in the
6004 normal way. To enable POSIX large write support (SMB/CIFS writes up
6005 to 16Mb) this option must be nonzero. The maximum value is 128k.
6006 Values greater than 128k will be silently set to 128k.
6007 Note this option will have NO EFFECT if set on a SMB signed
6009 connection.
6010 The default is zero, which disables this option.
6012 Default: min receivefile size = 0
6014 min wins ttl (G)
6016 This option tells nmbd(8) when acting as a WINS server (wins
6018 support = yes) what the minimum 'time to live' of NetBIOS names
6019 that nmbd will grant will be (in seconds). You should never need to
6020 change this parameter. The default is 6 hours (21600 seconds).
6021 Default: min wins ttl = 21600
6023 mit kdc command (G)
6025 This option specifies the path to the MIT kdc binary.
6027 If the KDC is not installed in the default location and wasn't
6029 correctly detected during build then you should modify this
6030 variable and point it to the correct binary.
6031 Default: mit kdc command = /usr/sbin/krb5kdc
6033 Example: mit kdc command = /opt/mit/sbin/krb5kdc
6035 msdfs proxy (S)
6037 This parameter indicates that the share is a stand-in for another
6039 CIFS share whose location is specified by the value of the
6040 parameter. When clients attempt to connect to this share, they are
6041 redirected to one or multiple, comma separated proxied shares using
6042 the SMB-Dfs protocol.
6043 Only Dfs roots can act as proxy shares. Take a look at the msdfs
6045 root and host msdfs options to find out how to set up a Dfs root
6046 share.
6047 No default
6049 Example: msdfs proxy =
6051 \otherserver\someshare,\otherserver2\someshare
6052 msdfs root (S)
6054 If set to yes, Samba treats the share as a Dfs root and allows
6056 clients to browse the distributed file system tree rooted at the
6057 share directory. Dfs links are specified in the share directory by
6058 symbolic links of the form msdfs:serverA\\shareA,serverB\\shareB
6059 and so on. For more information on setting up a Dfs tree on Samba,
6060 refer to the MSDFS chapter in the Samba3-HOWTO book.
6061 Default: msdfs root = no
6063 msdfs shuffle referrals (S)
6065 If set to yes, Samba will shuffle Dfs referrals for a given Dfs
6067 link if multiple are available, allowing for load balancing across
6068 clients. For more information on setting up a Dfs tree on Samba,
6069 refer to the MSDFS chapter in the Samba3-HOWTO book.
6070 Default: msdfs shuffle referrals = no
6072 multicast dns register (G)
6074 If compiled with proper support for it, Samba will announce itself
6076 with multicast DNS services like for example provided by the Avahi
6077 daemon.
6078 This parameter allows disabling Samba to register itself.
6080 Default: multicast dns register = yes
6082 name cache timeout (G)
6084 Specifies the number of seconds it takes before entries in samba's
6086 hostname resolve cache time out. If the timeout is set to 0. the
6087 caching is disabled.
6088 Default: name cache timeout = 660
6090 Example: name cache timeout = 0
6092 name resolve order (G)
6094 This option is used by the programs in the Samba suite to determine
6096 what naming services to use and in what order to resolve host names
6097 to IP addresses. Its main purpose to is to control how netbios name
6098 resolution is performed. The option takes a space separated string
6099 of name resolution options.
6100 The options are: "lmhosts", "host", "wins" and "bcast". They cause
6102 names to be resolved as follows:
6103 • lmhosts : Lookup an IP address in the Samba lmhosts
6105 file. If the line in lmhosts has no name type attached
6106 to the NetBIOS name (see the manpage for lmhosts for
6107 details) then any name type matches for lookup.
6108 • host : Do a standard host name to IP address resolution,
6110 using the system /etc/hosts, NIS, or DNS lookups. This
6111 method of name resolution is operating system depended
6112 for instance on IRIX or Solaris this may be controlled
6113 by the /etc/nsswitch.conf file. Note that this method is
6114 used only if the NetBIOS name type being queried is the
6115 0x20 (server) name type or 0x1c (domain controllers).
6116 The latter case is only useful for active directory
6117 domains and results in a DNS query for the SRV RR entry
6118 matching _ldap._tcp.domain.
6119 • wins : Query a name with the IP address listed in the
6121 WINSSERVER parameter. If no WINS server has been
6122 specified this method will be ignored.
6123 • bcast : Do a broadcast on each of the known local
6125 interfaces listed in the interfaces parameter. This is
6126 the least reliable of the name resolution methods as it
6127 depends on the target host being on a locally connected
6128 subnet.
6129 The example below will cause the local lmhosts file to be examined
6131 first, followed by a broadcast attempt, followed by a normal system
6132 hostname lookup.
6133 When Samba is functioning in ADS security mode (security = ads) it
6135 is advised to use following settings for name resolve order:
6136 name resolve order = wins bcast
6138 DC lookups will still be done via DNS, but fallbacks to netbios
6140 names will not inundate your DNS servers with needless queries for
6141 DOMAIN<0x1c> lookups.
6142 Default: name resolve order = lmhosts wins host bcast
6144 Example: name resolve order = lmhosts bcast host
6146 socket address
6148 This parameter is a synonym for nbt client socket address.
6150 nbt client socket address (G)
6152 This option allows you to control what address Samba will send NBT
6154 client packets from, and process replies using, including in nmbd.
6155 Setting this option should never be necessary on usual Samba
6157 servers running only one nmbd.
6158 By default Samba will send UDP packets from the OS default address
6160 for the destination, and accept replies on 0.0.0.0.
6161 This parameter is deprecated. See bind interfaces only = Yes and
6163 interfaces for the previous behaviour of controlling the normal
6164 listening sockets.
6165 Default: nbt client socket address = 0.0.0.0
6167 Example: nbt client socket address = 192.168.2.20
6169 nbtd:wins_prepend1Bto1Cqueries (G)
6171 Normally queries for 0x1C names (all logon servers for a domain)
6173 will return the first address of the 0x1B names (domain master
6174 browser and PDC) as first address in the result list. As many
6175 client only use the first address in the list by default, all
6176 clients will use the same server (the PDC). Windows servers have an
6177 option to disable this behavior (since Windows 2000 Service Pack
6178 2).
6179 Default: nbtd:wins_prepend1Bto1Cqueries = yes
6181 nbtd:wins_wins_randomize1Clist (G)
6183 Normally queries for 0x1C names will return the addresses in the
6185 same order as they're stored in the database, that means first all
6186 addresses which have been directly registered at the local wins
6187 server and then all addresses registered at other servers. Windows
6188 servers have an option to change this behavior and randomize the
6189 returned addresses. Set this parameter to "yes" and Samba will sort
6190 the address list depending on the client address and the matching
6191 bits of the addresses, the first address is randomized based on
6192 depending on the "nbtd:wins_randomize1Clist_mask" parameter.
6193 Default: nbtd:wins_wins_randomize1Clist = no
6195 nbtd:wins_randomize1Clist_mask (G)
6197 If the "nbtd:wins_randomize1Clist" parameter is set to "yes", then
6199 randomizing of the first returned address is based on the specified
6200 netmask. If there are addresses which are in the same subnet as the
6201 client address, the first returned address is randomly chosen out
6202 them. Otherwise the first returned address is randomly chosen out
6203 of all addresses.
6204 Default: nbtd:wins_randomize1Clist_mask = 255.255.255.0
6206 nbt port (G)
6208 Specifies which port the server should use for NetBIOS over IP name
6210 services traffic.
6211 Default: nbt port = 137
6213 ncalrpc dir (G)
6215 This directory will hold a series of named pipes to allow RPC over
6217 inter-process communication.
6218 This will allow Samba and other unix processes to interact over
6220 DCE/RPC without using TCP/IP. Additionally a sub-directory 'np' has
6221 restricted permissions, and allows a trusted communication channel
6222 between Samba processes
6223 Default: ncalrpc dir = /run/samba/ncalrpc
6225 Example: ncalrpc dir = /var/run/samba/ncalrpc
6227 netbios aliases (G)
6229 This is a list of NetBIOS names that nmbd will advertise as
6231 additional names by which the Samba server is known. This allows
6232 one machine to appear in browse lists under multiple names. If a
6233 machine is acting as a browse server or logon server none of these
6234 names will be advertised as either browse server or logon servers,
6235 only the primary name of the machine will be advertised with these
6236 capabilities.
6237 Default: netbios aliases = # empty string (no additional names)
6239 Example: netbios aliases = TEST TEST1 TEST2
6241 netbios name (G)
6243 This sets the NetBIOS name by which a Samba server is known. By
6245 default it is the same as the first component of the host's DNS
6246 name. If a machine is a browse server or logon server this name (or
6247 the first component of the hosts DNS name) will be the name that
6248 these services are advertised under.
6249 Note that the maximum length for a NetBIOS name is 15 characters.
6251 There is a bug in Samba that breaks operation of browsing and
6253 access to shares if the netbios name is set to the literal name
6254 PIPE. To avoid this problem, do not name your Samba server PIPE.
6255 Default: netbios name = # machine DNS name
6257 Example: netbios name = MYNAME
6259 netbios scope (G)
6261 This sets the NetBIOS scope that Samba will operate under. This
6263 should not be set unless every machine on your LAN also sets this
6264 value.
6265 Default: netbios scope =
6267 neutralize nt4 emulation (G)
6269 This option controls whether winbindd sends the
6271 NETLOGON_NEG_NEUTRALIZE_NT4_EMULATION flag in order to bypass the
6272 NT4 emulation of a domain controller.
6273 Typically you should not need set this. It can be useful for
6275 upgrades from NT4 to AD domains.
6276 The behavior can be controlled per netbios domain by using
6278 'neutralize nt4 emulation:NETBIOSDOMAIN = yes' as option.
6279 Default: neutralize nt4 emulation = no
6281 NIS homedir (G)
6283 Get the home share server from a NIS map. For UNIX systems that use
6285 an automounter, the user's home directory will often be mounted on
6286 a workstation on demand from a remote server.
6287 When the Samba logon server is not the actual home directory
6289 server, but is mounting the home directories via NFS then two
6290 network hops would be required to access the users home directory
6291 if the logon server told the client to use itself as the SMB server
6292 for home directories (one over SMB and one over NFS). This can be
6293 very slow.
6294 This option allows Samba to return the home share as being on a
6296 different server to the logon server and as long as a Samba daemon
6297 is running on the home directory server, it will be mounted on the
6298 Samba client directly from the directory server. When Samba is
6299 returning the home share to the client, it will consult the NIS map
6300 specified in homedir map and return the server listed there.
6301 Note that for this option to work there must be a working NIS
6303 system and the Samba server with this option must also be a logon
6304 server.
6305 Default: NIS homedir = no
6307 nmbd bind explicit broadcast (G)
6309 This option causes nmbd(8) to explicitly bind to the broadcast
6311 address of the local subnets. This is needed to make nmbd work
6312 correctly in combination with the socket address option. You should
6313 not need to unset this option.
6314 Default: nmbd bind explicit broadcast = yes
6316 nsupdate command (G)
6318 This option sets the path to the nsupdate command which is used for
6320 GSS-TSIG dynamic DNS updates.
6321 Default: nsupdate command = /usr/bin/nsupdate -g
6323 nt acl support (S)
6325 This boolean parameter controls whether smbd(8) will attempt to map
6327 UNIX permissions into Windows NT access control lists. The UNIX
6328 permissions considered are the traditional UNIX owner and group
6329 permissions, as well as POSIX ACLs set on any files or directories.
6330 This parameter was formally a global parameter in releases prior to
6331 2.2.2.
6332 Default: nt acl support = yes
6334 ntlm auth (G)
6336 This parameter determines whether or not smbd(8) will attempt to
6338 authenticate users using the NTLM encrypted password response for
6339 this local passdb (SAM or account database).
6340 If disabled, both NTLM and LanMan authencication against the local
6342 passdb is disabled.
6343 Note that these settings apply only to local users, authentication
6345 will still be forwarded to and NTLM authentication accepted against
6346 any domain we are joined to, and any trusted domain, even if
6347 disabled or if NTLMv2-only is enforced here. To control NTLM
6348 authentiation for domain users, this must option must be configured
6349 on each DC.
6350 By default with ntlm auth set to ntlmv2-only only NTLMv2 logins
6352 will be permitted. All modern clients support NTLMv2 by default,
6353 but some older clients will require special configuration to use
6354 it.
6355 The primary user of NTLMv1 is MSCHAPv2 for VPNs and 802.1x.
6357 The available settings are:
6359 • ntlmv1-permitted (alias yes) - Allow NTLMv1 and above
6361 for all clients.
6362 This is the required setting for to enable the lanman
6364 auth parameter.
6365 • ntlmv2-only (alias no) - Do not allow NTLMv1 to be used,
6367 but permit NTLMv2.
6368 • mschapv2-and-ntlmv2-only - Only allow NTLMv1 when the
6370 client promises that it is providing MSCHAPv2
6371 authentication (such as the ntlm_auth tool).
6372 • disabled - Do not accept NTLM (or LanMan) authentication
6374 of any level, nor permit NTLM password changes.
6375 The default changed from yes to no with Samba 4.5. The default
6377 changed again to ntlmv2-only with Samba 4.7, however the behaviour
6378 is unchanged.
6379 Default: ntlm auth = ntlmv2-only
6381 nt pipe support (G)
6383 This boolean parameter controls whether smbd(8) will allow Windows
6385 NT clients to connect to the NT SMB specific IPC$ pipes. This is a
6386 developer debugging option and can be left alone.
6387 Default: nt pipe support = yes
6389 ntp signd socket directory (G)
6391 This setting controls the location of the socket that the NTP
6393 daemon uses to communicate with Samba for signing packets.
6394 If a non-default path is specified here, then it is also necessary
6396 to make NTP aware of the new path using the ntpsigndsocket
6397 directive in ntp.conf.
6398 Default: ntp signd socket directory = /var/lib/samba/ntp_signd
6400 nt status support (G)
6402 This boolean parameter controls whether smbd(8) will negotiate NT
6404 specific status support with Windows NT/2k/XP clients. This is a
6405 developer debugging option and should be left alone. If this option
6406 is set to no then Samba offers exactly the same DOS error codes
6407 that versions prior to Samba 2.2.3 reported.
6408 You should not need to ever disable this parameter.
6410 Default: nt status support = yes
6412 ntvfs handler (S)
6414 This specifies the NTVFS handlers for this share.
6416 • unixuid: Sets up user credentials based on POSIX
6418 gid/uid.
6419 • cifs: Proxies a remote CIFS FS. Mainly useful for
6421 testing.
6422 • nbench: Filter module that saves data useful to the
6424 nbench benchmark suite.
6425 • ipc: Allows using SMB for inter process communication.
6427 Only used for the IPC$ share.
6428 • posix: Maps POSIX FS semantics to NT semantics
6430 • print: Allows printing over SMB. This is LANMAN-style
6432 printing, not the be confused with the spoolss DCE/RPC
6433 interface used by later versions of Windows.
6434 Note that this option is only used when the NTVFS file server is in
6436 use. It is not used with the (default) s3fs file server.
6437 Default: ntvfs handler = unixuid, default
6439 null passwords (G)
6441 Allow or disallow client access to accounts that have null
6443 passwords.
6444 See also smbpasswd(5).
6446 Default: null passwords = no
6448 obey pam restrictions (G)
6450 When Samba 3.0 is configured to enable PAM support (i.e.
6452 --with-pam), this parameter will control whether or not Samba
6453 should obey PAM's account and session management directives. The
6454 default behavior is to use PAM for clear text authentication only
6455 and to ignore any account or session management. Note that Samba
6456 always ignores PAM for authentication in the case of encrypt
6457 passwords = yes. The reason is that PAM modules cannot support the
6458 challenge/response authentication mechanism needed in the presence
6459 of SMB password encryption.
6460 Default: obey pam restrictions = no
6462 old password allowed period (G)
6464 Number of minutes to permit an NTLM login after a password change
6466 or reset using the old password. This allows the user to re-cache
6467 the new password on multiple clients without disrupting a network
6468 reconnection in the meantime.
6469 This parameter only applies when server role is set to Active
6471 Directory Domain Controller.
6472 Default: old password allowed period = 60
6474 oplock break wait time (G)
6476 This is a tuning parameter added due to bugs in both Windows 9x and
6478 WinNT. If Samba responds to a client too quickly when that client
6479 issues an SMB that can cause an oplock break request, then the
6480 network client can fail and not respond to the break request. This
6481 tuning parameter (which is set in milliseconds) is the amount of
6482 time Samba will wait before sending an oplock break request to such
6483 (broken) clients.
6484 Warning
6486 DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ AND
6487 UNDERSTOOD THE SAMBA OPLOCK CODE.
6488 Default: oplock break wait time = 0
6489 oplocks (S)
6491 This boolean option tells smbd whether to issue oplocks
6493 (opportunistic locks) to file open requests on this share. The
6494 oplock code can dramatically (approx. 30% or more) improve the
6495 speed of access to files on Samba servers. It allows the clients to
6496 aggressively cache files locally and you may want to disable this
6497 option for unreliable network environments (it is turned on by
6498 default in Windows NT Servers).
6499 Oplocks may be selectively turned off on certain files with a
6501 share. See the veto oplock files parameter. On some systems oplocks
6502 are recognized by the underlying operating system. This allows data
6503 synchronization between all access to oplocked files, whether it be
6504 via Samba or NFS or a local UNIX process. See the kernel oplocks
6505 parameter for details.
6506 Default: oplocks = yes
6508 os2 driver map (G)
6510 The parameter is used to define the absolute path to a file
6512 containing a mapping of Windows NT printer driver names to OS/2
6513 printer driver names. The format is:
6514 <nt driver name> = <os2 driver name>.<device name>
6516 For example, a valid entry using the HP LaserJet 5 printer driver
6518 would appear as HP LaserJet 5L = LASERJET.HP LaserJet 5L.
6519 The need for the file is due to the printer driver namespace
6521 problem described in the chapter on Classical Printing in the
6522 Samba3-HOWTO book. For more details on OS/2 clients, please refer
6523 to chapter on other clients in the Samba3-HOWTO book.
6524 Default: os2 driver map =
6526 os level (G)
6528 This integer value controls what level Samba advertises itself as
6530 for browse elections. The value of this parameter determines
6531 whether nmbd(8) has a chance of becoming a local master browser for
6532 the workgroup in the local broadcast area.
6533 Note: By default, Samba will win a local master browsing election
6535 over all Microsoft operating systems except a Windows NT 4.0/2000
6536 Domain Controller. This means that a misconfigured Samba host can
6537 effectively isolate a subnet for browsing purposes. This parameter
6538 is largely auto-configured in the Samba-3 release series and it is
6539 seldom necessary to manually override the default setting. Please
6540 refer to the chapter on Network Browsing in the Samba-3 HOWTO
6541 document for further information regarding the use of this
6542 parameter. Note: The maximum value for this parameter is 255. If
6543 you use higher values, counting will start at 0!
6544 Default: os level = 20
6546 Example: os level = 65
6548 pam password change (G)
6550 With the addition of better PAM support in Samba 2.2, this
6552 parameter, it is possible to use PAM's password change control flag
6553 for Samba. If enabled, then PAM will be used for password changes
6554 when requested by an SMB client instead of the program listed in
6555 passwd program. It should be possible to enable this without
6556 changing your passwd chat parameter for most setups.
6557 Default: pam password change = no
6559 panic action (G)
6561 This is a Samba developer option that allows a system command to be
6563 called when either smbd(8) or nmbd(8) crashes. This is usually used
6564 to draw attention to the fact that a problem occurred.
6565 Default: panic action =
6567 Example: panic action = /bin/sleep 90000
6569 passdb backend (G)
6571 This option allows the administrator to chose which backend will be
6573 used for storing user and possibly group information. This allows
6574 you to swap between different storage mechanisms without recompile.
6575 The parameter value is divided into two parts, the backend's name,
6577 and a 'location' string that has meaning only to that particular
6578 backed. These are separated by a : character.
6579 Available backends can include:
6581 • smbpasswd - The old plaintext passdb backend. Some Samba
6583 features will not work if this passdb backend is used.
6584 Takes a path to the smbpasswd file as an optional
6585 argument.
6586 • tdbsam - The TDB based password storage backend. Takes a
6588 path to the TDB as an optional argument (defaults to
6589 passdb.tdb in the private dir directory.
6590 • ldapsam - The LDAP based passdb backend. Takes an LDAP
6592 URL as an optional argument (defaults to
6593 ldap://localhost)
6594 LDAP connections should be secured where possible. This
6596 may be done using either Start-TLS (see ldap ssl) or by
6597 specifying ldaps:// in the URL argument.
6598 Multiple servers may also be specified in double-quotes.
6600 Whether multiple servers are supported or not and the
6601 exact syntax depends on the LDAP library you use.
6602 Examples of use are:
6605 passdb backend = tdbsam:/etc/samba/private/passdb.tdb
6607 or multi server LDAP URL with OpenLDAP library:
6609 passdb backend = ldapsam:"ldap://ldap-1.example.com ldap://ldap-2.example.com"
6611 or multi server LDAP URL with Netscape based LDAP library:
6613 passdb backend = ldapsam:"ldap://ldap-1.example.com ldap-2.example.com"
6615 Default: passdb backend = tdbsam
6617 passdb expand explicit (G)
6619 This parameter controls whether Samba substitutes %-macros in the
6621 passdb fields if they are explicitly set. We used to expand macros
6622 here, but this turned out to be a bug because the Windows client
6623 can expand a variable %G_osver% in which %G would have been
6624 substituted by the user's primary group.
6625 Default: passdb expand explicit = no
6627 passwd chat (G)
6629 This string controls the "chat" conversation that takes places
6631 between smbd(8) and the local password changing program to change
6632 the user's password. The string describes a sequence of
6633 response-receive pairs that smbd(8) uses to determine what to send
6634 to the passwd program and what to expect back. If the expected
6635 output is not received then the password is not changed.
6636 This chat sequence is often quite site specific, depending on what
6638 local methods are used for password control (such as NIS etc).
6639 Note that this parameter only is used if the unix password sync
6641 parameter is set to yes. This sequence is then called AS ROOT when
6642 the SMB password in the smbpasswd file is being changed, without
6643 access to the old password cleartext. This means that root must be
6644 able to reset the user's password without knowing the text of the
6645 previous password. In the presence of NIS/YP, this means that the
6646 passwd program must be executed on the NIS master.
6647 The string can contain the macro %n which is substituted for the
6649 new password. The old password (%o) is only available when encrypt
6650 passwords has been disabled. The chat sequence can also contain the
6651 standard macros \n, \r, \t and \s to give line-feed,
6652 carriage-return, tab and space. The chat sequence string can also
6653 contain a '*' which matches any sequence of characters. Double
6654 quotes can be used to collect strings with spaces in them into a
6655 single string.
6656 If the send string in any part of the chat sequence is a full stop
6658 ".", then no string is sent. Similarly, if the expect string is a
6659 full stop then no string is expected.
6660 If the pam password change parameter is set to yes, the chat pairs
6662 may be matched in any order, and success is determined by the PAM
6663 result, not any particular output. The \n macro is ignored for PAM
6664 conversions.
6665 Default: passwd chat = *new*password* %n\n *new*password* %n\n
6667 *changed*
6668 Example: passwd chat = "*Enter NEW password*" %n\n "*Reenter NEW
6670 password*" %n\n "*Password changed*"
6671 passwd chat debug (G)
6673 This boolean specifies if the passwd chat script parameter is run
6675 in debug mode. In this mode the strings passed to and received from
6676 the passwd chat are printed in the smbd(8) log with a debug level
6677 of 100. This is a dangerous option as it will allow plaintext
6678 passwords to be seen in the smbd log. It is available to help Samba
6679 admins debug their passwd chat scripts when calling the passwd
6680 program and should be turned off after this has been done. This
6681 option has no effect if the pam password change parameter is set.
6682 This parameter is off by default.
6683 Default: passwd chat debug = no
6685 passwd chat timeout (G)
6687 This integer specifies the number of seconds smbd will wait for an
6689 initial answer from a passwd chat script being run. Once the
6690 initial answer is received the subsequent answers must be received
6691 in one tenth of this time. The default it two seconds.
6692 Default: passwd chat timeout = 2
6694 passwd program (G)
6696 The name of a program that can be used to set UNIX user passwords.
6698 Any occurrences of %u will be replaced with the user name. The user
6699 name is checked for existence before calling the password changing
6700 program.
6701 Also note that many passwd programs insist in reasonable passwords,
6703 such as a minimum length, or the inclusion of mixed case chars and
6704 digits. This can pose a problem as some clients (such as Windows
6705 for Workgroups) uppercase the password before sending it.
6706 Note that if the unix password sync parameter is set to yes then
6708 this program is called AS ROOT before the SMB password in the
6709 smbpasswd file is changed. If this UNIX password change fails, then
6710 smbd will fail to change the SMB password also (this is by design).
6711 If the unix password sync parameter is set this parameter MUST USE
6713 ABSOLUTE PATHS for ALL programs called, and must be examined for
6714 security implications. Note that by default unix password sync is
6715 set to no.
6716 Default: passwd program =
6718 Example: passwd program = /bin/passwd %u
6720 password hash gpg key ids (G)
6722 If samba is running as an active directory domain controller, it is
6724 possible to store the cleartext password of accounts in a
6725 PGP/OpenGPG encrypted form.
6726 You can specify one or more recipients by key id or user id. Note
6728 that 32bit key ids are not allowed, specify at least 64bit.
6729 The value is stored as 'Primary:SambaGPG' in the
6731 supplementalCredentials attribute.
6732 As password changes can occur on any domain controller, you should
6734 configure this on each of them. Note that this feature is currently
6735 available only on Samba domain controllers.
6736 This option is only available if samba was compiled with gpgme
6738 support.
6739 You may need to export the GNUPGHOME environment variable before
6741 starting samba. It is strongly recommended to only store the
6742 public key in this location. The private key is not used for
6743 encryption and should be only stored where decryption is required.
6744 Being able to restore the cleartext password helps, when they need
6746 to be imported into other authentication systems later (see
6747 samba-tool user getpassword) or you want to keep the passwords in
6748 sync with another system, e.g. an OpenLDAP server (see samba-tool
6749 user syncpasswords).
6750 While this option needs to be configured on all domain controllers,
6752 the samba-tool user syncpasswords command should run on a single
6753 domain controller only (typically the PDC-emulator).
6754 Default: password hash gpg key ids =
6756 Example: password hash gpg key ids = 4952E40301FAB41A
6758 Example: password hash gpg key ids = selftest@samba.example.com
6760 Example: password hash gpg key ids = selftest@samba.example.com,
6762 4952E40301FAB41A
6763 password hash userPassword schemes (G)
6765 This parameter determines whether or not samba(8) acting as an
6767 Active Directory Domain Controller will attempt to store additional
6768 passwords hash types for the user
6769 The values are stored as 'Primary:userPassword' in the
6771 supplementalCredentials attribute. The value of this option is a
6772 hash type.
6773 The currently supported hash types are:
6775 • CryptSHA256
6777 • CryptSHA512
6779 Multiple instances of a hash type may be computed and stored. The
6781 password hashes are calculated using the crypt(3) call. The number
6782 of rounds used to compute the hash can be specified by adding
6783 ':rounds=xxxx' to the hash type, i.e. CryptSHA512:rounds=4500 would
6784 calculate an SHA512 hash using 4500 rounds. If not specified the
6785 Operating System defaults for crypt(3) are used.
6786 As password changes can occur on any domain controller, you should
6788 configure this on each of them. Note that this feature is currently
6789 available only on Samba domain controllers.
6790 Currently the NT Hash of the password is recorded when these hashes
6792 are calculated and stored. When retrieving the hashes the current
6793 value of the NT Hash is checked against the stored NT Hash. This
6794 detects password changes that have not updated the password hashes.
6795 In this case samba-tool user will ignore the stored hash values.
6796 Being able to obtain the hashed password helps, when they need to
6798 be imported into other authentication systems later (see samba-tool
6799 user getpassword) or you want to keep the passwords in sync with
6800 another system, e.g. an OpenLDAP server (see samba-tool user
6801 syncpasswords).
6802 Related command: unix password sync
6804 Default: password hash userPassword schemes =
6806 Example: password hash userPassword schemes = CryptSHA256
6808 Example: password hash userPassword schemes = CryptSHA256
6810 CryptSHA512
6811 Example: password hash userPassword schemes =
6813 CryptSHA256:rounds=5000 CryptSHA512:rounds=7000
6814 password server (G)
6816 By specifying the name of a domain controller with this option, and
6818 using security = [ads|domain] it is possible to get Samba to do all
6819 its username/password validation using a specific remote server.
6820 Ideally, this option should not be used, as the default '*'
6822 indicates to Samba to determine the best DC to contact dynamically,
6823 just as all other hosts in an AD domain do. This allows the domain
6824 to be maintained (addition and removal of domain controllers)
6825 without modification to the smb.conf file. The cryptographic
6826 protection on the authenticated RPC calls used to verify passwords
6827 ensures that this default is safe.
6828 It is strongly recommended that you use the default of '*', however
6830 if in your particular environment you have reason to specify a
6831 particular DC list, then the list of machines in this option must
6832 be a list of names or IP addresses of Domain controllers for the
6833 Domain. If you use the default of '*', or list several hosts in the
6834 password server option then smbd will try each in turn till it
6835 finds one that responds. This is useful in case your primary server
6836 goes down.
6837 If the list of servers contains both names/IP's and the '*'
6839 character, the list is treated as a list of preferred domain
6840 controllers, but an auto lookup of all remaining DC's will be added
6841 to the list as well. Samba will not attempt to optimize this list
6842 by locating the closest DC.
6843 If parameter is a name, it is looked up using the parameter name
6845 resolve order and so may resolved by any method and order described
6846 in that parameter.
6847 Default: password server = *
6849 Example: password server = NT-PDC, NT-BDC1, NT-BDC2, *
6851 Example: password server = windc.mydomain.com:389 192.168.1.101 *
6853 directory
6855 This parameter is a synonym for path.
6857 path (S)
6859 This parameter specifies a directory to which the user of the
6861 service is to be given access. In the case of printable services,
6862 this is where print data will spool prior to being submitted to the
6863 host for printing.
6864 For a printable service offering guest access, the service should
6866 be readonly and the path should be world-writeable and have the
6867 sticky bit set. This is not mandatory of course, but you probably
6868 won't get the results you expect if you do otherwise.
6869 Any occurrences of %u in the path will be replaced with the UNIX
6871 username that the client is using on this connection. Any
6872 occurrences of %m will be replaced by the NetBIOS name of the
6873 machine they are connecting from. These replacements are very
6874 useful for setting up pseudo home directories for users.
6875 Note that this path will be based on root dir if one was specified.
6877 Default: path =
6879 Example: path = /home/fred
6881 perfcount module (G)
6883 This parameter specifies the perfcount backend to be used when
6885 monitoring SMB operations. Only one perfcount module may be used,
6886 and it must implement all of the apis contained in the
6887 smb_perfcount_handler structure defined in smb.h.
6888 No default
6890 pid directory (G)
6892 This option specifies the directory where pid files will be placed.
6894 Default: pid directory = /run
6896 Example: pid directory = /var/run/
6898 posix locking (S)
6900 The smbd(8) daemon maintains an database of file locks obtained by
6902 SMB clients. The default behavior is to map this internal database
6903 to POSIX locks. This means that file locks obtained by SMB clients
6904 are consistent with those seen by POSIX compliant applications
6905 accessing the files via a non-SMB method (e.g. NFS or local file
6906 access). It is very unlikely that you need to set this parameter to
6907 "no", unless you are sharing from an NFS mount, which is not a good
6908 idea in the first place.
6909 Default: posix locking = yes
6911 postexec (S)
6913 This option specifies a command to be run whenever the service is
6915 disconnected. It takes the usual substitutions. The command may be
6916 run as the root on some systems.
6917 An interesting example may be to unmount server resources:
6919 postexec = /etc/umount /cdrom
6921 Default: postexec =
6923 Example: postexec = echo \"%u disconnected from %S from %m (%I)\"
6925 >> /tmp/log
6926 exec
6928 This parameter is a synonym for preexec.
6930 preexec (S)
6932 This option specifies a command to be run whenever the service is
6934 connected to. It takes the usual substitutions.
6935 An interesting example is to send the users a welcome message every
6937 time they log in. Maybe a message of the day? Here is an example:
6938 preexec = csh -c 'echo \"Welcome to %S!\" |
6940 /usr/local/samba/bin/smbclient -M %m -I %I' &
6941 Of course, this could get annoying after a while :-)
6943 See also preexec close and postexec.
6945 Default: preexec =
6947 Example: preexec = echo \"%u connected to %S from %m (%I)\" >>
6949 /tmp/log
6950 preexec close (S)
6952 This boolean option controls whether a non-zero return code from
6954 preexec should close the service being connected to.
6955 Default: preexec close = no
6957 prefered master
6959 This parameter is a synonym for preferred master.
6961 preferred master (G)
6963 This boolean parameter controls if nmbd(8) is a preferred master
6965 browser for its workgroup.
6966 If this is set to yes, on startup, nmbd will force an election, and
6968 it will have a slight advantage in winning the election. It is
6969 recommended that this parameter is used in conjunction with domain
6970 master = yes, so that nmbd can guarantee becoming a domain master.
6971 Use this option with caution, because if there are several hosts
6973 (whether Samba servers, Windows 95 or NT) that are preferred master
6974 browsers on the same subnet, they will each periodically and
6975 continuously attempt to become the local master browser. This will
6976 result in unnecessary broadcast traffic and reduced browsing
6977 capabilities.
6978 Default: preferred master = auto
6980 prefork backoff increment (G)
6982 This option specifies the number of seconds added to the delay
6984 before a prefork master or worker process is restarted. The restart
6985 is initially zero, the prefork backoff increment is added to the
6986 delay on each restart up to the value specified by "prefork maximum
6987 backoff".
6988 Additionally the the backoff for an individual service by using
6990 "prefork backoff increment: service name" i.e. "prefork backoff
6991 increment:ldap = 2" to set the backoff increment to 2.
6992 If the backoff increment is 2 and the maximum backoff is 5. There
6994 will be a zero second delay for the first restart. A two second
6995 delay for the second restart. A four second delay for the third and
6996 any subsequent restarts
6997 Default: prefork backoff increment = 10
6999 prefork children (G)
7001 This option controls the number of worker processes that are
7003 started for each service when prefork process model is enabled (see
7004 samba(8) -M) The prefork children are only started for those
7005 services that support prefork (currently ldap, kdc and netlogon).
7006 For processes that don't support preforking all requests are
7007 handled by a single process for that service.
7008 This should be set to a small multiple of the number of CPU's
7010 available on the server
7011 Additionally the number of prefork children can be specified for an
7013 individual service by using "prefork children: service name" i.e.
7014 "prefork children:ldap = 8" to set the number of ldap worker
7015 processes.
7016 Default: prefork children = 4
7018 prefork maximum backoff (G)
7020 This option controls the maximum delay before a failed pre-fork
7022 process is restarted.
7023 Default: prefork maximum backoff = 120
7025 preload modules (G)
7027 This is a list of paths to modules that should be loaded into smbd
7029 before a client connects. This improves the speed of smbd when
7030 reacting to new connections somewhat.
7031 Default: preload modules =
7033 Example: preload modules = /usr/lib/samba/passdb/mysql.so
7035 preserve case (S)
7037 This controls if new filenames are created with the case that the
7039 client passes, or if they are forced to be the default case.
7040 See the section on NAME MANGLING for a fuller discussion.
7042 Default: preserve case = yes
7044 print ok
7046 This parameter is a synonym for printable.
7048 printable (S)
7050 If this parameter is yes, then clients may open, write to and
7052 submit spool files on the directory specified for the service.
7053 Note that a printable service will ALWAYS allow writing to the
7055 service path (user privileges permitting) via the spooling of print
7056 data. The read only parameter controls only non-printing access to
7057 the resource.
7058 Default: printable = no
7060 printcap cache time (G)
7062 This option specifies the number of seconds before the printing
7064 subsystem is again asked for the known printers.
7065 Setting this parameter to 0 disables any rescanning for new or
7067 removed printers after the initial startup.
7068 Default: printcap cache time = 750
7070 Example: printcap cache time = 600
7072 printcap
7074 This parameter is a synonym for printcap name.
7076 printcap name (G)
7078 This parameter may be used to override the compiled-in default
7080 printcap name used by the server (usually /etc/printcap). See the
7081 discussion of the [printers] section above for reasons why you
7082 might want to do this.
7083 To use the CUPS printing interface set printcap name = cups. This
7085 should be supplemented by an additional setting printing = cups in
7086 the [global] section. printcap name = cups will use the "dummy"
7087 printcap created by CUPS, as specified in your CUPS configuration
7088 file.
7089 On System V systems that use lpstat to list available printers you
7091 can use printcap name = lpstat to automatically obtain lists of
7092 available printers. This is the default for systems that define
7093 SYSV at configure time in Samba (this includes most System V based
7094 systems). If
7095 printcap name is set to lpstat on these systems then Samba will
7096 launch lpstat -v and attempt to parse the output to obtain a
7097 printer list.
7098 A minimal printcap file would look something like this:
7100 print1|My Printer 1
7102 print2|My Printer 2
7103 print3|My Printer 3
7104 print4|My Printer 4
7105 print5|My Printer 5
7106 where the '|' separates aliases of a printer. The fact that the
7108 second alias has a space in it gives a hint to Samba that it's a
7109 comment.
7110 Note
7112 Under AIX the default printcap name is /etc/qconfig. Samba will
7113 assume the file is in AIX qconfig format if the string qconfig
7114 appears in the printcap filename.
7115 Default: printcap name = /etc/printcap
7116 Example: printcap name = /etc/myprintcap
7118 print command (S)
7120 After a print job has finished spooling to a service, this command
7122 will be used via a system() call to process the spool file.
7123 Typically the command specified will submit the spool file to the
7124 host's printing subsystem, but there is no requirement that this be
7125 the case. The server will not remove the spool file, so whatever
7126 command you specify should remove the spool file when it has been
7127 processed, otherwise you will need to manually remove old spool
7128 files.
7129 The print command is simply a text string. It will be used verbatim
7131 after macro substitutions have been made:
7132 %s, %f - the path to the spool file name
7134 %p - the appropriate printer name
7136 %J - the job name as transmitted by the client.
7138 %c - The number of printed pages of the spooled job (if known).
7140 %z - the size of the spooled print job (in bytes)
7142 The print command MUST contain at least one occurrence of %s or %f
7144 - the %p is optional. At the time a job is submitted, if no printer
7145 name is supplied the %p will be silently removed from the printer
7146 command.
7147 If specified in the [global] section, the print command given will
7149 be used for any printable service that does not have its own print
7150 command specified.
7151 If there is neither a specified print command for a printable
7153 service nor a global print command, spool files will be created but
7154 not processed and (most importantly) not removed.
7155 Note that printing may fail on some UNIXes from the nobody account.
7157 If this happens then create an alternative guest account that can
7158 print and set the guest account in the [global] section.
7159 You can form quite complex print commands by realizing that they
7161 are just passed to a shell. For example the following will log a
7162 print job, print the file, then remove it. Note that ';' is the
7163 usual separator for command in shell scripts.
7164 print command = echo Printing %s >> /tmp/print.log; lpr -P %p %s;
7166 rm %s
7167 You may have to vary this command considerably depending on how you
7169 normally print files on your system. The default for the parameter
7170 varies depending on the setting of the printing parameter.
7171 Default: For printing = BSD, AIX, QNX, LPRNG or PLP :
7173 print command = lpr -r -P%p %s
7175 For printing = SYSV or HPUX :
7177 print command = lp -c -d%p %s; rm %s
7179 For printing = SOFTQ :
7181 print command = lp -d%p -s %s; rm %s
7183 For printing = CUPS : If SAMBA is compiled against libcups, then
7185 printcap = cups uses the CUPS API to submit jobs, etc. Otherwise it
7186 maps to the System V commands with the -oraw option for printing,
7187 i.e. it uses lp -c -d%p -oraw; rm %s. With printing = cups, and if
7188 SAMBA is compiled against libcups, any manually set print command
7189 will be ignored.
7190 No default
7192 Example: print command = /usr/local/samba/bin/myprintscript %p %s
7194 printer
7196 This parameter is a synonym for printer name.
7198 printer name (S)
7200 This parameter specifies the name of the printer to which print
7202 jobs spooled through a printable service will be sent.
7203 If specified in the [global] section, the printer name given will
7205 be used for any printable service that does not have its own
7206 printer name specified.
7207 The default value of the printer name may be lp on many systems.
7209 Default: printer name =
7211 Example: printer name = laserwriter
7213 printing (S)
7215 This parameters controls how printer status information is
7217 interpreted on your system. It also affects the default values for
7218 the print command, lpq command, lppause command , lpresume command,
7219 and lprm command if specified in the [global] section.
7220 Currently nine printing styles are supported. They are BSD, AIX,
7222 LPRNG, PLP, SYSV, HPUX, QNX, SOFTQ, CUPS and IPRINT.
7223 Be aware that CUPS and IPRINT are only available if the CUPS
7225 development library was available at the time Samba was compiled or
7226 packaged.
7227 To see what the defaults are for the other print commands when
7229 using the various options use the testparm(1) program.
7230 This option can be set on a per printer basis. Please be aware
7232 however, that you must place any of the various printing commands
7233 (e.g. print command, lpq command, etc...) after defining the value
7234 for the printing option since it will reset the printing commands
7235 to default values.
7236 See also the discussion in the [printers] section.
7238 See testparm -v. for the default value on your system
7240 Default: printing = # Depends on the operating system
7242 printjob username (S)
7244 This parameter specifies which user information will be passed to
7246 the printing system. Usually, the username is sent, but in some
7247 cases, e.g. the domain prefix is useful, too.
7248 Default: printjob username = %U
7250 Example: printjob username = %D\%U
7252 print notify backchannel (S)
7254 Windows print clients can update print queue status by expecting
7256 the server to open a backchannel SMB connection to them. Due to
7257 client firewall settings this can cause considerable timeouts and
7258 will often fail, as there is no guarantee the client is even
7259 running an SMB server. By default, the Samba print server will not
7260 try to connect back to clients, and will treat corresponding
7261 requests as if the connection back to the client failed.
7262 Default: print notify backchannel = no
7264 private directory
7266 This parameter is a synonym for private dir.
7268 private dir (G)
7270 This parameters defines the directory smbd will use for storing
7272 such files as smbpasswd and secrets.tdb.
7273 Default: private dir = /var/lib/samba/private
7275 queuepause command (S)
7277 This parameter specifies the command to be executed on the server
7279 host in order to pause the printer queue.
7280 This command should be a program or script which takes a printer
7282 name as its only parameter and stops the printer queue, such that
7283 no longer jobs are submitted to the printer.
7284 This command is not supported by Windows for Workgroups, but can be
7286 issued from the Printers window under Windows 95 and NT.
7287 If a %p is given then the printer name is put in its place.
7289 Otherwise it is placed at the end of the command.
7290 Note that it is good practice to include the absolute path in the
7292 command as the PATH may not be available to the server.
7293 Default: queuepause command = # determined by printing parameter
7295 Example: queuepause command = disable %p
7297 queueresume command (S)
7299 This parameter specifies the command to be executed on the server
7301 host in order to resume the printer queue. It is the command to
7302 undo the behavior that is caused by the previous parameter
7303 (queuepause command).
7304 This command should be a program or script which takes a printer
7306 name as its only parameter and resumes the printer queue, such that
7307 queued jobs are resubmitted to the printer.
7308 This command is not supported by Windows for Workgroups, but can be
7310 issued from the Printers window under Windows 95 and NT.
7311 If a %p is given then the printer name is put in its place.
7313 Otherwise it is placed at the end of the command.
7314 Note that it is good practice to include the absolute path in the
7316 command as the PATH may not be available to the server.
7317 Default: queueresume command = # determined by printing parameter
7319 Example: queueresume command = enable %p
7321 raw NTLMv2 auth (G)
7323 This parameter has been deprecated since Samba 4.13 and support for
7325 NTLMv2 authentication without NTLMSSP will be removed in a future
7326 Samba release.
7327 That is, in the future, the current default of raw NTLMv2 auth = no
7329 will be the enforced behaviour.
7330 This parameter determines whether or not smbd(8) will allow SMB1
7332 clients without extended security (without SPNEGO) to use NTLMv2
7333 authentication.
7334 If this option, lanman auth and ntlm auth are all disabled, then
7336 only clients with SPNEGO support will be permitted. That means
7337 NTLMv2 is only supported within NTLMSSP.
7338 Default: raw NTLMv2 auth = no
7340 read list (S)
7342 This is a list of users that are given read-only access to a
7344 service. If the connecting user is in this list then they will not
7345 be given write access, no matter what the read only option is set
7346 to. The list can include group names using the syntax described in
7347 the invalid users parameter.
7348 Default: read list =
7350 Example: read list = mary, @students
7352 read only (S)
7354 An inverted synonym is writeable.
7356 If this parameter is yes, then users of a service may not create or
7358 modify files in the service's directory.
7359 Note that a printable service (printable = yes) will ALWAYS allow
7361 writing to the directory (user privileges permitting), but only via
7362 spooling operations.
7363 Default: read only = yes
7365 read raw (G)
7367 This is ignored if async smb echo handler is set, because this
7369 feature is incompatible with raw read SMB requests
7370 If enabled, raw reads allow reads of 65535 bytes in one packet.
7372 This typically provides a major performance benefit for some very,
7373 very old clients.
7374 However, some clients either negotiate the allowable block size
7376 incorrectly or are incapable of supporting larger block sizes, and
7377 for these clients you may need to disable raw reads.
7378 In general this parameter should be viewed as a system tuning tool
7380 and left severely alone.
7381 Default: read raw = yes
7383 realm (G)
7385 This option specifies the kerberos realm to use. The realm is used
7387 as the ADS equivalent of the NT4 domain. It is usually set to the
7388 DNS name of the kerberos server.
7389 Default: realm =
7391 Example: realm = mysambabox.mycompany.com
7393 registry shares (G)
7395 This turns on or off support for share definitions read from
7397 registry. Shares defined in smb.conf take precedence over shares
7398 with the same name defined in registry. See the section on
7399 registry-based configuration for details.
7400 Note that this parameter defaults to no, but it is set to yes when
7402 config backend is set to registry.
7403 Default: registry shares = no
7405 Example: registry shares = yes
7407 reject md5 clients (G)
7409 This option controls whether the netlogon server (currently only in
7411 'active directory domain controller' mode), will reject clients
7412 which does not support NETLOGON_NEG_SUPPORTS_AES.
7413 You can set this to yes if all domain members support aes. This
7415 will prevent downgrade attacks.
7416 This option takes precedence to the 'allow nt4 crypto' option.
7418 Default: reject md5 clients = no
7420 reject md5 servers (G)
7422 This option controls whether winbindd requires support for aes
7424 support for the netlogon secure channel.
7425 The following flags will be required NETLOGON_NEG_ARCFOUR,
7427 NETLOGON_NEG_SUPPORTS_AES, NETLOGON_NEG_PASSWORD_SET2 and
7428 NETLOGON_NEG_AUTHENTICATED_RPC.
7429 You can set this to yes if all domain controllers support aes. This
7431 will prevent downgrade attacks.
7432 The behavior can be controlled per netbios domain by using 'reject
7434 md5 servers:NETBIOSDOMAIN = yes' as option.
7435 This option takes precedence to the require strong key option.
7437 Default: reject md5 servers = no
7439 remote announce (G)
7441 This option allows you to setup nmbd(8) to periodically announce
7443 itself to arbitrary IP addresses with an arbitrary workgroup name.
7444 This is useful if you want your Samba server to appear in a remote
7446 workgroup for which the normal browse propagation rules don't work.
7447 The remote workgroup can be anywhere that you can send IP packets
7448 to.
7449 For example:
7451 remote announce = 192.168.2.255/SERVERS 192.168.4.255/STAFF
7453 the above line would cause nmbd to announce itself to the two given
7455 IP addresses using the given workgroup names. If you leave out the
7456 workgroup name, then the one given in the workgroup parameter is
7457 used instead.
7458 The IP addresses you choose would normally be the broadcast
7460 addresses of the remote networks, but can also be the IP addresses
7461 of known browse masters if your network config is that stable.
7462 See the chapter on Network Browsing in the Samba-HOWTO book.
7464 Default: remote announce =
7466 remote browse sync (G)
7468 This option allows you to setup nmbd(8) to periodically request
7470 synchronization of browse lists with the master browser of a Samba
7471 server that is on a remote segment. This option will allow you to
7472 gain browse lists for multiple workgroups across routed networks.
7473 This is done in a manner that does not work with any non-Samba
7474 servers.
7475 This is useful if you want your Samba server and all local clients
7477 to appear in a remote workgroup for which the normal browse
7478 propagation rules don't work. The remote workgroup can be anywhere
7479 that you can send IP packets to.
7480 For example:
7482 remote browse sync = 192.168.2.255 192.168.4.255
7484 the above line would cause nmbd to request the master browser on
7486 the specified subnets or addresses to synchronize their browse
7487 lists with the local server.
7488 The IP addresses you choose would normally be the broadcast
7490 addresses of the remote networks, but can also be the IP addresses
7491 of known browse masters if your network config is that stable. If a
7492 machine IP address is given Samba makes NO attempt to validate that
7493 the remote machine is available, is listening, nor that it is in
7494 fact the browse master on its segment.
7495 The remote browse sync may be used on networks where there is no
7497 WINS server, and may be used on disjoint networks where each
7498 network has its own WINS server.
7499 Default: remote browse sync =
7501 rename user script (G)
7503 This is the full pathname to a script that will be run as root by
7505 smbd(8) under special circumstances described below.
7506 When a user with admin authority or SeAddUserPrivilege rights
7508 renames a user (e.g.: from the NT4 User Manager for Domains), this
7509 script will be run to rename the POSIX user. Two variables, %uold
7510 and %unew, will be substituted with the old and new usernames,
7511 respectively. The script should return 0 upon successful
7512 completion, and nonzero otherwise.
7513 Note
7515 The script has all responsibility to rename all the necessary
7516 data that is accessible in this posix method. This can mean
7517 different requirements for different backends. The tdbsam and
7518 smbpasswd backends will take care of the contents of their
7519 respective files, so the script is responsible only for
7520 changing the POSIX username, and other data that may required
7521 for your circumstances, such as home directory. Please also
7522 consider whether or not you need to rename the actual home
7523 directories themselves. The ldapsam backend will not make any
7524 changes, because of the potential issues with renaming the LDAP
7525 naming attribute. In this case the script is responsible for
7526 changing the attribute that samba uses (uid) for locating
7527 users, as well as any data that needs to change for other
7528 applications using the same directory.
7529 Default: rename user script =
7530 require strong key (G)
7532 This option controls whether winbindd requires support for md5
7534 strong key support for the netlogon secure channel.
7535 The following flags will be required NETLOGON_NEG_STRONG_KEYS,
7537 NETLOGON_NEG_ARCFOUR and NETLOGON_NEG_AUTHENTICATED_RPC.
7538 You can set this to no if some domain controllers only support des.
7540 This might allows weak crypto to be negotiated, may via downgrade
7541 attacks.
7542 The behavior can be controlled per netbios domain by using 'require
7544 strong key:NETBIOSDOMAIN = no' as option.
7545 Note for active directory domain this option is hardcoded to 'yes'
7547 This option yields precedence to the reject md5 servers option.
7549 This option takes precedence to the client schannel option.
7551 Default: require strong key = yes
7553 reset on zero vc (G)
7555 This boolean option controls whether an incoming SMB1 session setup
7557 should kill other connections coming from the same IP. This matches
7558 the default Windows 2003 behaviour. Setting this parameter to yes
7559 becomes necessary when you have a flaky network and windows decides
7560 to reconnect while the old connection still has files with share
7561 modes open. These files become inaccessible over the new
7562 connection. The client sends a zero VC on the new connection, and
7563 Windows 2003 kills all other connections coming from the same IP.
7564 This way the locked files are accessible again. Please be aware
7565 that enabling this option will kill connections behind a
7566 masquerading router, and will not trigger for clients that only use
7567 SMB2 or SMB3.
7568 Default: reset on zero vc = no
7570 restrict anonymous (G)
7572 The setting of this parameter determines whether SAMR and LSA
7574 DCERPC services can be accessed anonymously. This corresponds to
7575 the following Windows Server registry options:
7576 HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Lsa\RestrictAnonymous
7578 The option also affects the browse option which is required by
7581 legacy clients which rely on Netbios browsing. While modern Windows
7582 version should be fine with restricting the access there could
7583 still be applications relying on anonymous access.
7584 Setting restrict anonymous = 1 will disable anonymous SAMR access.
7586 Setting restrict anonymous = 2 will, in addition to restricting
7588 SAMR access, disallow anonymous connections to the IPC$ share in
7589 general. Setting guest ok = yes on any share will remove the
7590 security advantage.
7591 Default: restrict anonymous = 0
7593 root
7595 This parameter is a synonym for root directory.
7597 root dir
7599 This parameter is a synonym for root directory.
7601 root directory (G)
7603 The server will chroot() (i.e. Change its root directory) to this
7605 directory on startup. This is not strictly necessary for secure
7606 operation. Even without it the server will deny access to files not
7607 in one of the service entries. It may also check for, and deny
7608 access to, soft links to other parts of the filesystem, or attempts
7609 to use ".." in file names to access other directories (depending on
7610 the setting of the wide smbconfoptions parameter).
7611 Adding a root directory entry other than "/" adds an extra level of
7613 security, but at a price. It absolutely ensures that no access is
7614 given to files not in the sub-tree specified in the root directory
7615 option, including some files needed for complete operation of the
7616 server. To maintain full operability of the server you will need to
7617 mirror some system files into the root directory tree. In
7618 particular you will need to mirror /etc/passwd (or a subset of it),
7619 and any binaries or configuration files needed for printing (if
7620 required). The set of files that must be mirrored is operating
7621 system dependent.
7622 Default: root directory =
7624 Example: root directory = /homes/smb
7626 root postexec (S)
7628 This is the same as the postexec parameter except that the command
7630 is run as root. This is useful for unmounting filesystems (such as
7631 CDROMs) after a connection is closed.
7632 Default: root postexec =
7634 root preexec (S)
7636 This is the same as the preexec parameter except that the command
7638 is run as root. This is useful for mounting filesystems (such as
7639 CDROMs) when a connection is opened.
7640 Default: root preexec =
7642 root preexec close (S)
7644 This is the same as the preexec close parameter except that the
7646 command is run as root.
7647 Default: root preexec close = no
7649 rpc big endian (G)
7651 Setting this option will force the RPC client and server to
7653 transfer data in big endian.
7654 If it is disabled, data will be transferred in little endian.
7656 The behaviour is independent of the endianness of the host machine.
7658 Default: rpc big endian = no
7660 rpc_daemon:DAEMON (G)
7662 Defines whether to use the embedded code or start a separate daemon
7664 for the defined rpc services. The rpc_daemon prefix must be
7665 followed by the server name, and a value.
7666 Two possible values are currently supported:
7668 disabled
7670 fork
7671 The classic method is to run rpc services as internal daemons
7674 embedded in smbd, therefore the external daemons are disabled by
7675 default.
7676 Choosing the fork option will cause samba to fork a separate
7678 process for each daemon configured this way. Each daemon may in
7679 turn fork a number of children used to handle requests from
7680 multiple smbds and direct tcp/ip connections (if the Endpoint
7681 Mapper is enabled). Communication with smbd happens over named
7682 pipes and require that said pipes are forward to the external
7683 daemon (see rpc_server).
7684 Forked RPC Daemons support dynamically forking children to handle
7686 connections. The heuristics about how many children to keep around
7687 and how fast to allow them to fork and also how many clients each
7688 child is allowed to handle concurrently is defined by parametrical
7689 options named after the daemon. Five options are currently
7690 supported:
7691 prefork_min_children
7693 prefork_max_children
7694 prefork_spawn_rate
7695 prefork_max_allowed_clients
7696 prefork_child_min_life
7697 To set one of these options use the following syntax:
7700 daemonname:prefork_min_children = 5
7702 Samba includes separate daemons for spoolss, lsarpc/lsass,
7705 netlogon, samr, FSRVP and mdssvc(Spotlight). Currently five daemons
7706 are available and they are called:
7707 epmd
7709 lsasd
7710 spoolssd
7711 fssd
7712 mdssd
7713 Example:
7716 rpc_daemon:spoolssd = fork
7718 Default: rpc_daemon:DAEMON = disabled
7721 rpc_server:SERVER (G)
7723 With this option you can define if a rpc service should be running
7725 internal/embedded in smbd or should be redirected to an external
7726 daemon like Samba4, the endpoint mapper daemon, the spoolss daemon
7727 or the new LSA service daemon. The rpc_server prefix must be
7728 followed by the pipe name, and a value.
7729 This option can be set for each available rpc service in Samba. The
7731 following list shows all available pipe names services you can
7732 modify with this option.
7733 • epmapper - Endpoint Mapper
7735 • winreg - Remote Registry Service
7737 • srvsvc - Remote Server Services
7739 • lsarpc - Local Security Authority
7741 • samr - Security Account Management
7743 • netlogon - Netlogon Remote Protocol
7745 • netdfs - Settings for Distributed File System
7747 • dssetup - Active Directory Setup
7749 • wkssvc - Workstation Services
7751 • spoolss - Network Printing Spooler
7753 • svcctl - Service Control
7755 • ntsvcs - Plug and Play Services
7757 • eventlog - Event Logger
7759 • initshutdown - Init Shutdown Service
7761 • mdssvc - Spotlight
7763 Three possible values currently supported are: embedded external
7765 disabled
7766 The classic method is to run every pipe as an internal function
7768 embedded in smbd. The defaults may vary depending on the service.
7769 Choosing the external option allows one to run a separate daemon or
7771 even a completely independent (3rd party) server capable of
7772 interfacing with samba via the MS-RPC interface over named pipes.
7773 Currently in Samba3 we support four daemons, spoolssd, epmd, lsasd
7775 and mdssd. These daemons can be enabled using the rpc_daemon
7776 option. For spoolssd you have to enable the daemon and proxy the
7777 named pipe with:
7778 Examples:
7780 rpc_daemon:lsasd = fork
7782 rpc_server:lsarpc = external
7783 rpc_server:samr = external
7784 rpc_server:netlogon = external
7785 rpc_server:spoolss = external
7787 rpc_server:epmapper = disabled
7788 rpc_daemon:mdssd = fork
7790 rpc_server:mdssvc = external
7791 There is one special option which allows you to enable rpc services
7794 to listen for ncacn_ip_tcp connections too. Currently this is only
7795 used for testing and doesn't scale!
7796 rpc_server:tcpip = yes
7798 Default: rpc_server:SERVER = embedded
7801 rpc server dynamic port range (G)
7803 This parameter tells the RPC server which port range it is allowed
7805 to use to create a listening socket for LSA, SAM, Netlogon and
7806 others without wellknown tcp ports. The first value is the lowest
7807 number of the port range and the second the highest.
7808 This applies to RPC servers in all server roles.
7810 Default: rpc server dynamic port range = 49152-65535
7812 rpc server port (G)
7814 Specifies which port the server should listen on for DCE/RPC over
7816 TCP/IP traffic.
7817 This controls the default port for all protocols, except for
7819 NETLOGON.
7820 If unset, the first available port from rpc server dynamic port
7822 range is used, e.g. 49152.
7823 The NETLOGON server will use the next available port, e.g. 49153.
7825 To change this port use (eg) rpc server port:netlogon = 4000.
7826 Furthermore, all RPC servers can have the port they use specified
7828 independenty, with (for example) rpc server port:drsuapi = 5000.
7829 This option applies currently only when samba(8) runs as an active
7831 directory domain controller.
7832 The default value 0 causes Samba to select the first available port
7834 from rpc server dynamic port range.
7835 Default: rpc server port = 0
7837 samba kcc command (G)
7839 This option specifies the path to the Samba KCC command. This
7841 script is used for replication topology replication.
7842 It should not be necessary to modify this option except for testing
7844 purposes or if the samba_kcc was installed in a non-default
7845 location.
7846 Default: samba kcc command =
7848 /builddir/build/BUILD/samba-4.14.5/source4/scripting/bin/samba_kcc
7849 Example: samba kcc command = /usr/local/bin/kcc
7851 security (G)
7853 This option affects how clients respond to Samba and is one of the
7855 most important settings in the smb.conf file.
7856 The default is security = user, as this is the most common setting,
7858 used for a standalone file server or a DC.
7859 The alternatives are security = ads or security = domain, which
7861 support joining Samba to a Windows domain
7862 You should use security = user and map to guest if you want to
7864 mainly setup shares without a password (guest shares). This is
7865 commonly used for a shared printer server.
7866 The different settings will now be explained.
7868 SECURITY = AUTO
7870 This is the default security setting in Samba, and causes Samba to
7872 consult the server role parameter (if set) to determine the
7873 security mode.
7874 SECURITY = USER
7876 If server role is not specified, this is the default security
7878 setting in Samba. With user-level security a client must first
7879 "log-on" with a valid username and password (which can be mapped
7880 using the username map parameter). Encrypted passwords (see the
7881 encrypted passwords parameter) can also be used in this security
7882 mode. Parameters such as user and guest only if set are then
7883 applied and may change the UNIX user to use on this connection, but
7884 only after the user has been successfully authenticated.
7885 Note that the name of the resource being requested is not sent to
7887 the server until after the server has successfully authenticated
7888 the client. This is why guest shares don't work in user level
7889 security without allowing the server to automatically map unknown
7890 users into the guest account. See the map to guest parameter for
7891 details on doing this.
7892 SECURITY = DOMAIN
7894 This mode will only work correctly if net(8) has been used to add
7896 this machine into a Windows NT Domain. It expects the encrypted
7897 passwords parameter to be set to yes. In this mode Samba will try
7898 to validate the username/password by passing it to a Windows NT
7899 Primary or Backup Domain Controller, in exactly the same way that a
7900 Windows NT Server would do.
7901 Note that a valid UNIX user must still exist as well as the account
7903 on the Domain Controller to allow Samba to have a valid UNIX
7904 account to map file access to.
7905 Note that from the client's point of view security = domain is the
7907 same as security = user. It only affects how the server deals with
7908 the authentication, it does not in any way affect what the client
7909 sees.
7910 Note that the name of the resource being requested is not sent to
7912 the server until after the server has successfully authenticated
7913 the client. This is why guest shares don't work in user level
7914 security without allowing the server to automatically map unknown
7915 users into the guest account. See the map to guest parameter for
7916 details on doing this.
7917 See also the password server parameter and the encrypted passwords
7919 parameter.
7920 SECURITY = ADS
7922 In this mode, Samba will act as a domain member in an ADS realm. To
7924 operate in this mode, the machine running Samba will need to have
7925 Kerberos installed and configured and Samba will need to be joined
7926 to the ADS realm using the net utility.
7927 Note that this mode does NOT make Samba operate as a Active
7929 Directory Domain Controller.
7930 Note that this forces require strong key = yes and client schannel
7932 = yes for the primary domain.
7933 Read the chapter about Domain Membership in the HOWTO for details.
7935 Default: security = AUTO
7937 Example: security = DOMAIN
7939 security mask (S)
7941 This parameter has been removed for Samba 4.0.0.
7943 No default
7945 max protocol
7947 This parameter is a synonym for server max protocol.
7949 protocol
7951 This parameter is a synonym for server max protocol.
7953 server max protocol (G)
7955 The value of the parameter (a string) is the highest protocol level
7957 that will be supported by the server.
7958 Possible values are :
7960 • LANMAN1: First modern version of the protocol. Long
7962 filename support.
7963 • LANMAN2: Updates to Lanman1 protocol.
7965 • NT1: Current up to date version of the protocol. Used by
7967 Windows NT. Known as CIFS.
7968 • SMB2: Re-implementation of the SMB protocol. Used by
7970 Windows Vista and later versions of Windows. SMB2 has
7971 sub protocols available.
7972 • SMB2_02: The earliest SMB2 version.
7974 • SMB2_10: Windows 7 SMB2 version.
7976 • SMB2_22: Early Windows 8 SMB2 version.
7978 • SMB2_24: Windows 8 beta SMB2 version.
7980 By default SMB2 selects the SMB2_10 variant.
7982 • SMB3: The same as SMB2. Used by Windows 8. SMB3 has sub
7984 protocols available.
7985 • SMB3_00: Windows 8 SMB3 version. (mostly the
7987 same as SMB2_24)
7988 • SMB3_02: Windows 8.1 SMB3 version.
7990 • SMB3_10: early Windows 10 technical preview
7992 SMB3 version.
7993 • SMB3_11: Windows 10 technical preview SMB3
7995 version (maybe final).
7996 By default SMB3 selects the SMB3_11 variant.
7998 Normally this option should not be set as the automatic negotiation
8000 phase in the SMB protocol takes care of choosing the appropriate
8001 protocol.
8002 Default: server max protocol = SMB3
8004 Example: server max protocol = LANMAN1
8006 min protocol
8008 This parameter is a synonym for server min protocol.
8010 server min protocol (G)
8012 This setting controls the minimum protocol version that the server
8014 will allow the client to use.
8015 Normally this option should not be set as the automatic negotiation
8017 phase in the SMB protocol takes care of choosing the appropriate
8018 protocol unless you have legacy clients which are SMB1 capable
8019 only.
8020 See Related command: server max protocol for a full list of
8022 available protocols.
8023 Default: server min protocol = SMB2_02
8025 Example: server min protocol = NT1
8027 server multi channel support (G)
8029 This boolean parameter controls whether smbd(8) will support SMB3
8031 multi-channel.
8032 This parameter was added with version 4.4.
8034 Warning: Note that this feature is still considered experimental.
8036 Use it at your own risk: Even though it may seem to work well in
8037 testing, it may result in data corruption under some race
8038 conditions. Future releases may improve this situation.
8039 Due to dependencies to kernel APIs of Linux or FreeBSD, it's only
8041 possible to use this feature on Linux and FreeBSD for now. For
8042 testing this restriction can be overwritten by specifying
8043 force:server multi channel support=yes in addition.
8044 Default: server multi channel support = no
8046 server role (G)
8048 This option determines the basic operating mode of a Samba server
8050 and is one of the most important settings in the smb.conf file.
8051 The default is server role = auto, as causes Samba to operate
8053 according to the security setting, or if not specified as a simple
8054 file server that is not connected to any domain.
8055 The alternatives are server role = standalone or server role =
8057 member server, which support joining Samba to a Windows domain,
8058 along with server role = domain controller, which run Samba as a
8059 Windows domain controller.
8060 You should use server role = standalone and map to guest if you
8062 want to mainly setup shares without a password (guest shares). This
8063 is commonly used for a shared printer server.
8064 SERVER ROLE = AUTO
8066 This is the default server role in Samba, and causes Samba to
8068 consult the security parameter (if set) to determine the server
8069 role, giving compatible behaviours to previous Samba versions.
8070 SERVER ROLE = STANDALONE
8072 If security is also not specified, this is the default security
8074 setting in Samba. In standalone operation, a client must first
8075 "log-on" with a valid username and password (which can be mapped
8076 using the username map parameter) stored on this machine. Encrypted
8077 passwords (see the encrypted passwords parameter) are by default
8078 used in this security mode. Parameters such as user and guest only
8079 if set are then applied and may change the UNIX user to use on this
8080 connection, but only after the user has been successfully
8081 authenticated.
8082 SERVER ROLE = MEMBER SERVER
8084 This mode will only work correctly if net(8) has been used to add
8086 this machine into a Windows Domain. It expects the encrypted
8087 passwords parameter to be set to yes. In this mode Samba will try
8088 to validate the username/password by passing it to a Windows or
8089 Samba Domain Controller, in exactly the same way that a Windows
8090 Server would do.
8091 Note that a valid UNIX user must still exist as well as the account
8093 on the Domain Controller to allow Samba to have a valid UNIX
8094 account to map file access to. Winbind can provide this.
8095 SERVER ROLE = CLASSIC PRIMARY DOMAIN CONTROLLER
8097 This mode of operation runs a classic Samba primary domain
8099 controller, providing domain logon services to Windows and Samba
8100 clients of an NT4-like domain. Clients must be joined to the domain
8101 to create a secure, trusted path across the network. There must be
8102 only one PDC per NetBIOS scope (typcially a broadcast network or
8103 clients served by a single WINS server).
8104 SERVER ROLE = CLASSIC BACKUP DOMAIN CONTROLLER
8106 This mode of operation runs a classic Samba backup domain
8108 controller, providing domain logon services to Windows and Samba
8109 clients of an NT4-like domain. As a BDC, this allows multiple Samba
8110 servers to provide redundant logon services to a single NetBIOS
8111 scope.
8112 SERVER ROLE = ACTIVE DIRECTORY DOMAIN CONTROLLER
8114 This mode of operation runs Samba as an active directory domain
8116 controller, providing domain logon services to Windows and Samba
8117 clients of the domain. This role requires special configuration,
8118 see the Samba4 HOWTO
8119 Default: server role = AUTO
8121 Example: server role = ACTIVE DIRECTORY DOMAIN CONTROLLER
8123 server schannel (G)
8125 This option is deprecated and will be removed in future, as it is a
8127 security problem if not set to "yes" (which will be the hardcoded
8128 behavior in future).
8129 Samba will complain in the log files at log level 0, about the
8131 security problem if the option is not set to "yes".
8132 See CVE-2020-1472(ZeroLogon)
8134 https://bugzilla.samba.org/show_bug.cgi?id=14497
8135 If you still have legacy domain members use the server require
8137 schannel:COMPUTERACCOUNT option.
8138 This option yields precedence to the server require
8140 schannel:COMPUTERACCOUNT option.
8141 Default: server schannel = yes
8143 server require schannel:COMPUTERACCOUNT (G)
8145 If you still have legacy domain members, which required "server
8147 schannel = auto" before, it is possible to specify explicit
8148 expection per computer account by using 'server require
8149 schannel:COMPUTERACCOUNT = no' as option. Note that COMPUTERACCOUNT
8150 has to be the sAMAccountName value of the computer account
8151 (including the trailing '$' sign).
8152 Samba will complain in the log files at log level 0, about the
8154 security problem if the option is not set to "no", but the related
8155 computer is actually using the netlogon secure channel (schannel)
8156 feature.
8157 Samba will warn in the log files at log level 5, if a setting is
8159 still needed for the specified computer account.
8160 See CVE-2020-1472(ZeroLogon)
8162 https://bugzilla.samba.org/show_bug.cgi?id=14497
8163 This option takes precedence to the server schannel option.
8165 server require schannel:LEGACYCOMPUTER1$ = no
8167 server require schannel:NASBOX$ = no
8168 server require schannel:LEGACYCOMPUTER2$ = no
8169 No default
8172 server services (G)
8174 This option contains the services that the Samba daemon will run.
8176 An entry in the smb.conf file can either override the previous
8178 value completely or entries can be removed from or added to it by
8179 prefixing them with + or -.
8180 Default: server services = s3fs, rpc, nbt, wrepl, ldap, cldap, kdc,
8182 drepl, winbindd, ntp_signd, kcc, dnsupdate, dns
8183 Example: server services = -s3fs, +smb
8185 server signing (G)
8187 This controls whether the client is allowed or required to use SMB1
8189 and SMB2 signing. Possible values are default, auto, mandatory and
8190 disabled.
8191 By default, and when smb signing is set to default, smb signing is
8193 required when server role is active directory domain controller and
8194 disabled otherwise.
8195 When set to auto, SMB1 signing is offered, but not enforced. When
8197 set to mandatory, SMB1 signing is required and if set to disabled,
8198 SMB signing is not offered either.
8199 For the SMB2 protocol, by design, signing cannot be disabled. In
8201 the case where SMB2 is negotiated, if this parameter is set to
8202 disabled, it will be treated as auto. Setting it to mandatory will
8203 still require SMB2 clients to use signing.
8204 Default: server signing = default
8206 server smb encrypt (S)
8208 This parameter controls whether a remote client is allowed or
8210 required to use SMB encryption. It has different effects depending
8211 on whether the connection uses SMB1 or SMB2 and newer:
8212 • If the connection uses SMB1, then this option controls
8214 the use of a Samba-specific extension to the SMB
8215 protocol introduced in Samba 3.2 that makes use of the
8216 Unix extensions.
8217 • If the connection uses SMB2 or newer, then this option
8219 controls the use of the SMB-level encryption that is
8220 supported in SMB version 3.0 and above and available in
8221 Windows 8 and newer.
8222 This parameter can be set globally and on a per-share bases.
8224 Possible values are off, if_required, desired, and required. A
8225 special value is default which is the implicit default setting of
8226 if_required.
8227 Effects for SMB1
8229 The Samba-specific encryption of SMB1 connections is an
8230 extension to the SMB protocol negotiated as part of the UNIX
8231 extensions. SMB encryption uses the GSSAPI (SSPI on Windows)
8232 ability to encrypt and sign every request/response in a SMB
8233 protocol stream. When enabled it provides a secure method of
8234 SMB/CIFS communication, similar to an ssh protected session,
8235 but using SMB/CIFS authentication to negotiate encryption and
8236 signing keys. Currently this is only supported smbclient of by
8237 Samba 3.2 and newer, and hopefully soon Linux CIFSFS and
8238 MacOS/X clients. Windows clients do not support this feature.
8239 This may be set on a per-share basis, but clients may chose to
8241 encrypt the entire session, not just traffic to a specific
8242 share. If this is set to mandatory then all traffic to a share
8243 must be encrypted once the connection has been made to the
8244 share. The server would return "access denied" to all
8245 non-encrypted requests on such a share. Selecting encrypted
8246 traffic reduces throughput as smaller packet sizes must be used
8247 (no huge UNIX style read/writes allowed) as well as the
8248 overhead of encrypting and signing all the data.
8249 If SMB encryption is selected, Windows style SMB signing (see
8251 the server signing option) is no longer necessary, as the
8252 GSSAPI flags use select both signing and sealing of the data.
8253 When set to auto or default, SMB encryption is offered, but not
8255 enforced. When set to mandatory, SMB encryption is required and
8256 if set to disabled, SMB encryption can not be negotiated.
8257 Effects for SMB2 and newer
8259 Native SMB transport encryption is available in SMB version 3.0
8260 or newer. It is only offered by Samba if server max protocol is
8261 set to SMB3 or newer. Clients supporting this type of
8262 encryption include Windows 8 and newer, Windows server 2012 and
8263 newer, and smbclient of Samba 4.1 and newer.
8264 The protocol implementation offers various options:
8266 • The capability to perform SMB encryption can be
8268 negotiated during protocol negotiation.
8269 • Data encryption can be enabled globally. In that
8271 case, an encryption-capable connection will have all
8272 traffic in all its sessions encrypted. In particular
8273 all share connections will be encrypted.
8274 • Data encryption can also be enabled per share if not
8276 enabled globally. For an encryption-capable
8277 connection, all connections to an encryption-enabled
8278 share will be encrypted.
8279 • Encryption can be enforced. This means that session
8281 setups will be denied on non-encryption-capable
8282 connections if data encryption has been enabled
8283 globally. And tree connections will be denied for
8284 non-encryption capable connections to shares with
8285 data encryption enabled.
8286 These features can be controlled with settings of server smb
8288 encrypt as follows:
8289 • Leaving it as default, explicitly setting default,
8291 or setting it to if_required globally will enable
8292 negotiation of encryption but will not turn on data
8293 encryption globally or per share.
8294 • Setting it to desired globally will enable
8296 negotiation and will turn on data encryption on
8297 sessions and share connections for those clients
8298 that support it.
8299 • Setting it to required globally will enable
8301 negotiation and turn on data encryption on sessions
8302 and share connections. Clients that do not support
8303 encryption will be denied access to the server.
8304 • Setting it to off globally will completely disable
8306 the encryption feature for all connections. Setting
8307 server smb encrypt = required for individual shares
8308 (while it's globally off) will deny access to this
8309 shares for all clients.
8310 • Setting it to desired on a share will turn on data
8312 encryption for this share for clients that support
8313 encryption if negotiation has been enabled globally.
8314 • Setting it to required on a share will enforce data
8316 encryption for this share if negotiation has been
8317 enabled globally. I.e. clients that do not support
8318 encryption will be denied access to the share.
8319 Note that this allows per-share enforcing to be
8321 controlled in Samba differently from Windows: In
8322 Windows, RejectUnencryptedAccess is a global
8323 setting, and if it is set, all shares with data
8324 encryption turned on are automatically enforcing
8325 encryption. In order to achieve the same effect in
8326 Samba, one has to globally set server smb encrypt to
8327 if_required, and then set all shares that should be
8328 encrypted to required. Additionally, it is possible
8329 in Samba to have some shares with encryption
8330 required and some other shares with encryption only
8331 desired, which is not possible in Windows.
8332 • Setting it to off or if_required for a share has no
8334 effect.
8335 Default: server smb encrypt = default
8338 server string (G)
8340 This controls what string will show up in the printer comment box
8342 in print manager and next to the IPC connection in net view. It can
8343 be any string that you wish to show to your users.
8344 It also sets what will appear in browse lists next to the machine
8346 name.
8347 A %v will be replaced with the Samba version number.
8349 A %h will be replaced with the hostname.
8351 Default: server string = Samba %v
8353 Example: server string = University of GNUs Samba Server
8355 set primary group script (G)
8357 Thanks to the Posix subsystem in NT a Windows User has a primary
8359 group in addition to the auxiliary groups. This script sets the
8360 primary group in the unix user database when an administrator sets
8361 the primary group from the windows user manager or when fetching a
8362 SAM with net rpc vampire. %u will be replaced with the user whose
8363 primary group is to be set. %g will be replaced with the group to
8364 set.
8365 Default: set primary group script =
8367 Example: set primary group script = /usr/sbin/usermod -g '%g' '%u'
8369 set quota command (G)
8371 The set quota command should only be used whenever there is no
8373 operating system API available from the OS that samba can use.
8374 This option is only available if Samba was compiled with quota
8376 support.
8377 This parameter should specify the path to a script that can set
8379 quota for the specified arguments.
8380 The specified script should take the following arguments:
8382 • 1 - path to where the quota needs to be set. This needs
8384 to be interpreted relative to the current working
8385 directory that the script may also check for.
8386 • 2 - quota type
8388 • 1 - user quotas
8390 • 2 - user default quotas (uid = -1)
8392 • 3 - group quotas
8394 • 4 - group default quotas (gid = -1)
8396 • 3 - id (uid for user, gid for group, -1 if N/A)
8399 • 4 - quota state (0 = disable, 1 = enable, 2 = enable and
8401 enforce)
8402 • 5 - block softlimit
8404 • 6 - block hardlimit
8406 • 7 - inode softlimit
8408 • 8 - inode hardlimit
8410 • 9(optional) - block size, defaults to 1024
8412 The script should output at least one line of data on success. And
8414 nothing on failure.
8415 Default: set quota command =
8417 Example: set quota command = /usr/local/sbin/set_quota
8419 share backend (G)
8421 This option specifies the backend that will be used to access the
8423 configuration of file shares.
8424 Traditionally, Samba file shares have been configured in the
8426 smb.conf file and this is still the default.
8427 At the moment there are no other supported backends.
8429 Default: share backend = classic
8431 share:fake_fscaps (G)
8433 This is needed to support some special application that makes
8435 QFSINFO calls to check whether we set the SPARSE_FILES bit (0x40).
8436 If this bit is not set that particular application refuses to work
8437 against Samba. With share:fake_fscaps = 64 the SPARSE_FILES file
8438 system capability flag is set. Use other decimal values to specify
8439 the bitmask you need to fake.
8440 Default: share:fake_fscaps = 0
8442 short preserve case (S)
8444 This boolean parameter controls if new files which conform to 8.3
8446 syntax, that is all in upper case and of suitable length, are
8447 created upper case, or if they are forced to be the default case.
8448 This option can be use with preserve case = yes to permit long
8449 filenames to retain their case, while short names are lowered.
8450 See the section on NAME MANGLING.
8452 Default: short preserve case = yes
8454 show add printer wizard (G)
8456 With the introduction of MS-RPC based printing support for Windows
8458 NT/2000 client in Samba 2.2, a "Printers..." folder will appear on
8459 Samba hosts in the share listing. Normally this folder will contain
8460 an icon for the MS Add Printer Wizard (APW). However, it is
8461 possible to disable this feature regardless of the level of
8462 privilege of the connected user.
8463 Under normal circumstances, the Windows NT/2000 client will open a
8465 handle on the printer server with OpenPrinterEx() asking for
8466 Administrator privileges. If the user does not have administrative
8467 access on the print server (i.e is not root or has granted the
8468 SePrintOperatorPrivilege), the OpenPrinterEx() call fails and the
8469 client makes another open call with a request for a lower privilege
8470 level. This should succeed, however the APW icon will not be
8471 displayed.
8472 Disabling the show add printer wizard parameter will always cause
8474 the OpenPrinterEx() on the server to fail. Thus the APW icon will
8475 never be displayed.
8476 Note
8478 This does not prevent the same user from having administrative
8479 privilege on an individual printer.
8480 Default: show add printer wizard = yes
8481 shutdown script (G)
8483 This a full path name to a script called by smbd(8) that should
8485 start a shutdown procedure.
8486 If the connected user possesses the SeRemoteShutdownPrivilege,
8488 right, this command will be run as root.
8489 The %z %t %r %f variables are expanded as follows:
8491 • %z will be substituted with the shutdown message sent to
8493 the server.
8494 • %t will be substituted with the number of seconds to
8496 wait before effectively starting the shutdown procedure.
8497 • %r will be substituted with the switch -r. It means
8499 reboot after shutdown for NT.
8500 • %f will be substituted with the switch -f. It means
8502 force the shutdown even if applications do not respond
8503 for NT.
8504 Shutdown script example:
8506 #!/bin/bash
8508 time=$2
8510 let time="${time} / 60"
8511 let time="${time} + 1"
8512 /sbin/shutdown $3 $4 +$time $1 &
8514 Shutdown does not return so we need to launch it in background.
8517 Default: shutdown script =
8519 Example: shutdown script = /usr/local/samba/sbin/shutdown %m %t %r
8521 %f
8522 smb2 disable lock sequence checking (G)
8524 This boolean parameter controls whether smbd(8) will disable lock
8526 sequence checking even for multi-channel connections as well as
8527 durable handles.
8528 The [MS-SMB2] specification (under 3.3.5.14 Receiving an SMB2 LOCK
8530 Request) documents that a server should do lock sequence if
8531 Open.IsResilient or Open.IsDurable or Open.IsPersistent is TRUE or
8532 if Connection.Dialect belongs to the SMB 3.x dialect family and
8533 Connection.ServerCapabilities includes
8534 SMB2_GLOBAL_CAP_MULTI_CHANNEL.
8535 But Windows Server (at least up to v2004) only does these checks
8537 for the Open.IsResilient and Open.IsPersistent. That means they do
8538 not implement the behavior specified in [MS-SMB2].
8539 By default Samba behaves according to the specification and sends
8541 smb2 oplock break notification retries.
8542 Warning: Only enable this option if existing clients can't handle
8544 lock sequence checking for handles without Open.IsResilient and
8545 Open.IsPersistent. And it turns out that the Windows Server
8546 behavior is required.
8547 Note: it's likely that this option will be removed again if future
8549 Windows versions change their behavior.
8550 Note: Samba does not implement Open.IsResilient and
8552 Open.IsPersistent yet.
8553 Default: smb2 disable lock sequence checking = no
8555 Example: smb2 disable lock sequence checking = yes
8557 smb2 disable oplock break retry (G)
8559 This boolean parameter controls whether smbd(8) will trigger smb2
8561 oplock break notification retries when using server multi channel
8562 support = yes.
8563 The [MS-SMB2] specification documents that a server should send
8565 smb2 oplock break notification retries on all available channel to
8566 the given client.
8567 But Windows Server versions (at least up to 2019) do not send smb2
8569 oplock break notification retries on channel failures. That means
8570 they do not implement the behavior specified in [MS-SMB2].
8571 By default Samba behaves according to the specification and send
8573 smb2 oplock break notification retries.
8574 Warning: Only enable this option if existing clients can't handle
8576 possible retries and it turns out that the Windows Server behavior
8577 is required.
8578 Note: it's likely that this option gets removed again if future
8580 Windows versions change their behavior.
8581 Note: this only applies to oplocks and not SMB2 leases.
8583 Default: smb2 disable oplock break retry = no
8585 Example: smb2 disable oplock break retry = yes
8587 smb2 leases (G)
8589 This boolean option tells smbd whether to globally negotiate SMB2
8591 leases on file open requests. Leasing is an SMB2-only feature which
8592 allows clients to aggressively cache files locally above and beyond
8593 the caching allowed by SMB1 oplocks.
8594 This is only available with oplocks = yes and kernel oplocks = no.
8596 Note that the write cache won't be used for file handles with a
8598 smb2 write lease.
8599 Default: smb2 leases = yes
8601 smb2 max credits (G)
8603 This option controls the maximum number of outstanding simultaneous
8605 SMB2 operations that Samba tells the client it will allow. This is
8606 similar to the max mux parameter for SMB1. You should never need to
8607 set this parameter.
8608 The default is 8192 credits, which is the same as a Windows 2008R2
8610 SMB2 server.
8611 Default: smb2 max credits = 8192
8613 smb2 max read (G)
8615 This option specifies the protocol value that smbd(8) will return
8617 to a client, informing the client of the largest size that may be
8618 returned by a single SMB2 read call.
8619 The maximum is 8388608 bytes (8MiB), which is the same as a Windows
8621 Server 2012 r2.
8622 Please note that the default is 8MiB, but it's limit is based on
8624 the smb2 dialect (64KiB for SMB == 2.0, 8MiB for SMB >= 2.1 with
8625 LargeMTU). Large MTU is not supported over NBT (tcp port 139).
8626 Default: smb2 max read = 8388608
8628 smb2 max trans (G)
8630 This option specifies the protocol value that smbd(8) will return
8632 to a client, informing the client of the largest size of buffer
8633 that may be used in querying file meta-data via QUERY_INFO and
8634 related SMB2 calls.
8635 The maximum is 8388608 bytes (8MiB), which is the same as a Windows
8637 Server 2012 r2.
8638 Please note that the default is 8MiB, but it's limit is based on
8640 the smb2 dialect (64KiB for SMB == 2.0, 1MiB for SMB >= 2.1 with
8641 LargeMTU). Large MTU is not supported over NBT (tcp port 139).
8642 Default: smb2 max trans = 8388608
8644 smb2 max write (G)
8646 This option specifies the protocol value that smbd(8) will return
8648 to a client, informing the client of the largest size that may be
8649 sent to the server by a single SMB2 write call.
8650 The maximum is 8388608 bytes (8MiB), which is the same as a Windows
8652 Server 2012 r2.
8653 Please note that the default is 8MiB, but it's limit is based on
8655 the smb2 dialect (64KiB for SMB == 2.0, 8MiB for SMB => 2.1 with
8656 LargeMTU). Large MTU is not supported over NBT (tcp port 139).
8657 Default: smb2 max write = 8388608
8659 smbd async dosmode (S)
8661 This parameter control whether the fileserver will use sync or
8663 async methods for fetching the DOS attributes when doing a
8664 directory listing. By default sync methods will be used.
8665 Default: smbd async dosmode = no
8667 smbd getinfo ask sharemode (S)
8669 This parameter allows disabling fetching file write time from the
8671 open file handle database locking.tdb when a client requests file
8672 or directory metadata. It's a performance optimisation at the
8673 expense of protocol correctness.
8674 Default: smbd getinfo ask sharemode = yes
8676 smbd max async dosmode (S)
8678 This parameter controls how many async operations to fetch the DOS
8680 attributes the fileserver will queue when doing directory listings.
8681 Default: smbd max async dosmode = aio max threads * 2
8683 smbd profiling level (G)
8685 This parameter allows the administrator to enable profiling
8687 support.
8688 Possible values are off, count and on.
8690 Default: smbd profiling level = off
8692 Example: smbd profiling level = on
8694 smbd search ask sharemode (S)
8696 This parameter allows disabling fetching file write time from the
8698 open file handle database locking.tdb. It's a performance
8699 optimisation at the expense of protocol correctness.
8700 Default: smbd search ask sharemode = yes
8702 smb encrypt (S)
8704 This is a synonym for server smb encrypt.
8706 Default: smb encrypt = default
8708 smb passwd file (G)
8710 This option sets the path to the encrypted smbpasswd file. By
8712 default the path to the smbpasswd file is compiled into Samba.
8713 An example of use is:
8715 smb passwd file = /etc/samba/smbpasswd
8717 Default: smb passwd file = /var/lib/samba/private/smbpasswd
8719 smb ports (G)
8721 Specifies which ports the server should listen on for SMB traffic.
8723 Default: smb ports = 445 139
8725 socket options (G)
8727 Warning
8729 Modern server operating systems are tuned for high network
8730 performance in the majority of situations; when you set socket
8731 options you are overriding those settings. Linux in particular
8732 has an auto-tuning mechanism for buffer sizes that will be
8733 disabled if you specify a socket buffer size. This can
8734 potentially cripple your TCP/IP stack.
8735 Getting the socket options correct can make a big difference to
8737 your performance, but getting them wrong can degrade it by just
8738 as much. As with any other low level setting, if you must make
8739 changes to it, make small changes and test the effect before
8740 making any large changes.
8741 This option allows you to set socket options to be used when
8743 talking with the client.
8744 Socket options are controls on the networking layer of the
8746 operating systems which allow the connection to be tuned.
8747 This option will typically be used to tune your Samba server for
8749 optimal performance for your local network. There is no way that
8750 Samba can know what the optimal parameters are for your net, so you
8751 must experiment and choose them yourself. We strongly suggest you
8752 read the appropriate documentation for your operating system first
8753 (perhaps man setsockopt will help).
8754 You may find that on some systems Samba will say "Unknown socket
8756 option" when you supply an option. This means you either
8757 incorrectly typed it or you need to add an include file to
8758 includes.h for your OS. If the latter is the case please send the
8759 patch to samba-technical@lists.samba.org.
8760 Any of the supported socket options may be combined in any way you
8762 like, as long as your OS allows it.
8763 This is the list of socket options currently settable using this
8765 option:
8766 • SO_KEEPALIVE
8768 • SO_REUSEADDR
8770 • SO_BROADCAST
8772 • TCP_NODELAY
8774 • TCP_KEEPCNT *
8776 • TCP_KEEPIDLE *
8778 • TCP_KEEPINTVL *
8780 • IPTOS_LOWDELAY
8782 • IPTOS_THROUGHPUT
8784 • SO_REUSEPORT
8786 • SO_SNDBUF *
8788 • SO_RCVBUF *
8790 • SO_SNDLOWAT *
8792 • SO_RCVLOWAT *
8794 • SO_SNDTIMEO *
8796 • SO_RCVTIMEO *
8798 • TCP_FASTACK *
8800 • TCP_QUICKACK
8802 • TCP_NODELAYACK
8804 • TCP_KEEPALIVE_THRESHOLD *
8806 • TCP_KEEPALIVE_ABORT_THRESHOLD *
8808 • TCP_DEFER_ACCEPT *
8810 • TCP_USER_TIMEOUT *
8812 Those marked with a '*' take an integer argument. The others can
8814 optionally take a 1 or 0 argument to enable or disable the option,
8815 by default they will be enabled if you don't specify 1 or 0.
8816 To specify an argument use the syntax SOME_OPTION = VALUE for
8818 example SO_SNDBUF = 8192. Note that you must not have any spaces
8819 before or after the = sign.
8820 If you are on a local network then a sensible option might be:
8822 socket options = IPTOS_LOWDELAY
8824 If you have a local network then you could try:
8826 socket options = IPTOS_LOWDELAY TCP_NODELAY
8828 If you are on a wide area network then perhaps try setting
8830 IPTOS_THROUGHPUT.
8831 Note that several of the options may cause your Samba server to
8833 fail completely. Use these options with caution!
8834 Default: socket options = TCP_NODELAY
8836 Example: socket options = IPTOS_LOWDELAY
8838 spn update command (G)
8840 This option sets the command that for updating servicePrincipalName
8842 names from spn_update_list.
8843 Default: spn update command =
8845 /builddir/build/BUILD/samba-4.14.5/source4/scripting/bin/samba_spnupdate
8846 Example: spn update command = /usr/local/sbin/spnupdate
8848 spoolss: architecture (G)
8850 Windows spoolss print clients only allow association of server-side
8852 drivers with printers when the driver architecture matches the
8853 advertised print server architecture. Samba's spoolss print server
8854 architecture can be changed using this parameter.
8855 Default: spoolss: architecture = Windows x64
8857 Example: spoolss: architecture = Windows NT x86
8859 spoolss: os_major (G)
8861 Windows might require a new os version number. This option allows
8863 to modify the build number. The complete default version number is:
8864 5.0.2195 (Windows 2000). The example is 6.1.7601 (Windows 2008 R2).
8865 Default: spoolss: os_major = 5
8867 Example: spoolss: os_major = 6
8869 spoolss: os_minor (G)
8871 Windows might require a new os version number. This option allows
8873 to modify the build number. The complete default version number is:
8874 5.0.2195 (Windows 2000). The example is 6.1.7601 (Windows 2008 R2).
8875 Default: spoolss: os_minor = 0
8877 Example: spoolss: os_minor = 1
8879 spoolss: os_build (G)
8881 Windows might require a new os version number. This option allows
8883 to modify the build number. The complete default version number is:
8884 5.0.2195 (Windows 2000). The example is 6.1.7601 (Windows 2008 R2).
8885 Default: spoolss: os_build = 2195
8887 Example: spoolss: os_build = 7601
8889 spoolss_client: os_major (G)
8891 Windows might require a new os version number. This option allows
8893 to modify the build number. The complete default version number is:
8894 6.1.7007 (Windows 7 and Windows Server 2008 R2).
8895 Default: spoolss_client: os_major = 6
8897 spoolss_client: os_minor (G)
8899 Windows might require a new os version number. This option allows
8901 to modify the build number. The complete default version number is:
8902 6.1.7007 (Windows 7 and Windows Server 2008 R2).
8903 Default: spoolss_client: os_minor = 1
8905 spoolss_client: os_build (G)
8907 Windows might require a new os version number. This option allows
8909 to modify the build number. The complete default version number is:
8910 6.1.7007 (Windows 7 and Windows Server 2008 R2).
8911 Default: spoolss_client: os_build = 7007
8913 spotlight (S)
8915 This parameter controls whether Samba allows Spotlight queries on a
8917 share. For controlling indexing of filesystems you also have to use
8918 Tracker's own configuration system.
8919 Spotlight has several prerequisites:
8921 • Samba must be configured and built with Spotlight
8923 support.
8924 • The mdssvc RPC service must be enabled, see below.
8926 • Tracker integration must be setup and the share must be
8928 indexed by Tracker.
8929 For a detailed set of instructions please see
8931 https://wiki.samba.org/index.php/Spotlight.
8932 The Spotlight RPC service can either be enabled as embedded RPC
8934 service:
8935 [Global]
8937 rpc_server:mdsvc = embedded
8938 Or it can be run in a separate RPC service daemon:
8940 [Global]
8942 rpc_server:mdssd = fork
8943 rpc_server:mdsvc = external
8944 Default: spotlight = no
8946 spotlight backend (S)
8948 Spotlight search backend. Available backends:
8950 • noindex - a backend that returns no results.
8952 • tracker - Gnome Tracker.
8955 • elasticsearch - a backend that uses JSON and REST over
8957 HTTP(s) to query an Elasticsearch server.
8958 Default: spotlight backend = noindex
8961 stat cache (G)
8963 This parameter determines if smbd(8) will use a cache in order to
8965 speed up case insensitive name mappings. You should never need to
8966 change this parameter.
8967 Default: stat cache = yes
8969 state directory (G)
8971 Usually, most of the TDB files are stored in the lock directory.
8973 Since Samba 3.4.0, it is possible to differentiate between TDB
8974 files with persistent data and TDB files with non-persistent data
8975 using the state directory and the cache directory options.
8976 This option specifies the directory where TDB files containing
8978 important persistent data will be stored.
8979 Default: state directory = /var/lib/samba
8981 Example: state directory = /var/run/samba/locks/state
8983 store dos attributes (S)
8985 If this parameter is set Samba attempts to first read DOS
8987 attributes (SYSTEM, HIDDEN, ARCHIVE or READ-ONLY) from a filesystem
8988 extended attribute, before mapping DOS attributes to UNIX
8989 permission bits (such as occurs with map hidden and map readonly).
8990 When set, DOS attributes will be stored onto an extended attribute
8991 in the UNIX filesystem, associated with the file or directory. When
8992 this parameter is set it will override the parameters map hidden,
8993 map system, map archive and map readonly and they will behave as if
8994 they were set to off. This parameter writes the DOS attributes as a
8995 string into the extended attribute named "user.DOSATTRIB". This
8996 extended attribute is explicitly hidden from smbd clients
8997 requesting an EA list. On Linux the filesystem must have been
8998 mounted with the mount option user_xattr in order for extended
8999 attributes to work, also extended attributes must be compiled into
9000 the Linux kernel. In Samba 3.5.0 and above the "user.DOSATTRIB"
9001 extended attribute has been extended to store the create time for a
9002 file as well as the DOS attributes. This is done in a backwards
9003 compatible way so files created by Samba 3.5.0 and above can still
9004 have the DOS attribute read from this extended attribute by earlier
9005 versions of Samba, but they will not be able to read the create
9006 time stored there. Storing the create time separately from the
9007 normal filesystem meta-data allows Samba to faithfully reproduce
9008 NTFS semantics on top of a POSIX filesystem. The default has
9009 changed to yes in Samba release 4.9.0 and above to allow better
9010 Windows fileserver compatibility in a default install.
9011 Default: store dos attributes = yes
9013 strict allocate (S)
9015 This is a boolean that controls the handling of disk space
9017 allocation in the server. When this is set to yes the server will
9018 change from UNIX behaviour of not committing real disk storage
9019 blocks when a file is extended to the Windows behaviour of actually
9020 forcing the disk system to allocate real storage blocks when a file
9021 is created or extended to be a given size. In UNIX terminology this
9022 means that Samba will stop creating sparse files.
9023 This option is really designed for file systems that support fast
9025 allocation of large numbers of blocks such as extent-based file
9026 systems. On file systems that don't support extents (most notably
9027 ext3) this can make Samba slower. When you work with large files
9028 over >100MB on file systems without extents you may even run into
9029 problems with clients running into timeouts.
9030 When you have an extent based filesystem it's likely that we can
9032 make use of unwritten extents which allows Samba to allocate even
9033 large amounts of space very fast and you will not see any timeout
9034 problems caused by strict allocate. With strict allocate in use you
9035 will also get much better out of quota messages in case you use
9036 quotas. Another advantage of activating this setting is that it
9037 will help to reduce file fragmentation.
9038 To give you an idea on which filesystems this setting might
9040 currently be a good option for you: XFS, ext4, btrfs, ocfs2 on
9041 Linux and JFS2 on AIX support unwritten extents. On Filesystems
9042 that do not support it, preallocation is probably an expensive
9043 operation where you will see reduced performance and risk to let
9044 clients run into timeouts when creating large files. Examples are
9045 ext3, ZFS, HFS+ and most others, so be aware if you activate this
9046 setting on those filesystems.
9047 Default: strict allocate = no
9049 strict locking (S)
9051 This is an enumerated type that controls the handling of file
9053 locking in the server. When this is set to yes, the server will
9054 check every read and write access for file locks, and deny access
9055 if locks exist. This can be slow on some systems.
9056 When strict locking is set to Auto (the default), the server
9058 performs file lock checks only on non-oplocked files. As most
9059 Windows redirectors perform file locking checks locally on oplocked
9060 files this is a good trade off for improved performance.
9061 When strict locking is disabled, the server performs file lock
9063 checks only when the client explicitly asks for them.
9064 Well-behaved clients always ask for lock checks when it is
9066 important. So in the vast majority of cases, strict locking = Auto
9067 or strict locking = no is acceptable.
9068 Default: strict locking = Auto
9070 strict rename (S)
9072 By default a Windows SMB server prevents directory renames when
9074 there are open file or directory handles below it in the filesystem
9075 hierarchy. Historically Samba has always allowed this as POSIX
9076 filesystem semantics require it.
9077 This boolean parameter allows Samba to match the Windows behavior.
9079 Setting this to "yes" is a very expensive change, as it forces
9080 Samba to travers the entire open file handle database on every
9081 directory rename request. In a clustered Samba system the cost is
9082 even greater than the non-clustered case.
9083 When set to "no" smbd only checks the local process the client is
9085 attached to for open files below a directory being renamed, instead
9086 of checking for open files across all smbd processes.
9087 Because of the expense in fully searching the database, the default
9089 is "no", and it is recommended to be left that way unless a
9090 specific Windows application requires it to be changed.
9091 If the client has requested UNIX extensions (POSIX pathnames) then
9093 renames are always allowed and this parameter has no effect.
9094 Default: strict rename = no
9096 strict sync (S)
9098 This parameter controls whether Samba honors a request from an SMB
9100 client to ensure any outstanding operating system buffer contents
9101 held in memory are safely written onto stable storage on disk. If
9102 set to yes, which is the default, then Windows applications can
9103 force the smbd server to synchronize unwritten data onto the disk.
9104 If set to no then smbd will ignore client requests to synchronize
9105 unwritten data onto stable storage on disk.
9106 In Samba 4.7.0, the default for this parameter changed from no to
9108 yes to better match the expectations of SMB2/3 clients and improve
9109 application safety when running against smbd.
9110 The flush request from SMB2/3 clients is handled asynchronously
9112 inside smbd, so leaving the parameter as the default value of yes
9113 does not block the processing of other requests to the smbd
9114 process.
9115 Legacy Windows applications (such as the Windows 98 explorer shell)
9117 seemed to confuse writing buffer contents to the operating system
9118 with synchronously writing outstanding data onto stable storage on
9119 disk. Changing this parameter to no means that smbd(8) will ignore
9120 the Windows applications request to synchronize unwritten data onto
9121 disk. Only consider changing this if smbd is serving obsolete SMB1
9122 Windows clients prior to Windows XP (Windows 98 and below). There
9123 should be no need to change this setting for normal operations.
9124 Default: strict sync = yes
9126 svcctl list (G)
9128 This option defines a list of init scripts that smbd will use for
9130 starting and stopping Unix services via the Win32 ServiceControl
9131 API. This allows Windows administrators to utilize the MS
9132 Management Console plug-ins to manage a Unix server running Samba.
9133 The administrator must create a directory name svcctl in Samba's
9135 $(libdir) and create symbolic links to the init scripts in
9136 /etc/init.d/. The name of the links must match the names given as
9137 part of the svcctl list.
9138 Default: svcctl list =
9140 Example: svcctl list = cups postfix portmap httpd
9142 sync always (S)
9144 This is a boolean parameter that controls whether writes will
9146 always be written to stable storage before the write call returns.
9147 If this is no then the server will be guided by the client's
9148 request in each write call (clients can set a bit indicating that a
9149 particular write should be synchronous). If this is yes then every
9150 write will be followed by a fsync() call to ensure the data is
9151 written to disk. Note that the strict sync parameter must be set to
9152 yes in order for this parameter to have any effect.
9153 Default: sync always = no
9155 syslog (G)
9157 This parameter maps how Samba debug messages are logged onto the
9159 system syslog logging levels. Samba debug level zero maps onto
9160 syslog LOG_ERR, debug level one maps onto LOG_WARNING, debug level
9161 two maps onto LOG_NOTICE, debug level three maps onto LOG_INFO. All
9162 higher levels are mapped to LOG_DEBUG.
9163 This parameter sets the threshold for sending messages to syslog.
9165 Only messages with debug level less than this value will be sent to
9166 syslog. There still will be some logging to log.[sn]mbd even if
9167 syslog only is enabled.
9168 The logging parameter should be used instead. When logging is set,
9170 it overrides the syslog parameter.
9171 Default: syslog = 1
9173 syslog only (G)
9175 If this parameter is set then Samba debug messages are logged into
9177 the system syslog only, and not to the debug log files. There still
9178 will be some logging to log.[sn]mbd even if syslog only is enabled.
9179 The logging parameter should be used instead. When logging is set,
9181 it overrides the syslog only parameter.
9182 Default: syslog only = no
9184 template homedir (G)
9186 When filling out the user information for a Windows NT user, the
9188 winbindd(8) daemon uses this parameter to fill in the home
9189 directory for that user. If the string %D is present it is
9190 substituted with the user's Windows NT domain name. If the string
9191 %U is present it is substituted with the user's Windows NT user
9192 name.
9193 Default: template homedir = /home/%D/%U
9195 template shell (G)
9197 When filling out the user information for a Windows NT user, the
9199 winbindd(8) daemon uses this parameter to fill in the login shell
9200 for that user.
9201 Default: template shell = /bin/false
9203 time server (G)
9205 This parameter determines if nmbd(8) advertises itself as a time
9207 server to Windows clients.
9208 Default: time server = no
9210 debug timestamp
9212 This parameter is a synonym for timestamp logs.
9214 timestamp logs (G)
9216 Samba debug log messages are timestamped by default. If you are
9218 running at a high debug level these timestamps can be distracting.
9219 This boolean parameter allows timestamping to be turned off.
9220 Default: timestamp logs = yes
9222 tls cafile (G)
9224 This option can be set to a file (PEM format) containing CA
9226 certificates of root CAs to trust to sign certificates or
9227 intermediate CA certificates.
9228 This path is relative to private dir if the path does not start
9230 with a /.
9231 Default: tls cafile = tls/ca.pem
9233 tls certfile (G)
9235 This option can be set to a file (PEM format) containing the RSA
9237 certificate.
9238 This path is relative to private dir if the path does not start
9240 with a /.
9241 Default: tls certfile = tls/cert.pem
9243 tls crlfile (G)
9245 This option can be set to a file containing a certificate
9247 revocation list (CRL).
9248 This path is relative to private dir if the path does not start
9250 with a /.
9251 Default: tls crlfile =
9253 tls dh params file (G)
9255 This option can be set to a file with Diffie-Hellman parameters
9257 which will be used with DH ciphers.
9258 This path is relative to private dir if the path does not start
9260 with a /.
9261 Default: tls dh params file =
9263 tls enabled (G)
9265 If this option is set to yes, then Samba will use TLS when possible
9267 in communication.
9268 Default: tls enabled = yes
9270 tls keyfile (G)
9272 This option can be set to a file (PEM format) containing the RSA
9274 private key. This file must be accessible without a pass-phrase,
9275 i.e. it must not be encrypted.
9276 This path is relative to private dir if the path does not start
9278 with a /.
9279 Default: tls keyfile = tls/key.pem
9281 tls priority (G)
9283 This option can be set to a string describing the TLS protocols to
9285 be supported in the parts of Samba that use GnuTLS, specifically
9286 the AD DC.
9287 The string is appended to the default priority list of GnuTLS.
9289 The valid options are described in the GNUTLS Priority-Strings
9291 documentation at
9292 http://gnutls.org/manual/html_node/Priority-Strings.html
9293 The SSL3.0 protocol will be disabled.
9295 Default: tls priority = NORMAL:-VERS-SSL3.0
9297 tls verify peer (G)
9299 This controls if and how strict the client will verify the peer's
9301 certificate and name. Possible values are (in increasing order):
9302 no_check, ca_only, ca_and_name_if_available, ca_and_name and
9303 as_strict_as_possible.
9304 When set to no_check the certificate is not verified at all, which
9306 allows trivial man in the middle attacks.
9307 When set to ca_only the certificate is verified to be signed from a
9309 ca specified in the tls ca file option. Setting tls ca file to a
9310 valid file is required. The certificate lifetime is also verified.
9311 If the tls crl file option is configured, the certificate is also
9312 verified against the ca crl.
9313 When set to ca_and_name_if_available all checks from ca_only are
9315 performed. In addition, the peer hostname is verified against the
9316 certificate's name, if it is provided by the application layer and
9317 not given as an ip address string.
9318 When set to ca_and_name all checks from ca_and_name_if_available
9320 are performed. In addition the peer hostname needs to be provided
9321 and even an ip address is checked against the certificate's name.
9322 When set to as_strict_as_possible all checks from ca_and_name are
9324 performed. In addition the tls crl file needs to be configured.
9325 Future versions of Samba may implement additional checks.
9326 Default: tls verify peer = as_strict_as_possible
9328 unicode (G)
9330 Specifies whether the server and client should support unicode.
9332 If this option is set to false, the use of ASCII will be forced.
9334 Default: unicode = yes
9336 unix charset (G)
9338 Specifies the charset the unix machine Samba runs on uses. Samba
9340 needs to know this in order to be able to convert text to the
9341 charsets other SMB clients use.
9342 This is also the charset Samba will use when specifying arguments
9344 to scripts that it invokes.
9345 Default: unix charset = UTF-8
9347 Example: unix charset = ASCII
9349 unix extensions (G)
9351 This boolean parameter controls whether Samba implements the CIFS
9353 UNIX extensions, as defined by HP. These extensions enable Samba to
9354 better serve UNIX CIFS clients by supporting features such as
9355 symbolic links, hard links, etc... These extensions require a
9356 similarly enabled client, and are of no current use to Windows
9357 clients.
9358 Note if this parameter is turned on, the wide links parameter will
9360 automatically be disabled.
9361 See the parameter allow insecure wide links if you wish to change
9363 this coupling between the two parameters.
9364 Default: unix extensions = yes
9366 unix password sync (G)
9368 This boolean parameter controls whether Samba attempts to
9370 synchronize the UNIX password with the SMB password when the
9371 encrypted SMB password in the smbpasswd file is changed. If this is
9372 set to yes the program specified in the passwd program parameter is
9373 called AS ROOT - to allow the new UNIX password to be set without
9374 access to the old UNIX password (as the SMB password change code
9375 has no access to the old password cleartext, only the new).
9376 This option has no effect if samba is running as an active
9378 directory domain controller, in that case have a look at the
9379 password hash gpg key ids option and the samba-tool user
9380 syncpasswords command.
9381 Default: unix password sync = no
9383 use client driver (S)
9385 This parameter applies only to Windows NT/2000 clients. It has no
9387 effect on Windows 95/98/ME clients. When serving a printer to
9388 Windows NT/2000 clients without first installing a valid printer
9389 driver on the Samba host, the client will be required to install a
9390 local printer driver. From this point on, the client will treat the
9391 print as a local printer and not a network printer connection. This
9392 is much the same behavior that will occur when disable spoolss =
9393 yes.
9394 The differentiating factor is that under normal circumstances, the
9396 NT/2000 client will attempt to open the network printer using
9397 MS-RPC. The problem is that because the client considers the
9398 printer to be local, it will attempt to issue the OpenPrinterEx()
9399 call requesting access rights associated with the logged on user.
9400 If the user possesses local administrator rights but not root
9401 privilege on the Samba host (often the case), the OpenPrinterEx()
9402 call will fail. The result is that the client will now display an
9403 "Access Denied; Unable to connect" message in the printer queue
9404 window (even though jobs may successfully be printed).
9405 If this parameter is enabled for a printer, then any attempt to
9407 open the printer with the PRINTER_ACCESS_ADMINISTER right is mapped
9408 to PRINTER_ACCESS_USE instead. Thus allowing the OpenPrinterEx()
9409 call to succeed. This parameter MUST not be enabled on a print
9410 share which has valid print driver installed on the Samba server.
9411 Default: use client driver = no
9413 use mmap (G)
9415 This global parameter determines if the tdb internals of Samba can
9417 depend on mmap working correctly on the running system. Samba
9418 requires a coherent mmap/read-write system memory cache. Currently
9419 only OpenBSD and HPUX do not have such a coherent cache, and on
9420 those platforms this paramter is overridden internally to be
9421 effeceively no. On all systems this parameter should be left alone.
9422 This parameter is provided to help the Samba developers track down
9423 problems with the tdb internal code.
9424 Default: use mmap = yes
9426 username level (G)
9428 This option helps Samba to try and 'guess' at the real UNIX
9430 username, as many DOS clients send an all-uppercase username. By
9431 default Samba tries all lowercase, followed by the username with
9432 the first letter capitalized, and fails if the username is not
9433 found on the UNIX machine.
9434 If this parameter is set to non-zero the behavior changes. This
9436 parameter is a number that specifies the number of uppercase
9437 combinations to try while trying to determine the UNIX user name.
9438 The higher the number the more combinations will be tried, but the
9439 slower the discovery of usernames will be. Use this parameter when
9440 you have strange usernames on your UNIX machine, such as
9441 AstrangeUser .
9442 This parameter is needed only on UNIX systems that have case
9444 sensitive usernames.
9445 Default: username level = 0
9447 Example: username level = 5
9449 username map (G)
9451 This option allows you to specify a file containing a mapping of
9453 usernames from the clients to the server. This can be used for
9454 several purposes. The most common is to map usernames that users
9455 use on DOS or Windows machines to those that the UNIX box uses. The
9456 other is to map multiple users to a single username so that they
9457 can more easily share files.
9458 Please note that for user mode security, the username map is
9460 applied prior to validating the user credentials. Domain member
9461 servers (domain or ads) apply the username map after the user has
9462 been successfully authenticated by the domain controller and
9463 require fully qualified entries in the map table (e.g. biddle =
9464 DOMAIN\foo).
9465 The map file is parsed line by line. Each line should contain a
9467 single UNIX username on the left then a '=' followed by a list of
9468 usernames on the right. The list of usernames on the right may
9469 contain names of the form @group in which case they will match any
9470 UNIX username in that group. The special client name '*' is a
9471 wildcard and matches any name. Each line of the map file may be up
9472 to 1023 characters long.
9473 The file is processed on each line by taking the supplied username
9475 and comparing it with each username on the right hand side of the
9476 '=' signs. If the supplied name matches any of the names on the
9477 right hand side then it is replaced with the name on the left.
9478 Processing then continues with the next line.
9479 If any line begins with a '#' or a ';' then it is ignored.
9481 If any line begins with an '!' then the processing will stop after
9483 that line if a mapping was done by the line. Otherwise mapping
9484 continues with every line being processed. Using '!' is most useful
9485 when you have a wildcard mapping line later in the file.
9486 For example to map from the name admin or administrator to the UNIX
9488 name
9489 root you would use:
9490 root = admin administrator
9492 Or to map anyone in the UNIX group system to the UNIX name sys you
9494 would use:
9495 sys = @system
9497 You can have as many mappings as you like in a username map file.
9499 If your system supports the NIS NETGROUP option then the netgroup
9501 database is checked before the /etc/group database for matching
9502 groups.
9503 You can map Windows usernames that have spaces in them by using
9505 double quotes around the name. For example:
9506 tridge = "Andrew Tridgell"
9508 would map the windows username "Andrew Tridgell" to the unix
9510 username "tridge".
9511 The following example would map mary and fred to the unix user sys,
9513 and map the rest to guest. Note the use of the '!' to tell Samba to
9514 stop processing if it gets a match on that line:
9515 !sys = mary fred
9517 guest = *
9518 Note that the remapping is applied to all occurrences of usernames.
9520 Thus if you connect to \\server\fred and fred is remapped to mary
9521 then you will actually be connecting to \\server\mary and will need
9522 to supply a password suitable for mary not fred. The only exception
9523 to this is the username passed to a Domain Controller (if you have
9524 one). The DC will receive whatever username the client supplies
9525 without modification.
9526 Also note that no reverse mapping is done. The main effect this has
9528 is with printing. Users who have been mapped may have trouble
9529 deleting print jobs as PrintManager under WfWg will think they
9530 don't own the print job.
9531 Samba versions prior to 3.0.8 would only support reading the fully
9533 qualified username (e.g.: DOMAIN\user) from the username map when
9534 performing a kerberos login from a client. However, when looking up
9535 a map entry for a user authenticated by NTLM[SSP], only the login
9536 name would be used for matches. This resulted in inconsistent
9537 behavior sometimes even on the same server.
9538 The following functionality is obeyed in version 3.0.8 and later:
9540 When performing local authentication, the username map is applied
9542 to the login name before attempting to authenticate the connection.
9543 When relying upon a external domain controller for validating
9545 authentication requests, smbd will apply the username map to the
9546 fully qualified username (i.e. DOMAIN\user) only after the user
9547 has been successfully authenticated.
9548 An example of use is:
9550 username map = /usr/local/samba/lib/users.map
9552 Default: username map = # no username map
9554 username map cache time (G)
9556 Mapping usernames with the username map or username map script
9558 features of Samba can be relatively expensive. During login of a
9559 user, the mapping is done several times. In particular, calling the
9560 username map script can slow down logins if external databases have
9561 to be queried from the script being called.
9562 The parameter username map cache time controls a mapping cache. It
9564 specifies the number of seconds a mapping from the username map
9565 file or script is to be efficiently cached. The default of 0 means
9566 no caching is done.
9567 Default: username map cache time = 0
9569 Example: username map cache time = 60
9571 username map script (G)
9573 This script is a mutually exclusive alternative to the username map
9575 parameter. This parameter specifies and external program or script
9576 that must accept a single command line option (the username
9577 transmitted in the authentication request) and return a line on
9578 standard output (the name to which the account should mapped). In
9579 this way, it is possible to store username map tables in an LDAP or
9580 NIS directory services.
9581 Default: username map script =
9583 Example: username map script = /etc/samba/scripts/mapusers.sh
9585 usershare allow guests (G)
9587 This parameter controls whether user defined shares are allowed to
9589 be accessed by non-authenticated users or not. It is the equivalent
9590 of allowing people who can create a share the option of setting
9591 guest ok = yes in a share definition. Due to its security sensitive
9592 nature, the default is set to off.
9593 Default: usershare allow guests = no
9595 usershare max shares (G)
9597 This parameter specifies the number of user defined shares that are
9599 allowed to be created by users belonging to the group owning the
9600 usershare directory. If set to zero (the default) user defined
9601 shares are ignored.
9602 Default: usershare max shares = 0
9604 usershare owner only (G)
9606 This parameter controls whether the pathname exported by a user
9608 defined shares must be owned by the user creating the user defined
9609 share or not. If set to True (the default) then smbd checks that
9610 the directory path being shared is owned by the user who owns the
9611 usershare file defining this share and refuses to create the share
9612 if not. If set to False then no such check is performed and any
9613 directory path may be exported regardless of who owns it.
9614 Default: usershare owner only = yes
9616 usershare path (G)
9618 This parameter specifies the absolute path of the directory on the
9620 filesystem used to store the user defined share definition files.
9621 This directory must be owned by root, and have no access for other,
9622 and be writable only by the group owner. In addition the "sticky"
9623 bit must also be set, restricting rename and delete to owners of a
9624 file (in the same way the /tmp directory is usually configured).
9625 Members of the group owner of this directory are the users allowed
9626 to create usershares.
9627 For example, a valid usershare directory might be
9629 /usr/local/samba/lib/usershares, set up as follows.
9630 ls -ld /usr/local/samba/lib/usershares/
9632 drwxrwx--T 2 root power_users 4096 2006-05-05 12:27 /usr/local/samba/lib/usershares/
9633 In this case, only members of the group "power_users" can create
9636 user defined shares.
9637 Default: usershare path = /var/lib/samba/usershares
9639 usershare prefix allow list (G)
9641 This parameter specifies a list of absolute pathnames the root of
9643 which are allowed to be exported by user defined share definitions.
9644 If the pathname to be exported doesn't start with one of the
9645 strings in this list, the user defined share will not be allowed.
9646 This allows the Samba administrator to restrict the directories on
9647 the system that can be exported by user defined shares.
9648 If there is a "usershare prefix deny list" and also a "usershare
9650 prefix allow list" the deny list is processed first, followed by
9651 the allow list, thus leading to the most restrictive
9652 interpretation.
9653 Default: usershare prefix allow list =
9655 Example: usershare prefix allow list = /home /data /space
9657 usershare prefix deny list (G)
9659 This parameter specifies a list of absolute pathnames the root of
9661 which are NOT allowed to be exported by user defined share
9662 definitions. If the pathname exported starts with one of the
9663 strings in this list the user defined share will not be allowed.
9664 Any pathname not starting with one of these strings will be allowed
9665 to be exported as a usershare. This allows the Samba administrator
9666 to restrict the directories on the system that can be exported by
9667 user defined shares.
9668 If there is a "usershare prefix deny list" and also a "usershare
9670 prefix allow list" the deny list is processed first, followed by
9671 the allow list, thus leading to the most restrictive
9672 interpretation.
9673 Default: usershare prefix deny list =
9675 Example: usershare prefix deny list = /etc /dev /private
9677 usershare template share (G)
9679 User defined shares only have limited possible parameters such as
9681 path, guest ok, etc. This parameter allows usershares to "cloned"
9682 from an existing share. If "usershare template share" is set to the
9683 name of an existing share, then all usershares created have their
9684 defaults set from the parameters set on this share.
9685 The target share may be set to be invalid for real file sharing by
9687 setting the parameter "-valid = False" on the template share
9688 definition. This causes it not to be seen as a real exported share
9689 but to be able to be used as a template for usershares.
9690 Default: usershare template share =
9692 Example: usershare template share = template_share
9694 use sendfile (S)
9696 If this parameter is yes, and the sendfile() system call is
9698 supported by the underlying operating system, then some SMB read
9699 calls (mainly ReadAndX and ReadRaw) will use the more efficient
9700 sendfile system call for files that are exclusively oplocked. This
9701 may make more efficient use of the system CPU's and cause Samba to
9702 be faster. Samba automatically turns this off for clients that use
9703 protocol levels lower than NT LM 0.12 and when it detects a client
9704 is Windows 9x (using sendfile from Linux will cause these clients
9705 to fail).
9706 Default: use sendfile = no
9708 utmp (G)
9710 This boolean parameter is only available if Samba has been
9712 configured and compiled with the option --with-utmp. If set to yes
9713 then Samba will attempt to add utmp or utmpx records (depending on
9714 the UNIX system) whenever a connection is made to a Samba server.
9715 Sites may use this to record the user connecting to a Samba share.
9716 Due to the requirements of the utmp record, we are required to
9718 create a unique identifier for the incoming user. Enabling this
9719 option creates an n^2 algorithm to find this number. This may
9720 impede performance on large installations.
9721 Default: utmp = no
9723 utmp directory (G)
9725 This parameter is only available if Samba has been configured and
9727 compiled with the option --with-utmp. It specifies a directory
9728 pathname that is used to store the utmp or utmpx files (depending
9729 on the UNIX system) that record user connections to a Samba server.
9730 By default this is not set, meaning the system will use whatever
9731 utmp file the native system is set to use (usually /var/run/utmp on
9732 Linux).
9733 Default: utmp directory = # Determined automatically
9735 Example: utmp directory = /var/run/utmp
9737 -valid (S)
9739 This parameter indicates whether a share is valid and thus can be
9741 used. When this parameter is set to false, the share will be in no
9742 way visible nor accessible.
9743 This option should not be used by regular users but might be of
9745 help to developers. Samba uses this option internally to mark
9746 shares as deleted.
9747 Default: -valid = yes
9749 valid users (S)
9751 This is a list of users that should be allowed to login to this
9753 service. Names starting with '@', '+' and '&' are interpreted using
9754 the same rules as described in the invalid users parameter.
9755 If this is empty (the default) then any user can login. If a
9757 username is in both this list and the invalid users list then
9758 access is denied for that user.
9759 The current servicename is substituted for %S. This is useful in
9761 the [homes] section.
9762 Note: When used in the [global] section this parameter may have
9764 unwanted side effects. For example: If samba is configured as a
9765 MASTER BROWSER (see local master, os level, domain master,
9766 preferred master) this option will prevent workstations from being
9767 able to browse the network.
9768 Default: valid users = # No valid users list (anyone can login)
9770 Example: valid users = greg, @pcusers
9772 veto files (S)
9774 This is a list of files and directories that are neither visible
9776 nor accessible. Each entry in the list must be separated by a '/',
9777 which allows spaces to be included in the entry. '*' and '?' can be
9778 used to specify multiple files or directories as in DOS wildcards.
9779 Each entry must be a unix path, not a DOS path and must not include
9781 the unix directory separator '/'.
9782 Note that the case sensitive option is applicable in vetoing files.
9784 One feature of the veto files parameter that it is important to be
9786 aware of is Samba's behaviour when trying to delete a directory. If
9787 a directory that is to be deleted contains nothing but veto files
9788 this deletion will fail unless you also set the delete veto files
9789 parameter to yes.
9790 Setting this parameter will affect the performance of Samba, as it
9792 will be forced to check all files and directories for a match as
9793 they are scanned.
9794 Examples of use include:
9796 ; Veto any files containing the word Security,
9798 ; any ending in .tmp, and any directory containing the
9799 ; word root.
9800 veto files = /*Security*/*.tmp/*root*/
9801 ; Veto the Apple specific files that a NetAtalk server
9803 ; creates.
9804 veto files = /.AppleDouble/.bin/.AppleDesktop/Network Trash Folder/
9805 Default: veto files = # No files or directories are vetoed
9807 veto oplock files (S)
9809 This parameter is only valid when the oplocks parameter is turned
9811 on for a share. It allows the Samba administrator to selectively
9812 turn off the granting of oplocks on selected files that match a
9813 wildcarded list, similar to the wildcarded list used in the veto
9814 files parameter.
9815 You might want to do this on files that you know will be heavily
9817 contended for by clients. A good example of this is in the NetBench
9818 SMB benchmark program, which causes heavy client contention for
9819 files ending in .SEM. To cause Samba not to grant oplocks on these
9820 files you would use the line (either in the [global] section or in
9821 the section for the particular NetBench share.
9822 An example of use is:
9824 veto oplock files = /.*SEM/
9826 Default: veto oplock files = # No files are vetoed for oplock
9828 grants
9829 vfs object
9831 This parameter is a synonym for vfs objects.
9833 vfs objects (S)
9835 This parameter specifies the backend names which are used for Samba
9837 VFS I/O operations. By default, normal disk I/O operations are used
9838 but these can be overloaded with one or more VFS objects. Be aware
9839 that the definition of this parameter will overwrite a possible
9840 previous definition of the vfs objects parameter.
9841 Default: vfs objects =
9843 Example: vfs objects = extd_audit recycle
9845 volume (S)
9847 This allows you to override the volume label returned for a share.
9849 Useful for CDROMs with installation programs that insist on a
9850 particular volume label.
9851 Default: volume = # the name of the share
9853 wide links (S)
9855 This parameter controls whether or not links in the UNIX file
9857 system may be followed by the server. Links that point to areas
9858 within the directory tree exported by the server are always
9859 allowed; this parameter controls access only to areas that are
9860 outside the directory tree being exported.
9861 Note: Turning this parameter on when UNIX extensions are enabled
9863 will allow UNIX clients to create symbolic links on the share that
9864 can point to files or directories outside restricted path exported
9865 by the share definition. This can cause access to areas outside of
9866 the share. Due to this problem, this parameter will be
9867 automatically disabled (with a message in the log file) if the unix
9868 extensions option is on.
9869 See the parameter allow insecure wide links if you wish to change
9871 this coupling between the two parameters.
9872 Default: wide links = no
9874 winbind cache time (G)
9876 This parameter specifies the number of seconds the winbindd(8)
9878 daemon will cache user and group information before querying a
9879 Windows NT server again.
9880 This does not apply to authentication requests, these are always
9882 evaluated in real time unless the winbind offline logon option has
9883 been enabled.
9884 Default: winbind cache time = 300
9886 winbindd socket directory (G)
9888 This setting controls the location of the winbind daemon's socket.
9890 Except within automated test scripts, this should not be altered,
9892 as the client tools (nss_winbind etc) do not honour this parameter.
9893 Client tools must then be advised of the altered path with the
9894 WINBINDD_SOCKET_DIR environment variable.
9895 Default: winbindd socket directory = /run/samba/winbindd
9897 winbind enum groups (G)
9899 On large installations using winbindd(8) it may be necessary to
9901 suppress the enumeration of groups through the setgrent(),
9902 getgrent() and endgrent() group of system calls. If the winbind
9903 enum groups parameter is no, calls to the getgrent() system call
9904 will not return any data.
9905 Warning
9907 Turning off group enumeration may cause some programs to behave
9908 oddly.
9909 Default: winbind enum groups = no
9910 winbind enum users (G)
9912 On large installations using winbindd(8) it may be necessary to
9914 suppress the enumeration of users through the setpwent(),
9915 getpwent() and endpwent() group of system calls. If the winbind
9916 enum users parameter is no, calls to the getpwent system call will
9917 not return any data.
9918 Warning
9920 Turning off user enumeration may cause some programs to behave
9921 oddly. For example, the finger program relies on having access
9922 to the full user list when searching for matching usernames.
9923 Default: winbind enum users = no
9924 winbind expand groups (G)
9926 This option controls the maximum depth that winbindd will traverse
9928 when flattening nested group memberships of Windows domain groups.
9929 This is different from the winbind nested groups option which
9930 implements the Windows NT4 model of local group nesting. The
9931 "winbind expand groups" parameter specifically applies to the
9932 membership of domain groups.
9933 This option also affects the return of non nested group memberships
9935 of Windows domain users. With the new default "winbind expand
9936 groups = 0" winbind does not query group memberships at all.
9937 Be aware that a high value for this parameter can result in system
9939 slowdown as the main parent winbindd daemon must perform the group
9940 unrolling and will be unable to answer incoming NSS or
9941 authentication requests during this time.
9942 The default value was changed from 1 to 0 with Samba 4.2. Some
9944 broken applications (including some implementations of newgrp and
9945 sg) calculate the group memberships of users by traversing groups,
9946 such applications will require "winbind expand groups = 1". But the
9947 new default makes winbindd more reliable as it doesn't require SAMR
9948 access to domain controllers of trusted domains.
9949 Default: winbind expand groups = 0
9951 winbind:ignore domains (G)
9953 Allows one to enter a list of trusted domains winbind should ignore
9955 (untrust). This can avoid the overhead of resources from attempting
9956 to login to DCs that should not be communicated with.
9957 Default: winbind:ignore domains =
9959 Example: winbind:ignore domains = DOMAIN1, DOMAIN2
9961 winbind max clients (G)
9963 This parameter specifies the maximum number of clients the
9965 winbindd(8) daemon can connect with. The parameter is not a hard
9966 limit. The winbindd(8) daemon configures itself to be able to
9967 accept at least that many connections, and if the limit is reached,
9968 an attempt is made to disconnect idle clients.
9969 Default: winbind max clients = 200
9971 winbind max domain connections (G)
9973 This parameter specifies the maximum number of simultaneous
9975 connections that the winbindd(8) daemon should open to the domain
9976 controller of one domain. Setting this parameter to a value greater
9977 than 1 can improve scalability with many simultaneous winbind
9978 requests, some of which might be slow.
9979 Note that if winbind offline logon is set to Yes, then only one DC
9981 connection is allowed per domain, regardless of this setting.
9982 Default: winbind max domain connections = 1
9984 Example: winbind max domain connections = 10
9986 winbind nested groups (G)
9988 If set to yes, this parameter activates the support for nested
9990 groups. Nested groups are also called local groups or aliases. They
9991 work like their counterparts in Windows: Nested groups are defined
9992 locally on any machine (they are shared between DC's through their
9993 SAM) and can contain users and global groups from any trusted SAM.
9994 To be able to use nested groups, you need to run nss_winbind.
9995 Default: winbind nested groups = yes
9997 winbind normalize names (G)
9999 This parameter controls whether winbindd will replace whitespace in
10001 user and group names with an underscore (_) character. For example,
10002 whether the name "Space Kadet" should be replaced with the string
10003 "space_kadet". Frequently Unix shell scripts will have difficulty
10004 with usernames contains whitespace due to the default field
10005 separator in the shell. If your domain possesses names containing
10006 the underscore character, this option may cause problems unless the
10007 name aliasing feature is supported by your nss_info plugin.
10008 This feature also enables the name aliasing API which can be used
10010 to make domain user and group names to a non-qualified version.
10011 Please refer to the manpage for the configured idmap and nss_info
10012 plugin for the specifics on how to configure name aliasing for a
10013 specific configuration. Name aliasing takes precedence (and is
10014 mutually exclusive) over the whitespace replacement mechanism
10015 discussed previously.
10016 Default: winbind normalize names = no
10018 Example: winbind normalize names = yes
10020 winbind nss info (G)
10022 This parameter is designed to control how Winbind retrieves Name
10024 Service Information to construct a user's home directory and login
10025 shell. Currently the following settings are available:
10026 • template - The default, using the parameters of template
10028 shell and template homedir)
10029 • <sfu | sfu20 | rfc2307 > - When Samba is running in
10031 security = ads and your Active Directory Domain
10032 Controller does support the Microsoft "Services for
10033 Unix" (SFU) LDAP schema, winbind can retrieve the login
10034 shell and the home directory attributes directly from
10035 your Directory Server. For SFU 3.0 or 3.5 simply choose
10036 "sfu", if you use SFU 2.0 please choose "sfu20".
10037 Note that for the idmap backend idmap_ad you need to
10039 configure those settings in the idmap configuration
10040 section. Make sure to consult the documentation of the
10041 idmap backend that you are using.
10042 Default: winbind nss info = template
10045 Example: winbind nss info = sfu
10047 winbind offline logon (G)
10049 This parameter is designed to control whether Winbind should allow
10051 one to login with the pam_winbind module using Cached Credentials.
10052 If enabled, winbindd will store user credentials from successful
10053 logins encrypted in a local cache.
10054 Default: winbind offline logon = no
10056 Example: winbind offline logon = yes
10058 winbind reconnect delay (G)
10060 This parameter specifies the number of seconds the winbindd(8)
10062 daemon will wait between attempts to contact a Domain controller
10063 for a domain that is determined to be down or not contactable.
10064 Default: winbind reconnect delay = 30
10066 winbind refresh tickets (G)
10068 This parameter is designed to control whether Winbind should
10070 refresh Kerberos Tickets retrieved using the pam_winbind module.
10071 Default: winbind refresh tickets = no
10073 Example: winbind refresh tickets = yes
10075 winbind request timeout (G)
10077 This parameter specifies the number of seconds the winbindd(8)
10079 daemon will wait before disconnecting either a client connection
10080 with no outstanding requests (idle) or a client connection with a
10081 request that has remained outstanding (hung) for longer than this
10082 number of seconds.
10083 Default: winbind request timeout = 60
10085 winbind rpc only (G)
10087 Setting this parameter to yes forces winbindd to use RPC instead of
10089 LDAP to retrieve information from Domain Controllers.
10090 Default: winbind rpc only = no
10092 winbind scan trusted domains (G)
10094 This option only takes effect when the security option is set to
10096 domain or ads. If it is set to yes (the default), winbindd
10097 periodically tries to scan for new trusted domains and adds them to
10098 a global list inside of winbindd. The list can be extracted with
10099 wbinfo --trusted-domains --verbose. This matches the behaviour of
10100 Samba 4.7 and older.
10101 The construction of that global list is not reliable and often
10103 incomplete in complex trust setups. In most situations the list is
10104 not needed any more for winbindd to operate correctly. E.g. for
10105 plain file serving via SMB using a simple idmap setup with autorid,
10106 tdb or ad. However some more complex setups require the list, e.g.
10107 if you specify idmap backends for specific domains. Some
10108 pam_winbind setups may also require the global list.
10109 If you have a setup that doesn't require the global list, you
10111 should set winbind scan trusted domains = no.
10112 Default: winbind scan trusted domains = yes
10114 winbind sealed pipes (G)
10116 This option controls whether any requests from winbindd to domain
10118 controllers pipe will be sealed. Disabling sealing can be useful
10119 for debugging purposes.
10120 The behavior can be controlled per netbios domain by using 'winbind
10122 sealed pipes:NETBIOSDOMAIN = no' as option.
10123 Default: winbind sealed pipes = yes
10125 winbind separator (G)
10127 This parameter allows an admin to define the character used when
10129 listing a username of the form of DOMAIN \user. This parameter is
10130 only applicable when using the pam_winbind.so and nss_winbind.so
10131 modules for UNIX services.
10132 Please note that setting this parameter to + causes problems with
10134 group membership at least on glibc systems, as the character + is
10135 used as a special character for NIS in /etc/group.
10136 Default: winbind separator = \
10138 Example: winbind separator = +
10140 winbind use default domain (G)
10142 This parameter specifies whether the winbindd(8) daemon should
10144 operate on users without domain component in their username. Users
10145 without a domain component are treated as is part of the winbindd
10146 server's own domain. While this does not benefit Windows users, it
10147 makes SSH, FTP and e-mail function in a way much closer to the way
10148 they would in a native unix system.
10149 This option should be avoided if possible. It can cause confusion
10151 about responsibilities for a user or group. In many situations it
10152 is not clear whether winbind or /etc/passwd should be seen as
10153 authoritative for a user, likewise for groups.
10154 Default: winbind use default domain = no
10156 Example: winbind use default domain = yes
10158 winbind use krb5 enterprise principals (G)
10160 winbindd is able to get kerberos tickets for pam_winbind with
10162 krb5_auth or wbinfo -K/--krb5auth=.
10163 winbindd (at least on a domain member) is never be able to have a
10165 complete picture of the trust topology (which is managed by the
10166 DCs). There might be uPNSuffixes and msDS-SPNSuffixes values, which
10167 don't belong to any AD domain at all.
10168 With winbind scan trusted domains = no winbindd don't even get an
10170 incomplete picture of the topology.
10171 It is not really required to know about the trust topology. We can
10173 just rely on the [K]DCs of our primary domain (e.g.
10174 PRIMARY.A.EXAMPLE.COM) and use enterprise principals e.g.
10175 upnfromB@B.EXAMPLE.COM@PRIMARY.A.EXAMPLE.COM and follow the
10176 WRONG_REALM referrals in order to find the correct DC. The final
10177 principal might be userfromB@INTERNALB.EXAMPLE.PRIVATE.
10178 With winbind use krb5 enterprise principals = yes winbindd
10180 enterprise principals will be used.
10181 Default: winbind use krb5 enterprise principals = no
10183 Example: winbind use krb5 enterprise principals = yes
10185 winsdb:local_owner (G)
10187 This specifies the address that is stored in the winsOwner
10189 attribute, of locally registered winsRecord-objects. The default is
10190 to use the ip-address of the first network interface.
10191 No default
10193 winsdb:dbnosync (G)
10195 This parameter disables fsync() after changes of the WINS database.
10197 Default: winsdb:dbnosync = no
10199 wins hook (G)
10201 When Samba is running as a WINS server this allows you to call an
10203 external program for all changes to the WINS database. The primary
10204 use for this option is to allow the dynamic update of external name
10205 resolution databases such as dynamic DNS.
10206 The wins hook parameter specifies the name of a script or
10208 executable that will be called as follows:
10209 wins_hook operation name nametype ttl IP_list
10211 • The first argument is the operation and is one of "add",
10213 "delete", or "refresh". In most cases the operation can
10214 be ignored as the rest of the parameters provide
10215 sufficient information. Note that "refresh" may
10216 sometimes be called when the name has not previously
10217 been added, in that case it should be treated as an add.
10218 • The second argument is the NetBIOS name. If the name is
10220 not a legal name then the wins hook is not called. Legal
10221 names contain only letters, digits, hyphens, underscores
10222 and periods.
10223 • The third argument is the NetBIOS name type as a 2 digit
10225 hexadecimal number.
10226 • The fourth argument is the TTL (time to live) for the
10228 name in seconds.
10229 • The fifth and subsequent arguments are the IP addresses
10231 currently registered for that name. If this list is
10232 empty then the name should be deleted.
10233 An example script that calls the BIND dynamic DNS update program
10235 nsupdate is provided in the examples directory of the Samba source
10236 code.
10237 No default
10239 wins proxy (G)
10241 This is a boolean that controls if nmbd(8) will respond to
10243 broadcast name queries on behalf of other hosts. You may need to
10244 set this to yes for some older clients.
10245 Default: wins proxy = no
10247 wins server (G)
10249 This specifies the IP address (or DNS name: IP address for
10251 preference) of the WINS server that nmbd(8) should register with.
10252 If you have a WINS server on your network then you should set this
10253 to the WINS server's IP.
10254 You should point this at your WINS server if you have a
10256 multi-subnetted network.
10257 If you want to work in multiple namespaces, you can give every wins
10259 server a 'tag'. For each tag, only one (working) server will be
10260 queried for a name. The tag should be separated from the ip address
10261 by a colon.
10262 Note
10264 You need to set up Samba to point to a WINS server if you have
10265 multiple subnets and wish cross-subnet browsing to work
10266 correctly.
10267 See the chapter in the Samba3-HOWTO on Network Browsing.
10268 Default: wins server =
10270 Example: wins server = mary:192.9.200.1 fred:192.168.3.199
10272 mary:192.168.2.61 # For this example when querying a certain name,
10273 192.19.200.1 will be asked first and if that doesn't respond
10274 192.168.2.61. If either of those doesn't know the name
10275 192.168.3.199 will be queried.
10276 Example: wins server = 192.9.200.1 192.168.2.61
10278 wins support (G)
10280 This boolean controls if the nmbd(8) process in Samba will act as a
10282 WINS server. You should not set this to yes unless you have a
10283 multi-subnetted network and you wish a particular nmbd to be your
10284 WINS server. Note that you should NEVER set this to yes on more
10285 than one machine in your network.
10286 Default: wins support = no
10288 workgroup (G)
10290 This controls what workgroup your server will appear to be in when
10292 queried by clients. Note that this parameter also controls the
10293 Domain name used with the security = domain setting.
10294 Default: workgroup = WORKGROUP
10296 Example: workgroup = MYGROUP
10298 wreplsrv:periodic_interval (G)
10300 This maximum interval in seconds between 2 periodically scheduled
10302 runs where we check for wins.ldb changes and do push notifications
10303 to our push partners. Also wins_config.ldb changes are checked in
10304 that interval and partner configuration reloads are done.
10305 Default: wreplsrv:periodic_interval = 15
10307 wreplsrv:propagate name releases (G)
10309 If this parameter is enabled, then explicit (from the client) and
10311 implicit (via the scavenging) name releases are propagated to the
10312 other servers directly, even if there are still other addresses
10313 active, this applies to SPECIAL GROUP (2) and MULTIHOMED (3)
10314 entries. Also the replication conflict merge algorithm for SPECIAL
10315 GROUP (2) entries discards replica addresses where the address
10316 owner is the local server, if the address was not stored locally
10317 before. The merge result is propagated directly in case an address
10318 was discarded. A Windows servers doesn't propagate name releases of
10319 SPECIAL GROUP (2) and MULTIHOMED (3) entries directly, which means
10320 that Windows servers may return different results to name queries
10321 for SPECIAL GROUP (2) and MULTIHOMED (3) names. The option doesn't
10322 have much negative impact if Windows servers are around, but be
10323 aware that they might return unexpected results.
10324 Default: wreplsrv:propagate name releases = no
10326 wreplsrv:scavenging_interval (G)
10328 This is the interval in s between 2 scavenging runs which clean up
10330 the WINS database and changes the states of expired name records.
10331 Defaults to half of the value of wreplsrv:renew_interval.
10332 No default
10334 wreplsrv:tombstone_extra_timeout (G)
10336 This is the time in s the server needs to be up till we'll remove
10338 tombstone records from our database. Defaults to 3 days.
10339 Default: wreplsrv:tombstone_extra_timeout = 259200
10341 wreplsrv:tombstone_interval (G)
10343 This is the interval in s till released records of the WINS server
10345 become tombstone. Defaults to 6 days.
10346 Default: wreplsrv:tombstone_interval = 518400
10348 wreplsrv:tombstone_timeout (G)
10350 This is the interval in s till tombstone records are deleted from
10352 the WINS database. Defaults to 1 day.
10353 Default: wreplsrv:tombstone_timeout = 86400
10355 wreplsrv:verify_interval (G)
10357 This is the interval in s till we verify active replica records
10359 with the owning WINS server. Unfortunately not implemented yet.
10360 Defaults to 24 days.
10361 Default: wreplsrv:verify_interval = 2073600
10363 writable
10365 This parameter is a synonym for writeable.
10367 write ok
10369 This parameter is a synonym for writeable.
10371 writeable (S)
10373 Inverted synonym for read only.
10375 Default: writeable = no
10377 write list (S)
10379 This is a list of users that are given read-write access to a
10381 service. If the connecting user is in this list then they will be
10382 given write access, no matter what the read only option is set to.
10383 The list can include group names using the @group syntax.
10384 Note that if a user is in both the read list and the write list
10386 then they will be given write access.
10387 Default: write list =
10389 Example: write list = admin, root, @staff
10391 write raw (G)
10393 This is ignored if async smb echo handler is set, because this
10395 feature is incompatible with raw write SMB requests
10396 If enabled, raw writes allow writes of 65535 bytes in one packet.
10398 This typically provides a major performance benefit for some very,
10399 very old clients.
10400 However, some clients either negotiate the allowable block size
10402 incorrectly or are incapable of supporting larger block sizes, and
10403 for these clients you may need to disable raw writes.
10404 In general this parameter should be viewed as a system tuning tool
10406 and left severely alone.
10407 Default: write raw = yes
10409 wtmp directory (G)
10411 This parameter is only available if Samba has been configured and
10413 compiled with the option --with-utmp. It specifies a directory
10414 pathname that is used to store the wtmp or wtmpx files (depending
10415 on the UNIX system) that record user connections to a Samba server.
10416 The difference with the utmp directory is the fact that user info
10417 is kept after a user has logged out.
10418 By default this is not set, meaning the system will use whatever
10420 utmp file the native system is set to use (usually /var/run/wtmp on
10421 Linux).
10422 Default: wtmp directory =
10424 Example: wtmp directory = /var/log/wtmp
10426
10428 Although the configuration file permits service names to contain
10429 spaces, your client software may not. Spaces will be ignored in
10430 comparisons anyway, so it shouldn't be a problem - but be aware of the
10431 possibility.
10432 On a similar note, many clients - especially DOS clients - limit
10434 service names to eight characters. smbd(8) has no such limitation, but
10435 attempts to connect from such clients will fail if they truncate the
10436 service names. For this reason you should probably keep your service
10437 names down to eight characters in length.
10438 Use of the [homes] and [printers] special sections make life for an
10440 administrator easy, but the various combinations of default attributes
10441 can be tricky. Take extreme care when designing these sections. In
10442 particular, ensure that the permissions on spool directories are
10443 correct.
10444
10446 This man page is part of version 4.14.5 of the Samba suite.
10447
10449 samba(7), smbpasswd(8), smbd(8), nmbd(8), winbindd(8), samba(8), samba-
10450 tool(8), smbclient(1), nmblookup(1), testparm(1).
10451
10453 The original Samba software and related utilities were created by
10454 Andrew Tridgell. Samba is now developed by the Samba Team as an Open
10455 Source project similar to the way the Linux kernel is developed.
10456Samba 4.14.5 06/01/2021 SMB.CONF(5)