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 username.
118 · If no path was given, the path is set to the user´s home directory.
120 If you decide to use a path = line in your [homes] section, it may be
123 useful to use the %S macro. For example:
124 path = /data/pchome/%S
126 is useful if you have different home directories for your PCs than for
128 UNIX access.
129 This is a fast and simple way to give a large number of clients access
131 to their home directories with a minimum of fuss.
132 A similar process occurs if the requested section name is “homes”,
134 except that the share name is not changed to that of the requesting
135 user. This method of using the [homes] section works well if different
136 users share a client PC.
137 The [homes] section can specify all the parameters a normal service
139 section can specify, though some make more sense than others. The
140 following is a typical and suitable [homes] section:
141 [homes]
143 read only = no
144 An important point is that if guest access is specified in the [homes]
146 section, all home directories will be visible to all clients without a
147 password. In the very unlikely event that this is actually desirable,
148 it is wise to also specify read only access.
149 The browseable flag for auto home directories will be inherited from
151 the global browseable flag, not the [homes] browseable flag. This is
152 useful as it means setting browseable = no in the [homes] section will
153 hide the [homes] share but make any auto home directories visible.
154 The [printers] section
156 This section works like [homes], but for printers.
157 If a [printers] section occurs in the configuration file, users are
159 able to connect to any printer specified in the local host´s printcap
160 file.
161 When a connection request is made, the existing sections are scanned.
163 If a match is found, it is used. If no match is found, but a [homes]
164 section exists, it is used as described above. Otherwise, the requested
165 section name is treated as a printer name and the appropriate printcap
166 file is scanned to see if the requested section name is a valid printer
167 share name. If a match is found, a new printer share is created by
168 cloning the [printers] section.
169 A few modifications are then made to the newly created share:
171 · The share name is set to the located printer name
173 · If no printer name was given, the printer name is set to the
175 located printer name
176 · If the share does not permit guest access and no username was
178 given, the username is set to the located printer name.
179 The [printers] service MUST be printable - if you specify otherwise,
182 the server will refuse to load the configuration file.
183 Typically the path specified is that of a world-writeable spool
185 directory with the sticky bit set on it. A typical [printers] entry
186 looks like this:
187 [printers]
189 path = /usr/spool/public
190 guest ok = yes
191 printable = yes
192 All aliases given for a printer in the printcap file are legitimate
194 printer names as far as the server is concerned. If your printing
195 subsystem doesn´t work like that, you will have to set up a
196 pseudo-printcap. This is a file consisting of one or more lines like
197 this:
198 alias|alias|alias|alias...
200 Each alias should be an acceptable printer name for your printing
202 subsystem. In the [global] section, specify the new file as your
203 printcap. The server will only recognize names found in your
204 pseudo-printcap, which of course can contain whatever aliases you like.
205 The same technique could be used simply to limit access to a subset of
206 your local printers.
207 An alias, by the way, is defined as any component of the first entry of
209 a printcap record. Records are separated by newlines, components (if
210 there are more than one) are separated by vertical bar symbols (|).
211 Note
213 On SYSV systems which use lpstat to determine what printers are
214 defined on the system you may be able to use printcap name = lpstat
215 to automatically obtain a list of printers. See the printcap name
216 option for more details.
217
219 Starting with Samba version 3.0.23 the capability for non-root users to
220 add, modify, and delete their own share definitions has been added.
221 This capability is called usershares and is controlled by a set of
222 parameters in the [global] section of the smb.conf. The relevant
223 parameters are :
224 usershare allow guests
226 Controls if usershares can permit guest access.
227 usershare max shares
229 Maximum number of user defined shares allowed.
230 usershare owner only
232 If set only directories owned by the sharing user can be shared.
233 usershare path
235 Points to the directory containing the user defined share
236 definitions. The filesystem permissions on this directory control
237 who can create user defined shares.
238 usershare prefix allow list
240 Comma-separated list of absolute pathnames restricting what
241 directories can be shared. Only directories below the pathnames in
242 this list are permitted.
243 usershare prefix deny list
245 Comma-separated list of absolute pathnames restricting what
246 directories can be shared. Directories below the pathnames in this
247 list are prohibited.
248 usershare template share
250 Names a pre-existing share used as a template for creating new
251 usershares. All other share parameters not specified in the user
252 defined share definition are copied from this named share.
253 To allow members of the UNIX group foo to create user defined shares,
255 create the directory to contain the share definitions as follows:
256 Become root:
258 mkdir /usr/local/samba/lib/usershares
260 chgrp foo /usr/local/samba/lib/usershares
261 chmod 1770 /usr/local/samba/lib/usershares
262 Then add the parameters
264 usershare path = /usr/local/samba/lib/usershares
266 usershare max shares = 10 # (or the desired number of shares)
267 to the global section of your smb.conf. Members of the group foo may
269 then manipulate the user defined shares using the following commands.
270 net usershare add sharename path [comment] [acl] [guest_ok=[y|n]]
272 To create or modify (overwrite) a user defined share.
273 net usershare delete sharename
275 To delete a user defined share.
276 net usershare list wildcard-sharename
278 To list user defined shares.
279 net usershare info wildcard-sharename
281 To print information about user defined shares.
282
284 Parameters define the specific attributes of sections.
285 Some parameters are specific to the [global] section (e.g., security).
287 Some parameters are usable in all sections (e.g., create mask). All
288 others are permissible only in normal sections. For the purposes of the
289 following descriptions the [homes] and [printers] sections will be
290 considered normal. The letter G in parentheses indicates that a
291 parameter is specific to the [global] section. The letter S indicates
292 that a parameter can be specified in a service specific section. All S
293 parameters can also be specified in the [global] section - in which
294 case they will define the default behavior for all services.
295 Parameters are arranged here in alphabetical order - this may not
297 create best bedfellows, but at least you can find them! Where there are
298 synonyms, the preferred synonym is described, others refer to the
299 preferred synonym.
300
302 Many of the strings that are settable in the config file can take
303 substitutions. For example the option “path = /tmp/%u” is interpreted
304 as “path = /tmp/john” if the user connected with the username john.
305 These substitutions are mostly noted in the descriptions below, but
307 there are some general substitutions which apply whenever they might be
308 relevant. These are:
309 %U
311 session username (the username that the client wanted, not
312 necessarily the same as the one they got).
313 %G
315 primary group name of %U.
316 %h
318 the Internet hostname that Samba is running on.
319 %m
321 the NetBIOS name of the client machine (very useful).
322 This parameter is not available when Samba listens on port 445, as
324 clients no longer send this information. If you use this macro in
325 an include statement on a domain that has a Samba domain controller
326 be sure to set in the [global] section smb ports = 139. This will
327 cause Samba to not listen on port 445 and will permit include
328 functionality to function as it did with Samba 2.x.
329 %L
331 the NetBIOS name of the server. This allows you to change your
332 config based on what the client calls you. Your server can have a
333 “dual personality”.
334 %M
336 the Internet name of the client machine.
337 %R
339 the selected protocol level after protocol negotiation. It can be
340 one of CORE, COREPLUS, LANMAN1, LANMAN2, NT1, SMB2_02, SMB2_10,
341 SMB2_22, SMB2_24, SMB3_00, SMB3_02 or SMB2_FF.
342 %d
344 the process id of the current server process.
345 %a
347 The architecture of the remote machine. It currently recognizes
348 Samba (Samba), the Linux CIFS file system (CIFSFS), OS/2, (OS2),
349 Mac OS X (OSX), Windows for Workgroups (WfWg), Windows 9x/ME
350 (Win95), Windows NT (WinNT), Windows 2000 (Win2K), Windows XP
351 (WinXP), Windows XP 64-bit(WinXP64), Windows 2003 including 2003R2
352 (Win2K3), and Windows Vista (Vista). Anything else will be known as
353 UNKNOWN.
354 %I
356 the IP address of the client machine.
357 Before 4.0.0 it could contain IPv4 mapped IPv6 addresses, now it
359 only contains IPv4 or IPv6 addresses.
360 %i
362 the local IP address to which a client connected.
363 Before 4.0.0 it could contain IPv4 mapped IPv6 addresses, now it
365 only contains IPv4 or IPv6 addresses.
366 %T
368 the current date and time.
369 %D
371 name of the domain or workgroup of the current user.
372 %w
374 the winbind separator.
375 %$(envvar)
377 the value of the environment variable envar.
378 The following substitutes apply only to some configuration options
380 (only those that are used when a connection has been established):
381 %S
383 the name of the current service, if any.
384 %P
386 the root directory of the current service, if any.
387 %u
389 username of the current service, if any.
390 %g
392 primary group name of %u.
393 %H
395 the home directory of the user given by %u.
396 %N
398 the name of your NIS home directory server. This is obtained from
399 your NIS auto.map entry. If you have not compiled Samba with the
400 --with-automount option, this value will be the same as %L.
401 %p
403 the path of the service´s home directory, obtained from your NIS
404 auto.map entry. The NIS auto.map entry is split up as %N:%p.
405 There are some quite creative things that can be done with these
407 substitutions and other smb.conf options.
408
410 Samba supports name mangling so that DOS and Windows clients can use
411 files that don´t conform to the 8.3 format. It can also be set to
412 adjust the case of 8.3 format filenames.
413 There are several options that control the way mangling is performed,
415 and they are grouped here rather than listed separately. For the
416 defaults look at the output of the testparm program.
417 These options can be set separately for each service.
419 The options are:
421 case sensitive = yes/no/auto
423 controls whether filenames are case sensitive. If they aren´t,
424 Samba must do a filename search and match on passed names. The
425 default setting of auto allows clients that support case sensitive
426 filenames (Linux CIFSVFS and smbclient 3.0.5 and above currently)
427 to tell the Samba server on a per-packet basis that they wish to
428 access the file system in a case-sensitive manner (to support UNIX
429 case sensitive semantics). No Windows or DOS system supports
430 case-sensitive filename so setting this option to auto is that same
431 as setting it to no for them. Default auto.
432 default case = upper/lower
434 controls what the default case is for new filenames (ie. files that
435 don´t currently exist in the filesystem). Default lower. IMPORTANT
436 NOTE: As part of the optimizations for directories containing large
437 numbers of files, the following special case applies. If the
438 options case sensitive = yes, preserve case = No, and short
439 preserve case = No are set, then the case of all incoming client
440 filenames, not just new filenames, will be modified. See additional
441 notes below.
442 preserve case = yes/no
444 controls whether new files (ie. files that don´t currently exist in
445 the filesystem) are created with the case that the client passes,
446 or if they are forced to be the default case. Default yes.
447 short preserve case = yes/no
449 controls if new files (ie. files that don´t currently exist in the
450 filesystem) which conform to 8.3 syntax, that is all in upper case
451 and of suitable length, are created upper case, or if they are
452 forced to be the default case. This option can be used with
453 preserve case = yes to permit long filenames to retain their case,
454 while short names are lowercased. Default yes.
455 By default, Samba 3.0 has the same semantics as a Windows NT server, in
457 that it is case insensitive but case preserving. As a special case for
458 directories with large numbers of files, if the case options are set as
459 follows, "case sensitive = yes", "case preserve = no", "short preserve
460 case = no" then the "default case" option will be applied and will
461 modify all filenames sent from the client when accessing this share.
462
464 Starting with Samba version 3.2.0, the capability to store Samba
465 configuration in the registry is available. The configuration is stored
466 in the registry key HKLM\Software\Samba\smbconf. There are two levels
467 of registry configuration:
468 1. Share definitions stored in registry are used. This is triggered by
470 setting the global parameter registry shares to “yes” in smb.conf.
471 The registry shares are loaded not at startup but on demand at
473 runtime by smbd. Shares defined in smb.conf take priority over
474 shares of the same name defined in registry.
475 2. Global smb.conf options stored in registry are used. This can be
477 activated in two different ways:
478 Firstly, a registry only configuration is triggered by setting
480 config backend = registry in the [global] section of smb.conf. This
481 resets everything that has been read from config files to this
482 point and reads the content of the global configuration section
483 from the registry. This is the recommended method of using registry
484 based configuration.
485 Secondly, a mixed configuration can be activated by a special new
487 meaning of the parameter include = registry in the [global] section
488 of smb.conf. This reads the global options from registry with the
489 same priorities as for an include of a text file. This may be
490 especially useful in cases where an initial configuration is needed
491 to access the registry.
492 Activation of global registry options automatically activates
494 registry shares. So in the registry only case, shares are loaded on
495 demand only.
496 Note: To make registry-based configurations foolproof at least to a
499 certain extent, the use of lock directory and config backend inside the
500 registry configuration has been disabled: Especially by changing the
501 lock directory inside the registry configuration, one would create a
502 broken setup where the daemons do not see the configuration they loaded
503 once it is active.
504 The registry configuration can be accessed with tools like regedit or
506 net (rpc) registry in the key HKLM\Software\Samba\smbconf. More
507 conveniently, the conf subcommand of the net(8) utility offers a
508 dedicated interface to read and write the registry based configuration
509 locally, i.e. directly accessing the database file, circumventing the
510 server.
511
513 bind interfaces only (G)
514 This global parameter allows the Samba admin to limit what
516 interfaces on a machine will serve SMB requests. It affects file
517 service smbd(8) and name service nmbd(8) in a slightly different
518 ways.
519 For name service it causes nmbd to bind to ports 137 and 138 on the
521 interfaces listed in the interfaces parameter. nmbd also binds to
522 the "all addresses" interface (0.0.0.0) on ports 137 and 138 for
523 the purposes of reading broadcast messages. If this option is not
524 set then nmbd will service name requests on all of these sockets.
525 If bind interfaces only is set then nmbd will check the source
526 address of any packets coming in on the broadcast sockets and
527 discard any that don´t match the broadcast addresses of the
528 interfaces in the interfaces parameter list. As unicast packets are
529 received on the other sockets it allows nmbd to refuse to serve
530 names to machines that send packets that arrive through any
531 interfaces not listed in the interfaces list. IP Source address
532 spoofing does defeat this simple check, however, so it must not be
533 used seriously as a security feature for nmbd.
534 For file service it causes smbd(8) to bind only to the interface
536 list given in the interfaces parameter. This restricts the networks
537 that smbd will serve, to packets coming in on those interfaces.
538 Note that you should not use this parameter for machines that are
539 serving PPP or other intermittent or non-broadcast network
540 interfaces as it will not cope with non-permanent interfaces.
541 If bind interfaces only is set and the network address 127.0.0.1 is
543 not added to the interfaces parameter list smbpasswd(8) may not
544 work as expected due to the reasons covered below.
545 To change a users SMB password, the smbpasswd by default connects
547 to the localhost - 127.0.0.1 address as an SMB client to issue the
548 password change request. If bind interfaces only is set then unless
549 the network address 127.0.0.1 is added to the interfaces parameter
550 list then smbpasswd will fail to connect in it´s default mode.
551 smbpasswd can be forced to use the primary IP interface of the
552 local host by using its smbpasswd(8) -r remote machine parameter,
553 with remote machine set to the IP name of the primary interface of
554 the local host.
555 Default: bind interfaces only = no
557 comment (S)
559 This is a text field that is seen next to a share when a client
561 does a queries the server, either via the network neighborhood or
562 via net view to list what shares are available.
563 If you want to set the string that is displayed next to the machine
565 name then see the server string parameter.
566 Default: comment = # No comment
568 Example: comment = Fred´s Files
570 config backend (G)
572 This controls the backend for storing the configuration. Possible
574 values are file (the default) and registry. When config backend =
575 registry is encountered while loading smb.conf, the configuration
576 read so far is dropped and the global options are read from
577 registry instead. So this triggers a registry only configuration.
578 Share definitions are not read immediately but instead registry
579 shares is set to yes.
580 Note: This option can not be set inside the registry configuration
582 itself.
583 Default: config backend = file
585 Example: config backend = registry
587 dos charset (G)
589 DOS SMB clients assume the server has the same charset as they do.
591 This option specifies which charset Samba should talk to DOS
592 clients.
593 The default depends on which charsets you have installed. Samba
595 tries to use charset 850 but falls back to ASCII in case it is not
596 available. Run testparm(1) to check the default on your system.
597 No default
599 enable core files (G)
601 This parameter specifies whether core dumps should be written on
603 internal exits. Normally set to yes. You should never need to
604 change this.
605 Default: enable core files = yes
607 Example: enable core files = no
609 interfaces (G)
611 This option allows you to override the default network interfaces
613 list that Samba will use for browsing, name registration and other
614 NetBIOS over TCP/IP (NBT) traffic. By default Samba will query the
615 kernel for the list of all active interfaces and use any interfaces
616 except 127.0.0.1 that are broadcast capable.
617 The option takes a list of interface strings. Each string can be in
619 any of the following forms:
620 · a network interface name (such as eth0). This may include
622 shell-like wildcards so eth* will match any interface starting
623 with the substring "eth"
624 · an IP address. In this case the netmask is determined from the
626 list of interfaces obtained from the kernel
627 · an IP/mask pair.
629 · a broadcast/mask pair.
631 The "mask" parameters can either be a bit length (such as 24 for a C
633 class network) or a full netmask in dotted decimal form.
634 The "IP" parameters above can either be a full dotted decimal IP
636 address or a hostname which will be looked up via the OS´s normal
637 hostname resolution mechanisms.
638 By default Samba enables all active interfaces that are broadcast
640 capable except the loopback adaptor (IP address 127.0.0.1).
641 The example below configures three network interfaces corresponding to
643 the eth0 device and IP addresses 192.168.2.10 and 192.168.3.10. The
644 netmasks of the latter two interfaces would be set to 255.255.255.0.
645 Default: interfaces =
647 Example: interfaces = eth0 192.168.2.10/24 192.168.3.10/255.255.255.0
649 multicast dns register (G)
651 If compiled with proper support for it, Samba will announce itself
653 with multicast DNS services like for example provided by the Avahi
654 daemon.
655 This parameter allows disabling Samba to register itself.
657 Default: multicast dns register = yes
659 netbios aliases (G)
661 This is a list of NetBIOS names that nmbd will advertise as
663 additional names by which the Samba server is known. This allows
664 one machine to appear in browse lists under multiple names. If a
665 machine is acting as a browse server or logon server none of these
666 names will be advertised as either browse server or logon servers,
667 only the primary name of the machine will be advertised with these
668 capabilities.
669 Default: netbios aliases = # empty string (no additional names)
671 Example: netbios aliases = TEST TEST1 TEST2
673 netbios name (G)
675 This sets the NetBIOS name by which a Samba server is known. By
677 default it is the same as the first component of the host´s DNS
678 name. If a machine is a browse server or logon server this name (or
679 the first component of the hosts DNS name) will be the name that
680 these services are advertised under.
681 Note that the maximum length for a NetBIOS name is 15 charactars.
683 There is a bug in Samba that breaks operation of browsing and
685 access to shares if the netbios name is set to the literal name
686 PIPE. To avoid this problem, do not name your Samba server PIPE.
687 Default: netbios name = # machine DNS name
689 Example: netbios name = MYNAME
691 netbios scope (G)
693 This sets the NetBIOS scope that Samba will operate under. This
695 should not be set unless every machine on your LAN also sets this
696 value.
697 Default: netbios scope =
699 directory
701 This parameter is a synonym for path.
703 path (S)
705 This parameter specifies a directory to which the user of the
707 service is to be given access. In the case of printable services,
708 this is where print data will spool prior to being submitted to the
709 host for printing.
710 For a printable service offering guest access, the service should
712 be readonly and the path should be world-writeable and have the
713 sticky bit set. This is not mandatory of course, but you probably
714 won´t get the results you expect if you do otherwise.
715 Any occurrences of %u in the path will be replaced with the UNIX
717 username that the client is using on this connection. Any
718 occurrences of %m will be replaced by the NetBIOS name of the
719 machine they are connecting from. These replacements are very
720 useful for setting up pseudo home directories for users.
721 Note that this path will be based on root dir if one was specified.
723 Default: path =
725 Example: path = /home/fred
727 realm (G)
729 This option specifies the kerberos realm to use. The realm is used
731 as the ADS equivalent of the NT4 domain. It is usually set to the
732 DNS name of the kerberos server.
733 Default: realm =
735 Example: realm = mysambabox.mycompany.com
737 server services (G)
739 This option contains the services that the Samba daemon will run.
741 An entry in the smb.conf file can either override the previous
743 value completely or entries can be removed from or added to it by
744 prefixing them with + or -.
745 Default: server services = s3fs, rpc, nbt, wrepl, ldap, cldap, kdc,
747 drepl, winbindd, ntp_signd, kcc, dnsupdate, dns
748 Example: server services = -s3fs, +smb
750 server string (G)
752 This controls what string will show up in the printer comment box
754 in print manager and next to the IPC connection in net view. It can
755 be any string that you wish to show to your users.
756 It also sets what will appear in browse lists next to the machine
758 name.
759 A %v will be replaced with the Samba version number.
761 A %h will be replaced with the hostname.
763 Default: server string = Samba %v
765 Example: server string = University of GNUs Samba Server
767 share backend (G)
769 This option specifies the backend that will be used to access the
771 configuration of file shares.
772 Traditionally, Samba file shares have been configured in the
774 smb.conf file and this is still the default.
775 At the moment there are no other supported backends.
777 Default: share backend = classic
779 unix charset (G)
781 Specifies the charset the unix machine Samba runs on uses. Samba
783 needs to know this in order to be able to convert text to the
784 charsets other SMB clients use.
785 This is also the charset Samba will use when specifying arguments
787 to scripts that it invokes.
788 Default: unix charset = UTF-8
790 Example: unix charset = ASCII
792 workgroup (G)
794 This controls what workgroup your server will appear to be in when
796 queried by clients. Note that this parameter also controls the
797 Domain name used with the security = domain setting.
798 Default: workgroup = WORKGROUP
800 Example: workgroup = MYGROUP
802 administrative share (S)
804 If this parameter is set to yes for a share, then the share will be
806 an administrative share. The Administrative Shares are the default
807 network shares created by all Windows NT-based operating systems.
808 These are shares like C$, D$ or ADMIN$. The type of these shares is
809 STYPE_DISKTREE_HIDDEN.
810 See the section below on security for more information about this
812 option.
813 Default: administrative share = no
815 browsable
817 This parameter is a synonym for browseable.
819 browseable (S)
821 This controls whether this share is seen in the list of available
823 shares in a net view and in the browse list.
824 Default: browseable = yes
826 browse list (G)
828 This controls whether smbd(8) will serve a browse list to a client
830 doing a NetServerEnum call. Normally set to yes. You should never
831 need to change this.
832 Default: browse list = yes
834 domain master (G)
836 Tell smbd(8) to enable WAN-wide browse list collation. Setting this
838 option causes nmbd to claim a special domain specific NetBIOS name
839 that identifies it as a domain master browser for its given
840 workgroup. Local master browsers in the same workgroup on
841 broadcast-isolated subnets will give this nmbd their local browse
842 lists, and then ask smbd(8) for a complete copy of the browse list
843 for the whole wide area network. Browser clients will then contact
844 their local master browser, and will receive the domain-wide browse
845 list, instead of just the list for their broadcast-isolated subnet.
846 Note that Windows NT Primary Domain Controllers expect to be able
848 to claim this workgroup specific special NetBIOS name that
849 identifies them as domain master browsers for that workgroup by
850 default (i.e. there is no way to prevent a Windows NT PDC from
851 attempting to do this). This means that if this parameter is set
852 and nmbd claims the special name for a workgroup before a Windows
853 NT PDC is able to do so then cross subnet browsing will behave
854 strangely and may fail.
855 If domain logons = yes, then the default behavior is to enable the
857 domain master parameter. If domain logons is not enabled (the
858 default setting), then neither will domain master be enabled by
859 default.
860 When domain logons = Yes the default setting for this parameter is
862 Yes, with the result that Samba will be a PDC. If domain master =
863 No, Samba will function as a BDC. In general, this parameter should
864 be set to ´No´ only on a BDC.
865 Default: domain master = auto
867 enhanced browsing (G)
869 This option enables a couple of enhancements to cross-subnet browse
871 propagation that have been added in Samba but which are not
872 standard in Microsoft implementations.
873 The first enhancement to browse propagation consists of a regular
875 wildcard query to a Samba WINS server for all Domain Master
876 Browsers, followed by a browse synchronization with each of the
877 returned DMBs. The second enhancement consists of a regular
878 randomised browse synchronization with all currently known DMBs.
879 You may wish to disable this option if you have a problem with
881 empty workgroups not disappearing from browse lists. Due to the
882 restrictions of the browse protocols, these enhancements can cause
883 a empty workgroup to stay around forever which can be annoying.
884 In general you should leave this option enabled as it makes
886 cross-subnet browse propagation much more reliable.
887 Default: enhanced browsing = yes
889 lm announce (G)
891 This parameter determines if nmbd(8) will produce Lanman announce
893 broadcasts that are needed by OS/2 clients in order for them to see
894 the Samba server in their browse list. This parameter can have
895 three values, yes, no, or auto. The default is auto. If set to no
896 Samba will never produce these broadcasts. If set to yes Samba will
897 produce Lanman announce broadcasts at a frequency set by the
898 parameter lm interval. If set to auto Samba will not send Lanman
899 announce broadcasts by default but will listen for them. If it
900 hears such a broadcast on the wire it will then start sending them
901 at a frequency set by the parameter lm interval.
902 Default: lm announce = auto
904 Example: lm announce = yes
906 lm interval (G)
908 If Samba is set to produce Lanman announce broadcasts needed by
910 OS/2 clients (see the lm announce parameter) then this parameter
911 defines the frequency in seconds with which they will be made. If
912 this is set to zero then no Lanman announcements will be made
913 despite the setting of the lm announce parameter.
914 Default: lm interval = 60
916 Example: lm interval = 120
918 local master (G)
920 This option allows nmbd(8) to try and become a local master browser
922 on a subnet. If set to no then nmbd will not attempt to become a
923 local master browser on a subnet and will also lose in all browsing
924 elections. By default this value is set to yes. Setting this value
925 to yes doesn´t mean that Samba will become the local master browser
926 on a subnet, just that nmbd will participate in elections for local
927 master browser.
928 Setting this value to no will cause nmbd never to become a local
930 master browser.
931 Default: local master = yes
933 os level (G)
935 This integer value controls what level Samba advertises itself as
937 for browse elections. The value of this parameter determines
938 whether nmbd(8) has a chance of becoming a local master browser for
939 the workgroup in the local broadcast area.
940 Note: By default, Samba will win a local master browsing election
942 over all Microsoft operating systems except a Windows NT 4.0/2000
943 Domain Controller. This means that a misconfigured Samba host can
944 effectively isolate a subnet for browsing purposes. This parameter
945 is largely auto-configured in the Samba-3 release series and it is
946 seldom necessary to manually override the default setting. Please
947 refer to the chapter on Network Browsing in the Samba-3 HOWTO
948 document for further information regarding the use of this
949 parameter. Note: The maximum value for this parameter is 255. If
950 you use higher values, counting will start at 0!
951 Default: os level = 20
953 Example: os level = 65
955 prefered master
957 This parameter is a synonym for preferred master.
959 preferred master (G)
961 This boolean parameter controls if nmbd(8) is a preferred master
963 browser for its workgroup.
964 If this is set to yes, on startup, nmbd will force an election, and
966 it will have a slight advantage in winning the election. It is
967 recommended that this parameter is used in conjunction with domain
968 master = yes, so that nmbd can guarantee becoming a domain master.
969 Use this option with caution, because if there are several hosts
971 (whether Samba servers, Windows 95 or NT) that are preferred master
972 browsers on the same subnet, they will each periodically and
973 continuously attempt to become the local master browser. This will
974 result in unnecessary broadcast traffic and reduced browsing
975 capabilities.
976 Default: preferred master = auto
978 allow dns updates (G)
980 This option determines what kind of updates to the DNS are allowed.
982 DNS updates can either be disallowed completely by setting it to
984 disabled, enabled over secure connections only by setting it to
985 secure only or allowed in all cases by setting it to nonsecure.
986 Default: allow dns updates = secure only
988 Example: allow dns updates = disabled
990 dns forwarder (G)
992 This option specifies the DNS server that DNS requests will be
994 forwarded to if they can not be handled by Samba itself.
995 The DNS forwarder is only used if the internal DNS server in Samba
997 is used.
998 Default: dns forwarder =
1000 Example: dns forwarder = 192.168.0.1
1002 dns update command (G)
1004 This option sets the command that is called when there are DNS
1006 updates. It should update the local machines DNS names using
1007 TSIG-GSS.
1008 Default: dns update command =
1010 /builddir/build/BUILD/samba-4.2.10/source4/scripting/bin/samba_dnsupdate
1011 Example: dns update command = /usr/local/sbin/dnsupdate
1013 machine password timeout (G)
1015 If a Samba server is a member of a Windows NT Domain (see the
1017 security = domain parameter) then periodically a running smbd
1018 process will try and change the MACHINE ACCOUNT PASSWORD stored in
1019 the TDB called private/secrets.tdb (or private/secrets.ntdb). This
1020 parameter specifies how often this password will be changed, in
1021 seconds. The default is one week (expressed in seconds), the same
1022 as a Windows NT Domain member server.
1023 See also smbpasswd(8), and the security = domain parameter.
1025 Default: machine password timeout = 604800
1027 nsupdate command (G)
1029 This option sets the path to the nsupdate command which is used for
1031 GSS-TSIG dynamic DNS updates.
1032 Default: nsupdate command = /usr/bin/nsupdate -g
1034 rndc command (G)
1036 This option specifies the path to the name server control utility.
1038 The rndc utility should be a part of the bind installation.
1040 Default: rndc command = /usr/sbin/rndc
1042 Example: rndc command = /usr/local/bind9/sbin/rndc
1044 spn update command (G)
1046 This option sets the command that for updating servicePrincipalName
1048 names from spn_update_list.
1049 Default: spn update command =
1051 /builddir/build/BUILD/samba-4.2.10/source4/scripting/bin/samba_spnupdate
1052 Example: spn update command = /usr/local/sbin/spnupdate
1054 casesignames
1056 This parameter is a synonym for case sensitive.
1058 case sensitive (S)
1060 See the discussion in the section name mangling.
1062 Default: case sensitive = auto
1064 default case (S)
1066 See the section on name mangling. Also note the short preserve case
1068 parameter.
1069 Default: default case = lower
1071 delete veto files (S)
1073 This option is used when Samba is attempting to delete a directory
1075 that contains one or more vetoed directories (see the veto files
1076 option). If this option is set to no (the default) then if a vetoed
1077 directory contains any non-vetoed files or directories then the
1078 directory delete will fail. This is usually what you want.
1079 If this option is set to yes, then Samba will attempt to
1081 recursively delete any files and directories within the vetoed
1082 directory. This can be useful for integration with file serving
1083 systems such as NetAtalk which create meta-files within directories
1084 you might normally veto DOS/Windows users from seeing (e.g.
1085 .AppleDouble)
1086 Setting delete veto files = yes allows these directories to be
1088 transparently deleted when the parent directory is deleted (so long
1089 as the user has permissions to do so).
1090 Default: delete veto files = no
1092 hide dot files (S)
1094 This is a boolean parameter that controls whether files starting
1096 with a dot appear as hidden files.
1097 Default: hide dot files = yes
1099 hide files (S)
1101 This is a list of files or directories that are not visible but are
1103 accessible. The DOS ´hidden´ attribute is applied to any files or
1104 directories that match.
1105 Each entry in the list must be separated by a ´/´, which allows
1107 spaces to be included in the entry. ´*´ and ´?´ can be used to
1108 specify multiple files or directories as in DOS wildcards.
1109 Each entry must be a Unix path, not a DOS path and must not include
1111 the Unix directory separator ´/´.
1112 Note that the case sensitivity option is applicable in hiding
1114 files.
1115 Setting this parameter will affect the performance of Samba, as it
1117 will be forced to check all files and directories for a match as
1118 they are scanned.
1119 The example shown above is based on files that the Macintosh SMB
1121 client (DAVE) available from Thursby creates for internal use, and
1122 also still hides all files beginning with a dot.
1123 An example of us of this parameter is:
1125 hide files = /.*/DesktopFolderDB/TrashFor%m/resource.frk/
1127 Default: hide files = # no file are hidden
1129 hide special files (S)
1131 This parameter prevents clients from seeing special files such as
1133 sockets, devices and fifo´s in directory listings.
1134 Default: hide special files = no
1136 hide unreadable (S)
1138 This parameter prevents clients from seeing the existance of files
1140 that cannot be read. Defaults to off.
1141 Please note that enabling this can slow down listing large
1143 directories significantly. Samba has to evaluate the ACLs of all
1144 directory members, which can be a lot of effort.
1145 Default: hide unreadable = no
1147 hide unwriteable files (S)
1149 This parameter prevents clients from seeing the existance of files
1151 that cannot be written to. Defaults to off. Note that unwriteable
1152 directories are shown as usual.
1153 Please note that enabling this can slow down listing large
1155 directories significantly. Samba has to evaluate the ACLs of all
1156 directory members, which can be a lot of effort.
1157 Default: hide unwriteable files = no
1159 mangled names (S)
1161 This controls whether non-DOS names under UNIX should be mapped to
1163 DOS-compatible names ("mangled") and made visible, or whether
1164 non-DOS names should simply be ignored.
1165 See the section on name mangling for details on how to control the
1167 mangling process.
1168 If mangling is used then the mangling method is as follows:
1170 · The first (up to) five alphanumeric characters before the
1172 rightmost dot of the filename are preserved, forced to upper
1173 case, and appear as the first (up to) five characters of the
1174 mangled name.
1175 · A tilde "~" is appended to the first part of the mangled name,
1177 followed by a two-character unique sequence, based on the
1178 original root name (i.e., the original filename minus its final
1179 extension). The final extension is included in the hash
1180 calculation only if it contains any upper case characters or is
1181 longer than three characters.
1182 Note that the character to use may be specified using the
1184 mangling char option, if you don´t like ´~´.
1185 · Files whose UNIX name begins with a dot will be presented as
1187 DOS hidden files. The mangled name will be created as for other
1188 filenames, but with the leading dot removed and "___" as its
1189 extension regardless of actual original extension (that´s three
1190 underscores).
1191 The two-digit hash value consists of upper case alphanumeric
1193 characters.
1194 This algorithm can cause name collisions only if files in a directory
1196 share the same first five alphanumeric characters. The probability of
1197 such a clash is 1/1300.
1198 The name mangling (if enabled) allows a file to be copied between UNIX
1200 directories from Windows/DOS while retaining the long UNIX filename.
1201 UNIX files can be renamed to a new extension from Windows/DOS and will
1202 retain the same basename. Mangled names do not change between sessions.
1203 Default: mangled names = yes
1205 mangle prefix (G)
1207 controls the number of prefix characters from the original name
1209 used when generating the mangled names. A larger value will give a
1210 weaker hash and therefore more name collisions. The minimum value
1211 is 1 and the maximum value is 6.
1212 mangle prefix is effective only when mangling method is hash2.
1214 Default: mangle prefix = 1
1216 Example: mangle prefix = 4
1218 mangling char (S)
1220 This controls what character is used as the magic character in name
1222 mangling. The default is a ´~´ but this may interfere with some
1223 software. Use this option to set it to whatever you prefer. This is
1224 effective only when mangling method is hash.
1225 Default: mangling char = ~
1227 Example: mangling char = ^
1229 mangling method (G)
1231 controls the algorithm used for the generating the mangled names.
1233 Can take two different values, "hash" and "hash2". "hash" is the
1234 algorithm that was used in Samba for many years and was the default
1235 in Samba 2.2.x "hash2" is now the default and is newer and
1236 considered a better algorithm (generates less collisions) in the
1237 names. Many Win32 applications store the mangled names and so
1238 changing to algorithms must not be done lightly as these
1239 applications may break unless reinstalled.
1240 Default: mangling method = hash2
1242 Example: mangling method = hash
1244 map archive (S)
1246 This controls whether the DOS archive attribute should be mapped to
1248 the UNIX owner execute bit. The DOS archive bit is set when a file
1249 has been modified since its last backup. One motivation for this
1250 option is to keep Samba/your PC from making any file it touches
1251 from becoming executable under UNIX. This can be quite annoying for
1252 shared source code, documents, etc...
1253 Note that this parameter will be ignored if the store dos
1255 attributes parameter is set, as the DOS archive attribute will then
1256 be stored inside a UNIX extended attribute.
1257 Note that this requires the create mask parameter to be set such
1259 that owner execute bit is not masked out (i.e. it must include
1260 100). See the parameter create mask for details.
1261 Default: map archive = yes
1263 map hidden (S)
1265 This controls whether DOS style hidden files should be mapped to
1267 the UNIX world execute bit.
1268 Note that this parameter will be ignored if the store dos
1270 attributes parameter is set, as the DOS hidden attribute will then
1271 be stored inside a UNIX extended attribute.
1272 Note that this requires the create mask to be set such that the
1274 world execute bit is not masked out (i.e. it must include 001). See
1275 the parameter create mask for details.
1276 Default: map hidden = no
1278 map readonly (S)
1280 This controls how the DOS read only attribute should be mapped from
1282 a UNIX filesystem.
1283 This parameter can take three different values, which tell smbd(8)
1285 how to display the read only attribute on files, where either store
1286 dos attributes is set to No, or no extended attribute is present.
1287 If store dos attributes is set to yes then this parameter is
1288 ignored. This is a new parameter introduced in Samba version
1289 3.0.21.
1290 The three settings are :
1292 · Yes - The read only DOS attribute is mapped to the inverse of
1294 the user or owner write bit in the unix permission mode set. If
1295 the owner write bit is not set, the read only attribute is
1296 reported as being set on the file. If the read only DOS
1297 attribute is set, Samba sets the owner, group and others write
1298 bits to zero. Write bits set in an ACL are ignored by Samba. If
1299 the read only DOS attribute is unset, Samba simply sets the
1300 write bit of the owner to one.
1301 · Permissions - The read only DOS attribute is mapped to the
1303 effective permissions of the connecting user, as evaluated by
1304 smbd(8) by reading the unix permissions and POSIX ACL (if
1305 present). If the connecting user does not have permission to
1306 modify the file, the read only attribute is reported as being
1307 set on the file.
1308 · No - The read only DOS attribute is unaffected by permissions,
1310 and can only be set by the store dos attributes method. This
1311 may be useful for exporting mounted CDs.
1312 Note that this parameter will be ignored if the store dos attributes
1314 parameter is set, as the DOS ´read-only´ attribute will then be stored
1315 inside a UNIX extended attribute.
1316 Default: map readonly = yes
1318 map system (S)
1320 This controls whether DOS style system files should be mapped to
1322 the UNIX group execute bit.
1323 Note that this parameter will be ignored if the store dos
1325 attributes parameter is set, as the DOS system attribute will then
1326 be stored inside a UNIX extended attribute.
1327 Note that this requires the create mask to be set such that the
1329 group execute bit is not masked out (i.e. it must include 010). See
1330 the parameter create mask for details.
1331 Default: map system = no
1333 max stat cache size (G)
1335 This parameter limits the size in memory of any stat cache being
1337 used to speed up case insensitive name mappings. It represents the
1338 number of kilobyte (1024) units the stat cache can use. A value of
1339 zero, meaning unlimited, is not advisable due to increased memory
1340 usage. You should not need to change this parameter.
1341 Default: max stat cache size = 256
1343 Example: max stat cache size = 100
1345 preserve case (S)
1347 This controls if new filenames are created with the case that the
1349 client passes, or if they are forced to be the default case.
1350 See the section on NAME MANGLING for a fuller discussion.
1352 Default: preserve case = yes
1354 short preserve case (S)
1356 This boolean parameter controls if new files which conform to 8.3
1358 syntax, that is all in upper case and of suitable length, are
1359 created upper case, or if they are forced to be the default case.
1360 This option can be use with preserve case = yes to permit long
1361 filenames to retain their case, while short names are lowered.
1362 See the section on NAME MANGLING.
1364 Default: short preserve case = yes
1366 stat cache (G)
1368 This parameter determines if smbd(8) will use a cache in order to
1370 speed up case insensitive name mappings. You should never need to
1371 change this parameter.
1372 Default: stat cache = yes
1374 store dos attributes (S)
1376 If this parameter is set Samba attempts to first read DOS
1378 attributes (SYSTEM, HIDDEN, ARCHIVE or READ-ONLY) from a filesystem
1379 extended attribute, before mapping DOS attributes to UNIX
1380 permission bits (such as occurs with map hidden and map readonly).
1381 When set, DOS attributes will be stored onto an extended attribute
1382 in the UNIX filesystem, associated with the file or directory. When
1383 this parameter is set it will override the parameters map hidden,
1384 map system, map archive and map readonly and they will behave as if
1385 they were set to off. This parameter writes the DOS attributes as a
1386 string into the extended attribute named "user.DOSATTRIB". This
1387 extended attribute is explicitly hidden from smbd clients
1388 requesting an EA list. On Linux the filesystem must have been
1389 mounted with the mount option user_xattr in order for extended
1390 attributes to work, also extended attributes must be compiled into
1391 the Linux kernel. In Samba 3.5.0 and above the "user.DOSATTRIB"
1392 extended attribute has been extended to store the create time for a
1393 file as well as the DOS attributes. This is done in a backwards
1394 compatible way so files created by Samba 3.5.0 and above can still
1395 have the DOS attribute read from this extended attribute by earlier
1396 versions of Samba, but they will not be able to read the create
1397 time stored there. Storing the create time separately from the
1398 normal filesystem meta-data allows Samba to faithfully reproduce
1399 NTFS semantics on top of a POSIX filesystem.
1400 Default: store dos attributes = no
1402 veto files (S)
1404 This is a list of files and directories that are neither visible
1406 nor accessible. Each entry in the list must be separated by a ´/´,
1407 which allows spaces to be included in the entry. ´*´ and ´?´ can be
1408 used to specify multiple files or directories as in DOS wildcards.
1409 Each entry must be a unix path, not a DOS path and must not include
1411 the unix directory separator ´/´.
1412 Note that the case sensitive option is applicable in vetoing files.
1414 One feature of the veto files parameter that it is important to be
1416 aware of is Samba´s behaviour when trying to delete a directory. If
1417 a directory that is to be deleted contains nothing but veto files
1418 this deletion will fail unless you also set the delete veto files
1419 parameter to yes.
1420 Setting this parameter will affect the performance of Samba, as it
1422 will be forced to check all files and directories for a match as
1423 they are scanned.
1424 Examples of use include:
1426 ; Veto any files containing the word Security,
1428 ; any ending in .tmp, and any directory containing the
1429 ; word root.
1430 veto files = /*Security*/*.tmp/*root*/
1431 ; Veto the Apple specific files that a NetAtalk server
1433 ; creates.
1434 veto files = /.AppleDouble/.bin/.AppleDesktop/Network Trash Folder/
1435 Default: veto files = # No files or directories are vetoed
1437 veto oplock files (S)
1439 This parameter is only valid when the oplocks parameter is turned
1441 on for a share. It allows the Samba administrator to selectively
1442 turn off the granting of oplocks on selected files that match a
1443 wildcarded list, similar to the wildcarded list used in the veto
1444 files parameter.
1445 You might want to do this on files that you know will be heavily
1447 contended for by clients. A good example of this is in the NetBench
1448 SMB benchmark program, which causes heavy client contention for
1449 files ending in .SEM. To cause Samba not to grant oplocks on these
1450 files you would use the line (either in the [global] section or in
1451 the section for the particular NetBench share.
1452 An example of use is:
1454 veto oplock files = /.*SEM/
1456 Default: veto oplock files = # No files are vetoed for oplock
1458 grants
1459 client ldap sasl wrapping (G)
1461 The client ldap sasl wrapping defines whether ldap traffic will be
1463 signed or signed and encrypted (sealed). Possible values are plain,
1464 sign and seal.
1465 The values sign and seal are only available if Samba has been
1467 compiled against a modern OpenLDAP version (2.3.x or higher).
1468 This option is needed in the case of Domain Controllers enforcing
1470 the usage of signed LDAP connections (e.g. Windows 2000 SP3 or
1471 higher). LDAP sign and seal can be controlled with the registry key
1472 "HKLM\System\CurrentControlSet\Services\
1473 NTDS\Parameters\LDAPServerIntegrity" on the Windows server side.
1474 Depending on the used KRB5 library (MIT and older Heimdal versions)
1476 it is possible that the message "integrity only" is not supported.
1477 In this case, sign is just an alias for seal.
1478 The default value is sign. That implies synchronizing the time with
1480 the KDC in the case of using Kerberos.
1481 Default: client ldap sasl wrapping = sign
1483 ldap admin dn (G)
1485 The ldap admin dn defines the Distinguished Name (DN) name used by
1487 Samba to contact the ldap server when retreiving user account
1488 information. The ldap admin dn is used in conjunction with the
1489 admin dn password stored in the private/secrets.tdb (or
1490 private/secrets.ntdb) file. See the smbpasswd(8) man page for more
1491 information on how to accomplish this.
1492 The ldap admin dn requires a fully specified DN. The ldap suffix is
1494 not appended to the ldap admin dn.
1495 No default
1497 ldap connection timeout (G)
1499 This parameter tells the LDAP library calls which timeout in
1501 seconds they should honor during initial connection establishments
1502 to LDAP servers. It is very useful in failover scenarios in
1503 particular. If one or more LDAP servers are not reachable at all,
1504 we do not have to wait until TCP timeouts are over. This feature
1505 must be supported by your LDAP library.
1506 This parameter is different from ldap timeout which affects
1508 operations on LDAP servers using an existing connection and not
1509 establishing an initial connection.
1510 Default: ldap connection timeout = 2
1512 ldap delete dn (G)
1514 This parameter specifies whether a delete operation in the ldapsam
1516 deletes the complete entry or only the attributes specific to
1517 Samba.
1518 Default: ldap delete dn = no
1520 ldap deref (G)
1522 This option controls whether Samba should tell the LDAP library to
1524 use a certain alias dereferencing method. The default is auto,
1525 which means that the default setting of the ldap client library
1526 will be kept. Other possible values are never, finding, searching
1527 and always. Grab your LDAP manual for more information.
1528 Default: ldap deref = auto
1530 Example: ldap deref = searching
1532 ldap follow referral (G)
1534 This option controls whether to follow LDAP referrals or not when
1536 searching for entries in the LDAP database. Possible values are on
1537 to enable following referrals, off to disable this, and auto, to
1538 use the libldap default settings. libldap´s choice of following
1539 referrals or not is set in /etc/openldap/ldap.conf with the
1540 REFERRALS parameter as documented in ldap.conf(5).
1541 Default: ldap follow referral = auto
1543 Example: ldap follow referral = off
1545 ldap group suffix (G)
1547 This parameter specifies the suffix that is used for groups when
1549 these are added to the LDAP directory. If this parameter is unset,
1550 the value of ldap suffix will be used instead. The suffix string is
1551 pre-pended to the ldap suffix string so use a partial DN.
1552 Default: ldap group suffix =
1554 Example: ldap group suffix = ou=Groups
1556 ldap idmap suffix (G)
1558 This parameters specifies the suffix that is used when storing
1560 idmap mappings. If this parameter is unset, the value of ldap
1561 suffix will be used instead. The suffix string is pre-pended to the
1562 ldap suffix string so use a partial DN.
1563 Default: ldap idmap suffix =
1565 Example: ldap idmap suffix = ou=Idmap
1567 ldap machine suffix (G)
1569 It specifies where machines should be added to the ldap tree. If
1571 this parameter is unset, the value of ldap suffix will be used
1572 instead. The suffix string is pre-pended to the ldap suffix string
1573 so use a partial DN.
1574 Default: ldap machine suffix =
1576 Example: ldap machine suffix = ou=Computers
1578 ldap page size (G)
1580 This parameter specifies the number of entries per page.
1582 If the LDAP server supports paged results, clients can request
1584 subsets of search results (pages) instead of the entire list. This
1585 parameter specifies the size of these pages.
1586 Default: ldap page size = 1024
1588 Example: ldap page size = 512
1590 ldap password sync
1592 This parameter is a synonym for ldap passwd sync.
1594 ldap passwd sync (G)
1596 This option is used to define whether or not Samba should sync the
1598 LDAP password with the NT and LM hashes for normal accounts (NOT
1599 for workstation, server or domain trusts) on a password change via
1600 SAMBA.
1601 The ldap passwd sync can be set to one of three values:
1603 · Yes = Try to update the LDAP, NT and LM passwords and update
1605 the pwdLastSet time.
1606 · No = Update NT and LM passwords and update the pwdLastSet time.
1608 · Only = Only update the LDAP password and let the LDAP server do
1610 the rest.
1611 Default: ldap passwd sync = no
1613 ldap replication sleep (G)
1615 When Samba is asked to write to a read-only LDAP replica, we are
1617 redirected to talk to the read-write master server. This server
1618 then replicates our changes back to the ´local´ server, however the
1619 replication might take some seconds, especially over slow links.
1620 Certain client activities, particularly domain joins, can become
1621 confused by the ´success´ that does not immediately change the LDAP
1622 back-end´s data.
1623 This option simply causes Samba to wait a short time, to allow the
1625 LDAP server to catch up. If you have a particularly high-latency
1626 network, you may wish to time the LDAP replication with a network
1627 sniffer, and increase this value accordingly. Be aware that no
1628 checking is performed that the data has actually replicated.
1629 The value is specified in milliseconds, the maximum value is 5000
1631 (5 seconds).
1632 Default: ldap replication sleep = 1000
1634 ldapsam:editposix (G)
1636 Editposix is an option that leverages ldapsam:trusted to make it
1638 simpler to manage a domain controller eliminating the need to set
1639 up custom scripts to add and manage the posix users and groups.
1640 This option will instead directly manipulate the ldap tree to
1641 create, remove and modify user and group entries. This option also
1642 requires a running winbindd as it is used to allocate new uids/gids
1643 on user/group creation. The allocation range must be therefore
1644 configured.
1645 To use this option, a basic ldap tree must be provided and the ldap
1647 suffix parameters must be properly configured. On virgin servers
1648 the default users and groups (Administrator, Guest, Domain Users,
1649 Domain Admins, Domain Guests) can be precreated with the command
1650 net sam provision. To run this command the ldap server must be
1651 running, Winbindd must be running and the smb.conf ldap options
1652 must be properly configured. The typical ldap setup used with the
1653 ldapsam:trusted = yes option is usually sufficient to use
1654 ldapsam:editposix = yes as well.
1655 An example configuration can be the following:
1657 encrypt passwords = true
1659 passdb backend = ldapsam
1660 ldapsam:trusted=yes
1662 ldapsam:editposix=yes
1663 ldap admin dn = cn=admin,dc=samba,dc=org
1665 ldap delete dn = yes
1666 ldap group suffix = ou=groups
1667 ldap idmap suffix = ou=idmap
1668 ldap machine suffix = ou=computers
1669 ldap user suffix = ou=users
1670 ldap suffix = dc=samba,dc=org
1671 idmap backend = ldap:"ldap://localhost"
1673 idmap uid = 5000-50000
1675 idmap gid = 5000-50000
1676 This configuration assumes a directory layout like described in the
1679 following ldif:
1680 dn: dc=samba,dc=org
1682 objectClass: top
1683 objectClass: dcObject
1684 objectClass: organization
1685 o: samba.org
1686 dc: samba
1687 dn: cn=admin,dc=samba,dc=org
1689 objectClass: simpleSecurityObject
1690 objectClass: organizationalRole
1691 cn: admin
1692 description: LDAP administrator
1693 userPassword: secret
1694 dn: ou=users,dc=samba,dc=org
1696 objectClass: top
1697 objectClass: organizationalUnit
1698 ou: users
1699 dn: ou=groups,dc=samba,dc=org
1701 objectClass: top
1702 objectClass: organizationalUnit
1703 ou: groups
1704 dn: ou=idmap,dc=samba,dc=org
1706 objectClass: top
1707 objectClass: organizationalUnit
1708 ou: idmap
1709 dn: ou=computers,dc=samba,dc=org
1711 objectClass: top
1712 objectClass: organizationalUnit
1713 ou: computers
1714 Default: ldapsam:editposix = no
1717 ldapsam:trusted (G)
1719 By default, Samba as a Domain Controller with an LDAP backend needs
1721 to use the Unix-style NSS subsystem to access user and group
1722 information. Due to the way Unix stores user information in
1723 /etc/passwd and /etc/group this inevitably leads to inefficiencies.
1724 One important question a user needs to know is the list of groups
1725 he is member of. The plain UNIX model involves a complete
1726 enumeration of the file /etc/group and its NSS counterparts in
1727 LDAP. UNIX has optimized functions to enumerate group membership.
1728 Sadly, other functions that are used to deal with user and group
1729 attributes lack such optimization.
1730 To make Samba scale well in large environments, the ldapsam:trusted
1732 = yes option assumes that the complete user and group database that
1733 is relevant to Samba is stored in LDAP with the standard
1734 posixAccount/posixGroup attributes. It further assumes that the
1735 Samba auxiliary object classes are stored together with the POSIX
1736 data in the same LDAP object. If these assumptions are met,
1737 ldapsam:trusted = yes can be activated and Samba can bypass the NSS
1738 system to query user group memberships. Optimized LDAP queries can
1739 greatly speed up domain logon and administration tasks. Depending
1740 on the size of the LDAP database a factor of 100 or more for common
1741 queries is easily achieved.
1742 Default: ldapsam:trusted = no
1744 ldap server require strong auth (G)
1746 The ldap server require strong auth defines whether the ldap server
1748 requires ldap traffic to be signed or signed and encrypted
1749 (sealed). Possible values are no, allow_sasl_over_tls and yes.
1750 A value of no allows simple and sasl binds over all transports.
1752 A value of allow_sasl_over_tls allows simple and sasl binds
1754 (without sign or seal) over TLS encrypted connections. Unencrypted
1755 connections only allow sasl binds with sign or seal.
1756 A value of yes allows only simple binds over TLS encrypted
1758 connections. Unencrypted connections only allow sasl binds with
1759 sign or seal.
1760 Default: ldap server require strong auth = yes
1762 ldap ssl (G)
1764 This option is used to define whether or not Samba should use SSL
1766 when connecting to the ldap server This is NOT related to Samba´s
1767 previous SSL support which was enabled by specifying the --with-ssl
1768 option to the configure script.
1769 LDAP connections should be secured where possible. This may be done
1771 setting either this parameter to Start_tls or by specifying
1772 ldaps:// in the URL argument of passdb backend.
1773 The ldap ssl can be set to one of two values:
1775 · Off = Never use SSL when querying the directory.
1777 · start tls = Use the LDAPv3 StartTLS extended operation
1779 (RFC2830) for communicating with the directory server.
1780 Please note that this parameter does only affect rpc methods. To enable
1782 the LDAPv3 StartTLS extended operation (RFC2830) for ads, set ldap ssl
1783 = yes and ldap ssl ads = yes. See smb.conf(5) for more information on
1784 ldap ssl ads.
1785 Default: ldap ssl = start tls
1787 ldap ssl ads (G)
1789 This option is used to define whether or not Samba should use SSL
1791 when connecting to the ldap server using ads methods. Rpc methods
1792 are not affected by this parameter. Please note, that this
1793 parameter won´t have any effect if ldap ssl is set to no.
1794 See smb.conf(5) for more information on ldap ssl.
1796 Default: ldap ssl ads = no
1798 ldap suffix (G)
1800 Specifies the base for all ldap suffixes and for storing the
1802 sambaDomain object.
1803 The ldap suffix will be appended to the values specified for the
1805 ldap user suffix, ldap group suffix, ldap machine suffix, and the
1806 ldap idmap suffix. Each of these should be given only a DN relative
1807 to the ldap suffix.
1808 Default: ldap suffix =
1810 Example: ldap suffix = dc=samba,dc=org
1812 ldap timeout (G)
1814 This parameter defines the number of seconds that Samba should use
1816 as timeout for LDAP operations.
1817 Default: ldap timeout = 15
1819 ldap user suffix (G)
1821 This parameter specifies where users are added to the tree. If this
1823 parameter is unset, the value of ldap suffix will be used instead.
1824 The suffix string is pre-pended to the ldap suffix string so use a
1825 partial DN.
1826 Default: ldap user suffix =
1828 Example: ldap user suffix = ou=people
1830 blocking locks (S)
1832 This parameter controls the behavior of smbd(8) when given a
1834 request by a client to obtain a byte range lock on a region of an
1835 open file, and the request has a time limit associated with it.
1836 If this parameter is set and the lock range requested cannot be
1838 immediately satisfied, samba will internally queue the lock
1839 request, and periodically attempt to obtain the lock until the
1840 timeout period expires.
1841 If this parameter is set to no, then samba will behave as previous
1843 versions of Samba would and will fail the lock request immediately
1844 if the lock range cannot be obtained.
1845 Default: blocking locks = yes
1847 csc policy (S)
1849 This stands for client-side caching policy, and specifies how
1851 clients capable of offline caching will cache the files in the
1852 share. The valid values are: manual, documents, programs, disable.
1853 These values correspond to those used on Windows servers.
1855 For example, shares containing roaming profiles can have offline
1857 caching disabled using csc policy = disable.
1858 Default: csc policy = manual
1860 Example: csc policy = programs
1862 fake oplocks (S)
1864 Oplocks are the way that SMB clients get permission from a server
1866 to locally cache file operations. If a server grants an oplock
1867 (opportunistic lock) then the client is free to assume that it is
1868 the only one accessing the file and it will aggressively cache file
1869 data. With some oplock types the client may even cache file
1870 open/close operations. This can give enormous performance benefits.
1871 When you set fake oplocks = yes, smbd(8) will always grant oplock
1873 requests no matter how many clients are using the file.
1874 It is generally much better to use the real oplocks support rather
1876 than this parameter.
1877 If you enable this option on all read-only shares or shares that
1879 you know will only be accessed from one client at a time such as
1880 physically read-only media like CDROMs, you will see a big
1881 performance improvement on many operations. If you enable this
1882 option on shares where multiple clients may be accessing the files
1883 read-write at the same time you can get data corruption. Use this
1884 option carefully!
1885 Default: fake oplocks = no
1887 kernel oplocks (S)
1889 For UNIXes that support kernel based oplocks (currently only IRIX
1891 and the Linux 2.4 kernel), this parameter allows the use of them to
1892 be turned on or off. However, this disables Level II oplocks for
1893 clients as the Linux and IRIX kernels do not support them properly.
1894 Kernel oplocks support allows Samba oplocks to be broken whenever a
1896 local UNIX process or NFS operation accesses a file that smbd(8)
1897 has oplocked. This allows complete data consistency between
1898 SMB/CIFS, NFS and local file access (and is a very cool feature
1899 :-).
1900 If you do not need this interaction, you should disable the
1902 parameter on Linux and IRIX to get Level II oplocks and the
1903 associated performance benefit.
1904 This parameter defaults to no and is translated to a no-op on
1906 systems that do not have the necessary kernel support.
1907 Default: kernel oplocks = no
1909 kernel share modes (S)
1911 This parameter controls whether SMB share modes are translated into
1913 UNIX flocks.
1914 Kernel share modes provide a minimal level of interoperability with
1916 local UNIX processes and NFS operations by preventing access with
1917 flocks corresponding to the SMB share modes. Generally, it is very
1918 desirable to leave this enabled.
1919 Note that in order to use SMB2 durable file handles on a share, you
1921 have to turn kernel share modes off.
1922 This parameter defaults to yes and is translated to a no-op on
1924 systems that do not have the necessary kernel flock support.
1925 Default: kernel share modes = yes
1927 level2 oplocks (S)
1929 This parameter controls whether Samba supports level2 (read-only)
1931 oplocks on a share.
1932 Level2, or read-only oplocks allow Windows NT clients that have an
1934 oplock on a file to downgrade from a read-write oplock to a
1935 read-only oplock once a second client opens the file (instead of
1936 releasing all oplocks on a second open, as in traditional,
1937 exclusive oplocks). This allows all openers of the file that
1938 support level2 oplocks to cache the file for read-ahead only (ie.
1939 they may not cache writes or lock requests) and increases
1940 performance for many accesses of files that are not commonly
1941 written (such as application .EXE files).
1942 Once one of the clients which have a read-only oplock writes to the
1944 file all clients are notified (no reply is needed or waited for)
1945 and told to break their oplocks to "none" and delete any read-ahead
1946 caches.
1947 It is recommended that this parameter be turned on to speed access
1949 to shared executables.
1950 For more discussions on level2 oplocks see the CIFS spec.
1952 Currently, if kernel oplocks are supported then level2 oplocks are
1954 not granted (even if this parameter is set to yes). Note also, the
1955 oplocks parameter must be set to yes on this share in order for
1956 this parameter to have any effect.
1957 Default: level2 oplocks = yes
1959 locking (S)
1961 This controls whether or not locking will be performed by the
1963 server in response to lock requests from the client.
1964 If locking = no, all lock and unlock requests will appear to
1966 succeed and all lock queries will report that the file in question
1967 is available for locking.
1968 If locking = yes, real locking will be performed by the server.
1970 This option may be useful for read-only filesystems which may not
1972 need locking (such as CDROM drives), although setting this
1973 parameter of no is not really recommended even in this case.
1974 Be careful about disabling locking either globally or in a specific
1976 service, as lack of locking may result in data corruption. You
1977 should never need to set this parameter.
1978 Default: locking = yes
1980 lock spin time (G)
1982 The time in milliseconds that smbd should keep waiting to see if a
1984 failed lock request can be granted. This parameter has changed in
1985 default value from Samba 3.0.23 from 10 to 200. The associated lock
1986 spin count parameter is no longer used in Samba 3.0.24. You should
1987 not need to change the value of this parameter.
1988 Default: lock spin time = 200
1990 oplock break wait time (G)
1992 This is a tuning parameter added due to bugs in both Windows 9x and
1994 WinNT. If Samba responds to a client too quickly when that client
1995 issues an SMB that can cause an oplock break request, then the
1996 network client can fail and not respond to the break request. This
1997 tuning parameter (which is set in milliseconds) is the amount of
1998 time Samba will wait before sending an oplock break request to such
1999 (broken) clients.
2000 Warning
2002 DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ AND
2003 UNDERSTOOD THE SAMBA OPLOCK CODE.
2004 Default: oplock break wait time = 0
2005 oplock contention limit (S)
2007 This is a very advanced smbd(8) tuning option to improve the
2009 efficiency of the granting of oplocks under multiple client
2010 contention for the same file.
2011 In brief it specifies a number, which causes smbd(8)not to grant an
2013 oplock even when requested if the approximate number of clients
2014 contending for an oplock on the same file goes over this limit.
2015 This causes smbd to behave in a similar way to Windows NT.
2016 Warning
2018 DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ AND
2019 UNDERSTOOD THE SAMBA OPLOCK CODE.
2020 Default: oplock contention limit = 2
2021 oplocks (S)
2023 This boolean option tells smbd whether to issue oplocks
2025 (opportunistic locks) to file open requests on this share. The
2026 oplock code can dramatically (approx. 30% or more) improve the
2027 speed of access to files on Samba servers. It allows the clients to
2028 aggressively cache files locally and you may want to disable this
2029 option for unreliable network environments (it is turned on by
2030 default in Windows NT Servers).
2031 Oplocks may be selectively turned off on certain files with a
2033 share. See the veto oplock files parameter. On some systems oplocks
2034 are recognized by the underlying operating system. This allows data
2035 synchronization between all access to oplocked files, whether it be
2036 via Samba or NFS or a local UNIX process. See the kernel oplocks
2037 parameter for details.
2038 Default: oplocks = yes
2040 posix locking (S)
2042 The smbd(8) daemon maintains an database of file locks obtained by
2044 SMB clients. The default behavior is to map this internal database
2045 to POSIX locks. This means that file locks obtained by SMB clients
2046 are consistent with those seen by POSIX compliant applications
2047 accessing the files via a non-SMB method (e.g. NFS or local file
2048 access). It is very unlikely that you need to set this parameter to
2049 "no", unless you are sharing from an NFS mount, which is not a good
2050 idea in the first place.
2051 Default: posix locking = yes
2053 smb2 leases (G)
2055 This boolean option tells smbd whether to globally negotiate SMB2
2057 leases on file open requests. Leasing is an SMB2-only feature which
2058 allows clients to aggressively cache files locally above and beyond
2059 the caching allowed by SMB1 oplocks. This (experimental) parameter
2060 is set to off by default until the SMB2 leasing code is declared
2061 fully stable.
2062 This is only available with oplocks = yes and kernel oplocks = no.
2064 Note that the write cache won´t be used for file handles with a
2066 smb2 write lease.
2067 The Samba implementation of leases is currently marked as
2069 experimental!
2070 Default: smb2 leases = no
2072 strict locking (S)
2074 This is an enumerated type that controls the handling of file
2076 locking in the server. When this is set to yes, the server will
2077 check every read and write access for file locks, and deny access
2078 if locks exist. This can be slow on some systems.
2079 When strict locking is set to Auto (the default), the server
2081 performs file lock checks only on non-oplocked files. As most
2082 Windows redirectors perform file locking checks locally on oplocked
2083 files this is a good trade off for improved performance.
2084 When strict locking is disabled, the server performs file lock
2086 checks only when the client explicitly asks for them.
2087 Well-behaved clients always ask for lock checks when it is
2089 important. So in the vast majority of cases, strict locking = Auto
2090 or strict locking = no is acceptable.
2091 Default: strict locking = Auto
2093 debug class (G)
2095 With this boolean parameter enabled, the debug class (DBGC_CLASS)
2097 will be displayed in the debug header.
2098 For more information about currently available debug classes, see
2100 section about log level.
2101 Default: debug class = no
2103 debug hires timestamp (G)
2105 Sometimes the timestamps in the log messages are needed with a
2107 resolution of higher that seconds, this boolean parameter adds
2108 microsecond resolution to the timestamp message header when turned
2109 on.
2110 Note that the parameter debug timestamp must be on for this to have
2112 an effect.
2113 Default: debug hires timestamp = yes
2115 debug pid (G)
2117 When using only one log file for more then one forked
2119 smbd(8)-process there may be hard to follow which process outputs
2120 which message. This boolean parameter is adds the process-id to the
2121 timestamp message headers in the logfile when turned on.
2122 Note that the parameter debug timestamp must be on for this to have
2124 an effect.
2125 Default: debug pid = no
2127 debug prefix timestamp (G)
2129 With this option enabled, the timestamp message header is prefixed
2131 to the debug message without the filename and function information
2132 that is included with the debug timestamp parameter. This gives
2133 timestamps to the messages without adding an additional line.
2134 Note that this parameter overrides the debug timestamp parameter.
2136 Default: debug prefix timestamp = no
2138 timestamp logs
2140 This parameter is a synonym for debug timestamp.
2142 debug timestamp (G)
2144 Samba debug log messages are timestamped by default. If you are
2146 running at a high debug level these timestamps can be distracting.
2147 This boolean parameter allows timestamping to be turned off.
2148 Default: debug timestamp = yes
2150 debug uid (G)
2152 Samba is sometimes run as root and sometime run as the connected
2154 user, this boolean parameter inserts the current euid, egid, uid
2155 and gid to the timestamp message headers in the log file if turned
2156 on.
2157 Note that the parameter debug timestamp must be on for this to have
2159 an effect.
2160 Default: debug uid = no
2162 ldap debug level (G)
2164 This parameter controls the debug level of the LDAP library calls.
2166 In the case of OpenLDAP, it is the same bit-field as understood by
2167 the server and documented in the slapd.conf(5) manpage. A typical
2168 useful value will be 1 for tracing function calls.
2169 The debug output from the LDAP libraries appears with the prefix
2171 [LDAP] in Samba´s logging output. The level at which LDAP logging
2172 is printed is controlled by the parameter ldap debug threshold.
2173 Default: ldap debug level = 0
2175 Example: ldap debug level = 1
2177 ldap debug threshold (G)
2179 This parameter controls the Samba debug level at which the ldap
2181 library debug output is printed in the Samba logs. See the
2182 description of ldap debug level for details.
2183 Default: ldap debug threshold = 10
2185 Example: ldap debug threshold = 5
2187 log file (G)
2189 This option allows you to override the name of the Samba log file
2191 (also known as the debug file).
2192 This option takes the standard substitutions, allowing you to have
2194 separate log files for each user or machine.
2195 No default
2197 Example: log file = /usr/local/samba/var/log.%m
2199 debuglevel
2201 This parameter is a synonym for log level.
2203 log level (G)
2205 The value of the parameter (a astring) allows the debug level
2207 (logging level) to be specified in the smb.conf file.
2208 This parameter has been extended since the 2.2.x series, now it
2210 allows to specify the debug level for multiple debug classes. This
2211 is to give greater flexibility in the configuration of the system.
2212 The following debug classes are currently implemented:
2213 · all
2215 · tdb
2217 · printdrivers
2219 · lanman
2221 · smb
2223 · rpc_parse
2225 · rpc_srv
2227 · rpc_cli
2229 · passdb
2231 · sam
2233 · auth
2235 · winbind
2237 · vfs
2239 · idmap
2241 · quota
2243 · acls
2245 · locking
2247 · msdfs
2249 · dmapi
2251 · registry
2253 Default: log level = 0
2255 Example: log level = 3 passdb:5 auth:10 winbind:2
2257 max log size (G)
2259 This option (an integer in kilobytes) specifies the max size the
2261 log file should grow to. Samba periodically checks the size and if
2262 it is exceeded it will rename the file, adding a .old extension.
2263 A size of 0 means no limit.
2265 Default: max log size = 5000
2267 Example: max log size = 1000
2269 syslog (G)
2271 This parameter maps how Samba debug messages are logged onto the
2273 system syslog logging levels. Samba debug level zero maps onto
2274 syslog LOG_ERR, debug level one maps onto LOG_WARNING, debug level
2275 two maps onto LOG_NOTICE, debug level three maps onto LOG_INFO. All
2276 higher levels are mapped to LOG_DEBUG.
2277 This parameter sets the threshold for sending messages to syslog.
2279 Only messages with debug level less than this value will be sent to
2280 syslog. There still will be some logging to log.[sn]mbd even if
2281 syslog only is enabled.
2282 Default: syslog = 1
2284 syslog only (G)
2286 If this parameter is set then Samba debug messages are logged into
2288 the system syslog only, and not to the debug log files. There still
2289 will be some logging to log.[sn]mbd even if syslog only is enabled.
2290 Default: syslog only = no
2292 abort shutdown script (G)
2294 This a full path name to a script called by smbd(8) that should
2296 stop a shutdown procedure issued by the shutdown script.
2297 If the connected user possesses the SeRemoteShutdownPrivilege,
2299 right, this command will be run as root.
2300 Default: abort shutdown script = ""
2302 Example: abort shutdown script = /sbin/shutdown -c
2304 add group script (G)
2306 This is the full pathname to a script that will be run AS ROOT by
2308 smbd(8) when a new group is requested. It will expand any %g to the
2309 group name passed. This script is only useful for installations
2310 using the Windows NT domain administration tools. The script is
2311 free to create a group with an arbitrary name to circumvent unix
2312 group name restrictions. In that case the script must print the
2313 numeric gid of the created group on stdout.
2314 Default: add group script =
2316 Example: add group script = /usr/sbin/groupadd %g
2318 add machine script (G)
2320 This is the full pathname to a script that will be run by smbd(8)
2322 when a machine is added to Samba´s domain and a Unix account
2323 matching the machine´s name appended with a "$" does not already
2324 exist.
2325 This option is very similar to the add user script, and likewise
2327 uses the %u substitution for the account name. Do not use the %m
2328 substitution.
2329 Default: add machine script =
2331 Example: add machine script = /usr/sbin/adduser -n -g machines -c
2333 Machine -d /var/lib/nobody -s /bin/false %u
2334 add user script (G)
2336 This is the full pathname to a script that will be run AS ROOT by
2338 smbd(8) under special circumstances described below.
2339 Normally, a Samba server requires that UNIX users are created for
2341 all users accessing files on this server. For sites that use
2342 Windows NT account databases as their primary user database
2343 creating these users and keeping the user list in sync with the
2344 Windows NT PDC is an onerous task. This option allows smbd to
2345 create the required UNIX users ON DEMAND when a user accesses the
2346 Samba server.
2347 When the Windows user attempts to access the Samba server, at login
2349 (session setup in the SMB protocol) time, smbd(8) contacts the
2350 password server and attempts to authenticate the given user with
2351 the given password. If the authentication succeeds then smbd
2352 attempts to find a UNIX user in the UNIX password database to map
2353 the Windows user into. If this lookup fails, and add user script is
2354 set then smbd will call the specified script AS ROOT, expanding any
2355 %u argument to be the user name to create.
2356 If this script successfully creates the user then smbd will
2358 continue on as though the UNIX user already existed. In this way,
2359 UNIX users are dynamically created to match existing Windows NT
2360 accounts.
2361 See also security, password server, delete user script.
2363 Default: add user script =
2365 Example: add user script = /usr/local/samba/bin/add_user %u
2367 add user to group script (G)
2369 Full path to the script that will be called when a user is added to
2371 a group using the Windows NT domain administration tools. It will
2372 be run by smbd(8) AS ROOT. Any %g will be replaced with the group
2373 name and any %u will be replaced with the user name.
2374 Note that the adduser command used in the example below does not
2376 support the used syntax on all systems.
2377 Default: add user to group script =
2379 Example: add user to group script = /usr/sbin/adduser %u %g
2381 allow nt4 crypto (G)
2383 This option controls whether the netlogon server (currently only in
2385 ´active directory domain controller´ mode), will reject clients
2386 which does not support NETLOGON_NEG_STRONG_KEYS nor
2387 NETLOGON_NEG_SUPPORTS_AES.
2388 This option was added with Samba 4.2.0. It may lock out clients
2390 which worked fine with Samba versions up to 4.1.x. as the effective
2391 default was "yes" there, while it is "no" now.
2392 If you have clients without RequireStrongKey = 1 in the registry,
2394 you may need to set "allow nt4 crypto = yes", until you have fixed
2395 all clients.
2396 "allow nt4 crypto = yes" allows weak crypto to be negotiated, maybe
2398 via downgrade attacks.
2399 This option yields precedence to the ´reject md5 clients´ option.
2401 Default: allow nt4 crypto = no
2403 delete group script (G)
2405 This is the full pathname to a script that will be run AS ROOT
2407 smbd(8) when a group is requested to be deleted. It will expand any
2408 %g to the group name passed. This script is only useful for
2409 installations using the Windows NT domain administration tools.
2410 Default: delete group script =
2412 delete user from group script (G)
2414 Full path to the script that will be called when a user is removed
2416 from a group using the Windows NT domain administration tools. It
2417 will be run by smbd(8) AS ROOT. Any %g will be replaced with the
2418 group name and any %u will be replaced with the user name.
2419 Default: delete user from group script =
2421 Example: delete user from group script = /usr/sbin/deluser %u %g
2423 delete user script (G)
2425 This is the full pathname to a script that will be run by smbd(8)
2427 when managing users with remote RPC (NT) tools.
2428 This script is called when a remote client removes a user from the
2430 server, normally using ´User Manager for Domains´ or rpcclient.
2431 This script should delete the given UNIX username.
2433 Default: delete user script =
2435 Example: delete user script = /usr/local/samba/bin/del_user %u
2437 domain logons (G)
2439 If set to yes, the Samba server will provide the netlogon service
2441 for Windows 9X network logons for the workgroup it is in. This will
2442 also cause the Samba server to act as a domain controller for NT4
2443 style domain services. For more details on setting up this feature
2444 see the Domain Control chapter of the Samba HOWTO Collection.
2445 Default: domain logons = no
2447 enable privileges (G)
2449 This deprecated parameter controls whether or not smbd will honor
2451 privileges assigned to specific SIDs via either net rpc rights or
2452 one of the Windows user and group manager tools. This parameter is
2453 enabled by default. It can be disabled to prevent members of the
2454 Domain Admins group from being able to assign privileges to users
2455 or groups which can then result in certain smbd operations running
2456 as root that would normally run under the context of the connected
2457 user.
2458 An example of how privileges can be used is to assign the right to
2460 join clients to a Samba controlled domain without providing root
2461 access to the server via smbd.
2462 Please read the extended description provided in the Samba HOWTO
2464 documentation.
2465 Default: enable privileges = yes
2467 init logon delay (G)
2469 This parameter specifies a delay in milliseconds for the hosts
2471 configured for delayed initial samlogon with init logon delayed
2472 hosts.
2473 Default: init logon delay = 100
2475 init logon delayed hosts (G)
2477 This parameter takes a list of host names, addresses or networks
2479 for which the initial samlogon reply should be delayed (so other
2480 DCs get preferred by XP workstations if there are any).
2481 The length of the delay can be specified with the init logon delay
2483 parameter.
2484 Default: init logon delayed hosts =
2486 Example: init logon delayed hosts = 150.203.5. myhost.mynet.de
2488 logon drive (G)
2490 This parameter specifies the local path to which the home directory
2492 will be connected (see logon home) and is only used by NT
2493 Workstations.
2494 Note that this option is only useful if Samba is set up as a logon
2496 server.
2497 Default: logon drive =
2499 Example: logon drive = h:
2501 logon home (G)
2503 This parameter specifies the home directory location when a
2505 Win95/98 or NT Workstation logs into a Samba PDC. It allows you to
2506 do
2507 C:\>NET USE H: /HOME
2510 from a command prompt, for example.
2512 This option takes the standard substitutions, allowing you to have
2514 separate logon scripts for each user or machine.
2515 This parameter can be used with Win9X workstations to ensure that
2517 roaming profiles are stored in a subdirectory of the user´s home
2518 directory. This is done in the following way:
2519 logon home = \\%N\%U\profile
2522 This tells Samba to return the above string, with substitutions
2524 made when a client requests the info, generally in a NetUserGetInfo
2525 request. Win9X clients truncate the info to \\server\share when a
2526 user does net use /home but use the whole string when dealing with
2527 profiles.
2528 Note that in prior versions of Samba, the logon path was returned
2530 rather than logon home. This broke net use /home but allowed
2531 profiles outside the home directory. The current implementation is
2532 correct, and can be used for profiles if you use the above trick.
2533 Disable this feature by setting logon home = "" - using the empty
2535 string.
2536 This option is only useful if Samba is set up as a logon server.
2538 Default: logon home = \\%N\%U
2540 Example: logon home = \\remote_smb_server\%U
2542 logon path (G)
2544 This parameter specifies the directory where roaming profiles
2546 (Desktop, NTuser.dat, etc) are stored. Contrary to previous
2547 versions of these manual pages, it has nothing to do with Win 9X
2548 roaming profiles. To find out how to handle roaming profiles for
2549 Win 9X system, see the logon home parameter.
2550 This option takes the standard substitutions, allowing you to have
2552 separate logon scripts for each user or machine. It also specifies
2553 the directory from which the "Application Data", desktop, start
2554 menu, network neighborhood, programs and other folders, and their
2555 contents, are loaded and displayed on your Windows NT client.
2556 The share and the path must be readable by the user for the
2558 preferences and directories to be loaded onto the Windows NT
2559 client. The share must be writeable when the user logs in for the
2560 first time, in order that the Windows NT client can create the
2561 NTuser.dat and other directories. Thereafter, the directories and
2562 any of the contents can, if required, be made read-only. It is not
2563 advisable that the NTuser.dat file be made read-only - rename it to
2564 NTuser.man to achieve the desired effect (a MANdatory profile).
2565 Windows clients can sometimes maintain a connection to the [homes]
2567 share, even though there is no user logged in. Therefore, it is
2568 vital that the logon path does not include a reference to the homes
2569 share (i.e. setting this parameter to \\%N\homes\profile_path will
2570 cause problems).
2571 This option takes the standard substitutions, allowing you to have
2573 separate logon scripts for each user or machine.
2574 Warning
2576 Do not quote the value. Setting this as “\\%N\profile\%U” will
2577 break profile handling. Where the tdbsam or ldapsam passdb
2578 backend is used, at the time the user account is created the
2579 value configured for this parameter is written to the passdb
2580 backend and that value will over-ride the parameter value
2581 present in the smb.conf file. Any error present in the passdb
2582 backend account record must be editted using the appropriate
2583 tool (pdbedit on the command-line, or any other locally
2584 provided system tool).
2585 Note that this option is only useful if Samba is set up as a domain
2586 controller.
2587 Disable the use of roaming profiles by setting the value of this
2589 parameter to the empty string. For example, logon path = "". Take
2590 note that even if the default setting in the smb.conf file is the
2591 empty string, any value specified in the user account settings in
2592 the passdb backend will over-ride the effect of setting this
2593 parameter to null. Disabling of all roaming profile use requires
2594 that the user account settings must also be blank.
2595 An example of use is:
2597 logon path = \\PROFILESERVER\PROFILE\%U
2599 Default: logon path = \\%N\%U\profile
2601 logon script (G)
2603 This parameter specifies the batch file (.bat) or NT command file
2605 (.cmd) to be downloaded and run on a machine when a user
2606 successfully logs in. The file must contain the DOS style CR/LF
2607 line endings. Using a DOS-style editor to create the file is
2608 recommended.
2609 The script must be a relative path to the [netlogon] service. If
2611 the [netlogon] service specifies a path of
2612 /usr/local/samba/netlogon, and logon script = STARTUP.BAT, then the
2613 file that will be downloaded is:
2614 /usr/local/samba/netlogon/STARTUP.BAT
2616 The contents of the batch file are entirely your choice. A
2618 suggested command would be to add NET TIME \\SERVER /SET /YES, to
2619 force every machine to synchronize clocks with the same time
2620 server. Another use would be to add NET USE U: \\SERVER\UTILS for
2621 commonly used utilities, or
2622 NET USE Q: \\SERVER\ISO9001_QA
2624 for example.
2626 Note that it is particularly important not to allow write access to
2628 the [netlogon] share, or to grant users write permission on the
2629 batch files in a secure environment, as this would allow the batch
2630 files to be arbitrarily modified and security to be breached.
2631 This option takes the standard substitutions, allowing you to have
2633 separate logon scripts for each user or machine.
2634 This option is only useful if Samba is set up as a logon server.
2636 Default: logon script =
2638 Example: logon script = scripts\%U.bat
2640 reject md5 clients (G)
2642 This option controls whether the netlogon server (currently only in
2644 ´active directory domain controller´ mode), will reject clients
2645 which does not support NETLOGON_NEG_SUPPORTS_AES.
2646 You can set this to yes if all domain members support aes. This
2648 will prevent downgrade attacks.
2649 This option takes precedence to the ´allow nt4 crypto´ option.
2651 Default: reject md5 clients = no
2653 set primary group script (G)
2655 Thanks to the Posix subsystem in NT a Windows User has a primary
2657 group in addition to the auxiliary groups. This script sets the
2658 primary group in the unix user database when an administrator sets
2659 the primary group from the windows user manager or when fetching a
2660 SAM with net rpc vampire. %u will be replaced with the user whose
2661 primary group is to be set. %g will be replaced with the group to
2662 set.
2663 Default: set primary group script =
2665 Example: set primary group script = /usr/sbin/usermod -g ´%g´ ´%u´
2667 shutdown script (G)
2669 This a full path name to a script called by smbd(8) that should
2671 start a shutdown procedure.
2672 If the connected user possesses the SeRemoteShutdownPrivilege,
2674 right, this command will be run as root.
2675 The %z %t %r %f variables are expanded as follows:
2677 · %z will be substituted with the shutdown message sent to the
2679 server.
2680 · %t will be substituted with the number of seconds to wait
2682 before effectively starting the shutdown procedure.
2683 · %r will be substituted with the switch -r. It means reboot
2685 after shutdown for NT.
2686 · %f will be substituted with the switch -f. It means force the
2688 shutdown even if applications do not respond for NT.
2689 Shutdown script example:
2691 #!/bin/bash
2693 time=$2
2695 let time="${time} / 60"
2696 let time="${time} + 1"
2697 /sbin/shutdown $3 $4 +$time $1 &
2699 Shutdown does not return so we need to launch it in background.
2702 Default: shutdown script =
2704 Example: shutdown script = /usr/local/samba/sbin/shutdown %m %t %r %f
2706 add share command (G)
2708 Samba 2.2.0 introduced the ability to dynamically add and delete
2710 shares via the Windows NT 4.0 Server Manager. The add share command
2711 is used to define an external program or script which will add a
2712 new service definition to smb.conf.
2713 In order to successfully execute the add share command, smbd
2715 requires that the administrator connects using a root account (i.e.
2716 uid == 0) or has the SeDiskOperatorPrivilege. Scripts defined in
2717 the add share command parameter are executed as root.
2718 When executed, smbd will automatically invoke the add share command
2720 with five parameters.
2721 · configFile - the location of the global smb.conf file.
2723 · shareName - the name of the new share.
2725 · pathName - path to an **existing** directory on disk.
2727 · comment - comment string to associate with the new share.
2729 · max connections Number of maximum simultaneous connections to
2731 this share.
2732 This parameter is only used to add file shares. To add printer shares,
2734 see the addprinter command.
2735 Default: add share command =
2737 Example: add share command = /usr/local/bin/addshare
2739 afs share (S)
2741 This parameter controls whether special AFS features are enabled
2743 for this share. If enabled, it assumes that the directory exported
2744 via the path parameter is a local AFS import. The special AFS
2745 features include the attempt to hand-craft an AFS token if you
2746 enabled --with-fake-kaserver in configure.
2747 Default: afs share = no
2749 afs token lifetime (G)
2751 This parameter controls the lifetime of tokens that the AFS
2753 fake-kaserver claims. In reality these never expire but this
2754 lifetime controls when the afs client will forget the token.
2755 Set this parameter to 0 to get NEVERDATE.
2757 Default: afs token lifetime = 604800
2759 afs username map (G)
2761 If you are using the fake kaserver AFS feature, you might want to
2763 hand-craft the usernames you are creating tokens for. For example
2764 this is necessary if you have users from several domain in your AFS
2765 Protection Database. One possible scheme to code users as
2766 DOMAIN+User as it is done by winbind with the + as a separator.
2767 The mapped user name must contain the cell name to log into, so
2769 without setting this parameter there will be no token.
2770 Default: afs username map =
2772 Example: afs username map = %u@afs.samba.org
2774 allow insecure wide links (G)
2776 In normal operation the option wide links which allows the server
2778 to follow symlinks outside of a share path is automatically
2779 disabled when unix extensions are enabled on a Samba server. This
2780 is done for security purposes to prevent UNIX clients creating
2781 symlinks to areas of the server file system that the administrator
2782 does not wish to export.
2783 Setting allow insecure wide links to true disables the link between
2785 these two parameters, removing this protection and allowing a site
2786 to configure the server to follow symlinks (by setting wide links
2787 to "true") even when unix extensions is turned on.
2788 If is not recommended to enable this option unless you fully
2790 understand the implications of allowing the server to follow
2791 symbolic links created by UNIX clients. For most normal Samba
2792 configurations this would be considered a security hole and setting
2793 this parameter is not recommended.
2794 This option was added at the request of sites who had deliberately
2796 set Samba up in this way and needed to continue supporting this
2797 functionality without having to patch the Samba code.
2798 Default: allow insecure wide links = no
2800 async smb echo handler (G)
2802 This parameter specifies whether Samba should fork the async smb
2804 echo handler. It can be beneficial if your file system can block
2805 syscalls for a very long time. In some circumstances, it prolongs
2806 the timeout that Windows uses to determine whether a connection is
2807 dead.
2808 Default: async smb echo handler = no
2810 available (S)
2812 This parameter lets you "turn off" a service. If available = no,
2814 then ALL attempts to connect to the service will fail. Such
2815 failures are logged.
2816 Default: available = yes
2818 cache directory (G)
2820 Usually, most of the TDB files are stored in the lock directory.
2822 Since Samba 3.4.0, it is possible to differentiate between TDB
2823 files with persistent data and TDB files with non-persistent data
2824 using the state directory and the cache directory options.
2825 This option specifies the directory where TDB files containing
2827 non-persistent data will be stored.
2828 Default: cache directory = /var/lib/samba
2830 Example: cache directory = /var/run/samba/locks/cache
2832 change notify (S)
2834 This parameter specifies whether Samba should reply to a client´s
2836 file change notify requests.
2837 You should never need to change this parameter
2839 Default: change notify = yes
2841 change share command (G)
2843 Samba 2.2.0 introduced the ability to dynamically add and delete
2845 shares via the Windows NT 4.0 Server Manager. The change share
2846 command is used to define an external program or script which will
2847 modify an existing service definition in smb.conf.
2848 In order to successfully execute the change share command, smbd
2850 requires that the administrator connects using a root account (i.e.
2851 uid == 0) or has the SeDiskOperatorPrivilege. Scripts defined in
2852 the change share command parameter are executed as root.
2853 When executed, smbd will automatically invoke the change share
2855 command with six parameters.
2856 · configFile - the location of the global smb.conf file.
2858 · shareName - the name of the new share.
2860 · pathName - path to an **existing** directory on disk.
2862 · comment - comment string to associate with the new share.
2864 · max connections Number of maximum simultaneous connections to
2866 this share.
2867 · CSC policy - client side caching policy in string form. Valid
2869 values are: manual, documents, programs, disable.
2870 This parameter is only used to modify existing file share definitions.
2872 To modify printer shares, use the "Printers..." folder as seen when
2873 browsing the Samba host.
2874 Default: change share command =
2876 Example: change share command = /usr/local/bin/changeshare
2878 cluster addresses (G)
2880 With this parameter you can add additional addresses nmbd will
2882 register with a WINS server. These addresses are not necessarily
2883 present on all nodes simultaneously, but they will be registered
2884 with the WINS server so that clients can contact any of the nodes.
2885 Default: cluster addresses =
2887 Example: cluster addresses = 10.0.0.1 10.0.0.2 10.0.0.3
2889 clustering (G)
2891 This parameter specifies whether Samba should contact ctdb for
2893 accessing its tdb files and use ctdb as a backend for its messaging
2894 backend.
2895 Set this parameter to yes only if you have a cluster setup with
2897 ctdb running.
2898 Default: clustering = no
2900 config file (G)
2902 This allows you to override the config file to use, instead of the
2904 default (usually smb.conf). There is a chicken and egg problem here
2905 as this option is set in the config file!
2906 For this reason, if the name of the config file has changed when
2908 the parameters are loaded then it will reload them from the new
2909 config file.
2910 This option takes the usual substitutions, which can be very
2912 useful.
2913 If the config file doesn´t exist then it won´t be loaded (allowing
2915 you to special case the config files of just a few clients).
2916 No default
2918 Example: config file = /usr/local/samba/lib/smb.conf.%m
2920 copy (S)
2922 This parameter allows you to "clone" service entries. The specified
2924 service is simply duplicated under the current service´s name. Any
2925 parameters specified in the current section will override those in
2926 the section being copied.
2927 This feature lets you set up a ´template´ service and create
2929 similar services easily. Note that the service being copied must
2930 occur earlier in the configuration file than the service doing the
2931 copying.
2932 Default: copy =
2934 Example: copy = otherservice
2936 ctdbd socket (G)
2938 If you set clustering=yes, you need to tell Samba where ctdbd
2940 listens on its unix domain socket. The default path as of ctdb 1.0
2941 is /tmp/ctdb.socket which you have to explicitly set for Samba in
2942 smb.conf.
2943 Default: ctdbd socket =
2945 Example: ctdbd socket = /tmp/ctdb.socket
2947 ctdb locktime warn threshold (G)
2949 In a cluster environment using Samba and ctdb it is critical that
2951 locks on central ctdb-hosted databases like locking.tdb are not
2952 held for long. With the current Samba architecture it happens that
2953 Samba takes a lock and while holding that lock makes file system
2954 calls into the shared cluster file system. This option makes Samba
2955 warn if it detects that it has held locks for the specified number
2956 of milliseconds. If this happens, smbd will emit a debug level 0
2957 message into its logs and potentially into syslog. The most likely
2958 reason for such a log message is that an operation of the cluster
2959 file system Samba exports is taking longer than expected. The
2960 messages are meant as a debugging aid for potential cluster
2961 problems.
2962 The default value of 0 disables this logging.
2964 Default: ctdb locktime warn threshold = 0
2966 ctdb timeout (G)
2968 This parameter specifies a timeout in seconds for the connection
2970 between Samba and ctdb. It is only valid if you have compiled Samba
2971 with clustering and if you have set clustering=yes.
2972 When something in the cluster blocks, it can happen that we wait
2974 indefinitely long for ctdb, just adding to the blocking condition.
2975 In a well-running cluster this should never happen, but there are
2976 too many components in a cluster that might have hickups. Choosing
2977 the right balance for this value is very tricky, because on a busy
2978 cluster long service times to transfer something across the cluster
2979 might be valid. Setting it too short will degrade the service your
2980 cluster presents, setting it too long might make the cluster itself
2981 not recover from something severely broken for too long.
2982 Be aware that if you set this parameter, this needs to be in the
2984 file smb.conf, it is not really helpful to put this into a registry
2985 configuration (typical on a cluster), because to access the
2986 registry contact to ctdb is required.
2987 Setting ctdb timeout to n makes any process waiting longer than n
2989 seconds for a reply by the cluster panic. Setting it to 0 (the
2990 default) makes Samba block forever, which is the highly recommended
2991 default.
2992 Default: ctdb timeout = 0
2994 default
2996 This parameter is a synonym for default service.
2998 default service (G)
3000 This parameter specifies the name of a service which will be
3002 connected to if the service actually requested cannot be found.
3003 Note that the square brackets are NOT given in the parameter value
3004 (see example below).
3005 There is no default value for this parameter. If this parameter is
3007 not given, attempting to connect to a nonexistent service results
3008 in an error.
3009 Typically the default service would be a guest ok, read-only
3011 service.
3012 Also note that the apparent service name will be changed to equal
3014 that of the requested service, this is very useful as it allows you
3015 to use macros like %S to make a wildcard service.
3016 Note also that any "_" characters in the name of the service used
3018 in the default service will get mapped to a "/". This allows for
3019 interesting things.
3020 Default: default service =
3022 Example: default service = pub
3024 delete readonly (S)
3026 This parameter allows readonly files to be deleted. This is not
3028 normal DOS semantics, but is allowed by UNIX.
3029 This option may be useful for running applications such as rcs,
3031 where UNIX file ownership prevents changing file permissions, and
3032 DOS semantics prevent deletion of a read only file.
3033 Default: delete readonly = no
3035 delete share command (G)
3037 Samba 2.2.0 introduced the ability to dynamically add and delete
3039 shares via the Windows NT 4.0 Server Manager. The delete share
3040 command is used to define an external program or script which will
3041 remove an existing service definition from smb.conf.
3042 In order to successfully execute the delete share command, smbd
3044 requires that the administrator connects using a root account (i.e.
3045 uid == 0) or has the SeDiskOperatorPrivilege. Scripts defined in
3046 the delete share command parameter are executed as root.
3047 When executed, smbd will automatically invoke the delete share
3049 command with two parameters.
3050 · configFile - the location of the global smb.conf file.
3052 · shareName - the name of the existing service.
3054 This parameter is only used to remove file shares. To delete printer
3056 shares, see the deleteprinter command.
3057 Default: delete share command =
3059 Example: delete share command = /usr/local/bin/delshare
3061 dfree cache time (S)
3063 The dfree cache time should only be used on systems where a problem
3065 occurs with the internal disk space calculations. This has been
3066 known to happen with Ultrix, but may occur with other operating
3067 systems. The symptom that was seen was an error of "Abort Retry
3068 Ignore" at the end of each directory listing.
3069 This is a new parameter introduced in Samba version 3.0.21. It
3071 specifies in seconds the time that smbd will cache the output of a
3072 disk free query. If set to zero (the default) no caching is done.
3073 This allows a heavily loaded server to prevent rapid spawning of
3074 dfree command scripts increasing the load.
3075 By default this parameter is zero, meaning no caching will be done.
3077 No default
3079 Example: dfree cache time = 60
3081 dfree command (S)
3083 The dfree command setting should only be used on systems where a
3085 problem occurs with the internal disk space calculations. This has
3086 been known to happen with Ultrix, but may occur with other
3087 operating systems. The symptom that was seen was an error of "Abort
3088 Retry Ignore" at the end of each directory listing.
3089 This setting allows the replacement of the internal routines to
3091 calculate the total disk space and amount available with an
3092 external routine. The example below gives a possible script that
3093 might fulfill this function.
3094 In Samba version 3.0.21 this parameter has been changed to be a
3096 per-share parameter, and in addition the parameter dfree cache time
3097 was added to allow the output of this script to be cached for
3098 systems under heavy load.
3099 The external program will be passed a single parameter indicating a
3101 directory in the filesystem being queried. This will typically
3102 consist of the string ./. The script should return two integers in
3103 ASCII. The first should be the total disk space in blocks, and the
3104 second should be the number of available blocks. An optional third
3105 return value can give the block size in bytes. The default
3106 blocksize is 1024 bytes.
3107 Note: Your script should NOT be setuid or setgid and should be
3109 owned by (and writeable only by) root!
3110 Where the script dfree (which must be made executable) could be:
3112 #!/bin/sh
3115 df $1 | tail -1 | awk ´{print $(NF-4),$(NF-2)}´
3116 or perhaps (on Sys V based systems):
3118 #!/bin/sh
3121 /usr/bin/df -k $1 | tail -1 | awk ´{print $3" "$5}´
3122 Note that you may have to replace the command names with full path
3124 names on some systems.
3125 By default internal routines for determining the disk capacity and
3127 remaining space will be used.
3128 No default
3130 Example: dfree command = /usr/local/samba/bin/dfree
3132 directory name cache size (S)
3134 This parameter specifies the size of the directory name cache. It
3136 will be needed to turn this off for *BSD systems.
3137 Default: directory name cache size = 100
3139 dmapi support (S)
3141 This parameter specifies whether Samba should use DMAPI to
3143 determine whether a file is offline or not. This would typically be
3144 used in conjunction with a hierarchical storage system that
3145 automatically migrates files to tape.
3146 Note that Samba infers the status of a file by examining the events
3148 that a DMAPI application has registered interest in. This heuristic
3149 is satisfactory for a number of hierarchical storage systems, but
3150 there may be system for which it will fail. In this case, Samba may
3151 erroneously report files to be offline.
3152 This parameter is only available if a supported DMAPI
3154 implementation was found at compilation time. It will only be used
3155 if DMAPI is found to enabled on the system at run time.
3156 Default: dmapi support = no
3158 dont descend (S)
3160 There are certain directories on some systems (e.g., the /proc tree
3162 under Linux) that are either not of interest to clients or are
3163 infinitely deep (recursive). This parameter allows you to specify a
3164 comma-delimited list of directories that the server should always
3165 show as empty.
3166 Note that Samba can be very fussy about the exact format of the
3168 "dont descend" entries. For example you may need ./proc instead of
3169 just /proc. Experimentation is the best policy :-)
3170 Default: dont descend =
3172 Example: dont descend = /proc,/dev
3174 dos filemode (S)
3176 The default behavior in Samba is to provide UNIX-like behavior
3178 where only the owner of a file/directory is able to change the
3179 permissions on it. However, this behavior is often confusing to
3180 DOS/Windows users. Enabling this parameter allows a user who has
3181 write access to the file (by whatever means, including an ACL
3182 permission) to modify the permissions (including ACL) on it. Note
3183 that a user belonging to the group owning the file will not be
3184 allowed to change permissions if the group is only granted read
3185 access. Ownership of the file/directory may also be changed. Note
3186 that using the VFS modules acl_xattr or acl_tdb which store native
3187 Windows as meta-data will automatically turn this option on for any
3188 share for which they are loaded, as they require this option to
3189 emulate Windows ACLs correctly.
3190 Default: dos filemode = no
3192 dos filetime resolution (S)
3194 Under the DOS and Windows FAT filesystem, the finest granularity on
3196 time resolution is two seconds. Setting this parameter for a share
3197 causes Samba to round the reported time down to the nearest two
3198 second boundary when a query call that requires one second
3199 resolution is made to smbd(8).
3200 This option is mainly used as a compatibility option for Visual C++
3202 when used against Samba shares. If oplocks are enabled on a share,
3203 Visual C++ uses two different time reading calls to check if a file
3204 has changed since it was last read. One of these calls uses a
3205 one-second granularity, the other uses a two second granularity. As
3206 the two second call rounds any odd second down, then if the file
3207 has a timestamp of an odd number of seconds then the two timestamps
3208 will not match and Visual C++ will keep reporting the file has
3209 changed. Setting this option causes the two timestamps to match,
3210 and Visual C++ is happy.
3211 Default: dos filetime resolution = no
3213 dos filetimes (S)
3215 Under DOS and Windows, if a user can write to a file they can
3217 change the timestamp on it. Under POSIX semantics, only the owner
3218 of the file or root may change the timestamp. By default, Samba
3219 emulates the DOS semantics and allows to change the timestamp on a
3220 file if the user smbd is acting on behalf has write permissions.
3221 Due to changes in Microsoft Office 2000 and beyond, the default for
3222 this parameter has been changed from "no" to "yes" in Samba 3.0.14
3223 and above. Microsoft Excel will display dialog box warnings about
3224 the file being changed by another user if this parameter is not set
3225 to "yes" and files are being shared between users.
3226 Default: dos filetimes = yes
3228 fake directory create times (S)
3230 NTFS and Windows VFAT file systems keep a create time for all files
3232 and directories. This is not the same as the ctime - status change
3233 time - that Unix keeps, so Samba by default reports the earliest of
3234 the various times Unix does keep. Setting this parameter for a
3235 share causes Samba to always report midnight 1-1-1980 as the create
3236 time for directories.
3237 This option is mainly used as a compatibility option for Visual C++
3239 when used against Samba shares. Visual C++ generated makefiles have
3240 the object directory as a dependency for each object file, and a
3241 make rule to create the directory. Also, when NMAKE compares
3242 timestamps it uses the creation time when examining a directory.
3243 Thus the object directory will be created if it does not exist, but
3244 once it does exist it will always have an earlier timestamp than
3245 the object files it contains.
3246 However, Unix time semantics mean that the create time reported by
3248 Samba will be updated whenever a file is created or deleted in the
3249 directory. NMAKE finds all object files in the object directory.
3250 The timestamp of the last one built is then compared to the
3251 timestamp of the object directory. If the directory´s timestamp if
3252 newer, then all object files will be rebuilt. Enabling this option
3253 ensures directories always predate their contents and an NMAKE
3254 build will proceed as expected.
3255 Default: fake directory create times = no
3257 follow symlinks (S)
3259 This parameter allows the Samba administrator to stop smbd(8) from
3261 following symbolic links in a particular share. Setting this
3262 parameter to no prevents any file or directory that is a symbolic
3263 link from being followed (the user will get an error). This option
3264 is very useful to stop users from adding a symbolic link to
3265 /etc/passwd in their home directory for instance. However it will
3266 slow filename lookups down slightly.
3267 This option is enabled (i.e. smbd will follow symbolic links) by
3269 default.
3270 Default: follow symlinks = yes
3272 fstype (S)
3274 This parameter allows the administrator to configure the string
3276 that specifies the type of filesystem a share is using that is
3277 reported by smbd(8) when a client queries the filesystem type for a
3278 share. The default type is NTFS for compatibility with Windows NT
3279 but this can be changed to other strings such as Samba or FAT if
3280 required.
3281 Default: fstype = NTFS
3283 Example: fstype = Samba
3285 homedir map (G)
3287 If nis homedir is yes, and smbd(8) is also acting as a Win95/98
3289 logon server then this parameter specifies the NIS (or YP) map from
3290 which the server for the user´s home directory should be extracted.
3291 At present, only the Sun auto.home map format is understood. The
3292 form of the map is:
3293 username server:/some/file/system
3295 and the program will extract the servername from before the first
3297 ´:´. There should probably be a better parsing system that copes
3298 with different map formats and also Amd (another automounter) maps.
3299 Note
3301 A working NIS client is required on the system for this option
3302 to work.
3303 Default: homedir map =
3304 Example: homedir map = amd.homedir
3306 include (G)
3308 This allows you to include one config file inside another. The file
3310 is included literally, as though typed in place.
3311 It takes the standard substitutions, except %u, %P and %S.
3313 The parameter include = registry has a special meaning: It does not
3315 include a file named registry from the current working directory,
3316 but instead reads the global configuration options from the
3317 registry. See the section on registry-based configuration for
3318 details. Note that this option automatically activates registry
3319 shares.
3320 Default: include =
3322 Example: include = /usr/local/samba/lib/admin_smb.conf
3324 kernel change notify (S)
3326 This parameter specifies whether Samba should ask the kernel for
3328 change notifications in directories so that SMB clients can refresh
3329 whenever the data on the server changes.
3330 This parameter is only used when your kernel supports change
3332 notification to user programs using the inotify interface.
3333 Default: kernel change notify = yes
3335 lock dir
3337 This parameter is a synonym for lock directory.
3339 lock directory (G)
3341 This option specifies the directory where lock files will be
3343 placed. The lock files are used to implement the max connections
3344 option.
3345 Note: This option can not be set inside registry configurations.
3347 Default: lock directory = /var/lib/samba
3349 Example: lock directory = /var/run/samba/locks
3351 log writeable files on exit (G)
3353 When the network connection between a CIFS client and Samba dies,
3355 Samba has no option but to simply shut down the server side of the
3356 network connection. If this happens, there is a risk of data
3357 corruption because the Windows client did not complete all write
3358 operations that the Windows application requested. Setting this
3359 option to "yes" makes smbd log with a level 0 message a list of all
3360 files that have been opened for writing when the network connection
3361 died. Those are the files that are potentially corrupted. It is
3362 meant as an aid for the administrator to give him a list of files
3363 to do consistency checks on.
3364 Default: log writeable files on exit = no
3366 magic output (S)
3368 This parameter specifies the name of a file which will contain
3370 output created by a magic script (see the magic script parameter
3371 below).
3372 Warning
3374 If two clients use the same magic script in the same directory
3375 the output file content is undefined.
3376 Default: magic output = # <magic script name>.out
3377 Example: magic output = myfile.txt
3379 magic script (S)
3381 This parameter specifies the name of a file which, if opened, will
3383 be executed by the server when the file is closed. This allows a
3384 UNIX script to be sent to the Samba host and executed on behalf of
3385 the connected user.
3386 Scripts executed in this way will be deleted upon completion
3388 assuming that the user has the appropriate level of privilege and
3389 the file permissions allow the deletion.
3390 If the script generates output, output will be sent to the file
3392 specified by the magic output parameter (see above).
3393 Note that some shells are unable to interpret scripts containing
3395 CR/LF instead of CR as the end-of-line marker. Magic scripts must
3396 be executable as is on the host, which for some hosts and some
3397 shells will require filtering at the DOS end.
3398 Magic scripts are EXPERIMENTAL and should NOT be relied upon.
3400 Default: magic script =
3402 Example: magic script = user.csh
3404 message command (G)
3406 This specifies what command to run when the server receives a
3408 WinPopup style message.
3409 This would normally be a command that would deliver the message
3411 somehow. How this is to be done is up to your imagination.
3412 An example is:
3414 message command = csh -c ´xedit %s;rm %s´ &
3416 This delivers the message using xedit, then removes it afterwards.
3418 NOTE THAT IT IS VERY IMPORTANT THAT THIS COMMAND RETURN
3419 IMMEDIATELY. That´s why I have the ´&´ on the end. If it doesn´t
3420 return immediately then your PCs may freeze when sending messages
3421 (they should recover after 30 seconds, hopefully).
3422 All messages are delivered as the global guest user. The command
3424 takes the standard substitutions, although
3425 %u won´t work (%U may be better in this case).
3426 Apart from the standard substitutions, some additional ones apply.
3428 In particular:
3429 · %s = the filename containing the message.
3431 · %t = the destination that the message was sent to (probably the
3433 server name).
3434 · %f = who the message is from.
3436 You could make this command send mail, or whatever else takes your
3438 fancy. Please let us know of any really interesting ideas you have.
3439 Here´s a way of sending the messages as mail to root:
3441 message command = /bin/mail -s ´message from %f on %m´ root < %s; rm %s
3443 If you don´t have a message command then the message won´t be delivered
3445 and Samba will tell the sender there was an error. Unfortunately WfWg
3446 totally ignores the error code and carries on regardless, saying that
3447 the message was delivered.
3448 If you want to silently delete it then try:
3450 message command = rm %s
3452 Default: message command =
3454 Example: message command = csh -c ´xedit %s; rm %s´ &
3456 socket address
3458 This parameter is a synonym for nbt client socket address.
3460 nbt client socket address (G)
3462 This option allows you to control what address Samba will send NBT
3464 client packets from, and process replies using, including in nmbd.
3465 Setting this option should never be necessary on usual Samba
3467 servers running only one nmbd.
3468 By default Samba will send UDP packets from the OS default address
3470 for the destination, and accept replies on 0.0.0.0.
3471 This parameter is deprecated. See bind interfaces only = Yes and
3473 interfaces for the previous behaviour of controlling the normal
3474 listening sockets.
3475 Default: nbt client socket address = 0.0.0.0
3477 Example: nbt client socket address = 192.168.2.20
3479 ncalrpc dir (G)
3481 This directory will hold a series of named pipes to allow RPC over
3483 inter-process communication.
3484 This will allow Samba and other unix processes to interact over
3486 DCE/RPC without using TCP/IP. Additionally a sub-directory ´np´ has
3487 restricted permissions, and allows a trusted communication channel
3488 between Samba processes
3489 Default: ncalrpc dir = /var/run/samba/ncalrpc
3491 Example: ncalrpc dir = /var/run/samba/ncalrpc
3493 NIS homedir (G)
3495 Get the home share server from a NIS map. For UNIX systems that use
3497 an automounter, the user´s home directory will often be mounted on
3498 a workstation on demand from a remote server.
3499 When the Samba logon server is not the actual home directory
3501 server, but is mounting the home directories via NFS then two
3502 network hops would be required to access the users home directory
3503 if the logon server told the client to use itself as the SMB server
3504 for home directories (one over SMB and one over NFS). This can be
3505 very slow.
3506 This option allows Samba to return the home share as being on a
3508 different server to the logon server and as long as a Samba daemon
3509 is running on the home directory server, it will be mounted on the
3510 Samba client directly from the directory server. When Samba is
3511 returning the home share to the client, it will consult the NIS map
3512 specified in homedir map and return the server listed there.
3513 Note that for this option to work there must be a working NIS
3515 system and the Samba server with this option must also be a logon
3516 server.
3517 Default: NIS homedir = no
3519 nmbd bind explicit broadcast (G)
3521 This option causes nmbd(8) to explicitly bind to the broadcast
3523 address of the local subnets. This is needed to make nmbd work
3524 correctly in combination with the socket address option. You should
3525 not need to unset this option.
3526 Default: nmbd bind explicit broadcast = yes
3528 panic action (G)
3530 This is a Samba developer option that allows a system command to be
3532 called when either smbd(8) or nmbd(8) crashes. This is usually used
3533 to draw attention to the fact that a problem occurred.
3534 Default: panic action =
3536 Example: panic action = "/bin/sleep 90000"
3538 perfcount module (G)
3540 This parameter specifies the perfcount backend to be used when
3542 monitoring SMB operations. Only one perfcount module may be used,
3543 and it must implement all of the apis contained in the
3544 smb_perfcount_handler structure defined in smb.h.
3545 No default
3547 pid directory (G)
3549 This option specifies the directory where pid files will be placed.
3551 Default: pid directory = /var/run
3553 Example: pid directory = /var/run/
3555 postexec (S)
3557 This option specifies a command to be run whenever the service is
3559 disconnected. It takes the usual substitutions. The command may be
3560 run as the root on some systems.
3561 An interesting example may be to unmount server resources:
3563 postexec = /etc/umount /cdrom
3565 Default: postexec =
3567 Example: postexec = echo \"%u disconnected from %S from %m (%I)\"
3569 >> /tmp/log
3570 exec
3572 This parameter is a synonym for preexec.
3574 preexec (S)
3576 This option specifies a command to be run whenever the service is
3578 connected to. It takes the usual substitutions.
3579 An interesting example is to send the users a welcome message every
3581 time they log in. Maybe a message of the day? Here is an example:
3582 preexec = csh -c ´echo \"Welcome to %S!\" |
3585 /usr/local/samba/bin/smbclient -M %m -I %I´ &
3586 Of course, this could get annoying after a while :-)
3588 See also preexec close and postexec.
3590 Default: preexec =
3592 Example: preexec = echo \"%u connected to %S from %m (%I)\" >>
3594 /tmp/log
3595 preexec close (S)
3597 This boolean option controls whether a non-zero return code from
3599 preexec should close the service being connected to.
3600 Default: preexec close = no
3602 auto services
3604 This parameter is a synonym for preload.
3606 preload (G)
3608 This is a list of services that you want to be automatically added
3610 to the browse lists. This is most useful for homes and printers
3611 services that would otherwise not be visible.
3612 Note that if you just want all printers in your printcap file
3614 loaded then the load printers option is easier.
3615 Default: preload =
3617 Example: preload = fred lp colorlp
3619 registry shares (G)
3621 This turns on or off support for share definitions read from
3623 registry. Shares defined in smb.conf take precedence over shares
3624 with the same name defined in registry. See the section on
3625 registry-based configuration for details.
3626 Note that this parameter defaults to no, but it is set to yes when
3628 config backend is set to registry.
3629 Default: registry shares = no
3631 Example: registry shares = yes
3633 remote announce (G)
3635 This option allows you to setup nmbd(8) to periodically announce
3637 itself to arbitrary IP addresses with an arbitrary workgroup name.
3638 This is useful if you want your Samba server to appear in a remote
3640 workgroup for which the normal browse propagation rules don´t work.
3641 The remote workgroup can be anywhere that you can send IP packets
3642 to.
3643 For example:
3645 remote announce = 192.168.2.255/SERVERS 192.168.4.255/STAFF
3647 the above line would cause nmbd to announce itself to the two given
3649 IP addresses using the given workgroup names. If you leave out the
3650 workgroup name, then the one given in the workgroup parameter is
3651 used instead.
3652 The IP addresses you choose would normally be the broadcast
3654 addresses of the remote networks, but can also be the IP addresses
3655 of known browse masters if your network config is that stable.
3656 See the chapter on Network Browsing in the Samba-HOWTO book.
3658 Default: remote announce =
3660 remote browse sync (G)
3662 This option allows you to setup nmbd(8) to periodically request
3664 synchronization of browse lists with the master browser of a Samba
3665 server that is on a remote segment. This option will allow you to
3666 gain browse lists for multiple workgroups across routed networks.
3667 This is done in a manner that does not work with any non-Samba
3668 servers.
3669 This is useful if you want your Samba server and all local clients
3671 to appear in a remote workgroup for which the normal browse
3672 propagation rules don´t work. The remote workgroup can be anywhere
3673 that you can send IP packets to.
3674 For example:
3676 remote browse sync = 192.168.2.255 192.168.4.255
3678 the above line would cause nmbd to request the master browser on
3680 the specified subnets or addresses to synchronize their browse
3681 lists with the local server.
3682 The IP addresses you choose would normally be the broadcast
3684 addresses of the remote networks, but can also be the IP addresses
3685 of known browse masters if your network config is that stable. If a
3686 machine IP address is given Samba makes NO attempt to validate that
3687 the remote machine is available, is listening, nor that it is in
3688 fact the browse master on its segment.
3689 The remote browse sync may be used on networks where there is no
3691 WINS server, and may be used on disjoint networks where each
3692 network has its own WINS server.
3693 Default: remote browse sync =
3695 reset on zero vc (G)
3697 This boolean option controls whether an incoming session setup
3699 should kill other connections coming from the same IP. This matches
3700 the default Windows 2003 behaviour. Setting this parameter to yes
3701 becomes necessary when you have a flaky network and windows decides
3702 to reconnect while the old connection still has files with share
3703 modes open. These files become inaccessible over the new
3704 connection. The client sends a zero VC on the new connection, and
3705 Windows 2003 kills all other connections coming from the same IP.
3706 This way the locked files are accessible again. Please be aware
3707 that enabling this option will kill connections behind a
3708 masquerading router.
3709 Default: reset on zero vc = no
3711 root postexec (S)
3713 This is the same as the postexec parameter except that the command
3715 is run as root. This is useful for unmounting filesystems (such as
3716 CDROMs) after a connection is closed.
3717 Default: root postexec =
3719 root preexec (S)
3721 This is the same as the preexec parameter except that the command
3723 is run as root. This is useful for mounting filesystems (such as
3724 CDROMs) when a connection is opened.
3725 Default: root preexec =
3727 root preexec close (S)
3729 This is the same as the preexec close parameter except that the
3731 command is run as root.
3732 Default: root preexec close = no
3734 rpc_daemon:DAEMON (G)
3736 Defines whether to use the embedded code or start a separate daemon
3738 for the defined rpc services. The rpc_daemon prefix must be
3739 followed by the server name, and a value.
3740 Two possible values are currently supported:
3742 disabled
3744 fork
3745 The classic method is to run rpc services as internal daemons
3748 embedded in smbd, therefore the external daemons are disabled by
3749 default.
3750 Choosing the fork option will cause samba to fork a separate proces
3752 for each daemon configured this way. Each daemon may in turn fork a
3753 number of children used to handle requests from multiple smbds and
3754 direct tcp/ip connections (if the Endpoint Mapper is enabled).
3755 Communication with smbd happens over named pipes and require that
3756 said pipes are forward to the external daemon (see rpc_server).
3757 Forked RPC Daemons support dynamically forking children to handle
3759 connections. The heuristics about how many children to keep around
3760 and how fast to allow them to fork and also how many clients each
3761 child is allowed to handle concurrently is defined by parametrical
3762 options named after the daemon. Five options are currently
3763 supported:
3764 prefork_min_children
3766 prefork_max_children
3767 prefork_spawn_rate
3768 prefork_max_allowed_clients
3769 prefork_child_min_life
3770 To set one of these options use the follwing syntax:
3773 damonname:prefork_min_children = 5
3775 Samba includes separate daemons for spoolss and the lsarpc/lsass,
3778 netlogon and samr pipes. Currently three daemons are available and
3779 they are called:
3780 epmd
3782 lsasd
3783 spoolssd
3784 Example:
3787 rpc_daemon:spoolssd = fork
3789 Default: rpc_daemon:DAEMON = disabled
3792 rpc_server:SERVER (G)
3794 With this option you can define if a rpc service should be running
3796 internal/embedded in smbd or should be redirected to an external
3797 daemon like Samba4, the endpoint mapper daemon, the spoolss daemon
3798 or the new LSA service daemon. The rpc_server prefix must be
3799 followed by the pipe name, and a value.
3800 This option can be set for each available rpc service in Samba. The
3802 following list shows all available pipe names services you can
3803 modify with this option.
3804 · epmapper - Endpoint Mapper
3806 · winreg - Remote Registry Service
3808 · srvsvc - Remote Server Services
3810 · lsarpc - Local Security Authority
3812 · samr - Security Account Management
3814 · netlogon - Netlogon Remote Protocol
3816 · netdfs - Settings for Distributed File System
3818 · dssetup - Active Directory Setup
3820 · wkssvc - Workstation Services
3822 · spoolss - Network Printing Spooler
3824 · svcctl - Service Control
3826 · ntsvcs - Plug and Play Services
3828 · eventlog - Event Logger
3830 · initshutdown - Init Shutdown Service
3832 Three possible values currently supported are: embedded external
3834 disabled
3835 The classic method is to run every pipe as an internal function
3837 embedded in smbd. The defaults may vary depending on the service.
3838 Choosing the external option allows to run a separate daemon or even a
3840 completely independent (3rd party) server capable of interfacing with
3841 samba via the MS-RPC interface over named pipes.
3842 Currently in Samba3 we support three daemons, spoolssd, epmd and lsasd.
3844 These daemons can be enabled using the rpc_daemon option. For spoolssd
3845 you have to enable the daemon and proxy the named pipe with:
3846 Examples:
3848 rpc_daemon:lsasd = fork
3850 rpc_server:lsarpc = external
3851 rpc_server:samr = external
3852 rpc_server:netlogon = external
3853 rpc_server:spoolss = external
3855 rpc_server:epmapper = disabled
3856 There is one special option which allows you to enable rpc services to
3859 listen for ncacn_ip_tcp connections too. Currently this is only used
3860 for testing and doesn´t scale!
3861 rpc_server:tcpip = yes
3863 Default: rpc_server:SERVER = embedded
3866 state directory (G)
3868 Usually, most of the TDB files are stored in the lock directory.
3870 Since Samba 3.4.0, it is possible to differentiate between TDB
3871 files with persistent data and TDB files with non-persistent data
3872 using the state directory and the cache directory options.
3873 This option specifies the directory where TDB files containing
3875 persistent data will be stored.
3876 Default: state directory = /var/lib/samba
3878 Example: state directory = /var/run/samba/locks/state
3880 usershare allow guests (G)
3882 This parameter controls whether user defined shares are allowed to
3884 be accessed by non-authenticated users or not. It is the equivalent
3885 of allowing people who can create a share the option of setting
3886 guest ok = yes in a share definition. Due to its security sensitive
3887 nature, the default is set to off.
3888 Default: usershare allow guests = no
3890 usershare max shares (G)
3892 This parameter specifies the number of user defined shares that are
3894 allowed to be created by users belonging to the group owning the
3895 usershare directory. If set to zero (the default) user defined
3896 shares are ignored.
3897 Default: usershare max shares = 0
3899 usershare owner only (G)
3901 This parameter controls whether the pathname exported by a user
3903 defined shares must be owned by the user creating the user defined
3904 share or not. If set to True (the default) then smbd checks that
3905 the directory path being shared is owned by the user who owns the
3906 usershare file defining this share and refuses to create the share
3907 if not. If set to False then no such check is performed and any
3908 directory path may be exported regardless of who owns it.
3909 Default: usershare owner only = yes
3911 usershare path (G)
3913 This parameter specifies the absolute path of the directory on the
3915 filesystem used to store the user defined share definition files.
3916 This directory must be owned by root, and have no access for other,
3917 and be writable only by the group owner. In addition the "sticky"
3918 bit must also be set, restricting rename and delete to owners of a
3919 file (in the same way the /tmp directory is usually configured).
3920 Members of the group owner of this directory are the users allowed
3921 to create usershares.
3922 For example, a valid usershare directory might be
3924 /usr/local/samba/lib/usershares, set up as follows.
3925 ls -ld /usr/local/samba/lib/usershares/
3929 drwxrwx--T 2 root power_users 4096 2006-05-05 12:27 /usr/local/samba/lib/usershares/
3930 In this case, only members of the group "power_users" can create
3933 user defined shares.
3934 Default: usershare path = /var/lib/samba/usershares
3936 usershare prefix allow list (G)
3938 This parameter specifies a list of absolute pathnames the root of
3940 which are allowed to be exported by user defined share definitions.
3941 If the pathname to be exported doesn´t start with one of the
3942 strings in this list, the user defined share will not be allowed.
3943 This allows the Samba administrator to restrict the directories on
3944 the system that can be exported by user defined shares.
3945 If there is a "usershare prefix deny list" and also a "usershare
3947 prefix allow list" the deny list is processed first, followed by
3948 the allow list, thus leading to the most restrictive
3949 interpretation.
3950 Default: usershare prefix allow list =
3952 Example: usershare prefix allow list = /home /data /space
3954 usershare prefix deny list (G)
3956 This parameter specifies a list of absolute pathnames the root of
3958 which are NOT allowed to be exported by user defined share
3959 definitions. If the pathname exported starts with one of the
3960 strings in this list the user defined share will not be allowed.
3961 Any pathname not starting with one of these strings will be allowed
3962 to be exported as a usershare. This allows the Samba administrator
3963 to restrict the directories on the system that can be exported by
3964 user defined shares.
3965 If there is a "usershare prefix deny list" and also a "usershare
3967 prefix allow list" the deny list is processed first, followed by
3968 the allow list, thus leading to the most restrictive
3969 interpretation.
3970 Default: usershare prefix deny list =
3972 Example: usershare prefix deny list = /etc /dev /private
3974 usershare template share (G)
3976 User defined shares only have limited possible parameters such as
3978 path, guest ok, etc. This parameter allows usershares to "cloned"
3979 from an existing share. If "usershare template share" is set to the
3980 name of an existing share, then all usershares created have their
3981 defaults set from the parameters set on this share.
3982 The target share may be set to be invalid for real file sharing by
3984 setting the parameter "-valid = False" on the template share
3985 definition. This causes it not to be seen as a real exported share
3986 but to be able to be used as a template for usershares.
3987 Default: usershare template share =
3989 Example: usershare template share = template_share
3991 utmp (G)
3993 This boolean parameter is only available if Samba has been
3995 configured and compiled with the option --with-utmp. If set to yes
3996 then Samba will attempt to add utmp or utmpx records (depending on
3997 the UNIX system) whenever a connection is made to a Samba server.
3998 Sites may use this to record the user connecting to a Samba share.
3999 Due to the requirements of the utmp record, we are required to
4001 create a unique identifier for the incoming user. Enabling this
4002 option creates an n^2 algorithm to find this number. This may
4003 impede performance on large installations.
4004 Default: utmp = no
4006 utmp directory (G)
4008 This parameter is only available if Samba has been configured and
4010 compiled with the option --with-utmp. It specifies a directory
4011 pathname that is used to store the utmp or utmpx files (depending
4012 on the UNIX system) that record user connections to a Samba server.
4013 By default this is not set, meaning the system will use whatever
4014 utmp file the native system is set to use (usually /var/run/utmp on
4015 Linux).
4016 Default: utmp directory = # Determined automatically
4018 Example: utmp directory = /var/run/utmp
4020 -valid (S)
4022 This parameter indicates whether a share is valid and thus can be
4024 used. When this parameter is set to false, the share will be in no
4025 way visible nor accessible.
4026 This option should not be used by regular users but might be of
4028 help to developers. Samba uses this option internally to mark
4029 shares as deleted.
4030 Default: -valid = yes
4032 volume (S)
4034 This allows you to override the volume label returned for a share.
4036 Useful for CDROMs with installation programs that insist on a
4037 particular volume label.
4038 Default: volume = # the name of the share
4040 wide links (S)
4042 This parameter controls whether or not links in the UNIX file
4044 system may be followed by the server. Links that point to areas
4045 within the directory tree exported by the server are always
4046 allowed; this parameter controls access only to areas that are
4047 outside the directory tree being exported.
4048 Note: Turning this parameter on when UNIX extensions are enabled
4050 will allow UNIX clients to create symbolic links on the share that
4051 can point to files or directories outside restricted path exported
4052 by the share definition. This can cause access to areas outside of
4053 the share. Due to this problem, this parameter will be
4054 automatically disabled (with a message in the log file) if the unix
4055 extensions option is on.
4056 See the parameter allow insecure wide links if you wish to change
4058 this coupling between the two parameters.
4059 Default: wide links = no
4061 wtmp directory (G)
4063 This parameter is only available if Samba has been configured and
4065 compiled with the option --with-utmp. It specifies a directory
4066 pathname that is used to store the wtmp or wtmpx files (depending
4067 on the UNIX system) that record user connections to a Samba server.
4068 The difference with the utmp directory is the fact that user info
4069 is kept after a user has logged out.
4070 By default this is not set, meaning the system will use whatever
4072 utmp file the native system is set to use (usually /var/run/wtmp on
4073 Linux).
4074 Default: wtmp directory =
4076 Example: wtmp directory = /var/log/wtmp
4078 addport command (G)
4080 Samba 3.0.23 introduced support for adding printer ports remotely
4082 using the Windows "Add Standard TCP/IP Port Wizard". This option
4083 defines an external program to be executed when smbd receives a
4084 request to add a new Port to the system. The script is passed two
4085 parameters:
4086 · port name
4088 · device URI
4090 The deviceURI is in the format of socket://<hostname>[:<portnumber>] or
4092 lpd://<hostname>/<queuename>.
4093 Default: addport command =
4095 Example: addport command = /etc/samba/scripts/addport.sh
4097 addprinter command (G)
4099 With the introduction of MS-RPC based printing support for Windows
4101 NT/2000 clients in Samba 2.2, The MS Add Printer Wizard (APW) icon
4102 is now also available in the "Printers..." folder displayed a share
4103 listing. The APW allows for printers to be add remotely to a Samba
4104 or Windows NT/2000 print server.
4105 For a Samba host this means that the printer must be physically
4107 added to the underlying printing system. The addprinter command
4108 defines a script to be run which will perform the necessary
4109 operations for adding the printer to the print system and to add
4110 the appropriate service definition to the smb.conf file in order
4111 that it can be shared by smbd(8).
4112 The addprinter command is automatically invoked with the following
4114 parameter (in order):
4115 · printer name
4117 · share name
4119 · port name
4121 · driver name
4123 · location
4125 · Windows 9x driver location
4127 All parameters are filled in from the PRINTER_INFO_2 structure sent by
4129 the Windows NT/2000 client with one exception. The "Windows 9x driver
4130 location" parameter is included for backwards compatibility only. The
4131 remaining fields in the structure are generated from answers to the APW
4132 questions.
4133 Once the addprinter command has been executed, smbd will reparse the
4135 smb.conf to determine if the share defined by the APW exists. If the
4136 sharename is still invalid, then smbd will return an ACCESS_DENIED
4137 error to the client.
4138 The addprinter command program can output a single line of text, which
4140 Samba will set as the port the new printer is connected to. If this
4141 line isn´t output, Samba won´t reload its printer shares.
4142 Default: addprinter command =
4144 Example: addprinter command = /usr/bin/addprinter
4146 cups connection timeout (G)
4148 This parameter is only applicable if printing is set to cups.
4150 If set, this option specifies the number of seconds that smbd will
4152 wait whilst trying to contact to the CUPS server. The connection
4153 will fail if it takes longer than this number of seconds.
4154 Default: cups connection timeout = 30
4156 Example: cups connection timeout = 60
4158 cups encrypt (G)
4160 This parameter is only applicable if printing is set to cups and if
4162 you use CUPS newer than 1.0.x.It is used to define whether or not
4163 Samba should use encryption when talking to the CUPS server.
4164 Possible values are auto, yes and no
4165 When set to auto we will try to do a TLS handshake on each CUPS
4167 connection setup. If that fails, we will fall back to unencrypted
4168 operation.
4169 Default: cups encrypt = no
4171 cups options (S)
4173 This parameter is only applicable if printing is set to cups. Its
4175 value is a free form string of options passed directly to the cups
4176 library.
4177 You can pass any generic print option known to CUPS (as listed in
4179 the CUPS "Software Users´ Manual"). You can also pass any printer
4180 specific option (as listed in "lpoptions -d printername -l") valid
4181 for the target queue. Multiple parameters should be space-delimited
4182 name/value pairs according to the PAPI text option ABNF
4183 specification. Collection values ("name={a=... b=... c=...}") are
4184 stored with the curley brackets intact.
4185 You should set this parameter to raw if your CUPS server error_log
4187 file contains messages such as "Unsupported format
4188 ´application/octet-stream´" when printing from a Windows client
4189 through Samba. It is no longer necessary to enable system wide raw
4190 printing in /etc/cups/mime.{convs,types}.
4191 Default: cups options = ""
4193 Example: cups options = "raw media=a4"
4195 cups server (G)
4197 This parameter is only applicable if printing is set to cups.
4199 If set, this option overrides the ServerName option in the CUPS
4201 client.conf. This is necessary if you have virtual samba servers
4202 that connect to different CUPS daemons.
4203 Optionally, a port can be specified by separating the server name
4205 and port number with a colon. If no port was specified, the default
4206 port for IPP (631) will be used.
4207 Default: cups server = ""
4209 Example: cups server = mycupsserver
4211 Example: cups server = mycupsserver:1631
4213 default devmode (S)
4215 This parameter is only applicable to printable services. When smbd
4217 is serving Printer Drivers to Windows NT/2k/XP clients, each
4218 printer on the Samba server has a Device Mode which defines things
4219 such as paper size and orientation and duplex settings. The device
4220 mode can only correctly be generated by the printer driver itself
4221 (which can only be executed on a Win32 platform). Because smbd is
4222 unable to execute the driver code to generate the device mode, the
4223 default behavior is to set this field to NULL.
4224 Most problems with serving printer drivers to Windows NT/2k/XP
4226 clients can be traced to a problem with the generated device mode.
4227 Certain drivers will do things such as crashing the client´s
4228 Explorer.exe with a NULL devmode. However, other printer drivers
4229 can cause the client´s spooler service (spoolsv.exe) to die if the
4230 devmode was not created by the driver itself (i.e. smbd generates a
4231 default devmode).
4232 This parameter should be used with care and tested with the printer
4234 driver in question. It is better to leave the device mode to NULL
4235 and let the Windows client set the correct values. Because drivers
4236 do not do this all the time, setting default devmode = yes will
4237 instruct smbd to generate a default one.
4238 For more information on Windows NT/2k printing and Device Modes,
4240 see the MSDN documentation.
4241 Default: default devmode = yes
4243 deleteprinter command (G)
4245 With the introduction of MS-RPC based printer support for Windows
4247 NT/2000 clients in Samba 2.2, it is now possible to delete a
4248 printer at run time by issuing the DeletePrinter() RPC call.
4249 For a Samba host this means that the printer must be physically
4251 deleted from the underlying printing system. The deleteprinter
4252 command defines a script to be run which will perform the necessary
4253 operations for removing the printer from the print system and from
4254 smb.conf.
4255 The deleteprinter command is automatically called with only one
4257 parameter: printer name.
4258 Once the deleteprinter command has been executed, smbd will reparse
4260 the smb.conf to check that the associated printer no longer exists.
4261 If the sharename is still valid, then smbd will return an
4262 ACCESS_DENIED error to the client.
4263 Default: deleteprinter command =
4265 Example: deleteprinter command = /usr/bin/removeprinter
4267 disable spoolss (G)
4269 Enabling this parameter will disable Samba´s support for the
4271 SPOOLSS set of MS-RPC´s and will yield identical behavior as Samba
4272 2.0.x. Windows NT/2000 clients will downgrade to using Lanman style
4273 printing commands. Windows 9x/ME will be unaffected by the
4274 parameter. However, this will also disable the ability to upload
4275 printer drivers to a Samba server via the Windows NT Add Printer
4276 Wizard or by using the NT printer properties dialog window. It will
4277 also disable the capability of Windows NT/2000 clients to download
4278 print drivers from the Samba host upon demand. Be very careful
4279 about enabling this parameter.
4280 Default: disable spoolss = no
4282 enable spoolss (G)
4284 Inverted synonym for disable spoolss.
4286 Default: enable spoolss = yes
4288 enumports command (G)
4290 The concept of a "port" is fairly foreign to UNIX hosts. Under
4292 Windows NT/2000 print servers, a port is associated with a port
4293 monitor and generally takes the form of a local port (i.e. LPT1:,
4294 COM1:, FILE:) or a remote port (i.e. LPD Port Monitor, etc...). By
4295 default, Samba has only one port defined--"Samba Printer Port".
4296 Under Windows NT/2000, all printers must have a valid port name. If
4297 you wish to have a list of ports displayed (smbd does not use a
4298 port name for anything) other than the default "Samba Printer
4299 Port", you can define enumports command to point to a program which
4300 should generate a list of ports, one per line, to standard output.
4301 This listing will then be used in response to the level 1 and 2
4302 EnumPorts() RPC.
4303 Default: enumports command =
4305 Example: enumports command = /usr/bin/listports
4307 force printername (S)
4309 When printing from Windows NT (or later), each printer in smb.conf
4311 has two associated names which can be used by the client. The first
4312 is the sharename (or shortname) defined in smb.conf. This is the
4313 only printername available for use by Windows 9x clients. The
4314 second name associated with a printer can be seen when browsing to
4315 the "Printers" (or "Printers and Faxes") folder on the Samba
4316 server. This is referred to simply as the printername (not to be
4317 confused with the printer name option).
4318 When assigning a new driver to a printer on a remote Windows
4320 compatible print server such as Samba, the Windows client will
4321 rename the printer to match the driver name just uploaded. This can
4322 result in confusion for users when multiple printers are bound to
4323 the same driver. To prevent Samba from allowing the printer´s
4324 printername to differ from the sharename defined in smb.conf, set
4325 force printername = yes.
4326 Be aware that enabling this parameter may affect migrating printers
4328 from a Windows server to Samba since Windows has no way to force
4329 the sharename and printername to match.
4330 It is recommended that this parameter´s value not be changed once
4332 the printer is in use by clients as this could cause a user not be
4333 able to delete printer connections from their local Printers
4334 folder.
4335 Default: force printername = no
4337 iprint server (G)
4339 This parameter is only applicable if printing is set to iprint.
4341 If set, this option overrides the ServerName option in the CUPS
4343 client.conf. This is necessary if you have virtual samba servers
4344 that connect to different CUPS daemons.
4345 Default: iprint server = ""
4347 Example: iprint server = MYCUPSSERVER
4349 load printers (G)
4351 A boolean variable that controls whether all printers in the
4353 printcap will be loaded for browsing by default. See the printers
4354 section for more details.
4355 Default: load printers = yes
4357 lppause command (S)
4359 This parameter specifies the command to be executed on the server
4361 host in order to stop printing or spooling a specific print job.
4362 This command should be a program or script which takes a printer
4364 name and job number to pause the print job. One way of implementing
4365 this is by using job priorities, where jobs having a too low
4366 priority won´t be sent to the printer.
4367 If a %p is given then the printer name is put in its place. A %j is
4369 replaced with the job number (an integer). On HPUX (see
4370 printing=hpux ), if the -p%p option is added to the lpq command,
4371 the job will show up with the correct status, i.e. if the job
4372 priority is lower than the set fence priority it will have the
4373 PAUSED status, whereas if the priority is equal or higher it will
4374 have the SPOOLED or PRINTING status.
4375 Note that it is good practice to include the absolute path in the
4377 lppause command as the PATH may not be available to the server.
4378 Currently no default value is given to this string, unless the
4380 value of the printing parameter is SYSV, in which case the default
4381 is : lp -i %p-%j -H hold or if the value of the printing parameter
4382 is SOFTQ, then the default is: qstat -s -j%j -h.
4383 Default: lppause command = # determined by printing parameter
4385 Example: lppause command = /usr/bin/lpalt %p-%j -p0
4387 lpq cache time (G)
4389 This controls how long lpq info will be cached for to prevent the
4391 lpq command being called too often. A separate cache is kept for
4392 each variation of the lpq command used by the system, so if you use
4393 different lpq commands for different users then they won´t share
4394 cache information.
4395 The cache files are stored in /tmp/lpq.xxxx where xxxx is a hash of
4397 the lpq command in use.
4398 The default is 30 seconds, meaning that the cached results of a
4400 previous identical lpq command will be used if the cached data is
4401 less than 30 seconds old. A large value may be advisable if your
4402 lpq command is very slow.
4403 A value of 0 will disable caching completely.
4405 Default: lpq cache time = 30
4407 Example: lpq cache time = 10
4409 lpq command (S)
4411 This parameter specifies the command to be executed on the server
4413 host in order to obtain lpq-style printer status information.
4414 This command should be a program or script which takes a printer
4416 name as its only parameter and outputs printer status information.
4417 Currently nine styles of printer status information are supported;
4419 BSD, AIX, LPRNG, PLP, SYSV, HPUX, QNX, CUPS, and SOFTQ. This covers
4420 most UNIX systems. You control which type is expected using the
4421 printing = option.
4422 Some clients (notably Windows for Workgroups) may not correctly
4424 send the connection number for the printer they are requesting
4425 status information about. To get around this, the server reports on
4426 the first printer service connected to by the client. This only
4427 happens if the connection number sent is invalid.
4428 If a %p is given then the printer name is put in its place.
4430 Otherwise it is placed at the end of the command.
4431 Note that it is good practice to include the absolute path in the
4433 lpq command as the $PATH may not be available to the server. When
4434 compiled with the CUPS libraries, no lpq command is needed because
4435 smbd will make a library call to obtain the print queue listing.
4436 Default: lpq command = # determined by printing parameter
4438 Example: lpq command = /usr/bin/lpq -P%p
4440 lpresume command (S)
4442 This parameter specifies the command to be executed on the server
4444 host in order to restart or continue printing or spooling a
4445 specific print job.
4446 This command should be a program or script which takes a printer
4448 name and job number to resume the print job. See also the lppause
4449 command parameter.
4450 If a %p is given then the printer name is put in its place. A %j is
4452 replaced with the job number (an integer).
4453 Note that it is good practice to include the absolute path in the
4455 lpresume command as the PATH may not be available to the server.
4456 See also the printing parameter.
4458 Default: Currently no default value is given to this string, unless
4460 the value of the printing parameter is SYSV, in which case the
4461 default is:
4462 lp -i %p-%j -H resume
4464 or if the value of the printing parameter is SOFTQ, then the
4466 default is:
4467 qstat -s -j%j -r
4469 Default: lpresume command = # determined by printing parameter
4471 Example: lpresume command = /usr/bin/lpalt %p-%j -p2
4473 lprm command (S)
4475 This parameter specifies the command to be executed on the server
4477 host in order to delete a print job.
4478 This command should be a program or script which takes a printer
4480 name and job number, and deletes the print job.
4481 If a %p is given then the printer name is put in its place. A %j is
4483 replaced with the job number (an integer).
4484 Note that it is good practice to include the absolute path in the
4486 lprm command as the PATH may not be available to the server.
4487 Examples of use are:
4489 lprm command = /usr/bin/lprm -P%p %j
4491 or
4493 lprm command = /usr/bin/cancel %p-%j
4495 Default: lprm command = # determined by printing parameter
4497 max print jobs (S)
4499 This parameter limits the maximum number of jobs allowable in a
4501 Samba printer queue at any given moment. If this number is
4502 exceeded, smbd(8) will remote "Out of Space" to the client.
4503 Default: max print jobs = 1000
4505 Example: max print jobs = 5000
4507 max reported print jobs (S)
4509 This parameter limits the maximum number of jobs displayed in a
4511 port monitor for Samba printer queue at any given moment. If this
4512 number is exceeded, the excess jobs will not be shown. A value of
4513 zero means there is no limit on the number of print jobs reported.
4514 Default: max reported print jobs = 0
4516 Example: max reported print jobs = 1000
4518 os2 driver map (G)
4520 The parameter is used to define the absolute path to a file
4522 containing a mapping of Windows NT printer driver names to OS/2
4523 printer driver names. The format is:
4524 <nt driver name> = <os2 driver name>.<device name>
4526 For example, a valid entry using the HP LaserJet 5 printer driver
4528 would appear as HP LaserJet 5L = LASERJET.HP LaserJet 5L.
4529 The need for the file is due to the printer driver namespace
4531 problem described in the chapter on Classical Printing in the
4532 Samba3-HOWTO book. For more details on OS/2 clients, please refer
4533 to chapter on other clients in the Samba3-HOWTO book.
4534 Default: os2 driver map =
4536 print ok
4538 This parameter is a synonym for printable.
4540 printable (S)
4542 If this parameter is yes, then clients may open, write to and
4544 submit spool files on the directory specified for the service.
4545 Note that a printable service will ALWAYS allow writing to the
4547 service path (user privileges permitting) via the spooling of print
4548 data. The read only parameter controls only non-printing access to
4549 the resource.
4550 Default: printable = no
4552 printcap cache time (G)
4554 This option specifies the number of seconds before the printing
4556 subsystem is again asked for the known printers.
4557 Setting this parameter to 0 disables any rescanning for new or
4559 removed printers after the initial startup.
4560 Default: printcap cache time = 750
4562 Example: printcap cache time = 600
4564 printcap
4566 This parameter is a synonym for printcap name.
4568 printcap name (G)
4570 This parameter may be used to override the compiled-in default
4572 printcap name used by the server (usually /etc/printcap). See the
4573 discussion of the [printers] section above for reasons why you
4574 might want to do this.
4575 To use the CUPS printing interface set printcap name = cups. This
4577 should be supplemented by an additional setting printing = cups in
4578 the [global] section. printcap name = cups will use the "dummy"
4579 printcap created by CUPS, as specified in your CUPS configuration
4580 file.
4581 On System V systems that use lpstat to list available printers you
4583 can use printcap name = lpstat to automatically obtain lists of
4584 available printers. This is the default for systems that define
4585 SYSV at configure time in Samba (this includes most System V based
4586 systems). If
4587 printcap name is set to lpstat on these systems then Samba will
4588 launch lpstat -v and attempt to parse the output to obtain a
4589 printer list.
4590 A minimal printcap file would look something like this:
4592 print1|My Printer 1
4594 print2|My Printer 2
4595 print3|My Printer 3
4596 print4|My Printer 4
4597 print5|My Printer 5
4598 where the ´|´ separates aliases of a printer. The fact that the
4600 second alias has a space in it gives a hint to Samba that it´s a
4601 comment.
4602 Note
4604 Under AIX the default printcap name is /etc/qconfig. Samba will
4605 assume the file is in AIX qconfig format if the string qconfig
4606 appears in the printcap filename.
4607 Default: printcap name = /etc/printcap
4608 Example: printcap name = /etc/myprintcap
4610 print command (S)
4612 After a print job has finished spooling to a service, this command
4614 will be used via a system() call to process the spool file.
4615 Typically the command specified will submit the spool file to the
4616 host´s printing subsystem, but there is no requirement that this be
4617 the case. The server will not remove the spool file, so whatever
4618 command you specify should remove the spool file when it has been
4619 processed, otherwise you will need to manually remove old spool
4620 files.
4621 The print command is simply a text string. It will be used verbatim
4623 after macro substitutions have been made:
4624 %s, %f - the path to the spool file name
4626 %p - the appropriate printer name
4628 %J - the job name as transmitted by the client.
4630 %c - The number of printed pages of the spooled job (if known).
4632 %z - the size of the spooled print job (in bytes)
4634 The print command MUST contain at least one occurrence of %s or %f
4636 - the %p is optional. At the time a job is submitted, if no printer
4637 name is supplied the %p will be silently removed from the printer
4638 command.
4639 If specified in the [global] section, the print command given will
4641 be used for any printable service that does not have its own print
4642 command specified.
4643 If there is neither a specified print command for a printable
4645 service nor a global print command, spool files will be created but
4646 not processed and (most importantly) not removed.
4647 Note that printing may fail on some UNIXes from the nobody account.
4649 If this happens then create an alternative guest account that can
4650 print and set the guest account in the [global] section.
4651 You can form quite complex print commands by realizing that they
4653 are just passed to a shell. For example the following will log a
4654 print job, print the file, then remove it. Note that ´;´ is the
4655 usual separator for command in shell scripts.
4656 print command = echo Printing %s >> /tmp/print.log; lpr -P %p %s;
4658 rm %s
4659 You may have to vary this command considerably depending on how you
4661 normally print files on your system. The default for the parameter
4662 varies depending on the setting of the printing parameter.
4663 Default: For printing = BSD, AIX, QNX, LPRNG or PLP :
4665 print command = lpr -r -P%p %s
4667 For printing = SYSV or HPUX :
4669 print command = lp -c -d%p %s; rm %s
4671 For printing = SOFTQ :
4673 print command = lp -d%p -s %s; rm %s
4675 For printing = CUPS : If SAMBA is compiled against libcups, then
4677 printcap = cups uses the CUPS API to submit jobs, etc. Otherwise it
4678 maps to the System V commands with the -oraw option for printing,
4679 i.e. it uses lp -c -d%p -oraw; rm %s. With printing = cups, and if
4680 SAMBA is compiled against libcups, any manually set print command
4681 will be ignored.
4682 No default
4684 Example: print command = /usr/local/samba/bin/myprintscript %p %s
4686 printer
4688 This parameter is a synonym for printer name.
4690 printer name (S)
4692 This parameter specifies the name of the printer to which print
4694 jobs spooled through a printable service will be sent.
4695 If specified in the [global] section, the printer name given will
4697 be used for any printable service that does not have its own
4698 printer name specified.
4699 The default value of the printer name may be lp on many systems.
4701 Default: printer name =
4703 Example: printer name = laserwriter
4705 printing (S)
4707 This parameters controls how printer status information is
4709 interpreted on your system. It also affects the default values for
4710 the print command, lpq command, lppause command , lpresume command,
4711 and lprm command if specified in the [global] section.
4712 Currently nine printing styles are supported. They are BSD, AIX,
4714 LPRNG, PLP, SYSV, HPUX, QNX, SOFTQ, CUPS and IPRINT.
4715 Be aware that CUPS and IPRINT are only available if the CUPS
4717 development library was available at the time Samba was compiled or
4718 packaged.
4719 To see what the defaults are for the other print commands when
4721 using the various options use the testparm(1) program.
4722 This option can be set on a per printer basis. Please be aware
4724 however, that you must place any of the various printing commands
4725 (e.g. print command, lpq command, etc...) after defining the value
4726 for the printing option since it will reset the printing commands
4727 to default values.
4728 See also the discussion in the [printers] section.
4730 See testparm -v. for the default value on your system
4732 Default: printing = # Depends on the operating system
4734 printjob username (S)
4736 This parameter specifies which user information will be passed to
4738 the printing system. Usually, the username is sent, but in some
4739 cases, e.g. the domain prefix is useful, too.
4740 Default: printjob username = %U
4742 Example: printjob username = %D\%U
4744 print notify backchannel (S)
4746 Windows print clients can update print queue status by expecting
4748 the server to open a backchannel SMB connection to them. Due to
4749 client firewall settings this can cause considerable timeouts and
4750 will often fail, as there is no guarantee the client is even
4751 running an SMB server. By default, the Samba print server will not
4752 try to connect back to clients, and will treat corresponding
4753 requests as if the connection back to the client failed.
4754 Default: print notify backchannel = no
4756 queuepause command (S)
4758 This parameter specifies the command to be executed on the server
4760 host in order to pause the printer queue.
4761 This command should be a program or script which takes a printer
4763 name as its only parameter and stops the printer queue, such that
4764 no longer jobs are submitted to the printer.
4765 This command is not supported by Windows for Workgroups, but can be
4767 issued from the Printers window under Windows 95 and NT.
4768 If a %p is given then the printer name is put in its place.
4770 Otherwise it is placed at the end of the command.
4771 Note that it is good practice to include the absolute path in the
4773 command as the PATH may not be available to the server.
4774 Default: queuepause command = # determined by printing parameter
4776 Example: queuepause command = disable %p
4778 queueresume command (S)
4780 This parameter specifies the command to be executed on the server
4782 host in order to resume the printer queue. It is the command to
4783 undo the behavior that is caused by the previous parameter
4784 (queuepause command).
4785 This command should be a program or script which takes a printer
4787 name as its only parameter and resumes the printer queue, such that
4788 queued jobs are resubmitted to the printer.
4789 This command is not supported by Windows for Workgroups, but can be
4791 issued from the Printers window under Windows 95 and NT.
4792 If a %p is given then the printer name is put in its place.
4794 Otherwise it is placed at the end of the command.
4795 Note that it is good practice to include the absolute path in the
4797 command as the PATH may not be available to the server.
4798 Default: queueresume command = # determined by printing parameter
4800 Example: queueresume command = enable %p
4802 show add printer wizard (G)
4804 With the introduction of MS-RPC based printing support for Windows
4806 NT/2000 client in Samba 2.2, a "Printers..." folder will appear on
4807 Samba hosts in the share listing. Normally this folder will contain
4808 an icon for the MS Add Printer Wizard (APW). However, it is
4809 possible to disable this feature regardless of the level of
4810 privilege of the connected user.
4811 Under normal circumstances, the Windows NT/2000 client will open a
4813 handle on the printer server with OpenPrinterEx() asking for
4814 Administrator privileges. If the user does not have administrative
4815 access on the print server (i.e is not root or has granted the
4816 SePrintOperatorPrivilege), the OpenPrinterEx() call fails and the
4817 client makes another open call with a request for a lower privilege
4818 level. This should succeed, however the APW icon will not be
4819 displayed.
4820 Disabling the show add printer wizard parameter will always cause
4822 the OpenPrinterEx() on the server to fail. Thus the APW icon will
4823 never be displayed.
4824 Note
4826 This does not prevent the same user from having administrative
4827 privilege on an individual printer.
4828 Default: show add printer wizard = yes
4829 spoolss: architecture (G)
4831 Windows spoolss print clients only allow association of server-side
4833 drivers with printers when the driver architecture matches the
4834 advertised print server architecture. Samba´s spoolss print server
4835 architecture can be changed using this parameter.
4836 Default: spoolss: architecture = Windows NT x86
4838 Example: spoolss: architecture = Windows x64
4840 spoolss: os_major (G)
4842 Windows might require a new os version number. This option allows
4844 to modify the build number. The complete default version number is:
4845 5.0.2195 (Windows 2000). The example is 6.1.7601 (Windows 2008 R2).
4846 Default: spoolss: os_major = 5
4848 Example: spoolss: os_major = 6
4850 spoolss: os_minor (G)
4852 Windows might require a new os version number. This option allows
4854 to modify the build number. The complete default version number is:
4855 5.0.2195 (Windows 2000). The example is 6.1.7601 (Windows 2008 R2).
4856 Default: spoolss: os_minor = 0
4858 Example: spoolss: os_minor = 1
4860 spoolss: os_build (G)
4862 Windows might require a new os version number. This option allows
4864 to modify the build number. The complete default version number is:
4865 5.0.2195 (Windows 2000). The example is 6.1.7601 (Windows 2008 R2).
4866 Default: spoolss: os_build = 2195
4868 Example: spoolss: os_build = 7601
4870 use client driver (S)
4872 This parameter applies only to Windows NT/2000 clients. It has no
4874 effect on Windows 95/98/ME clients. When serving a printer to
4875 Windows NT/2000 clients without first installing a valid printer
4876 driver on the Samba host, the client will be required to install a
4877 local printer driver. From this point on, the client will treat the
4878 print as a local printer and not a network printer connection. This
4879 is much the same behavior that will occur when disable spoolss =
4880 yes.
4881 The differentiating factor is that under normal circumstances, the
4883 NT/2000 client will attempt to open the network printer using
4884 MS-RPC. The problem is that because the client considers the
4885 printer to be local, it will attempt to issue the OpenPrinterEx()
4886 call requesting access rights associated with the logged on user.
4887 If the user possesses local administrator rights but not root
4888 privilege on the Samba host (often the case), the OpenPrinterEx()
4889 call will fail. The result is that the client will now display an
4890 "Access Denied; Unable to connect" message in the printer queue
4891 window (even though jobs may successfully be printed).
4892 If this parameter is enabled for a printer, then any attempt to
4894 open the printer with the PRINTER_ACCESS_ADMINISTER right is mapped
4895 to PRINTER_ACCESS_USE instead. Thus allowing the OpenPrinterEx()
4896 call to succeed. This parameter MUST not be enabled on a print
4897 share which has valid print driver installed on the Samba server.
4898 Default: use client driver = no
4900 acl allow execute always (S)
4902 This boolean parameter controls the behaviour of smbd(8) when
4904 receiving a protocol request of "open for execution" from a Windows
4905 client. With Samba 3.6 and older, the execution right in the ACL
4906 was not checked, so a client could execute a file even if it did
4907 not have execute rights on the file. In Samba 4.0, this has been
4908 fixed, so that by default, i.e. when this parameter is set to
4909 "False", "open for execution" is now denied when execution
4910 permissions are not present.
4911 If this parameter is set to "True", Samba does not check execute
4913 permissions on "open for execution", thus re-establishing the
4914 behaviour of Samba 3.6. This can be useful to smoothen upgrades
4915 from older Samba versions to 4.0 and newer. This setting is not
4916 meant to be used as a permanent setting, but as a temporary relief:
4917 It is recommended to fix the permissions in the ACLs and reset this
4918 parameter to the default after a certain transition period.
4919 Default: acl allow execute always = no
4921 acl check permissions (S)
4923 Please note this parameter is now deprecated in Samba 3.6.2 and
4925 will be removed in a future version of Samba.
4926 This boolean parameter controls what smbd(8) does on receiving a
4928 protocol request of "open for delete" from a Windows client. If a
4929 Windows client doesn´t have permissions to delete a file then they
4930 expect this to be denied at open time. POSIX systems normally only
4931 detect restrictions on delete by actually attempting to delete the
4932 file or directory. As Windows clients can (and do) "back out" a
4933 delete request by unsetting the "delete on close" bit Samba cannot
4934 delete the file immediately on "open for delete" request as we
4935 cannot restore such a deleted file. With this parameter set to true
4936 (the default) then smbd checks the file system permissions directly
4937 on "open for delete" and denies the request without actually
4938 deleting the file if the file system permissions would seem to deny
4939 it. This is not perfect, as it´s possible a user could have deleted
4940 a file without Samba being able to check the permissions correctly,
4941 but it is close enough to Windows semantics for mostly correct
4942 behaviour. Samba will correctly check POSIX ACL semantics in this
4943 case.
4944 If this parameter is set to "false" Samba doesn´t check permissions
4946 on "open for delete" and allows the open. If the user doesn´t have
4947 permission to delete the file this will only be discovered at close
4948 time, which is too late for the Windows user tools to display an
4949 error message to the user. The symptom of this is files that appear
4950 to have been deleted "magically" re-appearing on a Windows explorer
4951 refresh. This is an extremely advanced protocol option which should
4952 not need to be changed. This parameter was introduced in its final
4953 form in 3.0.21, an earlier version with slightly different
4954 semantics was introduced in 3.0.20. That older version is not
4955 documented here.
4956 Default: acl check permissions = yes
4958 acl map full control (S)
4960 This boolean parameter controls whether smbd(8) maps a POSIX ACE
4962 entry of "rwx" (read/write/execute), the maximum allowed POSIX
4963 permission set, into a Windows ACL of "FULL CONTROL". If this
4964 parameter is set to true any POSIX ACE entry of "rwx" will be
4965 returned in a Windows ACL as "FULL CONTROL", is this parameter is
4966 set to false any POSIX ACE entry of "rwx" will be returned as the
4967 specific Windows ACL bits representing read, write and execute.
4968 Default: acl map full control = yes
4970 cldap port (G)
4972 This option controls the port used by the CLDAP protocol.
4974 Default: cldap port = 389
4976 Example: cldap port = 3389
4978 client ipc max protocol (G)
4980 The value of the parameter (a string) is the highest protocol level
4982 that will be supported for IPC$ connections as DCERPC transport.
4983 Normally this option should not be set as the automatic negotiation
4985 phase in the SMB protocol takes care of choosing the appropriate
4986 protocol.
4987 The value default refers to the latest supported protocol,
4989 currently SMB3_11.
4990 See client max protocol for a full list of available protocols. The
4992 values CORE, COREPLUS, LANMAN1, LANMAN2 are silently upgraded to
4993 NT1.
4994 Default: client ipc max protocol = default
4996 Example: client ipc max protocol = SMB2_10
4998 client ipc min protocol (G)
5000 This setting controls the minimum protocol version that the will be
5002 attempted to use for IPC$ connections as DCERPC transport.
5003 Normally this option should not be set as the automatic negotiation
5005 phase in the SMB protocol takes care of choosing the appropriate
5006 protocol.
5007 The value default refers to the higher value of NT1 and the
5009 effective value of client min protocol.
5010 See client max protocol for a full list of available protocols. The
5012 values CORE, COREPLUS, LANMAN1, LANMAN2 are silently upgraded to
5013 NT1.
5014 Default: client ipc min protocol = default
5016 Example: client ipc min protocol = SMB3_11
5018 client max protocol (G)
5020 The value of the parameter (a string) is the highest protocol level
5022 that will be supported by the client.
5023 Possible values are :
5025 · CORE: Earliest version. No concept of user names.
5027 · COREPLUS: Slight improvements on CORE for efficiency.
5029 · LANMAN1: First modern version of the protocol. Long filename
5031 support.
5032 · LANMAN2: Updates to Lanman1 protocol.
5034 · NT1: Current up to date version of the protocol. Used by
5036 Windows NT. Known as CIFS.
5037 · SMB2: Re-implementation of the SMB protocol. Used by Windows
5039 Vista and later versions of Windows. SMB2 has sub protocols
5040 available.
5041 · SMB2_02: The earliest SMB2 version.
5043 · SMB2_10: Windows 7 SMB2 version.
5045 · SMB2_22: Early Windows 8 SMB2 version.
5047 · SMB2_24: Windows 8 beta SMB2 version.
5049 By default SMB2 selects the SMB2_10 variant.
5051 · SMB3: The same as SMB2. Used by Windows 8. SMB3 has sub protocols
5053 available.
5054 · SMB3_00: Windows 8 SMB3 version. (mostly the same as SMB2_24)
5056 · SMB3_02: Windows 8.1 SMB3 version.
5058 By default SMB3 selects the SMB3_00 variant.
5060 Normally this option should not be set as the automatic negotiation
5062 phase in the SMB protocol takes care of choosing the appropriate
5063 protocol.
5064 The value default refers to NT1.
5066 IPC$ connections for DCERPC e.g. in winbindd, are handled by the client
5068 ipc max protocol option.
5069 Default: client max protocol = default
5071 Example: client max protocol = LANMAN1
5073 client min protocol (G)
5075 This setting controls the minimum protocol version that the client
5077 will attempt to use.
5078 Normally this option should not be set as the automatic negotiation
5080 phase in the SMB protocol takes care of choosing the appropriate
5081 protocol.
5082 See Related command: client max protocol for a full list of
5084 available protocols.
5085 IPC$ connections for DCERPC e.g. in winbindd, are handled by the
5087 client ipc min protocol option.
5088 Default: client min protocol = CORE
5090 Example: client min protocol = NT1
5092 client use spnego (G)
5094 This variable controls whether Samba clients will try to use Simple
5096 and Protected NEGOciation (as specified by rfc2478) with supporting
5097 servers (including WindowsXP, Windows2000 and Samba 3.0) to agree
5098 upon an authentication mechanism. This enables Kerberos
5099 authentication in particular.
5100 When client NTLMv2 auth is also set to yes extended security
5102 (SPNEGO) is required in order to use NTLMv2 only within NTLMSSP.
5103 This behavior was introduced with the patches for CVE-2016-2111.
5104 Default: client use spnego = yes
5106 dcerpc endpoint servers (G)
5108 Specifies which DCE/RPC endpoint servers should be run.
5110 Default: dcerpc endpoint servers = epmapper, wkssvc, rpcecho, samr,
5112 netlogon, lsarpc, spoolss, drsuapi, dssetup, unixinfo, browser,
5113 eventlog6, backupkey, dnsserver
5114 Example: dcerpc endpoint servers = rpcecho
5116 defer sharing violations (G)
5118 Windows allows specifying how a file will be shared with other
5120 processes when it is opened. Sharing violations occur when a file
5121 is opened by a different process using options that violate the
5122 share settings specified by other processes. This parameter causes
5123 smbd to act as a Windows server does, and defer returning a
5124 "sharing violation" error message for up to one second, allowing
5125 the client to close the file causing the violation in the meantime.
5126 UNIX by default does not have this behaviour.
5128 There should be no reason to turn off this parameter, as it is
5130 designed to enable Samba to more correctly emulate Windows.
5131 Default: defer sharing violations = yes
5133 dgram port (G)
5135 Specifies which ports the server should listen on for NetBIOS
5137 datagram traffic.
5138 Default: dgram port = 138
5140 disable netbios (G)
5142 Enabling this parameter will disable netbios support in Samba.
5144 Netbios is the only available form of browsing in all windows
5145 versions except for 2000 and XP.
5146 Note
5148 Clients that only support netbios won´t be able to see your
5149 samba server when netbios support is disabled.
5150 Default: disable netbios = no
5151 durable handles (S)
5153 This boolean parameter controls whether Samba can grant SMB2
5155 durable file handles on a share.
5156 Note that durable handles are only enabled if kernel oplocks = no,
5158 kernel share modes = no, and posix locking = no, i.e. if the share
5159 is configured for CIFS/SMB2 only access, not supporting
5160 interoperability features with local UNIX processes or NFS
5161 operations.
5162 Also note that, for the time being, durability is not granted for a
5164 handle that has the delete on close flag set.
5165 Default: durable handles = yes
5167 ea support (S)
5169 This boolean parameter controls whether smbd(8) will allow clients
5171 to attempt to store OS/2 style Extended attributes on a share. In
5172 order to enable this parameter the underlying filesystem exported
5173 by the share must support extended attributes (such as provided on
5174 XFS and EXT3 on Linux, with the correct kernel patches). On Linux
5175 the filesystem must have been mounted with the mount option
5176 user_xattr in order for extended attributes to work, also extended
5177 attributes must be compiled into the Linux kernel.
5178 Default: ea support = no
5180 enable asu support (G)
5182 Hosts running the "Advanced Server for Unix (ASU)" product require
5184 some special accomodations such as creating a builtin [ADMIN$]
5185 share that only supports IPC connections. The has been the default
5186 behavior in smbd for many years. However, certain Microsoft
5187 applications such as the Print Migrator tool require that the
5188 remote server support an [ADMIN$] file share. Disabling this
5189 parameter allows for creating an [ADMIN$] file share in smb.conf.
5190 Default: enable asu support = no
5192 eventlog list (G)
5194 This option defines a list of log names that Samba will report to
5196 the Microsoft EventViewer utility. The listed eventlogs will be
5197 associated with tdb file on disk in the $(statedir)/eventlog.
5198 The administrator must use an external process to parse the normal
5200 Unix logs such as /var/log/messages and write then entries to the
5201 eventlog tdb files. Refer to the eventlogadm(8) utility for how to
5202 write eventlog entries.
5203 Default: eventlog list =
5205 Example: eventlog list = Security Application Syslog Apache
5207 large readwrite (G)
5209 This parameter determines whether or not smbd(8) supports the new
5211 64k streaming read and write variant SMB requests introduced with
5212 Windows 2000. Note that due to Windows 2000 client redirector bugs
5213 this requires Samba to be running on a 64-bit capable operating
5214 system such as IRIX, Solaris or a Linux 2.4 kernel. Can improve
5215 performance by 10% with Windows 2000 clients. Defaults to on. Not
5216 as tested as some other Samba code paths.
5217 Default: large readwrite = yes
5219 map acl inherit (S)
5221 This boolean parameter controls whether smbd(8) will attempt to map
5223 the ´inherit´ and ´protected´ access control entry flags stored in
5224 Windows ACLs into an extended attribute called user.SAMBA_PAI. This
5225 parameter only takes effect if Samba is being run on a platform
5226 that supports extended attributes (Linux and IRIX so far) and
5227 allows the Windows 2000 ACL editor to correctly use inheritance
5228 with the Samba POSIX ACL mapping code.
5229 Default: map acl inherit = no
5231 max mux (G)
5233 This option controls the maximum number of outstanding simultaneous
5235 SMB operations that Samba tells the client it will allow. You
5236 should never need to set this parameter.
5237 Default: max mux = 50
5239 max ttl (G)
5241 This option tells nmbd(8) what the default ´time to live´ of
5243 NetBIOS names should be (in seconds) when nmbd is requesting a name
5244 using either a broadcast packet or from a WINS server. You should
5245 never need to change this parameter. The default is 3 days.
5246 Default: max ttl = 259200
5248 max wins ttl (G)
5250 This option tells smbd(8) when acting as a WINS server (wins
5252 support = yes) what the maximum ´time to live´ of NetBIOS names
5253 that nmbd will grant will be (in seconds). You should never need to
5254 change this parameter. The default is 6 days (518400 seconds).
5255 Default: max wins ttl = 518400
5257 max xmit (G)
5259 This option controls the maximum packet size that will be
5261 negotiated by Samba. The default is 16644, which matches the
5262 behavior of Windows 2000. A value below 2048 is likely to cause
5263 problems. You should never need to change this parameter from its
5264 default value.
5265 Default: max xmit = 16644
5267 Example: max xmit = 8192
5269 min receivefile size (G)
5271 This option changes the behavior of smbd(8) when processing
5273 SMBwriteX calls. Any incoming SMBwriteX call on a non-signed
5274 SMB/CIFS connection greater than this value will not be processed
5275 in the normal way but will be passed to any underlying kernel
5276 recvfile or splice system call (if there is no such call Samba will
5277 emulate in user space). This allows zero-copy writes directly from
5278 network socket buffers into the filesystem buffer cache, if
5279 available. It may improve performance but user testing is
5280 recommended. If set to zero Samba processes SMBwriteX calls in the
5281 normal way. To enable POSIX large write support (SMB/CIFS writes up
5282 to 16Mb) this option must be nonzero. The maximum value is 128k.
5283 Values greater than 128k will be silently set to 128k.
5284 Note this option will have NO EFFECT if set on a SMB signed
5286 connection.
5287 The default is zero, which disables this option.
5289 Default: min receivefile size = 0
5291 min wins ttl (G)
5293 This option tells nmbd(8) when acting as a WINS server (wins
5295 support = yes) what the minimum ´time to live´ of NetBIOS names
5296 that nmbd will grant will be (in seconds). You should never need to
5297 change this parameter. The default is 6 hours (21600 seconds).
5298 Default: min wins ttl = 21600
5300 name resolve order (G)
5302 This option is used by the programs in the Samba suite to determine
5304 what naming services to use and in what order to resolve host names
5305 to IP addresses. Its main purpose to is to control how netbios name
5306 resolution is performed. The option takes a space separated string
5307 of name resolution options.
5308 The options are: "lmhosts", "host", "wins" and "bcast". They cause
5310 names to be resolved as follows:
5311 · lmhosts : Lookup an IP address in the Samba lmhosts file. If
5313 the line in lmhosts has no name type attached to the NetBIOS
5314 name (see the manpage for lmhosts for details) then any name
5315 type matches for lookup.
5316 · host : Do a standard host name to IP address resolution, using
5318 the system /etc/hosts, NIS, or DNS lookups. This method of name
5319 resolution is operating system depended for instance on IRIX or
5320 Solaris this may be controlled by the /etc/nsswitch.conf file.
5321 Note that this method is used only if the NetBIOS name type
5322 being queried is the 0x20 (server) name type or 0x1c (domain
5323 controllers). The latter case is only useful for active
5324 directory domains and results in a DNS query for the SRV RR
5325 entry matching _ldap._tcp.domain.
5326 · wins : Query a name with the IP address listed in the
5328 WINSSERVER parameter. If no WINS server has been specified this
5329 method will be ignored.
5330 · bcast : Do a broadcast on each of the known local interfaces
5332 listed in the interfaces parameter. This is the least reliable
5333 of the name resolution methods as it depends on the target host
5334 being on a locally connected subnet.
5335 The example below will cause the local lmhosts file to be examined
5337 first, followed by a broadcast attempt, followed by a normal system
5338 hostname lookup.
5339 When Samba is functioning in ADS security mode (security = ads) it is
5341 advised to use following settings for name resolve order:
5342 name resolve order = wins bcast
5344 DC lookups will still be done via DNS, but fallbacks to netbios names
5346 will not inundate your DNS servers with needless querys for
5347 DOMAIN<0x1c> lookups.
5348 Default: name resolve order = lmhosts wins host bcast
5350 Example: name resolve order = lmhosts bcast host
5352 nbt port (G)
5354 Specifies which port the server should use for NetBIOS over IP name
5356 services traffic.
5357 Default: nbt port = 137
5359 nt acl support (S)
5361 This boolean parameter controls whether smbd(8) will attempt to map
5363 UNIX permissions into Windows NT access control lists. The UNIX
5364 permissions considered are the traditional UNIX owner and group
5365 permissions, as well as POSIX ACLs set on any files or directories.
5366 This parameter was formally a global parameter in releases prior to
5367 2.2.2.
5368 Default: nt acl support = yes
5370 nt pipe support (G)
5372 This boolean parameter controls whether smbd(8) will allow Windows
5374 NT clients to connect to the NT SMB specific IPC$ pipes. This is a
5375 developer debugging option and can be left alone.
5376 Default: nt pipe support = yes
5378 nt status support (G)
5380 This boolean parameter controls whether smbd(8) will negotiate NT
5382 specific status support with Windows NT/2k/XP clients. This is a
5383 developer debugging option and should be left alone. If this option
5384 is set to no then Samba offers exactly the same DOS error codes
5385 that versions prior to Samba 2.2.3 reported.
5386 You should not need to ever disable this parameter.
5388 Default: nt status support = yes
5390 profile acls (S)
5392 This boolean parameter was added to fix the problems that people
5394 have been having with storing user profiles on Samba shares from
5395 Windows 2000 or Windows XP clients. New versions of Windows 2000 or
5396 Windows XP service packs do security ACL checking on the owner and
5397 ability to write of the profile directory stored on a local
5398 workstation when copied from a Samba share.
5399 When not in domain mode with winbindd then the security info copied
5401 onto the local workstation has no meaning to the logged in user
5402 (SID) on that workstation so the profile storing fails. Adding this
5403 parameter onto a share used for profile storage changes two things
5404 about the returned Windows ACL. Firstly it changes the owner and
5405 group owner of all reported files and directories to be
5406 BUILTIN\\Administrators, BUILTIN\\Users respectively (SIDs
5407 S-1-5-32-544, S-1-5-32-545). Secondly it adds an ACE entry of "Full
5408 Control" to the SID BUILTIN\\Users to every returned ACL. This will
5409 allow any Windows 2000 or XP workstation user to access the
5410 profile.
5411 Note that if you have multiple users logging on to a workstation
5413 then in order to prevent them from being able to access each others
5414 profiles you must remove the "Bypass traverse checking" advanced
5415 user right. This will prevent access to other users profile
5416 directories as the top level profile directory (named after the
5417 user) is created by the workstation profile code and has an ACL
5418 restricting entry to the directory tree to the owning user.
5419 Note that this parameter should be set to yes on dedicated profile
5421 shares only. On other shares, it might cause incorrect file
5422 ownerships.
5423 Default: profile acls = no
5425 read raw (G)
5427 This is ignored if async echo handler is set, because this feature
5429 is incompatible with raw read SMB requests
5430 If enabled, raw reads allow reads of 65535 bytes in one packet.
5432 This typically provides a major performance benefit for some very,
5433 very old clients.
5434 However, some clients either negotiate the allowable block size
5436 incorrectly or are incapable of supporting larger block sizes, and
5437 for these clients you may need to disable raw reads.
5438 In general this parameter should be viewed as a system tuning tool
5440 and left severely alone.
5441 Default: read raw = yes
5443 rpc big endian (G)
5445 Setting this option will force the RPC client and server to
5447 transfer data in big endian.
5448 If it is disabled, data will be transferred in little endian.
5450 The behaviour is independent of the endianness of the host machine.
5452 Default: rpc big endian = no
5454 max protocol
5456 This parameter is a synonym for server max protocol.
5458 protocol
5460 This parameter is a synonym for server max protocol.
5462 server max protocol (G)
5464 The value of the parameter (a string) is the highest protocol level
5466 that will be supported by the server.
5467 Possible values are :
5469 · LANMAN1: First modern version of the protocol. Long filename
5471 support.
5472 · LANMAN2: Updates to Lanman1 protocol.
5474 · NT1: Current up to date version of the protocol. Used by
5476 Windows NT. Known as CIFS.
5477 · SMB2: Re-implementation of the SMB protocol. Used by Windows
5479 Vista and later versions of Windows. SMB2 has sub protocols
5480 available.
5481 · SMB2_02: The earliest SMB2 version.
5483 · SMB2_10: Windows 7 SMB2 version.
5485 · SMB2_22: Early Windows 8 SMB2 version.
5487 · SMB2_24: Windows 8 beta SMB2 version.
5489 By default SMB2 selects the SMB2_10 variant.
5491 · SMB3: The same as SMB2. Used by Windows 8. SMB3 has sub protocols
5493 available.
5494 · SMB3_00: Windows 8 SMB3 version. (mostly the same as SMB2_24)
5496 By default SMB3 selects the SMB3_00 variant.
5498 Normally this option should not be set as the automatic negotiation
5500 phase in the SMB protocol takes care of choosing the appropriate
5501 protocol.
5502 Default: server max protocol = SMB3
5504 Example: server max protocol = LANMAN1
5506 min protocol
5508 This parameter is a synonym for server min protocol.
5510 server min protocol (G)
5512 This setting controls the minimum protocol version that the server
5514 will allow the client to use.
5515 Normally this option should not be set as the automatic negotiation
5517 phase in the SMB protocol takes care of choosing the appropriate
5518 protocol.
5519 See Related command: server max protocol for a full list of
5521 available protocols.
5522 Default: server min protocol = LANMAN1
5524 Example: server min protocol = NT1
5526 share:fake_fscaps (G)
5528 This is needed to support some special application that makes
5530 QFSINFO calls to check whether we set the SPARSE_FILES bit (0x40).
5531 If this bit is not set that particular application refuses to work
5532 against Samba. With share:fake_fscaps = 64 the SPARSE_FILES file
5533 system capability flag is set. Use other decimal values to specify
5534 the bitmask you need to fake.
5535 Default: share:fake_fscaps = 0
5537 smb2 max credits (G)
5539 This option controls the maximum number of outstanding simultaneous
5541 SMB2 operations that Samba tells the client it will allow. This is
5542 similar to the max mux parameter for SMB1. You should never need to
5543 set this parameter.
5544 The default is 8192 credits, which is the same as a Windows 2008R2
5546 SMB2 server.
5547 Default: smb2 max credits = 8192
5549 smb2 max read (G)
5551 This option specifies the protocol value that smbd(8) will return
5553 to a client, informing the client of the largest size that may be
5554 returned by a single SMB2 read call.
5555 The maximum is 8388608 bytes (8MiB), which is the same as a Windows
5557 Server 2012 r2.
5558 Please note that the default is 8MiB, but it´s limit is based on
5560 the smb2 dialect (64KiB for SMB == 2.0, 8MiB for SMB >= 2.1 with
5561 LargeMTU). Large MTU is not supported over NBT (tcp port 139).
5562 Default: smb2 max read = 8388608
5564 smb2 max trans (G)
5566 This option specifies the protocol value that smbd(8) will return
5568 to a client, informing the client of the largest size of buffer
5569 that may be used in querying file meta-data via QUERY_INFO and
5570 related SMB2 calls.
5571 The maximum is 8388608 bytes (8MiB), which is the same as a Windows
5573 Server 2012 r2.
5574 Please note that the default is 8MiB, but it´s limit is based on
5576 the smb2 dialect (64KiB for SMB == 2.0, 1MiB for SMB >= 2.1 with
5577 LargeMTU). Large MTU is not supported over NBT (tcp port 139).
5578 Default: smb2 max trans = 8388608
5580 smb2 max write (G)
5582 This option specifies the protocol value that smbd(8) will return
5584 to a client, informing the client of the largest size that may be
5585 sent to the server by a single SMB2 write call.
5586 The maximum is 8388608 bytes (8MiB), which is the same as a Windows
5588 Server 2012 r2.
5589 Please note that the default is 8MiB, but it´s limit is based on
5591 the smb2 dialect (64KiB for SMB == 2.0, 8MiB for SMB => 2.1 with
5592 LargeMTU). Large MTU is not supported over NBT (tcp port 139).
5593 Default: smb2 max write = 8388608
5595 smb ports (G)
5597 Specifies which ports the server should listen on for SMB traffic.
5599 Default: smb ports = 445 139
5601 svcctl list (G)
5603 This option defines a list of init scripts that smbd will use for
5605 starting and stopping Unix services via the Win32 ServiceControl
5606 API. This allows Windows administrators to utilize the MS
5607 Management Console plug-ins to manage a Unix server running Samba.
5608 The administrator must create a directory name svcctl in Samba´s
5610 $(libdir) and create symbolic links to the init scripts in
5611 /etc/init.d/. The name of the links must match the names given as
5612 part of the svcctl list.
5613 Default: svcctl list =
5615 Example: svcctl list = cups postfix portmap httpd
5617 time server (G)
5619 This parameter determines if nmbd(8) advertises itself as a time
5621 server to Windows clients.
5622 Default: time server = no
5624 unicode (G)
5626 Specifies whether the server and client should support unicode.
5628 If this option is set to false, the use of ASCII will be forced.
5630 Default: unicode = yes
5632 unix extensions (G)
5634 This boolean parameter controls whether Samba implements the CIFS
5636 UNIX extensions, as defined by HP. These extensions enable Samba to
5637 better serve UNIX CIFS clients by supporting features such as
5638 symbolic links, hard links, etc... These extensions require a
5639 similarly enabled client, and are of no current use to Windows
5640 clients.
5641 Note if this parameter is turned on, the wide links parameter will
5643 automatically be disabled.
5644 See the parameter allow insecure wide links if you wish to change
5646 this coupling between the two parameters.
5647 Default: unix extensions = yes
5649 use spnego (G)
5651 This deprecated variable controls whether samba will try to use
5653 Simple and Protected NEGOciation (as specified by rfc2478) with
5654 WindowsXP and Windows2000 clients to agree upon an authentication
5655 mechanism.
5656 Unless further issues are discovered with our SPNEGO
5658 implementation, there is no reason this should ever be disabled.
5659 Default: use spnego = yes
5661 web port (G)
5663 Specifies which port the Samba web server should listen on.
5665 Default: web port = 901
5667 Example: web port = 80
5669 write raw (G)
5671 This is ignored if async echo handler is set, because this feature
5673 is incompatible with raw write SMB requests
5674 If enabled, raw writes allow writes of 65535 bytes in one packet.
5676 This typically provides a major performance benefit for some very,
5677 very old clients.
5678 However, some clients either negotiate the allowable block size
5680 incorrectly or are incapable of supporting larger block sizes, and
5681 for these clients you may need to disable raw writes.
5682 In general this parameter should be viewed as a system tuning tool
5684 and left severely alone.
5685 Default: write raw = yes
5687 access based share enum (S)
5689 If this parameter is yes for a service, then the share hosted by
5691 the service will only be visible to users who have read or write
5692 access to the share during share enumeration (for example net view
5693 \\sambaserver). The share ACLs which allow or deny the access to
5694 the share can be modified using for example the sharesec command or
5695 using the appropriate Windows tools. This has parallels to access
5696 based enumeration, the main difference being that only share
5697 permissions are evaluated, and security descriptors on files
5698 contained on the share are not used in computing enumeration access
5699 rights.
5700 Default: access based share enum = no
5702 acl group control (S)
5704 In a POSIX filesystem, only the owner of a file or directory and
5706 the superuser can modify the permissions and ACLs on a file. If
5707 this parameter is set, then Samba overrides this restriction, and
5708 also allows the primary group owner of a file or directory to
5709 modify the permissions and ACLs on that file.
5710 On a Windows server, groups may be the owner of a file or directory
5712 - thus allowing anyone in that group to modify the permissions on
5713 it. This allows the delegation of security controls on a point in
5714 the filesystem to the group owner of a directory and anything below
5715 it also owned by that group. This means there are multiple people
5716 with permissions to modify ACLs on a file or directory, easing
5717 manageability.
5718 This parameter allows Samba to also permit delegation of the
5720 control over a point in the exported directory hierarchy in much
5721 the same way as Windows. This allows all members of a UNIX group to
5722 control the permissions on a file or directory they have group
5723 ownership on.
5724 This parameter is best used with the inherit owner option and also
5726 on a share containing directories with the UNIX setgid bit set on
5727 them, which causes new files and directories created within it to
5728 inherit the group ownership from the containing directory.
5729 This parameter was deprecated in Samba 3.0.23, but re-activated in
5731 Samba 3.0.31 and above, as it now only controls permission changes
5732 if the user is in the owning primary group. It is now no longer
5733 equivalent to the dos filemode option.
5734 Default: acl group control = no
5736 admin users (S)
5738 This is a list of users who will be granted administrative
5740 privileges on the share. This means that they will do all file
5741 operations as the super-user (root).
5742 You should use this option very carefully, as any user in this list
5744 will be able to do anything they like on the share, irrespective of
5745 file permissions.
5746 Default: admin users =
5748 Example: admin users = jason
5750 algorithmic rid base (G)
5752 This determines how Samba will use its algorithmic mapping from
5754 uids/gid to the RIDs needed to construct NT Security Identifiers.
5755 Setting this option to a larger value could be useful to sites
5757 transitioning from WinNT and Win2k, as existing user and group rids
5758 would otherwise clash with system users etc.
5759 All UIDs and GIDs must be able to be resolved into SIDs for the
5761 correct operation of ACLs on the server. As such the algorithmic
5762 mapping can´t be ´turned off´, but pushing it ´out of the way´
5763 should resolve the issues. Users and groups can then be assigned
5764 ´low´ RIDs in arbitrary-rid supporting backends.
5765 Default: algorithmic rid base = 1000
5767 Example: algorithmic rid base = 100000
5769 allow dcerpc auth level connect (G)
5771 This option controls whether DCERPC services are allowed to be used
5773 with DCERPC_AUTH_LEVEL_CONNECT, which provides authentication, but
5774 no per message integrity nor privacy protection.
5775 Some interfaces like samr, lsarpc and netlogon have a hard-coded
5777 default of no and epmapper, mgmt and rpcecho have a hard-coded
5778 default of yes.
5779 The behavior can be overwritten per interface name (e.g. lsarpc,
5781 netlogon, samr, srvsvc, winreg, wkssvc ...) by using ´allow dcerpc
5782 auth level connect:interface = yes´ as option.
5783 This option yields precedence to the implementation specific
5785 restrictions. E.g. the drsuapi and backupkey protocols require
5786 DCERPC_AUTH_LEVEL_PRIVACY. The dnsserver protocol requires
5787 DCERPC_AUTH_LEVEL_INTEGRITY.
5788 Default: allow dcerpc auth level connect = no
5790 Example: allow dcerpc auth level connect = yes
5792 allow trusted domains (G)
5794 This option only takes effect when the security option is set to
5796 server, domain or ads. If it is set to no, then attempts to connect
5797 to a resource from a domain or workgroup other than the one which
5798 smbd is running in will fail, even if that domain is trusted by the
5799 remote server doing the authentication.
5800 This is useful if you only want your Samba server to serve
5802 resources to users in the domain it is a member of. As an example,
5803 suppose that there are two domains DOMA and DOMB. DOMB is trusted
5804 by DOMA, which contains the Samba server. Under normal
5805 circumstances, a user with an account in DOMB can then access the
5806 resources of a UNIX account with the same account name on the Samba
5807 server even if they do not have an account in DOMA. This can make
5808 implementing a security boundary difficult.
5809 Default: allow trusted domains = yes
5811 auth methods (G)
5813 This option allows the administrator to chose what authentication
5815 methods smbd will use when authenticating a user. This option
5816 defaults to sensible values based on security. This should be
5817 considered a developer option and used only in rare circumstances.
5818 In the majority (if not all) of production servers, the default
5819 setting should be adequate.
5820 Each entry in the list attempts to authenticate the user in turn,
5822 until the user authenticates. In practice only one method will ever
5823 actually be able to complete the authentication.
5824 Possible options include guest (anonymous access), sam (lookups in
5826 local list of accounts based on netbios name or domain name),
5827 winbind (relay authentication requests for remote users through
5828 winbindd), ntdomain (pre-winbindd method of authentication for
5829 remote domain users; deprecated in favour of winbind method),
5830 trustdomain (authenticate trusted users by contacting the remote DC
5831 directly from smbd; deprecated in favour of winbind method).
5832 Default: auth methods =
5834 Example: auth methods = guest sam winbind
5836 check password script (G)
5838 The name of a program that can be used to check password
5840 complexity. The password is sent to the program´s standard input.
5841 The program must return 0 on a good password, or any other value if
5843 the password is bad. In case the password is considered weak (the
5844 program does not return 0) the user will be notified and the
5845 password change will fail.
5846 Note: In the example directory is a sample program called
5848 crackcheck that uses cracklib to check the password quality.
5849 Default: check password script = # Disabled
5851 Example: check password script = /usr/local/sbin/crackcheck
5853 client ipc signing (G)
5855 This controls whether the client is allowed or required to use SMB
5857 signing for IPC$ connections as DCERPC transport. Possible values
5858 are auto, mandatory and disabled.
5859 When set to mandatory or default, SMB signing is required.
5861 When set to auto, SMB signing is offered, but not enforced and if
5863 set to disabled, SMB signing is not offered either.
5864 Connections from winbindd to Active Directory Domain Controllers
5866 always enforce signing.
5867 Default: client ipc signing = default
5869 client lanman auth (G)
5871 This parameter determines whether or not smbclient(8) and other
5873 samba client tools will attempt to authenticate itself to servers
5874 using the weaker LANMAN password hash. If disabled, only server
5875 which support NT password hashes (e.g. Windows NT/2000, Samba,
5876 etc... but not Windows 95/98) will be able to be connected from the
5877 Samba client.
5878 The LANMAN encrypted response is easily broken, due to its
5880 case-insensitive nature, and the choice of algorithm. Clients
5881 without Windows 95/98 servers are advised to disable this option.
5882 Disabling this option will also disable the client plaintext auth
5884 option.
5885 Likewise, if the client ntlmv2 auth parameter is enabled, then only
5887 NTLMv2 logins will be attempted.
5888 Default: client lanman auth = no
5890 client NTLMv2 auth (G)
5892 This parameter determines whether or not smbclient(8) will attempt
5894 to authenticate itself to servers using the NTLMv2 encrypted
5895 password response.
5896 If enabled, only an NTLMv2 and LMv2 response (both much more secure
5898 than earlier versions) will be sent. Older servers (including NT4 <
5899 SP4, Win9x and Samba 2.2) are not compatible with NTLMv2 when not
5900 in an NTLMv2 supporting domain
5901 Similarly, if enabled, NTLMv1, client lanman auth and client
5903 plaintext auth authentication will be disabled. This also disables
5904 share-level authentication.
5905 If disabled, an NTLM response (and possibly a LANMAN response) will
5907 be sent by the client, depending on the value of client lanman
5908 auth.
5909 Note that Windows Vista and later versions already use NTLMv2 by
5911 default, and some sites (particularly those following ´best
5912 practice´ security polices) only allow NTLMv2 responses, and not
5913 the weaker LM or NTLM.
5914 When client use spnego is also set to yes extended security
5916 (SPNEGO) is required in order to use NTLMv2 only within NTLMSSP.
5917 This behavior was introduced with the patches for CVE-2016-2111.
5918 Default: client NTLMv2 auth = yes
5920 client plaintext auth (G)
5922 Specifies whether a client should send a plaintext password if the
5924 server does not support encrypted passwords.
5925 Default: client plaintext auth = no
5927 client schannel (G)
5929 This controls whether the client offers or even demands the use of
5931 the netlogon schannel. client schannel = no does not offer the
5932 schannel, client schannel = auto offers the schannel but does not
5933 enforce it, and client schannel = yes denies access if the server
5934 is not able to speak netlogon schannel.
5935 Note that for active directory domains this is hardcoded to client
5937 schannel = yes.
5938 This option yields precedence to the require strong key option.
5940 Default: client schannel = auto
5942 Example: client schannel = yes
5944 client signing (G)
5946 This controls whether the client is allowed or required to use SMB
5948 signing. Possible values are auto, mandatory and disabled.
5949 When set to auto or default, SMB signing is offered, but not
5951 enforced.
5952 When set to mandatory, SMB signing is required and if set to
5954 disabled, SMB signing is not offered either.
5955 IPC$ connections for DCERPC e.g. in winbindd, are handled by the
5957 client ipc signing option.
5958 Default: client signing = default
5960 client use spnego principal (G)
5962 This parameter determines whether or not smbclient(8) and other
5964 samba components acting as a client will attempt to use the
5965 server-supplied principal sometimes given in the SPNEGO exchange.
5966 If enabled, Samba can attempt to use Kerberos to contact servers
5968 known only by IP address. Kerberos relies on names, so ordinarily
5969 cannot function in this situation.
5970 This is a VERY BAD IDEA for security reasons, and so this parameter
5972 SHOULD NOT BE USED. It will be removed in a future version of
5973 Samba.
5974 If disabled, Samba will use the name used to look up the server
5976 when asking the KDC for a ticket. This avoids situations where a
5977 server may impersonate another, soliciting authentication as one
5978 principal while being known on the network as another.
5979 Note that Windows XP SP2 and later versions already follow this
5981 behaviour, and Windows Vista and later servers no longer supply
5982 this ´rfc4178 hint´ principal on the server side.
5983 This parameter is deprecated in Samba 4.2.1 and will be removed
5985 (along with the functionality) in a later release of Samba.
5986 Default: client use spnego principal = no
5988 create mode
5990 This parameter is a synonym for create mask.
5992 create mask (S)
5994 When a file is created, the necessary permissions are calculated
5996 according to the mapping from DOS modes to UNIX permissions, and
5997 the resulting UNIX mode is then bit-wise ´AND´ed with this
5998 parameter. This parameter may be thought of as a bit-wise MASK for
5999 the UNIX modes of a file. Any bit not set here will be removed from
6000 the modes set on a file when it is created.
6001 The default value of this parameter removes the group and other
6003 write and execute bits from the UNIX modes.
6004 Following this Samba will bit-wise ´OR´ the UNIX mode created from
6006 this parameter with the value of the force create mode parameter
6007 which is set to 000 by default.
6008 This parameter does not affect directory masks. See the parameter
6010 directory mask for details.
6011 Default: create mask = 0744
6013 Example: create mask = 0775
6015 dedicated keytab file (G)
6017 Specifies the path to the kerberos keytab file when kerberos method
6019 is set to "dedicated keytab".
6020 Default: dedicated keytab file =
6022 Example: dedicated keytab file = /usr/local/etc/krb5.keytab
6024 directory mode
6026 This parameter is a synonym for directory mask.
6028 directory mask (S)
6030 This parameter is the octal modes which are used when converting
6032 DOS modes to UNIX modes when creating UNIX directories.
6033 When a directory is created, the necessary permissions are
6035 calculated according to the mapping from DOS modes to UNIX
6036 permissions, and the resulting UNIX mode is then bit-wise ´AND´ed
6037 with this parameter. This parameter may be thought of as a bit-wise
6038 MASK for the UNIX modes of a directory. Any bit not set here will
6039 be removed from the modes set on a directory when it is created.
6040 The default value of this parameter removes the ´group´ and ´other´
6042 write bits from the UNIX mode, allowing only the user who owns the
6043 directory to modify it.
6044 Following this Samba will bit-wise ´OR´ the UNIX mode created from
6046 this parameter with the value of the force directory mode
6047 parameter. This parameter is set to 000 by default (i.e. no extra
6048 mode bits are added).
6049 Default: directory mask = 0755
6051 Example: directory mask = 0775
6053 directory security mask (S)
6055 This parameter has been removed for Samba 4.0.0.
6057 No default
6059 encrypt passwords (G)
6061 This boolean controls whether encrypted passwords will be
6063 negotiated with the client. Note that Windows NT 4.0 SP3 and above
6064 and also Windows 98 will by default expect encrypted passwords
6065 unless a registry entry is changed. To use encrypted passwords in
6066 Samba see the chapter "User Database" in the Samba HOWTO
6067 Collection.
6068 MS Windows clients that expect Microsoft encrypted passwords and
6070 that do not have plain text password support enabled will be able
6071 to connect only to a Samba server that has encrypted password
6072 support enabled and for which the user accounts have a valid
6073 encrypted password. Refer to the smbpasswd command man page for
6074 information regarding the creation of encrypted passwords for user
6075 accounts.
6076 The use of plain text passwords is NOT advised as support for this
6078 feature is no longer maintained in Microsoft Windows products. If
6079 you want to use plain text passwords you must set this parameter to
6080 no.
6081 In order for encrypted passwords to work correctly smbd(8) must
6083 either have access to a local smbpasswd(5) file (see the
6084 smbpasswd(8) program for information on how to set up and maintain
6085 this file), or set the security = [domain|ads] parameter which
6086 causes smbd to authenticate against another server.
6087 Default: encrypt passwords = yes
6089 force create mode (S)
6091 This parameter specifies a set of UNIX mode bit permissions that
6093 will always be set on a file created by Samba. This is done by
6094 bitwise ´OR´ing these bits onto the mode bits of a file that is
6095 being created. The default for this parameter is (in octal) 000.
6096 The modes in this parameter are bitwise ´OR´ed onto the file mode
6097 after the mask set in the create mask parameter is applied.
6098 The example below would force all newly created files to have read
6100 and execute permissions set for ´group´ and ´other´ as well as the
6101 read/write/execute bits set for the ´user´.
6102 Default: force create mode = 0000
6104 Example: force create mode = 0755
6106 force directory mode (S)
6108 This parameter specifies a set of UNIX mode bit permissions that
6110 will always be set on a directory created by Samba. This is done by
6111 bitwise ´OR´ing these bits onto the mode bits of a directory that
6112 is being created. The default for this parameter is (in octal) 0000
6113 which will not add any extra permission bits to a created
6114 directory. This operation is done after the mode mask in the
6115 parameter directory mask is applied.
6116 The example below would force all created directories to have read
6118 and execute permissions set for ´group´ and ´other´ as well as the
6119 read/write/execute bits set for the ´user´.
6120 Default: force directory mode = 0000
6122 Example: force directory mode = 0755
6124 force directory security mode (S)
6126 This parameter has been removed for Samba 4.0.0.
6128 No default
6130 group
6132 This parameter is a synonym for force group.
6134 force group (S)
6136 This specifies a UNIX group name that will be assigned as the
6138 default primary group for all users connecting to this service.
6139 This is useful for sharing files by ensuring that all access to
6140 files on service will use the named group for their permissions
6141 checking. Thus, by assigning permissions for this group to the
6142 files and directories within this service the Samba administrator
6143 can restrict or allow sharing of these files.
6144 In Samba 2.0.5 and above this parameter has extended functionality
6146 in the following way. If the group name listed here has a ´+´
6147 character prepended to it then the current user accessing the share
6148 only has the primary group default assigned to this group if they
6149 are already assigned as a member of that group. This allows an
6150 administrator to decide that only users who are already in a
6151 particular group will create files with group ownership set to that
6152 group. This gives a finer granularity of ownership assignment. For
6153 example, the setting force group = +sys means that only users who
6154 are already in group sys will have their default primary group
6155 assigned to sys when accessing this Samba share. All other users
6156 will retain their ordinary primary group.
6157 If the force user parameter is also set the group specified in
6159 force group will override the primary group set in force user.
6160 Default: force group =
6162 Example: force group = agroup
6164 force security mode (S)
6166 This parameter has been removed for Samba 4.0.0.
6168 No default
6170 force unknown acl user (S)
6172 If this parameter is set, a Windows NT ACL that contains an unknown
6174 SID (security descriptor, or representation of a user or group id)
6175 as the owner or group owner of the file will be silently mapped
6176 into the current UNIX uid or gid of the currently connected user.
6177 This is designed to allow Windows NT clients to copy files and
6179 folders containing ACLs that were created locally on the client
6180 machine and contain users local to that machine only (no domain
6181 users) to be copied to a Samba server (usually with XCOPY /O) and
6182 have the unknown userid and groupid of the file owner map to the
6183 current connected user. This can only be fixed correctly when
6184 winbindd allows arbitrary mapping from any Windows NT SID to a UNIX
6185 uid or gid.
6186 Try using this parameter when XCOPY /O gives an ACCESS_DENIED
6188 error.
6189 Default: force unknown acl user = no
6191 force user (S)
6193 This specifies a UNIX user name that will be assigned as the
6195 default user for all users connecting to this service. This is
6196 useful for sharing files. You should also use it carefully as using
6197 it incorrectly can cause security problems.
6198 This user name only gets used once a connection is established.
6200 Thus clients still need to connect as a valid user and supply a
6201 valid password. Once connected, all file operations will be
6202 performed as the "forced user", no matter what username the client
6203 connected as. This can be very useful.
6204 In Samba 2.0.5 and above this parameter also causes the primary
6206 group of the forced user to be used as the primary group for all
6207 file activity. Prior to 2.0.5 the primary group was left as the
6208 primary group of the connecting user (this was a bug).
6209 Default: force user =
6211 Example: force user = auser
6213 guest account (G)
6215 This is a username which will be used for access to services which
6217 are specified as guest ok (see below). Whatever privileges this
6218 user has will be available to any client connecting to the guest
6219 service. This user must exist in the password file, but does not
6220 require a valid login. The user account "ftp" is often a good
6221 choice for this parameter.
6222 On some systems the default guest account "nobody" may not be able
6224 to print. Use another account in this case. You should test this by
6225 trying to log in as your guest user (perhaps by using the su -
6226 command) and trying to print using the system print command such as
6227 lpr(1) or lp(1).
6228 This parameter does not accept % macros, because many parts of the
6230 system require this value to be constant for correct operation.
6231 Default: guest account = nobody # default can be changed at
6233 compile-time
6234 Example: guest account = ftp
6236 public
6238 This parameter is a synonym for guest ok.
6240 guest ok (S)
6242 If this parameter is yes for a service, then no password is
6244 required to connect to the service. Privileges will be those of the
6245 guest account.
6246 This parameter nullifies the benefits of setting restrict anonymous
6248 = 2
6249 See the section below on security for more information about this
6251 option.
6252 Default: guest ok = no
6254 only guest
6256 This parameter is a synonym for guest only.
6258 guest only (S)
6260 If this parameter is yes for a service, then only guest connections
6262 to the service are permitted. This parameter will have no effect if
6263 guest ok is not set for the service.
6264 See the section below on security for more information about this
6266 option.
6267 Default: guest only = no
6269 allow hosts
6271 This parameter is a synonym for hosts allow.
6273 hosts allow (S)
6275 A synonym for this parameter is allow hosts.
6277 This parameter is a comma, space, or tab delimited set of hosts
6279 which are permitted to access a service.
6280 If specified in the [global] section then it will apply to all
6282 services, regardless of whether the individual service has a
6283 different setting.
6284 You can specify the hosts by name or IP number. For example, you
6286 could restrict access to only the hosts on a Class C subnet with
6287 something like allow hosts = 150.203.5.. The full syntax of the
6288 list is described in the man page hosts_access(5). Note that this
6289 man page may not be present on your system, so a brief description
6290 will be given here also.
6291 Note that the localhost address 127.0.0.1 will always be allowed
6293 access unless specifically denied by a hosts deny option.
6294 You can also specify hosts by network/netmask pairs and by netgroup
6296 names if your system supports netgroups. The EXCEPT keyword can
6297 also be used to limit a wildcard list. The following examples may
6298 provide some help:
6299 Example 1: allow all IPs in 150.203.*.*; except one
6301 hosts allow = 150.203. EXCEPT 150.203.6.66
6303 Example 2: allow hosts that match the given network/netmask
6305 hosts allow = 150.203.15.0/255.255.255.0
6307 Example 3: allow a couple of hosts
6309 hosts allow = lapland, arvidsjaur
6311 Example 4: allow only hosts in NIS netgroup "foonet", but deny
6313 access from one particular host
6314 hosts allow = @foonet
6316 hosts deny = pirate
6318 Note
6320 Note that access still requires suitable user-level passwords.
6321 See testparm(1) for a way of testing your host access to see if it
6322 does what you expect.
6323 Default: hosts allow = # none (i.e., all hosts permitted access)
6325 Example: hosts allow = 150.203.5. myhost.mynet.edu.au
6327 deny hosts
6329 This parameter is a synonym for hosts deny.
6331 hosts deny (S)
6333 The opposite of hosts allow - hosts listed here are NOT permitted
6335 access to services unless the specific services have their own
6336 lists to override this one. Where the lists conflict, the allow
6337 list takes precedence.
6338 In the event that it is necessary to deny all by default, use the
6340 keyword ALL (or the netmask 0.0.0.0/0) and then explicitly specify
6341 to the hosts allow = hosts allow parameter those hosts that should
6342 be permitted access.
6343 Default: hosts deny = # none (i.e., no hosts specifically
6345 excluded)
6346 Example: hosts deny = 150.203.4. badhost.mynet.edu.au
6348 inherit acls (S)
6350 This parameter can be used to ensure that if default acls exist on
6352 parent directories, they are always honored when creating a new
6353 file or subdirectory in these parent directories. The default
6354 behavior is to use the unix mode specified when creating the
6355 directory. Enabling this option sets the unix mode to 0777, thus
6356 guaranteeing that default directory acls are propagated. Note that
6357 using the VFS modules acl_xattr or acl_tdb which store native
6358 Windows as meta-data will automatically turn this option on for any
6359 share for which they are loaded, as they require this option to
6360 emulate Windows ACLs correctly.
6361 Default: inherit acls = no
6363 inherit owner (S)
6365 The ownership of new files and directories is normally governed by
6367 effective uid of the connected user. This option allows the Samba
6368 administrator to specify that the ownership for new files and
6369 directories should be controlled by the ownership of the parent
6370 directory.
6371 Common scenarios where this behavior is useful is in implementing
6373 drop-boxes, where users can create and edit files but not delete
6374 them and ensuring that newly created files in a user´s roaming
6375 profile directory are actually owned by the user.
6376 Default: inherit owner = no
6378 inherit permissions (S)
6380 The permissions on new files and directories are normally governed
6382 by create mask, directory mask, force create mode and force
6383 directory mode but the boolean inherit permissions parameter
6384 overrides this.
6385 New directories inherit the mode of the parent directory, including
6387 bits such as setgid.
6388 New files inherit their read/write bits from the parent directory.
6390 Their execute bits continue to be determined by map archive, map
6391 hidden and map system as usual.
6392 Note that the setuid bit is never set via inheritance (the code
6394 explicitly prohibits this).
6395 This can be particularly useful on large systems with many users,
6397 perhaps several thousand, to allow a single [homes] share to be
6398 used flexibly by each user.
6399 Default: inherit permissions = no
6401 invalid users (S)
6403 This is a list of users that should not be allowed to login to this
6405 service. This is really a paranoid check to absolutely ensure an
6406 improper setting does not breach your security.
6407 A name starting with a ´@´ is interpreted as an NIS netgroup first
6409 (if your system supports NIS), and then as a UNIX group if the name
6410 was not found in the NIS netgroup database.
6411 A name starting with ´+´ is interpreted only by looking in the UNIX
6413 group database via the NSS getgrnam() interface. A name starting
6414 with ´&´ is interpreted only by looking in the NIS netgroup
6415 database (this requires NIS to be working on your system). The
6416 characters ´+´ and ´&´ may be used at the start of the name in
6417 either order so the value +&group means check the UNIX group
6418 database, followed by the NIS netgroup database, and the value
6419 &+group means check the NIS netgroup database, followed by the UNIX
6420 group database (the same as the ´@´ prefix).
6421 The current servicename is substituted for %S. This is useful in
6423 the [homes] section.
6424 Default: invalid users = # no invalid users
6426 Example: invalid users = root fred admin @wheel
6428 kerberos method (G)
6430 Controls how kerberos tickets are verified.
6432 Valid options are:
6434 · secrets only - use only the secrets.(n)tdb for ticket
6436 verification (default)
6437 · system keytab - use only the system keytab for ticket
6439 verification
6440 · dedicated keytab - use a dedicated keytab for ticket
6442 verification
6443 · secrets and keytab - use the secrets.(n)tdb first, then the
6445 system keytab
6446 The major difference between "system keytab" and "dedicated keytab" is
6448 that the latter method relies on kerberos to find the correct keytab
6449 entry instead of filtering based on expected principals.
6450 When the kerberos method is in "dedicated keytab" mode, dedicated
6452 keytab file must be set to specify the location of the keytab file.
6453 Default: kerberos method = default
6455 kpasswd port (G)
6457 Specifies which ports the Kerberos server should listen on for
6459 password changes.
6460 Default: kpasswd port = 464
6462 krb5 port (G)
6464 Specifies which port the KDC should listen on for Kerberos traffic.
6466 Default: krb5 port = 88
6468 lanman auth (G)
6470 This parameter determines whether or not smbd(8) will attempt to
6472 authenticate users or permit password changes using the LANMAN
6473 password hash. If disabled, only clients which support NT password
6474 hashes (e.g. Windows NT/2000 clients, smbclient, but not Windows
6475 95/98 or the MS DOS network client) will be able to connect to the
6476 Samba host.
6477 The LANMAN encrypted response is easily broken, due to its
6479 case-insensitive nature, and the choice of algorithm. Servers
6480 without Windows 95/98/ME or MS DOS clients are advised to disable
6481 this option.
6482 When this parameter is set to no this will also result in
6484 sambaLMPassword in Samba´s passdb being blanked after the next
6485 password change. As a result of that lanman clients won´t be able
6486 to authenticate, even if lanman auth is reenabled later on.
6487 Unlike the encrypt passwords option, this parameter cannot alter
6489 client behaviour, and the LANMAN response will still be sent over
6490 the network. See the client lanman auth to disable this for Samba´s
6491 clients (such as smbclient)
6492 If this option, and ntlm auth are both disabled, then only NTLMv2
6494 logins will be permited. Not all clients support NTLMv2, and most
6495 will require special configuration to use it.
6496 Default: lanman auth = no
6498 log nt token command (G)
6500 This option can be set to a command that will be called when new nt
6502 tokens are created.
6503 This is only useful for development purposes.
6505 Default: log nt token command =
6507 map to guest (G)
6509 This parameter can take four different values, which tell smbd(8)
6511 what to do with user login requests that don´t match a valid UNIX
6512 user in some way.
6513 The four settings are :
6515 · Never - Means user login requests with an invalid password are
6517 rejected. This is the default.
6518 · Bad User - Means user logins with an invalid password are
6520 rejected, unless the username does not exist, in which case it
6521 is treated as a guest login and mapped into the guest account.
6522 · Bad Password - Means user logins with an invalid password are
6524 treated as a guest login and mapped into the guest account.
6525 Note that this can cause problems as it means that any user
6526 incorrectly typing their password will be silently logged on as
6527 "guest" - and will not know the reason they cannot access files
6528 they think they should - there will have been no message given
6529 to them that they got their password wrong. Helpdesk services
6530 will hate you if you set the map to guest parameter this way
6531 :-).
6532 · Bad Uid - Is only applicable when Samba is configured in some
6534 type of domain mode security (security = {domain|ads}) and
6535 means that user logins which are successfully authenticated but
6536 which have no valid Unix user account (and smbd is unable to
6537 create one) should be mapped to the defined guest account. This
6538 was the default behavior of Samba 2.x releases. Note that if a
6539 member server is running winbindd, this option should never be
6540 required because the nss_winbind library will export the
6541 Windows domain users and groups to the underlying OS via the
6542 Name Service Switch interface.
6543 Note that this parameter is needed to set up "Guest" share services.
6545 This is because in these modes the name of the resource being requested
6546 is not sent to the server until after the server has successfully
6547 authenticated the client so the server cannot make authentication
6548 decisions at the correct time (connection to the share) for "Guest"
6549 shares.
6550 Default: map to guest = Never
6552 Example: map to guest = Bad User
6554 map untrusted to domain (G)
6556 If a client connects to smbd using an untrusted domain name, such
6558 as BOGUS\user, smbd replaces the BOGUS domain with it´s SAM name
6559 before attempting to authenticate that user. In the case where smbd
6560 is acting as a PDC this will be DOMAIN\user. In the case where smbd
6561 is acting as a domain member server or a standalone server this
6562 will be WORKSTATION\user.
6563 In previous versions of Samba (pre 3.4), if smbd was acting as a
6565 domain member server, the BOGUS domain name would instead be
6566 replaced by the primary domain which smbd was a member of. In this
6567 case authentication would be deferred off to a DC using the
6568 credentials DOMAIN\user.
6569 When this parameter is set to yes smbd provides the legacy behavior
6571 of mapping untrusted domain names to the primary domain. When smbd
6572 is not acting as a domain member server, this parameter has no
6573 effect.
6574 Default: map untrusted to domain = no
6576 ntlm auth (G)
6578 This parameter determines whether or not smbd(8) will attempt to
6580 authenticate users using the NTLM encrypted password response. If
6581 disabled, either the lanman password hash or an NTLMv2 response
6582 will need to be sent by the client.
6583 If this option, and lanman auth are both disabled, then only NTLMv2
6585 logins will be permited. Not all clients support NTLMv2, and most
6586 will require special configuration to use it.
6587 Default: ntlm auth = yes
6589 ntp signd socket directory (G)
6591 This setting controls the location of the socket that the NTP
6593 daemon uses to communicate with Samba for signing packets.
6594 If a non-default path is specified here, then it is also necessary
6596 to make NTP aware of the new path using the ntpsigndsocket
6597 directive in ntp.conf.
6598 Default: ntp signd socket directory = /var/lib/samba/ntp_signd
6600 null passwords (G)
6602 Allow or disallow client access to accounts that have null
6604 passwords.
6605 See also smbpasswd(5).
6607 Default: null passwords = no
6609 obey pam restrictions (G)
6611 When Samba 3.0 is configured to enable PAM support (i.e.
6613 --with-pam), this parameter will control whether or not Samba
6614 should obey PAM´s account and session management directives. The
6615 default behavior is to use PAM for clear text authentication only
6616 and to ignore any account or session management. Note that Samba
6617 always ignores PAM for authentication in the case of encrypt
6618 passwords = yes. The reason is that PAM modules cannot support the
6619 challenge/response authentication mechanism needed in the presence
6620 of SMB password encryption.
6621 Default: obey pam restrictions = no
6623 old password allowed period (G)
6625 Number of minutes to permit an NTLM login after a password change
6627 or reset using the old password. This allows the user to re-cache
6628 the new password on multiple clients without disrupting a network
6629 reconnection in the meantime.
6630 This parameter only applies when server role is set to Active
6632 Directory Domain Controller
6633 Default: old password allowed period = 60
6635 only user (S)
6637 To restrict a service to a particular set of users you can use the
6639 valid users parameter.
6640 This parameter is deprecated
6642 However, it currently operates only in conjunction with username.
6644 The supported way to restrict a service to a particular set of
6645 users is the valid users parameter.
6646 Default: only user = no
6648 pam password change (G)
6650 With the addition of better PAM support in Samba 2.2, this
6652 parameter, it is possible to use PAM´s password change control flag
6653 for Samba. If enabled, then PAM will be used for password changes
6654 when requested by an SMB client instead of the program listed in
6655 passwd program. It should be possible to enable this without
6656 changing your passwd chat parameter for most setups.
6657 Default: pam password change = no
6659 passdb backend (G)
6661 This option allows the administrator to chose which backend will be
6663 used for storing user and possibly group information. This allows
6664 you to swap between different storage mechanisms without recompile.
6665 The parameter value is divided into two parts, the backend´s name,
6667 and a ´location´ string that has meaning only to that particular
6668 backed. These are separated by a : character.
6669 Available backends can include:
6671 · smbpasswd - The old plaintext passdb backend. Some Samba
6673 features will not work if this passdb backend is used. Takes a
6674 path to the smbpasswd file as an optional argument.
6675 · tdbsam - The TDB based password storage backend. Takes a path
6677 to the TDB as an optional argument (defaults to passdb.tdb in
6678 the private dir directory.
6679 · ldapsam - The LDAP based passdb backend. Takes an LDAP URL as
6681 an optional argument (defaults to ldap://localhost)
6682 LDAP connections should be secured where possible. This may be
6684 done using either Start-TLS (see ldap ssl) or by specifying
6685 ldaps:// in the URL argument.
6686 Multiple servers may also be specified in double-quotes.
6688 Whether multiple servers are supported or not and the exact
6689 syntax depends on the LDAP library you use.
6690 Examples of use are:
6693 passdb backend = tdbsam:/etc/samba/private/passdb.tdb
6695 or multi server LDAP URL with OpenLDAP library:
6697 passdb backend = ldapsam:"ldap://ldap-1.example.com ldap://ldap-2.example.com"
6699 or multi server LDAP URL with Netscape based LDAP library:
6701 passdb backend = ldapsam:"ldap://ldap-1.example.com ldap-2.example.com"
6703 Default: passdb backend = tdbsam
6705 passdb expand explicit (G)
6707 This parameter controls whether Samba substitutes %-macros in the
6709 passdb fields if they are explicitly set. We used to expand macros
6710 here, but this turned out to be a bug because the Windows client
6711 can expand a variable %G_osver% in which %G would have been
6712 substituted by the user´s primary group.
6713 Default: passdb expand explicit = no
6715 passwd chat (G)
6717 This string controls the "chat" conversation that takes places
6719 between smbd(8) and the local password changing program to change
6720 the user´s password. The string describes a sequence of
6721 response-receive pairs that smbd(8) uses to determine what to send
6722 to the passwd program and what to expect back. If the expected
6723 output is not received then the password is not changed.
6724 This chat sequence is often quite site specific, depending on what
6726 local methods are used for password control (such as NIS etc).
6727 Note that this parameter only is used if the unix password sync
6729 parameter is set to yes. This sequence is then called AS ROOT when
6730 the SMB password in the smbpasswd file is being changed, without
6731 access to the old password cleartext. This means that root must be
6732 able to reset the user´s password without knowing the text of the
6733 previous password. In the presence of NIS/YP, this means that the
6734 passwd program must be executed on the NIS master.
6735 The string can contain the macro %n which is substituted for the
6737 new password. The old passsword (%o) is only available when encrypt
6738 passwords has been disabled. The chat sequence can also contain the
6739 standard macros \n, \r, \t and \s to give line-feed,
6740 carriage-return, tab and space. The chat sequence string can also
6741 contain a ´*´ which matches any sequence of characters. Double
6742 quotes can be used to collect strings with spaces in them into a
6743 single string.
6744 If the send string in any part of the chat sequence is a full stop
6746 ".", then no string is sent. Similarly, if the expect string is a
6747 full stop then no string is expected.
6748 If the pam password change parameter is set to yes, the chat pairs
6750 may be matched in any order, and success is determined by the PAM
6751 result, not any particular output. The \n macro is ignored for PAM
6752 conversions.
6753 Default: passwd chat = *new*password* %n\n *new*password* %n\n
6755 *changed*
6756 Example: passwd chat = "*Enter NEW password*" %n\n "*Reenter NEW
6758 password*" %n\n "*Password changed*"
6759 passwd chat debug (G)
6761 This boolean specifies if the passwd chat script parameter is run
6763 in debug mode. In this mode the strings passed to and received from
6764 the passwd chat are printed in the smbd(8) log with a debug level
6765 of 100. This is a dangerous option as it will allow plaintext
6766 passwords to be seen in the smbd log. It is available to help Samba
6767 admins debug their passwd chat scripts when calling the passwd
6768 program and should be turned off after this has been done. This
6769 option has no effect if the pam password change parameter is set.
6770 This parameter is off by default.
6771 Default: passwd chat debug = no
6773 passwd chat timeout (G)
6775 This integer specifies the number of seconds smbd will wait for an
6777 initial answer from a passwd chat script being run. Once the
6778 initial answer is received the subsequent answers must be received
6779 in one tenth of this time. The default it two seconds.
6780 Default: passwd chat timeout = 2
6782 passwd program (G)
6784 The name of a program that can be used to set UNIX user passwords.
6786 Any occurrences of %u will be replaced with the user name. The user
6787 name is checked for existence before calling the password changing
6788 program.
6789 Also note that many passwd programs insist in reasonable passwords,
6791 such as a minimum length, or the inclusion of mixed case chars and
6792 digits. This can pose a problem as some clients (such as Windows
6793 for Workgroups) uppercase the password before sending it.
6794 Note that if the unix password sync parameter is set to yes then
6796 this program is called AS ROOT before the SMB password in the
6797 smbpasswd file is changed. If this UNIX password change fails, then
6798 smbd will fail to change the SMB password also (this is by design).
6799 If the unix password sync parameter is set this parameter MUST USE
6801 ABSOLUTE PATHS for ALL programs called, and must be examined for
6802 security implications. Note that by default unix password sync is
6803 set to no.
6804 Default: passwd program =
6806 Example: passwd program = /bin/passwd %u
6808 password server (G)
6810 By specifying the name of a domain controller with this option, and
6812 using security = [ads|domain] it is possible to get Samba to do all
6813 its username/password validation using a specific remote server.
6814 Ideally, this option should not be used, as the default ´*´
6816 indicates to Samba to determine the best DC to contact dynamically,
6817 just as all other hosts in an AD domain do. This allows the domain
6818 to be maintained (addition and removal of domain controllers)
6819 without modification to the smb.conf file. The cryptographic
6820 protection on the authenticated RPC calls used to verify passwords
6821 ensures that this default is safe.
6822 It is strongly recommended that you use the default of ´*´, however
6824 if in your particular environment you have reason to specify a
6825 particular DC list, then the list of machines in this option must
6826 be a list of names or IP addresses of Domain controllers for the
6827 Domain. If you use the default of ´*´, or list several hosts in the
6828 password server option then smbd will try each in turn till it
6829 finds one that responds. This is useful in case your primary server
6830 goes down.
6831 If the list of servers contains both names/IP´s and the ´*´
6833 character, the list is treated as a list of preferred domain
6834 controllers, but an auto lookup of all remaining DC´s will be added
6835 to the list as well. Samba will not attempt to optimize this list
6836 by locating the closest DC.
6837 If parameter is a name, it is looked up using the parameter name
6839 resolve order and so may resolved by any method and order described
6840 in that parameter.
6841 Default: password server = *
6843 Example: password server = NT-PDC, NT-BDC1, NT-BDC2, *
6845 Example: password server = windc.mydomain.com:389 192.168.1.101 *
6847 preload modules (G)
6849 This is a list of paths to modules that should be loaded into smbd
6851 before a client connects. This improves the speed of smbd when
6852 reacting to new connections somewhat.
6853 Default: preload modules =
6855 Example: preload modules = /usr/lib/samba/passdb/mysql.so
6857 private directory
6859 This parameter is a synonym for private dir.
6861 private dir (G)
6863 This parameters defines the directory smbd will use for storing
6865 such files as smbpasswd and secrets.tdb (or secrets.ntdb).
6866 Default: private dir = /var/lib/samba/private
6868 raw NTLMv2 auth (G)
6870 This parameter determines whether or not smbd(8) will allow SMB1
6872 clients without extended security (without SPNEGO) to use NTLMv2
6873 authentication.
6874 If this option, lanman auth and ntlm auth are all disabled, then
6876 only clients with SPNEGO support will be permitted. That means
6877 NTLMv2 is only supported within NTLMSSP.
6878 Default: raw NTLMv2 auth = no
6880 read list (S)
6882 This is a list of users that are given read-only access to a
6884 service. If the connecting user is in this list then they will not
6885 be given write access, no matter what the read only option is set
6886 to. The list can include group names using the syntax described in
6887 the invalid users parameter.
6888 Default: read list =
6890 Example: read list = mary, @students
6892 write ok
6894 This parameter is a synonym for read only.
6896 read only (S)
6898 An inverted synonym is writeable.
6900 If this parameter is yes, then users of a service may not create or
6902 modify files in the service´s directory.
6903 Note that a printable service (printable = yes) will ALWAYS allow
6905 writing to the directory (user privileges permitting), but only via
6906 spooling operations.
6907 Default: read only = yes
6909 rename user script (G)
6911 This is the full pathname to a script that will be run as root by
6913 smbd(8) under special circumstances described below.
6914 When a user with admin authority or SeAddUserPrivilege rights
6916 renames a user (e.g.: from the NT4 User Manager for Domains), this
6917 script will be run to rename the POSIX user. Two variables, %uold
6918 and %unew, will be substituted with the old and new usernames,
6919 respectively. The script should return 0 upon successful
6920 completion, and nonzero otherwise.
6921 Note
6923 The script has all responsibility to rename all the necessary
6924 data that is accessible in this posix method. This can mean
6925 different requirements for different backends. The tdbsam and
6926 smbpasswd backends will take care of the contents of their
6927 respective files, so the script is responsible only for
6928 changing the POSIX username, and other data that may required
6929 for your circumstances, such as home directory. Please also
6930 consider whether or not you need to rename the actual home
6931 directories themselves. The ldapsam backend will not make any
6932 changes, because of the potential issues with renaming the LDAP
6933 naming attribute. In this case the script is responsible for
6934 changing the attribute that samba uses (uid) for locating
6935 users, as well as any data that needs to change for other
6936 applications using the same directory.
6937 Default: rename user script =
6938 restrict anonymous (G)
6940 The setting of this parameter determines whether user and group
6942 list information is returned for an anonymous connection. and
6943 mirrors the effects of the
6944 HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\
6946 Control\LSA\RestrictAnonymous
6947 registry key in Windows 2000 and Windows NT. When set to 0, user
6949 and group list information is returned to anyone who asks. When set
6950 to 1, only an authenticated user can retrieve user and group list
6951 information. For the value 2, supported by Windows 2000/XP and
6952 Samba, no anonymous connections are allowed at all. This can break
6953 third party and Microsoft applications which expect to be allowed
6954 to perform operations anonymously.
6955 The security advantage of using restrict anonymous = 1 is dubious,
6957 as user and group list information can be obtained using other
6958 means.
6959 Note
6961 The security advantage of using restrict anonymous = 2 is
6962 removed by setting guest ok = yes on any share.
6963 Default: restrict anonymous = 0
6964 root
6966 This parameter is a synonym for root directory.
6968 root dir
6970 This parameter is a synonym for root directory.
6972 root directory (G)
6974 The server will chroot() (i.e. Change its root directory) to this
6976 directory on startup. This is not strictly necessary for secure
6977 operation. Even without it the server will deny access to files not
6978 in one of the service entries. It may also check for, and deny
6979 access to, soft links to other parts of the filesystem, or attempts
6980 to use ".." in file names to access other directories (depending on
6981 the setting of the wide smbconfoptions parameter).
6982 Adding a root directory entry other than "/" adds an extra level of
6984 security, but at a price. It absolutely ensures that no access is
6985 given to files not in the sub-tree specified in the root directory
6986 option, including some files needed for complete operation of the
6987 server. To maintain full operability of the server you will need to
6988 mirror some system files into the root directory tree. In
6989 particular you will need to mirror /etc/passwd (or a subset of it),
6990 and any binaries or configuration files needed for printing (if
6991 required). The set of files that must be mirrored is operating
6992 system dependent.
6993 Default: root directory =
6995 Example: root directory = /homes/smb
6997 samba kcc command (G)
6999 This option specifies the path to the Samba KCC command. This
7001 script is used for replication topology replication.
7002 It should not be necessary to modify this option except for testing
7004 purposes or if the samba_kcc was installed in a non-default
7005 location.
7006 Default: samba kcc command =
7008 /builddir/build/BUILD/samba-4.2.10/source4/scripting/bin/samba_kcc
7009 Example: samba kcc command = /usr/local/bin/kcc
7011 security (G)
7013 This option affects how clients respond to Samba and is one of the
7015 most important settings in the smb.conf file.
7016 The default is security = user, as this is the most common setting,
7018 used for a standalone file server or a DC.
7019 The alternatives are security = ads or security = domain, which
7021 support joining Samba to a Windows domain
7022 You should use security = user and map to guest if you want to
7024 mainly setup shares without a password (guest shares). This is
7025 commonly used for a shared printer server.
7026 The different settings will now be explained.
7028 SECURITY = AUTO
7030 This is the default security setting in Samba, and causes Samba to
7032 consult the server role parameter (if set) to determine the
7033 security mode.
7034 SECURITY = USER
7036 If server role is not specified, this is the default security
7038 setting in Samba. With user-level security a client must first
7039 "log-on" with a valid username and password (which can be mapped
7040 using the username map parameter). Encrypted passwords (see the
7041 encrypted passwords parameter) can also be used in this security
7042 mode. Parameters such as user and guest only if set are then
7043 applied and may change the UNIX user to use on this connection, but
7044 only after the user has been successfully authenticated.
7045 Note that the name of the resource being requested is not sent to
7047 the server until after the server has successfully authenticated
7048 the client. This is why guest shares don´t work in user level
7049 security without allowing the server to automatically map unknown
7050 users into the guest account. See the map to guest parameter for
7051 details on doing this.
7052 SECURITY = DOMAIN
7054 This mode will only work correctly if net(8) has been used to add
7056 this machine into a Windows NT Domain. It expects the encrypted
7057 passwords parameter to be set to yes. In this mode Samba will try
7058 to validate the username/password by passing it to a Windows NT
7059 Primary or Backup Domain Controller, in exactly the same way that a
7060 Windows NT Server would do.
7061 Note that a valid UNIX user must still exist as well as the account
7063 on the Domain Controller to allow Samba to have a valid UNIX
7064 account to map file access to.
7065 Note that from the client´s point of view security = domain is the
7067 same as security = user. It only affects how the server deals with
7068 the authentication, it does not in any way affect what the client
7069 sees.
7070 Note that the name of the resource being requested is not sent to
7072 the server until after the server has successfully authenticated
7073 the client. This is why guest shares don´t work in user level
7074 security without allowing the server to automatically map unknown
7075 users into the guest account. See the map to guest parameter for
7076 details on doing this.
7077 See also the password server parameter and the encrypted passwords
7079 parameter.
7080 Note that the name of the resource being requested is not sent to
7082 the server until after the server has successfully authenticated
7083 the client. This is why guest shares don´t work in user level
7084 security without allowing the server to automatically map unknown
7085 users into the guest account. See the map to guest parameter for
7086 details on doing this.
7087 See also the password server parameter and the encrypted passwords
7089 parameter.
7090 SECURITY = ADS
7092 In this mode, Samba will act as a domain member in an ADS realm. To
7094 operate in this mode, the machine running Samba will need to have
7095 Kerberos installed and configured and Samba will need to be joined
7096 to the ADS realm using the net utility.
7097 Note that this mode does NOT make Samba operate as a Active
7099 Directory Domain Controller.
7100 Note that this forces require strong key = yes and client schannel
7102 = yes for the primary domain.
7103 Read the chapter about Domain Membership in the HOWTO for details.
7105 Default: security = AUTO
7107 Example: security = DOMAIN
7109 security mask (S)
7111 This parameter has been removed for Samba 4.0.0.
7113 No default
7115 server role (G)
7117 This option determines the basic operating mode of a Samba server
7119 and is one of the most important settings in the smb.conf file.
7120 The default is server role = auto, as causes Samba to operate
7122 according to the security setting, or if not specified as a simple
7123 file server that is not connected to any domain.
7124 The alternatives are server role = standalone or server role =
7126 member server, which support joining Samba to a Windows domain,
7127 along with server role = domain controller, which run Samba as a
7128 Windows domain controller.
7129 You should use server role = standalone and map to guest if you
7131 want to mainly setup shares without a password (guest shares). This
7132 is commonly used for a shared printer server.
7133 SERVER ROLE = AUTO
7135 This is the default server role in Samba, and causes Samba to
7137 consult the security parameter (if set) to determine the server
7138 role, giving compatable behaviours to previous Samba versions.
7139 SERVER ROLE = STANDALONE
7141 If security is also not specified, this is the default security
7143 setting in Samba. In standalone operation, a client must first
7144 "log-on" with a valid username and password (which can be mapped
7145 using the username map parameter) stored on this machine. Encrypted
7146 passwords (see the encrypted passwords parameter) are by default
7147 used in this security mode. Parameters such as user and guest only
7148 if set are then applied and may change the UNIX user to use on this
7149 connection, but only after the user has been successfully
7150 authenticated.
7151 SERVER ROLE = MEMBER SERVER
7153 This mode will only work correctly if net(8) has been used to add
7155 this machine into a Windows Domain. It expects the encrypted
7156 passwords parameter to be set to yes. In this mode Samba will try
7157 to validate the username/password by passing it to a Windows or
7158 Samba Domain Controller, in exactly the same way that a Windows
7159 Server would do.
7160 Note that a valid UNIX user must still exist as well as the account
7162 on the Domain Controller to allow Samba to have a valid UNIX
7163 account to map file access to. Winbind can provide this.
7164 SERVER ROLE = CLASSIC PRIMARY DOMAIN CONTROLLER
7166 This mode of operation runs a classic Samba primary domain
7168 controller, providing domain logon services to Windows and Samba
7169 clients of an NT4-like domain. Clients must be joined to the domain
7170 to create a secure, trusted path across the network. There must be
7171 only one PDC per NetBIOS scope (typcially a broadcast network or
7172 clients served by a single WINS server).
7173 SERVER ROLE = NETBIOS BACKUP DOMAIN CONTROLLER
7175 This mode of operation runs a classic Samba backup domain
7177 controller, providing domain logon services to Windows and Samba
7178 clients of an NT4-like domain. As a BDC, this allows multiple Samba
7179 servers to provide redundant logon services to a single NetBIOS
7180 scope.
7181 SERVER ROLE = ACTIVE DIRECTORY DOMAIN CONTROLLER
7183 This mode of operation runs Samba as an active directory domain
7185 controller, providing domain logon services to Windows and Samba
7186 clients of the domain. This role requires special configuration,
7187 see the Samba4 HOWTO
7188 Default: server role = AUTO
7190 Example: server role = DOMAIN CONTROLLER
7192 server schannel (G)
7194 This controls whether the server offers or even demands the use of
7196 the netlogon schannel. server schannel = no does not offer the
7197 schannel, server schannel = auto offers the schannel but does not
7198 enforce it, and server schannel = yes denies access if the client
7199 is not able to speak netlogon schannel. This is only the case for
7200 Windows NT4 before SP4.
7201 Please note that with this set to no, you will have to apply the
7203 WindowsXP WinXP_SignOrSeal.reg registry patch found in the
7204 docs/registry subdirectory of the Samba distribution tarball.
7205 Default: server schannel = auto
7207 Example: server schannel = yes
7209 server signing (G)
7211 This controls whether the client is allowed or required to use SMB1
7213 and SMB2 signing. Possible values are default, auto, mandatory and
7214 disabled.
7215 By default, and when smb signing is set to default, smb signing is
7217 required when server role is active directory domain controller and
7218 disabled otherwise.
7219 When set to auto, SMB1 signing is offered, but not enforced. When
7221 set to mandatory, SMB1 signing is required and if set to disabled,
7222 SMB signing is not offered either.
7223 For the SMB2 protocol, by design, signing cannot be disabled. In
7225 the case where SMB2 is negotiated, if this parameter is set to
7226 disabled, it will be treated as auto. Setting it to mandatory will
7227 still require SMB2 clients to use signing.
7228 Default: server signing = default
7230 smb encrypt (S)
7232 This parameter controls whether a remote client is allowed or
7234 required to use SMB encryption. It has different effects depending
7235 on whether the connection uses SMB1 or SMB2 and newer:
7236 · If the connection uses SMB1, then this option controls the use
7238 of a Samba-specific extension to the SMB protocol introduced in
7239 Samba 3.2 that makes use of the Unix extensions.
7240 · If the connection uses SMB2 or newer, then this option controls
7242 the use of the SMB-level encryption that is supported in SMB
7243 version 3.0 and above and available in Windows 8 and newer.
7244 This parameter can be set globally and on a per-share bases. Possible
7246 values are off (or disabled), enabled (or auto, or if_required),
7247 desired, and required (or mandatory). A special value is default which
7248 is the implicit default setting of enabled.
7249 Effects for SMB1
7251 The Samba-specific encryption of SMB1 connections is an extension
7252 to the SMB protocol negotiated as part of the UNIX extensions. SMB
7253 encryption uses the GSSAPI (SSPI on Windows) ability to encrypt and
7254 sign every request/response in a SMB protocol stream. When enabled
7255 it provides a secure method of SMB/CIFS communication, similar to
7256 an ssh protected session, but using SMB/CIFS authentication to
7257 negotiate encryption and signing keys. Currently this is only
7258 supported smbclient of by Samba 3.2 and newer, and hopefully soon
7259 Linux CIFSFS and MacOS/X clients. Windows clients do not support
7260 this feature.
7261 This may be set on a per-share basis, but clients may chose to
7263 encrypt the entire session, not just traffic to a specific share.
7264 If this is set to mandatory then all traffic to a share must be
7265 encrypted once the connection has been made to the share. The
7266 server would return "access denied" to all non-encrypted requests
7267 on such a share. Selecting encrypted traffic reduces throughput as
7268 smaller packet sizes must be used (no huge UNIX style read/writes
7269 allowed) as well as the overhead of encrypting and signing all the
7270 data.
7271 If SMB encryption is selected, Windows style SMB signing (see the
7273 server signing option) is no longer necessary, as the GSSAPI flags
7274 use select both signing and sealing of the data.
7275 When set to auto or default, SMB encryption is offered, but not
7277 enforced. When set to mandatory, SMB encryption is required and if
7278 set to disabled, SMB encryption can not be negotiated.
7279 Effects for SMB2
7281 Native SMB transport encryption is available in SMB version 3.0 or
7282 newer. It is only offered by Samba if server max protocol is set to
7283 SMB3 or newer. Clients supporting this type of encryption include
7284 Windows 8 and newer, Windows server 2012 and newer, and smbclient
7285 of Samba 4.1 and newer.
7286 The protocol implementation offers various options:
7288 · The capability to perform SMB encryption can be negotiated
7290 during protocol negotiation.
7291 · Data encryption can be enabled globally. In that case, an
7293 encryption-capable connection will have all traffic in all its
7294 sessions encrypted. In particular all share connections will be
7295 encrypted.
7296 · Data encryption can also be enabled per share if not enabled
7298 globally. For an encryption-capable connection, all connections
7299 to an encryption-enabled share will be encrypted.
7300 · Encryption can be enforced. This means that session setups will
7302 be denied on non-encryption-capable connections if data
7303 encryption has been enabled globally. And tree connections will
7304 be denied for non-encryption capable connections to shares with
7305 data encryption enabled.
7306 These features can be crontrolled with settings of smb encrypt as
7308 follows:
7309 · Leaving it as default, explicitly setting default, or setting it to
7311 enabled globally will enable negotiation of encryption but will not
7312 turn on data encryption globally or per share.
7313 · Setting it to desired globally will enable negotiation and will
7315 turn on data encryption on sessions and share connections for those
7316 clients that support it.
7317 · Setting it to required globally will enable negotiation and turn on
7319 data encryption on sessions and share connections. Clients that do
7320 not support encryption will be denied access to the server.
7321 · Setting it to off globally will completely disable the encryption
7323 feature.
7324 · Setting it to desired on a share will turn on data encryption for
7326 this share for clients that support encryption if negotiation has
7327 been enabled globally.
7328 · Setting it to required on a share will enforce data encryption for
7330 this share if negotiation has been enabled globally. I.e. clients
7331 that do not support encryption will be denied access to the share.
7332 Note that this allows per-share enforcing to be controlled in Samba
7334 differently from Windows: In Windows, RejectUnencryptedAccess is a
7335 global setting, and if it is set, all shares with data encryption
7336 turned on are automatically enforcing encryption. In order to
7337 achieve the same effect in Samba, one has to globally set smb
7338 encrypt to enabled, and then set all shares that should be
7339 encrypted to required. Additionally, it is possible in Samba to
7340 have some shares with encryption required and some other shares
7341 with encryption only desired, which is not possible in Windows.
7342 · Setting it to off or enabled for a share has no effect.
7344 Default: smb encrypt = default
7347 smb passwd file (G)
7349 This option sets the path to the encrypted smbpasswd file. By
7351 default the path to the smbpasswd file is compiled into Samba.
7352 An example of use is:
7354 smb passwd file = /etc/samba/smbpasswd
7356 Default: smb passwd file = /var/lib/samba/private/smbpasswd
7358 tls cafile (G)
7360 This option can be set to a file (PEM format) containing CA
7362 certificates of root CAs to trust to sign certificates or
7363 intermediate CA certificates.
7364 This path is relative to private dir if the path does not start
7366 with a /.
7367 Default: tls cafile = tls/ca.pem
7369 tls certfile (G)
7371 This option can be set to a file (PEM format) containing the RSA
7373 certificate.
7374 This path is relative to private dir if the path does not start
7376 with a /.
7377 Default: tls certfile = tls/cert.pem
7379 tls crlfile (G)
7381 This option can be set to a file containing a certificate
7383 revocation list (CRL).
7384 This path is relative to private dir if the path does not start
7386 with a /.
7387 Default: tls crlfile =
7389 tls dh params file (G)
7391 This option can be set to a file with Diffie-Hellman parameters
7393 which will be used with EDH ciphers.
7394 This path is relative to private dir if the path does not start
7396 with a /.
7397 Default: tls dh params file =
7399 tls enabled (G)
7401 If this option is set to yes, then Samba will use TLS when possible
7403 in communication.
7404 Default: tls enabled = yes
7406 tls keyfile (G)
7408 This option can be set to a file (PEM format) containing the RSA
7410 private key. This file must be accessible without a pass-phrase,
7411 i.e. it must not be encrypted.
7412 This path is relative to private dir if the path does not start
7414 with a /.
7415 Default: tls keyfile = tls/key.pem
7417 tls priority (G)
7419 This option can be set to a string describing the TLS protocols to
7421 be supported in the parts of Samba that use GnuTLS, specifically
7422 the AD DC.
7423 The default turns off SSLv3, as this protocol is no longer
7425 considered secure after CVE-2014-3566 (otherwise known as POODLE)
7426 impacted SSLv3 use in HTTPS applications.
7427 The valid options are described in the GNUTLS Priority-Strings
7429 documentation at
7430 http://gnutls.org/manual/html_node/Priority-Strings.html
7431 Default: tls priority = NORMAL:-VERS-SSL3.0
7433 tls verify peer (G)
7435 This controls if and how strict the client will verify the peer´s
7437 certificate and name. Possible values are (in increasing order):
7438 no_check, ca_only, ca_and_name_if_available, ca_and_name and
7439 as_strict_as_possible.
7440 When set to no_check the certificate is not verified at all, which
7442 allows trivial man in the middle attacks.
7443 When set to ca_only the certificate is verified to be signed from a
7445 ca specified in the tls ca file option. Setting tls ca file to a
7446 valid file is required. The certificate lifetime is also verified.
7447 If the tls crl file option is configured, the certificate is also
7448 verified against the ca crl.
7449 When set to ca_and_name_if_available all checks from ca_only are
7451 performed. In addition, the peer hostname is verified against the
7452 certificate´s name, if it is provided by the application layer and
7453 not given as an ip address string.
7454 When set to ca_and_name all checks from ca_and_name_if_available
7456 are performed. In addition the peer hostname needs to be provided
7457 and even an ip address is checked against the certificate´s name.
7458 When set to as_strict_as_possible all checks from ca_and_name are
7460 performed. In addition the tls crl file needs to be configured.
7461 Future versions of Samba may implement additional checks.
7462 Default: tls verify peer = as_strict_as_possible
7464 unix password sync (G)
7466 This boolean parameter controls whether Samba attempts to
7468 synchronize the UNIX password with the SMB password when the
7469 encrypted SMB password in the smbpasswd file is changed. If this is
7470 set to yes the program specified in the passwd program parameter is
7471 called AS ROOT - to allow the new UNIX password to be set without
7472 access to the old UNIX password (as the SMB password change code
7473 has no access to the old password cleartext, only the new).
7474 Default: unix password sync = no
7476 user
7478 This parameter is a synonym for username.
7480 users
7482 This parameter is a synonym for username.
7484 username (S)
7486 To restrict a service to a particular set of users you can use the
7488 valid users parameter.
7489 This parameter is deprecated
7491 However, it currently operates only in conjunction with only user.
7493 The supported way to restrict a service to a particular set of
7494 users is the valid users parameter.
7495 Default: username = # The guest account if a guest service, else
7497 <empty string>.
7498 Example: username = fred, mary, jack, jane, @users, @pcgroup
7500 username level (G)
7502 This option helps Samba to try and ´guess´ at the real UNIX
7504 username, as many DOS clients send an all-uppercase username. By
7505 default Samba tries all lowercase, followed by the username with
7506 the first letter capitalized, and fails if the username is not
7507 found on the UNIX machine.
7508 If this parameter is set to non-zero the behavior changes. This
7510 parameter is a number that specifies the number of uppercase
7511 combinations to try while trying to determine the UNIX user name.
7512 The higher the number the more combinations will be tried, but the
7513 slower the discovery of usernames will be. Use this parameter when
7514 you have strange usernames on your UNIX machine, such as
7515 AstrangeUser .
7516 This parameter is needed only on UNIX systems that have case
7518 sensitive usernames.
7519 Default: username level = 0
7521 Example: username level = 5
7523 username map (G)
7525 This option allows you to specify a file containing a mapping of
7527 usernames from the clients to the server. This can be used for
7528 several purposes. The most common is to map usernames that users
7529 use on DOS or Windows machines to those that the UNIX box uses. The
7530 other is to map multiple users to a single username so that they
7531 can more easily share files.
7532 Please note that for user mode security, the username map is
7534 applied prior to validating the user credentials. Domain member
7535 servers (domain or ads) apply the username map after the user has
7536 been successfully authenticated by the domain controller and
7537 require fully qualified entries in the map table (e.g. biddle =
7538 DOMAIN\foo).
7539 The map file is parsed line by line. Each line should contain a
7541 single UNIX username on the left then a ´=´ followed by a list of
7542 usernames on the right. The list of usernames on the right may
7543 contain names of the form @group in which case they will match any
7544 UNIX username in that group. The special client name ´*´ is a
7545 wildcard and matches any name. Each line of the map file may be up
7546 to 1023 characters long.
7547 The file is processed on each line by taking the supplied username
7549 and comparing it with each username on the right hand side of the
7550 ´=´ signs. If the supplied name matches any of the names on the
7551 right hand side then it is replaced with the name on the left.
7552 Processing then continues with the next line.
7553 If any line begins with a ´#´ or a ´;´ then it is ignored.
7555 If any line begins with an ´!´ then the processing will stop after
7557 that line if a mapping was done by the line. Otherwise mapping
7558 continues with every line being processed. Using ´!´ is most useful
7559 when you have a wildcard mapping line later in the file.
7560 For example to map from the name admin or administrator to the UNIX
7562 name
7563 root you would use:
7564 root = admin administrator
7566 Or to map anyone in the UNIX group system to the UNIX name sys you
7568 would use:
7569 sys = @system
7571 You can have as many mappings as you like in a username map file.
7573 If your system supports the NIS NETGROUP option then the netgroup
7575 database is checked before the /etc/group database for matching
7576 groups.
7577 You can map Windows usernames that have spaces in them by using
7579 double quotes around the name. For example:
7580 tridge = "Andrew Tridgell"
7582 would map the windows username "Andrew Tridgell" to the unix
7584 username "tridge".
7585 The following example would map mary and fred to the unix user sys,
7587 and map the rest to guest. Note the use of the ´!´ to tell Samba to
7588 stop processing if it gets a match on that line:
7589 !sys = mary fred
7591 guest = *
7592 Note that the remapping is applied to all occurrences of usernames.
7594 Thus if you connect to \\server\fred and fred is remapped to mary
7595 then you will actually be connecting to \\server\mary and will need
7596 to supply a password suitable for mary not fred. The only exception
7597 to this is the username passed to a Domain Controller (if you have
7598 one). The DC will receive whatever username the client supplies
7599 without modification.
7600 Also note that no reverse mapping is done. The main effect this has
7602 is with printing. Users who have been mapped may have trouble
7603 deleting print jobs as PrintManager under WfWg will think they
7604 don´t own the print job.
7605 Samba versions prior to 3.0.8 would only support reading the fully
7607 qualified username (e.g.: DOMAIN\user) from the username map when
7608 performing a kerberos login from a client. However, when looking up
7609 a map entry for a user authenticated by NTLM[SSP], only the login
7610 name would be used for matches. This resulted in inconsistent
7611 behavior sometimes even on the same server.
7612 The following functionality is obeyed in version 3.0.8 and later:
7614 When performing local authentication, the username map is applied
7616 to the login name before attempting to authenticate the connection.
7617 When relying upon a external domain controller for validating
7619 authentication requests, smbd will apply the username map to the
7620 fully qualified username (i.e. DOMAIN\user) only after the user
7621 has been successfully authenticated.
7622 An example of use is:
7624 username map = /usr/local/samba/lib/users.map
7626 Default: username map = # no username map
7628 username map cache time (G)
7630 Mapping usernames with the username map or username map script
7632 features of Samba can be relatively expensive. During login of a
7633 user, the mapping is done several times. In particular, calling the
7634 username map script can slow down logins if external databases have
7635 to be queried from the script being called.
7636 The parameter username map cache time controls a mapping cache. It
7638 specifies the number of seconds a mapping from the username map
7639 file or script is to be efficiently cached. The default of 0 means
7640 no caching is done.
7641 Default: username map cache time = 0
7643 Example: username map cache time = 60
7645 username map script (G)
7647 This script is a mutually exclusive alternative to the username map
7649 parameter. This parameter specifies and external program or script
7650 that must accept a single command line option (the username
7651 transmitted in the authentication request) and return a line on
7652 standard output (the name to which the account should mapped). In
7653 this way, it is possible to store username map tables in an LDAP or
7654 NIS directory services.
7655 Default: username map script =
7657 Example: username map script = /etc/samba/scripts/mapusers.sh
7659 valid users (S)
7661 This is a list of users that should be allowed to login to this
7663 service. Names starting with ´@´, ´+´ and ´&´ are interpreted using
7664 the same rules as described in the invalid users parameter.
7665 If this is empty (the default) then any user can login. If a
7667 username is in both this list and the invalid users list then
7668 access is denied for that user.
7669 The current servicename is substituted for %S. This is useful in
7671 the [homes] section.
7672 Note: When used in the [global] section this parameter may have
7674 unwanted side effects. For example: If samba is configured as a
7675 MASTER BROWSER (see local master, os level, domain master,
7676 preferred master) this option will prevent workstations from being
7677 able to browse the network.
7678 Default: valid users = # No valid users list (anyone can login)
7680 Example: valid users = greg, @pcusers
7682 writable
7684 This parameter is a synonym for writeable.
7686 writeable (S)
7688 Inverted synonym for read only.
7690 Default: writeable = no
7692 write list (S)
7694 This is a list of users that are given read-write access to a
7696 service. If the connecting user is in this list then they will be
7697 given write access, no matter what the read only option is set to.
7698 The list can include group names using the @group syntax.
7699 Note that if a user is in both the read list and the write list
7701 then they will be given write access.
7702 Default: write list =
7704 Example: write list = admin, root, @staff
7706 aio read size (S)
7708 If Samba has been built with asynchronous I/O support and this
7710 integer parameter is set to non-zero value, Samba will read from
7711 file asynchronously when size of request is bigger than this value.
7712 Note that it happens only for non-chained and non-chaining reads
7713 and when not using write cache.
7714 Current implementation of asynchronous I/O in Samba 3.0 does
7716 support only up to 10 outstanding asynchronous requests, read and
7717 write combined.
7718 Related command: write cache size
7720 Related command: aio write size
7722 Default: aio read size = 0
7724 Example: aio read size = 16384 # Use asynchronous I/O for reads
7726 bigger than 16KB request size
7727 aio write behind (S)
7729 If Samba has been built with asynchronous I/O support, Samba will
7731 not wait until write requests are finished before returning the
7732 result to the client for files listed in this parameter. Instead,
7733 Samba will immediately return that the write request has been
7734 finished successfully, no matter if the operation will succeed or
7735 not. This might speed up clients without aio support, but is really
7736 dangerous, because data could be lost and files could be damaged.
7737 The syntax is identical to the veto files parameter.
7739 Default: aio write behind =
7741 Example: aio write behind = /*.tmp/
7743 aio write size (S)
7745 If Samba has been built with asynchronous I/O support and this
7747 integer parameter is set to non-zero value, Samba will write to
7748 file asynchronously when size of request is bigger than this value.
7749 Note that it happens only for non-chained and non-chaining reads
7750 and when not using write cache.
7751 Current implementation of asynchronous I/O in Samba 3.0 does
7753 support only up to 10 outstanding asynchronous requests, read and
7754 write combined.
7755 Related command: write cache size
7757 Related command: aio read size
7759 Default: aio write size = 0
7761 Example: aio write size = 16384 # Use asynchronous I/O for writes
7763 bigger than 16KB request size
7764 allocation roundup size (S)
7766 This parameter allows an administrator to tune the allocation size
7768 reported to Windows clients. The default size of 1Mb generally
7769 results in improved Windows client performance. However, rounding
7770 the allocation size may cause difficulties for some applications,
7771 e.g. MS Visual Studio. If the MS Visual Studio compiler starts to
7772 crash with an internal error, set this parameter to zero for this
7773 share.
7774 The integer parameter specifies the roundup size in bytes.
7776 Default: allocation roundup size = 1048576
7778 Example: allocation roundup size = 0 # (to disable roundups)
7780 block size (S)
7782 This parameter controls the behavior of smbd(8) when reporting disk
7784 free sizes. By default, this reports a disk block size of 1024
7785 bytes.
7786 Changing this parameter may have some effect on the efficiency of
7788 client writes, this is not yet confirmed. This parameter was added
7789 to allow advanced administrators to change it (usually to a higher
7790 value) and test the effect it has on client write performance
7791 without re-compiling the code. As this is an experimental option it
7792 may be removed in a future release.
7793 Changing this option does not change the disk free reporting size,
7795 just the block size unit reported to the client.
7796 Default: block size = 1024
7798 Example: block size = 4096
7800 deadtime (G)
7802 The value of the parameter (a decimal integer) represents the
7804 number of minutes of inactivity before a connection is considered
7805 dead, and it is disconnected. The deadtime only takes effect if the
7806 number of open files is zero.
7807 This is useful to stop a server´s resources being exhausted by a
7809 large number of inactive connections.
7810 Most clients have an auto-reconnect feature when a connection is
7812 broken so in most cases this parameter should be transparent to
7813 users.
7814 Using this parameter with a timeout of a few minutes is recommended
7816 for most systems.
7817 A deadtime of zero indicates that no auto-disconnection should be
7819 performed.
7820 Default: deadtime = 0
7822 Example: deadtime = 15
7824 getwd cache (G)
7826 This is a tuning option. When this is enabled a caching algorithm
7828 will be used to reduce the time taken for getwd() calls. This can
7829 have a significant impact on performance, especially when the wide
7830 smbconfoptions parameter is set to no.
7831 Default: getwd cache = yes
7833 hostname lookups (G)
7835 Specifies whether samba should use (expensive) hostname lookups or
7837 use the ip addresses instead. An example place where hostname
7838 lookups are currently used is when checking the hosts deny and
7839 hosts allow.
7840 Default: hostname lookups = no
7842 Example: hostname lookups = yes
7844 keepalive (G)
7846 The value of the parameter (an integer) represents the number of
7848 seconds between keepalive packets. If this parameter is zero, no
7849 keepalive packets will be sent. Keepalive packets, if sent, allow
7850 the server to tell whether a client is still present and
7851 responding.
7852 Keepalives should, in general, not be needed if the socket has the
7854 SO_KEEPALIVE attribute set on it by default. (see socket options).
7855 Basically you should only use this option if you strike
7856 difficulties.
7857 Please note this option only applies to SMB1 client connections,
7859 and has no effect on SMB2 clients.
7860 Default: keepalive = 300
7862 Example: keepalive = 600
7864 max connections (S)
7866 This option allows the number of simultaneous connections to a
7868 service to be limited. If max connections is greater than 0 then
7869 connections will be refused if this number of connections to the
7870 service are already open. A value of zero mean an unlimited number
7871 of connections may be made.
7872 Record lock files are used to implement this feature. The lock
7874 files will be stored in the directory specified by the lock
7875 directory option.
7876 Default: max connections = 0
7878 Example: max connections = 10
7880 max disk size (G)
7882 This option allows you to put an upper limit on the apparent size
7884 of disks. If you set this option to 100 then all shares will appear
7885 to be not larger than 100 MB in size.
7886 Note that this option does not limit the amount of data you can put
7888 on the disk. In the above case you could still store much more than
7889 100 MB on the disk, but if a client ever asks for the amount of
7890 free disk space or the total disk size then the result will be
7891 bounded by the amount specified in max disk size.
7892 This option is primarily useful to work around bugs in some pieces
7894 of software that can´t handle very large disks, particularly disks
7895 over 1GB in size.
7896 A max disk size of 0 means no limit.
7898 Default: max disk size = 0
7900 Example: max disk size = 1000
7902 max open files (G)
7904 This parameter limits the maximum number of open files that one
7906 smbd(8) file serving process may have open for a client at any one
7907 time. This parameter can be set very high (16384) as Samba uses
7908 only one bit per unopened file. Setting this parameter lower than
7909 16384 will cause Samba to complain and set this value back to the
7910 minimum of 16384, as Windows 7 depends on this number of open file
7911 handles being available.
7912 The limit of the number of open files is usually set by the UNIX
7914 per-process file descriptor limit rather than this parameter so you
7915 should never need to touch this parameter.
7916 Default: max open files = 16384
7918 max smbd processes (G)
7920 This parameter limits the maximum number of smbd(8) processes
7922 concurrently running on a system and is intended as a stopgap to
7923 prevent degrading service to clients in the event that the server
7924 has insufficient resources to handle more than this number of
7925 connections. Remember that under normal operating conditions, each
7926 user will have an smbd(8) associated with him or her to handle
7927 connections to all shares from a given host.
7928 Default: max smbd processes = 0
7930 Example: max smbd processes = 1000
7932 min print space (S)
7934 This sets the minimum amount of free disk space that must be
7936 available before a user will be able to spool a print job. It is
7937 specified in kilobytes. The default is 0, which means a user can
7938 always spool a print job.
7939 Default: min print space = 0
7941 Example: min print space = 2000
7943 name cache timeout (G)
7945 Specifies the number of seconds it takes before entries in samba´s
7947 hostname resolve cache time out. If the timeout is set to 0. the
7948 caching is disabled.
7949 Default: name cache timeout = 660
7951 Example: name cache timeout = 0
7953 socket options (G)
7955 Warning
7957 Modern server operating systems are tuned for high network
7958 performance in the majority of situations; when you set socket
7959 options you are overriding those settings. Linux in particular
7960 has an auto-tuning mechanism for buffer sizes that will be
7961 disabled if you specify a socket buffer size. This can
7962 potentially cripple your TCP/IP stack.
7963 Getting the socket options correct can make a big difference to
7965 your performance, but getting them wrong can degrade it by just
7966 as much. As with any other low level setting, if you must make
7967 changes to it, make small changes and test the effect before
7968 making any large changes.
7969 This option allows you to set socket options to be used when
7971 talking with the client.
7972 Socket options are controls on the networking layer of the
7974 operating systems which allow the connection to be tuned.
7975 This option will typically be used to tune your Samba server for
7977 optimal performance for your local network. There is no way that
7978 Samba can know what the optimal parameters are for your net, so you
7979 must experiment and choose them yourself. We strongly suggest you
7980 read the appropriate documentation for your operating system first
7981 (perhaps man setsockopt will help).
7982 You may find that on some systems Samba will say "Unknown socket
7984 option" when you supply an option. This means you either
7985 incorrectly typed it or you need to add an include file to
7986 includes.h for your OS. If the latter is the case please send the
7987 patch to samba-technical@samba.org.
7988 Any of the supported socket options may be combined in any way you
7990 like, as long as your OS allows it.
7991 This is the list of socket options currently settable using this
7993 option:
7994 · SO_KEEPALIVE
7996 · SO_REUSEADDR
7998 · SO_BROADCAST
8000 · TCP_NODELAY
8002 · IPTOS_LOWDELAY
8004 · IPTOS_THROUGHPUT
8006 · SO_SNDBUF *
8008 · SO_RCVBUF *
8010 · SO_SNDLOWAT *
8012 · SO_RCVLOWAT *
8014 Those marked with a ´*´ take an integer argument. The others can
8016 optionally take a 1 or 0 argument to enable or disable the option, by
8017 default they will be enabled if you don´t specify 1 or 0.
8018 To specify an argument use the syntax SOME_OPTION = VALUE for example
8020 SO_SNDBUF = 8192. Note that you must not have any spaces before or
8021 after the = sign.
8022 If you are on a local network then a sensible option might be:
8024 socket options = IPTOS_LOWDELAY
8026 If you have a local network then you could try:
8028 socket options = IPTOS_LOWDELAY TCP_NODELAY
8030 If you are on a wide area network then perhaps try setting
8032 IPTOS_THROUGHPUT.
8033 Note that several of the options may cause your Samba server to fail
8035 completely. Use these options with caution!
8036 Default: socket options = TCP_NODELAY
8038 Example: socket options = IPTOS_LOWDELAY
8040 strict allocate (S)
8042 This is a boolean that controls the handling of disk space
8044 allocation in the server. When this is set to yes the server will
8045 change from UNIX behaviour of not committing real disk storage
8046 blocks when a file is extended to the Windows behaviour of actually
8047 forcing the disk system to allocate real storage blocks when a file
8048 is created or extended to be a given size. In UNIX terminology this
8049 means that Samba will stop creating sparse files.
8050 This option is really designed for file systems that support fast
8052 allocation of large numbers of blocks such as extent-based file
8053 systems. On file systems that don´t support extents (most notably
8054 ext3) this can make Samba slower. When you work with large files
8055 over >100MB on file systems without extents you may even run into
8056 problems with clients running into timeouts.
8057 When you have an extent based filesystem it´s likely that we can
8059 make use of unwritten extents which allows Samba to allocate even
8060 large amounts of space very fast and you will not see any timeout
8061 problems caused by strict allocate. With strict allocate in use you
8062 will also get much better out of quota messages in case you use
8063 quotas. Another advantage of activating this setting is that it
8064 will help to reduce file fragmentation.
8065 To give you an idea on which filesystems this setting might
8067 currently be a good option for you: XFS, ext4, btrfs, ocfs2 on
8068 Linux and JFS2 on AIX support unwritten extents. On Filesystems
8069 that do not support it, preallocation is probably an expensive
8070 operation where you will see reduced performance and risk to let
8071 clients run into timeouts when creating large files. Examples are
8072 ext3, ZFS, HFS+ and most others, so be aware if you activate this
8073 setting on those filesystems.
8074 Default: strict allocate = no
8076 strict rename (S)
8078 By default a Windows SMB server prevents directory renames when
8080 there are open file or directory handles below it in the filesystem
8081 hierarchy. Historically Samba has always allowed this as POSIX
8082 filesystem semantics require it.
8083 This boolean parameter allows Samba to match the Windows behavior.
8085 Setting this to "yes" is a very expensive change, as it forces
8086 Samba to travers the entire open file handle database on every
8087 directory rename request. In a clustered Samba system the cost is
8088 even greater than the non-clustered case.
8089 For this reason the default is "no", and it is recommended to be
8091 left that way unless a specific Windows application requires it to
8092 be changed.
8093 Default: strict rename = no
8095 strict sync (S)
8097 Many Windows applications (including the Windows 98 explorer shell)
8099 seem to confuse flushing buffer contents to disk with doing a sync
8100 to disk. Under UNIX, a sync call forces the process to be suspended
8101 until the kernel has ensured that all outstanding data in kernel
8102 disk buffers has been safely stored onto stable storage. This is
8103 very slow and should only be done rarely. Setting this parameter to
8104 no (the default) means that smbd(8) ignores the Windows
8105 applications requests for a sync call. There is only a possibility
8106 of losing data if the operating system itself that Samba is running
8107 on crashes, so there is little danger in this default setting. In
8108 addition, this fixes many performance problems that people have
8109 reported with the new Windows98 explorer shell file copies.
8110 Default: strict sync = no
8112 sync always (S)
8114 This is a boolean parameter that controls whether writes will
8116 always be written to stable storage before the write call returns.
8117 If this is no then the server will be guided by the client´s
8118 request in each write call (clients can set a bit indicating that a
8119 particular write should be synchronous). If this is yes then every
8120 write will be followed by a fsync() call to ensure the data is
8121 written to disk. Note that the strict sync parameter must be set to
8122 yes in order for this parameter to have any effect.
8123 Default: sync always = no
8125 use mmap (G)
8127 This global parameter determines if the tdb internals of Samba can
8129 depend on mmap working correctly on the running system. Samba
8130 requires a coherent mmap/read-write system memory cache. Currently
8131 only HPUX does not have such a coherent cache, and so this
8132 parameter is set to no by default on HPUX. On all other systems
8133 this parameter should be left alone. This parameter is provided to
8134 help the Samba developers track down problems with the tdb internal
8135 code.
8136 Default: use mmap = yes
8138 use ntdb (G)
8140 Beginning in Samba 4.1, a growing number of databases can use the
8142 NTDB format rather than TDB.
8143 If you enable this option these databases will default to a .ntdb
8145 extension rather than .tdb. If the .tdb file exists, it will
8146 automatically be converted to NTDB and renamed to .tdb.bak.
8147 Filenames explicitly specified in smb.conf will be respected (i.e.
8149 the format will depend on the .ntdb or .tdb extension).
8150 Default: use ntdb = no
8152 use sendfile (S)
8154 If this parameter is yes, and the sendfile() system call is
8156 supported by the underlying operating system, then some SMB read
8157 calls (mainly ReadAndX and ReadRaw) will use the more efficient
8158 sendfile system call for files that are exclusively oplocked. This
8159 may make more efficient use of the system CPU´s and cause Samba to
8160 be faster. Samba automatically turns this off for clients that use
8161 protocol levels lower than NT LM 0.12 and when it detects a client
8162 is Windows 9x (using sendfile from Linux will cause these clients
8163 to fail).
8164 Default: use sendfile = no
8166 write cache size (S)
8168 If this integer parameter is set to non-zero value, Samba will
8170 create an in-memory cache for each oplocked file (it does not do
8171 this for non-oplocked files). All writes that the client does not
8172 request to be flushed directly to disk will be stored in this cache
8173 if possible. The cache is flushed onto disk when a write comes in
8174 whose offset would not fit into the cache or when the file is
8175 closed by the client. Reads for the file are also served from this
8176 cache if the data is stored within it.
8177 This cache allows Samba to batch client writes into a more
8179 efficient write size for RAID disks (i.e. writes may be tuned to be
8180 the RAID stripe size) and can improve performance on systems where
8181 the disk subsystem is a bottleneck but there is free memory for
8182 userspace programs.
8183 The integer parameter specifies the size of this cache (per
8185 oplocked file) in bytes.
8186 Note that the write cache won´t be used for file handles with a
8188 smb2 write lease.
8189 Default: write cache size = 0
8191 Example: write cache size = 262144 # for a 256k cache size per file
8193 get quota command (G)
8195 The get quota command should only be used whenever there is no
8197 operating system API available from the OS that samba can use.
8198 This option is only available Samba was compiled with quotas
8200 support.
8201 This parameter should specify the path to a script that queries the
8203 quota information for the specified user/group for the partition
8204 that the specified directory is on.
8205 Such a script is being given 3 arguments:
8207 · directory
8209 · type of query
8211 · uid of user or gid of group
8213 The directory is actually mostly just "." - It needs to be treated
8215 relatively to the current working directory that the script can also
8216 query.
8217 The type of query can be one of:
8219 · 1 - user quotas
8221 · 2 - user default quotas (uid = -1)
8223 · 3 - group quotas
8225 · 4 - group default quotas (gid = -1)
8227 This script should print one line as output with spaces between the
8229 columns. The printed columns should be:
8230 · 1 - quota flags (0 = no quotas, 1 = quotas enabled, 2 = quotas
8232 enabled and enforced)
8233 · 2 - number of currently used blocks
8235 · 3 - the softlimit number of blocks
8237 · 4 - the hardlimit number of blocks
8239 · 5 - currently used number of inodes
8241 · 6 - the softlimit number of inodes
8243 · 7 - the hardlimit number of inodes
8245 · 8 (optional) - the number of bytes in a block(default is 1024)
8247 Default: get quota command =
8249 Example: get quota command = /usr/local/sbin/query_quota
8251 host msdfs (G)
8253 If set to yes, Samba will act as a Dfs server, and allow Dfs-aware
8255 clients to browse Dfs trees hosted on the server.
8256 See also the msdfs root share level parameter. For more information
8258 on setting up a Dfs tree on Samba, refer to the MSFDS chapter in
8259 the book Samba3-HOWTO.
8260 Default: host msdfs = yes
8262 msdfs proxy (S)
8264 This parameter indicates that the share is a stand-in for another
8266 CIFS share whose location is specified by the value of the
8267 parameter. When clients attempt to connect to this share, they are
8268 redirected to one or multiple, comma separated proxied shares using
8269 the SMB-Dfs protocol.
8270 Only Dfs roots can act as proxy shares. Take a look at the msdfs
8272 root and host msdfs options to find out how to set up a Dfs root
8273 share.
8274 No default
8276 Example: msdfs proxy =
8278 \otherserver\someshare,\otherserver2\someshare
8279 msdfs root (S)
8281 If set to yes, Samba treats the share as a Dfs root and allows
8283 clients to browse the distributed file system tree rooted at the
8284 share directory. Dfs links are specified in the share directory by
8285 symbolic links of the form msdfs:serverA\\shareA,serverB\\shareB
8286 and so on. For more information on setting up a Dfs tree on Samba,
8287 refer to the MSDFS chapter in the Samba3-HOWTO book.
8288 Default: msdfs root = no
8290 ntvfs handler (S)
8292 This specifies the NTVFS handlers for this share.
8294 · posix: Maps POSIX FS semantics to NT semantics
8296 · unixuid: Sets up user credentials based on POSIX gid/uid.
8298 · cifs: Proxies a remote CIFS FS. Mainly useful for testing.
8300 · nbench: Filter module that saves data useful to the nbench
8302 benchmark suite.
8303 · ipc: Allows using SMB for inter process communication. Only
8305 used for the IPC$ share.
8306 · posix: Maps POSIX FS semantics to NT semantics
8308 · print: Allows printing over SMB. This is LANMAN-style printing,
8310 not the be confused with the spoolss DCE/RPC interface used by
8311 later versions of Windows.
8312 Note that this option is only used when the NTVFS file server is in
8314 use. It is not used with the (default) s3fs file server.
8315 Default: ntvfs handler = unixuid, default
8317 set quota command (G)
8319 The set quota command should only be used whenever there is no
8321 operating system API available from the OS that samba can use.
8322 This option is only available if Samba was compiled with quota
8324 support.
8325 This parameter should specify the path to a script that can set
8327 quota for the specified arguments.
8328 The specified script should take the following arguments:
8330 · 1 - path to where the quota needs to be set. This needs to be
8332 interpreted relative to the current working directory that the
8333 script may also check for.
8334 · 2 - quota type
8336 · 1 - user quotas
8338 · 2 - user default quotas (uid = -1)
8340 · 3 - group quotas
8342 · 4 - group default quotas (gid = -1)
8344 · 3 - id (uid for user, gid for group, -1 if N/A)
8347 · 4 - quota state (0 = disable, 1 = enable, 2 = enable and enforce)
8349 · 5 - block softlimit
8351 · 6 - block hardlimit
8353 · 7 - inode softlimit
8355 · 8 - inode hardlimit
8357 · 9(optional) - block size, defaults to 1024
8359 The script should output at least one line of data on success. And
8361 nothing on failure.
8362 Default: set quota command =
8364 Example: set quota command = /usr/local/sbin/set_quota
8366 vfs object
8368 This parameter is a synonym for vfs objects.
8370 vfs objects (S)
8372 This parameter specifies the backend names which are used for Samba
8374 VFS I/O operations. By default, normal disk I/O operations are used
8375 but these can be overloaded with one or more VFS objects.
8376 Default: vfs objects =
8378 Example: vfs objects = extd_audit recycle
8380 create krb5 conf (G)
8382 Setting this parameter to no prevents winbind from creating custom
8384 krb5.conf files. Winbind normally does this because the krb5
8385 libraries are not AD-site-aware and thus would pick any domain
8386 controller out of potentially very many. Winbind is site-aware and
8387 makes the krb5 libraries use a local DC by creating its own
8388 krb5.conf files.
8389 Preventing winbind from doing this might become necessary if you
8391 have to add special options into your system-krb5.conf that winbind
8392 does not see.
8393 Default: create krb5 conf = yes
8395 idmap backend (G)
8397 The idmap backend provides a plugin interface for Winbind to use
8399 varying backends to store SID/uid/gid mapping tables.
8400 This option specifies the default backend that is used when no
8402 special configuration set, but it is now deprecated in favour of
8403 the new spelling idmap config * : backend.
8404 Default: idmap backend = tdb
8406 idmap cache time (G)
8408 This parameter specifies the number of seconds that Winbind´s idmap
8410 interface will cache positive SID/uid/gid query results. By
8411 default, Samba will cache these results for one week.
8412 Default: idmap cache time = 604800
8414 idmap config:OPTION (G)
8416 ID mapping in Samba is the mapping between Windows SIDs and Unix
8418 user and group IDs. This is performed by Winbindd with a
8419 configurable plugin interface. Samba´s ID mapping is configured by
8420 options starting with the idmap config prefix. An idmap option
8421 consists of the idmap config prefix, followed by a domain name or
8422 the asterisk character (*), a colon, and the name of an idmap
8423 setting for the chosen domain.
8424 The idmap configuration is hence divided into groups, one group for
8426 each domain to be configured, and one group with the asterisk
8427 instead of a proper domain name, which specifies the default
8428 configuration that is used to catch all domains that do not have an
8429 explicit idmap configuration of their own.
8430 There are three general options available:
8432 backend = backend_name
8434 This specifies the name of the idmap plugin to use as the
8435 SID/uid/gid backend for this domain. The standard backends are
8436 tdb (idmap_tdb(8)), tdb2 (idmap_tdb2(8)), ldap (idmap_ldap(8)),
8437 rid (idmap_rid(8)), hash (idmap_hash(8)), autorid
8438 (idmap_autorid(8)), ad (idmap_ad(8)) and nss (idmap_nss(8)).
8439 The corresponding manual pages contain the details, but here is
8440 a summary.
8441 The first three of these create mappings of their own using
8443 internal unixid counters and store the mappings in a database.
8444 These are suitable for use in the default idmap configuration.
8445 The rid and hash backends use a pure algorithmic calculation to
8446 determine the unixid for a SID. The autorid module is a mixture
8447 of the tdb and rid backend. It creates ranges for each domain
8448 encountered and then uses the rid algorithm for each of these
8449 automatically configured domains individually. The ad backend
8450 uses unix ids stored in Active Directory via the standard
8451 schema extensions. The nss backend reverses the standard
8452 winbindd setup and gets the unix ids via names from nsswitch
8453 which can be useful in an ldap setup.
8454 range = low - high
8456 Defines the available matching uid and gid range for which the
8457 backend is authoritative. For allocating backends, this also
8458 defines the start and the end of the range for allocating new
8459 unique IDs.
8460 winbind uses this parameter to find the backend that is
8462 authoritative for a unix ID to SID mapping, so it must be set
8463 for each individually configured domain and for the default
8464 configuration. The configured ranges must be mutually disjoint.
8465 read only = yes|no
8467 This option can be used to turn the writing backends tdb, tdb2,
8468 and ldap into read only mode. This can be useful e.g. in cases
8469 where a pre-filled database exists that should not be extended
8470 automatically.
8471 The following example illustrates how to configure the idmap_ad(8)
8473 backend for the CORP domain and the idmap_tdb(8) backend for all
8474 other domains. This configuration assumes that the admin of CORP
8475 assigns unix ids below 1000000 via the SFU extensions, and winbind
8476 is supposed to use the next million entries for its own mappings
8477 from trusted domains and for local groups for example.
8478 idmap config * : backend = tdb
8480 idmap config * : range = 1000000-1999999
8481 idmap config CORP : backend = ad
8483 idmap config CORP : range = 1000-999999
8484 No default
8487 winbind gid
8489 This parameter is a synonym for idmap gid.
8491 idmap gid (G)
8493 The idmap gid parameter specifies the range of group ids for the
8495 default idmap configuration. It is now deprecated in favour of
8496 idmap config * : range.
8497 See the idmap config option.
8499 Default: idmap gid =
8501 Example: idmap gid = 10000-20000
8503 idmap negative cache time (G)
8505 This parameter specifies the number of seconds that Winbind´s idmap
8507 interface will cache negative SID/uid/gid query results.
8508 Default: idmap negative cache time = 120
8510 winbind uid
8512 This parameter is a synonym for idmap uid.
8514 idmap uid (G)
8516 The idmap uid parameter specifies the range of user ids for the
8518 default idmap configuration. It is now deprecated in favour of
8519 idmap config * : range.
8520 See the idmap config option.
8522 Default: idmap uid =
8524 Example: idmap uid = 10000-20000
8526 neutralize nt4 emulation (G)
8528 This option controls whether winbindd sends the
8530 NETLOGON_NEG_NEUTRALIZE_NT4_EMULATION flag in order to bypass the
8531 NT4 emulation of a domain controller.
8532 Typically you should not need set this. It can be useful for
8534 upgrades from NT4 to AD domains.
8535 The behavior can be controlled per netbios domain by using
8537 ´neutralize nt4 emulation:NETBIOSDOMAIN = yes´ as option.
8538 Default: neutralize nt4 emulation = no
8540 reject md5 servers (G)
8542 This option controls whether winbindd requires support for aes
8544 support for the netlogon secure channel.
8545 The following flags will be required NETLOGON_NEG_ARCFOUR,
8547 NETLOGON_NEG_SUPPORTS_AES, NETLOGON_NEG_PASSWORD_SET2 and
8548 NETLOGON_NEG_AUTHENTICATED_RPC.
8549 You can set this to yes if all domain controllers support aes. This
8551 will prevent downgrade attacks.
8552 The behavior can be controlled per netbios domain by using ´reject
8554 md5 servers:NETBIOSDOMAIN = yes´ as option.
8555 This option takes precedence to the require strong key option.
8557 Default: reject md5 servers = no
8559 require strong key (G)
8561 This option controls whether winbindd requires support for md5
8563 strong key support for the netlogon secure channel.
8564 The following flags will be required NETLOGON_NEG_STRONG_KEYS,
8566 NETLOGON_NEG_ARCFOUR and NETLOGON_NEG_AUTHENTICATED_RPC.
8567 You can set this to no if some domain controllers only support des.
8569 This might allows weak crypto to be negotiated, may via downgrade
8570 attacks.
8571 The behavior can be controlled per netbios domain by using ´require
8573 strong key:NETBIOSDOMAIN = no´ as option.
8574 Note for active directory domain this option is hardcoded to ´yes´
8576 This option yields precedence to the reject md5 servers option.
8578 This option takes precedence to the client schannel option.
8580 Default: require strong key = yes
8582 template homedir (G)
8584 When filling out the user information for a Windows NT user, the
8586 winbindd(8) daemon uses this parameter to fill in the home
8587 directory for that user. If the string %D is present it is
8588 substituted with the user´s Windows NT domain name. If the string
8589 %U is present it is substituted with the user´s Windows NT user
8590 name.
8591 Default: template homedir = /home/%D/%U
8593 template shell (G)
8595 When filling out the user information for a Windows NT user, the
8597 winbindd(8) daemon uses this parameter to fill in the login shell
8598 for that user.
8599 Default: template shell = /bin/false
8601 winbind cache time (G)
8603 This parameter specifies the number of seconds the winbindd(8)
8605 daemon will cache user and group information before querying a
8606 Windows NT server again.
8607 This does not apply to authentication requests, these are always
8609 evaluated in real time unless the winbind offline logon option has
8610 been enabled.
8611 Default: winbind cache time = 300
8613 winbindd privileged socket directory (G)
8615 This setting controls the location of the winbind daemon´s
8617 privileged socket.
8618 Default: winbindd privileged socket directory =
8620 /var/lib/samba/winbindd_privileged
8621 winbindd socket directory (G)
8623 This setting controls the location of the winbind daemon´s socket.
8625 Except within automated test scripts, this should not be altered,
8627 as the client tools (nss_winbind etc) do not honour this parameter.
8628 Client tools must then be advised of the altered path with the
8629 WINBINDD_SOCKET_DIR environment varaible.
8630 Default: winbindd socket directory = /var/run/samba/winbindd
8632 winbind enum groups (G)
8634 On large installations using winbindd(8) it may be necessary to
8636 suppress the enumeration of groups through the setgrent(),
8637 getgrent() and endgrent() group of system calls. If the winbind
8638 enum groups parameter is no, calls to the getgrent() system call
8639 will not return any data.
8640 Warning
8642 Turning off group enumeration may cause some programs to behave
8643 oddly.
8644 Default: winbind enum groups = no
8645 winbind enum users (G)
8647 On large installations using winbindd(8) it may be necessary to
8649 suppress the enumeration of users through the setpwent(),
8650 getpwent() and endpwent() group of system calls. If the winbind
8651 enum users parameter is no, calls to the getpwent system call will
8652 not return any data.
8653 Warning
8655 Turning off user enumeration may cause some programs to behave
8656 oddly. For example, the finger program relies on having access
8657 to the full user list when searching for matching usernames.
8658 Default: winbind enum users = no
8659 winbind expand groups (G)
8661 This option controls the maximum depth that winbindd will traverse
8663 when flattening nested group memberships of Windows domain groups.
8664 This is different from the winbind nested groups option which
8665 implements the Windows NT4 model of local group nesting. The
8666 "winbind expand groups" parameter specifically applies to the
8667 membership of domain groups.
8668 Be aware that a high value for this parameter can result in system
8670 slowdown as the main parent winbindd daemon must perform the group
8671 unrolling and will be unable to answer incoming NSS or
8672 authentication requests during this time.
8673 The default value was changed from 1 to 0 with Samba 4.2. Some
8675 broken applications calculate the group memberships of users by
8676 traversing groups, such applications will require "winbind expand
8677 groups = 1". But the new default makes winbindd more reliable as it
8678 doesn´t require SAMR access to domain controllers of trusted
8679 domains.
8680 Default: winbind expand groups = 0
8682 winbind max clients (G)
8684 This parameter specifies the maximum number of clients the
8686 winbindd(8) daemon can connect with.
8687 Default: winbind max clients = 200
8689 winbind max domain connections (G)
8691 This parameter specifies the maximum number of simultaneous
8693 connections that the winbindd(8) daemon should open to the domain
8694 controller of one domain. Setting this parameter to a value greater
8695 than 1 can improve scalability with many simultaneous winbind
8696 requests, some of which might be slow.
8697 Note that if winbind offline logon is set to Yes, then only one DC
8699 connection is allowed per domain, regardless of this setting.
8700 Default: winbind max domain connections = 1
8702 Example: winbind max domain connections = 10
8704 winbind nested groups (G)
8706 If set to yes, this parameter activates the support for nested
8708 groups. Nested groups are also called local groups or aliases. They
8709 work like their counterparts in Windows: Nested groups are defined
8710 locally on any machine (they are shared between DC´s through their
8711 SAM) and can contain users and global groups from any trusted SAM.
8712 To be able to use nested groups, you need to run nss_winbind.
8713 Default: winbind nested groups = yes
8715 winbind normalize names (G)
8717 This parameter controls whether winbindd will replace whitespace in
8719 user and group names with an underscore (_) character. For example,
8720 whether the name "Space Kadet" should be replaced with the string
8721 "space_kadet". Frequently Unix shell scripts will have difficulty
8722 with usernames contains whitespace due to the default field
8723 separator in the shell. If your domain possesses names containing
8724 the underscore character, this option may cause problems unless the
8725 name aliasing feature is supported by your nss_info plugin.
8726 This feature also enables the name aliasing API which can be used
8728 to make domain user and group names to a non-qualified version.
8729 Please refer to the manpage for the configured idmap and nss_info
8730 plugin for the specifics on how to configure name aliasing for a
8731 specific configuration. Name aliasing takes precedence (and is
8732 mutually exclusive) over the whitespace replacement mechanism
8733 discussed previously.
8734 Default: winbind normalize names = no
8736 Example: winbind normalize names = yes
8738 winbind nss info (G)
8740 This parameter is designed to control how Winbind retrieves Name
8742 Service Information to construct a user´s home directory and login
8743 shell. Currently the following settings are available:
8744 · template - The default, using the parameters of template shell
8746 and template homedir)
8747 · <sfu | sfu20 | rfc2307 > - When Samba is running in security =
8749 ads and your Active Directory Domain Controller does support
8750 the Microsoft "Services for Unix" (SFU) LDAP schema, winbind
8751 can retrieve the login shell and the home directory attributes
8752 directly from your Directory Server. For SFU 3.0 or 3.5 simply
8753 choose "sfu", if you use SFU 2.0 please choose "sfu20". Note
8754 that retrieving UID and GID from your ADS-Server requires to
8755 use idmap config DOMAIN:backend = ad as well. The primary group
8756 membership is currently always calculated via the
8757 "primaryGroupID" LDAP attribute.
8758 Default: winbind nss info = template
8761 Example: winbind nss info = sfu
8763 winbind offline logon (G)
8765 This parameter is designed to control whether Winbind should allow
8767 to login with the pam_winbind module using Cached Credentials. If
8768 enabled, winbindd will store user credentials from successful
8769 logins encrypted in a local cache.
8770 Default: winbind offline logon = no
8772 Example: winbind offline logon = yes
8774 winbind reconnect delay (G)
8776 This parameter specifies the number of seconds the winbindd(8)
8778 daemon will wait between attempts to contact a Domain controller
8779 for a domain that is determined to be down or not contactable.
8780 Default: winbind reconnect delay = 30
8782 winbind refresh tickets (G)
8784 This parameter is designed to control whether Winbind should
8786 refresh Kerberos Tickets retrieved using the pam_winbind module.
8787 Default: winbind refresh tickets = no
8789 Example: winbind refresh tickets = yes
8791 winbind request timeout (G)
8793 This parameter specifies the number of seconds the winbindd(8)
8795 daemon will wait before disconnecting either a client connection
8796 with no outstanding requests (idle) or a client connection with a
8797 request that has remained outstanding (hung) for longer than this
8798 number of seconds.
8799 Default: winbind request timeout = 60
8801 winbind rpc only (G)
8803 Setting this parameter to yes forces winbindd to use RPC instead of
8805 LDAP to retrieve information from Domain Controllers.
8806 Default: winbind rpc only = no
8808 winbind sealed pipes (G)
8810 This option controls whether any requests from winbindd to domain
8812 controllers pipe will be sealed. Disabling sealing can be useful
8813 for debugging purposes.
8814 The behavior can be controlled per netbios domain by using ´winbind
8816 sealed pipes:NETBIOSDOMAIN = no´ as option.
8817 Default: winbind sealed pipes = yes
8819 winbind separator (G)
8821 This parameter allows an admin to define the character used when
8823 listing a username of the form of DOMAIN \user. This parameter is
8824 only applicable when using the pam_winbind.so and nss_winbind.so
8825 modules for UNIX services.
8826 Please note that setting this parameter to + causes problems with
8828 group membership at least on glibc systems, as the character + is
8829 used as a special character for NIS in /etc/group.
8830 Default: winbind separator = \
8832 Example: winbind separator = +
8834 winbind trusted domains only (G)
8836 This parameter is designed to allow Samba servers that are members
8838 of a Samba controlled domain to use UNIX accounts distributed via
8839 NIS, rsync, or LDAP as the uid´s for winbindd users in the hosts
8840 primary domain. Therefore, the user DOMAIN\user1 would be mapped to
8841 the account user1 in /etc/passwd instead of allocating a new uid
8842 for him or her.
8843 This parameter is now deprecated in favor of the newer idmap_nss
8845 backend. Refer to the idmap_nss(8) man page for more information.
8846 Default: winbind trusted domains only = no
8848 winbind use default domain (G)
8850 This parameter specifies whether the winbindd(8) daemon should
8852 operate on users without domain component in their username. Users
8853 without a domain component are treated as is part of the winbindd
8854 server´s own domain. While this does not benefit Windows users, it
8855 makes SSH, FTP and e-mail function in a way much closer to the way
8856 they would in a native unix system.
8857 This option should be avoided if possible. It can cause confusion
8859 about responsibilities for a user or group. In many situations it
8860 is not clear whether winbind or /etc/passwd should be seen as
8861 authoritative for a user, likewise for groups.
8862 Default: winbind use default domain = no
8864 Example: winbind use default domain = yes
8866 dns proxy (G)
8868 Specifies that nmbd(8) when acting as a WINS server and finding
8870 that a NetBIOS name has not been registered, should treat the
8871 NetBIOS name word-for-word as a DNS name and do a lookup with the
8872 DNS server for that name on behalf of the name-querying client.
8873 Note that the maximum length for a NetBIOS name is 15 characters,
8875 so the DNS name (or DNS alias) can likewise only be 15 characters,
8876 maximum.
8877 nmbd spawns a second copy of itself to do the DNS name lookup
8879 requests, as doing a name lookup is a blocking action.
8880 Default: dns proxy = yes
8882 wins hook (G)
8884 When Samba is running as a WINS server this allows you to call an
8886 external program for all changes to the WINS database. The primary
8887 use for this option is to allow the dynamic update of external name
8888 resolution databases such as dynamic DNS.
8889 The wins hook parameter specifies the name of a script or
8891 executable that will be called as follows:
8892 wins_hook operation name nametype ttl IP_list
8894 · The first argument is the operation and is one of "add",
8896 "delete", or "refresh". In most cases the operation can be
8897 ignored as the rest of the parameters provide sufficient
8898 information. Note that "refresh" may sometimes be called when
8899 the name has not previously been added, in that case it should
8900 be treated as an add.
8901 · The second argument is the NetBIOS name. If the name is not a
8903 legal name then the wins hook is not called. Legal names
8904 contain only letters, digits, hyphens, underscores and periods.
8905 · The third argument is the NetBIOS name type as a 2 digit
8907 hexadecimal number.
8908 · The fourth argument is the TTL (time to live) for the name in
8910 seconds.
8911 · The fifth and subsequent arguments are the IP addresses
8913 currently registered for that name. If this list is empty then
8914 the name should be deleted.
8915 An example script that calls the BIND dynamic DNS update program
8917 nsupdate is provided in the examples directory of the Samba source
8918 code.
8919 No default
8921 wins proxy (G)
8923 This is a boolean that controls if nmbd(8) will respond to
8925 broadcast name queries on behalf of other hosts. You may need to
8926 set this to yes for some older clients.
8927 Default: wins proxy = no
8929 wins server (G)
8931 This specifies the IP address (or DNS name: IP address for
8933 preference) of the WINS server that nmbd(8) should register with.
8934 If you have a WINS server on your network then you should set this
8935 to the WINS server´s IP.
8936 You should point this at your WINS server if you have a
8938 multi-subnetted network.
8939 If you want to work in multiple namespaces, you can give every wins
8941 server a ´tag´. For each tag, only one (working) server will be
8942 queried for a name. The tag should be separated from the ip address
8943 by a colon.
8944 Note
8946 You need to set up Samba to point to a WINS server if you have
8947 multiple subnets and wish cross-subnet browsing to work
8948 correctly.
8949 See the chapter in the Samba3-HOWTO on Network Browsing.
8950 Default: wins server =
8952 Example: wins server = mary:192.9.200.1 fred:192.168.3.199
8954 mary:192.168.2.61 # For this example when querying a certain name,
8955 192.19.200.1 will be asked first and if that doesn´t respond
8956 192.168.2.61. If either of those doesn´t know the name
8957 192.168.3.199 will be queried.
8958 Example: wins server = 192.9.200.1 192.168.2.61
8960 wins support (G)
8962 This boolean controls if the nmbd(8) process in Samba will act as a
8964 WINS server. You should not set this to yes unless you have a
8965 multi-subnetted network and you wish a particular nmbd to be your
8966 WINS server. Note that you should NEVER set this to yes on more
8967 than one machine in your network.
8968 Default: wins support = no
8970
8972 Although the configuration file permits service names to contain
8973 spaces, your client software may not. Spaces will be ignored in
8974 comparisons anyway, so it shouldn´t be a problem - but be aware of the
8975 possibility.
8976 On a similar note, many clients - especially DOS clients - limit
8978 service names to eight characters. smbd(8) has no such limitation, but
8979 attempts to connect from such clients will fail if they truncate the
8980 service names. For this reason you should probably keep your service
8981 names down to eight characters in length.
8982 Use of the [homes] and [printers] special sections make life for an
8984 administrator easy, but the various combinations of default attributes
8985 can be tricky. Take extreme care when designing these sections. In
8986 particular, ensure that the permissions on spool directories are
8987 correct.
8988
8990 This man page is correct for version 4 of the Samba suite.
8991
8993 samba(7), smbpasswd(8), smbd(8), nmbd(8), winbindd(8), samba(8), samba-
8994 tool(8), smbclient(1), nmblookup(1), testparm(1).
8995
8997 The original Samba software and related utilities were created by
8998 Andrew Tridgell. Samba is now developed by the Samba Team as an Open
8999 Source project similar to the way the Linux kernel is developed.
9000 The original Samba man pages were written by Karl Auer. The man page
9002 sources were converted to YODL format (another excellent piece of Open
9003 Source software, available at ftp://ftp.icce.rug.nl/pub/unix/) and
9004 updated for the Samba 2.0 release by Jeremy Allison. The conversion to
9005 DocBook for Samba 2.2 was done by Gerald Carter. The conversion to
9006 DocBook XML 4.2 for Samba 3.0 was done by Alexander Bokovoy.
9007Samba 4.2 06/19/2018 SMB.CONF(5)