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 file consists of sections and parameters. A section begins with the
16 name of the section in square brackets and continues until the next
17 section begins. Sections contain parameters of the form:
18 name = value
20 The file is line-based - that is, each newline-terminated line
22 represents either a comment, a section name or a parameter.
23 Section and parameter names are not case sensitive.
25 Only the first equals sign in a parameter is significant. Whitespace
27 before or after the first equals sign is discarded. Leading, trailing
28 and internal whitespace in section and parameter names is irrelevant.
29 Leading and trailing whitespace in a parameter value is discarded.
30 Internal whitespace within a parameter value is retained verbatim.
31 Any line beginning with a semicolon (“;”) or a hash (“#”) character is
33 ignored, as are lines containing only whitespace.
34 Any line ending in a “\” is continued on the next line in the customary
36 UNIX fashion.
37 The values following the equals sign in parameters are all either a
39 string (no quotes needed) or a boolean, which may be given as yes/no,
40 1/0 or true/false. Case is not significant in boolean values, but is
41 preserved in string values. Some items such as create masks are
42 numeric.
43
45 Each section in the configuration file (except for the [global]
46 section) describes a shared resource (known as a “share”). The section
47 name is the name of the shared resource and the parameters within the
48 section define the shares attributes.
49 There are three special sections, [global], [homes] and [printers],
51 which are described under special sections. The following notes apply
52 to ordinary section descriptions.
53 A share consists of a directory to which access is being given plus a
55 description of the access rights which are granted to the user of the
56 service. Some housekeeping options are also specifiable.
57 Sections are either file share services (used by the client as an
59 extension of their native file systems) or printable services (used by
60 the client to access print services on the host running the server).
61 Sections may be designated guest services, in which case no password is
63 required to access them. A specified UNIX guest account is used to
64 define access privileges in this case.
65 Sections other than guest services will require a password to access
67 them. The client provides the username. As older clients only provide
68 passwords and not usernames, you may specify a list of usernames to
69 check against the password using the user = option in the share
70 definition. For modern clients such as Windows 95/98/ME/NT/2000, this
71 should not be necessary.
72 The access rights granted by the server are masked by the access rights
74 granted to the specified or guest UNIX user by the host system. The
75 server does not grant more access than the host system grants.
76 The following sample section defines a file space share. The user has
78 write access to the path /home/bar. The share is accessed via the share
79 name foo:
80 [foo]
82 path = /home/bar
83 read only = no
84 The following sample section defines a printable share. The share is
86 read-only, but printable. That is, the only write access permitted is
87 via calls to open, write to and close a spool file. The guest ok
88 parameter means access will be permitted as the default guest user
89 (specified elsewhere):
90 [aprinter]
92 path = /usr/spool/public
93 read only = yes
94 printable = yes
95 guest ok = yes
96
99 The [global] section
100 Parameters in this section apply to the server as a whole, or are
101 defaults for sections that do not specifically define certain items.
102 See the notes under PARAMETERS for more information.
103 The [homes] section
105 If a section called [homes] is included in the configuration file,
106 services connecting clients to their home directories can be created on
107 the fly by the server.
108 When the connection request is made, the existing sections are scanned.
110 If a match is found, it is used. If no match is found, the requested
111 section name is treated as a username and looked up in the local
112 password file. If the name exists and the correct password has been
113 given, a share is created by cloning the [homes] section.
114 Some modifications are then made to the newly created share:
116 · The share name is changed from homes to the located
118 username.
119 · If no path was given, the path is set to the user's home
121 directory.
122 If you decide to use a path = line in your [homes] section, it may be
125 useful to use the %S macro. For example:
126 path = /data/pchome/%S
128 is useful if you have different home directories for your PCs than for
130 UNIX access.
131 This is a fast and simple way to give a large number of clients access
133 to their home directories with a minimum of fuss.
134 A similar process occurs if the requested section name is “homes”,
136 except that the share name is not changed to that of the requesting
137 user. This method of using the [homes] section works well if different
138 users share a client PC.
139 The [homes] section can specify all the parameters a normal service
141 section can specify, though some make more sense than others. The
142 following is a typical and suitable [homes] section:
143 [homes]
145 read only = no
146 An important point is that if guest access is specified in the [homes]
148 section, all home directories will be visible to all clients without a
149 password. In the very unlikely event that this is actually desirable,
150 it is wise to also specify read only access.
151 The browseable flag for auto home directories will be inherited from
153 the global browseable flag, not the [homes] browseable flag. This is
154 useful as it means setting browseable = no in the [homes] section will
155 hide the [homes] share but make any auto home directories visible.
156 The [printers] section
158 This section works like [homes], but for printers.
159 If a [printers] section occurs in the configuration file, users are
161 able to connect to any printer specified in the local host's printcap
162 file.
163 When a connection request is made, the existing sections are scanned.
165 If a match is found, it is used. If no match is found, but a [homes]
166 section exists, it is used as described above. Otherwise, the requested
167 section name is treated as a printer name and the appropriate printcap
168 file is scanned to see if the requested section name is a valid printer
169 share name. If a match is found, a new printer share is created by
170 cloning the [printers] section.
171 A few modifications are then made to the newly created share:
173 · The share name is set to the located printer name
175 · If no printer name was given, the printer name is set to the
177 located printer name
178 · If the share does not permit guest access and no username
180 was given, the username is set to the located printer name.
181 The [printers] service MUST be printable - if you specify otherwise,
184 the server will refuse to load the configuration file.
185 Typically the path specified is that of a world-writeable spool
187 directory with the sticky bit set on it. A typical [printers] entry
188 looks like this:
189 [printers]
191 path = /usr/spool/public
192 guest ok = yes
193 printable = yes
194 All aliases given for a printer in the printcap file are legitimate
196 printer names as far as the server is concerned. If your printing
197 subsystem doesn't work like that, you will have to set up a
198 pseudo-printcap. This is a file consisting of one or more lines like
199 this:
200 alias|alias|alias|alias...
202 Each alias should be an acceptable printer name for your printing
204 subsystem. In the [global] section, specify the new file as your
205 printcap. The server will only recognize names found in your
206 pseudo-printcap, which of course can contain whatever aliases you like.
207 The same technique could be used simply to limit access to a subset of
208 your local printers.
209 An alias, by the way, is defined as any component of the first entry of
211 a printcap record. Records are separated by newlines, components (if
212 there are more than one) are separated by vertical bar symbols (|).
213 Note
215 On SYSV systems which use lpstat to determine what printers are
216 defined on the system you may be able to use printcap name = lpstat
217 to automatically obtain a list of printers. See the printcap name
218 option for more details.
219
221 Starting with Samba version 3.0.23 the capability for non-root users to
222 add, modify, and delete their own share definitions has been added.
223 This capability is called usershares and is controlled by a set of
224 parameters in the [global] section of the smb.conf. The relevant
225 parameters are :
226 usershare allow guests
228 Controls if usershares can permit guest access.
229 usershare max shares
231 Maximum number of user defined shares allowed.
232 usershare owner only
234 If set only directories owned by the sharing user can be shared.
235 usershare path
237 Points to the directory containing the user defined share
238 definitions. The filesystem permissions on this directory control
239 who can create user defined shares.
240 usershare prefix allow list
242 Comma-separated list of absolute pathnames restricting what
243 directories can be shared. Only directories below the pathnames in
244 this list are permitted.
245 usershare prefix deny list
247 Comma-separated list of absolute pathnames restricting what
248 directories can be shared. Directories below the pathnames in this
249 list are prohibited.
250 usershare template share
252 Names a pre-existing share used as a template for creating new
253 usershares. All other share parameters not specified in the user
254 defined share definition are copied from this named share.
255 To allow members of the UNIX group foo to create user defined shares,
257 create the directory to contain the share definitions as follows:
258 Become root:
260 mkdir /usr/local/samba/lib/usershares
262 chgrp foo /usr/local/samba/lib/usershares
263 chmod 1770 /usr/local/samba/lib/usershares
264 Then add the parameters
266 usershare path = /usr/local/samba/lib/usershares
268 usershare max shares = 10 # (or the desired number of shares)
269 to the global section of your smb.conf. Members of the group foo may
271 then manipulate the user defined shares using the following commands.
272 net usershare add sharename path [comment] [acl] [guest_ok=[y|n]]
274 To create or modify (overwrite) a user defined share.
275 net usershare delete sharename
277 To delete a user defined share.
278 net usershare list wildcard-sharename
280 To list user defined shares.
281 net usershare info wildcard-sharename
283 To print information about user defined shares.
284
286 Parameters define the specific attributes of sections.
287 Some parameters are specific to the [global] section (e.g., security).
289 Some parameters are usable in all sections (e.g., create mask). All
290 others are permissible only in normal sections. For the purposes of the
291 following descriptions the [homes] and [printers] sections will be
292 considered normal. The letter G in parentheses indicates that a
293 parameter is specific to the [global] section. The letter S indicates
294 that a parameter can be specified in a service specific section. All S
295 parameters can also be specified in the [global] section - in which
296 case they will define the default behavior for all services.
297 Parameters are arranged here in alphabetical order - this may not
299 create best bedfellows, but at least you can find them! Where there are
300 synonyms, the preferred synonym is described, others refer to the
301 preferred synonym.
302
304 Many of the strings that are settable in the config file can take
305 substitutions. For example the option “path = /tmp/%u” is interpreted
306 as “path = /tmp/john” if the user connected with the username john.
307 These substitutions are mostly noted in the descriptions below, but
309 there are some general substitutions which apply whenever they might be
310 relevant. These are:
311 %U
313 session username (the username that the client wanted, not
314 necessarily the same as the one they got).
315 %G
317 primary group name of %U.
318 %h
320 the Internet hostname that Samba is running on.
321 %m
323 the NetBIOS name of the client machine (very useful).
324 This parameter is not available when Samba listens on port 445, as
326 clients no longer send this information. If you use this macro in
327 an include statement on a domain that has a Samba domain controller
328 be sure to set in the [global] section smb ports = 139. This will
329 cause Samba to not listen on port 445 and will permit include
330 functionality to function as it did with Samba 2.x.
331 %L
333 the NetBIOS name of the server. This allows you to change your
334 config based on what the client calls you. Your server can have a
335 “dual personality”.
336 %M
338 the Internet name of the client machine.
339 %R
341 the selected protocol level after protocol negotiation. It can be
342 one of CORE, COREPLUS, LANMAN1, LANMAN2, NT1, SMB2_02, SMB2_10,
343 SMB2_22, SMB2_24, SMB3_00, SMB3_02, SMB3_10, SMB3_11 or SMB2_FF.
344 %d
346 the process id of the current server process.
347 %a
349 The architecture of the remote machine. It currently recognizes
350 Samba (Samba), the Linux CIFS file system (CIFSFS), OS/2, (OS2),
351 Mac OS X (OSX), Windows for Workgroups (WfWg), Windows 9x/ME
352 (Win95), Windows NT (WinNT), Windows 2000 (Win2K), Windows XP
353 (WinXP), Windows XP 64-bit(WinXP64), Windows 2003 including 2003R2
354 (Win2K3), and Windows Vista (Vista). Anything else will be known as
355 UNKNOWN.
356 %I
358 the IP address of the client machine.
359 Before 4.0.0 it could contain IPv4 mapped IPv6 addresses, now it
361 only contains IPv4 or IPv6 addresses.
362 %J
364 the IP address of the client machine, colons/dots replaced by
365 underscores.
366 %i
368 the local IP address to which a client connected.
369 Before 4.0.0 it could contain IPv4 mapped IPv6 addresses, now it
371 only contains IPv4 or IPv6 addresses.
372 %j
374 the local IP address to which a client connected, colons/dots
375 replaced by underscores.
376 %T
378 the current date and time.
379 %t
381 the current date and time in a minimal format without colons
382 (YYYYYmmdd_HHMMSS).
383 %D
385 name of the domain or workgroup of the current user.
386 %w
388 the winbind separator.
389 %$(envvar)
391 the value of the environment variable envar.
392 The following substitutes apply only to some configuration options
394 (only those that are used when a connection has been established):
395 %S
397 the name of the current service, if any.
398 %P
400 the root directory of the current service, if any.
401 %u
403 username of the current service, if any.
404 %g
406 primary group name of %u.
407 %H
409 the home directory of the user given by %u.
410 %N
412 the name of your NIS home directory server. This is obtained from
413 your NIS auto.map entry. If you have not compiled Samba with the
414 --with-automount option, this value will be the same as %L.
415 %p
417 the path of the service's home directory, obtained from your NIS
418 auto.map entry. The NIS auto.map entry is split up as %N:%p.
419 There are some quite creative things that can be done with these
421 substitutions and other smb.conf options.
422
424 Samba supports name mangling so that DOS and Windows clients can use
425 files that don't conform to the 8.3 format. It can also be set to
426 adjust the case of 8.3 format filenames.
427 There are several options that control the way mangling is performed,
429 and they are grouped here rather than listed separately. For the
430 defaults look at the output of the testparm program.
431 These options can be set separately for each service.
433 The options are:
435 case sensitive = yes/no/auto
437 controls whether filenames are case sensitive. If they aren't,
438 Samba must do a filename search and match on passed names. The
439 default setting of auto allows clients that support case sensitive
440 filenames (Linux CIFSVFS and smbclient 3.0.5 and above currently)
441 to tell the Samba server on a per-packet basis that they wish to
442 access the file system in a case-sensitive manner (to support UNIX
443 case sensitive semantics). No Windows or DOS system supports
444 case-sensitive filename so setting this option to auto is that same
445 as setting it to no for them. Default auto.
446 default case = upper/lower
448 controls what the default case is for new filenames (ie. files that
449 don't currently exist in the filesystem). Default lower. IMPORTANT
450 NOTE: As part of the optimizations for directories containing large
451 numbers of files, the following special case applies. If the
452 options case sensitive = yes, preserve case = No, and short
453 preserve case = No are set, then the case of all incoming client
454 filenames, not just new filenames, will be modified. See additional
455 notes below.
456 preserve case = yes/no
458 controls whether new files (ie. files that don't currently exist in
459 the filesystem) are created with the case that the client passes,
460 or if they are forced to be the default case. Default yes.
461 short preserve case = yes/no
463 controls if new files (ie. files that don't currently exist in the
464 filesystem) which conform to 8.3 syntax, that is all in upper case
465 and of suitable length, are created upper case, or if they are
466 forced to be the default case. This option can be used with
467 preserve case = yes to permit long filenames to retain their case,
468 while short names are lowercased. Default yes.
469 By default, Samba 3.0 has the same semantics as a Windows NT server, in
471 that it is case insensitive but case preserving. As a special case for
472 directories with large numbers of files, if the case options are set as
473 follows, "case sensitive = yes", "case preserve = no", "short preserve
474 case = no" then the "default case" option will be applied and will
475 modify all filenames sent from the client when accessing this share.
476
478 Starting with Samba version 3.2.0, the capability to store Samba
479 configuration in the registry is available. The configuration is stored
480 in the registry key HKLM\Software\Samba\smbconf. There are two levels
481 of registry configuration:
482 1. Share definitions stored in registry are used. This is
484 triggered by setting the global parameter registry shares to
485 “yes” in smb.conf.
486 The registry shares are loaded not at startup but on demand
488 at runtime by smbd. Shares defined in smb.conf take priority
489 over shares of the same name defined in registry.
490 2. Global smb.conf options stored in registry are used. This
492 can be activated in two different ways:
493 Firstly, a registry only configuration is triggered by
495 setting config backend = registry in the [global] section of
496 smb.conf. This resets everything that has been read from
497 config files to this point and reads the content of the
498 global configuration section from the registry. This is the
499 recommended method of using registry based configuration.
500 Secondly, a mixed configuration can be activated by a
502 special new meaning of the parameter include = registry in
503 the [global] section of smb.conf. This reads the global
504 options from registry with the same priorities as for an
505 include of a text file. This may be especially useful in
506 cases where an initial configuration is needed to access the
507 registry.
508 Activation of global registry options automatically
510 activates registry shares. So in the registry only case,
511 shares are loaded on demand only.
512 Note: To make registry-based configurations foolproof at least to a
515 certain extent, the use of lock directory and config backend inside the
516 registry configuration has been disabled: Especially by changing the
517 lock directory inside the registry configuration, one would create a
518 broken setup where the daemons do not see the configuration they loaded
519 once it is active.
520 The registry configuration can be accessed with tools like regedit or
522 net (rpc) registry in the key HKLM\Software\Samba\smbconf. More
523 conveniently, the conf subcommand of the net(8) utility offers a
524 dedicated interface to read and write the registry based configuration
525 locally, i.e. directly accessing the database file, circumventing the
526 server.
527
529 In the SMB protocol, users, groups, and machines are represented by
530 their security identifiers (SIDs). On POSIX system Samba processes need
531 to run under corresponding POSIX user identities and with supplemental
532 POSIX groups to allow access to the files owned by those users and
533 groups. The process of mapping SIDs to POSIX users and groups is called
534 IDENTITY MAPPING or, in short, ID MAPPING.
535 Samba supports multiple ways to map SIDs to POSIX users and groups. The
537 configuration is driven by the idmap config DOMAIN : OPTION option
538 which allows one to specify identity mapping (idmap) options for each
539 domain separately.
540 Identity mapping modules implement different strategies for mapping of
542 SIDs to POSIX user and group identities. They are applicable to
543 different use cases and scenarios. It is advised to read the
544 documentation of the individual identity mapping modules before
545 choosing a specific scenario to use. Each identity management module is
546 documented in a separate manual page. The standard idmap backends are
547 tdb (idmap_tdb(8)), tdb2 (idmap_tdb2(8)), ldap (idmap_ldap(8)), rid
548 (idmap_rid(8)), hash (idmap_hash(8)), autorid (idmap_autorid(8)), ad
549 (idmap_ad(8)), nss (idmap_nss(8)), and rfc2307 (idmap_rfc2307(8)).
550 Overall, ID mapping configuration should be decided carefully. Changes
552 to the already deployed ID mapping configuration may create the risk of
553 losing access to the data or disclosing the data to the wrong parties.
554 This example shows how to configure two domains with idmap_rid(8), the
556 principal domain and a trusted domain, leaving the default id mapping
557 scheme at tdb.
558 [global]
560 security = domain
561 workgroup = MAIN
562 idmap config * : backend = tdb
564 idmap config * : range = 1000000-1999999
565 idmap config MAIN : backend = rid
567 idmap config MAIN : range = 5000000-5999999
568 idmap config TRUSTED : backend = rid
570 idmap config TRUSTED : range = 6000000-6999999
571
574 abort shutdown script (G)
575 This a full path name to a script called by smbd(8) that should
577 stop a shutdown procedure issued by the shutdown script.
578 If the connected user possesses the SeRemoteShutdownPrivilege,
580 right, this command will be run as root.
581 Default: abort shutdown script = ""
583 Example: abort shutdown script = /sbin/shutdown -c
585 access based share enum (S)
587 If this parameter is yes for a service, then the share hosted by
589 the service will only be visible to users who have read or write
590 access to the share during share enumeration (for example net view
591 \\sambaserver). The share ACLs which allow or deny the access to
592 the share can be modified using for example the sharesec command or
593 using the appropriate Windows tools. This has parallels to access
594 based enumeration, the main difference being that only share
595 permissions are evaluated, and security descriptors on files
596 contained on the share are not used in computing enumeration access
597 rights.
598 Default: access based share enum = no
600 acl allow execute always (S)
602 This boolean parameter controls the behaviour of smbd(8) when
604 receiving a protocol request of "open for execution" from a Windows
605 client. With Samba 3.6 and older, the execution right in the ACL
606 was not checked, so a client could execute a file even if it did
607 not have execute rights on the file. In Samba 4.0, this has been
608 fixed, so that by default, i.e. when this parameter is set to
609 "False", "open for execution" is now denied when execution
610 permissions are not present.
611 If this parameter is set to "True", Samba does not check execute
613 permissions on "open for execution", thus re-establishing the
614 behaviour of Samba 3.6. This can be useful to smoothen upgrades
615 from older Samba versions to 4.0 and newer. This setting is not
616 meant to be used as a permanent setting, but as a temporary relief:
617 It is recommended to fix the permissions in the ACLs and reset this
618 parameter to the default after a certain transition period.
619 Default: acl allow execute always = no
621 acl check permissions (S)
623 Please note this parameter is now deprecated in Samba 3.6.2 and
625 will be removed in a future version of Samba.
626 This boolean parameter controls what smbd(8) does on receiving a
628 protocol request of "open for delete" from a Windows client. If a
629 Windows client doesn't have permissions to delete a file then they
630 expect this to be denied at open time. POSIX systems normally only
631 detect restrictions on delete by actually attempting to delete the
632 file or directory. As Windows clients can (and do) "back out" a
633 delete request by unsetting the "delete on close" bit Samba cannot
634 delete the file immediately on "open for delete" request as we
635 cannot restore such a deleted file. With this parameter set to true
636 (the default) then smbd checks the file system permissions directly
637 on "open for delete" and denies the request without actually
638 deleting the file if the file system permissions would seem to deny
639 it. This is not perfect, as it's possible a user could have deleted
640 a file without Samba being able to check the permissions correctly,
641 but it is close enough to Windows semantics for mostly correct
642 behaviour. Samba will correctly check POSIX ACL semantics in this
643 case.
644 If this parameter is set to "false" Samba doesn't check permissions
646 on "open for delete" and allows the open. If the user doesn't have
647 permission to delete the file this will only be discovered at close
648 time, which is too late for the Windows user tools to display an
649 error message to the user. The symptom of this is files that appear
650 to have been deleted "magically" re-appearing on a Windows explorer
651 refresh. This is an extremely advanced protocol option which should
652 not need to be changed. This parameter was introduced in its final
653 form in 3.0.21, an earlier version with slightly different
654 semantics was introduced in 3.0.20. That older version is not
655 documented here.
656 Default: acl check permissions = yes
658 acl group control (S)
660 In a POSIX filesystem, only the owner of a file or directory and
662 the superuser can modify the permissions and ACLs on a file. If
663 this parameter is set, then Samba overrides this restriction, and
664 also allows the primary group owner of a file or directory to
665 modify the permissions and ACLs on that file.
666 On a Windows server, groups may be the owner of a file or directory
668 - thus allowing anyone in that group to modify the permissions on
669 it. This allows the delegation of security controls on a point in
670 the filesystem to the group owner of a directory and anything below
671 it also owned by that group. This means there are multiple people
672 with permissions to modify ACLs on a file or directory, easing
673 manageability.
674 This parameter allows Samba to also permit delegation of the
676 control over a point in the exported directory hierarchy in much
677 the same way as Windows. This allows all members of a UNIX group to
678 control the permissions on a file or directory they have group
679 ownership on.
680 This parameter is best used with the inherit owner option and also
682 on a share containing directories with the UNIX setgid bit set on
683 them, which causes new files and directories created within it to
684 inherit the group ownership from the containing directory.
685 This parameter was deprecated in Samba 3.0.23, but re-activated in
687 Samba 3.0.31 and above, as it now only controls permission changes
688 if the user is in the owning primary group. It is now no longer
689 equivalent to the dos filemode option.
690 Default: acl group control = no
692 acl map full control (S)
694 This boolean parameter controls whether smbd(8) maps a POSIX ACE
696 entry of "rwx" (read/write/execute), the maximum allowed POSIX
697 permission set, into a Windows ACL of "FULL CONTROL". If this
698 parameter is set to true any POSIX ACE entry of "rwx" will be
699 returned in a Windows ACL as "FULL CONTROL", is this parameter is
700 set to false any POSIX ACE entry of "rwx" will be returned as the
701 specific Windows ACL bits representing read, write and execute.
702 Default: acl map full control = yes
704 add group script (G)
706 This is the full pathname to a script that will be run AS ROOT by
708 smbd(8) when a new group is requested. It will expand any %g to the
709 group name passed. This script is only useful for installations
710 using the Windows NT domain administration tools. The script is
711 free to create a group with an arbitrary name to circumvent unix
712 group name restrictions. In that case the script must print the
713 numeric gid of the created group on stdout.
714 Default: add group script =
716 Example: add group script = /usr/sbin/groupadd %g
718 add machine script (G)
720 This is the full pathname to a script that will be run by smbd(8)
722 when a machine is added to Samba's domain and a Unix account
723 matching the machine's name appended with a "$" does not already
724 exist.
725 This option is very similar to the add user script, and likewise
727 uses the %u substitution for the account name. Do not use the %m
728 substitution.
729 Default: add machine script =
731 Example: add machine script = /usr/sbin/adduser -n -g machines -c
733 Machine -d /var/lib/nobody -s /bin/false %u
734 addport command (G)
736 Samba 3.0.23 introduced support for adding printer ports remotely
738 using the Windows "Add Standard TCP/IP Port Wizard". This option
739 defines an external program to be executed when smbd receives a
740 request to add a new Port to the system. The script is passed two
741 parameters:
742 · port name
744 · device URI
746 The deviceURI is in the format of
748 socket://<hostname>[:<portnumber>] or lpd://<hostname>/<queuename>.
749 Default: addport command =
751 Example: addport command = /etc/samba/scripts/addport.sh
753 addprinter command (G)
755 With the introduction of MS-RPC based printing support for Windows
757 NT/2000 clients in Samba 2.2, The MS Add Printer Wizard (APW) icon
758 is now also available in the "Printers..." folder displayed a share
759 listing. The APW allows for printers to be add remotely to a Samba
760 or Windows NT/2000 print server.
761 For a Samba host this means that the printer must be physically
763 added to the underlying printing system. The addprinter command
764 defines a script to be run which will perform the necessary
765 operations for adding the printer to the print system and to add
766 the appropriate service definition to the smb.conf file in order
767 that it can be shared by smbd(8).
768 The addprinter command is automatically invoked with the following
770 parameter (in order):
771 · printer name
773 · share name
775 · port name
777 · driver name
779 · location
781 · Windows 9x driver location
783 All parameters are filled in from the PRINTER_INFO_2 structure sent
785 by the Windows NT/2000 client with one exception. The "Windows 9x
786 driver location" parameter is included for backwards compatibility
787 only. The remaining fields in the structure are generated from
788 answers to the APW questions.
789 Once the addprinter command has been executed, smbd will reparse
791 the smb.conf to determine if the share defined by the APW exists.
792 If the sharename is still invalid, then smbd will return an
793 ACCESS_DENIED error to the client.
794 The addprinter command program can output a single line of text,
796 which Samba will set as the port the new printer is connected to.
797 If this line isn't output, Samba won't reload its printer shares.
798 Default: addprinter command =
800 Example: addprinter command = /usr/bin/addprinter
802 add share command (G)
804 Samba 2.2.0 introduced the ability to dynamically add and delete
806 shares via the Windows NT 4.0 Server Manager. The add share command
807 is used to define an external program or script which will add a
808 new service definition to smb.conf.
809 In order to successfully execute the add share command, smbd
811 requires that the administrator connects using a root account (i.e.
812 uid == 0) or has the SeDiskOperatorPrivilege. Scripts defined in
813 the add share command parameter are executed as root.
814 When executed, smbd will automatically invoke the add share command
816 with five parameters.
817 · configFile - the location of the global smb.conf file.
819 · shareName - the name of the new share.
821 · pathName - path to an **existing** directory on disk.
823 · comment - comment string to associate with the new
825 share.
826 · max connections Number of maximum simultaneous
828 connections to this share.
829 This parameter is only used to add file shares. To add printer
831 shares, see the addprinter command.
832 Default: add share command =
834 Example: add share command = /usr/local/bin/addshare
836 add user script (G)
838 This is the full pathname to a script that will be run AS ROOT by
840 smbd(8) under special circumstances described below.
841 Normally, a Samba server requires that UNIX users are created for
843 all users accessing files on this server. For sites that use
844 Windows NT account databases as their primary user database
845 creating these users and keeping the user list in sync with the
846 Windows NT PDC is an onerous task. This option allows smbd to
847 create the required UNIX users ON DEMAND when a user accesses the
848 Samba server.
849 When the Windows user attempts to access the Samba server, at login
851 (session setup in the SMB protocol) time, smbd(8) contacts the
852 password server and attempts to authenticate the given user with
853 the given password. If the authentication succeeds then smbd
854 attempts to find a UNIX user in the UNIX password database to map
855 the Windows user into. If this lookup fails, and add user script is
856 set then smbd will call the specified script AS ROOT, expanding any
857 %u argument to be the user name to create.
858 If this script successfully creates the user then smbd will
860 continue on as though the UNIX user already existed. In this way,
861 UNIX users are dynamically created to match existing Windows NT
862 accounts.
863 See also security, password server, delete user script.
865 Default: add user script =
867 Example: add user script = /usr/local/samba/bin/add_user %u
869 add user to group script (G)
871 Full path to the script that will be called when a user is added to
873 a group using the Windows NT domain administration tools. It will
874 be run by smbd(8)AS ROOT. Any %g will be replaced with the group
875 name and any %u will be replaced with the user name.
876 Note that the adduser command used in the example below does not
878 support the used syntax on all systems.
879 Default: add user to group script =
881 Example: add user to group script = /usr/sbin/adduser %u %g
883 administrative share (S)
885 If this parameter is set to yes for a share, then the share will be
887 an administrative share. The Administrative Shares are the default
888 network shares created by all Windows NT-based operating systems.
889 These are shares like C$, D$ or ADMIN$. The type of these shares is
890 STYPE_DISKTREE_HIDDEN.
891 See the section below on security for more information about this
893 option.
894 Default: administrative share = no
896 admin users (S)
898 This is a list of users who will be granted administrative
900 privileges on the share. This means that they will do all file
901 operations as the super-user (root).
902 You should use this option very carefully, as any user in this list
904 will be able to do anything they like on the share, irrespective of
905 file permissions.
906 Default: admin users =
908 Example: admin users = jason
910 afs share (S)
912 This parameter controls whether special AFS features are enabled
914 for this share. If enabled, it assumes that the directory exported
915 via the path parameter is a local AFS import. The special AFS
916 features include the attempt to hand-craft an AFS token if you
917 enabled --with-fake-kaserver in configure.
918 Default: afs share = no
920 afs token lifetime (G)
922 This parameter controls the lifetime of tokens that the AFS
924 fake-kaserver claims. In reality these never expire but this
925 lifetime controls when the afs client will forget the token.
926 Set this parameter to 0 to get NEVERDATE.
928 Default: afs token lifetime = 604800
930 afs username map (G)
932 If you are using the fake kaserver AFS feature, you might want to
934 hand-craft the usernames you are creating tokens for. For example
935 this is necessary if you have users from several domain in your AFS
936 Protection Database. One possible scheme to code users as
937 DOMAIN+User as it is done by winbind with the + as a separator.
938 The mapped user name must contain the cell name to log into, so
940 without setting this parameter there will be no token.
941 Default: afs username map =
943 Example: afs username map = %u@afs.samba.org
945 aio max threads (G)
947 The integer parameter specifies the maximum number of threads each
949 smbd process will create when doing parallel asynchronous IO calls.
950 If the number of outstanding calls is greater than this number the
951 requests will not be refused but go onto a queue and will be
952 scheduled in turn as outstanding requests complete.
953 Related command: aio read size
955 Related command: aio write size
957 Default: aio max threads = 100
959 aio read size (S)
961 If this integer parameter is set to a non-zero value, Samba will
963 read from files asynchronously when the request size is bigger than
964 this value. Note that it happens only for non-chained and
965 non-chaining reads and when not using write cache.
966 The only reasonable values for this parameter are 0 (no async I/O)
968 and 1 (always do async I/O).
969 Related command: write cache size
971 Related command: aio write size
973 Default: aio read size = 1
975 Example: aio read size = 0 # Always do reads synchronously
977 aio write behind (S)
979 If Samba has been built with asynchronous I/O support, Samba will
981 not wait until write requests are finished before returning the
982 result to the client for files listed in this parameter. Instead,
983 Samba will immediately return that the write request has been
984 finished successfully, no matter if the operation will succeed or
985 not. This might speed up clients without aio support, but is really
986 dangerous, because data could be lost and files could be damaged.
987 The syntax is identical to the veto files parameter.
989 Default: aio write behind =
991 Example: aio write behind = /*.tmp/
993 aio write size (S)
995 If this integer parameter is set to a non-zero value, Samba will
997 write to files asynchronously when the request size is bigger than
998 this value. Note that it happens only for non-chained and
999 non-chaining reads and when not using write cache.
1000 The only reasonable values for this parameter are 0 (no async I/O)
1002 and 1 (always do async I/O).
1003 Compared to aio read size this parameter has a smaller effect, most
1005 writes should end up in the file system cache. Writes that require
1006 space allocation might benefit most from going asynchronous.
1007 Related command: write cache size
1009 Related command: aio read size
1011 Default: aio write size = 1
1013 Example: aio write size = 0 # Always do writes synchronously
1015 algorithmic rid base (G)
1017 This determines how Samba will use its algorithmic mapping from
1019 uids/gid to the RIDs needed to construct NT Security Identifiers.
1020 Setting this option to a larger value could be useful to sites
1022 transitioning from WinNT and Win2k, as existing user and group rids
1023 would otherwise clash with system users etc.
1024 All UIDs and GIDs must be able to be resolved into SIDs for the
1026 correct operation of ACLs on the server. As such the algorithmic
1027 mapping can't be 'turned off', but pushing it 'out of the way'
1028 should resolve the issues. Users and groups can then be assigned
1029 'low' RIDs in arbitrary-rid supporting backends.
1030 Default: algorithmic rid base = 1000
1032 Example: algorithmic rid base = 100000
1034 allocation roundup size (S)
1036 This parameter allows an administrator to tune the allocation size
1038 reported to Windows clients. The default size of 1Mb generally
1039 results in improved Windows client performance. However, rounding
1040 the allocation size may cause difficulties for some applications,
1041 e.g. MS Visual Studio. If the MS Visual Studio compiler starts to
1042 crash with an internal error, set this parameter to zero for this
1043 share.
1044 The integer parameter specifies the roundup size in bytes.
1046 Default: allocation roundup size = 1048576
1048 Example: allocation roundup size = 0 # (to disable roundups)
1050 allow dcerpc auth level connect (G)
1052 This option controls whether DCERPC services are allowed to be used
1054 with DCERPC_AUTH_LEVEL_CONNECT, which provides authentication, but
1055 no per message integrity nor privacy protection.
1056 Some interfaces like samr, lsarpc and netlogon have a hard-coded
1058 default of no and epmapper, mgmt and rpcecho have a hard-coded
1059 default of yes.
1060 The behavior can be overwritten per interface name (e.g. lsarpc,
1062 netlogon, samr, srvsvc, winreg, wkssvc ...) by using 'allow dcerpc
1063 auth level connect:interface = yes' as option.
1064 This option yields precedence to the implementation specific
1066 restrictions. E.g. the drsuapi and backupkey protocols require
1067 DCERPC_AUTH_LEVEL_PRIVACY. The dnsserver protocol requires
1068 DCERPC_AUTH_LEVEL_INTEGRITY.
1069 Default: allow dcerpc auth level connect = no
1071 Example: allow dcerpc auth level connect = yes
1073 allow dns updates (G)
1075 This option determines what kind of updates to the DNS are allowed.
1077 DNS updates can either be disallowed completely by setting it to
1079 disabled, enabled over secure connections only by setting it to
1080 secure only or allowed in all cases by setting it to nonsecure.
1081 Default: allow dns updates = secure only
1083 Example: allow dns updates = disabled
1085 allow insecure wide links (G)
1087 In normal operation the option wide links which allows the server
1089 to follow symlinks outside of a share path is automatically
1090 disabled when unix extensions are enabled on a Samba server. This
1091 is done for security purposes to prevent UNIX clients creating
1092 symlinks to areas of the server file system that the administrator
1093 does not wish to export.
1094 Setting allow insecure wide links to true disables the link between
1096 these two parameters, removing this protection and allowing a site
1097 to configure the server to follow symlinks (by setting wide links
1098 to "true") even when unix extensions is turned on.
1099 It is not recommended to enable this option unless you fully
1101 understand the implications of allowing the server to follow
1102 symbolic links created by UNIX clients. For most normal Samba
1103 configurations this would be considered a security hole and setting
1104 this parameter is not recommended.
1105 This option was added at the request of sites who had deliberately
1107 set Samba up in this way and needed to continue supporting this
1108 functionality without having to patch the Samba code.
1109 Default: allow insecure wide links = no
1111 allow nt4 crypto (G)
1113 This option controls whether the netlogon server (currently only in
1115 'active directory domain controller' mode), will reject clients
1116 which does not support NETLOGON_NEG_STRONG_KEYS nor
1117 NETLOGON_NEG_SUPPORTS_AES.
1118 This option was added with Samba 4.2.0. It may lock out clients
1120 which worked fine with Samba versions up to 4.1.x. as the effective
1121 default was "yes" there, while it is "no" now.
1122 If you have clients without RequireStrongKey = 1 in the registry,
1124 you may need to set "allow nt4 crypto = yes", until you have fixed
1125 all clients.
1126 "allow nt4 crypto = yes" allows weak crypto to be negotiated, maybe
1128 via downgrade attacks.
1129 This option yields precedence to the 'reject md5 clients' option.
1131 Default: allow nt4 crypto = no
1133 allow trusted domains (G)
1135 This option only takes effect when the security option is set to
1137 server, domain or ads. If it is set to no, then attempts to connect
1138 to a resource from a domain or workgroup other than the one which
1139 smbd is running in will fail, even if that domain is trusted by the
1140 remote server doing the authentication.
1141 This is useful if you only want your Samba server to serve
1143 resources to users in the domain it is a member of. As an example,
1144 suppose that there are two domains DOMA and DOMB. DOMB is trusted
1145 by DOMA, which contains the Samba server. Under normal
1146 circumstances, a user with an account in DOMB can then access the
1147 resources of a UNIX account with the same account name on the Samba
1148 server even if they do not have an account in DOMA. This can make
1149 implementing a security boundary difficult.
1150 Default: allow trusted domains = yes
1152 allow unsafe cluster upgrade (G)
1154 If set to no (the default), smbd checks at startup if other smbd
1156 versions are running in the cluster and refuses to start if so.
1157 This is done to protect data corruption in internal data structures
1158 due to incompatible Samba versions running concurrently in the same
1159 cluster. Setting this parameter to yes disables this safety check.
1160 Default: allow unsafe cluster upgrade = no
1162 apply group policies (G)
1164 This option controls whether winbind will execute the gpupdate
1166 command defined in gpo update command on the Group Policy update
1167 interval. The Group Policy update interval is defined as every 90
1168 minutes, plus a random offset between 0 and 30 minutes. This
1169 applies Group Policy Machine polices to the client or KDC and
1170 machine policies to a server.
1171 Default: apply group policies = no
1173 Example: apply group policies = yes
1175 async smb echo handler (G)
1177 This parameter specifies whether Samba should fork the async smb
1179 echo handler. It can be beneficial if your file system can block
1180 syscalls for a very long time. In some circumstances, it prolongs
1181 the timeout that Windows uses to determine whether a connection is
1182 dead.
1183 Default: async smb echo handler = no
1185 auth event notification (G)
1187 When enabled, this option causes Samba (acting as an Active
1189 Directory Domain Controller) to stream authentication events across
1190 the internal message bus. Scripts built using Samba's python
1191 bindings can listen to these events by registering as the service
1192 auth_event.
1193 This should be considered a developer option (it assists in the
1195 Samba testsuite) rather than a facility for external auditing, as
1196 message delivery is not guaranteed (a feature that the testsuite
1197 works around). Additionally Samba must be compiled with the jansson
1198 support for this option to be effective.
1199 The authentication events are also logged via the normal logging
1201 methods when the log level is set appropriately.
1202 Default: auth event notification = no
1204 preload
1206 This parameter is a synonym for auto services.
1208 auto services (G)
1210 This is a list of services that you want to be automatically added
1212 to the browse lists. This is most useful for homes and printers
1213 services that would otherwise not be visible.
1214 Note that if you just want all printers in your printcap file
1216 loaded then the load printers option is easier.
1217 Default: auto services =
1219 Example: auto services = fred lp colorlp
1221 available (S)
1223 This parameter lets you "turn off" a service. If available = no,
1225 then ALL attempts to connect to the service will fail. Such
1226 failures are logged.
1227 Default: available = yes
1229 bind dns directory
1231 This parameter is a synonym for binddns dir.
1233 binddns dir (G)
1235 This parameters defines the directory samba will use to store the
1237 configuration files for bind, such as named.conf. NOTE: The bind
1238 dns directory needs to be on the same mount point as the private
1239 directory!
1240 Default: binddns dir = /var/lib/samba/bind-dns
1242 bind interfaces only (G)
1244 This global parameter allows the Samba admin to limit what
1246 interfaces on a machine will serve SMB requests. It affects file
1247 service smbd(8) and name service nmbd(8) in a slightly different
1248 ways.
1249 For name service it causes nmbd to bind to ports 137 and 138 on the
1251 interfaces listed in the interfaces parameter. nmbd also binds to
1252 the "all addresses" interface (0.0.0.0) on ports 137 and 138 for
1253 the purposes of reading broadcast messages. If this option is not
1254 set then nmbd will service name requests on all of these sockets.
1255 If bind interfaces only is set then nmbd will check the source
1256 address of any packets coming in on the broadcast sockets and
1257 discard any that don't match the broadcast addresses of the
1258 interfaces in the interfaces parameter list. As unicast packets are
1259 received on the other sockets it allows nmbd to refuse to serve
1260 names to machines that send packets that arrive through any
1261 interfaces not listed in the interfaces list. IP Source address
1262 spoofing does defeat this simple check, however, so it must not be
1263 used seriously as a security feature for nmbd.
1264 For file service it causes smbd(8) to bind only to the interface
1266 list given in the interfaces parameter. This restricts the networks
1267 that smbd will serve, to packets coming in on those interfaces.
1268 Note that you should not use this parameter for machines that are
1269 serving PPP or other intermittent or non-broadcast network
1270 interfaces as it will not cope with non-permanent interfaces.
1271 If bind interfaces only is set and the network address 127.0.0.1 is
1273 not added to the interfaces parameter list smbpasswd(8) may not
1274 work as expected due to the reasons covered below.
1275 To change a users SMB password, the smbpasswd by default connects
1277 to the localhost - 127.0.0.1 address as an SMB client to issue the
1278 password change request. If bind interfaces only is set then unless
1279 the network address 127.0.0.1 is added to the interfaces parameter
1280 list then smbpasswd will fail to connect in it's default mode.
1281 smbpasswd can be forced to use the primary IP interface of the
1282 local host by using its smbpasswd(8)-r remote machine parameter,
1283 with remote machine set to the IP name of the primary interface of
1284 the local host.
1285 Default: bind interfaces only = no
1287 blocking locks (S)
1289 This parameter controls the behavior of smbd(8) when given a
1291 request by a client to obtain a byte range lock on a region of an
1292 open file, and the request has a time limit associated with it.
1293 If this parameter is set and the lock range requested cannot be
1295 immediately satisfied, samba will internally queue the lock
1296 request, and periodically attempt to obtain the lock until the
1297 timeout period expires.
1298 If this parameter is set to no, then samba will behave as previous
1300 versions of Samba would and will fail the lock request immediately
1301 if the lock range cannot be obtained.
1302 Default: blocking locks = yes
1304 block size (S)
1306 This parameter controls the behavior of smbd(8) when reporting disk
1308 free sizes. By default, this reports a disk block size of 1024
1309 bytes.
1310 Changing this parameter may have some effect on the efficiency of
1312 client writes, this is not yet confirmed. This parameter was added
1313 to allow advanced administrators to change it (usually to a higher
1314 value) and test the effect it has on client write performance
1315 without re-compiling the code. As this is an experimental option it
1316 may be removed in a future release.
1317 Changing this option does not change the disk free reporting size,
1319 just the block size unit reported to the client.
1320 Default: block size = 1024
1322 Example: block size = 4096
1324 browsable
1326 This parameter is a synonym for browseable.
1328 browseable (S)
1330 This controls whether this share is seen in the list of available
1332 shares in a net view and in the browse list.
1333 Default: browseable = yes
1335 browse list (G)
1337 This controls whether smbd(8) will serve a browse list to a client
1339 doing a NetServerEnum call. Normally set to yes. You should never
1340 need to change this.
1341 Default: browse list = yes
1343 cache directory (G)
1345 Usually, most of the TDB files are stored in the lock directory.
1347 Since Samba 3.4.0, it is possible to differentiate between TDB
1348 files with persistent data and TDB files with non-persistent data
1349 using the state directory and the cache directory options.
1350 This option specifies the directory for storing TDB files
1352 containing non-persistent data that will be kept across service
1353 restarts. The directory should be placed on persistent storage, but
1354 the data can be safely deleted by an administrator.
1355 Default: cache directory = /var/lib/samba
1357 Example: cache directory = /var/run/samba/locks/cache
1359 casesignames
1361 This parameter is a synonym for case sensitive.
1363 case sensitive (S)
1365 See the discussion in the section name mangling.
1367 Default: case sensitive = auto
1369 change notify (G)
1371 This parameter specifies whether Samba should reply to a client's
1373 file change notify requests.
1374 You should never need to change this parameter
1376 Default: change notify = yes
1378 change share command (G)
1380 Samba 2.2.0 introduced the ability to dynamically add and delete
1382 shares via the Windows NT 4.0 Server Manager. The change share
1383 command is used to define an external program or script which will
1384 modify an existing service definition in smb.conf.
1385 In order to successfully execute the change share command, smbd
1387 requires that the administrator connects using a root account (i.e.
1388 uid == 0) or has the SeDiskOperatorPrivilege. Scripts defined in
1389 the change share command parameter are executed as root.
1390 When executed, smbd will automatically invoke the change share
1392 command with six parameters.
1393 · configFile - the location of the global smb.conf file.
1395 · shareName - the name of the new share.
1397 · pathName - path to an **existing** directory on disk.
1399 · comment - comment string to associate with the new
1401 share.
1402 · max connections Number of maximum simultaneous
1404 connections to this share.
1405 · CSC policy - client side caching policy in string form.
1407 Valid values are: manual, documents, programs, disable.
1408 This parameter is only used to modify existing file share
1410 definitions. To modify printer shares, use the "Printers..." folder
1411 as seen when browsing the Samba host.
1412 Default: change share command =
1414 Example: change share command = /usr/local/bin/changeshare
1416 check password script (G)
1418 The name of a program that can be used to check password
1420 complexity. The password is sent to the program's standard input.
1421 The program must return 0 on a good password, or any other value if
1423 the password is bad. In case the password is considered weak (the
1424 program does not return 0) the user will be notified and the
1425 password change will fail.
1426 In Samba AD, this script will be run AS ROOT by samba(8) without
1428 any substitutions.
1429 Note: In the example directory is a sample program called
1431 crackcheck that uses cracklib to check the password quality.
1432 Default: check password script = # Disabled
1434 Example: check password script = /usr/local/sbin/crackcheck
1436 cldap port (G)
1438 This option controls the port used by the CLDAP protocol.
1440 Default: cldap port = 389
1442 Example: cldap port = 3389
1444 client ipc max protocol (G)
1446 The value of the parameter (a string) is the highest protocol level
1448 that will be supported for IPC$ connections as DCERPC transport.
1449 Normally this option should not be set as the automatic negotiation
1451 phase in the SMB protocol takes care of choosing the appropriate
1452 protocol.
1453 The value default refers to the latest supported protocol,
1455 currently SMB3_11.
1456 See client max protocol for a full list of available protocols. The
1458 values CORE, COREPLUS, LANMAN1, LANMAN2 are silently upgraded to
1459 NT1.
1460 Default: client ipc max protocol = default
1462 Example: client ipc max protocol = SMB2_10
1464 client ipc min protocol (G)
1466 This setting controls the minimum protocol version that the will be
1468 attempted to use for IPC$ connections as DCERPC transport.
1469 Normally this option should not be set as the automatic negotiation
1471 phase in the SMB protocol takes care of choosing the appropriate
1472 protocol.
1473 The value default refers to the higher value of NT1 and the
1475 effective value of client min protocol.
1476 See client max protocol for a full list of available protocols. The
1478 values CORE, COREPLUS, LANMAN1, LANMAN2 are silently upgraded to
1479 NT1.
1480 Default: client ipc min protocol = default
1482 Example: client ipc min protocol = SMB3_11
1484 client ipc signing (G)
1486 This controls whether the client is allowed or required to use SMB
1488 signing for IPC$ connections as DCERPC transport. Possible values
1489 are auto, mandatory and disabled.
1490 When set to mandatory or default, SMB signing is required.
1492 When set to auto, SMB signing is offered, but not enforced and if
1494 set to disabled, SMB signing is not offered either.
1495 Connections from winbindd to Active Directory Domain Controllers
1497 always enforce signing.
1498 Default: client ipc signing = default
1500 client lanman auth (G)
1502 This parameter determines whether or not smbclient(8) and other
1504 samba client tools will attempt to authenticate itself to servers
1505 using the weaker LANMAN password hash. If disabled, only server
1506 which support NT password hashes (e.g. Windows NT/2000, Samba,
1507 etc... but not Windows 95/98) will be able to be connected from the
1508 Samba client.
1509 The LANMAN encrypted response is easily broken, due to its
1511 case-insensitive nature, and the choice of algorithm. Clients
1512 without Windows 95/98 servers are advised to disable this option.
1513 Disabling this option will also disable the client plaintext auth
1515 option.
1516 Likewise, if the client ntlmv2 auth parameter is enabled, then only
1518 NTLMv2 logins will be attempted.
1519 Default: client lanman auth = no
1521 client ldap sasl wrapping (G)
1523 The client ldap sasl wrapping defines whether ldap traffic will be
1525 signed or signed and encrypted (sealed). Possible values are plain,
1526 sign and seal.
1527 The values sign and seal are only available if Samba has been
1529 compiled against a modern OpenLDAP version (2.3.x or higher).
1530 This option is needed in the case of Domain Controllers enforcing
1532 the usage of signed LDAP connections (e.g. Windows 2000 SP3 or
1533 higher). LDAP sign and seal can be controlled with the registry key
1534 "HKLM\System\CurrentControlSet\Services\NTDS\Parameters\LDAPServerIntegrity"
1535 on the Windows server side.
1536 Depending on the used KRB5 library (MIT and older Heimdal versions)
1538 it is possible that the message "integrity only" is not supported.
1539 In this case, sign is just an alias for seal.
1540 The default value is sign. That implies synchronizing the time with
1542 the KDC in the case of using Kerberos.
1543 Default: client ldap sasl wrapping = sign
1545 client max protocol (G)
1547 The value of the parameter (a string) is the highest protocol level
1549 that will be supported by the client.
1550 Possible values are :
1552 · CORE: Earliest version. No concept of user names.
1554 · COREPLUS: Slight improvements on CORE for efficiency.
1556 · LANMAN1: First modern version of the protocol. Long
1558 filename support.
1559 · LANMAN2: Updates to Lanman1 protocol.
1561 · NT1: Current up to date version of the protocol. Used by
1563 Windows NT. Known as CIFS.
1564 · SMB2: Re-implementation of the SMB protocol. Used by
1566 Windows Vista and later versions of Windows. SMB2 has
1567 sub protocols available.
1568 · SMB2_02: The earliest SMB2 version.
1570 · SMB2_10: Windows 7 SMB2 version.
1572 · SMB2_22: Early Windows 8 SMB2 version.
1574 · SMB2_24: Windows 8 beta SMB2 version.
1576 By default SMB2 selects the SMB2_10 variant.
1578 · SMB3: The same as SMB2. Used by Windows 8. SMB3 has sub
1580 protocols available.
1581 · SMB3_00: Windows 8 SMB3 version. (mostly the
1583 same as SMB2_24)
1584 · SMB3_02: Windows 8.1 SMB3 version.
1586 · SMB3_10: early Windows 10 technical preview
1588 SMB3 version.
1589 · SMB3_11: Windows 10 technical preview SMB3
1591 version (maybe final).
1592 By default SMB3 selects the SMB3_11 variant.
1594 Normally this option should not be set as the automatic negotiation
1596 phase in the SMB protocol takes care of choosing the appropriate
1597 protocol.
1598 The value default refers to SMB3_11.
1600 IPC$ connections for DCERPC e.g. in winbindd, are handled by the
1602 client ipc max protocol option.
1603 Default: client max protocol = default
1605 Example: client max protocol = LANMAN1
1607 client min protocol (G)
1609 This setting controls the minimum protocol version that the client
1611 will attempt to use.
1612 Normally this option should not be set as the automatic negotiation
1614 phase in the SMB protocol takes care of choosing the appropriate
1615 protocol.
1616 See Related command: client max protocol for a full list of
1618 available protocols.
1619 IPC$ connections for DCERPC e.g. in winbindd, are handled by the
1621 client ipc min protocol option.
1622 Default: client min protocol = CORE
1624 Example: client min protocol = NT1
1626 client NTLMv2 auth (G)
1628 This parameter determines whether or not smbclient(8) will attempt
1630 to authenticate itself to servers using the NTLMv2 encrypted
1631 password response.
1632 If enabled, only an NTLMv2 and LMv2 response (both much more secure
1634 than earlier versions) will be sent. Older servers (including NT4 <
1635 SP4, Win9x and Samba 2.2) are not compatible with NTLMv2 when not
1636 in an NTLMv2 supporting domain
1637 Similarly, if enabled, NTLMv1, client lanman auth and client
1639 plaintext auth authentication will be disabled. This also disables
1640 share-level authentication.
1641 If disabled, an NTLM response (and possibly a LANMAN response) will
1643 be sent by the client, depending on the value of client lanman
1644 auth.
1645 Note that Windows Vista and later versions already use NTLMv2 by
1647 default, and some sites (particularly those following 'best
1648 practice' security polices) only allow NTLMv2 responses, and not
1649 the weaker LM or NTLM.
1650 When client use spnego is also set to yes extended security
1652 (SPNEGO) is required in order to use NTLMv2 only within NTLMSSP.
1653 This behavior was introduced with the patches for CVE-2016-2111.
1654 Default: client NTLMv2 auth = yes
1656 client plaintext auth (G)
1658 Specifies whether a client should send a plaintext password if the
1660 server does not support encrypted passwords.
1661 Default: client plaintext auth = no
1663 client schannel (G)
1665 This option is deprecated with Samba 4.8 and will be removed in
1667 future. At the same time the default changed to yes, which will be
1668 the hardcoded behavior in future.
1669 This controls whether the client offers or even demands the use of
1671 the netlogon schannel. client schannel = no does not offer the
1672 schannel, client schannel = auto offers the schannel but does not
1673 enforce it, and client schannel = yes denies access if the server
1674 is not able to speak netlogon schannel.
1675 Note that for active directory domains this is hardcoded to client
1677 schannel = yes.
1678 This option yields precedence to the require strong key option.
1680 Default: client schannel = yes
1682 Example: client schannel = auto
1684 client signing (G)
1686 This controls whether the client is allowed or required to use SMB
1688 signing. Possible values are auto, mandatory and disabled.
1689 When set to auto or default, SMB signing is offered, but not
1691 enforced.
1692 When set to mandatory, SMB signing is required and if set to
1694 disabled, SMB signing is not offered either.
1695 IPC$ connections for DCERPC e.g. in winbindd, are handled by the
1697 client ipc signing option.
1698 Default: client signing = default
1700 client use spnego principal (G)
1702 This parameter determines whether or not smbclient(8) and other
1704 samba components acting as a client will attempt to use the
1705 server-supplied principal sometimes given in the SPNEGO exchange.
1706 If enabled, Samba can attempt to use Kerberos to contact servers
1708 known only by IP address. Kerberos relies on names, so ordinarily
1709 cannot function in this situation.
1710 This is a VERY BAD IDEA for security reasons, and so this parameter
1712 SHOULD NOT BE USED. It will be removed in a future version of
1713 Samba.
1714 If disabled, Samba will use the name used to look up the server
1716 when asking the KDC for a ticket. This avoids situations where a
1717 server may impersonate another, soliciting authentication as one
1718 principal while being known on the network as another.
1719 Note that Windows XP SP2 and later versions already follow this
1721 behaviour, and Windows Vista and later servers no longer supply
1722 this 'rfc4178 hint' principal on the server side.
1723 This parameter is deprecated in Samba 4.2.1 and will be removed
1725 (along with the functionality) in a later release of Samba.
1726 Default: client use spnego principal = no
1728 client use spnego (G)
1730 This variable controls whether Samba clients will try to use Simple
1732 and Protected NEGOciation (as specified by rfc2478) with supporting
1733 servers (including WindowsXP, Windows2000 and Samba 3.0) to agree
1734 upon an authentication mechanism. This enables Kerberos
1735 authentication in particular.
1736 When client NTLMv2 auth is also set to yes extended security
1738 (SPNEGO) is required in order to use NTLMv2 only within NTLMSSP.
1739 This behavior was introduced with the patches for CVE-2016-2111.
1740 Default: client use spnego = yes
1742 cluster addresses (G)
1744 With this parameter you can add additional addresses nmbd will
1746 register with a WINS server. These addresses are not necessarily
1747 present on all nodes simultaneously, but they will be registered
1748 with the WINS server so that clients can contact any of the nodes.
1749 Default: cluster addresses =
1751 Example: cluster addresses = 10.0.0.1 10.0.0.2 10.0.0.3
1753 clustering (G)
1755 This parameter specifies whether Samba should contact ctdb for
1757 accessing its tdb files and use ctdb as a backend for its messaging
1758 backend.
1759 Set this parameter to yes only if you have a cluster setup with
1761 ctdb running.
1762 Default: clustering = no
1764 comment (S)
1766 This is a text field that is seen next to a share when a client
1768 does a queries the server, either via the network neighborhood or
1769 via net view to list what shares are available.
1770 If you want to set the string that is displayed next to the machine
1772 name then see the server string parameter.
1773 Default: comment = # No comment
1775 Example: comment = Fred's Files
1777 config backend (G)
1779 This controls the backend for storing the configuration. Possible
1781 values are file (the default) and registry. When config backend =
1782 registry is encountered while loading smb.conf, the configuration
1783 read so far is dropped and the global options are read from
1784 registry instead. So this triggers a registry only configuration.
1785 Share definitions are not read immediately but instead registry
1786 shares is set to yes.
1787 Note: This option can not be set inside the registry configuration
1789 itself.
1790 Default: config backend = file
1792 Example: config backend = registry
1794 config file (G)
1796 This allows you to override the config file to use, instead of the
1798 default (usually smb.conf). There is a chicken and egg problem here
1799 as this option is set in the config file!
1800 For this reason, if the name of the config file has changed when
1802 the parameters are loaded then it will reload them from the new
1803 config file.
1804 This option takes the usual substitutions, which can be very
1806 useful.
1807 If the config file doesn't exist then it won't be loaded (allowing
1809 you to special case the config files of just a few clients).
1810 No default
1812 Example: config file = /usr/local/samba/lib/smb.conf.%m
1814 copy (S)
1816 This parameter allows you to "clone" service entries. The specified
1818 service is simply duplicated under the current service's name. Any
1819 parameters specified in the current section will override those in
1820 the section being copied.
1821 This feature lets you set up a 'template' service and create
1823 similar services easily. Note that the service being copied must
1824 occur earlier in the configuration file than the service doing the
1825 copying.
1826 Default: copy =
1828 Example: copy = otherservice
1830 create krb5 conf (G)
1832 Setting this parameter to no prevents winbind from creating custom
1834 krb5.conf files. Winbind normally does this because the krb5
1835 libraries are not AD-site-aware and thus would pick any domain
1836 controller out of potentially very many. Winbind is site-aware and
1837 makes the krb5 libraries use a local DC by creating its own
1838 krb5.conf files.
1839 Preventing winbind from doing this might become necessary if you
1841 have to add special options into your system-krb5.conf that winbind
1842 does not see.
1843 Default: create krb5 conf = yes
1845 create mode
1847 This parameter is a synonym for create mask.
1849 create mask (S)
1851 When a file is created, the necessary permissions are calculated
1853 according to the mapping from DOS modes to UNIX permissions, and
1854 the resulting UNIX mode is then bit-wise 'AND'ed with this
1855 parameter. This parameter may be thought of as a bit-wise MASK for
1856 the UNIX modes of a file. Any bit not set here will be removed from
1857 the modes set on a file when it is created.
1858 The default value of this parameter removes the group and other
1860 write and execute bits from the UNIX modes.
1861 Following this Samba will bit-wise 'OR' the UNIX mode created from
1863 this parameter with the value of the force create mode parameter
1864 which is set to 000 by default.
1865 This parameter does not affect directory masks. See the parameter
1867 directory mask for details.
1868 Default: create mask = 0744
1870 Example: create mask = 0775
1872 csc policy (S)
1874 This stands for client-side caching policy, and specifies how
1876 clients capable of offline caching will cache the files in the
1877 share. The valid values are: manual, documents, programs, disable.
1878 These values correspond to those used on Windows servers.
1880 For example, shares containing roaming profiles can have offline
1882 caching disabled using csc policy = disable.
1883 Default: csc policy = manual
1885 Example: csc policy = programs
1887 ctdbd socket (G)
1889 If you set clustering=yes, you need to tell Samba where ctdbd
1891 listens on its unix domain socket. The default path as of ctdb 1.0
1892 is /tmp/ctdb.socket which you have to explicitly set for Samba in
1893 smb.conf.
1894 Default: ctdbd socket =
1896 Example: ctdbd socket = /tmp/ctdb.socket
1898 ctdb locktime warn threshold (G)
1900 In a cluster environment using Samba and ctdb it is critical that
1902 locks on central ctdb-hosted databases like locking.tdb are not
1903 held for long. With the current Samba architecture it happens that
1904 Samba takes a lock and while holding that lock makes file system
1905 calls into the shared cluster file system. This option makes Samba
1906 warn if it detects that it has held locks for the specified number
1907 of milliseconds. If this happens, smbd will emit a debug level 0
1908 message into its logs and potentially into syslog. The most likely
1909 reason for such a log message is that an operation of the cluster
1910 file system Samba exports is taking longer than expected. The
1911 messages are meant as a debugging aid for potential cluster
1912 problems.
1913 The default value of 0 disables this logging.
1915 Default: ctdb locktime warn threshold = 0
1917 ctdb timeout (G)
1919 This parameter specifies a timeout in milliseconds for the
1921 connection between Samba and ctdb. It is only valid if you have
1922 compiled Samba with clustering and if you have set clustering=yes.
1923 When something in the cluster blocks, it can happen that we wait
1925 indefinitely long for ctdb, just adding to the blocking condition.
1926 In a well-running cluster this should never happen, but there are
1927 too many components in a cluster that might have hickups. Choosing
1928 the right balance for this value is very tricky, because on a busy
1929 cluster long service times to transfer something across the cluster
1930 might be valid. Setting it too short will degrade the service your
1931 cluster presents, setting it too long might make the cluster itself
1932 not recover from something severely broken for too long.
1933 Be aware that if you set this parameter, this needs to be in the
1935 file smb.conf, it is not really helpful to put this into a registry
1936 configuration (typical on a cluster), because to access the
1937 registry contact to ctdb is required.
1938 Setting ctdb timeout to n makes any process waiting longer than n
1940 milliseconds for a reply by the cluster panic. Setting it to 0 (the
1941 default) makes Samba block forever, which is the highly recommended
1942 default.
1943 Default: ctdb timeout = 0
1945 cups connection timeout (G)
1947 This parameter is only applicable if printing is set to cups.
1949 If set, this option specifies the number of seconds that smbd will
1951 wait whilst trying to contact to the CUPS server. The connection
1952 will fail if it takes longer than this number of seconds.
1953 Default: cups connection timeout = 30
1955 Example: cups connection timeout = 60
1957 cups encrypt (G)
1959 This parameter is only applicable if printing is set to cups and if
1961 you use CUPS newer than 1.0.x.It is used to define whether or not
1962 Samba should use encryption when talking to the CUPS server.
1963 Possible values are auto, yes and no
1964 When set to auto we will try to do a TLS handshake on each CUPS
1966 connection setup. If that fails, we will fall back to unencrypted
1967 operation.
1968 Default: cups encrypt = no
1970 cups options (S)
1972 This parameter is only applicable if printing is set to cups. Its
1974 value is a free form string of options passed directly to the cups
1975 library.
1976 You can pass any generic print option known to CUPS (as listed in
1978 the CUPS "Software Users' Manual"). You can also pass any printer
1979 specific option (as listed in "lpoptions -d printername -l") valid
1980 for the target queue. Multiple parameters should be space-delimited
1981 name/value pairs according to the PAPI text option ABNF
1982 specification. Collection values ("name={a=... b=... c=...}") are
1983 stored with the curley brackets intact.
1984 You should set this parameter to raw if your CUPS server error_log
1986 file contains messages such as "Unsupported format
1987 'application/octet-stream'" when printing from a Windows client
1988 through Samba. It is no longer necessary to enable system wide raw
1989 printing in /etc/cups/mime.{convs,types}.
1990 Default: cups options = ""
1992 Example: cups options = "raw media=a4"
1994 cups server (G)
1996 This parameter is only applicable if printing is set to cups.
1998 If set, this option overrides the ServerName option in the CUPS
2000 client.conf. This is necessary if you have virtual samba servers
2001 that connect to different CUPS daemons.
2002 Optionally, a port can be specified by separating the server name
2004 and port number with a colon. If no port was specified, the default
2005 port for IPP (631) will be used.
2006 Default: cups server = ""
2008 Example: cups server = mycupsserver
2010 Example: cups server = mycupsserver:1631
2012 dcerpc endpoint servers (G)
2014 Specifies which DCE/RPC endpoint servers should be run.
2016 Default: dcerpc endpoint servers = epmapper, wkssvc, rpcecho, samr,
2018 netlogon, lsarpc, drsuapi, dssetup, unixinfo, browser, eventlog6,
2019 backupkey, dnsserver
2020 Example: dcerpc endpoint servers = rpcecho
2022 deadtime (G)
2024 The value of the parameter (a decimal integer) represents the
2026 number of minutes of inactivity before a connection is considered
2027 dead, and it is disconnected. The deadtime only takes effect if the
2028 number of open files is zero.
2029 This is useful to stop a server's resources being exhausted by a
2031 large number of inactive connections.
2032 Most clients have an auto-reconnect feature when a connection is
2034 broken so in most cases this parameter should be transparent to
2035 users.
2036 Using this parameter with a timeout of a few minutes is recommended
2038 for most systems.
2039 A deadtime of zero indicates that no auto-disconnection should be
2041 performed.
2042 Default: deadtime = 0
2044 Example: deadtime = 15
2046 debug class (G)
2048 With this boolean parameter enabled, the debug class (DBGC_CLASS)
2050 will be displayed in the debug header.
2051 For more information about currently available debug classes, see
2053 section about log level.
2054 Default: debug class = no
2056 debug hires timestamp (G)
2058 Sometimes the timestamps in the log messages are needed with a
2060 resolution of higher that seconds, this boolean parameter adds
2061 microsecond resolution to the timestamp message header when turned
2062 on.
2063 Note that the parameter debug timestamp must be on for this to have
2065 an effect.
2066 Default: debug hires timestamp = yes
2068 debug pid (G)
2070 When using only one log file for more then one forked
2072 smbd(8)-process there may be hard to follow which process outputs
2073 which message. This boolean parameter is adds the process-id to the
2074 timestamp message headers in the logfile when turned on.
2075 Note that the parameter debug timestamp must be on for this to have
2077 an effect.
2078 Default: debug pid = no
2080 debug prefix timestamp (G)
2082 With this option enabled, the timestamp message header is prefixed
2084 to the debug message without the filename and function information
2085 that is included with the debug timestamp parameter. This gives
2086 timestamps to the messages without adding an additional line.
2087 Note that this parameter overrides the debug timestamp parameter.
2089 Default: debug prefix timestamp = no
2091 debug uid (G)
2093 Samba is sometimes run as root and sometime run as the connected
2095 user, this boolean parameter inserts the current euid, egid, uid
2096 and gid to the timestamp message headers in the log file if turned
2097 on.
2098 Note that the parameter debug timestamp must be on for this to have
2100 an effect.
2101 Default: debug uid = no
2103 dedicated keytab file (G)
2105 Specifies the absolute path to the kerberos keytab file when
2107 kerberos method is set to "dedicated keytab".
2108 Default: dedicated keytab file =
2110 Example: dedicated keytab file = /usr/local/etc/krb5.keytab
2112 default case (S)
2114 See the section on name mangling. Also note the short preserve case
2116 parameter.
2117 Default: default case = lower
2119 default devmode (S)
2121 This parameter is only applicable to printable services. When smbd
2123 is serving Printer Drivers to Windows NT/2k/XP clients, each
2124 printer on the Samba server has a Device Mode which defines things
2125 such as paper size and orientation and duplex settings. The device
2126 mode can only correctly be generated by the printer driver itself
2127 (which can only be executed on a Win32 platform). Because smbd is
2128 unable to execute the driver code to generate the device mode, the
2129 default behavior is to set this field to NULL.
2130 Most problems with serving printer drivers to Windows NT/2k/XP
2132 clients can be traced to a problem with the generated device mode.
2133 Certain drivers will do things such as crashing the client's
2134 Explorer.exe with a NULL devmode. However, other printer drivers
2135 can cause the client's spooler service (spoolsv.exe) to die if the
2136 devmode was not created by the driver itself (i.e. smbd generates a
2137 default devmode).
2138 This parameter should be used with care and tested with the printer
2140 driver in question. It is better to leave the device mode to NULL
2141 and let the Windows client set the correct values. Because drivers
2142 do not do this all the time, setting default devmode = yes will
2143 instruct smbd to generate a default one.
2144 For more information on Windows NT/2k printing and Device Modes,
2146 see the MSDN documentation.
2147 Default: default devmode = yes
2149 default
2151 This parameter is a synonym for default service.
2153 default service (G)
2155 This parameter specifies the name of a service which will be
2157 connected to if the service actually requested cannot be found.
2158 Note that the square brackets are NOT given in the parameter value
2159 (see example below).
2160 There is no default value for this parameter. If this parameter is
2162 not given, attempting to connect to a nonexistent service results
2163 in an error.
2164 Typically the default service would be a guest ok, read-only
2166 service.
2167 Also note that the apparent service name will be changed to equal
2169 that of the requested service, this is very useful as it allows you
2170 to use macros like %S to make a wildcard service.
2171 Note also that any "_" characters in the name of the service used
2173 in the default service will get mapped to a "/". This allows for
2174 interesting things.
2175 Default: default service =
2177 Example: default service = pub
2179 defer sharing violations (G)
2181 Windows allows specifying how a file will be shared with other
2183 processes when it is opened. Sharing violations occur when a file
2184 is opened by a different process using options that violate the
2185 share settings specified by other processes. This parameter causes
2186 smbd to act as a Windows server does, and defer returning a
2187 "sharing violation" error message for up to one second, allowing
2188 the client to close the file causing the violation in the meantime.
2189 UNIX by default does not have this behaviour.
2191 There should be no reason to turn off this parameter, as it is
2193 designed to enable Samba to more correctly emulate Windows.
2194 Default: defer sharing violations = yes
2196 delete group script (G)
2198 This is the full pathname to a script that will be run AS ROOT by
2200 smbd(8) when a group is requested to be deleted. It will expand any
2201 %g to the group name passed. This script is only useful for
2202 installations using the Windows NT domain administration tools.
2203 Default: delete group script =
2205 deleteprinter command (G)
2207 With the introduction of MS-RPC based printer support for Windows
2209 NT/2000 clients in Samba 2.2, it is now possible to delete a
2210 printer at run time by issuing the DeletePrinter() RPC call.
2211 For a Samba host this means that the printer must be physically
2213 deleted from the underlying printing system. The deleteprinter
2214 command defines a script to be run which will perform the necessary
2215 operations for removing the printer from the print system and from
2216 smb.conf.
2217 The deleteprinter command is automatically called with only one
2219 parameter: printer name.
2220 Once the deleteprinter command has been executed, smbd will reparse
2222 the smb.conf to check that the associated printer no longer exists.
2223 If the sharename is still valid, then smbd will return an
2224 ACCESS_DENIED error to the client.
2225 Default: deleteprinter command =
2227 Example: deleteprinter command = /usr/bin/removeprinter
2229 delete readonly (S)
2231 This parameter allows readonly files to be deleted. This is not
2233 normal DOS semantics, but is allowed by UNIX.
2234 This option may be useful for running applications such as rcs,
2236 where UNIX file ownership prevents changing file permissions, and
2237 DOS semantics prevent deletion of a read only file.
2238 Default: delete readonly = no
2240 delete share command (G)
2242 Samba 2.2.0 introduced the ability to dynamically add and delete
2244 shares via the Windows NT 4.0 Server Manager. The delete share
2245 command is used to define an external program or script which will
2246 remove an existing service definition from smb.conf.
2247 In order to successfully execute the delete share command, smbd
2249 requires that the administrator connects using a root account (i.e.
2250 uid == 0) or has the SeDiskOperatorPrivilege. Scripts defined in
2251 the delete share command parameter are executed as root.
2252 When executed, smbd will automatically invoke the delete share
2254 command with two parameters.
2255 · configFile - the location of the global smb.conf file.
2257 · shareName - the name of the existing service.
2259 This parameter is only used to remove file shares. To delete
2261 printer shares, see the deleteprinter command.
2262 Default: delete share command =
2264 Example: delete share command = /usr/local/bin/delshare
2266 delete user from group script (G)
2268 Full path to the script that will be called when a user is removed
2270 from a group using the Windows NT domain administration tools. It
2271 will be run by smbd(8)AS ROOT. Any %g will be replaced with the
2272 group name and any %u will be replaced with the user name.
2273 Default: delete user from group script =
2275 Example: delete user from group script = /usr/sbin/deluser %u %g
2277 delete user script (G)
2279 This is the full pathname to a script that will be run by smbd(8)
2281 when managing users with remote RPC (NT) tools.
2282 This script is called when a remote client removes a user from the
2284 server, normally using 'User Manager for Domains' or rpcclient.
2285 This script should delete the given UNIX username.
2287 Default: delete user script =
2289 Example: delete user script = /usr/local/samba/bin/del_user %u
2291 delete veto files (S)
2293 This option is used when Samba is attempting to delete a directory
2295 that contains one or more vetoed directories (see the veto files
2296 option). If this option is set to no (the default) then if a vetoed
2297 directory contains any non-vetoed files or directories then the
2298 directory delete will fail. This is usually what you want.
2299 If this option is set to yes, then Samba will attempt to
2301 recursively delete any files and directories within the vetoed
2302 directory. This can be useful for integration with file serving
2303 systems such as NetAtalk which create meta-files within directories
2304 you might normally veto DOS/Windows users from seeing (e.g.
2305 .AppleDouble)
2306 Setting delete veto files = yes allows these directories to be
2308 transparently deleted when the parent directory is deleted (so long
2309 as the user has permissions to do so).
2310 Default: delete veto files = no
2312 dfree cache time (S)
2314 The dfree cache time should only be used on systems where a problem
2316 occurs with the internal disk space calculations. This has been
2317 known to happen with Ultrix, but may occur with other operating
2318 systems. The symptom that was seen was an error of "Abort Retry
2319 Ignore" at the end of each directory listing.
2320 This is a new parameter introduced in Samba version 3.0.21. It
2322 specifies in seconds the time that smbd will cache the output of a
2323 disk free query. If set to zero (the default) no caching is done.
2324 This allows a heavily loaded server to prevent rapid spawning of
2325 dfree command scripts increasing the load.
2326 By default this parameter is zero, meaning no caching will be done.
2328 No default
2330 Example: dfree cache time = 60
2332 dfree command (S)
2334 The dfree command setting should only be used on systems where a
2336 problem occurs with the internal disk space calculations. This has
2337 been known to happen with Ultrix, but may occur with other
2338 operating systems. The symptom that was seen was an error of "Abort
2339 Retry Ignore" at the end of each directory listing.
2340 This setting allows the replacement of the internal routines to
2342 calculate the total disk space and amount available with an
2343 external routine. The example below gives a possible script that
2344 might fulfill this function.
2345 In Samba version 3.0.21 this parameter has been changed to be a
2347 per-share parameter, and in addition the parameter dfree cache time
2348 was added to allow the output of this script to be cached for
2349 systems under heavy load.
2350 The external program will be passed a single parameter indicating a
2352 directory in the filesystem being queried. This will typically
2353 consist of the string ./. The script should return two integers in
2354 ASCII. The first should be the total disk space in blocks, and the
2355 second should be the number of available blocks. An optional third
2356 return value can give the block size in bytes. The default
2357 blocksize is 1024 bytes.
2358 Note: Your script should NOT be setuid or setgid and should be
2360 owned by (and writeable only by) root!
2361 Where the script dfree (which must be made executable) could be:
2363 #!/bin/sh
2366 df $1 | tail -1 | awk '{print $(NF-4),$(NF-2)}'
2367 or perhaps (on Sys V based systems):
2369 #!/bin/sh
2372 /usr/bin/df -k $1 | tail -1 | awk '{print $3" "$5}'
2373 Note that you may have to replace the command names with full path
2375 names on some systems.
2376 By default internal routines for determining the disk capacity and
2378 remaining space will be used.
2379 No default
2381 Example: dfree command = /usr/local/samba/bin/dfree
2383 dgram port (G)
2385 Specifies which ports the server should listen on for NetBIOS
2387 datagram traffic.
2388 Default: dgram port = 138
2390 directory mode
2392 This parameter is a synonym for directory mask.
2394 directory mask (S)
2396 This parameter is the octal modes which are used when converting
2398 DOS modes to UNIX modes when creating UNIX directories.
2399 When a directory is created, the necessary permissions are
2401 calculated according to the mapping from DOS modes to UNIX
2402 permissions, and the resulting UNIX mode is then bit-wise 'AND'ed
2403 with this parameter. This parameter may be thought of as a bit-wise
2404 MASK for the UNIX modes of a directory. Any bit not set here will
2405 be removed from the modes set on a directory when it is created.
2406 The default value of this parameter removes the 'group' and 'other'
2408 write bits from the UNIX mode, allowing only the user who owns the
2409 directory to modify it.
2410 Following this Samba will bit-wise 'OR' the UNIX mode created from
2412 this parameter with the value of the force directory mode
2413 parameter. This parameter is set to 000 by default (i.e. no extra
2414 mode bits are added).
2415 Default: directory mask = 0755
2417 Example: directory mask = 0775
2419 directory name cache size (S)
2421 This parameter specifies the size of the directory name cache for
2423 SMB1 connections. It is not used for SMB2. It will be needed to
2424 turn this off for *BSD systems.
2425 Default: directory name cache size = 100
2427 directory security mask (S)
2429 This parameter has been removed for Samba 4.0.0.
2431 No default
2433 disable netbios (G)
2435 Enabling this parameter will disable netbios support in Samba.
2437 Netbios is the only available form of browsing in all windows
2438 versions except for 2000 and XP.
2439 Note
2441 Clients that only support netbios won't be able to see your
2442 samba server when netbios support is disabled.
2443 Default: disable netbios = no
2444 disable spoolss (G)
2446 Enabling this parameter will disable Samba's support for the
2448 SPOOLSS set of MS-RPC's and will yield identical behavior as Samba
2449 2.0.x. Windows NT/2000 clients will downgrade to using Lanman style
2450 printing commands. Windows 9x/ME will be unaffected by the
2451 parameter. However, this will also disable the ability to upload
2452 printer drivers to a Samba server via the Windows NT Add Printer
2453 Wizard or by using the NT printer properties dialog window. It will
2454 also disable the capability of Windows NT/2000 clients to download
2455 print drivers from the Samba host upon demand. Be very careful
2456 about enabling this parameter.
2457 Default: disable spoolss = no
2459 dmapi support (S)
2461 This parameter specifies whether Samba should use DMAPI to
2463 determine whether a file is offline or not. This would typically be
2464 used in conjunction with a hierarchical storage system that
2465 automatically migrates files to tape.
2466 Note that Samba infers the status of a file by examining the events
2468 that a DMAPI application has registered interest in. This heuristic
2469 is satisfactory for a number of hierarchical storage systems, but
2470 there may be system for which it will fail. In this case, Samba may
2471 erroneously report files to be offline.
2472 This parameter is only available if a supported DMAPI
2474 implementation was found at compilation time. It will only be used
2475 if DMAPI is found to enabled on the system at run time.
2476 Default: dmapi support = no
2478 dns forwarder (G)
2480 This option specifies the list of DNS servers that DNS requests
2482 will be forwarded to if they can not be handled by Samba itself.
2483 The DNS forwarder is only used if the internal DNS server in Samba
2485 is used.
2486 Default: dns forwarder =
2488 Example: dns forwarder = 192.168.0.1
2490 dns proxy (G)
2492 Specifies that nmbd(8) when acting as a WINS server and finding
2494 that a NetBIOS name has not been registered, should treat the
2495 NetBIOS name word-for-word as a DNS name and do a lookup with the
2496 DNS server for that name on behalf of the name-querying client.
2497 Note that the maximum length for a NetBIOS name is 15 characters,
2499 so the DNS name (or DNS alias) can likewise only be 15 characters,
2500 maximum.
2501 nmbd spawns a second copy of itself to do the DNS name lookup
2503 requests, as doing a name lookup is a blocking action.
2504 Default: dns proxy = yes
2506 dns update command (G)
2508 This option sets the command that is called when there are DNS
2510 updates. It should update the local machines DNS names using
2511 TSIG-GSS.
2512 Default: dns update command =
2514 /builddir/build/BUILD/samba-4.8.3/source4/scripting/bin/samba_dnsupdate
2515 Example: dns update command = /usr/local/sbin/dnsupdate
2517 domain logons (G)
2519 If set to yes, the Samba server will provide the netlogon service
2521 for Windows 9X network logons for the workgroup it is in. This will
2522 also cause the Samba server to act as a domain controller for NT4
2523 style domain services. For more details on setting up this feature
2524 see the Domain Control chapter of the Samba HOWTO Collection.
2525 Default: domain logons = no
2527 domain master (G)
2529 Tell smbd(8) to enable WAN-wide browse list collation. Setting this
2531 option causes nmbd to claim a special domain specific NetBIOS name
2532 that identifies it as a domain master browser for its given
2533 workgroup. Local master browsers in the same workgroup on
2534 broadcast-isolated subnets will give this nmbd their local browse
2535 lists, and then ask smbd(8) for a complete copy of the browse list
2536 for the whole wide area network. Browser clients will then contact
2537 their local master browser, and will receive the domain-wide browse
2538 list, instead of just the list for their broadcast-isolated subnet.
2539 Note that Windows NT Primary Domain Controllers expect to be able
2541 to claim this workgroup specific special NetBIOS name that
2542 identifies them as domain master browsers for that workgroup by
2543 default (i.e. there is no way to prevent a Windows NT PDC from
2544 attempting to do this). This means that if this parameter is set
2545 and nmbd claims the special name for a workgroup before a Windows
2546 NT PDC is able to do so then cross subnet browsing will behave
2547 strangely and may fail.
2548 If domain logons = yes, then the default behavior is to enable the
2550 domain master parameter. If domain logons is not enabled (the
2551 default setting), then neither will domain master be enabled by
2552 default.
2553 When domain logons = Yes the default setting for this parameter is
2555 Yes, with the result that Samba will be a PDC. If domain master =
2556 No, Samba will function as a BDC. In general, this parameter should
2557 be set to 'No' only on a BDC.
2558 Default: domain master = auto
2560 dont descend (S)
2562 There are certain directories on some systems (e.g., the /proc tree
2564 under Linux) that are either not of interest to clients or are
2565 infinitely deep (recursive). This parameter allows you to specify a
2566 comma-delimited list of directories that the server should always
2567 show as empty.
2568 Note that Samba can be very fussy about the exact format of the
2570 "dont descend" entries. For example you may need ./proc instead of
2571 just /proc. Experimentation is the best policy :-)
2572 Default: dont descend =
2574 Example: dont descend = /proc,/dev
2576 dos charset (G)
2578 DOS SMB clients assume the server has the same charset as they do.
2580 This option specifies which charset Samba should talk to DOS
2581 clients.
2582 The default depends on which charsets you have installed. Samba
2584 tries to use charset 850 but falls back to ASCII in case it is not
2585 available. Run testparm(1) to check the default on your system.
2586 No default
2588 dos filemode (S)
2590 The default behavior in Samba is to provide UNIX-like behavior
2592 where only the owner of a file/directory is able to change the
2593 permissions on it. However, this behavior is often confusing to
2594 DOS/Windows users. Enabling this parameter allows a user who has
2595 write access to the file (by whatever means, including an ACL
2596 permission) to modify the permissions (including ACL) on it. Note
2597 that a user belonging to the group owning the file will not be
2598 allowed to change permissions if the group is only granted read
2599 access. Ownership of the file/directory may also be changed. Note
2600 that using the VFS modules acl_xattr or acl_tdb which store native
2601 Windows as meta-data will automatically turn this option on for any
2602 share for which they are loaded, as they require this option to
2603 emulate Windows ACLs correctly.
2604 Default: dos filemode = no
2606 dos filetime resolution (S)
2608 Under the DOS and Windows FAT filesystem, the finest granularity on
2610 time resolution is two seconds. Setting this parameter for a share
2611 causes Samba to round the reported time down to the nearest two
2612 second boundary when a query call that requires one second
2613 resolution is made to smbd(8).
2614 This option is mainly used as a compatibility option for Visual C++
2616 when used against Samba shares. If oplocks are enabled on a share,
2617 Visual C++ uses two different time reading calls to check if a file
2618 has changed since it was last read. One of these calls uses a
2619 one-second granularity, the other uses a two second granularity. As
2620 the two second call rounds any odd second down, then if the file
2621 has a timestamp of an odd number of seconds then the two timestamps
2622 will not match and Visual C++ will keep reporting the file has
2623 changed. Setting this option causes the two timestamps to match,
2624 and Visual C++ is happy.
2625 Default: dos filetime resolution = no
2627 dos filetimes (S)
2629 Under DOS and Windows, if a user can write to a file they can
2631 change the timestamp on it. Under POSIX semantics, only the owner
2632 of the file or root may change the timestamp. By default, Samba
2633 emulates the DOS semantics and allows one to change the timestamp
2634 on a file if the user smbd is acting on behalf has write
2635 permissions. Due to changes in Microsoft Office 2000 and beyond,
2636 the default for this parameter has been changed from "no" to "yes"
2637 in Samba 3.0.14 and above. Microsoft Excel will display dialog box
2638 warnings about the file being changed by another user if this
2639 parameter is not set to "yes" and files are being shared between
2640 users.
2641 Default: dos filetimes = yes
2643 durable handles (S)
2645 This boolean parameter controls whether Samba can grant SMB2
2647 durable file handles on a share.
2648 Note that durable handles are only enabled if kernel oplocks = no,
2650 kernel share modes = no, and posix locking = no, i.e. if the share
2651 is configured for CIFS/SMB2 only access, not supporting
2652 interoperability features with local UNIX processes or NFS
2653 operations.
2654 Also note that, for the time being, durability is not granted for a
2656 handle that has the delete on close flag set.
2657 Default: durable handles = yes
2659 ea support (S)
2661 This boolean parameter controls whether smbd(8) will allow clients
2663 to attempt to access extended attributes on a share. In order to
2664 enable this parameter on a setup with default VFS modules:
2665 · Samba must have been built with extended attributes
2667 support.
2668 · The underlying filesystem exposed by the share must
2670 support extended attributes (e.g. the getfattr(1) /
2671 setfattr(1) utilities must work).
2672 Note that the SMB protocol allows setting attributes whose value is
2674 64K bytes long, and that on NTFS, the maximum storage space for
2675 extended attributes per file is 64K. On most UNIX systems (Solaris
2676 and ZFS file system being the exception), the limits are much lower
2677 - typically 4K. Worse, the same 4K space is often used to store
2678 system metadata such as POSIX ACLs, or Samba's NT ACLs. Giving
2679 clients access to this tight space via extended attribute support
2680 could consume all of it by unsuspecting client applications, which
2681 would prevent changing system metadata due to lack of space.
2682 Default: ea support = no
2684 enable asu support (G)
2686 Hosts running the "Advanced Server for Unix (ASU)" product require
2688 some special accomodations such as creating a builtin [ADMIN$]
2689 share that only supports IPC connections. The has been the default
2690 behavior in smbd for many years. However, certain Microsoft
2691 applications such as the Print Migrator tool require that the
2692 remote server support an [ADMIN$] file share. Disabling this
2693 parameter allows for creating an [ADMIN$] file share in smb.conf.
2694 Default: enable asu support = no
2696 enable core files (G)
2698 This parameter specifies whether core dumps should be written on
2700 internal exits. Normally set to yes. You should never need to
2701 change this.
2702 Default: enable core files = yes
2704 Example: enable core files = no
2706 enable privileges (G)
2708 This deprecated parameter controls whether or not smbd will honor
2710 privileges assigned to specific SIDs via either net rpc rights or
2711 one of the Windows user and group manager tools. This parameter is
2712 enabled by default. It can be disabled to prevent members of the
2713 Domain Admins group from being able to assign privileges to users
2714 or groups which can then result in certain smbd operations running
2715 as root that would normally run under the context of the connected
2716 user.
2717 An example of how privileges can be used is to assign the right to
2719 join clients to a Samba controlled domain without providing root
2720 access to the server via smbd.
2721 Please read the extended description provided in the Samba HOWTO
2723 documentation.
2724 Default: enable privileges = yes
2726 enable spoolss (G)
2728 Inverted synonym for disable spoolss.
2730 Default: enable spoolss = yes
2732 encrypt passwords (G)
2734 This boolean controls whether encrypted passwords will be
2736 negotiated with the client. Note that Windows NT 4.0 SP3 and above
2737 and also Windows 98 will by default expect encrypted passwords
2738 unless a registry entry is changed. To use encrypted passwords in
2739 Samba see the chapter "User Database" in the Samba HOWTO
2740 Collection.
2741 MS Windows clients that expect Microsoft encrypted passwords and
2743 that do not have plain text password support enabled will be able
2744 to connect only to a Samba server that has encrypted password
2745 support enabled and for which the user accounts have a valid
2746 encrypted password. Refer to the smbpasswd command man page for
2747 information regarding the creation of encrypted passwords for user
2748 accounts.
2749 The use of plain text passwords is NOT advised as support for this
2751 feature is no longer maintained in Microsoft Windows products. If
2752 you want to use plain text passwords you must set this parameter to
2753 no.
2754 In order for encrypted passwords to work correctly smbd(8) must
2756 either have access to a local smbpasswd(5) file (see the
2757 smbpasswd(8) program for information on how to set up and maintain
2758 this file), or set the security = [domain|ads] parameter which
2759 causes smbd to authenticate against another server.
2760 Default: encrypt passwords = yes
2762 enhanced browsing (G)
2764 This option enables a couple of enhancements to cross-subnet browse
2766 propagation that have been added in Samba but which are not
2767 standard in Microsoft implementations.
2768 The first enhancement to browse propagation consists of a regular
2770 wildcard query to a Samba WINS server for all Domain Master
2771 Browsers, followed by a browse synchronization with each of the
2772 returned DMBs. The second enhancement consists of a regular
2773 randomised browse synchronization with all currently known DMBs.
2774 You may wish to disable this option if you have a problem with
2776 empty workgroups not disappearing from browse lists. Due to the
2777 restrictions of the browse protocols, these enhancements can cause
2778 a empty workgroup to stay around forever which can be annoying.
2779 In general you should leave this option enabled as it makes
2781 cross-subnet browse propagation much more reliable.
2782 Default: enhanced browsing = yes
2784 enumports command (G)
2786 The concept of a "port" is fairly foreign to UNIX hosts. Under
2788 Windows NT/2000 print servers, a port is associated with a port
2789 monitor and generally takes the form of a local port (i.e. LPT1:,
2790 COM1:, FILE:) or a remote port (i.e. LPD Port Monitor, etc...). By
2791 default, Samba has only one port defined--"Samba Printer Port".
2792 Under Windows NT/2000, all printers must have a valid port name. If
2793 you wish to have a list of ports displayed (smbd does not use a
2794 port name for anything) other than the default "Samba Printer
2795 Port", you can define enumports command to point to a program which
2796 should generate a list of ports, one per line, to standard output.
2797 This listing will then be used in response to the level 1 and 2
2798 EnumPorts() RPC.
2799 Default: enumports command =
2801 Example: enumports command = /usr/bin/listports
2803 eventlog list (G)
2805 This option defines a list of log names that Samba will report to
2807 the Microsoft EventViewer utility. The listed eventlogs will be
2808 associated with tdb file on disk in the $(statedir)/eventlog.
2809 The administrator must use an external process to parse the normal
2811 Unix logs such as /var/log/messages and write then entries to the
2812 eventlog tdb files. Refer to the eventlogadm(8) utility for how to
2813 write eventlog entries.
2814 Default: eventlog list =
2816 Example: eventlog list = Security Application Syslog Apache
2818 fake directory create times (S)
2820 NTFS and Windows VFAT file systems keep a create time for all files
2822 and directories. This is not the same as the ctime - status change
2823 time - that Unix keeps, so Samba by default reports the earliest of
2824 the various times Unix does keep. Setting this parameter for a
2825 share causes Samba to always report midnight 1-1-1980 as the create
2826 time for directories.
2827 This option is mainly used as a compatibility option for Visual C++
2829 when used against Samba shares. Visual C++ generated makefiles have
2830 the object directory as a dependency for each object file, and a
2831 make rule to create the directory. Also, when NMAKE compares
2832 timestamps it uses the creation time when examining a directory.
2833 Thus the object directory will be created if it does not exist, but
2834 once it does exist it will always have an earlier timestamp than
2835 the object files it contains.
2836 However, Unix time semantics mean that the create time reported by
2838 Samba will be updated whenever a file is created or deleted in the
2839 directory. NMAKE finds all object files in the object directory.
2840 The timestamp of the last one built is then compared to the
2841 timestamp of the object directory. If the directory's timestamp if
2842 newer, then all object files will be rebuilt. Enabling this option
2843 ensures directories always predate their contents and an NMAKE
2844 build will proceed as expected.
2845 Default: fake directory create times = no
2847 fake oplocks (S)
2849 Oplocks are the way that SMB clients get permission from a server
2851 to locally cache file operations. If a server grants an oplock
2852 (opportunistic lock) then the client is free to assume that it is
2853 the only one accessing the file and it will aggressively cache file
2854 data. With some oplock types the client may even cache file
2855 open/close operations. This can give enormous performance benefits.
2856 When you set fake oplocks = yes, smbd(8) will always grant oplock
2858 requests no matter how many clients are using the file.
2859 It is generally much better to use the real oplocks support rather
2861 than this parameter.
2862 If you enable this option on all read-only shares or shares that
2864 you know will only be accessed from one client at a time such as
2865 physically read-only media like CDROMs, you will see a big
2866 performance improvement on many operations. If you enable this
2867 option on shares where multiple clients may be accessing the files
2868 read-write at the same time you can get data corruption. Use this
2869 option carefully!
2870 Default: fake oplocks = no
2872 follow symlinks (S)
2874 This parameter allows the Samba administrator to stop smbd(8) from
2876 following symbolic links in a particular share. Setting this
2877 parameter to no prevents any file or directory that is a symbolic
2878 link from being followed (the user will get an error). This option
2879 is very useful to stop users from adding a symbolic link to
2880 /etc/passwd in their home directory for instance. However it will
2881 slow filename lookups down slightly.
2882 This option is enabled (i.e. smbd will follow symbolic links) by
2884 default.
2885 Default: follow symlinks = yes
2887 force create mode (S)
2889 This parameter specifies a set of UNIX mode bit permissions that
2891 will always be set on a file created by Samba. This is done by
2892 bitwise 'OR'ing these bits onto the mode bits of a file that is
2893 being created. The default for this parameter is (in octal) 000.
2894 The modes in this parameter are bitwise 'OR'ed onto the file mode
2895 after the mask set in the create mask parameter is applied.
2896 The example below would force all newly created files to have read
2898 and execute permissions set for 'group' and 'other' as well as the
2899 read/write/execute bits set for the 'user'.
2900 Default: force create mode = 0000
2902 Example: force create mode = 0755
2904 force directory mode (S)
2906 This parameter specifies a set of UNIX mode bit permissions that
2908 will always be set on a directory created by Samba. This is done by
2909 bitwise 'OR'ing these bits onto the mode bits of a directory that
2910 is being created. The default for this parameter is (in octal) 0000
2911 which will not add any extra permission bits to a created
2912 directory. This operation is done after the mode mask in the
2913 parameter directory mask is applied.
2914 The example below would force all created directories to have read
2916 and execute permissions set for 'group' and 'other' as well as the
2917 read/write/execute bits set for the 'user'.
2918 Default: force directory mode = 0000
2920 Example: force directory mode = 0755
2922 force directory security mode (S)
2924 This parameter has been removed for Samba 4.0.0.
2926 No default
2928 group
2930 This parameter is a synonym for force group.
2932 force group (S)
2934 This specifies a UNIX group name that will be assigned as the
2936 default primary group for all users connecting to this service.
2937 This is useful for sharing files by ensuring that all access to
2938 files on service will use the named group for their permissions
2939 checking. Thus, by assigning permissions for this group to the
2940 files and directories within this service the Samba administrator
2941 can restrict or allow sharing of these files.
2942 In Samba 2.0.5 and above this parameter has extended functionality
2944 in the following way. If the group name listed here has a '+'
2945 character prepended to it then the current user accessing the share
2946 only has the primary group default assigned to this group if they
2947 are already assigned as a member of that group. This allows an
2948 administrator to decide that only users who are already in a
2949 particular group will create files with group ownership set to that
2950 group. This gives a finer granularity of ownership assignment. For
2951 example, the setting force group = +sys means that only users who
2952 are already in group sys will have their default primary group
2953 assigned to sys when accessing this Samba share. All other users
2954 will retain their ordinary primary group.
2955 If the force user parameter is also set the group specified in
2957 force group will override the primary group set in force user.
2958 Default: force group =
2960 Example: force group = agroup
2962 force printername (S)
2964 When printing from Windows NT (or later), each printer in smb.conf
2966 has two associated names which can be used by the client. The first
2967 is the sharename (or shortname) defined in smb.conf. This is the
2968 only printername available for use by Windows 9x clients. The
2969 second name associated with a printer can be seen when browsing to
2970 the "Printers" (or "Printers and Faxes") folder on the Samba
2971 server. This is referred to simply as the printername (not to be
2972 confused with the printer name option).
2973 When assigning a new driver to a printer on a remote Windows
2975 compatible print server such as Samba, the Windows client will
2976 rename the printer to match the driver name just uploaded. This can
2977 result in confusion for users when multiple printers are bound to
2978 the same driver. To prevent Samba from allowing the printer's
2979 printername to differ from the sharename defined in smb.conf, set
2980 force printername = yes.
2981 Be aware that enabling this parameter may affect migrating printers
2983 from a Windows server to Samba since Windows has no way to force
2984 the sharename and printername to match.
2985 It is recommended that this parameter's value not be changed once
2987 the printer is in use by clients as this could cause a user not be
2988 able to delete printer connections from their local Printers
2989 folder.
2990 Default: force printername = no
2992 force security mode (S)
2994 This parameter has been removed for Samba 4.0.0.
2996 No default
2998 force unknown acl user (S)
3000 If this parameter is set, a Windows NT ACL that contains an unknown
3002 SID (security descriptor, or representation of a user or group id)
3003 as the owner or group owner of the file will be silently mapped
3004 into the current UNIX uid or gid of the currently connected user.
3005 This is designed to allow Windows NT clients to copy files and
3007 folders containing ACLs that were created locally on the client
3008 machine and contain users local to that machine only (no domain
3009 users) to be copied to a Samba server (usually with XCOPY /O) and
3010 have the unknown userid and groupid of the file owner map to the
3011 current connected user. This can only be fixed correctly when
3012 winbindd allows arbitrary mapping from any Windows NT SID to a UNIX
3013 uid or gid.
3014 Try using this parameter when XCOPY /O gives an ACCESS_DENIED
3016 error.
3017 Default: force unknown acl user = no
3019 force user (S)
3021 This specifies a UNIX user name that will be assigned as the
3023 default user for all users connecting to this service. This is
3024 useful for sharing files. You should also use it carefully as using
3025 it incorrectly can cause security problems.
3026 This user name only gets used once a connection is established.
3028 Thus clients still need to connect as a valid user and supply a
3029 valid password. Once connected, all file operations will be
3030 performed as the "forced user", no matter what username the client
3031 connected as. This can be very useful.
3032 In Samba 2.0.5 and above this parameter also causes the primary
3034 group of the forced user to be used as the primary group for all
3035 file activity. Prior to 2.0.5 the primary group was left as the
3036 primary group of the connecting user (this was a bug).
3037 Default: force user =
3039 Example: force user = auser
3041 fss: prune stale (G)
3043 When enabled, Samba's File Server Remote VSS Protocol (FSRVP)
3045 server checks all FSRVP initiated snapshots on startup, and removes
3046 any corresponding state (including share definitions) for
3047 nonexistent snapshot paths.
3048 Default: fss: prune stale = no
3050 Example: fss: prune stale = yes
3052 fss: sequence timeout (G)
3054 The File Server Remote VSS Protocol (FSRVP) server includes a
3056 message sequence timer to ensure cleanup on unexpected client
3057 disconnect. This parameter overrides the default timeout between
3058 FSRVP operations. FSRVP timeouts can be completely disabled via a
3059 value of 0.
3060 Default: fss: sequence timeout = 180 or 1800, depending on
3062 operation
3063 Example: fss: sequence timeout = 0
3065 fstype (S)
3067 This parameter allows the administrator to configure the string
3069 that specifies the type of filesystem a share is using that is
3070 reported by smbd(8) when a client queries the filesystem type for a
3071 share. The default type is NTFS for compatibility with Windows NT
3072 but this can be changed to other strings such as Samba or FAT if
3073 required.
3074 Default: fstype = NTFS
3076 Example: fstype = Samba
3078 get quota command (G)
3080 The get quota command should only be used whenever there is no
3082 operating system API available from the OS that samba can use.
3083 This option is only available Samba was compiled with quotas
3085 support.
3086 This parameter should specify the path to a script that queries the
3088 quota information for the specified user/group for the partition
3089 that the specified directory is on.
3090 Such a script is being given 3 arguments:
3092 · directory
3094 · type of query
3096 · uid of user or gid of group
3098 The directory is actually mostly just "." - It needs to be treated
3100 relatively to the current working directory that the script can
3101 also query.
3102 The type of query can be one of:
3104 · 1 - user quotas
3106 · 2 - user default quotas (uid = -1)
3108 · 3 - group quotas
3110 · 4 - group default quotas (gid = -1)
3112 This script should print one line as output with spaces between the
3114 columns. The printed columns should be:
3115 · 1 - quota flags (0 = no quotas, 1 = quotas enabled, 2 =
3117 quotas enabled and enforced)
3118 · 2 - number of currently used blocks
3120 · 3 - the softlimit number of blocks
3122 · 4 - the hardlimit number of blocks
3124 · 5 - currently used number of inodes
3126 · 6 - the softlimit number of inodes
3128 · 7 - the hardlimit number of inodes
3130 · 8 (optional) - the number of bytes in a block(default is
3132 1024)
3133 Default: get quota command =
3135 Example: get quota command = /usr/local/sbin/query_quota
3137 getwd cache (G)
3139 This is a tuning option. When this is enabled a caching algorithm
3141 will be used to reduce the time taken for getwd() calls. This can
3142 have a significant impact on performance, especially when the wide
3143 links parameter is set to no.
3144 Default: getwd cache = yes
3146 gpo update command (G)
3148 This option sets the command that is called to apply GPO policies.
3150 The samba_gpoupdate script applies System Access and Kerberos
3151 Policies to the KDC. System Access policies set minPwdAge,
3152 maxPwdAge, minPwdLength, and pwdProperties in the samdb. Kerberos
3153 Policies set kdc:service ticket lifetime, kdc:user ticket lifetime,
3154 and kdc:renewal lifetime in smb.conf.
3155 Default: gpo update command =
3157 /builddir/build/BUILD/samba-4.8.3/source4/scripting/bin/samba_gpoupdate
3158 Example: gpo update command = /usr/local/sbin/gpoupdate
3160 guest account (G)
3162 This is a username which will be used for access to services which
3164 are specified as guest ok (see below). Whatever privileges this
3165 user has will be available to any client connecting to the guest
3166 service. This user must exist in the password file, but does not
3167 require a valid login. The user account "ftp" is often a good
3168 choice for this parameter.
3169 On some systems the default guest account "nobody" may not be able
3171 to print. Use another account in this case. You should test this by
3172 trying to log in as your guest user (perhaps by using the su -
3173 command) and trying to print using the system print command such as
3174 lpr(1) or lp(1).
3175 This parameter does not accept % macros, because many parts of the
3177 system require this value to be constant for correct operation.
3178 Default: guest account = nobody # default can be changed at
3180 compile-time
3181 Example: guest account = ftp
3183 public
3185 This parameter is a synonym for guest ok.
3187 guest ok (S)
3189 If this parameter is yes for a service, then no password is
3191 required to connect to the service. Privileges will be those of the
3192 guest account.
3193 This parameter nullifies the benefits of setting restrict anonymous
3195 = 2
3196 See the section below on security for more information about this
3198 option.
3199 Default: guest ok = no
3201 only guest
3203 This parameter is a synonym for guest only.
3205 guest only (S)
3207 If this parameter is yes for a service, then only guest connections
3209 to the service are permitted. This parameter will have no effect if
3210 guest ok is not set for the service.
3211 See the section below on security for more information about this
3213 option.
3214 Default: guest only = no
3216 hide dot files (S)
3218 This is a boolean parameter that controls whether files starting
3220 with a dot appear as hidden files.
3221 Default: hide dot files = yes
3223 hide files (S)
3225 This is a list of files or directories that are not visible but are
3227 accessible. The DOS 'hidden' attribute is applied to any files or
3228 directories that match.
3229 Each entry in the list must be separated by a '/', which allows
3231 spaces to be included in the entry. '*' and '?' can be used to
3232 specify multiple files or directories as in DOS wildcards.
3233 Each entry must be a Unix path, not a DOS path and must not include
3235 the Unix directory separator '/'.
3236 Note that the case sensitivity option is applicable in hiding
3238 files.
3239 Setting this parameter will affect the performance of Samba, as it
3241 will be forced to check all files and directories for a match as
3242 they are scanned.
3243 The example shown above is based on files that the Macintosh SMB
3245 client (DAVE) available from Thursby creates for internal use, and
3246 also still hides all files beginning with a dot.
3247 An example of us of this parameter is:
3249 hide files = /.*/DesktopFolderDB/TrashFor%m/resource.frk/
3251 Default: hide files = # no file are hidden
3253 hide special files (S)
3255 This parameter prevents clients from seeing special files such as
3257 sockets, devices and fifo's in directory listings.
3258 Default: hide special files = no
3260 hide unreadable (S)
3262 This parameter prevents clients from seeing the existence of files
3264 that cannot be read. Defaults to off.
3265 Please note that enabling this can slow down listing large
3267 directories significantly. Samba has to evaluate the ACLs of all
3268 directory members, which can be a lot of effort.
3269 Default: hide unreadable = no
3271 hide unwriteable files (S)
3273 This parameter prevents clients from seeing the existence of files
3275 that cannot be written to. Defaults to off. Note that unwriteable
3276 directories are shown as usual.
3277 Please note that enabling this can slow down listing large
3279 directories significantly. Samba has to evaluate the ACLs of all
3280 directory members, which can be a lot of effort.
3281 Default: hide unwriteable files = no
3283 homedir map (G)
3285 If nis homedir is yes, and smbd(8) is also acting as a Win95/98
3287 logon server then this parameter specifies the NIS (or YP) map from
3288 which the server for the user's home directory should be extracted.
3289 At present, only the Sun auto.home map format is understood. The
3290 form of the map is:
3291 username server:/some/file/system
3293 and the program will extract the servername from before the first
3295 ':'. There should probably be a better parsing system that copes
3296 with different map formats and also Amd (another automounter) maps.
3297 Note
3299 A working NIS client is required on the system for this option
3300 to work.
3301 Default: homedir map =
3302 Example: homedir map = amd.homedir
3304 host msdfs (G)
3306 If set to yes, Samba will act as a Dfs server, and allow Dfs-aware
3308 clients to browse Dfs trees hosted on the server.
3309 See also the msdfs root share level parameter. For more information
3311 on setting up a Dfs tree on Samba, refer to the MSFDS chapter in
3312 the book Samba3-HOWTO.
3313 Default: host msdfs = yes
3315 hostname lookups (G)
3317 Specifies whether samba should use (expensive) hostname lookups or
3319 use the ip addresses instead. An example place where hostname
3320 lookups are currently used is when checking the hosts deny and
3321 hosts allow.
3322 Default: hostname lookups = no
3324 Example: hostname lookups = yes
3326 allow hosts
3328 This parameter is a synonym for hosts allow.
3330 hosts allow (S)
3332 A synonym for this parameter is allow hosts.
3334 This parameter is a comma, space, or tab delimited set of hosts
3336 which are permitted to access a service.
3337 If specified in the [global] section then it will apply to all
3339 services, regardless of whether the individual service has a
3340 different setting.
3341 You can specify the hosts by name or IP number. For example, you
3343 could restrict access to only the hosts on a Class C subnet with
3344 something like allow hosts = 150.203.5.. The full syntax of the
3345 list is described in the man page hosts_access(5). Note that this
3346 man page may not be present on your system, so a brief description
3347 will be given here also.
3348 Note that the localhost address 127.0.0.1 will always be allowed
3350 access unless specifically denied by a hosts deny option.
3351 You can also specify hosts by network/netmask pairs and by netgroup
3353 names if your system supports netgroups. The EXCEPT keyword can
3354 also be used to limit a wildcard list. The following examples may
3355 provide some help:
3356 Example 1: allow all IPs in 150.203.*.*; except one
3358 hosts allow = 150.203. EXCEPT 150.203.6.66
3360 Example 2: allow hosts that match the given network/netmask
3362 hosts allow = 150.203.15.0/255.255.255.0
3364 Example 3: allow a couple of hosts
3366 hosts allow = lapland, arvidsjaur
3368 Example 4: allow only hosts in NIS netgroup "foonet", but deny
3370 access from one particular host
3371 hosts allow = @foonet
3373 hosts deny = pirate
3375 Note
3377 Note that access still requires suitable user-level passwords.
3378 See testparm(1) for a way of testing your host access to see if it
3379 does what you expect.
3380 Default: hosts allow = # none (i.e., all hosts permitted access)
3382 Example: hosts allow = 150.203.5. myhost.mynet.edu.au
3384 deny hosts
3386 This parameter is a synonym for hosts deny.
3388 hosts deny (S)
3390 The opposite of hosts allow - hosts listed here are NOT permitted
3392 access to services unless the specific services have their own
3393 lists to override this one. Where the lists conflict, the allow
3394 list takes precedence.
3395 In the event that it is necessary to deny all by default, use the
3397 keyword ALL (or the netmask 0.0.0.0/0) and then explicitly specify
3398 to the hosts allow = hosts allow parameter those hosts that should
3399 be permitted access.
3400 Default: hosts deny = # none (i.e., no hosts specifically
3402 excluded)
3403 Example: hosts deny = 150.203.4. badhost.mynet.edu.au
3405 idmap backend (G)
3407 The idmap backend provides a plugin interface for Winbind to use
3409 varying backends to store SID/uid/gid mapping tables.
3410 This option specifies the default backend that is used when no
3412 special configuration set, but it is now deprecated in favour of
3413 the new spelling idmap config * : backend.
3414 Default: idmap backend = tdb
3416 idmap cache time (G)
3418 This parameter specifies the number of seconds that Winbind's idmap
3420 interface will cache positive SID/uid/gid query results. By
3421 default, Samba will cache these results for one week.
3422 Default: idmap cache time = 604800
3424 idmap config DOMAIN : OPTION (G)
3426 ID mapping in Samba is the mapping between Windows SIDs and Unix
3428 user and group IDs. This is performed by Winbindd with a
3429 configurable plugin interface. Samba's ID mapping is configured by
3430 options starting with the idmap config prefix. An idmap option
3431 consists of the idmap config prefix, followed by a domain name or
3432 the asterisk character (*), a colon, and the name of an idmap
3433 setting for the chosen domain.
3434 The idmap configuration is hence divided into groups, one group for
3436 each domain to be configured, and one group with the asterisk
3437 instead of a proper domain name, which specifies the default
3438 configuration that is used to catch all domains that do not have an
3439 explicit idmap configuration of their own.
3440 There are three general options available:
3442 backend = backend_name
3444 This specifies the name of the idmap plugin to use as the
3445 SID/uid/gid backend for this domain. The standard backends are
3446 tdb (idmap_tdb(8)), tdb2 (idmap_tdb2(8)), ldap (idmap_ldap(8)),
3447 rid (idmap_rid(8)), hash (idmap_hash(8)), autorid
3448 (idmap_autorid(8)), ad (idmap_ad(8)) and nss (idmap_nss(8)).
3449 The corresponding manual pages contain the details, but here is
3450 a summary.
3451 The first three of these create mappings of their own using
3453 internal unixid counters and store the mappings in a database.
3454 These are suitable for use in the default idmap configuration.
3455 The rid and hash backends use a pure algorithmic calculation to
3456 determine the unixid for a SID. The autorid module is a mixture
3457 of the tdb and rid backend. It creates ranges for each domain
3458 encountered and then uses the rid algorithm for each of these
3459 automatically configured domains individually. The ad backend
3460 uses unix ids stored in Active Directory via the standard
3461 schema extensions. The nss backend reverses the standard
3462 winbindd setup and gets the unix ids via names from nsswitch
3463 which can be useful in an ldap setup.
3464 range = low - high
3466 Defines the available matching uid and gid range for which the
3467 backend is authoritative. For allocating backends, this also
3468 defines the start and the end of the range for allocating new
3469 unique IDs.
3470 winbind uses this parameter to find the backend that is
3472 authoritative for a unix ID to SID mapping, so it must be set
3473 for each individually configured domain and for the default
3474 configuration. The configured ranges must be mutually disjoint.
3475 read only = yes|no
3477 This option can be used to turn the writing backends tdb, tdb2,
3478 and ldap into read only mode. This can be useful e.g. in cases
3479 where a pre-filled database exists that should not be extended
3480 automatically.
3481 The following example illustrates how to configure the idmap_ad(8)
3483 backend for the CORP domain and the idmap_tdb(8) backend for all
3484 other domains. This configuration assumes that the admin of CORP
3485 assigns unix ids below 1000000 via the SFU extensions, and winbind
3486 is supposed to use the next million entries for its own mappings
3487 from trusted domains and for local groups for example.
3488 idmap config * : backend = tdb
3490 idmap config * : range = 1000000-1999999
3491 idmap config CORP : backend = ad
3493 idmap config CORP : range = 1000-999999
3494 No default
3497 winbind gid
3499 This parameter is a synonym for idmap gid.
3501 idmap gid (G)
3503 The idmap gid parameter specifies the range of group ids for the
3505 default idmap configuration. It is now deprecated in favour of
3506 idmap config * : range.
3507 See the idmap config option.
3509 Default: idmap gid =
3511 Example: idmap gid = 10000-20000
3513 idmap negative cache time (G)
3515 This parameter specifies the number of seconds that Winbind's idmap
3517 interface will cache negative SID/uid/gid query results.
3518 Default: idmap negative cache time = 120
3520 winbind uid
3522 This parameter is a synonym for idmap uid.
3524 idmap uid (G)
3526 The idmap uid parameter specifies the range of user ids for the
3528 default idmap configuration. It is now deprecated in favour of
3529 idmap config * : range.
3530 See the idmap config option.
3532 Default: idmap uid =
3534 Example: idmap uid = 10000-20000
3536 include (S)
3538 This allows you to include one config file inside another. The file
3540 is included literally, as though typed in place.
3541 It takes the standard substitutions, except %u, %P and %S.
3543 The parameter include = registry has a special meaning: It does not
3545 include a file named registry from the current working directory,
3546 but instead reads the global configuration options from the
3547 registry. See the section on registry-based configuration for
3548 details. Note that this option automatically activates registry
3549 shares.
3550 Default: include =
3552 Example: include = /usr/local/samba/lib/admin_smb.conf
3554 include system krb5 conf (G)
3556 Setting this parameter to no will prevent winbind to include the
3558 system /etc/krb5.conf file into the krb5.conf file it creates. See
3559 also create krb5 conf. This option only applies to Samba built with
3560 MIT Kerberos.
3561 Default: include system krb5 conf = yes
3563 inherit acls (S)
3565 This parameter can be used to ensure that if default acls exist on
3567 parent directories, they are always honored when creating a new
3568 file or subdirectory in these parent directories. The default
3569 behavior is to use the unix mode specified when creating the
3570 directory. Enabling this option sets the unix mode to 0777, thus
3571 guaranteeing that default directory acls are propagated. Note that
3572 using the VFS modules acl_xattr or acl_tdb which store native
3573 Windows as meta-data will automatically turn this option on for any
3574 share for which they are loaded, as they require this option to
3575 emulate Windows ACLs correctly.
3576 Default: inherit acls = no
3578 inherit owner (S)
3580 The ownership of new files and directories is normally governed by
3582 effective uid of the connected user. This option allows the Samba
3583 administrator to specify that the ownership for new files and
3584 directories should be controlled by the ownership of the parent
3585 directory.
3586 Valid options are:
3588 · no - Both the Windows (SID) owner and the UNIX (uid)
3590 owner of the file are governed by the identity of the
3591 user that created the file.
3592 · windows and unix - The Windows (SID) owner and the UNIX
3594 (uid) owner of new files and directories are set to the
3595 respective owner of the parent directory.
3596 · yes - a synonym for windows and unix.
3598 · unix only - Only the UNIX owner is set to the UNIX owner
3600 of the parent directory.
3601 Common scenarios where this behavior is useful is in implementing
3603 drop-boxes, where users can create and edit files but not delete
3604 them and ensuring that newly created files in a user's roaming
3605 profile directory are actually owned by the user.
3606 The unix only option effectively breaks the tie between the Windows
3608 owner of a file and the UNIX owner. As a logical consequence, in
3609 this mode, setting the the Windows owner of a file does not modify
3610 the UNIX owner. Using this mode should typically be combined with a
3611 backing store that can emulate the full NT ACL model without
3612 affecting the POSIX permissions, such as the acl_xattr VFS module,
3613 coupled with acl_xattr:ignore system acls = yes. This can be used
3614 to emulate folder quotas, when files are exposed only via SMB
3615 (without UNIX extensions). The UNIX owner of a directory is locally
3616 set and inherited by all subdirectories and files, and they all
3617 consume the same quota.
3618 Default: inherit owner = no
3620 inherit permissions (S)
3622 The permissions on new files and directories are normally governed
3624 by create mask, directory mask, force create mode and force
3625 directory mode but the boolean inherit permissions parameter
3626 overrides this.
3627 New directories inherit the mode of the parent directory, including
3629 bits such as setgid.
3630 New files inherit their read/write bits from the parent directory.
3632 Their execute bits continue to be determined by map archive, map
3633 hidden and map system as usual.
3634 Note that the setuid bit is never set via inheritance (the code
3636 explicitly prohibits this).
3637 This can be particularly useful on large systems with many users,
3639 perhaps several thousand, to allow a single [homes] share to be
3640 used flexibly by each user.
3641 Default: inherit permissions = no
3643 init logon delay (G)
3645 This parameter specifies a delay in milliseconds for the hosts
3647 configured for delayed initial samlogon with init logon delayed
3648 hosts.
3649 Default: init logon delay = 100
3651 init logon delayed hosts (G)
3653 This parameter takes a list of host names, addresses or networks
3655 for which the initial samlogon reply should be delayed (so other
3656 DCs get preferred by XP workstations if there are any).
3657 The length of the delay can be specified with the init logon delay
3659 parameter.
3660 Default: init logon delayed hosts =
3662 Example: init logon delayed hosts = 150.203.5. myhost.mynet.de
3664 interfaces (G)
3666 This option allows you to override the default network interfaces
3668 list that Samba will use for browsing, name registration and other
3669 NetBIOS over TCP/IP (NBT) traffic. By default Samba will query the
3670 kernel for the list of all active interfaces and use any interfaces
3671 except 127.0.0.1 that are broadcast capable.
3672 The option takes a list of interface strings. Each string can be in
3674 any of the following forms:
3675 · a network interface name (such as eth0). This may
3677 include shell-like wildcards so eth* will match any
3678 interface starting with the substring "eth"
3679 · an IP address. In this case the netmask is determined
3681 from the list of interfaces obtained from the kernel
3682 · an IP/mask pair.
3684 · a broadcast/mask pair.
3686 The "mask" parameters can either be a bit length (such as 24 for a
3688 C class network) or a full netmask in dotted decimal form.
3689 The "IP" parameters above can either be a full dotted decimal IP
3691 address or a hostname which will be looked up via the OS's normal
3692 hostname resolution mechanisms.
3693 By default Samba enables all active interfaces that are broadcast
3695 capable except the loopback adaptor (IP address 127.0.0.1).
3696 In order to support SMB3 multi-channel configurations, smbd
3698 understands some extra data that can be appended after the actual
3699 interface with this extended syntax:
3700 interface[;key1=value1[,key2=value2[...]]]
3702 Known keys are speed, capability, and if_index. Speed is specified
3704 in bits per second. Known capabilities are RSS and RDMA. The
3705 if_index should be used with care: the values must not coincide
3706 with indexes used by the kernel. Note that these options are mainly
3707 intended for testing and development rather than for production
3708 use. At least on Linux systems, these values should be
3709 auto-detected, but the settings can serve as last a resort when
3710 autodetection is not working or is not available.
3711 The example below configures three network interfaces corresponding
3713 to the eth0 device and IP addresses 192.168.2.10 and 192.168.3.10.
3714 The netmasks of the latter two interfaces would be set to
3715 255.255.255.0.
3716 Default: interfaces =
3718 Example: interfaces = eth0 192.168.2.10/24
3720 192.168.3.10/255.255.255.0
3721 invalid users (S)
3723 This is a list of users that should not be allowed to login to this
3725 service. This is really a paranoid check to absolutely ensure an
3726 improper setting does not breach your security.
3727 A name starting with a '@' is interpreted as an NIS netgroup first
3729 (if your system supports NIS), and then as a UNIX group if the name
3730 was not found in the NIS netgroup database.
3731 A name starting with '+' is interpreted only by looking in the UNIX
3733 group database via the NSS getgrnam() interface. A name starting
3734 with '&' is interpreted only by looking in the NIS netgroup
3735 database (this requires NIS to be working on your system). The
3736 characters '+' and '&' may be used at the start of the name in
3737 either order so the value +&group means check the UNIX group
3738 database, followed by the NIS netgroup database, and the value
3739 &+group means check the NIS netgroup database, followed by the UNIX
3740 group database (the same as the '@' prefix).
3741 The current servicename is substituted for %S. This is useful in
3743 the [homes] section.
3744 Default: invalid users = # no invalid users
3746 Example: invalid users = root fred admin @wheel
3748 iprint server (G)
3750 This parameter is only applicable if printing is set to iprint.
3752 If set, this option overrides the ServerName option in the CUPS
3754 client.conf. This is necessary if you have virtual samba servers
3755 that connect to different CUPS daemons.
3756 Default: iprint server = ""
3758 Example: iprint server = MYCUPSSERVER
3760 keepalive (G)
3762 The value of the parameter (an integer) represents the number of
3764 seconds between keepalive packets. If this parameter is zero, no
3765 keepalive packets will be sent. Keepalive packets, if sent, allow
3766 the server to tell whether a client is still present and
3767 responding.
3768 Keepalives should, in general, not be needed if the socket has the
3770 SO_KEEPALIVE attribute set on it by default. (see socket options).
3771 Basically you should only use this option if you strike
3772 difficulties.
3773 Please note this option only applies to SMB1 client connections,
3775 and has no effect on SMB2 clients.
3776 Default: keepalive = 300
3778 Example: keepalive = 600
3780 kerberos encryption types (G)
3782 This parameter determines the encryption types to use when
3784 operating as a Kerberos client. Possible values are all, strong,
3785 and legacy.
3786 Samba uses a Kerberos library (MIT or Heimdal) to obtain Kerberos
3788 tickets. This library is normally configured outside of Samba,
3789 using the krb5.conf file. This file may also include directives to
3790 configure the encryption types to be used. However, Samba
3791 implements Active Directory protocols and algorithms to locate a
3792 domain controller. In order to force the Kerberos library into
3793 using the correct domain controller, some Samba processes, such as
3794 winbindd(8) and net(8), build a private krb5.conf file for use by
3795 the Kerberos library while being invoked from Samba. This private
3796 file controls all aspects of the Kerberos library operation, and
3797 this parameter controls how the encryption types are configured
3798 within this generated file, and therefore also controls the
3799 encryption types negotiable by Samba.
3800 When set to all, all active directory encryption types are allowed.
3802 When set to strong, only AES-based encryption types are offered.
3804 This can be used in hardened environments to prevent downgrade
3805 attacks.
3806 When set to legacy, only RC4-HMAC-MD5 is allowed. Avoiding AES this
3808 way has one a very specific use. Normally, the encryption type is
3809 negotiated between the peers. However, there is one scenario in
3810 which a Windows read-only domain controller (RODC) advertises AES
3811 encryption, but then proxies the request to a writeable DC which
3812 may not support AES encryption, leading to failure of the
3813 handshake. Setting this parameter to legacy would cause samba not
3814 to negotiate AES encryption. It is assumed of course that the
3815 weaker legacy encryption types are acceptable for the setup.
3816 Default: kerberos encryption types = all
3818 kerberos method (G)
3820 Controls how kerberos tickets are verified.
3822 Valid options are:
3824 · secrets only - use only the secrets.tdb for ticket
3826 verification (default)
3827 · system keytab - use only the system keytab for ticket
3829 verification
3830 · dedicated keytab - use a dedicated keytab for ticket
3832 verification
3833 · secrets and keytab - use the secrets.tdb first, then the
3835 system keytab
3836 The major difference between "system keytab" and "dedicated keytab"
3838 is that the latter method relies on kerberos to find the correct
3839 keytab entry instead of filtering based on expected principals.
3840 When the kerberos method is in "dedicated keytab" mode, dedicated
3842 keytab file must be set to specify the location of the keytab file.
3843 Default: kerberos method = default
3845 kernel change notify (G)
3847 This parameter specifies whether Samba should ask the kernel for
3849 change notifications in directories so that SMB clients can refresh
3850 whenever the data on the server changes.
3851 This parameter is only used when your kernel supports change
3853 notification to user programs using the inotify interface.
3854 Default: kernel change notify = yes
3856 kernel oplocks (S)
3858 For UNIXes that support kernel based oplocks (currently only IRIX
3860 and the Linux 2.4 kernel), this parameter allows the use of them to
3861 be turned on or off. However, this disables Level II oplocks for
3862 clients as the Linux and IRIX kernels do not support them properly.
3863 Kernel oplocks support allows Samba oplocks to be broken whenever a
3865 local UNIX process or NFS operation accesses a file that smbd(8)
3866 has oplocked. This allows complete data consistency between
3867 SMB/CIFS, NFS and local file access (and is a very cool feature
3868 :-).
3869 If you do not need this interaction, you should disable the
3871 parameter on Linux and IRIX to get Level II oplocks and the
3872 associated performance benefit.
3873 This parameter defaults to no and is translated to a no-op on
3875 systems that do not have the necessary kernel support.
3876 Default: kernel oplocks = no
3878 kernel share modes (S)
3880 This parameter controls whether SMB share modes are translated into
3882 UNIX flocks.
3883 Kernel share modes provide a minimal level of interoperability with
3885 local UNIX processes and NFS operations by preventing access with
3886 flocks corresponding to the SMB share modes. Generally, it is very
3887 desirable to leave this enabled.
3888 Note that in order to use SMB2 durable file handles on a share, you
3890 have to turn kernel share modes off.
3891 This parameter defaults to yes and is translated to a no-op on
3893 systems that do not have the necessary kernel flock support.
3894 Default: kernel share modes = yes
3896 kpasswd port (G)
3898 Specifies which ports the Kerberos server should listen on for
3900 password changes.
3901 Default: kpasswd port = 464
3903 krb5 port (G)
3905 Specifies which port the KDC should listen on for Kerberos traffic.
3907 Default: krb5 port = 88
3909 lanman auth (G)
3911 This parameter determines whether or not smbd(8) will attempt to
3913 authenticate users or permit password changes using the LANMAN
3914 password hash. If disabled, only clients which support NT password
3915 hashes (e.g. Windows NT/2000 clients, smbclient, but not Windows
3916 95/98 or the MS DOS network client) will be able to connect to the
3917 Samba host.
3918 The LANMAN encrypted response is easily broken, due to its
3920 case-insensitive nature, and the choice of algorithm. Servers
3921 without Windows 95/98/ME or MS DOS clients are advised to disable
3922 this option.
3923 When this parameter is set to no this will also result in
3925 sambaLMPassword in Samba's passdb being blanked after the next
3926 password change. As a result of that lanman clients won't be able
3927 to authenticate, even if lanman auth is re-enabled later on.
3928 Unlike the encrypt passwords option, this parameter cannot alter
3930 client behaviour, and the LANMAN response will still be sent over
3931 the network. See the client lanman auth to disable this for Samba's
3932 clients (such as smbclient)
3933 If this option, and ntlm auth are both disabled, then only NTLMv2
3935 logins will be permited. Not all clients support NTLMv2, and most
3936 will require special configuration to use it.
3937 Default: lanman auth = no
3939 large readwrite (G)
3941 This parameter determines whether or not smbd(8) supports the new
3943 64k streaming read and write variant SMB requests introduced with
3944 Windows 2000. Note that due to Windows 2000 client redirector bugs
3945 this requires Samba to be running on a 64-bit capable operating
3946 system such as IRIX, Solaris or a Linux 2.4 kernel. Can improve
3947 performance by 10% with Windows 2000 clients. Defaults to on. Not
3948 as tested as some other Samba code paths.
3949 Default: large readwrite = yes
3951 ldap admin dn (G)
3953 The ldap admin dn defines the Distinguished Name (DN) name used by
3955 Samba to contact the ldap server when retreiving user account
3956 information. The ldap admin dn is used in conjunction with the
3957 admin dn password stored in the private/secrets.tdb file. See the
3958 smbpasswd(8) man page for more information on how to accomplish
3959 this.
3960 The ldap admin dn requires a fully specified DN. The ldap suffix is
3962 not appended to the ldap admin dn.
3963 No default
3965 ldap connection timeout (G)
3967 This parameter tells the LDAP library calls which timeout in
3969 seconds they should honor during initial connection establishments
3970 to LDAP servers. It is very useful in failover scenarios in
3971 particular. If one or more LDAP servers are not reachable at all,
3972 we do not have to wait until TCP timeouts are over. This feature
3973 must be supported by your LDAP library.
3974 This parameter is different from ldap timeout which affects
3976 operations on LDAP servers using an existing connection and not
3977 establishing an initial connection.
3978 Default: ldap connection timeout = 2
3980 ldap debug level (G)
3982 This parameter controls the debug level of the LDAP library calls.
3984 In the case of OpenLDAP, it is the same bit-field as understood by
3985 the server and documented in the slapd.conf(5) manpage. A typical
3986 useful value will be 1 for tracing function calls.
3987 The debug output from the LDAP libraries appears with the prefix
3989 [LDAP] in Samba's logging output. The level at which LDAP logging
3990 is printed is controlled by the parameter ldap debug threshold.
3991 Default: ldap debug level = 0
3993 Example: ldap debug level = 1
3995 ldap debug threshold (G)
3997 This parameter controls the Samba debug level at which the ldap
3999 library debug output is printed in the Samba logs. See the
4000 description of ldap debug level for details.
4001 Default: ldap debug threshold = 10
4003 Example: ldap debug threshold = 5
4005 ldap delete dn (G)
4007 This parameter specifies whether a delete operation in the ldapsam
4009 deletes the complete entry or only the attributes specific to
4010 Samba.
4011 Default: ldap delete dn = no
4013 ldap deref (G)
4015 This option controls whether Samba should tell the LDAP library to
4017 use a certain alias dereferencing method. The default is auto,
4018 which means that the default setting of the ldap client library
4019 will be kept. Other possible values are never, finding, searching
4020 and always. Grab your LDAP manual for more information.
4021 Default: ldap deref = auto
4023 Example: ldap deref = searching
4025 ldap follow referral (G)
4027 This option controls whether to follow LDAP referrals or not when
4029 searching for entries in the LDAP database. Possible values are on
4030 to enable following referrals, off to disable this, and auto, to
4031 use the libldap default settings. libldap's choice of following
4032 referrals or not is set in /etc/openldap/ldap.conf with the
4033 REFERRALS parameter as documented in ldap.conf(5).
4034 Default: ldap follow referral = auto
4036 Example: ldap follow referral = off
4038 ldap group suffix (G)
4040 This parameter specifies the suffix that is used for groups when
4042 these are added to the LDAP directory. If this parameter is unset,
4043 the value of ldap suffix will be used instead. The suffix string is
4044 pre-pended to the ldap suffix string so use a partial DN.
4045 Default: ldap group suffix =
4047 Example: ldap group suffix = ou=Groups
4049 ldap idmap suffix (G)
4051 This parameters specifies the suffix that is used when storing
4053 idmap mappings. If this parameter is unset, the value of ldap
4054 suffix will be used instead. The suffix string is pre-pended to the
4055 ldap suffix string so use a partial DN.
4056 Default: ldap idmap suffix =
4058 Example: ldap idmap suffix = ou=Idmap
4060 ldap machine suffix (G)
4062 It specifies where machines should be added to the ldap tree. If
4064 this parameter is unset, the value of ldap suffix will be used
4065 instead. The suffix string is pre-pended to the ldap suffix string
4066 so use a partial DN.
4067 Default: ldap machine suffix =
4069 Example: ldap machine suffix = ou=Computers
4071 ldap page size (G)
4073 This parameter specifies the number of entries per page.
4075 If the LDAP server supports paged results, clients can request
4077 subsets of search results (pages) instead of the entire list. This
4078 parameter specifies the size of these pages.
4079 Default: ldap page size = 1000
4081 Example: ldap page size = 512
4083 ldap password sync
4085 This parameter is a synonym for ldap passwd sync.
4087 ldap passwd sync (G)
4089 This option is used to define whether or not Samba should sync the
4091 LDAP password with the NT and LM hashes for normal accounts (NOT
4092 for workstation, server or domain trusts) on a password change via
4093 SAMBA.
4094 The ldap passwd sync can be set to one of three values:
4096 · Yes = Try to update the LDAP, NT and LM passwords and
4098 update the pwdLastSet time.
4099 · No = Update NT and LM passwords and update the
4101 pwdLastSet time.
4102 · Only = Only update the LDAP password and let the LDAP
4104 server do the rest.
4105 Default: ldap passwd sync = no
4107 ldap replication sleep (G)
4109 When Samba is asked to write to a read-only LDAP replica, we are
4111 redirected to talk to the read-write master server. This server
4112 then replicates our changes back to the 'local' server, however the
4113 replication might take some seconds, especially over slow links.
4114 Certain client activities, particularly domain joins, can become
4115 confused by the 'success' that does not immediately change the LDAP
4116 back-end's data.
4117 This option simply causes Samba to wait a short time, to allow the
4119 LDAP server to catch up. If you have a particularly high-latency
4120 network, you may wish to time the LDAP replication with a network
4121 sniffer, and increase this value accordingly. Be aware that no
4122 checking is performed that the data has actually replicated.
4123 The value is specified in milliseconds, the maximum value is 5000
4125 (5 seconds).
4126 Default: ldap replication sleep = 1000
4128 ldapsam:editposix (G)
4130 Editposix is an option that leverages ldapsam:trusted to make it
4132 simpler to manage a domain controller eliminating the need to set
4133 up custom scripts to add and manage the posix users and groups.
4134 This option will instead directly manipulate the ldap tree to
4135 create, remove and modify user and group entries. This option also
4136 requires a running winbindd as it is used to allocate new uids/gids
4137 on user/group creation. The allocation range must be therefore
4138 configured.
4139 To use this option, a basic ldap tree must be provided and the ldap
4141 suffix parameters must be properly configured. On virgin servers
4142 the default users and groups (Administrator, Guest, Domain Users,
4143 Domain Admins, Domain Guests) can be precreated with the command
4144 net sam provision. To run this command the ldap server must be
4145 running, Winbindd must be running and the smb.conf ldap options
4146 must be properly configured. The typical ldap setup used with the
4147 ldapsam:trusted = yes option is usually sufficient to use
4148 ldapsam:editposix = yes as well.
4149 An example configuration can be the following:
4151 encrypt passwords = true
4153 passdb backend = ldapsam
4154 ldapsam:trusted=yes
4156 ldapsam:editposix=yes
4157 ldap admin dn = cn=admin,dc=samba,dc=org
4159 ldap delete dn = yes
4160 ldap group suffix = ou=groups
4161 ldap idmap suffix = ou=idmap
4162 ldap machine suffix = ou=computers
4163 ldap user suffix = ou=users
4164 ldap suffix = dc=samba,dc=org
4165 idmap backend = ldap:"ldap://localhost"
4167 idmap uid = 5000-50000
4169 idmap gid = 5000-50000
4170 This configuration assumes a directory layout like described in the
4173 following ldif:
4174 dn: dc=samba,dc=org
4176 objectClass: top
4177 objectClass: dcObject
4178 objectClass: organization
4179 o: samba.org
4180 dc: samba
4181 dn: cn=admin,dc=samba,dc=org
4183 objectClass: simpleSecurityObject
4184 objectClass: organizationalRole
4185 cn: admin
4186 description: LDAP administrator
4187 userPassword: secret
4188 dn: ou=users,dc=samba,dc=org
4190 objectClass: top
4191 objectClass: organizationalUnit
4192 ou: users
4193 dn: ou=groups,dc=samba,dc=org
4195 objectClass: top
4196 objectClass: organizationalUnit
4197 ou: groups
4198 dn: ou=idmap,dc=samba,dc=org
4200 objectClass: top
4201 objectClass: organizationalUnit
4202 ou: idmap
4203 dn: ou=computers,dc=samba,dc=org
4205 objectClass: top
4206 objectClass: organizationalUnit
4207 ou: computers
4208 Default: ldapsam:editposix = no
4211 ldapsam:trusted (G)
4213 By default, Samba as a Domain Controller with an LDAP backend needs
4215 to use the Unix-style NSS subsystem to access user and group
4216 information. Due to the way Unix stores user information in
4217 /etc/passwd and /etc/group this inevitably leads to inefficiencies.
4218 One important question a user needs to know is the list of groups
4219 he is member of. The plain UNIX model involves a complete
4220 enumeration of the file /etc/group and its NSS counterparts in
4221 LDAP. UNIX has optimized functions to enumerate group membership.
4222 Sadly, other functions that are used to deal with user and group
4223 attributes lack such optimization.
4224 To make Samba scale well in large environments, the ldapsam:trusted
4226 = yes option assumes that the complete user and group database that
4227 is relevant to Samba is stored in LDAP with the standard
4228 posixAccount/posixGroup attributes. It further assumes that the
4229 Samba auxiliary object classes are stored together with the POSIX
4230 data in the same LDAP object. If these assumptions are met,
4231 ldapsam:trusted = yes can be activated and Samba can bypass the NSS
4232 system to query user group memberships. Optimized LDAP queries can
4233 greatly speed up domain logon and administration tasks. Depending
4234 on the size of the LDAP database a factor of 100 or more for common
4235 queries is easily achieved.
4236 Default: ldapsam:trusted = no
4238 ldap server require strong auth (G)
4240 The ldap server require strong auth defines whether the ldap server
4242 requires ldap traffic to be signed or signed and encrypted
4243 (sealed). Possible values are no, allow_sasl_over_tls and yes.
4244 A value of no allows simple and sasl binds over all transports.
4246 A value of allow_sasl_over_tls allows simple and sasl binds
4248 (without sign or seal) over TLS encrypted connections. Unencrypted
4249 connections only allow sasl binds with sign or seal.
4250 A value of yes allows only simple binds over TLS encrypted
4252 connections. Unencrypted connections only allow sasl binds with
4253 sign or seal.
4254 Default: ldap server require strong auth = yes
4256 ldap ssl (G)
4258 This option is used to define whether or not Samba should use SSL
4260 when connecting to the ldap server This is NOT related to Samba's
4261 previous SSL support which was enabled by specifying the --with-ssl
4262 option to the configure script.
4263 LDAP connections should be secured where possible. This may be done
4265 setting either this parameter to start tlsor by specifying ldaps://
4266 in the URL argument of passdb backend.
4267 The ldap ssl can be set to one of two values:
4269 · Off = Never use SSL when querying the directory.
4271 · start tls = Use the LDAPv3 StartTLS extended operation
4273 (RFC2830) for communicating with the directory server.
4274 Please note that this parameter does only affect rpc methods. To
4276 enable the LDAPv3 StartTLS extended operation (RFC2830) for ads,
4277 set ldap ssl = start tlsandldap ssl ads = yes. See smb.conf(5) for
4278 more information on ldap ssl ads.
4279 Default: ldap ssl = start tls
4281 ldap ssl ads (G)
4283 This option is used to define whether or not Samba should use SSL
4285 when connecting to the ldap server using ads methods. Rpc methods
4286 are not affected by this parameter. Please note, that this
4287 parameter won't have any effect if ldap ssl is set to no.
4288 See smb.conf(5) for more information on ldap ssl.
4290 Default: ldap ssl ads = no
4292 ldap suffix (G)
4294 Specifies the base for all ldap suffixes and for storing the
4296 sambaDomain object.
4297 The ldap suffix will be appended to the values specified for the
4299 ldap user suffix, ldap group suffix, ldap machine suffix, and the
4300 ldap idmap suffix. Each of these should be given only a DN relative
4301 to the ldap suffix.
4302 Default: ldap suffix =
4304 Example: ldap suffix = dc=samba,dc=org
4306 ldap timeout (G)
4308 This parameter defines the number of seconds that Samba should use
4310 as timeout for LDAP operations.
4311 Default: ldap timeout = 15
4313 ldap user suffix (G)
4315 This parameter specifies where users are added to the tree. If this
4317 parameter is unset, the value of ldap suffix will be used instead.
4318 The suffix string is pre-pended to the ldap suffix string so use a
4319 partial DN.
4320 Default: ldap user suffix =
4322 Example: ldap user suffix = ou=people
4324 level2 oplocks (S)
4326 This parameter controls whether Samba supports level2 (read-only)
4328 oplocks on a share.
4329 Level2, or read-only oplocks allow Windows NT clients that have an
4331 oplock on a file to downgrade from a read-write oplock to a
4332 read-only oplock once a second client opens the file (instead of
4333 releasing all oplocks on a second open, as in traditional,
4334 exclusive oplocks). This allows all openers of the file that
4335 support level2 oplocks to cache the file for read-ahead only (ie.
4336 they may not cache writes or lock requests) and increases
4337 performance for many accesses of files that are not commonly
4338 written (such as application .EXE files).
4339 Once one of the clients which have a read-only oplock writes to the
4341 file all clients are notified (no reply is needed or waited for)
4342 and told to break their oplocks to "none" and delete any read-ahead
4343 caches.
4344 It is recommended that this parameter be turned on to speed access
4346 to shared executables.
4347 For more discussions on level2 oplocks see the CIFS spec.
4349 Currently, if kernel oplocks are supported then level2 oplocks are
4351 not granted (even if this parameter is set to yes). Note also, the
4352 oplocks parameter must be set to yes on this share in order for
4353 this parameter to have any effect.
4354 Default: level2 oplocks = yes
4356 lm announce (G)
4358 This parameter determines if nmbd(8) will produce Lanman announce
4360 broadcasts that are needed by OS/2 clients in order for them to see
4361 the Samba server in their browse list. This parameter can have
4362 three values, yes, no, or auto. The default is auto. If set to no
4363 Samba will never produce these broadcasts. If set to yes Samba will
4364 produce Lanman announce broadcasts at a frequency set by the
4365 parameter lm interval. If set to auto Samba will not send Lanman
4366 announce broadcasts by default but will listen for them. If it
4367 hears such a broadcast on the wire it will then start sending them
4368 at a frequency set by the parameter lm interval.
4369 Default: lm announce = auto
4371 Example: lm announce = yes
4373 lm interval (G)
4375 If Samba is set to produce Lanman announce broadcasts needed by
4377 OS/2 clients (see the lm announce parameter) then this parameter
4378 defines the frequency in seconds with which they will be made. If
4379 this is set to zero then no Lanman announcements will be made
4380 despite the setting of the lm announce parameter.
4381 Default: lm interval = 60
4383 Example: lm interval = 120
4385 load printers (G)
4387 A boolean variable that controls whether all printers in the
4389 printcap will be loaded for browsing by default. See the printers
4390 section for more details.
4391 Default: load printers = yes
4393 local master (G)
4395 This option allows nmbd(8) to try and become a local master browser
4397 on a subnet. If set to no then nmbd will not attempt to become a
4398 local master browser on a subnet and will also lose in all browsing
4399 elections. By default this value is set to yes. Setting this value
4400 to yes doesn't mean that Samba will become the local master browser
4401 on a subnet, just that nmbd will participate in elections for local
4402 master browser.
4403 Setting this value to no will cause nmbdnever to become a local
4405 master browser.
4406 Default: local master = yes
4408 lock dir
4410 This parameter is a synonym for lock directory.
4412 lock directory (G)
4414 This option specifies the directory where lock files will be
4416 placed. The lock files are used to implement the max connections
4417 option.
4418 Note: This option can not be set inside registry configurations.
4420 The files placed in this directory are not required across service
4422 restarts and can be safely placed on volatile storage (e.g. tmpfs
4423 in Linux)
4424 Default: lock directory = /var/lib/samba/lock
4426 Example: lock directory = /var/run/samba/locks
4428 locking (S)
4430 This controls whether or not locking will be performed by the
4432 server in response to lock requests from the client.
4433 If locking = no, all lock and unlock requests will appear to
4435 succeed and all lock queries will report that the file in question
4436 is available for locking.
4437 If locking = yes, real locking will be performed by the server.
4439 This option may be useful for read-only filesystems which may not
4441 need locking (such as CDROM drives), although setting this
4442 parameter of no is not really recommended even in this case.
4443 Be careful about disabling locking either globally or in a specific
4445 service, as lack of locking may result in data corruption. You
4446 should never need to set this parameter.
4447 Default: locking = yes
4449 lock spin time (G)
4451 The time in milliseconds that smbd should keep waiting to see if a
4453 failed lock request can be granted. This parameter has changed in
4454 default value from Samba 3.0.23 from 10 to 200. The associated lock
4455 spin count parameter is no longer used in Samba 3.0.24. You should
4456 not need to change the value of this parameter.
4457 Default: lock spin time = 200
4459 log file (G)
4461 This option allows you to override the name of the Samba log file
4463 (also known as the debug file).
4464 This option takes the standard substitutions, allowing you to have
4466 separate log files for each user or machine.
4467 No default
4469 Example: log file = /usr/local/samba/var/log.%m
4471 logging (G)
4473 This parameter configures logging backends. Multiple backends can
4475 be specified at the same time, with different log levels for each
4476 backend. The parameter is a list of backends, where each backend is
4477 specified as backend[:option][@loglevel].
4478 The 'option' parameter can be used to pass backend-specific
4480 options.
4481 The log level for a backend is optional, if it is not set for a
4483 backend, all messages are sent to this backend. The parameter log
4484 level determines overall log levels, while the log levels specified
4485 here define what is sent to the individual backends.
4486 When logging is set, it overrides the syslog and syslog only
4488 parameters.
4489 Some backends are only available when Samba has been compiled with
4491 the additional libraries. The overall list of logging backends:
4492 · syslog
4494 · file
4496 · systemd
4498 · lttng
4500 · gpfs
4502 · ringbuf
4504 The ringbuf backend supports an optional size argument to change
4506 the buffer size used, the default is 1 MB: ringbuf:size=NBYTES
4507 Default: logging =
4509 Example: logging = syslog@1 file
4511 debuglevel
4513 This parameter is a synonym for log level.
4515 log level (G)
4517 The value of the parameter (a astring) allows the debug level
4519 (logging level) to be specified in the smb.conf file.
4520 This parameter has been extended since the 2.2.x series, now it
4522 allows one to specify the debug level for multiple debug classes.
4523 This is to give greater flexibility in the configuration of the
4524 system. The following debug classes are currently implemented:
4525 · all
4527 · tdb
4529 · printdrivers
4531 · lanman
4533 · smb
4535 · smb2
4537 · smb2_credits
4539 · rpc_parse
4541 · rpc_srv
4543 · rpc_cli
4545 · passdb
4547 · sam
4549 · auth
4551 · winbind
4553 · vfs
4555 · idmap
4557 · quota
4559 · acls
4561 · locking
4563 · msdfs
4565 · dmapi
4567 · registry
4569 · scavenger
4571 · dns
4573 · ldb
4575 · tevent
4577 · auth_audit
4579 · auth_json_audit
4581 · kerberos
4583 Authentication and authorization audit information is logged under
4585 the auth_audit, and if Samba is compiled against the jansson JSON
4586 library, a JSON representation is logged under auth_json_audit.
4587 Support is comprehensive for all authentication and authorisation
4589 of user accounts in the Samba Active Directory Domain Controller,
4590 as well as the implicit authentication in password changes. In the
4591 file server, NTLM authentication, SMB and RPC authorization is
4592 covered.
4593 Log levels for auth_audit and auth_audit_json are:
4595 · 2: Authentication Failure
4597 · 3: Authentication Success
4599 · 4: Authorization Success
4601 · 5: Anonymous Authentication and Authorization Success
4603 Default: log level = 0
4605 Example: log level = 3 passdb:5 auth:10 winbind:2
4607 log nt token command (G)
4609 This option can be set to a command that will be called when new nt
4611 tokens are created.
4612 This is only useful for development purposes.
4614 Default: log nt token command =
4616 logon drive (G)
4618 This parameter specifies the local path to which the home directory
4620 will be connected (see logon home) and is only used by NT
4621 Workstations.
4622 Note that this option is only useful if Samba is set up as a logon
4624 server.
4625 Default: logon drive =
4627 Example: logon drive = h:
4629 logon home (G)
4631 This parameter specifies the home directory location when a
4633 Win95/98 or NT Workstation logs into a Samba PDC. It allows you to
4634 do
4635 C:\>NET USE H: /HOME
4637 from a command prompt, for example.
4639 This option takes the standard substitutions, allowing you to have
4641 separate logon scripts for each user or machine.
4642 This parameter can be used with Win9X workstations to ensure that
4644 roaming profiles are stored in a subdirectory of the user's home
4645 directory. This is done in the following way:
4646 logon home = \\%N\%U\profile
4648 This tells Samba to return the above string, with substitutions
4650 made when a client requests the info, generally in a NetUserGetInfo
4651 request. Win9X clients truncate the info to \\server\share when a
4652 user does net use /home but use the whole string when dealing with
4653 profiles.
4654 Note that in prior versions of Samba, the logon path was returned
4656 rather than logon home. This broke net use /home but allowed
4657 profiles outside the home directory. The current implementation is
4658 correct, and can be used for profiles if you use the above trick.
4659 Disable this feature by setting logon home = "" - using the empty
4661 string.
4662 This option is only useful if Samba is set up as a logon server.
4664 Default: logon home = \\%N\%U
4666 Example: logon home = \\remote_smb_server\%U
4668 logon path (G)
4670 This parameter specifies the directory where roaming profiles
4672 (Desktop, NTuser.dat, etc) are stored. Contrary to previous
4673 versions of these manual pages, it has nothing to do with Win 9X
4674 roaming profiles. To find out how to handle roaming profiles for
4675 Win 9X system, see the logon home parameter.
4676 This option takes the standard substitutions, allowing you to have
4678 separate logon scripts for each user or machine. It also specifies
4679 the directory from which the "Application Data", desktop, start
4680 menu, network neighborhood, programs and other folders, and their
4681 contents, are loaded and displayed on your Windows NT client.
4682 The share and the path must be readable by the user for the
4684 preferences and directories to be loaded onto the Windows NT
4685 client. The share must be writeable when the user logs in for the
4686 first time, in order that the Windows NT client can create the
4687 NTuser.dat and other directories. Thereafter, the directories and
4688 any of the contents can, if required, be made read-only. It is not
4689 advisable that the NTuser.dat file be made read-only - rename it to
4690 NTuser.man to achieve the desired effect (a MANdatory profile).
4691 Windows clients can sometimes maintain a connection to the [homes]
4693 share, even though there is no user logged in. Therefore, it is
4694 vital that the logon path does not include a reference to the homes
4695 share (i.e. setting this parameter to \\%N\homes\profile_path will
4696 cause problems).
4697 This option takes the standard substitutions, allowing you to have
4699 separate logon scripts for each user or machine.
4700 Warning
4702 Do not quote the value. Setting this as “\\%N\profile\%U” will
4703 break profile handling. Where the tdbsam or ldapsam passdb
4704 backend is used, at the time the user account is created the
4705 value configured for this parameter is written to the passdb
4706 backend and that value will over-ride the parameter value
4707 present in the smb.conf file. Any error present in the passdb
4708 backend account record must be editted using the appropriate
4709 tool (pdbedit on the command-line, or any other locally
4710 provided system tool).
4711 Note that this option is only useful if Samba is set up as a domain
4712 controller.
4713 Disable the use of roaming profiles by setting the value of this
4715 parameter to the empty string. For example, logon path = "". Take
4716 note that even if the default setting in the smb.conf file is the
4717 empty string, any value specified in the user account settings in
4718 the passdb backend will over-ride the effect of setting this
4719 parameter to null. Disabling of all roaming profile use requires
4720 that the user account settings must also be blank.
4721 An example of use is:
4723 logon path = \\PROFILESERVER\PROFILE\%U
4725 Default: logon path = \\%N\%U\profile
4727 logon script (G)
4729 This parameter specifies the batch file (.bat) or NT command file
4731 (.cmd) to be downloaded and run on a machine when a user
4732 successfully logs in. The file must contain the DOS style CR/LF
4733 line endings. Using a DOS-style editor to create the file is
4734 recommended.
4735 The script must be a relative path to the [netlogon] service. If
4737 the [netlogon] service specifies a path of
4738 /usr/local/samba/netlogon, and logon script = STARTUP.BAT, then the
4739 file that will be downloaded is:
4740 /usr/local/samba/netlogon/STARTUP.BAT
4742 The contents of the batch file are entirely your choice. A
4744 suggested command would be to add NET TIME \\SERVER /SET /YES, to
4745 force every machine to synchronize clocks with the same time
4746 server. Another use would be to add NET USE U: \\SERVER\UTILS for
4747 commonly used utilities, or
4748 NET USE Q: \\SERVER\ISO9001_QA
4750 for example.
4752 Note that it is particularly important not to allow write access to
4754 the [netlogon] share, or to grant users write permission on the
4755 batch files in a secure environment, as this would allow the batch
4756 files to be arbitrarily modified and security to be breached.
4757 This option takes the standard substitutions, allowing you to have
4759 separate logon scripts for each user or machine.
4760 This option is only useful if Samba is set up as a logon server in
4762 a classic domain controller role. If Samba is set up as an Active
4763 Directory domain controller, LDAP attribute scriptPath is used
4764 instead. For configurations where passdb backend = ldapsam is in
4765 use, this option only defines a default value in case LDAP
4766 attribute sambaLogonScript is missing.
4767 Default: logon script =
4769 Example: logon script = scripts\%U.bat
4771 log writeable files on exit (G)
4773 When the network connection between a CIFS client and Samba dies,
4775 Samba has no option but to simply shut down the server side of the
4776 network connection. If this happens, there is a risk of data
4777 corruption because the Windows client did not complete all write
4778 operations that the Windows application requested. Setting this
4779 option to "yes" makes smbd log with a level 0 message a list of all
4780 files that have been opened for writing when the network connection
4781 died. Those are the files that are potentially corrupted. It is
4782 meant as an aid for the administrator to give him a list of files
4783 to do consistency checks on.
4784 Default: log writeable files on exit = no
4786 lppause command (S)
4788 This parameter specifies the command to be executed on the server
4790 host in order to stop printing or spooling a specific print job.
4791 This command should be a program or script which takes a printer
4793 name and job number to pause the print job. One way of implementing
4794 this is by using job priorities, where jobs having a too low
4795 priority won't be sent to the printer.
4796 If a %p is given then the printer name is put in its place. A %j is
4798 replaced with the job number (an integer). On HPUX (see
4799 printing=hpux ), if the -p%p option is added to the lpq command,
4800 the job will show up with the correct status, i.e. if the job
4801 priority is lower than the set fence priority it will have the
4802 PAUSED status, whereas if the priority is equal or higher it will
4803 have the SPOOLED or PRINTING status.
4804 Note that it is good practice to include the absolute path in the
4806 lppause command as the PATH may not be available to the server.
4807 Currently no default value is given to this string, unless the
4809 value of the printing parameter is SYSV, in which case the default
4810 is : lp -i %p-%j -H hold or if the value of the printing parameter
4811 is SOFTQ, then the default is: qstat -s -j%j -h.
4812 Default: lppause command = # determined by printing parameter
4814 Example: lppause command = /usr/bin/lpalt %p-%j -p0
4816 lpq cache time (G)
4818 This controls how long lpq info will be cached for to prevent the
4820 lpq command being called too often. A separate cache is kept for
4821 each variation of the lpq command used by the system, so if you use
4822 different lpq commands for different users then they won't share
4823 cache information.
4824 The cache files are stored in /tmp/lpq.xxxx where xxxx is a hash of
4826 the lpq command in use.
4827 The default is 30 seconds, meaning that the cached results of a
4829 previous identical lpq command will be used if the cached data is
4830 less than 30 seconds old. A large value may be advisable if your
4831 lpq command is very slow.
4832 A value of 0 will disable caching completely.
4834 Default: lpq cache time = 30
4836 Example: lpq cache time = 10
4838 lpq command (S)
4840 This parameter specifies the command to be executed on the server
4842 host in order to obtain lpq-style printer status information.
4843 This command should be a program or script which takes a printer
4845 name as its only parameter and outputs printer status information.
4846 Currently nine styles of printer status information are supported;
4848 BSD, AIX, LPRNG, PLP, SYSV, HPUX, QNX, CUPS, and SOFTQ. This covers
4849 most UNIX systems. You control which type is expected using the
4850 printing = option.
4851 Some clients (notably Windows for Workgroups) may not correctly
4853 send the connection number for the printer they are requesting
4854 status information about. To get around this, the server reports on
4855 the first printer service connected to by the client. This only
4856 happens if the connection number sent is invalid.
4857 If a %p is given then the printer name is put in its place.
4859 Otherwise it is placed at the end of the command.
4860 Note that it is good practice to include the absolute path in the
4862 lpq command as the $PATH may not be available to the server. When
4863 compiled with the CUPS libraries, no lpq command is needed because
4864 smbd will make a library call to obtain the print queue listing.
4865 Default: lpq command = # determined by printing parameter
4867 Example: lpq command = /usr/bin/lpq -P%p
4869 lpresume command (S)
4871 This parameter specifies the command to be executed on the server
4873 host in order to restart or continue printing or spooling a
4874 specific print job.
4875 This command should be a program or script which takes a printer
4877 name and job number to resume the print job. See also the lppause
4878 command parameter.
4879 If a %p is given then the printer name is put in its place. A %j is
4881 replaced with the job number (an integer).
4882 Note that it is good practice to include the absolute path in the
4884 lpresume command as the PATH may not be available to the server.
4885 See also the printing parameter.
4887 Default: Currently no default value is given to this string, unless
4889 the value of the printing parameter is SYSV, in which case the
4890 default is:
4891 lp -i %p-%j -H resume
4893 or if the value of the printing parameter is SOFTQ, then the
4895 default is:
4896 qstat -s -j%j -r
4898 Default: lpresume command = # determined by printing parameter
4900 Example: lpresume command = /usr/bin/lpalt %p-%j -p2
4902 lprm command (S)
4904 This parameter specifies the command to be executed on the server
4906 host in order to delete a print job.
4907 This command should be a program or script which takes a printer
4909 name and job number, and deletes the print job.
4910 If a %p is given then the printer name is put in its place. A %j is
4912 replaced with the job number (an integer).
4913 Note that it is good practice to include the absolute path in the
4915 lprm command as the PATH may not be available to the server.
4916 Examples of use are:
4918 lprm command = /usr/bin/lprm -P%p %j
4920 or
4922 lprm command = /usr/bin/cancel %p-%j
4924 Default: lprm command = # determined by printing parameter
4926 lsa over netlogon (G)
4928 Setting this deprecated option will allow the RPC server in the AD
4930 DC to answer the LSARPC interface on the \pipe\netlogon IPC pipe.
4931 When enabled, this matches the behaviour of Microsoft's Windows,
4933 due to their internal implementation choices.
4934 If it is disabled (the default), the AD DC can offer improved
4936 performance, as the netlogon server is decoupled and can run as
4937 multiple processes.
4938 Default: lsa over netlogon = no
4940 machine password timeout (G)
4942 If a Samba server is a member of a Windows NT or Active Directory
4944 Domain (see the security = domain and security = ads parameters),
4945 then periodically a running winbindd process will try and change
4946 the MACHINE ACCOUNT PASSWORD stored in the TDB called secrets.tdb.
4947 This parameter specifies how often this password will be changed,
4948 in seconds. The default is one week (expressed in seconds), the
4949 same as a Windows NT Domain member server.
4950 See also smbpasswd(8), and the security = domain and security = ads
4952 parameters.
4953 Default: machine password timeout = 604800
4955 magic output (S)
4957 This parameter specifies the name of a file which will contain
4959 output created by a magic script (see the magic script parameter
4960 below).
4961 Warning
4963 If two clients use the same magic script in the same directory
4964 the output file content is undefined.
4965 Default: magic output = # <magic script name>.out
4966 Example: magic output = myfile.txt
4968 magic script (S)
4970 This parameter specifies the name of a file which, if opened, will
4972 be executed by the server when the file is closed. This allows a
4973 UNIX script to be sent to the Samba host and executed on behalf of
4974 the connected user.
4975 Scripts executed in this way will be deleted upon completion
4977 assuming that the user has the appropriate level of privilege and
4978 the file permissions allow the deletion.
4979 If the script generates output, output will be sent to the file
4981 specified by the magic output parameter (see above).
4982 Note that some shells are unable to interpret scripts containing
4984 CR/LF instead of CR as the end-of-line marker. Magic scripts must
4985 be executable as is on the host, which for some hosts and some
4986 shells will require filtering at the DOS end.
4987 Magic scripts are EXPERIMENTAL and should NOT be relied upon.
4989 Default: magic script =
4991 Example: magic script = user.csh
4993 mangled names (S)
4995 This controls whether non-DOS names under UNIX should be mapped to
4997 DOS-compatible names ("mangled") and made visible, or whether
4998 non-DOS names should simply be ignored.
4999 See the section on name mangling for details on how to control the
5001 mangling process.
5002 Possible option settings are
5004 · yes (default) - enables name mangling for all not DOS
5006 8.3 conforming names.
5007 · no - disables any name mangling.
5009 · illegal - does mangling for names with illegal NTFS
5011 characters. This is the most sensible setting for modern
5012 clients that don't use the shortname anymore.
5013 If mangling is used then the mangling method is as follows:
5015 · The first (up to) five alphanumeric characters before
5017 the rightmost dot of the filename are preserved, forced
5018 to upper case, and appear as the first (up to) five
5019 characters of the mangled name.
5020 · A tilde "~" is appended to the first part of the mangled
5022 name, followed by a two-character unique sequence, based
5023 on the original root name (i.e., the original filename
5024 minus its final extension). The final extension is
5025 included in the hash calculation only if it contains any
5026 upper case characters or is longer than three
5027 characters.
5028 Note that the character to use may be specified using
5030 the mangling char option, if you don't like '~'.
5031 · Files whose UNIX name begins with a dot will be
5033 presented as DOS hidden files. The mangled name will be
5034 created as for other filenames, but with the leading dot
5035 removed and "___" as its extension regardless of actual
5036 original extension (that's three underscores).
5037 The two-digit hash value consists of upper case alphanumeric
5039 characters.
5040 This algorithm can cause name collisions only if files in a
5042 directory share the same first five alphanumeric characters. The
5043 probability of such a clash is 1/1300.
5044 The name mangling (if enabled) allows a file to be copied between
5046 UNIX directories from Windows/DOS while retaining the long UNIX
5047 filename. UNIX files can be renamed to a new extension from
5048 Windows/DOS and will retain the same basename. Mangled names do not
5049 change between sessions.
5050 Default: mangled names = yes
5052 Example: mangled names = illegal
5054 mangle prefix (G)
5056 controls the number of prefix characters from the original name
5058 used when generating the mangled names. A larger value will give a
5059 weaker hash and therefore more name collisions. The minimum value
5060 is 1 and the maximum value is 6.
5061 mangle prefix is effective only when mangling method is hash2.
5063 Default: mangle prefix = 1
5065 Example: mangle prefix = 4
5067 mangling char (S)
5069 This controls what character is used as the magic character in name
5071 mangling. The default is a '~' but this may interfere with some
5072 software. Use this option to set it to whatever you prefer. This is
5073 effective only when mangling method is hash.
5074 Default: mangling char = ~
5076 Example: mangling char = ^
5078 mangling method (G)
5080 controls the algorithm used for the generating the mangled names.
5082 Can take two different values, "hash" and "hash2". "hash" is the
5083 algorithm that was used in Samba for many years and was the default
5084 in Samba 2.2.x "hash2" is now the default and is newer and
5085 considered a better algorithm (generates less collisions) in the
5086 names. Many Win32 applications store the mangled names and so
5087 changing to algorithms must not be done lightly as these
5088 applications may break unless reinstalled.
5089 Default: mangling method = hash2
5091 Example: mangling method = hash
5093 map acl inherit (S)
5095 This boolean parameter controls whether smbd(8) will attempt to map
5097 the 'inherit' and 'protected' access control entry flags stored in
5098 Windows ACLs into an extended attribute called user.SAMBA_PAI. This
5099 parameter only takes effect if Samba is being run on a platform
5100 that supports extended attributes (Linux and IRIX so far) and
5101 allows the Windows 2000 ACL editor to correctly use inheritance
5102 with the Samba POSIX ACL mapping code.
5103 Default: map acl inherit = no
5105 map archive (S)
5107 This controls whether the DOS archive attribute should be mapped to
5109 the UNIX owner execute bit. The DOS archive bit is set when a file
5110 has been modified since its last backup. One motivation for this
5111 option is to keep Samba/your PC from making any file it touches
5112 from becoming executable under UNIX. This can be quite annoying for
5113 shared source code, documents, etc...
5114 Note that this parameter will be ignored if the store dos
5116 attributes parameter is set, as the DOS archive attribute will then
5117 be stored inside a UNIX extended attribute.
5118 Note that this requires the create mask parameter to be set such
5120 that owner execute bit is not masked out (i.e. it must include
5121 100). See the parameter create mask for details.
5122 Default: map archive = yes
5124 map hidden (S)
5126 This controls whether DOS style hidden files should be mapped to
5128 the UNIX world execute bit.
5129 Note that this parameter will be ignored if the store dos
5131 attributes parameter is set, as the DOS hidden attribute will then
5132 be stored inside a UNIX extended attribute.
5133 Note that this requires the create mask to be set such that the
5135 world execute bit is not masked out (i.e. it must include 001). See
5136 the parameter create mask for details.
5137 Default: map hidden = no
5139 map readonly (S)
5141 This controls how the DOS read only attribute should be mapped from
5143 a UNIX filesystem.
5144 This parameter can take three different values, which tell smbd(8)
5146 how to display the read only attribute on files, where either store
5147 dos attributes is set to No, or no extended attribute is present.
5148 If store dos attributes is set to yes then this parameter is
5149 ignored. This is a new parameter introduced in Samba version
5150 3.0.21.
5151 The three settings are :
5153 · Yes - The read only DOS attribute is mapped to the
5155 inverse of the user or owner write bit in the unix
5156 permission mode set. If the owner write bit is not set,
5157 the read only attribute is reported as being set on the
5158 file. If the read only DOS attribute is set, Samba sets
5159 the owner, group and others write bits to zero. Write
5160 bits set in an ACL are ignored by Samba. If the read
5161 only DOS attribute is unset, Samba simply sets the write
5162 bit of the owner to one.
5163 · Permissions - The read only DOS attribute is mapped to
5165 the effective permissions of the connecting user, as
5166 evaluated by smbd(8) by reading the unix permissions and
5167 POSIX ACL (if present). If the connecting user does not
5168 have permission to modify the file, the read only
5169 attribute is reported as being set on the file.
5170 · No - The read only DOS attribute is unaffected by
5172 permissions, and can only be set by the store dos
5173 attributes method. This may be useful for exporting
5174 mounted CDs.
5175 Note that this parameter will be ignored if the store dos
5177 attributes parameter is set, as the DOS 'read-only' attribute will
5178 then be stored inside a UNIX extended attribute.
5179 Default: map readonly = yes
5181 map system (S)
5183 This controls whether DOS style system files should be mapped to
5185 the UNIX group execute bit.
5186 Note that this parameter will be ignored if the store dos
5188 attributes parameter is set, as the DOS system attribute will then
5189 be stored inside a UNIX extended attribute.
5190 Note that this requires the create mask to be set such that the
5192 group execute bit is not masked out (i.e. it must include 010). See
5193 the parameter create mask for details.
5194 Default: map system = no
5196 map to guest (G)
5198 This parameter can take four different values, which tell smbd(8)
5200 what to do with user login requests that don't match a valid UNIX
5201 user in some way.
5202 The four settings are :
5204 · Never - Means user login requests with an invalid
5206 password are rejected. This is the default.
5207 · Bad User - Means user logins with an invalid password
5209 are rejected, unless the username does not exist, in
5210 which case it is treated as a guest login and mapped
5211 into the guest account.
5212 · Bad Password - Means user logins with an invalid
5214 password are treated as a guest login and mapped into
5215 the guest account. Note that this can cause problems as
5216 it means that any user incorrectly typing their password
5217 will be silently logged on as "guest" - and will not
5218 know the reason they cannot access files they think they
5219 should - there will have been no message given to them
5220 that they got their password wrong. Helpdesk services
5221 will hate you if you set the map to guest parameter this
5222 way :-).
5223 · Bad Uid - Is only applicable when Samba is configured in
5225 some type of domain mode security (security =
5226 {domain|ads}) and means that user logins which are
5227 successfully authenticated but which have no valid Unix
5228 user account (and smbd is unable to create one) should
5229 be mapped to the defined guest account. This was the
5230 default behavior of Samba 2.x releases. Note that if a
5231 member server is running winbindd, this option should
5232 never be required because the nss_winbind library will
5233 export the Windows domain users and groups to the
5234 underlying OS via the Name Service Switch interface.
5235 Note that this parameter is needed to set up "Guest" share
5237 services. This is because in these modes the name of the resource
5238 being requested is not sent to the server until after the server
5239 has successfully authenticated the client so the server cannot make
5240 authentication decisions at the correct time (connection to the
5241 share) for "Guest" shares.
5242 Default: map to guest = Never
5244 Example: map to guest = Bad User
5246 max connections (S)
5248 This option allows the number of simultaneous connections to a
5250 service to be limited. If max connections is greater than 0 then
5251 connections will be refused if this number of connections to the
5252 service are already open. A value of zero mean an unlimited number
5253 of connections may be made.
5254 Record lock files are used to implement this feature. The lock
5256 files will be stored in the directory specified by the lock
5257 directory option.
5258 Default: max connections = 0
5260 Example: max connections = 10
5262 max disk size (G)
5264 This option allows you to put an upper limit on the apparent size
5266 of disks. If you set this option to 100 then all shares will appear
5267 to be not larger than 100 MB in size.
5268 Note that this option does not limit the amount of data you can put
5270 on the disk. In the above case you could still store much more than
5271 100 MB on the disk, but if a client ever asks for the amount of
5272 free disk space or the total disk size then the result will be
5273 bounded by the amount specified in max disk size.
5274 This option is primarily useful to work around bugs in some pieces
5276 of software that can't handle very large disks, particularly disks
5277 over 1GB in size.
5278 A max disk size of 0 means no limit.
5280 Default: max disk size = 0
5282 Example: max disk size = 1000
5284 max log size (G)
5286 This option (an integer in kilobytes) specifies the max size the
5288 log file should grow to. Samba periodically checks the size and if
5289 it is exceeded it will rename the file, adding a .old extension.
5290 A size of 0 means no limit.
5292 Default: max log size = 5000
5294 Example: max log size = 1000
5296 max mux (G)
5298 This option controls the maximum number of outstanding simultaneous
5300 SMB operations that Samba tells the client it will allow. You
5301 should never need to set this parameter.
5302 Default: max mux = 50
5304 max open files (G)
5306 This parameter limits the maximum number of open files that one
5308 smbd(8) file serving process may have open for a client at any one
5309 time. This parameter can be set very high (16384) as Samba uses
5310 only one bit per unopened file. Setting this parameter lower than
5311 16384 will cause Samba to complain and set this value back to the
5312 minimum of 16384, as Windows 7 depends on this number of open file
5313 handles being available.
5314 The limit of the number of open files is usually set by the UNIX
5316 per-process file descriptor limit rather than this parameter so you
5317 should never need to touch this parameter.
5318 Default: max open files = 16384
5320 max print jobs (S)
5322 This parameter limits the maximum number of jobs allowable in a
5324 Samba printer queue at any given moment. If this number is
5325 exceeded, smbd(8) will remote "Out of Space" to the client.
5326 Default: max print jobs = 1000
5328 Example: max print jobs = 5000
5330 max reported print jobs (S)
5332 This parameter limits the maximum number of jobs displayed in a
5334 port monitor for Samba printer queue at any given moment. If this
5335 number is exceeded, the excess jobs will not be shown. A value of
5336 zero means there is no limit on the number of print jobs reported.
5337 Default: max reported print jobs = 0
5339 Example: max reported print jobs = 1000
5341 max smbd processes (G)
5343 This parameter limits the maximum number of smbd(8) processes
5345 concurrently running on a system and is intended as a stopgap to
5346 prevent degrading service to clients in the event that the server
5347 has insufficient resources to handle more than this number of
5348 connections. Remember that under normal operating conditions, each
5349 user will have an smbd(8) associated with him or her to handle
5350 connections to all shares from a given host.
5351 Default: max smbd processes = 0
5353 Example: max smbd processes = 1000
5355 max stat cache size (G)
5357 This parameter limits the size in memory of any stat cache being
5359 used to speed up case insensitive name mappings. It represents the
5360 number of kilobyte (1024) units the stat cache can use. A value of
5361 zero, meaning unlimited, is not advisable due to increased memory
5362 usage. You should not need to change this parameter.
5363 Default: max stat cache size = 256
5365 Example: max stat cache size = 100
5367 max ttl (G)
5369 This option tells nmbd(8) what the default 'time to live' of
5371 NetBIOS names should be (in seconds) when nmbd is requesting a name
5372 using either a broadcast packet or from a WINS server. You should
5373 never need to change this parameter. The default is 3 days.
5374 Default: max ttl = 259200
5376 max wins ttl (G)
5378 This option tells smbd(8) when acting as a WINS server (wins
5380 support = yes) what the maximum 'time to live' of NetBIOS names
5381 that nmbd will grant will be (in seconds). You should never need to
5382 change this parameter. The default is 6 days (518400 seconds).
5383 Default: max wins ttl = 518400
5385 max xmit (G)
5387 This option controls the maximum packet size that will be
5389 negotiated by Samba. The default is 16644, which matches the
5390 behavior of Windows 2000. A value below 2048 is likely to cause
5391 problems. You should never need to change this parameter from its
5392 default value.
5393 Default: max xmit = 16644
5395 Example: max xmit = 8192
5397 mdns name (G)
5399 This parameter controls the name that multicast DNS support
5401 advertises as its' hostname.
5402 The default is to use the NETBIOS name which is typically the
5404 hostname in all capital letters.
5405 A setting of mdns will defer the hostname configuration to the MDNS
5407 library that is used.
5408 Default: mdns name = netbios
5410 message command (G)
5412 This specifies what command to run when the server receives a
5414 WinPopup style message.
5415 This would normally be a command that would deliver the message
5417 somehow. How this is to be done is up to your imagination.
5418 An example is:
5420 message command = csh -c 'xedit %s;rm %s' &
5422 This delivers the message using xedit, then removes it afterwards.
5424 NOTE THAT IT IS VERY IMPORTANT THAT THIS COMMAND RETURN
5425 IMMEDIATELY. That's why I have the '&' on the end. If it doesn't
5426 return immediately then your PCs may freeze when sending messages
5427 (they should recover after 30 seconds, hopefully).
5428 All messages are delivered as the global guest user. The command
5430 takes the standard substitutions, although
5431 %u won't work (%U may be better in this case).
5432 Apart from the standard substitutions, some additional ones apply.
5434 In particular:
5435 · %s = the filename containing the message.
5437 · %t = the destination that the message was sent to
5439 (probably the server name).
5440 · %f = who the message is from.
5442 You could make this command send mail, or whatever else takes your
5444 fancy. Please let us know of any really interesting ideas you have.
5445 Here's a way of sending the messages as mail to root:
5447 message command = /bin/mail -s 'message from %f on %m' root < %s; rm %s
5449 If you don't have a message command then the message won't be
5451 delivered and Samba will tell the sender there was an error.
5452 Unfortunately WfWg totally ignores the error code and carries on
5453 regardless, saying that the message was delivered.
5454 If you want to silently delete it then try:
5456 message command = rm %s
5458 Default: message command =
5460 Example: message command = csh -c 'xedit %s; rm %s' &
5462 min print space (S)
5464 This sets the minimum amount of free disk space that must be
5466 available before a user will be able to spool a print job. It is
5467 specified in kilobytes. The default is 0, which means a user can
5468 always spool a print job.
5469 Default: min print space = 0
5471 Example: min print space = 2000
5473 min receivefile size (G)
5475 This option changes the behavior of smbd(8) when processing
5477 SMBwriteX calls. Any incoming SMBwriteX call on a non-signed
5478 SMB/CIFS connection greater than this value will not be processed
5479 in the normal way but will be passed to any underlying kernel
5480 recvfile or splice system call (if there is no such call Samba will
5481 emulate in user space). This allows zero-copy writes directly from
5482 network socket buffers into the filesystem buffer cache, if
5483 available. It may improve performance but user testing is
5484 recommended. If set to zero Samba processes SMBwriteX calls in the
5485 normal way. To enable POSIX large write support (SMB/CIFS writes up
5486 to 16Mb) this option must be nonzero. The maximum value is 128k.
5487 Values greater than 128k will be silently set to 128k.
5488 Note this option will have NO EFFECT if set on a SMB signed
5490 connection.
5491 The default is zero, which disables this option.
5493 Default: min receivefile size = 0
5495 min wins ttl (G)
5497 This option tells nmbd(8) when acting as a WINS server (wins
5499 support = yes) what the minimum 'time to live' of NetBIOS names
5500 that nmbd will grant will be (in seconds). You should never need to
5501 change this parameter. The default is 6 hours (21600 seconds).
5502 Default: min wins ttl = 21600
5504 mit kdc command (G)
5506 This option specifies the path to the MIT kdc binary.
5508 If the KDC is not installed in the default location and wasn't
5510 correctly detected during build then you should modify this
5511 variable and point it to the correct binary.
5512 Default: mit kdc command = /usr/sbin/krb5kdc
5514 Example: mit kdc command = /opt/mit/sbin/krb5kdc
5516 msdfs proxy (S)
5518 This parameter indicates that the share is a stand-in for another
5520 CIFS share whose location is specified by the value of the
5521 parameter. When clients attempt to connect to this share, they are
5522 redirected to one or multiple, comma separated proxied shares using
5523 the SMB-Dfs protocol.
5524 Only Dfs roots can act as proxy shares. Take a look at the msdfs
5526 root and host msdfs options to find out how to set up a Dfs root
5527 share.
5528 No default
5530 Example: msdfs proxy =
5532 \otherserver\someshare,\otherserver2\someshare
5533 msdfs root (S)
5535 If set to yes, Samba treats the share as a Dfs root and allows
5537 clients to browse the distributed file system tree rooted at the
5538 share directory. Dfs links are specified in the share directory by
5539 symbolic links of the form msdfs:serverA\\shareA,serverB\\shareB
5540 and so on. For more information on setting up a Dfs tree on Samba,
5541 refer to the MSDFS chapter in the Samba3-HOWTO book.
5542 Default: msdfs root = no
5544 msdfs shuffle referrals (S)
5546 If set to yes, Samba will shuffle Dfs referrals for a given Dfs
5548 link if multiple are available, allowing for load balancing across
5549 clients. For more information on setting up a Dfs tree on Samba,
5550 refer to the MSDFS chapter in the Samba3-HOWTO book.
5551 Default: msdfs shuffle referrals = no
5553 multicast dns register (G)
5555 If compiled with proper support for it, Samba will announce itself
5557 with multicast DNS services like for example provided by the Avahi
5558 daemon.
5559 This parameter allows disabling Samba to register itself.
5561 Default: multicast dns register = yes
5563 name cache timeout (G)
5565 Specifies the number of seconds it takes before entries in samba's
5567 hostname resolve cache time out. If the timeout is set to 0. the
5568 caching is disabled.
5569 Default: name cache timeout = 660
5571 Example: name cache timeout = 0
5573 name resolve order (G)
5575 This option is used by the programs in the Samba suite to determine
5577 what naming services to use and in what order to resolve host names
5578 to IP addresses. Its main purpose to is to control how netbios name
5579 resolution is performed. The option takes a space separated string
5580 of name resolution options.
5581 The options are: "lmhosts", "host", "wins" and "bcast". They cause
5583 names to be resolved as follows:
5584 · lmhosts : Lookup an IP address in the Samba lmhosts
5586 file. If the line in lmhosts has no name type attached
5587 to the NetBIOS name (see the manpage for lmhosts for
5588 details) then any name type matches for lookup.
5589 · host : Do a standard host name to IP address resolution,
5591 using the system /etc/hosts, NIS, or DNS lookups. This
5592 method of name resolution is operating system depended
5593 for instance on IRIX or Solaris this may be controlled
5594 by the /etc/nsswitch.conf file. Note that this method is
5595 used only if the NetBIOS name type being queried is the
5596 0x20 (server) name type or 0x1c (domain controllers).
5597 The latter case is only useful for active directory
5598 domains and results in a DNS query for the SRV RR entry
5599 matching _ldap._tcp.domain.
5600 · wins : Query a name with the IP address listed in the
5602 WINSSERVER parameter. If no WINS server has been
5603 specified this method will be ignored.
5604 · bcast : Do a broadcast on each of the known local
5606 interfaces listed in the interfaces parameter. This is
5607 the least reliable of the name resolution methods as it
5608 depends on the target host being on a locally connected
5609 subnet.
5610 The example below will cause the local lmhosts file to be examined
5612 first, followed by a broadcast attempt, followed by a normal system
5613 hostname lookup.
5614 When Samba is functioning in ADS security mode (security = ads) it
5616 is advised to use following settings for name resolve order:
5617 name resolve order = wins bcast
5619 DC lookups will still be done via DNS, but fallbacks to netbios
5621 names will not inundate your DNS servers with needless querys for
5622 DOMAIN<0x1c> lookups.
5623 Default: name resolve order = lmhosts wins host bcast
5625 Example: name resolve order = lmhosts bcast host
5627 socket address
5629 This parameter is a synonym for nbt client socket address.
5631 nbt client socket address (G)
5633 This option allows you to control what address Samba will send NBT
5635 client packets from, and process replies using, including in nmbd.
5636 Setting this option should never be necessary on usual Samba
5638 servers running only one nmbd.
5639 By default Samba will send UDP packets from the OS default address
5641 for the destination, and accept replies on 0.0.0.0.
5642 This parameter is deprecated. See bind interfaces only = Yes and
5644 interfaces for the previous behaviour of controlling the normal
5645 listening sockets.
5646 Default: nbt client socket address = 0.0.0.0
5648 Example: nbt client socket address = 192.168.2.20
5650 nbtd:wins_prepend1Bto1Cqueries (G)
5652 Normally queries for 0x1C names (all logon servers for a domain)
5654 will return the first address of the 0x1B names (domain master
5655 browser and PDC) as first address in the result list. As many
5656 client only use the first address in the list by default, all
5657 clients will use the same server (the PDC). Windows servers have an
5658 option to disable this behavior (since Windows 2000 Service Pack
5659 2).
5660 Default: nbtd:wins_prepend1Bto1Cqueries = yes
5662 nbtd:wins_wins_randomize1Clist (G)
5664 Normally queries for 0x1C names will return the addresses in the
5666 same order as they're stored in the database, that means first all
5667 addresses which have been directly registered at the local wins
5668 server and then all addresses registered at other servers. Windows
5669 servers have an option to change this behavior and randomize the
5670 returned addresses. Set this parameter to "yes" and Samba will sort
5671 the address list depending on the client address and the matching
5672 bits of the addresses, the first address is randomized based on
5673 depending on the "nbtd:wins_randomize1Clist_mask" parameter.
5674 Default: nbtd:wins_wins_randomize1Clist = no
5676 nbtd:wins_randomize1Clist_mask (G)
5678 If the "nbtd:wins_randomize1Clist" parameter is set to "yes", then
5680 randomizing of the first returned address is based on the specified
5681 netmask. If there are addresses which are in the same subnet as the
5682 client address, the first returned address is randomly chosen out
5683 them. Otherwise the first returned address is randomly chosen out
5684 of all addresses.
5685 Default: nbtd:wins_randomize1Clist_mask = 255.255.255.0
5687 nbt port (G)
5689 Specifies which port the server should use for NetBIOS over IP name
5691 services traffic.
5692 Default: nbt port = 137
5694 ncalrpc dir (G)
5696 This directory will hold a series of named pipes to allow RPC over
5698 inter-process communication.
5699 This will allow Samba and other unix processes to interact over
5701 DCE/RPC without using TCP/IP. Additionally a sub-directory 'np' has
5702 restricted permissions, and allows a trusted communication channel
5703 between Samba processes
5704 Default: ncalrpc dir = /run/samba/ncalrpc
5706 Example: ncalrpc dir = /var/run/samba/ncalrpc
5708 netbios aliases (G)
5710 This is a list of NetBIOS names that nmbd will advertise as
5712 additional names by which the Samba server is known. This allows
5713 one machine to appear in browse lists under multiple names. If a
5714 machine is acting as a browse server or logon server none of these
5715 names will be advertised as either browse server or logon servers,
5716 only the primary name of the machine will be advertised with these
5717 capabilities.
5718 Default: netbios aliases = # empty string (no additional names)
5720 Example: netbios aliases = TEST TEST1 TEST2
5722 netbios name (G)
5724 This sets the NetBIOS name by which a Samba server is known. By
5726 default it is the same as the first component of the host's DNS
5727 name. If a machine is a browse server or logon server this name (or
5728 the first component of the hosts DNS name) will be the name that
5729 these services are advertised under.
5730 Note that the maximum length for a NetBIOS name is 15 characters.
5732 There is a bug in Samba that breaks operation of browsing and
5734 access to shares if the netbios name is set to the literal name
5735 PIPE. To avoid this problem, do not name your Samba server PIPE.
5736 Default: netbios name = # machine DNS name
5738 Example: netbios name = MYNAME
5740 netbios scope (G)
5742 This sets the NetBIOS scope that Samba will operate under. This
5744 should not be set unless every machine on your LAN also sets this
5745 value.
5746 Default: netbios scope =
5748 neutralize nt4 emulation (G)
5750 This option controls whether winbindd sends the
5752 NETLOGON_NEG_NEUTRALIZE_NT4_EMULATION flag in order to bypass the
5753 NT4 emulation of a domain controller.
5754 Typically you should not need set this. It can be useful for
5756 upgrades from NT4 to AD domains.
5757 The behavior can be controlled per netbios domain by using
5759 'neutralize nt4 emulation:NETBIOSDOMAIN = yes' as option.
5760 Default: neutralize nt4 emulation = no
5762 NIS homedir (G)
5764 Get the home share server from a NIS map. For UNIX systems that use
5766 an automounter, the user's home directory will often be mounted on
5767 a workstation on demand from a remote server.
5768 When the Samba logon server is not the actual home directory
5770 server, but is mounting the home directories via NFS then two
5771 network hops would be required to access the users home directory
5772 if the logon server told the client to use itself as the SMB server
5773 for home directories (one over SMB and one over NFS). This can be
5774 very slow.
5775 This option allows Samba to return the home share as being on a
5777 different server to the logon server and as long as a Samba daemon
5778 is running on the home directory server, it will be mounted on the
5779 Samba client directly from the directory server. When Samba is
5780 returning the home share to the client, it will consult the NIS map
5781 specified in homedir map and return the server listed there.
5782 Note that for this option to work there must be a working NIS
5784 system and the Samba server with this option must also be a logon
5785 server.
5786 Default: NIS homedir = no
5788 nmbd bind explicit broadcast (G)
5790 This option causes nmbd(8) to explicitly bind to the broadcast
5792 address of the local subnets. This is needed to make nmbd work
5793 correctly in combination with the socket address option. You should
5794 not need to unset this option.
5795 Default: nmbd bind explicit broadcast = yes
5797 nsupdate command (G)
5799 This option sets the path to the nsupdate command which is used for
5801 GSS-TSIG dynamic DNS updates.
5802 Default: nsupdate command = /usr/bin/nsupdate -g
5804 nt acl support (S)
5806 This boolean parameter controls whether smbd(8) will attempt to map
5808 UNIX permissions into Windows NT access control lists. The UNIX
5809 permissions considered are the traditional UNIX owner and group
5810 permissions, as well as POSIX ACLs set on any files or directories.
5811 This parameter was formally a global parameter in releases prior to
5812 2.2.2.
5813 Default: nt acl support = yes
5815 ntlm auth (G)
5817 This parameter determines whether or not smbd(8) will attempt to
5819 authenticate users using the NTLM encrypted password response for
5820 this local passdb (SAM or account database).
5821 If disabled, both NTLM and LanMan authencication against the local
5823 passdb is disabled.
5824 Note that these settings apply only to local users, authentication
5826 will still be forwarded to and NTLM authentication accepted against
5827 any domain we are joined to, and any trusted domain, even if
5828 disabled or if NTLMv2-only is enforced here. To control NTLM
5829 authentiation for domain users, this must option must be configured
5830 on each DC.
5831 By default with lanman auth set to no and ntlm auth set to
5833 ntlmv2-only only NTLMv2 logins will be permited. Most clients
5834 support NTLMv2 by default, but some older clients will require
5835 special configuration to use it.
5836 The primary user of NTLMv1 is MSCHAPv2 for VPNs and 802.1x.
5838 The available settings are:
5840 · ntlmv1-permitted (alias yes) - Allow NTLMv1 and above
5842 for all clients.
5843 · ntlmv2-only (alias no) - Do not allow NTLMv1 to be used,
5845 but permit NTLMv2.
5846 · mschapv2-and-ntlmv2-only - Only allow NTLMv1 when the
5848 client promises that it is providing MSCHAPv2
5849 authentication (such as the ntlm_auth tool).
5850 · disabled - Do not accept NTLM (or LanMan) authentication
5852 of any level, nor permit NTLM password changes.
5853 The default changed from yes to no with Samba 4.5. The default
5855 chagned again to ntlmv2-only with Samba 4.7, however the behaviour
5856 is unchanged.
5857 Default: ntlm auth = ntlmv2-only
5859 nt pipe support (G)
5861 This boolean parameter controls whether smbd(8) will allow Windows
5863 NT clients to connect to the NT SMB specific IPC$ pipes. This is a
5864 developer debugging option and can be left alone.
5865 Default: nt pipe support = yes
5867 ntp signd socket directory (G)
5869 This setting controls the location of the socket that the NTP
5871 daemon uses to communicate with Samba for signing packets.
5872 If a non-default path is specified here, then it is also necessary
5874 to make NTP aware of the new path using the ntpsigndsocket
5875 directive in ntp.conf.
5876 Default: ntp signd socket directory = /var/lib/samba/ntp_signd
5878 nt status support (G)
5880 This boolean parameter controls whether smbd(8) will negotiate NT
5882 specific status support with Windows NT/2k/XP clients. This is a
5883 developer debugging option and should be left alone. If this option
5884 is set to no then Samba offers exactly the same DOS error codes
5885 that versions prior to Samba 2.2.3 reported.
5886 You should not need to ever disable this parameter.
5888 Default: nt status support = yes
5890 ntvfs handler (S)
5892 This specifies the NTVFS handlers for this share.
5894 · unixuid: Sets up user credentials based on POSIX
5896 gid/uid.
5897 · cifs: Proxies a remote CIFS FS. Mainly useful for
5899 testing.
5900 · nbench: Filter module that saves data useful to the
5902 nbench benchmark suite.
5903 · ipc: Allows using SMB for inter process communication.
5905 Only used for the IPC$ share.
5906 · posix: Maps POSIX FS semantics to NT semantics
5908 · print: Allows printing over SMB. This is LANMAN-style
5910 printing, not the be confused with the spoolss DCE/RPC
5911 interface used by later versions of Windows.
5912 Note that this option is only used when the NTVFS file server is in
5914 use. It is not used with the (default) s3fs file server.
5915 Default: ntvfs handler = unixuid, default
5917 null passwords (G)
5919 Allow or disallow client access to accounts that have null
5921 passwords.
5922 See also smbpasswd(5).
5924 Default: null passwords = no
5926 obey pam restrictions (G)
5928 When Samba 3.0 is configured to enable PAM support (i.e.
5930 --with-pam), this parameter will control whether or not Samba
5931 should obey PAM's account and session management directives. The
5932 default behavior is to use PAM for clear text authentication only
5933 and to ignore any account or session management. Note that Samba
5934 always ignores PAM for authentication in the case of encrypt
5935 passwords = yes. The reason is that PAM modules cannot support the
5936 challenge/response authentication mechanism needed in the presence
5937 of SMB password encryption.
5938 Default: obey pam restrictions = no
5940 old password allowed period (G)
5942 Number of minutes to permit an NTLM login after a password change
5944 or reset using the old password. This allows the user to re-cache
5945 the new password on multiple clients without disrupting a network
5946 reconnection in the meantime.
5947 This parameter only applies when server role is set to Active
5949 Directory Domain Controller
5950 Default: old password allowed period = 60
5952 oplock break wait time (G)
5954 This is a tuning parameter added due to bugs in both Windows 9x and
5956 WinNT. If Samba responds to a client too quickly when that client
5957 issues an SMB that can cause an oplock break request, then the
5958 network client can fail and not respond to the break request. This
5959 tuning parameter (which is set in milliseconds) is the amount of
5960 time Samba will wait before sending an oplock break request to such
5961 (broken) clients.
5962 Warning
5964 DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ AND
5965 UNDERSTOOD THE SAMBA OPLOCK CODE.
5966 Default: oplock break wait time = 0
5967 oplocks (S)
5969 This boolean option tells smbd whether to issue oplocks
5971 (opportunistic locks) to file open requests on this share. The
5972 oplock code can dramatically (approx. 30% or more) improve the
5973 speed of access to files on Samba servers. It allows the clients to
5974 aggressively cache files locally and you may want to disable this
5975 option for unreliable network environments (it is turned on by
5976 default in Windows NT Servers).
5977 Oplocks may be selectively turned off on certain files with a
5979 share. See the veto oplock files parameter. On some systems oplocks
5980 are recognized by the underlying operating system. This allows data
5981 synchronization between all access to oplocked files, whether it be
5982 via Samba or NFS or a local UNIX process. See the kernel oplocks
5983 parameter for details.
5984 Default: oplocks = yes
5986 os2 driver map (G)
5988 The parameter is used to define the absolute path to a file
5990 containing a mapping of Windows NT printer driver names to OS/2
5991 printer driver names. The format is:
5992 <nt driver name> = <os2 driver name>.<device name>
5994 For example, a valid entry using the HP LaserJet 5 printer driver
5996 would appear as HP LaserJet 5L = LASERJET.HP LaserJet 5L.
5997 The need for the file is due to the printer driver namespace
5999 problem described in the chapter on Classical Printing in the
6000 Samba3-HOWTO book. For more details on OS/2 clients, please refer
6001 to chapter on other clients in the Samba3-HOWTO book.
6002 Default: os2 driver map =
6004 os level (G)
6006 This integer value controls what level Samba advertises itself as
6008 for browse elections. The value of this parameter determines
6009 whether nmbd(8) has a chance of becoming a local master browser for
6010 the workgroup in the local broadcast area.
6011 Note: By default, Samba will win a local master browsing election
6013 over all Microsoft operating systems except a Windows NT 4.0/2000
6014 Domain Controller. This means that a misconfigured Samba host can
6015 effectively isolate a subnet for browsing purposes. This parameter
6016 is largely auto-configured in the Samba-3 release series and it is
6017 seldom necessary to manually override the default setting. Please
6018 refer to the chapter on Network Browsing in the Samba-3 HOWTO
6019 document for further information regarding the use of this
6020 parameter. Note: The maximum value for this parameter is 255. If
6021 you use higher values, counting will start at 0!
6022 Default: os level = 20
6024 Example: os level = 65
6026 pam password change (G)
6028 With the addition of better PAM support in Samba 2.2, this
6030 parameter, it is possible to use PAM's password change control flag
6031 for Samba. If enabled, then PAM will be used for password changes
6032 when requested by an SMB client instead of the program listed in
6033 passwd program. It should be possible to enable this without
6034 changing your passwd chat parameter for most setups.
6035 Default: pam password change = no
6037 panic action (G)
6039 This is a Samba developer option that allows a system command to be
6041 called when either smbd(8) or nmbd(8) crashes. This is usually used
6042 to draw attention to the fact that a problem occurred.
6043 Default: panic action =
6045 Example: panic action = "/bin/sleep 90000"
6047 passdb backend (G)
6049 This option allows the administrator to chose which backend will be
6051 used for storing user and possibly group information. This allows
6052 you to swap between different storage mechanisms without recompile.
6053 The parameter value is divided into two parts, the backend's name,
6055 and a 'location' string that has meaning only to that particular
6056 backed. These are separated by a : character.
6057 Available backends can include:
6059 · smbpasswd - The old plaintext passdb backend. Some Samba
6061 features will not work if this passdb backend is used.
6062 Takes a path to the smbpasswd file as an optional
6063 argument.
6064 · tdbsam - The TDB based password storage backend. Takes a
6066 path to the TDB as an optional argument (defaults to
6067 passdb.tdb in the private dir directory.
6068 · ldapsam - The LDAP based passdb backend. Takes an LDAP
6070 URL as an optional argument (defaults to
6071 ldap://localhost)
6072 LDAP connections should be secured where possible. This
6074 may be done using either Start-TLS (see ldap ssl) or by
6075 specifying ldaps:// in the URL argument.
6076 Multiple servers may also be specified in double-quotes.
6078 Whether multiple servers are supported or not and the
6079 exact syntax depends on the LDAP library you use.
6080 Examples of use are:
6083 passdb backend = tdbsam:/etc/samba/private/passdb.tdb
6085 or multi server LDAP URL with OpenLDAP library:
6087 passdb backend = ldapsam:"ldap://ldap-1.example.com ldap://ldap-2.example.com"
6089 or multi server LDAP URL with Netscape based LDAP library:
6091 passdb backend = ldapsam:"ldap://ldap-1.example.com ldap-2.example.com"
6093 Default: passdb backend = tdbsam
6095 passdb expand explicit (G)
6097 This parameter controls whether Samba substitutes %-macros in the
6099 passdb fields if they are explicitly set. We used to expand macros
6100 here, but this turned out to be a bug because the Windows client
6101 can expand a variable %G_osver% in which %G would have been
6102 substituted by the user's primary group.
6103 Default: passdb expand explicit = no
6105 passwd chat (G)
6107 This string controls the "chat" conversation that takes places
6109 between smbd(8) and the local password changing program to change
6110 the user's password. The string describes a sequence of
6111 response-receive pairs that smbd(8) uses to determine what to send
6112 to the passwd program and what to expect back. If the expected
6113 output is not received then the password is not changed.
6114 This chat sequence is often quite site specific, depending on what
6116 local methods are used for password control (such as NIS etc).
6117 Note that this parameter only is used if the unix password sync
6119 parameter is set to yes. This sequence is then called AS ROOT when
6120 the SMB password in the smbpasswd file is being changed, without
6121 access to the old password cleartext. This means that root must be
6122 able to reset the user's password without knowing the text of the
6123 previous password. In the presence of NIS/YP, this means that the
6124 passwd program must be executed on the NIS master.
6125 The string can contain the macro %n which is substituted for the
6127 new password. The old passsword (%o) is only available when encrypt
6128 passwords has been disabled. The chat sequence can also contain the
6129 standard macros \n, \r, \t and \s to give line-feed,
6130 carriage-return, tab and space. The chat sequence string can also
6131 contain a '*' which matches any sequence of characters. Double
6132 quotes can be used to collect strings with spaces in them into a
6133 single string.
6134 If the send string in any part of the chat sequence is a full stop
6136 ".", then no string is sent. Similarly, if the expect string is a
6137 full stop then no string is expected.
6138 If the pam password change parameter is set to yes, the chat pairs
6140 may be matched in any order, and success is determined by the PAM
6141 result, not any particular output. The \n macro is ignored for PAM
6142 conversions.
6143 Default: passwd chat = *new*password* %n\n *new*password* %n\n
6145 *changed*
6146 Example: passwd chat = "*Enter NEW password*" %n\n "*Reenter NEW
6148 password*" %n\n "*Password changed*"
6149 passwd chat debug (G)
6151 This boolean specifies if the passwd chat script parameter is run
6153 in debug mode. In this mode the strings passed to and received from
6154 the passwd chat are printed in the smbd(8) log with a debug level
6155 of 100. This is a dangerous option as it will allow plaintext
6156 passwords to be seen in the smbd log. It is available to help Samba
6157 admins debug their passwd chat scripts when calling the passwd
6158 program and should be turned off after this has been done. This
6159 option has no effect if the pam password change parameter is set.
6160 This parameter is off by default.
6161 Default: passwd chat debug = no
6163 passwd chat timeout (G)
6165 This integer specifies the number of seconds smbd will wait for an
6167 initial answer from a passwd chat script being run. Once the
6168 initial answer is received the subsequent answers must be received
6169 in one tenth of this time. The default it two seconds.
6170 Default: passwd chat timeout = 2
6172 passwd program (G)
6174 The name of a program that can be used to set UNIX user passwords.
6176 Any occurrences of %u will be replaced with the user name. The user
6177 name is checked for existence before calling the password changing
6178 program.
6179 Also note that many passwd programs insist in reasonable passwords,
6181 such as a minimum length, or the inclusion of mixed case chars and
6182 digits. This can pose a problem as some clients (such as Windows
6183 for Workgroups) uppercase the password before sending it.
6184 Note that if the unix password sync parameter is set to yes then
6186 this program is called AS ROOT before the SMB password in the
6187 smbpasswd file is changed. If this UNIX password change fails, then
6188 smbd will fail to change the SMB password also (this is by design).
6189 If the unix password sync parameter is set this parameter MUST USE
6191 ABSOLUTE PATHS for ALL programs called, and must be examined for
6192 security implications. Note that by default unix password sync is
6193 set to no.
6194 Default: passwd program =
6196 Example: passwd program = /bin/passwd %u
6198 password hash gpg key ids (G)
6200 If samba is running as an active directory domain controller, it is
6202 possible to store the cleartext password of accounts in a
6203 PGP/OpenGPG encrypted form.
6204 You can specify one or more recipients by key id or user id. Note
6206 that 32bit key ids are not allowed, specify at least 64bit.
6207 The value is stored as 'Primary:SambaGPG' in the
6209 supplementalCredentials attribute.
6210 As password changes can occur on any domain controller, you should
6212 configure this on each of them. Note that this feature is currently
6213 available only on Samba domain controllers.
6214 This option is only available if samba was compiled with gpgme
6216 support.
6217 You may need to export the GNUPGHOME environment variable before
6219 starting samba. It is strongly recommended to only store the
6220 public key in this location. The private key is not used for
6221 encryption and should be only stored where decryption is required.
6222 Being able to restore the cleartext password helps, when they need
6224 to be imported into other authentication systems later (see
6225 samba-tool user getpassword) or you want to keep the passwords in
6226 sync with another system, e.g. an OpenLDAP server (see samba-tool
6227 user syncpasswords).
6228 While this option needs to be configured on all domain controllers,
6230 the samba-tool user syncpasswords command should run on a single
6231 domain controller only (typically the PDC-emulator).
6232 Default: password hash gpg key ids =
6234 Example: password hash gpg key ids = 4952E40301FAB41A
6236 Example: password hash gpg key ids = selftest@samba.example.com
6238 Example: password hash gpg key ids = selftest@samba.example.com,
6240 4952E40301FAB41A
6241 password hash userPassword schemes (G)
6243 This parameter determines whether or not samba(8) acting as an
6245 Active Directory Domain Controller will attempt to store additional
6246 passwords hash types for the user
6247 The values are stored as 'Primary:userPassword' in the
6249 supplementalCredentials attribute. The value of this option is a
6250 hash type.
6251 The currently supported hash types are:
6253 · CryptSHA256
6255 · CryptSHA512
6257 Multiple instances of a hash type may be computed and stored. The
6259 password hashes are calculated using the crypt(3) call. The number
6260 of rounds used to compute the hash can be specified by adding
6261 ':rounds=xxxx' to the hash type, i.e. CryptSHA512:rounds=4500 would
6262 calculate an SHA512 hash using 4500 rounds. If not specified the
6263 Operating System defaults for crypt(3) are used.
6264 As password changes can occur on any domain controller, you should
6266 configure this on each of them. Note that this feature is currently
6267 available only on Samba domain controllers.
6268 Currently the NT Hash of the password is recorded when these hashes
6270 are calculated and stored. When retrieving the hashes the current
6271 value of the NT Hash is checked against the stored NT Hash. This
6272 detects password changes that have not updated the password hashes.
6273 In this case samba-tool user will ignore the stored hash values.
6274 Being able to obtain the hashed password helps, when they need to
6276 be imported into other authentication systems later (see samba-tool
6277 user getpassword) or you want to keep the passwords in sync with
6278 another system, e.g. an OpenLDAP server (see samba-tool user
6279 syncpasswords).
6280 Related command: unix password sync
6282 Default: password hash userPassword schemes =
6284 Example: password hash userPassword schemes = CryptSHA256
6286 Example: password hash userPassword schemes = CryptSHA256
6288 CryptSHA512
6289 Example: password hash userPassword schemes =
6291 CryptSHA256:rounds=5000 CryptSHA512:rounds=7000
6292 password server (G)
6294 By specifying the name of a domain controller with this option, and
6296 using security = [ads|domain] it is possible to get Samba to do all
6297 its username/password validation using a specific remote server.
6298 Ideally, this option should not be used, as the default '*'
6300 indicates to Samba to determine the best DC to contact dynamically,
6301 just as all other hosts in an AD domain do. This allows the domain
6302 to be maintained (addition and removal of domain controllers)
6303 without modification to the smb.conf file. The cryptographic
6304 protection on the authenticated RPC calls used to verify passwords
6305 ensures that this default is safe.
6306 It is strongly recommended that you use the default of '*', however
6308 if in your particular environment you have reason to specify a
6309 particular DC list, then the list of machines in this option must
6310 be a list of names or IP addresses of Domain controllers for the
6311 Domain. If you use the default of '*', or list several hosts in the
6312 password server option then smbd will try each in turn till it
6313 finds one that responds. This is useful in case your primary server
6314 goes down.
6315 If the list of servers contains both names/IP's and the '*'
6317 character, the list is treated as a list of preferred domain
6318 controllers, but an auto lookup of all remaining DC's will be added
6319 to the list as well. Samba will not attempt to optimize this list
6320 by locating the closest DC.
6321 If parameter is a name, it is looked up using the parameter name
6323 resolve order and so may resolved by any method and order described
6324 in that parameter.
6325 Default: password server = *
6327 Example: password server = NT-PDC, NT-BDC1, NT-BDC2, *
6329 Example: password server = windc.mydomain.com:389 192.168.1.101 *
6331 directory
6333 This parameter is a synonym for path.
6335 path (S)
6337 This parameter specifies a directory to which the user of the
6339 service is to be given access. In the case of printable services,
6340 this is where print data will spool prior to being submitted to the
6341 host for printing.
6342 For a printable service offering guest access, the service should
6344 be readonly and the path should be world-writeable and have the
6345 sticky bit set. This is not mandatory of course, but you probably
6346 won't get the results you expect if you do otherwise.
6347 Any occurrences of %u in the path will be replaced with the UNIX
6349 username that the client is using on this connection. Any
6350 occurrences of %m will be replaced by the NetBIOS name of the
6351 machine they are connecting from. These replacements are very
6352 useful for setting up pseudo home directories for users.
6353 Note that this path will be based on root dir if one was specified.
6355 Default: path =
6357 Example: path = /home/fred
6359 perfcount module (G)
6361 This parameter specifies the perfcount backend to be used when
6363 monitoring SMB operations. Only one perfcount module may be used,
6364 and it must implement all of the apis contained in the
6365 smb_perfcount_handler structure defined in smb.h.
6366 No default
6368 pid directory (G)
6370 This option specifies the directory where pid files will be placed.
6372 Default: pid directory = /run
6374 Example: pid directory = /var/run/
6376 posix locking (S)
6378 The smbd(8) daemon maintains an database of file locks obtained by
6380 SMB clients. The default behavior is to map this internal database
6381 to POSIX locks. This means that file locks obtained by SMB clients
6382 are consistent with those seen by POSIX compliant applications
6383 accessing the files via a non-SMB method (e.g. NFS or local file
6384 access). It is very unlikely that you need to set this parameter to
6385 "no", unless you are sharing from an NFS mount, which is not a good
6386 idea in the first place.
6387 Default: posix locking = yes
6389 postexec (S)
6391 This option specifies a command to be run whenever the service is
6393 disconnected. It takes the usual substitutions. The command may be
6394 run as the root on some systems.
6395 An interesting example may be to unmount server resources:
6397 postexec = /etc/umount /cdrom
6399 Default: postexec =
6401 Example: postexec = echo \"%u disconnected from %S from %m (%I)\"
6403 >> /tmp/log
6404 exec
6406 This parameter is a synonym for preexec.
6408 preexec (S)
6410 This option specifies a command to be run whenever the service is
6412 connected to. It takes the usual substitutions.
6413 An interesting example is to send the users a welcome message every
6415 time they log in. Maybe a message of the day? Here is an example:
6416 preexec = csh -c 'echo \"Welcome to %S!\" |
6418 /usr/local/samba/bin/smbclient -M %m -I %I' &
6419 Of course, this could get annoying after a while :-)
6421 See also preexec close and postexec.
6423 Default: preexec =
6425 Example: preexec = echo \"%u connected to %S from %m (%I)\" >>
6427 /tmp/log
6428 preexec close (S)
6430 This boolean option controls whether a non-zero return code from
6432 preexec should close the service being connected to.
6433 Default: preexec close = no
6435 prefered master
6437 This parameter is a synonym for preferred master.
6439 preferred master (G)
6441 This boolean parameter controls if nmbd(8) is a preferred master
6443 browser for its workgroup.
6444 If this is set to yes, on startup, nmbd will force an election, and
6446 it will have a slight advantage in winning the election. It is
6447 recommended that this parameter is used in conjunction with domain
6448 master = yes, so that nmbd can guarantee becoming a domain master.
6449 Use this option with caution, because if there are several hosts
6451 (whether Samba servers, Windows 95 or NT) that are preferred master
6452 browsers on the same subnet, they will each periodically and
6453 continuously attempt to become the local master browser. This will
6454 result in unnecessary broadcast traffic and reduced browsing
6455 capabilities.
6456 Default: preferred master = auto
6458 prefork children (G)
6460 This option controls the number of worker processes that are
6462 started for each service when prefork process model is enabled. The
6463 prefork children are only started for those services that support
6464 prefork (currently only ldap). For processes that don't support
6465 preforking all requests are handled by a single process for that
6466 service.
6467 This should be set to a small multiple of the number of CPU's
6469 available on the server
6470 Additionally the number of prefork children can be specified for an
6472 individual service by using "prefork children: service name" i.e.
6473 "prefork children:ldap = 8" to set the number of ldap worker
6474 processes.
6475 Default: prefork children = 1
6477 preload modules (G)
6479 This is a list of paths to modules that should be loaded into smbd
6481 before a client connects. This improves the speed of smbd when
6482 reacting to new connections somewhat.
6483 Default: preload modules =
6485 Example: preload modules = /usr/lib/samba/passdb/mysql.so
6487 preserve case (S)
6489 This controls if new filenames are created with the case that the
6491 client passes, or if they are forced to be the default case.
6492 See the section on NAME MANGLING for a fuller discussion.
6494 Default: preserve case = yes
6496 print ok
6498 This parameter is a synonym for printable.
6500 printable (S)
6502 If this parameter is yes, then clients may open, write to and
6504 submit spool files on the directory specified for the service.
6505 Note that a printable service will ALWAYS allow writing to the
6507 service path (user privileges permitting) via the spooling of print
6508 data. The read only parameter controls only non-printing access to
6509 the resource.
6510 Default: printable = no
6512 printcap cache time (G)
6514 This option specifies the number of seconds before the printing
6516 subsystem is again asked for the known printers.
6517 Setting this parameter to 0 disables any rescanning for new or
6519 removed printers after the initial startup.
6520 Default: printcap cache time = 750
6522 Example: printcap cache time = 600
6524 printcap
6526 This parameter is a synonym for printcap name.
6528 printcap name (G)
6530 This parameter may be used to override the compiled-in default
6532 printcap name used by the server (usually /etc/printcap). See the
6533 discussion of the [printers] section above for reasons why you
6534 might want to do this.
6535 To use the CUPS printing interface set printcap name = cups. This
6537 should be supplemented by an additional setting printing = cups in
6538 the [global] section. printcap name = cups will use the "dummy"
6539 printcap created by CUPS, as specified in your CUPS configuration
6540 file.
6541 On System V systems that use lpstat to list available printers you
6543 can use printcap name = lpstat to automatically obtain lists of
6544 available printers. This is the default for systems that define
6545 SYSV at configure time in Samba (this includes most System V based
6546 systems). If
6547 printcap name is set to lpstat on these systems then Samba will
6548 launch lpstat -v and attempt to parse the output to obtain a
6549 printer list.
6550 A minimal printcap file would look something like this:
6552 print1|My Printer 1
6554 print2|My Printer 2
6555 print3|My Printer 3
6556 print4|My Printer 4
6557 print5|My Printer 5
6558 where the '|' separates aliases of a printer. The fact that the
6560 second alias has a space in it gives a hint to Samba that it's a
6561 comment.
6562 Note
6564 Under AIX the default printcap name is /etc/qconfig. Samba will
6565 assume the file is in AIX qconfig format if the string qconfig
6566 appears in the printcap filename.
6567 Default: printcap name = /etc/printcap
6568 Example: printcap name = /etc/myprintcap
6570 print command (S)
6572 After a print job has finished spooling to a service, this command
6574 will be used via a system() call to process the spool file.
6575 Typically the command specified will submit the spool file to the
6576 host's printing subsystem, but there is no requirement that this be
6577 the case. The server will not remove the spool file, so whatever
6578 command you specify should remove the spool file when it has been
6579 processed, otherwise you will need to manually remove old spool
6580 files.
6581 The print command is simply a text string. It will be used verbatim
6583 after macro substitutions have been made:
6584 %s, %f - the path to the spool file name
6586 %p - the appropriate printer name
6588 %J - the job name as transmitted by the client.
6590 %c - The number of printed pages of the spooled job (if known).
6592 %z - the size of the spooled print job (in bytes)
6594 The print command MUST contain at least one occurrence of %s or %f
6596 - the %p is optional. At the time a job is submitted, if no printer
6597 name is supplied the %p will be silently removed from the printer
6598 command.
6599 If specified in the [global] section, the print command given will
6601 be used for any printable service that does not have its own print
6602 command specified.
6603 If there is neither a specified print command for a printable
6605 service nor a global print command, spool files will be created but
6606 not processed and (most importantly) not removed.
6607 Note that printing may fail on some UNIXes from the nobody account.
6609 If this happens then create an alternative guest account that can
6610 print and set the guest account in the [global] section.
6611 You can form quite complex print commands by realizing that they
6613 are just passed to a shell. For example the following will log a
6614 print job, print the file, then remove it. Note that ';' is the
6615 usual separator for command in shell scripts.
6616 print command = echo Printing %s >> /tmp/print.log; lpr -P %p %s;
6618 rm %s
6619 You may have to vary this command considerably depending on how you
6621 normally print files on your system. The default for the parameter
6622 varies depending on the setting of the printing parameter.
6623 Default: For printing = BSD, AIX, QNX, LPRNG or PLP :
6625 print command = lpr -r -P%p %s
6627 For printing = SYSV or HPUX :
6629 print command = lp -c -d%p %s; rm %s
6631 For printing = SOFTQ :
6633 print command = lp -d%p -s %s; rm %s
6635 For printing = CUPS : If SAMBA is compiled against libcups, then
6637 printcap = cups uses the CUPS API to submit jobs, etc. Otherwise it
6638 maps to the System V commands with the -oraw option for printing,
6639 i.e. it uses lp -c -d%p -oraw; rm %s. With printing = cups, and if
6640 SAMBA is compiled against libcups, any manually set print command
6641 will be ignored.
6642 No default
6644 Example: print command = /usr/local/samba/bin/myprintscript %p %s
6646 printer
6648 This parameter is a synonym for printer name.
6650 printer name (S)
6652 This parameter specifies the name of the printer to which print
6654 jobs spooled through a printable service will be sent.
6655 If specified in the [global] section, the printer name given will
6657 be used for any printable service that does not have its own
6658 printer name specified.
6659 The default value of the printer name may be lp on many systems.
6661 Default: printer name =
6663 Example: printer name = laserwriter
6665 printing (S)
6667 This parameters controls how printer status information is
6669 interpreted on your system. It also affects the default values for
6670 the print command, lpq command, lppause command , lpresume command,
6671 and lprm command if specified in the [global] section.
6672 Currently nine printing styles are supported. They are BSD, AIX,
6674 LPRNG, PLP, SYSV, HPUX, QNX, SOFTQ, CUPS and IPRINT.
6675 Be aware that CUPS and IPRINT are only available if the CUPS
6677 development library was available at the time Samba was compiled or
6678 packaged.
6679 To see what the defaults are for the other print commands when
6681 using the various options use the testparm(1) program.
6682 This option can be set on a per printer basis. Please be aware
6684 however, that you must place any of the various printing commands
6685 (e.g. print command, lpq command, etc...) after defining the value
6686 for the printing option since it will reset the printing commands
6687 to default values.
6688 See also the discussion in the [printers] section.
6690 See testparm -v. for the default value on your system
6692 Default: printing = # Depends on the operating system
6694 printjob username (S)
6696 This parameter specifies which user information will be passed to
6698 the printing system. Usually, the username is sent, but in some
6699 cases, e.g. the domain prefix is useful, too.
6700 Default: printjob username = %U
6702 Example: printjob username = %D\%U
6704 print notify backchannel (S)
6706 Windows print clients can update print queue status by expecting
6708 the server to open a backchannel SMB connection to them. Due to
6709 client firewall settings this can cause considerable timeouts and
6710 will often fail, as there is no guarantee the client is even
6711 running an SMB server. By default, the Samba print server will not
6712 try to connect back to clients, and will treat corresponding
6713 requests as if the connection back to the client failed.
6714 Default: print notify backchannel = no
6716 private directory
6718 This parameter is a synonym for private dir.
6720 private dir (G)
6722 This parameters defines the directory smbd will use for storing
6724 such files as smbpasswd and secrets.tdb.
6725 Default: private dir = /var/lib/samba/private
6727 queuepause command (S)
6729 This parameter specifies the command to be executed on the server
6731 host in order to pause the printer queue.
6732 This command should be a program or script which takes a printer
6734 name as its only parameter and stops the printer queue, such that
6735 no longer jobs are submitted to the printer.
6736 This command is not supported by Windows for Workgroups, but can be
6738 issued from the Printers window under Windows 95 and NT.
6739 If a %p is given then the printer name is put in its place.
6741 Otherwise it is placed at the end of the command.
6742 Note that it is good practice to include the absolute path in the
6744 command as the PATH may not be available to the server.
6745 Default: queuepause command = # determined by printing parameter
6747 Example: queuepause command = disable %p
6749 queueresume command (S)
6751 This parameter specifies the command to be executed on the server
6753 host in order to resume the printer queue. It is the command to
6754 undo the behavior that is caused by the previous parameter
6755 (queuepause command).
6756 This command should be a program or script which takes a printer
6758 name as its only parameter and resumes the printer queue, such that
6759 queued jobs are resubmitted to the printer.
6760 This command is not supported by Windows for Workgroups, but can be
6762 issued from the Printers window under Windows 95 and NT.
6763 If a %p is given then the printer name is put in its place.
6765 Otherwise it is placed at the end of the command.
6766 Note that it is good practice to include the absolute path in the
6768 command as the PATH may not be available to the server.
6769 Default: queueresume command = # determined by printing parameter
6771 Example: queueresume command = enable %p
6773 raw NTLMv2 auth (G)
6775 This parameter determines whether or not smbd(8) will allow SMB1
6777 clients without extended security (without SPNEGO) to use NTLMv2
6778 authentication.
6779 If this option, lanman auth and ntlm auth are all disabled, then
6781 only clients with SPNEGO support will be permitted. That means
6782 NTLMv2 is only supported within NTLMSSP.
6783 Default: raw NTLMv2 auth = no
6785 read list (S)
6787 This is a list of users that are given read-only access to a
6789 service. If the connecting user is in this list then they will not
6790 be given write access, no matter what the read only option is set
6791 to. The list can include group names using the syntax described in
6792 the invalid users parameter.
6793 Default: read list =
6795 Example: read list = mary, @students
6797 read only (S)
6799 An inverted synonym is writeable.
6801 If this parameter is yes, then users of a service may not create or
6803 modify files in the service's directory.
6804 Note that a printable service (printable = yes) will ALWAYS allow
6806 writing to the directory (user privileges permitting), but only via
6807 spooling operations.
6808 Default: read only = yes
6810 read raw (G)
6812 This is ignored if async smb echo handler is set, because this
6814 feature is incompatible with raw read SMB requests
6815 If enabled, raw reads allow reads of 65535 bytes in one packet.
6817 This typically provides a major performance benefit for some very,
6818 very old clients.
6819 However, some clients either negotiate the allowable block size
6821 incorrectly or are incapable of supporting larger block sizes, and
6822 for these clients you may need to disable raw reads.
6823 In general this parameter should be viewed as a system tuning tool
6825 and left severely alone.
6826 Default: read raw = yes
6828 realm (G)
6830 This option specifies the kerberos realm to use. The realm is used
6832 as the ADS equivalent of the NT4 domain. It is usually set to the
6833 DNS name of the kerberos server.
6834 Default: realm =
6836 Example: realm = mysambabox.mycompany.com
6838 registry shares (G)
6840 This turns on or off support for share definitions read from
6842 registry. Shares defined in smb.conf take precedence over shares
6843 with the same name defined in registry. See the section on
6844 registry-based configuration for details.
6845 Note that this parameter defaults to no, but it is set to yes when
6847 config backend is set to registry.
6848 Default: registry shares = no
6850 Example: registry shares = yes
6852 reject md5 clients (G)
6854 This option controls whether the netlogon server (currently only in
6856 'active directory domain controller' mode), will reject clients
6857 which does not support NETLOGON_NEG_SUPPORTS_AES.
6858 You can set this to yes if all domain members support aes. This
6860 will prevent downgrade attacks.
6861 This option takes precedence to the 'allow nt4 crypto' option.
6863 Default: reject md5 clients = no
6865 reject md5 servers (G)
6867 This option controls whether winbindd requires support for aes
6869 support for the netlogon secure channel.
6870 The following flags will be required NETLOGON_NEG_ARCFOUR,
6872 NETLOGON_NEG_SUPPORTS_AES, NETLOGON_NEG_PASSWORD_SET2 and
6873 NETLOGON_NEG_AUTHENTICATED_RPC.
6874 You can set this to yes if all domain controllers support aes. This
6876 will prevent downgrade attacks.
6877 The behavior can be controlled per netbios domain by using 'reject
6879 md5 servers:NETBIOSDOMAIN = yes' as option.
6880 This option takes precedence to the require strong key option.
6882 Default: reject md5 servers = no
6884 remote announce (G)
6886 This option allows you to setup nmbd(8) to periodically announce
6888 itself to arbitrary IP addresses with an arbitrary workgroup name.
6889 This is useful if you want your Samba server to appear in a remote
6891 workgroup for which the normal browse propagation rules don't work.
6892 The remote workgroup can be anywhere that you can send IP packets
6893 to.
6894 For example:
6896 remote announce = 192.168.2.255/SERVERS 192.168.4.255/STAFF
6898 the above line would cause nmbd to announce itself to the two given
6900 IP addresses using the given workgroup names. If you leave out the
6901 workgroup name, then the one given in the workgroup parameter is
6902 used instead.
6903 The IP addresses you choose would normally be the broadcast
6905 addresses of the remote networks, but can also be the IP addresses
6906 of known browse masters if your network config is that stable.
6907 See the chapter on Network Browsing in the Samba-HOWTO book.
6909 Default: remote announce =
6911 remote browse sync (G)
6913 This option allows you to setup nmbd(8) to periodically request
6915 synchronization of browse lists with the master browser of a Samba
6916 server that is on a remote segment. This option will allow you to
6917 gain browse lists for multiple workgroups across routed networks.
6918 This is done in a manner that does not work with any non-Samba
6919 servers.
6920 This is useful if you want your Samba server and all local clients
6922 to appear in a remote workgroup for which the normal browse
6923 propagation rules don't work. The remote workgroup can be anywhere
6924 that you can send IP packets to.
6925 For example:
6927 remote browse sync = 192.168.2.255 192.168.4.255
6929 the above line would cause nmbd to request the master browser on
6931 the specified subnets or addresses to synchronize their browse
6932 lists with the local server.
6933 The IP addresses you choose would normally be the broadcast
6935 addresses of the remote networks, but can also be the IP addresses
6936 of known browse masters if your network config is that stable. If a
6937 machine IP address is given Samba makes NO attempt to validate that
6938 the remote machine is available, is listening, nor that it is in
6939 fact the browse master on its segment.
6940 The remote browse sync may be used on networks where there is no
6942 WINS server, and may be used on disjoint networks where each
6943 network has its own WINS server.
6944 Default: remote browse sync =
6946 rename user script (G)
6948 This is the full pathname to a script that will be run as root by
6950 smbd(8) under special circumstances described below.
6951 When a user with admin authority or SeAddUserPrivilege rights
6953 renames a user (e.g.: from the NT4 User Manager for Domains), this
6954 script will be run to rename the POSIX user. Two variables, %uold
6955 and %unew, will be substituted with the old and new usernames,
6956 respectively. The script should return 0 upon successful
6957 completion, and nonzero otherwise.
6958 Note
6960 The script has all responsibility to rename all the necessary
6961 data that is accessible in this posix method. This can mean
6962 different requirements for different backends. The tdbsam and
6963 smbpasswd backends will take care of the contents of their
6964 respective files, so the script is responsible only for
6965 changing the POSIX username, and other data that may required
6966 for your circumstances, such as home directory. Please also
6967 consider whether or not you need to rename the actual home
6968 directories themselves. The ldapsam backend will not make any
6969 changes, because of the potential issues with renaming the LDAP
6970 naming attribute. In this case the script is responsible for
6971 changing the attribute that samba uses (uid) for locating
6972 users, as well as any data that needs to change for other
6973 applications using the same directory.
6974 Default: rename user script =
6975 require strong key (G)
6977 This option controls whether winbindd requires support for md5
6979 strong key support for the netlogon secure channel.
6980 The following flags will be required NETLOGON_NEG_STRONG_KEYS,
6982 NETLOGON_NEG_ARCFOUR and NETLOGON_NEG_AUTHENTICATED_RPC.
6983 You can set this to no if some domain controllers only support des.
6985 This might allows weak crypto to be negotiated, may via downgrade
6986 attacks.
6987 The behavior can be controlled per netbios domain by using 'require
6989 strong key:NETBIOSDOMAIN = no' as option.
6990 Note for active directory domain this option is hardcoded to 'yes'
6992 This option yields precedence to the reject md5 servers option.
6994 This option takes precedence to the client schannel option.
6996 Default: require strong key = yes
6998 reset on zero vc (G)
7000 This boolean option controls whether an incoming SMB1 session setup
7002 should kill other connections coming from the same IP. This matches
7003 the default Windows 2003 behaviour. Setting this parameter to yes
7004 becomes necessary when you have a flaky network and windows decides
7005 to reconnect while the old connection still has files with share
7006 modes open. These files become inaccessible over the new
7007 connection. The client sends a zero VC on the new connection, and
7008 Windows 2003 kills all other connections coming from the same IP.
7009 This way the locked files are accessible again. Please be aware
7010 that enabling this option will kill connections behind a
7011 masquerading router, and will not trigger for clients that only use
7012 SMB2 or SMB3.
7013 Default: reset on zero vc = no
7015 restrict anonymous (G)
7017 The setting of this parameter determines whether user and group
7019 list information is returned for an anonymous connection. and
7020 mirrors the effects of the
7021 HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\
7023 Control\LSA\RestrictAnonymous
7024 registry key in Windows 2000 and Windows NT. When set to 0, user
7026 and group list information is returned to anyone who asks. When set
7027 to 1, only an authenticated user can retrieve user and group list
7028 information. For the value 2, supported by Windows 2000/XP and
7029 Samba, no anonymous connections are allowed at all. This can break
7030 third party and Microsoft applications which expect to be allowed
7031 to perform operations anonymously.
7032 The security advantage of using restrict anonymous = 1 is dubious,
7034 as user and group list information can be obtained using other
7035 means.
7036 Note
7038 The security advantage of using restrict anonymous = 2 is
7039 removed by setting guest ok = yes on any share.
7040 Default: restrict anonymous = 0
7041 rndc command (G)
7043 This option specifies the path to the name server control utility.
7045 The rndc utility should be a part of the bind installation.
7047 Default: rndc command = /usr/sbin/rndc
7049 Example: rndc command = /usr/local/bind9/sbin/rndc
7051 root
7053 This parameter is a synonym for root directory.
7055 root dir
7057 This parameter is a synonym for root directory.
7059 root directory (G)
7061 The server will chroot() (i.e. Change its root directory) to this
7063 directory on startup. This is not strictly necessary for secure
7064 operation. Even without it the server will deny access to files not
7065 in one of the service entries. It may also check for, and deny
7066 access to, soft links to other parts of the filesystem, or attempts
7067 to use ".." in file names to access other directories (depending on
7068 the setting of the wide smbconfoptions parameter).
7069 Adding a root directory entry other than "/" adds an extra level of
7071 security, but at a price. It absolutely ensures that no access is
7072 given to files not in the sub-tree specified in the root directory
7073 option, including some files needed for complete operation of the
7074 server. To maintain full operability of the server you will need to
7075 mirror some system files into the root directory tree. In
7076 particular you will need to mirror /etc/passwd (or a subset of it),
7077 and any binaries or configuration files needed for printing (if
7078 required). The set of files that must be mirrored is operating
7079 system dependent.
7080 Default: root directory =
7082 Example: root directory = /homes/smb
7084 root postexec (S)
7086 This is the same as the postexec parameter except that the command
7088 is run as root. This is useful for unmounting filesystems (such as
7089 CDROMs) after a connection is closed.
7090 Default: root postexec =
7092 root preexec (S)
7094 This is the same as the preexec parameter except that the command
7096 is run as root. This is useful for mounting filesystems (such as
7097 CDROMs) when a connection is opened.
7098 Default: root preexec =
7100 root preexec close (S)
7102 This is the same as the preexec close parameter except that the
7104 command is run as root.
7105 Default: root preexec close = no
7107 rpc big endian (G)
7109 Setting this option will force the RPC client and server to
7111 transfer data in big endian.
7112 If it is disabled, data will be transferred in little endian.
7114 The behaviour is independent of the endianness of the host machine.
7116 Default: rpc big endian = no
7118 rpc_daemon:DAEMON (G)
7120 Defines whether to use the embedded code or start a separate daemon
7122 for the defined rpc services. The rpc_daemon prefix must be
7123 followed by the server name, and a value.
7124 Two possible values are currently supported:
7126 disabled
7128 fork
7129 The classic method is to run rpc services as internal daemons
7132 embedded in smbd, therefore the external daemons are disabled by
7133 default.
7134 Choosing the fork option will cause samba to fork a separate
7136 process for each daemon configured this way. Each daemon may in
7137 turn fork a number of children used to handle requests from
7138 multiple smbds and direct tcp/ip connections (if the Endpoint
7139 Mapper is enabled). Communication with smbd happens over named
7140 pipes and require that said pipes are forward to the external
7141 daemon (see rpc_server).
7142 Forked RPC Daemons support dynamically forking children to handle
7144 connections. The heuristics about how many children to keep around
7145 and how fast to allow them to fork and also how many clients each
7146 child is allowed to handle concurrently is defined by parametrical
7147 options named after the daemon. Five options are currently
7148 supported:
7149 prefork_min_children
7151 prefork_max_children
7152 prefork_spawn_rate
7153 prefork_max_allowed_clients
7154 prefork_child_min_life
7155 To set one of these options use the following syntax:
7158 daemonname:prefork_min_children = 5
7160 Samba includes separate daemons for spoolss, lsarpc/lsass,
7163 netlogon, samr, FSRVP and mdssvc(Spotlight). Currently five daemons
7164 are available and they are called:
7165 epmd
7167 lsasd
7168 spoolssd
7169 fssd
7170 mdssd
7171 Example:
7174 rpc_daemon:spoolssd = fork
7176 Default: rpc_daemon:DAEMON = disabled
7179 rpc_server:SERVER (G)
7181 With this option you can define if a rpc service should be running
7183 internal/embedded in smbd or should be redirected to an external
7184 daemon like Samba4, the endpoint mapper daemon, the spoolss daemon
7185 or the new LSA service daemon. The rpc_server prefix must be
7186 followed by the pipe name, and a value.
7187 This option can be set for each available rpc service in Samba. The
7189 following list shows all available pipe names services you can
7190 modify with this option.
7191 · epmapper - Endpoint Mapper
7193 · winreg - Remote Registry Service
7195 · srvsvc - Remote Server Services
7197 · lsarpc - Local Security Authority
7199 · samr - Security Account Management
7201 · netlogon - Netlogon Remote Protocol
7203 · netdfs - Settings for Distributed File System
7205 · dssetup - Active Directory Setup
7207 · wkssvc - Workstation Services
7209 · spoolss - Network Printing Spooler
7211 · svcctl - Service Control
7213 · ntsvcs - Plug and Play Services
7215 · eventlog - Event Logger
7217 · initshutdown - Init Shutdown Service
7219 · mdssvc - Spotlight
7221 Three possible values currently supported are:
7223 embeddedexternaldisabled
7224 The classic method is to run every pipe as an internal function
7226 embedded in smbd. The defaults may vary depending on the service.
7227 Choosing the external option allows one to run a separate daemon or
7229 even a completely independent (3rd party) server capable of
7230 interfacing with samba via the MS-RPC interface over named pipes.
7231 Currently in Samba3 we support four daemons, spoolssd, epmd, lsasd
7233 and mdssd. These daemons can be enabled using the rpc_daemon
7234 option. For spoolssd you have to enable the daemon and proxy the
7235 named pipe with:
7236 Examples:
7238 rpc_daemon:lsasd = fork
7240 rpc_server:lsarpc = external
7241 rpc_server:samr = external
7242 rpc_server:netlogon = external
7243 rpc_server:spoolss = external
7245 rpc_server:epmapper = disabled
7246 rpc_daemon:mdssd = fork
7248 rpc_server:mdssvc = external
7249 There is one special option which allows you to enable rpc services
7252 to listen for ncacn_ip_tcp connections too. Currently this is only
7253 used for testing and doesn't scale!
7254 rpc_server:tcpip = yes
7256 Default: rpc_server:SERVER = embedded
7259 rpc server dynamic port range (G)
7261 This parameter tells the RPC server which port range it is allowed
7263 to use to create a listening socket for LSA, SAM, Netlogon and
7264 others without wellknown tcp ports. The first value is the lowest
7265 number of the port range and the second the hightest.
7266 This applies to RPC servers in all server roles.
7268 Default: rpc server dynamic port range = 49152-65535
7270 rpc server port (G)
7272 Specifies which port the server should listen on for DCE/RPC over
7274 TCP/IP traffic.
7275 This controls the default port for all protocols, except for
7277 NETLOGON.
7278 If unset, the first available port from rpc server dynamic port
7280 range is used, e.g. 49152.
7281 The NETLOGON server will use the next available port, e.g. 49153.
7283 To change this port use (eg) rpc server port:netlogon = 4000.
7284 Furthermore, all RPC servers can have the port they use specified
7286 independenty, with (for example) rpc server port:drsuapi = 5000.
7287 This option applies currently only when samba(8) runs as an active
7289 directory domain controller.
7290 The default value 0 causes Samba to select the first available port
7292 from rpc server dynamic port range.
7293 Default: rpc server port = 0
7295 samba kcc command (G)
7297 This option specifies the path to the Samba KCC command. This
7299 script is used for replication topology replication.
7300 It should not be necessary to modify this option except for testing
7302 purposes or if the samba_kcc was installed in a non-default
7303 location.
7304 Default: samba kcc command =
7306 /builddir/build/BUILD/samba-4.8.3/source4/scripting/bin/samba_kcc
7307 Example: samba kcc command = /usr/local/bin/kcc
7309 security (G)
7311 This option affects how clients respond to Samba and is one of the
7313 most important settings in the smb.conf file.
7314 The default is security = user, as this is the most common setting,
7316 used for a standalone file server or a DC.
7317 The alternatives are security = ads or security = domain, which
7319 support joining Samba to a Windows domain
7320 You should use security = user and map to guest if you want to
7322 mainly setup shares without a password (guest shares). This is
7323 commonly used for a shared printer server.
7324 The different settings will now be explained.
7326 SECURITY = AUTO
7328 This is the default security setting in Samba, and causes Samba to
7330 consult the server role parameter (if set) to determine the
7331 security mode.
7332 SECURITY = USER
7334 If server role is not specified, this is the default security
7336 setting in Samba. With user-level security a client must first
7337 "log-on" with a valid username and password (which can be mapped
7338 using the username map parameter). Encrypted passwords (see the
7339 encrypted passwords parameter) can also be used in this security
7340 mode. Parameters such as user and guest only if set are then
7341 applied and may change the UNIX user to use on this connection, but
7342 only after the user has been successfully authenticated.
7343 Note that the name of the resource being requested is not sent to
7345 the server until after the server has successfully authenticated
7346 the client. This is why guest shares don't work in user level
7347 security without allowing the server to automatically map unknown
7348 users into the guest account. See the map to guest parameter for
7349 details on doing this.
7350 SECURITY = DOMAIN
7352 This mode will only work correctly if net(8) has been used to add
7354 this machine into a Windows NT Domain. It expects the encrypted
7355 passwords parameter to be set to yes. In this mode Samba will try
7356 to validate the username/password by passing it to a Windows NT
7357 Primary or Backup Domain Controller, in exactly the same way that a
7358 Windows NT Server would do.
7359 Note that a valid UNIX user must still exist as well as the account
7361 on the Domain Controller to allow Samba to have a valid UNIX
7362 account to map file access to.
7363 Note that from the client's point of view security = domain is the
7365 same as security = user. It only affects how the server deals with
7366 the authentication, it does not in any way affect what the client
7367 sees.
7368 Note that the name of the resource being requested is not sent to
7370 the server until after the server has successfully authenticated
7371 the client. This is why guest shares don't work in user level
7372 security without allowing the server to automatically map unknown
7373 users into the guest account. See the map to guest parameter for
7374 details on doing this.
7375 See also the password server parameter and the encrypted passwords
7377 parameter.
7378 SECURITY = ADS
7380 In this mode, Samba will act as a domain member in an ADS realm. To
7382 operate in this mode, the machine running Samba will need to have
7383 Kerberos installed and configured and Samba will need to be joined
7384 to the ADS realm using the net utility.
7385 Note that this mode does NOT make Samba operate as a Active
7387 Directory Domain Controller.
7388 Note that this forces require strong key = yes and client schannel
7390 = yes for the primary domain.
7391 Read the chapter about Domain Membership in the HOWTO for details.
7393 Default: security = AUTO
7395 Example: security = DOMAIN
7397 security mask (S)
7399 This parameter has been removed for Samba 4.0.0.
7401 No default
7403 max protocol
7405 This parameter is a synonym for server max protocol.
7407 protocol
7409 This parameter is a synonym for server max protocol.
7411 server max protocol (G)
7413 The value of the parameter (a string) is the highest protocol level
7415 that will be supported by the server.
7416 Possible values are :
7418 · LANMAN1: First modern version of the protocol. Long
7420 filename support.
7421 · LANMAN2: Updates to Lanman1 protocol.
7423 · NT1: Current up to date version of the protocol. Used by
7425 Windows NT. Known as CIFS.
7426 · SMB2: Re-implementation of the SMB protocol. Used by
7428 Windows Vista and later versions of Windows. SMB2 has
7429 sub protocols available.
7430 · SMB2_02: The earliest SMB2 version.
7432 · SMB2_10: Windows 7 SMB2 version.
7434 · SMB2_22: Early Windows 8 SMB2 version.
7436 · SMB2_24: Windows 8 beta SMB2 version.
7438 By default SMB2 selects the SMB2_10 variant.
7440 · SMB3: The same as SMB2. Used by Windows 8. SMB3 has sub
7442 protocols available.
7443 · SMB3_00: Windows 8 SMB3 version. (mostly the
7445 same as SMB2_24)
7446 · SMB3_02: Windows 8.1 SMB3 version.
7448 · SMB3_10: early Windows 10 technical preview
7450 SMB3 version.
7451 · SMB3_11: Windows 10 technical preview SMB3
7453 version (maybe final).
7454 By default SMB3 selects the SMB3_11 variant.
7456 Normally this option should not be set as the automatic negotiation
7458 phase in the SMB protocol takes care of choosing the appropriate
7459 protocol.
7460 Default: server max protocol = SMB3
7462 Example: server max protocol = LANMAN1
7464 min protocol
7466 This parameter is a synonym for server min protocol.
7468 server min protocol (G)
7470 This setting controls the minimum protocol version that the server
7472 will allow the client to use.
7473 Normally this option should not be set as the automatic negotiation
7475 phase in the SMB protocol takes care of choosing the appropriate
7476 protocol.
7477 See Related command: server max protocol for a full list of
7479 available protocols.
7480 Default: server min protocol = LANMAN1
7482 Example: server min protocol = NT1
7484 server multi channel support (G)
7486 This boolean parameter controls whether smbd(8) will support SMB3
7488 multi-channel.
7489 This parameter was added with version 4.4.
7491 Warning: Note that this feature is still considered experimental.
7493 Use it at your own risk: Even though it may seem to work well in
7494 testing, it may result in data corruption under some race
7495 conditions. Future releases may improve this situation.
7496 Default: server multi channel support = no
7498 server role (G)
7500 This option determines the basic operating mode of a Samba server
7502 and is one of the most important settings in the smb.conf file.
7503 The default is server role = auto, as causes Samba to operate
7505 according to the security setting, or if not specified as a simple
7506 file server that is not connected to any domain.
7507 The alternatives are server role = standalone or server role =
7509 member server, which support joining Samba to a Windows domain,
7510 along with server role = domain controller, which run Samba as a
7511 Windows domain controller.
7512 You should use server role = standalone and map to guest if you
7514 want to mainly setup shares without a password (guest shares). This
7515 is commonly used for a shared printer server.
7516 SERVER ROLE = AUTO
7518 This is the default server role in Samba, and causes Samba to
7520 consult the security parameter (if set) to determine the server
7521 role, giving compatible behaviours to previous Samba versions.
7522 SERVER ROLE = STANDALONE
7524 If security is also not specified, this is the default security
7526 setting in Samba. In standalone operation, a client must first
7527 "log-on" with a valid username and password (which can be mapped
7528 using the username map parameter) stored on this machine. Encrypted
7529 passwords (see the encrypted passwords parameter) are by default
7530 used in this security mode. Parameters such as user and guest only
7531 if set are then applied and may change the UNIX user to use on this
7532 connection, but only after the user has been successfully
7533 authenticated.
7534 SERVER ROLE = MEMBER SERVER
7536 This mode will only work correctly if net(8) has been used to add
7538 this machine into a Windows Domain. It expects the encrypted
7539 passwords parameter to be set to yes. In this mode Samba will try
7540 to validate the username/password by passing it to a Windows or
7541 Samba Domain Controller, in exactly the same way that a Windows
7542 Server would do.
7543 Note that a valid UNIX user must still exist as well as the account
7545 on the Domain Controller to allow Samba to have a valid UNIX
7546 account to map file access to. Winbind can provide this.
7547 SERVER ROLE = CLASSIC PRIMARY DOMAIN CONTROLLER
7549 This mode of operation runs a classic Samba primary domain
7551 controller, providing domain logon services to Windows and Samba
7552 clients of an NT4-like domain. Clients must be joined to the domain
7553 to create a secure, trusted path across the network. There must be
7554 only one PDC per NetBIOS scope (typcially a broadcast network or
7555 clients served by a single WINS server).
7556 SERVER ROLE = CLASSIC BACKUP DOMAIN CONTROLLER
7558 This mode of operation runs a classic Samba backup domain
7560 controller, providing domain logon services to Windows and Samba
7561 clients of an NT4-like domain. As a BDC, this allows multiple Samba
7562 servers to provide redundant logon services to a single NetBIOS
7563 scope.
7564 SERVER ROLE = ACTIVE DIRECTORY DOMAIN CONTROLLER
7566 This mode of operation runs Samba as an active directory domain
7568 controller, providing domain logon services to Windows and Samba
7569 clients of the domain. This role requires special configuration,
7570 see the Samba4 HOWTO
7571 Default: server role = AUTO
7573 Example: server role = ACTIVE DIRECTORY DOMAIN CONTROLLER
7575 server schannel (G)
7577 This option is deprecated with Samba 4.8 and will be removed in
7579 future. At the same time the default changed to yes, which will be
7580 the hardcoded behavior in future. If you have the need for the
7581 behavior of "auto" to be kept, please file a bug at
7582 https://bugzilla.samba.org.
7583 This controls whether the server offers or even demands the use of
7585 the netlogon schannel. server schannel = no does not offer the
7586 schannel, server schannel = auto offers the schannel but does not
7587 enforce it, and server schannel = yes denies access if the client
7588 is not able to speak netlogon schannel. This is only the case for
7589 Windows NT4 before SP4.
7590 Please note that with this set to no, you will have to apply the
7592 WindowsXP WinXP_SignOrSeal.reg registry patch found in the
7593 docs/registry subdirectory of the Samba distribution tarball.
7594 Default: server schannel = yes
7596 Example: server schannel = auto
7598 server services (G)
7600 This option contains the services that the Samba daemon will run.
7602 An entry in the smb.conf file can either override the previous
7604 value completely or entries can be removed from or added to it by
7605 prefixing them with + or -.
7606 Default: server services = s3fs, rpc, nbt, wrepl, ldap, cldap, kdc,
7608 drepl, winbindd, ntp_signd, kcc, dnsupdate, dns
7609 Example: server services = -s3fs, +smb
7611 server signing (G)
7613 This controls whether the client is allowed or required to use SMB1
7615 and SMB2 signing. Possible values are default, auto, mandatory and
7616 disabled.
7617 By default, and when smb signing is set to default, smb signing is
7619 required when server role is active directory domain controller and
7620 disabled otherwise.
7621 When set to auto, SMB1 signing is offered, but not enforced. When
7623 set to mandatory, SMB1 signing is required and if set to disabled,
7624 SMB signing is not offered either.
7625 For the SMB2 protocol, by design, signing cannot be disabled. In
7627 the case where SMB2 is negotiated, if this parameter is set to
7628 disabled, it will be treated as auto. Setting it to mandatory will
7629 still require SMB2 clients to use signing.
7630 Default: server signing = default
7632 server string (G)
7634 This controls what string will show up in the printer comment box
7636 in print manager and next to the IPC connection in net view. It can
7637 be any string that you wish to show to your users.
7638 It also sets what will appear in browse lists next to the machine
7640 name.
7641 A %v will be replaced with the Samba version number.
7643 A %h will be replaced with the hostname.
7645 Default: server string = Samba %v
7647 Example: server string = University of GNUs Samba Server
7649 set primary group script (G)
7651 Thanks to the Posix subsystem in NT a Windows User has a primary
7653 group in addition to the auxiliary groups. This script sets the
7654 primary group in the unix user database when an administrator sets
7655 the primary group from the windows user manager or when fetching a
7656 SAM with net rpc vampire. %u will be replaced with the user whose
7657 primary group is to be set. %g will be replaced with the group to
7658 set.
7659 Default: set primary group script =
7661 Example: set primary group script = /usr/sbin/usermod -g '%g' '%u'
7663 set quota command (G)
7665 The set quota command should only be used whenever there is no
7667 operating system API available from the OS that samba can use.
7668 This option is only available if Samba was compiled with quota
7670 support.
7671 This parameter should specify the path to a script that can set
7673 quota for the specified arguments.
7674 The specified script should take the following arguments:
7676 · 1 - path to where the quota needs to be set. This needs
7678 to be interpreted relative to the current working
7679 directory that the script may also check for.
7680 · 2 - quota type
7682 · 1 - user quotas
7684 · 2 - user default quotas (uid = -1)
7686 · 3 - group quotas
7688 · 4 - group default quotas (gid = -1)
7690 · 3 - id (uid for user, gid for group, -1 if N/A)
7693 · 4 - quota state (0 = disable, 1 = enable, 2 = enable and
7695 enforce)
7696 · 5 - block softlimit
7698 · 6 - block hardlimit
7700 · 7 - inode softlimit
7702 · 8 - inode hardlimit
7704 · 9(optional) - block size, defaults to 1024
7706 The script should output at least one line of data on success. And
7708 nothing on failure.
7709 Default: set quota command =
7711 Example: set quota command = /usr/local/sbin/set_quota
7713 share backend (G)
7715 This option specifies the backend that will be used to access the
7717 configuration of file shares.
7718 Traditionally, Samba file shares have been configured in the
7720 smb.conf file and this is still the default.
7721 At the moment there are no other supported backends.
7723 Default: share backend = classic
7725 share:fake_fscaps (G)
7727 This is needed to support some special application that makes
7729 QFSINFO calls to check whether we set the SPARSE_FILES bit (0x40).
7730 If this bit is not set that particular application refuses to work
7731 against Samba. With share:fake_fscaps = 64 the SPARSE_FILES file
7732 system capability flag is set. Use other decimal values to specify
7733 the bitmask you need to fake.
7734 Default: share:fake_fscaps = 0
7736 short preserve case (S)
7738 This boolean parameter controls if new files which conform to 8.3
7740 syntax, that is all in upper case and of suitable length, are
7741 created upper case, or if they are forced to be the default case.
7742 This option can be use with preserve case = yes to permit long
7743 filenames to retain their case, while short names are lowered.
7744 See the section on NAME MANGLING.
7746 Default: short preserve case = yes
7748 show add printer wizard (G)
7750 With the introduction of MS-RPC based printing support for Windows
7752 NT/2000 client in Samba 2.2, a "Printers..." folder will appear on
7753 Samba hosts in the share listing. Normally this folder will contain
7754 an icon for the MS Add Printer Wizard (APW). However, it is
7755 possible to disable this feature regardless of the level of
7756 privilege of the connected user.
7757 Under normal circumstances, the Windows NT/2000 client will open a
7759 handle on the printer server with OpenPrinterEx() asking for
7760 Administrator privileges. If the user does not have administrative
7761 access on the print server (i.e is not root or has granted the
7762 SePrintOperatorPrivilege), the OpenPrinterEx() call fails and the
7763 client makes another open call with a request for a lower privilege
7764 level. This should succeed, however the APW icon will not be
7765 displayed.
7766 Disabling the show add printer wizard parameter will always cause
7768 the OpenPrinterEx() on the server to fail. Thus the APW icon will
7769 never be displayed.
7770 Note
7772 This does not prevent the same user from having administrative
7773 privilege on an individual printer.
7774 Default: show add printer wizard = yes
7775 shutdown script (G)
7777 This a full path name to a script called by smbd(8) that should
7779 start a shutdown procedure.
7780 If the connected user possesses the SeRemoteShutdownPrivilege,
7782 right, this command will be run as root.
7783 The %z %t %r %f variables are expanded as follows:
7785 · %z will be substituted with the shutdown message sent to
7787 the server.
7788 · %t will be substituted with the number of seconds to
7790 wait before effectively starting the shutdown procedure.
7791 · %r will be substituted with the switch -r. It means
7793 reboot after shutdown for NT.
7794 · %f will be substituted with the switch -f. It means
7796 force the shutdown even if applications do not respond
7797 for NT.
7798 Shutdown script example:
7800 #!/bin/bash
7802 time=$2
7804 let time="${time} / 60"
7805 let time="${time} + 1"
7806 /sbin/shutdown $3 $4 +$time $1 &
7808 Shutdown does not return so we need to launch it in background.
7811 Default: shutdown script =
7813 Example: shutdown script = /usr/local/samba/sbin/shutdown %m %t %r
7815 %f
7816 smb2 leases (G)
7818 This boolean option tells smbd whether to globally negotiate SMB2
7820 leases on file open requests. Leasing is an SMB2-only feature which
7821 allows clients to aggressively cache files locally above and beyond
7822 the caching allowed by SMB1 oplocks.
7823 This is only available with oplocks = yes and kernel oplocks = no.
7825 Note that the write cache won't be used for file handles with a
7827 smb2 write lease.
7828 Default: smb2 leases = yes
7830 smb2 max credits (G)
7832 This option controls the maximum number of outstanding simultaneous
7834 SMB2 operations that Samba tells the client it will allow. This is
7835 similar to the max mux parameter for SMB1. You should never need to
7836 set this parameter.
7837 The default is 8192 credits, which is the same as a Windows 2008R2
7839 SMB2 server.
7840 Default: smb2 max credits = 8192
7842 smb2 max read (G)
7844 This option specifies the protocol value that smbd(8) will return
7846 to a client, informing the client of the largest size that may be
7847 returned by a single SMB2 read call.
7848 The maximum is 8388608 bytes (8MiB), which is the same as a Windows
7850 Server 2012 r2.
7851 Please note that the default is 8MiB, but it's limit is based on
7853 the smb2 dialect (64KiB for SMB == 2.0, 8MiB for SMB >= 2.1 with
7854 LargeMTU). Large MTU is not supported over NBT (tcp port 139).
7855 Default: smb2 max read = 8388608
7857 smb2 max trans (G)
7859 This option specifies the protocol value that smbd(8) will return
7861 to a client, informing the client of the largest size of buffer
7862 that may be used in querying file meta-data via QUERY_INFO and
7863 related SMB2 calls.
7864 The maximum is 8388608 bytes (8MiB), which is the same as a Windows
7866 Server 2012 r2.
7867 Please note that the default is 8MiB, but it's limit is based on
7869 the smb2 dialect (64KiB for SMB == 2.0, 1MiB for SMB >= 2.1 with
7870 LargeMTU). Large MTU is not supported over NBT (tcp port 139).
7871 Default: smb2 max trans = 8388608
7873 smb2 max write (G)
7875 This option specifies the protocol value that smbd(8) will return
7877 to a client, informing the client of the largest size that may be
7878 sent to the server by a single SMB2 write call.
7879 The maximum is 8388608 bytes (8MiB), which is the same as a Windows
7881 Server 2012 r2.
7882 Please note that the default is 8MiB, but it's limit is based on
7884 the smb2 dialect (64KiB for SMB == 2.0, 8MiB for SMB => 2.1 with
7885 LargeMTU). Large MTU is not supported over NBT (tcp port 139).
7886 Default: smb2 max write = 8388608
7888 smbd profiling level (G)
7890 This parameter allows the administrator to enable profiling
7892 support.
7893 Possible values are off, count and on.
7895 Default: smbd profiling level = off
7897 Example: smbd profiling level = on
7899 smb encrypt (S)
7901 This parameter controls whether a remote client is allowed or
7903 required to use SMB encryption. It has different effects depending
7904 on whether the connection uses SMB1 or SMB2 and newer:
7905 · If the connection uses SMB1, then this option controls
7907 the use of a Samba-specific extension to the SMB
7908 protocol introduced in Samba 3.2 that makes use of the
7909 Unix extensions.
7910 · If the connection uses SMB2 or newer, then this option
7912 controls the use of the SMB-level encryption that is
7913 supported in SMB version 3.0 and above and available in
7914 Windows 8 and newer.
7915 This parameter can be set globally and on a per-share bases.
7917 Possible values are off (or disabled), enabled (or auto, or
7918 if_required), desired, and required (or mandatory). A special value
7919 is default which is the implicit default setting of enabled.
7920 Effects for SMB1
7922 The Samba-specific encryption of SMB1 connections is an
7923 extension to the SMB protocol negotiated as part of the UNIX
7924 extensions. SMB encryption uses the GSSAPI (SSPI on Windows)
7925 ability to encrypt and sign every request/response in a SMB
7926 protocol stream. When enabled it provides a secure method of
7927 SMB/CIFS communication, similar to an ssh protected session,
7928 but using SMB/CIFS authentication to negotiate encryption and
7929 signing keys. Currently this is only supported smbclient of by
7930 Samba 3.2 and newer, and hopefully soon Linux CIFSFS and
7931 MacOS/X clients. Windows clients do not support this feature.
7932 This may be set on a per-share basis, but clients may chose to
7934 encrypt the entire session, not just traffic to a specific
7935 share. If this is set to mandatory then all traffic to a share
7936 must be encrypted once the connection has been made to the
7937 share. The server would return "access denied" to all
7938 non-encrypted requests on such a share. Selecting encrypted
7939 traffic reduces throughput as smaller packet sizes must be used
7940 (no huge UNIX style read/writes allowed) as well as the
7941 overhead of encrypting and signing all the data.
7942 If SMB encryption is selected, Windows style SMB signing (see
7944 the server signing option) is no longer necessary, as the
7945 GSSAPI flags use select both signing and sealing of the data.
7946 When set to auto or default, SMB encryption is offered, but not
7948 enforced. When set to mandatory, SMB encryption is required and
7949 if set to disabled, SMB encryption can not be negotiated.
7950 Effects for SMB2
7952 Native SMB transport encryption is available in SMB version 3.0
7953 or newer. It is only offered by Samba if server max protocol is
7954 set to SMB3 or newer. Clients supporting this type of
7955 encryption include Windows 8 and newer, Windows server 2012 and
7956 newer, and smbclient of Samba 4.1 and newer.
7957 The protocol implementation offers various options:
7959 · The capability to perform SMB encryption can be
7961 negotiated during protocol negotiation.
7962 · Data encryption can be enabled globally. In that
7964 case, an encryption-capable connection will have all
7965 traffic in all its sessions encrypted. In particular
7966 all share connections will be encrypted.
7967 · Data encryption can also be enabled per share if not
7969 enabled globally. For an encryption-capable
7970 connection, all connections to an encryption-enabled
7971 share will be encrypted.
7972 · Encryption can be enforced. This means that session
7974 setups will be denied on non-encryption-capable
7975 connections if data encryption has been enabled
7976 globally. And tree connections will be denied for
7977 non-encryption capable connections to shares with
7978 data encryption enabled.
7979 These features can be controlled with settings of smb encrypt
7981 as follows:
7982 · Leaving it as default, explicitly setting default,
7984 or setting it to enabled globally will enable
7985 negotiation of encryption but will not turn on data
7986 encryption globally or per share.
7987 · Setting it to desired globally will enable
7989 negotiation and will turn on data encryption on
7990 sessions and share connections for those clients
7991 that support it.
7992 · Setting it to required globally will enable
7994 negotiation and turn on data encryption on sessions
7995 and share connections. Clients that do not support
7996 encryption will be denied access to the server.
7997 · Setting it to off globally will completely disable
7999 the encryption feature for all connections. Setting
8000 smb encrypt = required for individual shares (while
8001 it's globally off) will deny access to this shares
8002 for all clients.
8003 · Setting it to desired on a share will turn on data
8005 encryption for this share for clients that support
8006 encryption if negotiation has been enabled globally.
8007 · Setting it to required on a share will enforce data
8009 encryption for this share if negotiation has been
8010 enabled globally. I.e. clients that do not support
8011 encryption will be denied access to the share.
8012 Note that this allows per-share enforcing to be
8014 controlled in Samba differently from Windows: In
8015 Windows, RejectUnencryptedAccess is a global
8016 setting, and if it is set, all shares with data
8017 encryption turned on are automatically enforcing
8018 encryption. In order to achieve the same effect in
8019 Samba, one has to globally set smb encrypt to
8020 enabled, and then set all shares that should be
8021 encrypted to required. Additionally, it is possible
8022 in Samba to have some shares with encryption
8023 required and some other shares with encryption only
8024 desired, which is not possible in Windows.
8025 · Setting it to off or enabled for a share has no
8027 effect.
8028 Default: smb encrypt = default
8031 smb passwd file (G)
8033 This option sets the path to the encrypted smbpasswd file. By
8035 default the path to the smbpasswd file is compiled into Samba.
8036 An example of use is:
8038 smb passwd file = /etc/samba/smbpasswd
8040 Default: smb passwd file = /var/lib/samba/private/smbpasswd
8042 smb ports (G)
8044 Specifies which ports the server should listen on for SMB traffic.
8046 Default: smb ports = 445 139
8048 socket options (G)
8050 Warning
8052 Modern server operating systems are tuned for high network
8053 performance in the majority of situations; when you set socket
8054 options you are overriding those settings. Linux in particular
8055 has an auto-tuning mechanism for buffer sizes that will be
8056 disabled if you specify a socket buffer size. This can
8057 potentially cripple your TCP/IP stack.
8058 Getting the socket options correct can make a big difference to
8060 your performance, but getting them wrong can degrade it by just
8061 as much. As with any other low level setting, if you must make
8062 changes to it, make small changes and test the effect before
8063 making any large changes.
8064 This option allows you to set socket options to be used when
8066 talking with the client.
8067 Socket options are controls on the networking layer of the
8069 operating systems which allow the connection to be tuned.
8070 This option will typically be used to tune your Samba server for
8072 optimal performance for your local network. There is no way that
8073 Samba can know what the optimal parameters are for your net, so you
8074 must experiment and choose them yourself. We strongly suggest you
8075 read the appropriate documentation for your operating system first
8076 (perhaps man setsockopt will help).
8077 You may find that on some systems Samba will say "Unknown socket
8079 option" when you supply an option. This means you either
8080 incorrectly typed it or you need to add an include file to
8081 includes.h for your OS. If the latter is the case please send the
8082 patch to samba-technical@lists.samba.org.
8083 Any of the supported socket options may be combined in any way you
8085 like, as long as your OS allows it.
8086 This is the list of socket options currently settable using this
8088 option:
8089 · SO_KEEPALIVE
8091 · SO_REUSEADDR
8093 · SO_BROADCAST
8095 · TCP_NODELAY
8097 · TCP_KEEPCNT *
8099 · TCP_KEEPIDLE *
8101 · TCP_KEEPINTVL *
8103 · IPTOS_LOWDELAY
8105 · IPTOS_THROUGHPUT
8107 · SO_REUSEPORT
8109 · SO_SNDBUF *
8111 · SO_RCVBUF *
8113 · SO_SNDLOWAT *
8115 · SO_RCVLOWAT *
8117 · SO_SNDTIMEO *
8119 · SO_RCVTIMEO *
8121 · TCP_FASTACK *
8123 · TCP_QUICKACK
8125 · TCP_NODELAYACK
8127 · TCP_KEEPALIVE_THRESHOLD *
8129 · TCP_KEEPALIVE_ABORT_THRESHOLD *
8131 · TCP_DEFER_ACCEPT *
8133 Those marked with a '*' take an integer argument. The others can
8135 optionally take a 1 or 0 argument to enable or disable the option,
8136 by default they will be enabled if you don't specify 1 or 0.
8137 To specify an argument use the syntax SOME_OPTION = VALUE for
8139 example SO_SNDBUF = 8192. Note that you must not have any spaces
8140 before or after the = sign.
8141 If you are on a local network then a sensible option might be:
8143 socket options = IPTOS_LOWDELAY
8145 If you have a local network then you could try:
8147 socket options = IPTOS_LOWDELAY TCP_NODELAY
8149 If you are on a wide area network then perhaps try setting
8151 IPTOS_THROUGHPUT.
8152 Note that several of the options may cause your Samba server to
8154 fail completely. Use these options with caution!
8155 Default: socket options = TCP_NODELAY
8157 Example: socket options = IPTOS_LOWDELAY
8159 spn update command (G)
8161 This option sets the command that for updating servicePrincipalName
8163 names from spn_update_list.
8164 Default: spn update command =
8166 /builddir/build/BUILD/samba-4.8.3/source4/scripting/bin/samba_spnupdate
8167 Example: spn update command = /usr/local/sbin/spnupdate
8169 spoolss: architecture (G)
8171 Windows spoolss print clients only allow association of server-side
8173 drivers with printers when the driver architecture matches the
8174 advertised print server architecture. Samba's spoolss print server
8175 architecture can be changed using this parameter.
8176 Default: spoolss: architecture = Windows NT x86
8178 Example: spoolss: architecture = Windows x64
8180 spoolss: os_major (G)
8182 Windows might require a new os version number. This option allows
8184 to modify the build number. The complete default version number is:
8185 5.0.2195 (Windows 2000). The example is 6.1.7601 (Windows 2008 R2).
8186 Default: spoolss: os_major = 5
8188 Example: spoolss: os_major = 6
8190 spoolss: os_minor (G)
8192 Windows might require a new os version number. This option allows
8194 to modify the build number. The complete default version number is:
8195 5.0.2195 (Windows 2000). The example is 6.1.7601 (Windows 2008 R2).
8196 Default: spoolss: os_minor = 0
8198 Example: spoolss: os_minor = 1
8200 spoolss: os_build (G)
8202 Windows might require a new os version number. This option allows
8204 to modify the build number. The complete default version number is:
8205 5.0.2195 (Windows 2000). The example is 6.1.7601 (Windows 2008 R2).
8206 Default: spoolss: os_build = 2195
8208 Example: spoolss: os_build = 7601
8210 spotlight (S)
8212 This parameter controls whether Samba allows Spotlight queries on a
8214 share. For controlling indexing of filesystems you also have to use
8215 Tracker's own configuration system.
8216 Spotlight has several prerequisites:
8218 · Samba must be configured and built with Spotlight
8220 support.
8221 · The mdssvc RPC service must be enabled, see below.
8223 · Tracker intergration must be setup and the share must be
8225 indexed by Tracker.
8226 For a detailed set of instructions please see
8228 https://wiki.samba.org/index.php/Spotlight.
8229 The Spotlight RPC service can either be enabled as embedded RPC
8231 service:
8232 [Global]
8234 rpc_server:mdsvc = embedded
8235 Or it can be run in a separate RPC service daemon:
8237 [Global]
8239 rpc_server:mdssd = fork
8240 rpc_server:mdsvc = external
8241 Default: spotlight = no
8243 stat cache (G)
8245 This parameter determines if smbd(8) will use a cache in order to
8247 speed up case insensitive name mappings. You should never need to
8248 change this parameter.
8249 Default: stat cache = yes
8251 state directory (G)
8253 Usually, most of the TDB files are stored in the lock directory.
8255 Since Samba 3.4.0, it is possible to differentiate between TDB
8256 files with persistent data and TDB files with non-persistent data
8257 using the state directory and the cache directory options.
8258 This option specifies the directory where TDB files containing
8260 important persistent data will be stored.
8261 Default: state directory = /var/lib/samba
8263 Example: state directory = /var/run/samba/locks/state
8265 store dos attributes (S)
8267 If this parameter is set Samba attempts to first read DOS
8269 attributes (SYSTEM, HIDDEN, ARCHIVE or READ-ONLY) from a filesystem
8270 extended attribute, before mapping DOS attributes to UNIX
8271 permission bits (such as occurs with map hidden and map readonly).
8272 When set, DOS attributes will be stored onto an extended attribute
8273 in the UNIX filesystem, associated with the file or directory. When
8274 this parameter is set it will override the parameters map hidden,
8275 map system, map archive and map readonly and they will behave as if
8276 they were set to off. This parameter writes the DOS attributes as a
8277 string into the extended attribute named "user.DOSATTRIB". This
8278 extended attribute is explicitly hidden from smbd clients
8279 requesting an EA list. On Linux the filesystem must have been
8280 mounted with the mount option user_xattr in order for extended
8281 attributes to work, also extended attributes must be compiled into
8282 the Linux kernel. In Samba 3.5.0 and above the "user.DOSATTRIB"
8283 extended attribute has been extended to store the create time for a
8284 file as well as the DOS attributes. This is done in a backwards
8285 compatible way so files created by Samba 3.5.0 and above can still
8286 have the DOS attribute read from this extended attribute by earlier
8287 versions of Samba, but they will not be able to read the create
8288 time stored there. Storing the create time separately from the
8289 normal filesystem meta-data allows Samba to faithfully reproduce
8290 NTFS semantics on top of a POSIX filesystem.
8291 Default: store dos attributes = no
8293 strict allocate (S)
8295 This is a boolean that controls the handling of disk space
8297 allocation in the server. When this is set to yes the server will
8298 change from UNIX behaviour of not committing real disk storage
8299 blocks when a file is extended to the Windows behaviour of actually
8300 forcing the disk system to allocate real storage blocks when a file
8301 is created or extended to be a given size. In UNIX terminology this
8302 means that Samba will stop creating sparse files.
8303 This option is really designed for file systems that support fast
8305 allocation of large numbers of blocks such as extent-based file
8306 systems. On file systems that don't support extents (most notably
8307 ext3) this can make Samba slower. When you work with large files
8308 over >100MB on file systems without extents you may even run into
8309 problems with clients running into timeouts.
8310 When you have an extent based filesystem it's likely that we can
8312 make use of unwritten extents which allows Samba to allocate even
8313 large amounts of space very fast and you will not see any timeout
8314 problems caused by strict allocate. With strict allocate in use you
8315 will also get much better out of quota messages in case you use
8316 quotas. Another advantage of activating this setting is that it
8317 will help to reduce file fragmentation.
8318 To give you an idea on which filesystems this setting might
8320 currently be a good option for you: XFS, ext4, btrfs, ocfs2 on
8321 Linux and JFS2 on AIX support unwritten extents. On Filesystems
8322 that do not support it, preallocation is probably an expensive
8323 operation where you will see reduced performance and risk to let
8324 clients run into timeouts when creating large files. Examples are
8325 ext3, ZFS, HFS+ and most others, so be aware if you activate this
8326 setting on those filesystems.
8327 Default: strict allocate = no
8329 strict locking (S)
8331 This is an enumerated type that controls the handling of file
8333 locking in the server. When this is set to yes, the server will
8334 check every read and write access for file locks, and deny access
8335 if locks exist. This can be slow on some systems.
8336 When strict locking is set to Auto (the default), the server
8338 performs file lock checks only on non-oplocked files. As most
8339 Windows redirectors perform file locking checks locally on oplocked
8340 files this is a good trade off for improved performance.
8341 When strict locking is disabled, the server performs file lock
8343 checks only when the client explicitly asks for them.
8344 Well-behaved clients always ask for lock checks when it is
8346 important. So in the vast majority of cases, strict locking = Auto
8347 or strict locking = no is acceptable.
8348 Default: strict locking = Auto
8350 strict rename (S)
8352 By default a Windows SMB server prevents directory renames when
8354 there are open file or directory handles below it in the filesystem
8355 hierarchy. Historically Samba has always allowed this as POSIX
8356 filesystem semantics require it.
8357 This boolean parameter allows Samba to match the Windows behavior.
8359 Setting this to "yes" is a very expensive change, as it forces
8360 Samba to travers the entire open file handle database on every
8361 directory rename request. In a clustered Samba system the cost is
8362 even greater than the non-clustered case.
8363 When set to "no" smbd only checks the local process the client is
8365 attached to for open files below a directory being renamed, instead
8366 of checking for open files across all smbd processes.
8367 Because of the expense in fully searching the database, the default
8369 is "no", and it is recommended to be left that way unless a
8370 specific Windows application requires it to be changed.
8371 If the client has requested UNIX extensions (POSIX pathnames) then
8373 renames are always allowed and this parameter has no effect.
8374 Default: strict rename = no
8376 strict sync (S)
8378 This parameter controls whether Samba honors a request from an SMB
8380 client to ensure any outstanding operating system buffer contents
8381 held in memory are safely written onto stable storage on disk. If
8382 set to yes, which is the default, then Windows applications can
8383 force the smbd server to synchronize unwritten data onto the disk.
8384 If set to no then smbd will ignore client requests to synchronize
8385 unwritten data onto stable storage on disk.
8386 In Samba 4.7.0, the default for this parameter changed from no to
8388 yes to better match the expectations of SMB2/3 clients and improve
8389 application safety when running against smbd.
8390 The flush request from SMB2/3 clients is handled asynchronously
8392 inside smbd, so leaving the parameter as the default value of yes
8393 does not block the processing of other requests to the smbd
8394 process.
8395 Legacy Windows applications (such as the Windows 98 explorer shell)
8397 seemed to confuse writing buffer contents to the operating system
8398 with synchronously writing outstanding data onto stable storage on
8399 disk. Changing this parameter to no means that smbd(8) will ignore
8400 the Windows applications request to synchronize unwritten data onto
8401 disk. Only consider changing this if smbd is serving obsolete SMB1
8402 Windows clients prior to Windows XP (Windows 98 and below). There
8403 should be no need to change this setting for normal operations.
8404 Default: strict sync = yes
8406 svcctl list (G)
8408 This option defines a list of init scripts that smbd will use for
8410 starting and stopping Unix services via the Win32 ServiceControl
8411 API. This allows Windows administrators to utilize the MS
8412 Management Console plug-ins to manage a Unix server running Samba.
8413 The administrator must create a directory name svcctl in Samba's
8415 $(libdir) and create symbolic links to the init scripts in
8416 /etc/init.d/. The name of the links must match the names given as
8417 part of the svcctl list.
8418 Default: svcctl list =
8420 Example: svcctl list = cups postfix portmap httpd
8422 sync always (S)
8424 This is a boolean parameter that controls whether writes will
8426 always be written to stable storage before the write call returns.
8427 If this is no then the server will be guided by the client's
8428 request in each write call (clients can set a bit indicating that a
8429 particular write should be synchronous). If this is yes then every
8430 write will be followed by a fsync() call to ensure the data is
8431 written to disk. Note that the strict sync parameter must be set to
8432 yes in order for this parameter to have any effect.
8433 Default: sync always = no
8435 syslog (G)
8437 This parameter maps how Samba debug messages are logged onto the
8439 system syslog logging levels. Samba debug level zero maps onto
8440 syslog LOG_ERR, debug level one maps onto LOG_WARNING, debug level
8441 two maps onto LOG_NOTICE, debug level three maps onto LOG_INFO. All
8442 higher levels are mapped to LOG_DEBUG.
8443 This parameter sets the threshold for sending messages to syslog.
8445 Only messages with debug level less than this value will be sent to
8446 syslog. There still will be some logging to log.[sn]mbd even if
8447 syslog only is enabled.
8448 The logging parameter should be used instead. When logging is set,
8450 it overrides the syslog parameter.
8451 Default: syslog = 1
8453 syslog only (G)
8455 If this parameter is set then Samba debug messages are logged into
8457 the system syslog only, and not to the debug log files. There still
8458 will be some logging to log.[sn]mbd even if syslog only is enabled.
8459 The logging parameter should be used instead. When logging is set,
8461 it overrides the syslog only parameter.
8462 Default: syslog only = no
8464 template homedir (G)
8466 When filling out the user information for a Windows NT user, the
8468 winbindd(8) daemon uses this parameter to fill in the home
8469 directory for that user. If the string %D is present it is
8470 substituted with the user's Windows NT domain name. If the string
8471 %U is present it is substituted with the user's Windows NT user
8472 name.
8473 Default: template homedir = /home/%D/%U
8475 template shell (G)
8477 When filling out the user information for a Windows NT user, the
8479 winbindd(8) daemon uses this parameter to fill in the login shell
8480 for that user.
8481 Default: template shell = /bin/false
8483 time server (G)
8485 This parameter determines if nmbd(8) advertises itself as a time
8487 server to Windows clients.
8488 Default: time server = no
8490 debug timestamp
8492 This parameter is a synonym for timestamp logs.
8494 timestamp logs (G)
8496 Samba debug log messages are timestamped by default. If you are
8498 running at a high debug level these timestamps can be distracting.
8499 This boolean parameter allows timestamping to be turned off.
8500 Default: timestamp logs = yes
8502 tls cafile (G)
8504 This option can be set to a file (PEM format) containing CA
8506 certificates of root CAs to trust to sign certificates or
8507 intermediate CA certificates.
8508 This path is relative to private dir if the path does not start
8510 with a /.
8511 Default: tls cafile = tls/ca.pem
8513 tls certfile (G)
8515 This option can be set to a file (PEM format) containing the RSA
8517 certificate.
8518 This path is relative to private dir if the path does not start
8520 with a /.
8521 Default: tls certfile = tls/cert.pem
8523 tls crlfile (G)
8525 This option can be set to a file containing a certificate
8527 revocation list (CRL).
8528 This path is relative to private dir if the path does not start
8530 with a /.
8531 Default: tls crlfile =
8533 tls dh params file (G)
8535 This option can be set to a file with Diffie-Hellman parameters
8537 which will be used with DH ciphers.
8538 This path is relative to private dir if the path does not start
8540 with a /.
8541 Default: tls dh params file =
8543 tls enabled (G)
8545 If this option is set to yes, then Samba will use TLS when possible
8547 in communication.
8548 Default: tls enabled = yes
8550 tls keyfile (G)
8552 This option can be set to a file (PEM format) containing the RSA
8554 private key. This file must be accessible without a pass-phrase,
8555 i.e. it must not be encrypted.
8556 This path is relative to private dir if the path does not start
8558 with a /.
8559 Default: tls keyfile = tls/key.pem
8561 tls priority (G)
8563 This option can be set to a string describing the TLS protocols to
8565 be supported in the parts of Samba that use GnuTLS, specifically
8566 the AD DC.
8567 The default turns off SSLv3, as this protocol is no longer
8569 considered secure after CVE-2014-3566 (otherwise known as POODLE)
8570 impacted SSLv3 use in HTTPS applications.
8571 The valid options are described in the GNUTLS Priority-Strings
8573 documentation at
8574 http://gnutls.org/manual/html_node/Priority-Strings.html
8575 Default: tls priority = NORMAL:-VERS-SSL3.0
8577 tls verify peer (G)
8579 This controls if and how strict the client will verify the peer's
8581 certificate and name. Possible values are (in increasing order):
8582 no_check, ca_only, ca_and_name_if_available, ca_and_name and
8583 as_strict_as_possible.
8584 When set to no_check the certificate is not verified at all, which
8586 allows trivial man in the middle attacks.
8587 When set to ca_only the certificate is verified to be signed from a
8589 ca specified in the tls ca file option. Setting tls ca file to a
8590 valid file is required. The certificate lifetime is also verified.
8591 If the tls crl file option is configured, the certificate is also
8592 verified against the ca crl.
8593 When set to ca_and_name_if_available all checks from ca_only are
8595 performed. In addition, the peer hostname is verified against the
8596 certificate's name, if it is provided by the application layer and
8597 not given as an ip address string.
8598 When set to ca_and_name all checks from ca_and_name_if_available
8600 are performed. In addition the peer hostname needs to be provided
8601 and even an ip address is checked against the certificate's name.
8602 When set to as_strict_as_possible all checks from ca_and_name are
8604 performed. In addition the tls crl file needs to be configured.
8605 Future versions of Samba may implement additional checks.
8606 Default: tls verify peer = as_strict_as_possible
8608 unicode (G)
8610 Specifies whether the server and client should support unicode.
8612 If this option is set to false, the use of ASCII will be forced.
8614 Default: unicode = yes
8616 unix charset (G)
8618 Specifies the charset the unix machine Samba runs on uses. Samba
8620 needs to know this in order to be able to convert text to the
8621 charsets other SMB clients use.
8622 This is also the charset Samba will use when specifying arguments
8624 to scripts that it invokes.
8625 Default: unix charset = UTF-8
8627 Example: unix charset = ASCII
8629 unix extensions (G)
8631 This boolean parameter controls whether Samba implements the CIFS
8633 UNIX extensions, as defined by HP. These extensions enable Samba to
8634 better serve UNIX CIFS clients by supporting features such as
8635 symbolic links, hard links, etc... These extensions require a
8636 similarly enabled client, and are of no current use to Windows
8637 clients.
8638 Note if this parameter is turned on, the wide links parameter will
8640 automatically be disabled.
8641 See the parameter allow insecure wide links if you wish to change
8643 this coupling between the two parameters.
8644 Default: unix extensions = yes
8646 unix password sync (G)
8648 This boolean parameter controls whether Samba attempts to
8650 synchronize the UNIX password with the SMB password when the
8651 encrypted SMB password in the smbpasswd file is changed. If this is
8652 set to yes the program specified in the passwd program parameter is
8653 called AS ROOT - to allow the new UNIX password to be set without
8654 access to the old UNIX password (as the SMB password change code
8655 has no access to the old password cleartext, only the new).
8656 This option has no effect if samba is running as an active
8658 directory domain controller, in that case have a look at the
8659 password hash gpg key ids option and the samba-tool user
8660 syncpasswords command.
8661 Default: unix password sync = no
8663 use client driver (S)
8665 This parameter applies only to Windows NT/2000 clients. It has no
8667 effect on Windows 95/98/ME clients. When serving a printer to
8668 Windows NT/2000 clients without first installing a valid printer
8669 driver on the Samba host, the client will be required to install a
8670 local printer driver. From this point on, the client will treat the
8671 print as a local printer and not a network printer connection. This
8672 is much the same behavior that will occur when disable spoolss =
8673 yes.
8674 The differentiating factor is that under normal circumstances, the
8676 NT/2000 client will attempt to open the network printer using
8677 MS-RPC. The problem is that because the client considers the
8678 printer to be local, it will attempt to issue the OpenPrinterEx()
8679 call requesting access rights associated with the logged on user.
8680 If the user possesses local administrator rights but not root
8681 privilege on the Samba host (often the case), the OpenPrinterEx()
8682 call will fail. The result is that the client will now display an
8683 "Access Denied; Unable to connect" message in the printer queue
8684 window (even though jobs may successfully be printed).
8685 If this parameter is enabled for a printer, then any attempt to
8687 open the printer with the PRINTER_ACCESS_ADMINISTER right is mapped
8688 to PRINTER_ACCESS_USE instead. Thus allowing the OpenPrinterEx()
8689 call to succeed. This parameter MUST not be enabled on a print
8690 share which has valid print driver installed on the Samba server.
8691 Default: use client driver = no
8693 use mmap (G)
8695 This global parameter determines if the tdb internals of Samba can
8697 depend on mmap working correctly on the running system. Samba
8698 requires a coherent mmap/read-write system memory cache. Currently
8699 only HPUX does not have such a coherent cache, and so this
8700 parameter is set to no by default on HPUX. On all other systems
8701 this parameter should be left alone. This parameter is provided to
8702 help the Samba developers track down problems with the tdb internal
8703 code.
8704 Default: use mmap = yes
8706 username level (G)
8708 This option helps Samba to try and 'guess' at the real UNIX
8710 username, as many DOS clients send an all-uppercase username. By
8711 default Samba tries all lowercase, followed by the username with
8712 the first letter capitalized, and fails if the username is not
8713 found on the UNIX machine.
8714 If this parameter is set to non-zero the behavior changes. This
8716 parameter is a number that specifies the number of uppercase
8717 combinations to try while trying to determine the UNIX user name.
8718 The higher the number the more combinations will be tried, but the
8719 slower the discovery of usernames will be. Use this parameter when
8720 you have strange usernames on your UNIX machine, such as
8721 AstrangeUser .
8722 This parameter is needed only on UNIX systems that have case
8724 sensitive usernames.
8725 Default: username level = 0
8727 Example: username level = 5
8729 username map (G)
8731 This option allows you to specify a file containing a mapping of
8733 usernames from the clients to the server. This can be used for
8734 several purposes. The most common is to map usernames that users
8735 use on DOS or Windows machines to those that the UNIX box uses. The
8736 other is to map multiple users to a single username so that they
8737 can more easily share files.
8738 Please note that for user mode security, the username map is
8740 applied prior to validating the user credentials. Domain member
8741 servers (domain or ads) apply the username map after the user has
8742 been successfully authenticated by the domain controller and
8743 require fully qualified entries in the map table (e.g. biddle =
8744 DOMAIN\foo).
8745 The map file is parsed line by line. Each line should contain a
8747 single UNIX username on the left then a '=' followed by a list of
8748 usernames on the right. The list of usernames on the right may
8749 contain names of the form @group in which case they will match any
8750 UNIX username in that group. The special client name '*' is a
8751 wildcard and matches any name. Each line of the map file may be up
8752 to 1023 characters long.
8753 The file is processed on each line by taking the supplied username
8755 and comparing it with each username on the right hand side of the
8756 '=' signs. If the supplied name matches any of the names on the
8757 right hand side then it is replaced with the name on the left.
8758 Processing then continues with the next line.
8759 If any line begins with a '#' or a ';' then it is ignored.
8761 If any line begins with an '!' then the processing will stop after
8763 that line if a mapping was done by the line. Otherwise mapping
8764 continues with every line being processed. Using '!' is most useful
8765 when you have a wildcard mapping line later in the file.
8766 For example to map from the name admin or administrator to the UNIX
8768 name
8769 root you would use:
8770 root = admin administrator
8772 Or to map anyone in the UNIX group system to the UNIX name sys you
8774 would use:
8775 sys = @system
8777 You can have as many mappings as you like in a username map file.
8779 If your system supports the NIS NETGROUP option then the netgroup
8781 database is checked before the /etc/group database for matching
8782 groups.
8783 You can map Windows usernames that have spaces in them by using
8785 double quotes around the name. For example:
8786 tridge = "Andrew Tridgell"
8788 would map the windows username "Andrew Tridgell" to the unix
8790 username "tridge".
8791 The following example would map mary and fred to the unix user sys,
8793 and map the rest to guest. Note the use of the '!' to tell Samba to
8794 stop processing if it gets a match on that line:
8795 !sys = mary fred
8797 guest = *
8798 Note that the remapping is applied to all occurrences of usernames.
8800 Thus if you connect to \\server\fred and fred is remapped to mary
8801 then you will actually be connecting to \\server\mary and will need
8802 to supply a password suitable for mary not fred. The only exception
8803 to this is the username passed to a Domain Controller (if you have
8804 one). The DC will receive whatever username the client supplies
8805 without modification.
8806 Also note that no reverse mapping is done. The main effect this has
8808 is with printing. Users who have been mapped may have trouble
8809 deleting print jobs as PrintManager under WfWg will think they
8810 don't own the print job.
8811 Samba versions prior to 3.0.8 would only support reading the fully
8813 qualified username (e.g.: DOMAIN\user) from the username map when
8814 performing a kerberos login from a client. However, when looking up
8815 a map entry for a user authenticated by NTLM[SSP], only the login
8816 name would be used for matches. This resulted in inconsistent
8817 behavior sometimes even on the same server.
8818 The following functionality is obeyed in version 3.0.8 and later:
8820 When performing local authentication, the username map is applied
8822 to the login name before attempting to authenticate the connection.
8823 When relying upon a external domain controller for validating
8825 authentication requests, smbd will apply the username map to the
8826 fully qualified username (i.e. DOMAIN\user) only after the user
8827 has been successfully authenticated.
8828 An example of use is:
8830 username map = /usr/local/samba/lib/users.map
8832 Default: username map = # no username map
8834 username map cache time (G)
8836 Mapping usernames with the username map or username map script
8838 features of Samba can be relatively expensive. During login of a
8839 user, the mapping is done several times. In particular, calling the
8840 username map script can slow down logins if external databases have
8841 to be queried from the script being called.
8842 The parameter username map cache time controls a mapping cache. It
8844 specifies the number of seconds a mapping from the username map
8845 file or script is to be efficiently cached. The default of 0 means
8846 no caching is done.
8847 Default: username map cache time = 0
8849 Example: username map cache time = 60
8851 username map script (G)
8853 This script is a mutually exclusive alternative to the username map
8855 parameter. This parameter specifies and external program or script
8856 that must accept a single command line option (the username
8857 transmitted in the authentication request) and return a line on
8858 standard output (the name to which the account should mapped). In
8859 this way, it is possible to store username map tables in an LDAP or
8860 NIS directory services.
8861 Default: username map script =
8863 Example: username map script = /etc/samba/scripts/mapusers.sh
8865 usershare allow guests (G)
8867 This parameter controls whether user defined shares are allowed to
8869 be accessed by non-authenticated users or not. It is the equivalent
8870 of allowing people who can create a share the option of setting
8871 guest ok = yes in a share definition. Due to its security sensitive
8872 nature, the default is set to off.
8873 Default: usershare allow guests = no
8875 usershare max shares (G)
8877 This parameter specifies the number of user defined shares that are
8879 allowed to be created by users belonging to the group owning the
8880 usershare directory. If set to zero (the default) user defined
8881 shares are ignored.
8882 Default: usershare max shares = 0
8884 usershare owner only (G)
8886 This parameter controls whether the pathname exported by a user
8888 defined shares must be owned by the user creating the user defined
8889 share or not. If set to True (the default) then smbd checks that
8890 the directory path being shared is owned by the user who owns the
8891 usershare file defining this share and refuses to create the share
8892 if not. If set to False then no such check is performed and any
8893 directory path may be exported regardless of who owns it.
8894 Default: usershare owner only = yes
8896 usershare path (G)
8898 This parameter specifies the absolute path of the directory on the
8900 filesystem used to store the user defined share definition files.
8901 This directory must be owned by root, and have no access for other,
8902 and be writable only by the group owner. In addition the "sticky"
8903 bit must also be set, restricting rename and delete to owners of a
8904 file (in the same way the /tmp directory is usually configured).
8905 Members of the group owner of this directory are the users allowed
8906 to create usershares.
8907 For example, a valid usershare directory might be
8909 /usr/local/samba/lib/usershares, set up as follows.
8910 ls -ld /usr/local/samba/lib/usershares/
8912 drwxrwx--T 2 root power_users 4096 2006-05-05 12:27 /usr/local/samba/lib/usershares/
8913 In this case, only members of the group "power_users" can create
8916 user defined shares.
8917 Default: usershare path = /var/lib/samba/usershares
8919 usershare prefix allow list (G)
8921 This parameter specifies a list of absolute pathnames the root of
8923 which are allowed to be exported by user defined share definitions.
8924 If the pathname to be exported doesn't start with one of the
8925 strings in this list, the user defined share will not be allowed.
8926 This allows the Samba administrator to restrict the directories on
8927 the system that can be exported by user defined shares.
8928 If there is a "usershare prefix deny list" and also a "usershare
8930 prefix allow list" the deny list is processed first, followed by
8931 the allow list, thus leading to the most restrictive
8932 interpretation.
8933 Default: usershare prefix allow list =
8935 Example: usershare prefix allow list = /home /data /space
8937 usershare prefix deny list (G)
8939 This parameter specifies a list of absolute pathnames the root of
8941 which are NOT allowed to be exported by user defined share
8942 definitions. If the pathname exported starts with one of the
8943 strings in this list the user defined share will not be allowed.
8944 Any pathname not starting with one of these strings will be allowed
8945 to be exported as a usershare. This allows the Samba administrator
8946 to restrict the directories on the system that can be exported by
8947 user defined shares.
8948 If there is a "usershare prefix deny list" and also a "usershare
8950 prefix allow list" the deny list is processed first, followed by
8951 the allow list, thus leading to the most restrictive
8952 interpretation.
8953 Default: usershare prefix deny list =
8955 Example: usershare prefix deny list = /etc /dev /private
8957 usershare template share (G)
8959 User defined shares only have limited possible parameters such as
8961 path, guest ok, etc. This parameter allows usershares to "cloned"
8962 from an existing share. If "usershare template share" is set to the
8963 name of an existing share, then all usershares created have their
8964 defaults set from the parameters set on this share.
8965 The target share may be set to be invalid for real file sharing by
8967 setting the parameter "-valid = False" on the template share
8968 definition. This causes it not to be seen as a real exported share
8969 but to be able to be used as a template for usershares.
8970 Default: usershare template share =
8972 Example: usershare template share = template_share
8974 use sendfile (S)
8976 If this parameter is yes, and the sendfile() system call is
8978 supported by the underlying operating system, then some SMB read
8979 calls (mainly ReadAndX and ReadRaw) will use the more efficient
8980 sendfile system call for files that are exclusively oplocked. This
8981 may make more efficient use of the system CPU's and cause Samba to
8982 be faster. Samba automatically turns this off for clients that use
8983 protocol levels lower than NT LM 0.12 and when it detects a client
8984 is Windows 9x (using sendfile from Linux will cause these clients
8985 to fail).
8986 Default: use sendfile = no
8988 utmp (G)
8990 This boolean parameter is only available if Samba has been
8992 configured and compiled with the option --with-utmp. If set to yes
8993 then Samba will attempt to add utmp or utmpx records (depending on
8994 the UNIX system) whenever a connection is made to a Samba server.
8995 Sites may use this to record the user connecting to a Samba share.
8996 Due to the requirements of the utmp record, we are required to
8998 create a unique identifier for the incoming user. Enabling this
8999 option creates an n^2 algorithm to find this number. This may
9000 impede performance on large installations.
9001 Default: utmp = no
9003 utmp directory (G)
9005 This parameter is only available if Samba has been configured and
9007 compiled with the option --with-utmp. It specifies a directory
9008 pathname that is used to store the utmp or utmpx files (depending
9009 on the UNIX system) that record user connections to a Samba server.
9010 By default this is not set, meaning the system will use whatever
9011 utmp file the native system is set to use (usually /var/run/utmp on
9012 Linux).
9013 Default: utmp directory = # Determined automatically
9015 Example: utmp directory = /var/run/utmp
9017 -valid (S)
9019 This parameter indicates whether a share is valid and thus can be
9021 used. When this parameter is set to false, the share will be in no
9022 way visible nor accessible.
9023 This option should not be used by regular users but might be of
9025 help to developers. Samba uses this option internally to mark
9026 shares as deleted.
9027 Default: -valid = yes
9029 valid users (S)
9031 This is a list of users that should be allowed to login to this
9033 service. Names starting with '@', '+' and '&' are interpreted using
9034 the same rules as described in the invalid users parameter.
9035 If this is empty (the default) then any user can login. If a
9037 username is in both this list and the invalid users list then
9038 access is denied for that user.
9039 The current servicename is substituted for %S. This is useful in
9041 the [homes] section.
9042 Note: When used in the [global] section this parameter may have
9044 unwanted side effects. For example: If samba is configured as a
9045 MASTER BROWSER (see local master, os level, domain master,
9046 preferred master) this option will prevent workstations from being
9047 able to browse the network.
9048 Default: valid users = # No valid users list (anyone can login)
9050 Example: valid users = greg, @pcusers
9052 veto files (S)
9054 This is a list of files and directories that are neither visible
9056 nor accessible. Each entry in the list must be separated by a '/',
9057 which allows spaces to be included in the entry. '*' and '?' can be
9058 used to specify multiple files or directories as in DOS wildcards.
9059 Each entry must be a unix path, not a DOS path and must not include
9061 the unix directory separator '/'.
9062 Note that the case sensitive option is applicable in vetoing files.
9064 One feature of the veto files parameter that it is important to be
9066 aware of is Samba's behaviour when trying to delete a directory. If
9067 a directory that is to be deleted contains nothing but veto files
9068 this deletion will fail unless you also set the delete veto files
9069 parameter to yes.
9070 Setting this parameter will affect the performance of Samba, as it
9072 will be forced to check all files and directories for a match as
9073 they are scanned.
9074 Examples of use include:
9076 ; Veto any files containing the word Security,
9078 ; any ending in .tmp, and any directory containing the
9079 ; word root.
9080 veto files = /*Security*/*.tmp/*root*/
9081 ; Veto the Apple specific files that a NetAtalk server
9083 ; creates.
9084 veto files = /.AppleDouble/.bin/.AppleDesktop/Network Trash Folder/
9085 Default: veto files = # No files or directories are vetoed
9087 veto oplock files (S)
9089 This parameter is only valid when the oplocks parameter is turned
9091 on for a share. It allows the Samba administrator to selectively
9092 turn off the granting of oplocks on selected files that match a
9093 wildcarded list, similar to the wildcarded list used in the veto
9094 files parameter.
9095 You might want to do this on files that you know will be heavily
9097 contended for by clients. A good example of this is in the NetBench
9098 SMB benchmark program, which causes heavy client contention for
9099 files ending in .SEM. To cause Samba not to grant oplocks on these
9100 files you would use the line (either in the [global] section or in
9101 the section for the particular NetBench share.
9102 An example of use is:
9104 veto oplock files = /.*SEM/
9106 Default: veto oplock files = # No files are vetoed for oplock
9108 grants
9109 vfs object
9111 This parameter is a synonym for vfs objects.
9113 vfs objects (S)
9115 This parameter specifies the backend names which are used for Samba
9117 VFS I/O operations. By default, normal disk I/O operations are used
9118 but these can be overloaded with one or more VFS objects.
9119 Default: vfs objects =
9121 Example: vfs objects = extd_audit recycle
9123 volume (S)
9125 This allows you to override the volume label returned for a share.
9127 Useful for CDROMs with installation programs that insist on a
9128 particular volume label.
9129 Default: volume = # the name of the share
9131 web port (G)
9133 Specifies which port the Samba web server should listen on.
9135 Default: web port = 901
9137 Example: web port = 80
9139 wide links (S)
9141 This parameter controls whether or not links in the UNIX file
9143 system may be followed by the server. Links that point to areas
9144 within the directory tree exported by the server are always
9145 allowed; this parameter controls access only to areas that are
9146 outside the directory tree being exported.
9147 Note: Turning this parameter on when UNIX extensions are enabled
9149 will allow UNIX clients to create symbolic links on the share that
9150 can point to files or directories outside restricted path exported
9151 by the share definition. This can cause access to areas outside of
9152 the share. Due to this problem, this parameter will be
9153 automatically disabled (with a message in the log file) if the unix
9154 extensions option is on.
9155 See the parameter allow insecure wide links if you wish to change
9157 this coupling between the two parameters.
9158 Default: wide links = no
9160 winbind cache time (G)
9162 This parameter specifies the number of seconds the winbindd(8)
9164 daemon will cache user and group information before querying a
9165 Windows NT server again.
9166 This does not apply to authentication requests, these are always
9168 evaluated in real time unless the winbind offline logon option has
9169 been enabled.
9170 Default: winbind cache time = 300
9172 winbindd socket directory (G)
9174 This setting controls the location of the winbind daemon's socket.
9176 Except within automated test scripts, this should not be altered,
9178 as the client tools (nss_winbind etc) do not honour this parameter.
9179 Client tools must then be advised of the altered path with the
9180 WINBINDD_SOCKET_DIR environment varaible.
9181 Default: winbindd socket directory = /run/samba/winbindd
9183 winbind enum groups (G)
9185 On large installations using winbindd(8) it may be necessary to
9187 suppress the enumeration of groups through the setgrent(),
9188 getgrent() and endgrent() group of system calls. If the winbind
9189 enum groups parameter is no, calls to the getgrent() system call
9190 will not return any data.
9191 Warning
9193 Turning off group enumeration may cause some programs to behave
9194 oddly.
9195 Default: winbind enum groups = no
9196 winbind enum users (G)
9198 On large installations using winbindd(8) it may be necessary to
9200 suppress the enumeration of users through the setpwent(),
9201 getpwent() and endpwent() group of system calls. If the winbind
9202 enum users parameter is no, calls to the getpwent system call will
9203 not return any data.
9204 Warning
9206 Turning off user enumeration may cause some programs to behave
9207 oddly. For example, the finger program relies on having access
9208 to the full user list when searching for matching usernames.
9209 Default: winbind enum users = no
9210 winbind expand groups (G)
9212 This option controls the maximum depth that winbindd will traverse
9214 when flattening nested group memberships of Windows domain groups.
9215 This is different from the winbind nested groups option which
9216 implements the Windows NT4 model of local group nesting. The
9217 "winbind expand groups" parameter specifically applies to the
9218 membership of domain groups.
9219 This option also affects the return of non nested group memberships
9221 of Windows domain users. With the new default "winbind expand
9222 groups = 0" winbind does not query group memberships at all.
9223 Be aware that a high value for this parameter can result in system
9225 slowdown as the main parent winbindd daemon must perform the group
9226 unrolling and will be unable to answer incoming NSS or
9227 authentication requests during this time.
9228 The default value was changed from 1 to 0 with Samba 4.2. Some
9230 broken applications (including some implementations of newgrp and
9231 sg) calculate the group memberships of users by traversing groups,
9232 such applications will require "winbind expand groups = 1". But the
9233 new default makes winbindd more reliable as it doesn't require SAMR
9234 access to domain controllers of trusted domains.
9235 Default: winbind expand groups = 0
9237 winbind:ignore domains (G)
9239 Allows to enter a list of trusted domains winbind should ignore
9241 (untrust). This can avoid the overhead of resources from attempting
9242 to login to DCs that should not be communicated with.
9243 Default: winbind:ignore domains =
9245 Example: winbind:ignore domains = DOMAIN1, DOMAIN2
9247 winbind max clients (G)
9249 This parameter specifies the maximum number of clients the
9251 winbindd(8) daemon can connect with. The parameter is not a hard
9252 limit. The winbindd(8) daemon configures itself to be able to
9253 accept at least that many connections, and if the limit is reached,
9254 an attempt is made to disconnect idle clients.
9255 Default: winbind max clients = 200
9257 winbind max domain connections (G)
9259 This parameter specifies the maximum number of simultaneous
9261 connections that the winbindd(8) daemon should open to the domain
9262 controller of one domain. Setting this parameter to a value greater
9263 than 1 can improve scalability with many simultaneous winbind
9264 requests, some of which might be slow.
9265 Note that if winbind offline logon is set to Yes, then only one DC
9267 connection is allowed per domain, regardless of this setting.
9268 Default: winbind max domain connections = 1
9270 Example: winbind max domain connections = 10
9272 winbind nested groups (G)
9274 If set to yes, this parameter activates the support for nested
9276 groups. Nested groups are also called local groups or aliases. They
9277 work like their counterparts in Windows: Nested groups are defined
9278 locally on any machine (they are shared between DC's through their
9279 SAM) and can contain users and global groups from any trusted SAM.
9280 To be able to use nested groups, you need to run nss_winbind.
9281 Default: winbind nested groups = yes
9283 winbind normalize names (G)
9285 This parameter controls whether winbindd will replace whitespace in
9287 user and group names with an underscore (_) character. For example,
9288 whether the name "Space Kadet" should be replaced with the string
9289 "space_kadet". Frequently Unix shell scripts will have difficulty
9290 with usernames contains whitespace due to the default field
9291 separator in the shell. If your domain possesses names containing
9292 the underscore character, this option may cause problems unless the
9293 name aliasing feature is supported by your nss_info plugin.
9294 This feature also enables the name aliasing API which can be used
9296 to make domain user and group names to a non-qualified version.
9297 Please refer to the manpage for the configured idmap and nss_info
9298 plugin for the specifics on how to configure name aliasing for a
9299 specific configuration. Name aliasing takes precedence (and is
9300 mutually exclusive) over the whitespace replacement mechanism
9301 discussed previously.
9302 Default: winbind normalize names = no
9304 Example: winbind normalize names = yes
9306 winbind nss info (G)
9308 This parameter is designed to control how Winbind retrieves Name
9310 Service Information to construct a user's home directory and login
9311 shell. Currently the following settings are available:
9312 · template - The default, using the parameters of template
9314 shell and template homedir)
9315 · <sfu | sfu20 | rfc2307 > - When Samba is running in
9317 security = ads and your Active Directory Domain
9318 Controller does support the Microsoft "Services for
9319 Unix" (SFU) LDAP schema, winbind can retrieve the login
9320 shell and the home directory attributes directly from
9321 your Directory Server. For SFU 3.0 or 3.5 simply choose
9322 "sfu", if you use SFU 2.0 please choose "sfu20". Note
9323 that retrieving UID and GID from your ADS-Server
9324 requires to use idmap config DOMAIN:backend = ad as
9325 well. The primary group membership is currently always
9326 calculated via the "primaryGroupID" LDAP attribute.
9327 Default: winbind nss info = template
9330 Example: winbind nss info = sfu
9332 winbind offline logon (G)
9334 This parameter is designed to control whether Winbind should allow
9336 one to login with the pam_winbind module using Cached Credentials.
9337 If enabled, winbindd will store user credentials from successful
9338 logins encrypted in a local cache.
9339 Default: winbind offline logon = no
9341 Example: winbind offline logon = yes
9343 winbind reconnect delay (G)
9345 This parameter specifies the number of seconds the winbindd(8)
9347 daemon will wait between attempts to contact a Domain controller
9348 for a domain that is determined to be down or not contactable.
9349 Default: winbind reconnect delay = 30
9351 winbind refresh tickets (G)
9353 This parameter is designed to control whether Winbind should
9355 refresh Kerberos Tickets retrieved using the pam_winbind module.
9356 Default: winbind refresh tickets = no
9358 Example: winbind refresh tickets = yes
9360 winbind request timeout (G)
9362 This parameter specifies the number of seconds the winbindd(8)
9364 daemon will wait before disconnecting either a client connection
9365 with no outstanding requests (idle) or a client connection with a
9366 request that has remained outstanding (hung) for longer than this
9367 number of seconds.
9368 Default: winbind request timeout = 60
9370 winbind rpc only (G)
9372 Setting this parameter to yes forces winbindd to use RPC instead of
9374 LDAP to retrieve information from Domain Controllers.
9375 Default: winbind rpc only = no
9377 winbind scan trusted domains (G)
9379 This option only takes effect when the security option is set to
9381 domain or ads. If it is set to yes (the default), winbindd
9382 periodically tries to scan for new trusted domains and adds them to
9383 a global list inside of winbindd. The list can be extracted with
9384 wbinfo --trusted-domains --verbose. This matches the behaviour of
9385 Samba 4.7 and older.
9386 The construction of that global list is not reliable and often
9388 incomplete in complex trust setups. In most situations the list is
9389 not needed any more for winbindd to operate correctly. E.g. for
9390 plain file serving via SMB using a simple idmap setup with autorid,
9391 tdb or ad. However some more complex setups require the list, e.g.
9392 if you specify idmap backends for specific domains. Some
9393 pam_winbind setups may also require the global list.
9394 If you have a setup that doesn't require the global list, you
9396 should set winbind scan trusted domains = no.
9397 Default: winbind scan trusted domains = yes
9399 winbind sealed pipes (G)
9401 This option controls whether any requests from winbindd to domain
9403 controllers pipe will be sealed. Disabling sealing can be useful
9404 for debugging purposes.
9405 The behavior can be controlled per netbios domain by using 'winbind
9407 sealed pipes:NETBIOSDOMAIN = no' as option.
9408 Default: winbind sealed pipes = yes
9410 winbind separator (G)
9412 This parameter allows an admin to define the character used when
9414 listing a username of the form of DOMAIN \user. This parameter is
9415 only applicable when using the pam_winbind.so and nss_winbind.so
9416 modules for UNIX services.
9417 Please note that setting this parameter to + causes problems with
9419 group membership at least on glibc systems, as the character + is
9420 used as a special character for NIS in /etc/group.
9421 Default: winbind separator = \
9423 Example: winbind separator = +
9425 winbind use default domain (G)
9427 This parameter specifies whether the winbindd(8) daemon should
9429 operate on users without domain component in their username. Users
9430 without a domain component are treated as is part of the winbindd
9431 server's own domain. While this does not benefit Windows users, it
9432 makes SSH, FTP and e-mail function in a way much closer to the way
9433 they would in a native unix system.
9434 This option should be avoided if possible. It can cause confusion
9436 about responsibilities for a user or group. In many situations it
9437 is not clear whether winbind or /etc/passwd should be seen as
9438 authoritative for a user, likewise for groups.
9439 Default: winbind use default domain = no
9441 Example: winbind use default domain = yes
9443 winsdb:local_owner (G)
9445 This specifies the address that is stored in the winsOwner
9447 attribute, of locally registered winsRecord-objects. The default is
9448 to use the ip-address of the first network interface.
9449 No default
9451 winsdb:dbnosync (G)
9453 This parameter disables fsync() after changes of the WINS database.
9455 Default: winsdb:dbnosync = no
9457 wins hook (G)
9459 When Samba is running as a WINS server this allows you to call an
9461 external program for all changes to the WINS database. The primary
9462 use for this option is to allow the dynamic update of external name
9463 resolution databases such as dynamic DNS.
9464 The wins hook parameter specifies the name of a script or
9466 executable that will be called as follows:
9467 wins_hook operation name nametype ttl IP_list
9469 · The first argument is the operation and is one of "add",
9471 "delete", or "refresh". In most cases the operation can
9472 be ignored as the rest of the parameters provide
9473 sufficient information. Note that "refresh" may
9474 sometimes be called when the name has not previously
9475 been added, in that case it should be treated as an add.
9476 · The second argument is the NetBIOS name. If the name is
9478 not a legal name then the wins hook is not called. Legal
9479 names contain only letters, digits, hyphens, underscores
9480 and periods.
9481 · The third argument is the NetBIOS name type as a 2 digit
9483 hexadecimal number.
9484 · The fourth argument is the TTL (time to live) for the
9486 name in seconds.
9487 · The fifth and subsequent arguments are the IP addresses
9489 currently registered for that name. If this list is
9490 empty then the name should be deleted.
9491 An example script that calls the BIND dynamic DNS update program
9493 nsupdate is provided in the examples directory of the Samba source
9494 code.
9495 No default
9497 wins proxy (G)
9499 This is a boolean that controls if nmbd(8) will respond to
9501 broadcast name queries on behalf of other hosts. You may need to
9502 set this to yes for some older clients.
9503 Default: wins proxy = no
9505 wins server (G)
9507 This specifies the IP address (or DNS name: IP address for
9509 preference) of the WINS server that nmbd(8) should register with.
9510 If you have a WINS server on your network then you should set this
9511 to the WINS server's IP.
9512 You should point this at your WINS server if you have a
9514 multi-subnetted network.
9515 If you want to work in multiple namespaces, you can give every wins
9517 server a 'tag'. For each tag, only one (working) server will be
9518 queried for a name. The tag should be separated from the ip address
9519 by a colon.
9520 Note
9522 You need to set up Samba to point to a WINS server if you have
9523 multiple subnets and wish cross-subnet browsing to work
9524 correctly.
9525 See the chapter in the Samba3-HOWTO on Network Browsing.
9526 Default: wins server =
9528 Example: wins server = mary:192.9.200.1 fred:192.168.3.199
9530 mary:192.168.2.61 # For this example when querying a certain name,
9531 192.19.200.1 will be asked first and if that doesn't respond
9532 192.168.2.61. If either of those doesn't know the name
9533 192.168.3.199 will be queried.
9534 Example: wins server = 192.9.200.1 192.168.2.61
9536 wins support (G)
9538 This boolean controls if the nmbd(8) process in Samba will act as a
9540 WINS server. You should not set this to yes unless you have a
9541 multi-subnetted network and you wish a particular nmbd to be your
9542 WINS server. Note that you should NEVER set this to yes on more
9543 than one machine in your network.
9544 Default: wins support = no
9546 workgroup (G)
9548 This controls what workgroup your server will appear to be in when
9550 queried by clients. Note that this parameter also controls the
9551 Domain name used with the security = domain setting.
9552 Default: workgroup = WORKGROUP
9554 Example: workgroup = MYGROUP
9556 wreplsrv:periodic_interval (G)
9558 This maximum interval in s between 2 periodically scheduled runs
9560 where we check for wins.ldb changes and do push notifications to
9561 our push partners. Also wins_config.ldb changes are checked in that
9562 interval and partner configuration reloads are done.
9563 Default: wreplsrv:periodic_interval = 15
9565 wreplsrv:propagate name releases (G)
9567 If this parameter is enabled, then explicit (from the client) and
9569 implicit (via the scavenging) name releases are propagated to the
9570 other servers directly, even if there are still other addresses
9571 active, this applies to SPECIAL GROUP (2) and MULTIHOMED (3)
9572 entries. Also the replication conflict merge algorithm for SPECIAL
9573 GROUP (2) entries discards replica addresses where the address
9574 owner is the local server, if the address was not stored locally
9575 before. The merge result is propagated directly in case an address
9576 was discarded. A Windows servers doesn't propagate name releases of
9577 SPECIAL GROUP (2) and MULTIHOMED (3) entries directly, which means
9578 that Windows servers may return different results to name queries
9579 for SPECIAL GROUP (2) and MULTIHOMED (3) names. The option doesn't
9580 have much negative impact if Windows servers are around, but be
9581 aware that they might return unexpected results.
9582 Default: wreplsrv:propagate name releases = no
9584 wreplsrv:scavenging_interval (G)
9586 This is the interval in s between 2 scavenging runs which clean up
9588 the WINS database and changes the states of expired name records.
9589 Defaults to half of the value of wreplsrv:renew_interval.
9590 No default
9592 wreplsrv:tombstone_extra_timeout (G)
9594 This is the time in s the server needs to be up till we'll remove
9596 tombstone records from our database. Defaults to 3 days.
9597 Default: wreplsrv:tombstone_extra_timeout = 259200
9599 wreplsrv:tombstone_interval (G)
9601 This is the interval in s till released records of the WINS server
9603 become tombstone. Defaults to 6 days.
9604 Default: wreplsrv:tombstone_interval = 518400
9606 wreplsrv:tombstone_timeout (G)
9608 This is the interval in s till tombstone records are deleted from
9610 the WINS database. Defaults to 1 day.
9611 Default: wreplsrv:tombstone_timeout = 86400
9613 wreplsrv:verify_interval (G)
9615 This is the interval in s till we verify active replica records
9617 with the owning WINS server. Unfortunately not implemented yet.
9618 Defaults to 24 days.
9619 Default: wreplsrv:verify_interval = 2073600
9621 writable
9623 This parameter is a synonym for writeable.
9625 write ok
9627 This parameter is a synonym for writeable.
9629 writeable (S)
9631 Inverted synonym for read only.
9633 Default: writeable = no
9635 write cache size (S)
9637 If this integer parameter is set to non-zero value, Samba will
9639 create an in-memory cache for each oplocked file (it does not do
9640 this for non-oplocked files). All writes that the client does not
9641 request to be flushed directly to disk will be stored in this cache
9642 if possible. The cache is flushed onto disk when a write comes in
9643 whose offset would not fit into the cache or when the file is
9644 closed by the client. Reads for the file are also served from this
9645 cache if the data is stored within it.
9646 This cache allows Samba to batch client writes into a more
9648 efficient write size for RAID disks (i.e. writes may be tuned to be
9649 the RAID stripe size) and can improve performance on systems where
9650 the disk subsystem is a bottleneck but there is free memory for
9651 userspace programs.
9652 The integer parameter specifies the size of this cache (per
9654 oplocked file) in bytes.
9655 Note that the write cache won't be used for file handles with a
9657 smb2 write lease.
9658 Default: write cache size = 0
9660 Example: write cache size = 262144 # for a 256k cache size per file
9662 write list (S)
9664 This is a list of users that are given read-write access to a
9666 service. If the connecting user is in this list then they will be
9667 given write access, no matter what the read only option is set to.
9668 The list can include group names using the @group syntax.
9669 Note that if a user is in both the read list and the write list
9671 then they will be given write access.
9672 Default: write list =
9674 Example: write list = admin, root, @staff
9676 write raw (G)
9678 This is ignored if async smb echo handler is set, because this
9680 feature is incompatible with raw write SMB requests
9681 If enabled, raw writes allow writes of 65535 bytes in one packet.
9683 This typically provides a major performance benefit for some very,
9684 very old clients.
9685 However, some clients either negotiate the allowable block size
9687 incorrectly or are incapable of supporting larger block sizes, and
9688 for these clients you may need to disable raw writes.
9689 In general this parameter should be viewed as a system tuning tool
9691 and left severely alone.
9692 Default: write raw = yes
9694 wtmp directory (G)
9696 This parameter is only available if Samba has been configured and
9698 compiled with the option --with-utmp. It specifies a directory
9699 pathname that is used to store the wtmp or wtmpx files (depending
9700 on the UNIX system) that record user connections to a Samba server.
9701 The difference with the utmp directory is the fact that user info
9702 is kept after a user has logged out.
9703 By default this is not set, meaning the system will use whatever
9705 utmp file the native system is set to use (usually /var/run/wtmp on
9706 Linux).
9707 Default: wtmp directory =
9709 Example: wtmp directory = /var/log/wtmp
9711
9713 Although the configuration file permits service names to contain
9714 spaces, your client software may not. Spaces will be ignored in
9715 comparisons anyway, so it shouldn't be a problem - but be aware of the
9716 possibility.
9717 On a similar note, many clients - especially DOS clients - limit
9719 service names to eight characters. smbd(8) has no such limitation, but
9720 attempts to connect from such clients will fail if they truncate the
9721 service names. For this reason you should probably keep your service
9722 names down to eight characters in length.
9723 Use of the [homes] and [printers] special sections make life for an
9725 administrator easy, but the various combinations of default attributes
9726 can be tricky. Take extreme care when designing these sections. In
9727 particular, ensure that the permissions on spool directories are
9728 correct.
9729
9731 This man page is part of version 4.8.3 of the Samba suite.
9732
9734 samba(7), smbpasswd(8), smbd(8), nmbd(8), winbindd(8), samba(8), samba-
9735 tool(8), smbclient(1), nmblookup(1), testparm(1).
9736
9738 The original Samba software and related utilities were created by
9739 Andrew Tridgell. Samba is now developed by the Samba Team as an Open
9740 Source project similar to the way the Linux kernel is developed.
9741Samba 4.8.3 10/30/2018 SMB.CONF(5)