Samba Unix Settings Scripts Daily Hourly Monthly Weekly Sudo Rights This policy setting allows you to execute commands, either local or on remote storage, daily. This policy setting allows you to execute commands, either local or on remote storage, hourly. This policy setting allows you to execute commands, either local or on remote storage, monthly. This policy setting allows you to execute commands, either local or on remote storage, weekly. This policy configures the sudoers file with the lines specified. smb.conf additional dns hostnames A list of additional DNS names by which this host can be identified Example: host2.example.com host3.other.com bind interfaces only This global parameter allows the Samba admin to limit what interfaces on a machine will serve SMB requests. It affects file service smbd 8 and name service nmbd 8 in a slightly different ways. For name service it causes nmbd to bind to ports 137 and 138 on the interfaces listed in the parameter. nmbd also binds to the "all addresses" interface (0.0.0.0) on ports 137 and 138 for the purposes of reading broadcast messages. If this option is not set then nmbd will service name requests on all of these sockets. If is set then nmbd will check the source address of any packets coming in on the broadcast sockets and discard any that don't match the broadcast addresses of the interfaces in the parameter list. As unicast packets are received on the other sockets it allows nmbd to refuse to serve names to machines that send packets that arrive through any interfaces not listed in the list. IP Source address spoofing does defeat this simple check, however, so it must not be used seriously as a security feature for nmbd. For file service it causes smbd 8 to bind only to the interface list given in the parameter. This restricts the networks that smbd will serve, to packets coming in on those interfaces. Note that you should not use this parameter for machines that are serving PPP or other intermittent or non-broadcast network interfaces as it will not cope with non-permanent interfaces. If is set and the network address 127.0.0.1 is not added to the parameter list smbpasswd 8 may not work as expected due to the reasons covered below. To change a users SMB password, the smbpasswd by default connects to the localhost - 127.0.0.1 address as an SMB client to issue the password change request. If is set then unless the network address 127.0.0.1 is added to the parameter list then smbpasswd will fail to connect in it's default mode. smbpasswd can be forced to use the primary IP interface of the local host by using its smbpasswd 8 -r remote machine parameter, with remote machine set to the IP name of the primary interface of the local host. config backend This controls the backend for storing the configuration. Possible values are file (the default) and registry. When registry is encountered while loading smb.conf, the configuration read so far is dropped and the global options are read from registry instead. So this triggers a registry only configuration. Share definitions are not read immediately but instead registry shares is set to yes. Note: This option can not be set inside the registry configuration itself. Example: registry dos charset DOS SMB clients assume the server has the same charset as they do. This option specifies which charset Samba should talk to DOS clients. The default depends on which charsets you have installed. Samba tries to use charset 850 but falls back to ASCII in case it is not available. Run testparm 1 to check the default on your system. enable core files This parameter specifies whether core dumps should be written on internal exits. Normally set to yes. You should never need to change this. Example: no mdns name This parameter controls the name that multicast DNS support advertises as its' hostname. The default is to use the NETBIOS name which is typically the hostname in all capital letters. A setting of mdns will defer the hostname configuration to the MDNS library that is used. multicast dns register If compiled with proper support for it, Samba will announce itself with multicast DNS services like for example provided by the Avahi daemon. This parameter allows disabling Samba to register itself. netbios aliases This is a list of NetBIOS names that nmbd will advertise as additional names by which the Samba server is known. This allows one machine to appear in browse lists under multiple names. If a machine is acting as a browse server or logon server none of these names will be advertised as either browse server or logon servers, only the primary name of the machine will be advertised with these capabilities. Example: TEST TEST1 TEST2 netbios name This sets the NetBIOS name by which a Samba server is known. By default it is the same as the first component of the host's DNS name. If a machine is a browse server or logon server this name (or the first component of the hosts DNS name) will be the name that these services are advertised under. Note that the maximum length for a NetBIOS name is 15 characters. There is a bug in Samba that breaks operation of browsing and access to shares if the netbios name is set to the literal name PIPE. To avoid this problem, do not name your Samba server PIPE. Example: MYNAME netbios scope This sets the NetBIOS scope that Samba will operate under. This should not be set unless every machine on your LAN also sets this value. prefork backoff increment This option specifies the number of seconds added to the delay before a prefork master or worker process is restarted. The restart is initially zero, the prefork backoff increment is added to the delay on each restart up to the value specified by "prefork maximum backoff". Additionally the the backoff for an individual service by using "prefork backoff increment: service name" i.e. "prefork backoff increment:ldap = 2" to set the backoff increment to 2. If the backoff increment is 2 and the maximum backoff is 5. There will be a zero second delay for the first restart. A two second delay for the second restart. A four second delay for the third and any subsequent restarts prefork children This option controls the number of worker processes that are started for each service when prefork process model is enabled (see samba 8 -M) The prefork children are only started for those services that support prefork (currently ldap, kdc and netlogon). For processes that don't support preforking all requests are handled by a single process for that service. This should be set to a small multiple of the number of CPU's available on the server Additionally the number of prefork children can be specified for an individual service by using "prefork children: service name" i.e. "prefork children:ldap = 8" to set the number of ldap worker processes. prefork maximum backoff This option controls the maximum delay before a failed pre-fork process is restarted. realm This option specifies the kerberos realm to use. The realm is used as the ADS equivalent of the NT4 domain. It is usually set to the DNS name of the kerberos server. Example: mysambabox.mycompany.com server services This option contains the services that the Samba daemon will run. An entry in the smb.conf file can either override the previous value completely or entries can be removed from or added to it by prefixing them with + or -. Example: -s3fs, +smb server string This controls what string will show up in the printer comment box in print manager and next to the IPC connection in net view. It can be any string that you wish to show to your users. It also sets what will appear in browse lists next to the machine name. A %v will be replaced with the Samba version number. A %h will be replaced with the hostname. Example: University of GNUs Samba Server share backend This option specifies the backend that will be used to access the configuration of file shares. Traditionally, Samba file shares have been configured in the smb.conf file and this is still the default. At the moment there are no other supported backends. unix charset Specifies the charset the unix machine Samba runs on uses. Samba needs to know this in order to be able to convert text to the charsets other SMB clients use. This is also the charset Samba will use when specifying arguments to scripts that it invokes. Example: ASCII workgroup This controls what workgroup your server will appear to be in when queried by clients. Note that this parameter also controls the Domain name used with the domain setting. Example: MYGROUP interfaces This option allows you to override the default network interfaces list that Samba will use for browsing, name registration and other NetBIOS over TCP/IP (NBT) traffic. By default Samba will query the kernel for the list of all active interfaces and use any interfaces except 127.0.0.1 that are broadcast capable. The option takes a list of interface strings. Each string can be in any of the following forms: a network interface name (such as eth0). This may include shell-like wildcards so eth* will match any interface starting with the substring "eth" an IP address. In this case the netmask is determined from the list of interfaces obtained from the kernel an IP/mask pair. a broadcast/mask pair. The "mask" parameters can either be a bit length (such as 24 for a C class network) or a full netmask in dotted decimal form. The "IP" parameters above can either be a full dotted decimal IP address or a hostname which will be looked up via the OS's normal hostname resolution mechanisms. By default Samba enables all active interfaces that are broadcast capable except the loopback adaptor (IP address 127.0.0.1). In order to support SMB3 multi-channel configurations, smbd understands some extra parameters which can be appended after the actual interface with this extended syntax (note that the quoting is important in order to handle the ; and , characters): "interface[;key1=value1[,key2=value2[...]]]" Known keys are speed, capability, and if_index. Speed is specified in bits per second. Known capabilities are RSS and RDMA. The if_index should be used with care: the values must not coincide with indexes used by the kernel. Note that these options are mainly intended for testing and development rather than for production use. At least on Linux systems, these values should be auto-detected, but the settings can serve as last a resort when autodetection is not working or is not available. The specified values overwrite the auto-detected values. The first two example below configures three network interfaces corresponding to the eth0 device and IP addresses 192.168.2.10 and 192.168.3.10. The netmasks of the latter two interfaces would be set to 255.255.255.0. The other examples show how per interface extra parameters can be specified. Notice the possible usage of "," and ";", which makes the double quoting necessary. Example: eth0 192.168.2.10/24 192.168.3.10/255.255.255.0 Example: eth0, 192.168.2.10/24; 192.168.3.10/255.255.255.0 Example: "eth0;if_index=65,speed=1000000000,capability=RSS" Example: "lo;speed=1000000000" "eth0;capability=RSS" Example: "lo;speed=1000000000" , "eth0;capability=RSS" Example: "eth0;capability=RSS" , "rdma1;capability=RDMA" ; "rdma2;capability=RSS,capability=RDMA" browse list This controls whether smbd 8 will serve a browse list to a client doing a NetServerEnum call. Normally set to yes. You should never need to change this. domain master Tell smbd 8 to enable WAN-wide browse list collation. Setting this option causes nmbd to claim a special domain specific NetBIOS name that identifies it as a domain master browser for its given . Local master browsers in the same on broadcast-isolated subnets will give this nmbd their local browse lists, and then ask smbd 8 for a complete copy of the browse list for the whole wide area network. Browser clients will then contact their local master browser, and will receive the domain-wide browse list, instead of just the list for their broadcast-isolated subnet. Note that Windows NT Primary Domain Controllers expect to be able to claim this specific special NetBIOS name that identifies them as domain master browsers for that by default (i.e. there is no way to prevent a Windows NT PDC from attempting to do this). This means that if this parameter is set and nmbd claims the special name for a before a Windows NT PDC is able to do so then cross subnet browsing will behave strangely and may fail. If yes, then the default behavior is to enable the parameter. If is not enabled (the default setting), then neither will be enabled by default. When Yes the default setting for this parameter is Yes, with the result that Samba will be a PDC. If No, Samba will function as a BDC. In general, this parameter should be set to 'No' only on a BDC. enhanced browsing This option enables a couple of enhancements to cross-subnet browse propagation that have been added in Samba but which are not standard in Microsoft implementations. The first enhancement to browse propagation consists of a regular wildcard query to a Samba WINS server for all Domain Master Browsers, followed by a browse synchronization with each of the returned DMBs. The second enhancement consists of a regular randomised browse synchronization with all currently known DMBs. You may wish to disable this option if you have a problem with empty workgroups not disappearing from browse lists. Due to the restrictions of the browse protocols, these enhancements can cause a empty workgroup to stay around forever which can be annoying. In general you should leave this option enabled as it makes cross-subnet browse propagation much more reliable. lm announce This parameter determines if nmbd 8 will produce Lanman announce broadcasts that are needed by OS/2 clients in order for them to see the Samba server in their browse list. This parameter can have three values, yes, no, or auto. The default is auto. If set to no Samba will never produce these broadcasts. If set to yes Samba will produce Lanman announce broadcasts at a frequency set by the parameter . If set to auto Samba will not send Lanman announce broadcasts by default but will listen for them. If it hears such a broadcast on the wire it will then start sending them at a frequency set by the parameter . Example: yes lm interval If Samba is set to produce Lanman announce broadcasts needed by OS/2 clients (see the parameter) then this parameter defines the frequency in seconds with which they will be made. If this is set to zero then no Lanman announcements will be made despite the setting of the parameter. Example: 120 local master This option allows nmbd 8 to try and become a local master browser on a subnet. If set to no then nmbd will not attempt to become a local master browser on a subnet and will also lose in all browsing elections. By default this value is set to yes. Setting this value to yes doesn't mean that Samba will become the local master browser on a subnet, just that nmbd will participate in elections for local master browser. Setting this value to no will cause nmbd never to become a local master browser. os level This integer value controls what level Samba advertises itself as for browse elections. The value of this parameter determines whether nmbd 8 has a chance of becoming a local master browser for the in the local broadcast area. Note: By default, Samba will win a local master browsing election over all Microsoft operating systems except a Windows NT 4.0/2000 Domain Controller. This means that a misconfigured Samba host can effectively isolate a subnet for browsing purposes. This parameter is largely auto-configured in the Samba-3 release series and it is seldom necessary to manually override the default setting. Please refer to the chapter on Network Browsing in the Samba-3 HOWTO document for further information regarding the use of this parameter. Note: The maximum value for this parameter is 255. If you use higher values, counting will start at 0! Example: 65 preferred master This boolean parameter controls if nmbd 8 is a preferred master browser for its workgroup. If this is set to yes, on startup, nmbd will force an election, and it will have a slight advantage in winning the election. It is recommended that this parameter is used in conjunction with yes, so that nmbd can guarantee becoming a domain master. Use this option with caution, because if there are several hosts (whether Samba servers, Windows 95 or NT) that are preferred master browsers on the same subnet, they will each periodically and continuously attempt to become the local master browser. This will result in unnecessary broadcast traffic and reduced browsing capabilities. allow dns updates This option determines what kind of updates to the DNS are allowed. DNS updates can either be disallowed completely by setting it to disabled, enabled over secure connections only by setting it to secure only or allowed in all cases by setting it to nonsecure. Example: disabled dns forwarder This option specifies the list of DNS servers that DNS requests will be forwarded to if they can not be handled by Samba itself. The DNS forwarder is only used if the internal DNS server in Samba is used. Example: 192.168.0.1 192.168.0.2 dns update command This option sets the command that is called when there are DNS updates. It should update the local machines DNS names using TSIG-GSS. Example: /usr/local/sbin/dnsupdate dns zone scavenging When enabled (the default is disabled) unused dynamic dns records are periodically removed. This option should not be enabled for installations created with versions of samba before 4.9. Doing this will result in the loss of static DNS entries. This is due to a bug in previous versions of samba (BUG 12451) which marked dynamic DNS records as static and static records as dynamic. If one record for a DNS name is static (non-aging) then no other record for that DNS name will be scavenged. gpo update command This option sets the command that is called to apply GPO policies. The samba-gpupdate script applies System Access and Kerberos Policies to the KDC. System Access policies set minPwdAge, maxPwdAge, minPwdLength, and pwdProperties in the samdb. Kerberos Policies set kdc:service ticket lifetime, kdc:user ticket lifetime, and kdc:renewal lifetime in smb.conf. Example: /usr/local/sbin/gpoupdate machine password timeout If a Samba server is a member of a Windows NT or Active Directory Domain (see the domain and ads parameters), then periodically a running winbindd process will try and change the MACHINE ACCOUNT PASSWORD stored in the TDB called secrets.tdb . This parameter specifies how often this password will be changed, in seconds. The default is one week (expressed in seconds), the same as a Windows NT Domain member server. See also smbpasswd 8, and the domain and ads parameters. nsupdate command This option sets the path to the nsupdate command which is used for GSS-TSIG dynamic DNS updates. spn update command This option sets the command that for updating servicePrincipalName names from spn_update_list. Example: /usr/local/sbin/spnupdate mangle prefix controls the number of prefix characters from the original name used when generating the mangled names. A larger value will give a weaker hash and therefore more name collisions. The minimum value is 1 and the maximum value is 6. mangle prefix is effective only when mangling method is hash2. Example: 4 mangling method controls the algorithm used for the generating the mangled names. Can take two different values, "hash" and "hash2". "hash" is the algorithm that was used in Samba for many years and was the default in Samba 2.2.x "hash2" is now the default and is newer and considered a better algorithm (generates less collisions) in the names. Many Win32 applications store the mangled names and so changing to algorithms must not be done lightly as these applications may break unless reinstalled. Example: hash max stat cache size This parameter limits the size in memory of any stat cache being used to speed up case insensitive name mappings. It represents the number of kilobyte (1024) units the stat cache can use. A value of zero, meaning unlimited, is not advisable due to increased memory usage. You should not need to change this parameter. Example: 100 stat cache This parameter determines if smbd 8 will use a cache in order to speed up case insensitive name mappings. You should never need to change this parameter. client ldap sasl wrapping The defines whether ldap traffic will be signed or signed and encrypted (sealed). Possible values are plain, sign and seal. The values sign and seal are only available if Samba has been compiled against a modern OpenLDAP version (2.3.x or higher). This option is needed in the case of Domain Controllers enforcing the usage of signed LDAP connections (e.g. Windows 2000 SP3 or higher). LDAP sign and seal can be controlled with the registry key "HKLM\System\CurrentControlSet\Services\ NTDS\Parameters\LDAPServerIntegrity" on the Windows server side. Depending on the used KRB5 library (MIT and older Heimdal versions) it is possible that the message "integrity only" is not supported. In this case, sign is just an alias for seal. The default value is sign. That implies synchronizing the time with the KDC in the case of using Kerberos. ldap admin dn The defines the Distinguished Name (DN) name used by Samba to contact the ldap server when retrieving user account information. The is used in conjunction with the admin dn password stored in the private/secrets.tdb file. See the smbpasswd 8 man page for more information on how to accomplish this. The requires a fully specified DN. The is not appended to the . ldap connection timeout This parameter tells the LDAP library calls which timeout in seconds they should honor during initial connection establishments to LDAP servers. It is very useful in failover scenarios in particular. If one or more LDAP servers are not reachable at all, we do not have to wait until TCP timeouts are over. This feature must be supported by your LDAP library. This parameter is different from which affects operations on LDAP servers using an existing connection and not establishing an initial connection. ldap delete dn This parameter specifies whether a delete operation in the ldapsam deletes the complete entry or only the attributes specific to Samba. ldap deref This option controls whether Samba should tell the LDAP library to use a certain alias dereferencing method. The default is auto, which means that the default setting of the ldap client library will be kept. Other possible values are never, finding, searching and always. Grab your LDAP manual for more information. Example: searching ldap follow referral This option controls whether to follow LDAP referrals or not when searching for entries in the LDAP database. Possible values are on to enable following referrals, off to disable this, and auto, to use the libldap default settings. libldap's choice of following referrals or not is set in /etc/openldap/ldap.conf with the REFERRALS parameter as documented in ldap.conf(5). Example: off ldap group suffix This parameter specifies the suffix that is used for groups when these are added to the LDAP directory. If this parameter is unset, the value of will be used instead. The suffix string is prepended to the string so use a partial DN. Example: ou=Groups ldap idmap suffix This parameters specifies the suffix that is used when storing idmap mappings. If this parameter is unset, the value of will be used instead. The suffix string is prepended to the string so use a partial DN. Example: ou=Idmap ldap machine suffix It specifies where machines should be added to the ldap tree. If this parameter is unset, the value of will be used instead. The suffix string is prepended to the string so use a partial DN. Example: ou=Computers ldap page size This parameter specifies the number of entries per page. If the LDAP server supports paged results, clients can request subsets of search results (pages) instead of the entire list. This parameter specifies the size of these pages. Example: 512 ldap passwd sync This option is used to define whether or not Samba should sync the LDAP password with the NT and LM hashes for normal accounts (NOT for workstation, server or domain trusts) on a password change via SAMBA. The can be set to one of three values: Yes = Try to update the LDAP, NT and LM passwords and update the pwdLastSet time. No = Update NT and LM passwords and update the pwdLastSet time. Only = Only update the LDAP password and let the LDAP server do the rest. ldap replication sleep When Samba is asked to write to a read-only LDAP replica, we are redirected to talk to the read-write master server. This server then replicates our changes back to the 'local' server, however the replication might take some seconds, especially over slow links. Certain client activities, particularly domain joins, can become confused by the 'success' that does not immediately change the LDAP back-end's data. This option simply causes Samba to wait a short time, to allow the LDAP server to catch up. If you have a particularly high-latency network, you may wish to time the LDAP replication with a network sniffer, and increase this value accordingly. Be aware that no checking is performed that the data has actually replicated. The value is specified in milliseconds, the maximum value is 5000 (5 seconds). ldapsam:editposix Editposix is an option that leverages ldapsam:trusted to make it simpler to manage a domain controller eliminating the need to set up custom scripts to add and manage the posix users and groups. This option will instead directly manipulate the ldap tree to create, remove and modify user and group entries. This option also requires a running winbindd as it is used to allocate new uids/gids on user/group creation. The allocation range must be therefore configured. To use this option, a basic ldap tree must be provided and the ldap suffix parameters must be properly configured. On virgin servers the default users and groups (Administrator, Guest, Domain Users, Domain Admins, Domain Guests) can be precreated with the command net sam provision. To run this command the ldap server must be running, Winbindd must be running and the smb.conf ldap options must be properly configured. The typical ldap setup used with the yes option is usually sufficient to use yes as well. An example configuration can be the following: encrypt passwords = true passdb backend = ldapsam ldapsam:trusted=yes ldapsam:editposix=yes ldap admin dn = cn=admin,dc=samba,dc=org ldap delete dn = yes ldap group suffix = ou=groups ldap idmap suffix = ou=idmap ldap machine suffix = ou=computers ldap user suffix = ou=users ldap suffix = dc=samba,dc=org idmap backend = ldap:"ldap://localhost" idmap uid = 5000-50000 idmap gid = 5000-50000 This configuration assumes a directory layout like described in the following ldif: dn: dc=samba,dc=org objectClass: top objectClass: dcObject objectClass: organization o: samba.org dc: samba dn: cn=admin,dc=samba,dc=org objectClass: simpleSecurityObject objectClass: organizationalRole cn: admin description: LDAP administrator userPassword: secret dn: ou=users,dc=samba,dc=org objectClass: top objectClass: organizationalUnit ou: users dn: ou=groups,dc=samba,dc=org objectClass: top objectClass: organizationalUnit ou: groups dn: ou=idmap,dc=samba,dc=org objectClass: top objectClass: organizationalUnit ou: idmap dn: ou=computers,dc=samba,dc=org objectClass: top objectClass: organizationalUnit ou: computers ldapsam:trusted By default, Samba as a Domain Controller with an LDAP backend needs to use the Unix-style NSS subsystem to access user and group information. Due to the way Unix stores user information in /etc/passwd and /etc/group this inevitably leads to inefficiencies. One important question a user needs to know is the list of groups he is member of. The plain UNIX model involves a complete enumeration of the file /etc/group and its NSS counterparts in LDAP. UNIX has optimized functions to enumerate group membership. Sadly, other functions that are used to deal with user and group attributes lack such optimization. To make Samba scale well in large environments, the yes option assumes that the complete user and group database that is relevant to Samba is stored in LDAP with the standard posixAccount/posixGroup attributes. It further assumes that the Samba auxiliary object classes are stored together with the POSIX data in the same LDAP object. If these assumptions are met, yes can be activated and Samba can bypass the NSS system to query user group memberships. Optimized LDAP queries can greatly speed up domain logon and administration tasks. Depending on the size of the LDAP database a factor of 100 or more for common queries is easily achieved. ldap server require strong auth The defines whether the ldap server requires ldap traffic to be signed or signed and encrypted (sealed). Possible values are no, allow_sasl_over_tls and yes. A value of no allows simple and sasl binds over all transports. A value of allow_sasl_over_tls allows simple and sasl binds (without sign or seal) over TLS encrypted connections. Unencrypted connections only allow sasl binds with sign or seal. A value of yes allows only simple binds over TLS encrypted connections. Unencrypted connections only allow sasl binds with sign or seal. ldap ssl This option is used to define whether or not Samba should use SSL when connecting to the ldap server This is NOT related to Samba's previous SSL support which was enabled by specifying the --with-ssl option to the configure script. LDAP connections should be secured where possible. This may be done setting either this parameter to start tls or by specifying ldaps:// in the URL argument of . The can be set to one of two values: Off = Never use SSL when querying the directory. start tls = Use the LDAPv3 StartTLS extended operation (RFC2830) for communicating with the directory server. Please note that this parameter does only affect rpc methods. To enable the LDAPv3 StartTLS extended operation (RFC2830) for ads, set start tls and yes. See smb.conf5 for more information on . ldap ssl ads This option is used to define whether or not Samba should use SSL when connecting to the ldap server using ads methods. Rpc methods are not affected by this parameter. Please note, that this parameter won't have any effect if is set to no. See smb.conf5 for more information on . ldap suffix Specifies the base for all ldap suffixes and for storing the sambaDomain object. The ldap suffix will be appended to the values specified for the , , , and the . Each of these should be given only a DN relative to the . Example: dc=samba,dc=org ldap timeout This parameter defines the number of seconds that Samba should use as timeout for LDAP operations. ldap user suffix This parameter specifies where users are added to the tree. If this parameter is unset, the value of will be used instead. The suffix string is prepended to the string so use a partial DN. Example: ou=people ldap max anonymous request size This parameter specifies the maximum permitted size (in bytes) for an LDAP request received on an anonymous connection. If the request size exceeds this limit the request will be rejected. Example: 500000 ldap max authenticated request size This parameter specifies the maximum permitted size (in bytes) for an LDAP request received on an authenticated connection. If the request size exceeds this limit the request will be rejected. Example: 4194304 ldap max search request size This parameter specifies the maximum permitted size (in bytes) for an LDAP search request. If the request size exceeds this limit the request will be rejected. Example: 4194304 lock spin time The time in milliseconds that smbd should keep waiting to see if a failed lock request can be granted. This parameter has changed in default value from Samba 3.0.23 from 10 to 200. The associated parameter is no longer used in Samba 3.0.24. You should not need to change the value of this parameter. oplock break wait time This is a tuning parameter added due to bugs in both Windows 9x and WinNT. If Samba responds to a client too quickly when that client issues an SMB that can cause an oplock break request, then the network client can fail and not respond to the break request. This tuning parameter (which is set in milliseconds) is the amount of time Samba will wait before sending an oplock break request to such (broken) clients. DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ AND UNDERSTOOD THE SAMBA OPLOCK CODE. smb2 leases This boolean option tells smbd whether to globally negotiate SMB2 leases on file open requests. Leasing is an SMB2-only feature which allows clients to aggressively cache files locally above and beyond the caching allowed by SMB1 oplocks. This is only available with yes and no. debug class With this boolean parameter enabled, the debug class (DBGC_CLASS) will be displayed in the debug header. For more information about currently available debug classes, see section about . debug hires timestamp Sometimes the timestamps in the log messages are needed with a resolution of higher that seconds, this boolean parameter adds microsecond resolution to the timestamp message header when turned on. Note that the parameter must be on for this to have an effect. debug pid When using only one log file for more then one forked smbd 8-process there may be hard to follow which process outputs which message. This boolean parameter is adds the process-id to the timestamp message headers in the logfile when turned on. Note that the parameter must be on for this to have an effect. debug prefix timestamp With this option enabled, the timestamp message header is prefixed to the debug message without the filename and function information that is included with the parameter. This gives timestamps to the messages without adding an additional line. Note that this parameter overrides the parameter. debug uid Samba is sometimes run as root and sometime run as the connected user, this boolean parameter inserts the current euid, egid, uid and gid to the timestamp message headers in the log file if turned on. Note that the parameter must be on for this to have an effect. ldap debug level This parameter controls the debug level of the LDAP library calls. In the case of OpenLDAP, it is the same bit-field as understood by the server and documented in the slapd.conf 5 manpage. A typical useful value will be 1 for tracing function calls. The debug output from the LDAP libraries appears with the prefix [LDAP] in Samba's logging output. The level at which LDAP logging is printed is controlled by the parameter ldap debug threshold. Example: 1 ldap debug threshold This parameter controls the Samba debug level at which the ldap library debug output is printed in the Samba logs. See the description of ldap debug level for details. Example: 5 log file This option allows you to override the name of the Samba log file (also known as the debug file). This option takes the standard substitutions, allowing you to have separate log files for each user or machine. Example: /usr/local/samba/var/log.%m logging This parameter configures logging backends. Multiple backends can be specified at the same time, with different log levels for each backend. The parameter is a list of backends, where each backend is specified as backend[:option][@loglevel]. The 'option' parameter can be used to pass backend-specific options. The log level for a backend is optional, if it is not set for a backend, all messages are sent to this backend. The parameter determines overall log levels, while the log levels specified here define what is sent to the individual backends. When is set, it overrides the and parameters. Some backends are only available when Samba has been compiled with the additional libraries. The overall list of logging backends: syslog file systemd lttng gpfs ringbuf The ringbuf backend supports an optional size argument to change the buffer size used, the default is 1 MB: ringbuf:size=NBYTES Example: syslog@1 file log level The value of the parameter (a string) allows the debug level (logging level) to be specified in the smb.conf file. This parameter has been extended since the 2.2.x series, now it allows one to specify the debug level for multiple debug classes and distinct logfiles for debug classes. This is to give greater flexibility in the configuration of the system. The following debug classes are currently implemented: all tdb printdrivers lanman smb smb2 smb2_credits rpc_parse rpc_srv rpc_cli passdb sam auth winbind vfs idmap quota acls locking msdfs dmapi registry scavenger dns ldb tevent auth_audit auth_json_audit kerberos dsdb_audit dsdb_json_audit dsdb_password_audit dsdb_password_json_audit dsdb_transaction_audit dsdb_transaction_json_audit To configure the logging for specific classes to go into a different file then , you can append @PATH to the class, eg log level = 1 full_audit:1@/var/log/audit.log. Authentication and authorization audit information is logged under the auth_audit, and if Samba was not compiled with --without-json, a JSON representation is logged under auth_json_audit. Support is comprehensive for all authentication and authorisation of user accounts in the Samba Active Directory Domain Controller, as well as the implicit authentication in password changes. In the file server, NTLM authentication, SMB and RPC authorization is covered. Log levels for auth_audit and auth_audit_json are: 2: Authentication Failure 3: Authentication Success 4: Authorization Success 5: Anonymous Authentication and Authorization Success Changes to the sam.ldb database are logged under the dsdb_audit and a JSON representation is logged under dsdb_json_audit. Password changes and Password resets are logged under dsdb_password_audit and a JSON representation is logged under the dsdb_password_json_audit. Transaction rollbacks and prepare commit failures are logged under the dsdb_transaction_audit and a JSON representation is logged under the password_json_audit. Logging the transaction details allows the identification of password and sam.ldb operations that have been rolled back. Example: 3 passdb:5 auth:10 winbind:2 Example: 1 full_audit:1@/var/log/audit.log winbind:2 max log size This option (an integer in kilobytes) specifies the max size the log file should grow to. Samba periodically checks the size and if it is exceeded it will rename the file, adding a .old extension. A size of 0 means no limit. Example: 1000 syslog This parameter maps how Samba debug messages are logged onto the system syslog logging levels. Samba debug level zero maps onto syslog LOG_ERR, debug level one maps onto LOG_WARNING, debug level two maps onto LOG_NOTICE, debug level three maps onto LOG_INFO. All higher levels are mapped to LOG_DEBUG. This parameter sets the threshold for sending messages to syslog. Only messages with debug level less than this value will be sent to syslog. There still will be some logging to log.[sn]mbd even if syslog only is enabled. The parameter should be used instead. When is set, it overrides the parameter. syslog only If this parameter is set then Samba debug messages are logged into the system syslog only, and not to the debug log files. There still will be some logging to log.[sn]mbd even if syslog only is enabled. The parameter should be used instead. When is set, it overrides the parameter. timestamp logs Samba debug log messages are timestamped by default. If you are running at a high these timestamps can be distracting. This boolean parameter allows timestamping to be turned off. abort shutdown script This a full path name to a script called by smbd 8 that should stop a shutdown procedure issued by the . If the connected user possesses the SeRemoteShutdownPrivilege, right, this command will be run as root. Example: /sbin/shutdown -c add group script This is the full pathname to a script that will be run AS ROOT by smbd8 when a new group is requested. It will expand any %g to the group name passed. This script is only useful for installations using the Windows NT domain administration tools. The script is free to create a group with an arbitrary name to circumvent unix group name restrictions. In that case the script must print the numeric gid of the created group on stdout. Example: /usr/sbin/groupadd %g add machine script This is the full pathname to a script that will be run by smbd 8 when a machine is added to Samba's domain and a Unix account matching the machine's name appended with a "$" does not already exist. This option is very similar to the , and likewise uses the %u substitution for the account name. Do not use the %m substitution. Example: /usr/sbin/adduser -n -g machines -c Machine -d /var/lib/nobody -s /bin/false %u add user script This is the full pathname to a script that will be run AS ROOT by smbd 8 under special circumstances described below. Normally, a Samba server requires that UNIX users are created for all users accessing files on this server. For sites that use Windows NT account databases as their primary user database creating these users and keeping the user list in sync with the Windows NT PDC is an onerous task. This option allows smbd to create the required UNIX users ON DEMAND when a user accesses the Samba server. When the Windows user attempts to access the Samba server, at login (session setup in the SMB protocol) time, smbd 8 contacts the and attempts to authenticate the given user with the given password. If the authentication succeeds then smbd attempts to find a UNIX user in the UNIX password database to map the Windows user into. If this lookup fails, and is set then smbd will call the specified script AS ROOT, expanding any %u argument to be the user name to create. If this script successfully creates the user then smbd will continue on as though the UNIX user already existed. In this way, UNIX users are dynamically created to match existing Windows NT accounts. See also , , . Example: /usr/local/samba/bin/add_user %u add user to group script Full path to the script that will be called when a user is added to a group using the Windows NT domain administration tools. It will be run by smbd 8 AS ROOT. Any %g will be replaced with the group name and any %u will be replaced with the user name. Note that the adduser command used in the example below does not support the used syntax on all systems. Example: /usr/sbin/adduser %u %g allow nt4 crypto This option controls whether the netlogon server (currently only in 'active directory domain controller' mode), will reject clients which does not support NETLOGON_NEG_STRONG_KEYS nor NETLOGON_NEG_SUPPORTS_AES. This option was added with Samba 4.2.0. It may lock out clients which worked fine with Samba versions up to 4.1.x. as the effective default was "yes" there, while it is "no" now. If you have clients without RequireStrongKey = 1 in the registry, you may need to set "allow nt4 crypto = yes", until you have fixed all clients. "allow nt4 crypto = yes" allows weak crypto to be negotiated, maybe via downgrade attacks. This option yields precedence to the 'reject md5 clients' option. auth event notification When enabled, this option causes Samba (acting as an Active Directory Domain Controller) to stream authentication events across the internal message bus. Scripts built using Samba's python bindings can listen to these events by registering as the service auth_event. This should be considered a developer option (it assists in the Samba testsuite) rather than a facility for external auditing, as message delivery is not guaranteed (a feature that the testsuite works around). Additionally Samba must be compiled with the jansson support for this option to be effective. The authentication events are also logged via the normal logging methods when the is set appropriately. delete group script This is the full pathname to a script that will be run AS ROOT by smbd 8 when a group is requested to be deleted. It will expand any %g to the group name passed. This script is only useful for installations using the Windows NT domain administration tools. delete user from group script Full path to the script that will be called when a user is removed from a group using the Windows NT domain administration tools. It will be run by smbd 8 AS ROOT. Any %g will be replaced with the group name and any %u will be replaced with the user name. Example: /usr/sbin/deluser %u %g delete user script This is the full pathname to a script that will be run by smbd 8 when managing users with remote RPC (NT) tools. This script is called when a remote client removes a user from the server, normally using 'User Manager for Domains' or rpcclient. This script should delete the given UNIX username. Example: /usr/local/samba/bin/del_user %u domain logons If set to yes, the Samba server will provide the netlogon service for Windows 9X network logons for the it is in. This will also cause the Samba server to act as a domain controller for NT4 style domain services. For more details on setting up this feature see the Domain Control chapter of the Samba HOWTO Collection. enable privileges This deprecated parameter controls whether or not smbd will honor privileges assigned to specific SIDs via either net rpc rights or one of the Windows user and group manager tools. This parameter is enabled by default. It can be disabled to prevent members of the Domain Admins group from being able to assign privileges to users or groups which can then result in certain smbd operations running as root that would normally run under the context of the connected user. An example of how privileges can be used is to assign the right to join clients to a Samba controlled domain without providing root access to the server via smbd. Please read the extended description provided in the Samba HOWTO documentation. init logon delay This parameter specifies a delay in milliseconds for the hosts configured for delayed initial samlogon with . init logon delayed hosts This parameter takes a list of host names, addresses or networks for which the initial samlogon reply should be delayed (so other DCs get preferred by XP workstations if there are any). The length of the delay can be specified with the parameter. Example: 150.203.5. myhost.mynet.de logon drive This parameter specifies the local path to which the home directory will be connected (see ) and is only used by NT Workstations. Note that this option is only useful if Samba is set up as a logon server. Example: h: logon home This parameter specifies the home directory location when a Win95/98 or NT Workstation logs into a Samba PDC. It allows you to do C:\>NET USE H: /HOME from a command prompt, for example. This option takes the standard substitutions, allowing you to have separate logon scripts for each user or machine. This parameter can be used with Win9X workstations to ensure that roaming profiles are stored in a subdirectory of the user's home directory. This is done in the following way: logon home = \\%N\%U\profile This tells Samba to return the above string, with substitutions made when a client requests the info, generally in a NetUserGetInfo request. Win9X clients truncate the info to \\server\share when a user does net use /home but use the whole string when dealing with profiles. Note that in prior versions of Samba, the was returned rather than logon home. This broke net use /home but allowed profiles outside the home directory. The current implementation is correct, and can be used for profiles if you use the above trick. Disable this feature by setting "" - using the empty string. This option is only useful if Samba is set up as a logon server. Example: \\remote_smb_server\%U logon path This parameter specifies the directory where roaming profiles (Desktop, NTuser.dat, etc) are stored. Contrary to previous versions of these manual pages, it has nothing to do with Win 9X roaming profiles. To find out how to handle roaming profiles for Win 9X system, see the parameter. This option takes the standard substitutions, allowing you to have separate logon scripts for each user or machine. It also specifies the directory from which the "Application Data", desktop, start menu, network neighborhood, programs and other folders, and their contents, are loaded and displayed on your Windows NT client. The share and the path must be readable by the user for the preferences and directories to be loaded onto the Windows NT client. The share must be writeable when the user logs in for the first time, in order that the Windows NT client can create the NTuser.dat and other directories. Thereafter, the directories and any of the contents can, if required, be made read-only. It is not advisable that the NTuser.dat file be made read-only - rename it to NTuser.man to achieve the desired effect (a MANdatory profile). Windows clients can sometimes maintain a connection to the [homes] share, even though there is no user logged in. Therefore, it is vital that the logon path does not include a reference to the homes share (i.e. setting this parameter to \\%N\homes\profile_path will cause problems). This option takes the standard substitutions, allowing you to have separate logon scripts for each user or machine. Do not quote the value. Setting this as \\%N\profile\%U will break profile handling. Where the tdbsam or ldapsam passdb backend is used, at the time the user account is created the value configured for this parameter is written to the passdb backend and that value will over-ride the parameter value present in the smb.conf file. Any error present in the passdb backend account record must be edited using the appropriate tool (pdbedit on the command-line, or any other locally provided system tool). Note that this option is only useful if Samba is set up as a domain controller. Disable the use of roaming profiles by setting the value of this parameter to the empty string. For example, "". Take note that even if the default setting in the smb.conf file is the empty string, any value specified in the user account settings in the passdb backend will over-ride the effect of setting this parameter to null. Disabling of all roaming profile use requires that the user account settings must also be blank. An example of use is: logon path = \\PROFILESERVER\PROFILE\%U logon script This parameter specifies the batch file (.bat) or NT command file (.cmd) to be downloaded and run on a machine when a user successfully logs in. The file must contain the DOS style CR/LF line endings. Using a DOS-style editor to create the file is recommended. The script must be a relative path to the service. If the [netlogon] service specifies a of /usr/local/samba/netlogon, and STARTUP.BAT, then the file that will be downloaded is: /usr/local/samba/netlogon/STARTUP.BAT The contents of the batch file are entirely your choice. A suggested command would be to add NET TIME \\SERVER /SET /YES, to force every machine to synchronize clocks with the same time server. Another use would be to add NET USE U: \\SERVER\UTILS for commonly used utilities, or NET USE Q: \\SERVER\ISO9001_QA for example. Note that it is particularly important not to allow write access to the [netlogon] share, or to grant users write permission on the batch files in a secure environment, as this would allow the batch files to be arbitrarily modified and security to be breached. This option takes the standard substitutions, allowing you to have separate logon scripts for each user or machine. This option is only useful if Samba is set up as a logon server in a classic domain controller role. If Samba is set up as an Active Directory domain controller, LDAP attribute scriptPath is used instead. For configurations where ldapsam is in use, this option only defines a default value in case LDAP attribute sambaLogonScript is missing. Example: scripts\%U.bat reject md5 clients This option controls whether the netlogon server (currently only in 'active directory domain controller' mode), will reject clients which does not support NETLOGON_NEG_SUPPORTS_AES. You can set this to yes if all domain members support aes. This will prevent downgrade attacks. This option takes precedence to the 'allow nt4 crypto' option. set primary group script Thanks to the Posix subsystem in NT a Windows User has a primary group in addition to the auxiliary groups. This script sets the primary group in the unix user database when an administrator sets the primary group from the windows user manager or when fetching a SAM with net rpc vampire. %u will be replaced with the user whose primary group is to be set. %g will be replaced with the group to set. Example: /usr/sbin/usermod -g '%g' '%u' shutdown script This a full path name to a script called by smbd 8 that should start a shutdown procedure. If the connected user possesses the SeRemoteShutdownPrivilege, right, this command will be run as root. The %z %t %r %f variables are expanded as follows: %z will be substituted with the shutdown message sent to the server. %t will be substituted with the number of seconds to wait before effectively starting the shutdown procedure. %r will be substituted with the switch -r. It means reboot after shutdown for NT. %f will be substituted with the switch -f. It means force the shutdown even if applications do not respond for NT. Shutdown script example: #!/bin/bash time=$2 let time="${time} / 60" let time="${time} + 1" /sbin/shutdown $3 $4 +$time $1 & Shutdown does not return so we need to launch it in background. Example: /usr/local/samba/sbin/shutdown %m %t %r %f add share command Samba 2.2.0 introduced the ability to dynamically add and delete shares via the Windows NT 4.0 Server Manager. The add share command is used to define an external program or script which will add a new service definition to smb.conf. In order to successfully execute the add share command, smbd requires that the administrator connects using a root account (i.e. uid == 0) or has the SeDiskOperatorPrivilege. Scripts defined in the add share command parameter are executed as root. When executed, smbd will automatically invoke the add share command with five parameters. configFile - the location of the global smb.conf file. shareName - the name of the new share. pathName - path to an **existing** directory on disk. comment - comment string to associate with the new share. max connections Number of maximum simultaneous connections to this share. This parameter is only used to add file shares. To add printer shares, see the . Example: /usr/local/bin/addshare afs token lifetime This parameter controls the lifetime of tokens that the AFS fake-kaserver claims. In reality these never expire but this lifetime controls when the afs client will forget the token. Set this parameter to 0 to get NEVERDATE. afs username map If you are using the fake kaserver AFS feature, you might want to hand-craft the usernames you are creating tokens for. For example this is necessary if you have users from several domain in your AFS Protection Database. One possible scheme to code users as DOMAIN+User as it is done by winbind with the + as a separator. The mapped user name must contain the cell name to log into, so without setting this parameter there will be no token. Example: %u@afs.samba.org allow insecure wide links In normal operation the option which allows the server to follow symlinks outside of a share path is automatically disabled when are enabled on a Samba server. This is done for security purposes to prevent UNIX clients creating symlinks to areas of the server file system that the administrator does not wish to export. Setting to true disables the link between these two parameters, removing this protection and allowing a site to configure the server to follow symlinks (by setting to "true") even when is turned on. It is not recommended to enable this option unless you fully understand the implications of allowing the server to follow symbolic links created by UNIX clients. For most normal Samba configurations this would be considered a security hole and setting this parameter is not recommended. This option was added at the request of sites who had deliberately set Samba up in this way and needed to continue supporting this functionality without having to patch the Samba code. allow unsafe cluster upgrade If set to no (the default), smbd checks at startup if other smbd versions are running in the cluster and refuses to start if so. This is done to protect data corruption in internal data structures due to incompatible Samba versions running concurrently in the same cluster. Setting this parameter to yes disables this safety check. async smb echo handler This parameter specifies whether Samba should fork the async smb echo handler. It can be beneficial if your file system can block syscalls for a very long time. In some circumstances, it prolongs the timeout that Windows uses to determine whether a connection is dead. This parameter is only for SMB1. For SMB2 and above TCP keepalives can be used instead. auto services This is a list of services that you want to be automatically added to the browse lists. This is most useful for homes and printers services that would otherwise not be visible. Note that if you just want all printers in your printcap file loaded then the option is easier. Example: fred lp colorlp cache directory Usually, most of the TDB files are stored in the lock directory. Since Samba 3.4.0, it is possible to differentiate between TDB files with persistent data and TDB files with non-persistent data using the state directory and the cache directory options. This option specifies the directory for storing TDB files containing non-persistent data that will be kept across service restarts. The directory should be placed on persistent storage, but the data can be safely deleted by an administrator. Example: /var/run/samba/locks/cache change notify This parameter specifies whether Samba should reply to a client's file change notify requests. You should never need to change this parameter change share command Samba 2.2.0 introduced the ability to dynamically add and delete shares via the Windows NT 4.0 Server Manager. The change share command is used to define an external program or script which will modify an existing service definition in smb.conf. In order to successfully execute the change share command, smbd requires that the administrator connects using a root account (i.e. uid == 0) or has the SeDiskOperatorPrivilege. Scripts defined in the change share command parameter are executed as root. When executed, smbd will automatically invoke the change share command with six parameters. configFile - the location of the global smb.conf file. shareName - the name of the new share. pathName - path to an **existing** directory on disk. comment - comment string to associate with the new share. max connections Number of maximum simultaneous connections to this share. CSC policy - client side caching policy in string form. Valid values are: manual, documents, programs, disable. This parameter is only used to modify existing file share definitions. To modify printer shares, use the "Printers..." folder as seen when browsing the Samba host. Example: /usr/local/bin/changeshare cluster addresses With this parameter you can add additional addresses that nmbd will register with a WINS server. Similarly, these addresses will be registered by default when net ads dns register is called with yes configured. Example: 10.0.0.1 10.0.0.2 10.0.0.3 clustering This parameter specifies whether Samba should contact ctdb for accessing its tdb files and use ctdb as a backend for its messaging backend. Set this parameter to yes only if you have a cluster setup with ctdb running. config file This allows you to override the config file to use, instead of the default (usually smb.conf). There is a chicken and egg problem here as this option is set in the config file! For this reason, if the name of the config file has changed when the parameters are loaded then it will reload them from the new config file. This option takes the usual substitutions, which can be very useful. If the config file doesn't exist then it won't be loaded (allowing you to special case the config files of just a few clients). Example: /usr/local/samba/lib/smb.conf.%m ctdbd socket If you set clustering=yes, you need to tell Samba where ctdbd listens on its unix domain socket. The default path as of ctdb 1.0 is /tmp/ctdb.socket which you have to explicitly set for Samba in smb.conf. Example: /tmp/ctdb.socket ctdb locktime warn threshold In a cluster environment using Samba and ctdb it is critical that locks on central ctdb-hosted databases like locking.tdb are not held for long. With the current Samba architecture it happens that Samba takes a lock and while holding that lock makes file system calls into the shared cluster file system. This option makes Samba warn if it detects that it has held locks for the specified number of milliseconds. If this happens, smbd will emit a debug level 0 message into its logs and potentially into syslog. The most likely reason for such a log message is that an operation of the cluster file system Samba exports is taking longer than expected. The messages are meant as a debugging aid for potential cluster problems. The default value of 0 disables this logging. ctdb timeout This parameter specifies a timeout in milliseconds for the connection between Samba and ctdb. It is only valid if you have compiled Samba with clustering and if you have set clustering=yes. When something in the cluster blocks, it can happen that we wait indefinitely long for ctdb, just adding to the blocking condition. In a well-running cluster this should never happen, but there are too many components in a cluster that might have hickups. Choosing the right balance for this value is very tricky, because on a busy cluster long service times to transfer something across the cluster might be valid. Setting it too short will degrade the service your cluster presents, setting it too long might make the cluster itself not recover from something severely broken for too long. Be aware that if you set this parameter, this needs to be in the file smb.conf, it is not really helpful to put this into a registry configuration (typical on a cluster), because to access the registry contact to ctdb is required. Setting ctdb timeout to n makes any process waiting longer than n milliseconds for a reply by the cluster panic. Setting it to 0 (the default) makes Samba block forever, which is the highly recommended default. default service This parameter specifies the name of a service which will be connected to if the service actually requested cannot be found. Note that the square brackets are NOT given in the parameter value (see example below). There is no default value for this parameter. If this parameter is not given, attempting to connect to a nonexistent service results in an error. Typically the default service would be a , service. Also note that the apparent service name will be changed to equal that of the requested service, this is very useful as it allows you to use macros like %S to make a wildcard service. Note also that any "_" characters in the name of the service used in the default service will get mapped to a "/". This allows for interesting things. Example: pub delete share command Samba 2.2.0 introduced the ability to dynamically add and delete shares via the Windows NT 4.0 Server Manager. The delete share command is used to define an external program or script which will remove an existing service definition from smb.conf. In order to successfully execute the delete share command, smbd requires that the administrator connects using a root account (i.e. uid == 0) or has the SeDiskOperatorPrivilege. Scripts defined in the delete share command parameter are executed as root. When executed, smbd will automatically invoke the delete share command with two parameters. configFile - the location of the global smb.conf file. shareName - the name of the existing service. This parameter is only used to remove file shares. To delete printer shares, see the . Example: /usr/local/bin/delshare dsdb event notification When enabled, this option causes Samba (acting as an Active Directory Domain Controller) to stream Samba database events across the internal message bus. Scripts built using Samba's python bindings can listen to these events by registering as the service dsdb_event. This should be considered a developer option (it assists in the Samba testsuite) rather than a facility for external auditing, as message delivery is not guaranteed (a feature that the testsuite works around). The Samba database events are also logged via the normal logging methods when the is set appropriately. dsdb group change notification When enabled, this option causes Samba (acting as an Active Directory Domain Controller) to stream group membership change events across the internal message bus. Scripts built using Samba's python bindings can listen to these events by registering as the service dsdb_group_event. This should be considered a developer option (it assists in the Samba testsuite) rather than a facility for external auditing, as message delivery is not guaranteed (a feature that the testsuite works around). The group events are also logged via the normal logging methods when the is set appropriately. dsdb password event notification When enabled, this option causes Samba (acting as an Active Directory Domain Controller) to stream password change and reset events across the internal message bus. Scripts built using Samba's python bindings can listen to these events by registering as the service password_event. This should be considered a developer option (it assists in the Samba testsuite) rather than a facility for external auditing, as message delivery is not guaranteed (a feature that the testsuite works around). The password events are also logged via the normal logging methods when the is set appropriately. elasticsearch:mappings Path to a file specifying metadata attribute mappings in JSON format. Use by the Elasticsearch backend of the Spotlight RPC service. Example: /usr/share/foo/mymappings.json fss: prune stale When enabled, Samba's File Server Remote VSS Protocol (FSRVP) server checks all FSRVP initiated snapshots on startup, and removes any corresponding state (including share definitions) for nonexistent snapshot paths. Example: yes fss: sequence timeout The File Server Remote VSS Protocol (FSRVP) server includes a message sequence timer to ensure cleanup on unexpected client disconnect. This parameter overrides the default timeout between FSRVP operations. FSRVP timeouts can be completely disabled via a value of 0. Example: 0 homedir map If is yes, and smbd 8 is also acting as a Win95/98 logon server then this parameter specifies the NIS (or YP) map from which the server for the user's home directory should be extracted. At present, only the Sun auto.home map format is understood. The form of the map is: username server:/some/file/system and the program will extract the servername from before the first ':'. There should probably be a better parsing system that copes with different map formats and also Amd (another automounter) maps. A working NIS client is required on the system for this option to work. Example: amd.homedir kernel change notify This parameter specifies whether Samba should ask the kernel for change notifications in directories so that SMB clients can refresh whenever the data on the server changes. This parameter is only used when your kernel supports change notification to user programs using the inotify interface. lock directory This option specifies the directory where lock files will be placed. The lock files are used to implement the option. Note: This option can not be set inside registry configurations. The files placed in this directory are not required across service restarts and can be safely placed on volatile storage (e.g. tmpfs in Linux) Example: /var/run/samba/locks log writeable files on exit When the network connection between a CIFS client and Samba dies, Samba has no option but to simply shut down the server side of the network connection. If this happens, there is a risk of data corruption because the Windows client did not complete all write operations that the Windows application requested. Setting this option to "yes" makes smbd log with a level 0 message a list of all files that have been opened for writing when the network connection died. Those are the files that are potentially corrupted. It is meant as an aid for the administrator to give him a list of files to do consistency checks on. message command This specifies what command to run when the server receives a WinPopup style message. This would normally be a command that would deliver the message somehow. How this is to be done is up to your imagination. An example is: message command = csh -c 'xedit %s;rm %s' & This delivers the message using xedit, then removes it afterwards. NOTE THAT IT IS VERY IMPORTANT THAT THIS COMMAND RETURN IMMEDIATELY. That's why I have the '&' on the end. If it doesn't return immediately then your PCs may freeze when sending messages (they should recover after 30 seconds, hopefully). All messages are delivered as the global guest user. The command takes the standard substitutions, although %u won't work (%U may be better in this case). Apart from the standard substitutions, some additional ones apply. In particular: %s = the filename containing the message. %t = the destination that the message was sent to (probably the server name). %f = who the message is from. You could make this command send mail, or whatever else takes your fancy. Please let us know of any really interesting ideas you have. Here's a way of sending the messages as mail to root: message command = /bin/mail -s 'message from %f on %m' root < %s; rm %s If you don't have a message command then the message won't be delivered and Samba will tell the sender there was an error. Unfortunately WfWg totally ignores the error code and carries on regardless, saying that the message was delivered. If you want to silently delete it then try: message command = rm %s Example: csh -c 'xedit %s; rm %s' & nbt client socket address This option allows you to control what address Samba will send NBT client packets from, and process replies using, including in nmbd. Setting this option should never be necessary on usual Samba servers running only one nmbd. By default Samba will send UDP packets from the OS default address for the destination, and accept replies on 0.0.0.0. This parameter is deprecated. See Yes and for the previous behaviour of controlling the normal listening sockets. Example: 192.168.2.20 ncalrpc dir This directory will hold a series of named pipes to allow RPC over inter-process communication. This will allow Samba and other unix processes to interact over DCE/RPC without using TCP/IP. Additionally a sub-directory 'np' has restricted permissions, and allows a trusted communication channel between Samba processes Example: /var/run/samba/ncalrpc NIS homedir Get the home share server from a NIS map. For UNIX systems that use an automounter, the user's home directory will often be mounted on a workstation on demand from a remote server. When the Samba logon server is not the actual home directory server, but is mounting the home directories via NFS then two network hops would be required to access the users home directory if the logon server told the client to use itself as the SMB server for home directories (one over SMB and one over NFS). This can be very slow. This option allows Samba to return the home share as being on a different server to the logon server and as long as a Samba daemon is running on the home directory server, it will be mounted on the Samba client directly from the directory server. When Samba is returning the home share to the client, it will consult the NIS map specified in and return the server listed there. Note that for this option to work there must be a working NIS system and the Samba server with this option must also be a logon server. nmbd bind explicit broadcast This option causes nmbd 8 to explicitly bind to the broadcast address of the local subnets. This is needed to make nmbd work correctly in combination with the option. You should not need to unset this option. panic action This is a Samba developer option that allows a system command to be called when either smbd 8 or nmbd 8 crashes. This is usually used to draw attention to the fact that a problem occurred. Example: /bin/sleep 90000 perfcount module This parameter specifies the perfcount backend to be used when monitoring SMB operations. Only one perfcount module may be used, and it must implement all of the apis contained in the smb_perfcount_handler structure defined in smb.h. pid directory This option specifies the directory where pid files will be placed. Example: /var/run/ registry shares This turns on or off support for share definitions read from registry. Shares defined in smb.conf take precedence over shares with the same name defined in registry. See the section on registry-based configuration for details. Note that this parameter defaults to no, but it is set to yes when config backend is set to registry. Example: yes remote announce This option allows you to setup nmbd 8 to periodically announce itself to arbitrary IP addresses with an arbitrary workgroup name. This is useful if you want your Samba server to appear in a remote workgroup for which the normal browse propagation rules don't work. The remote workgroup can be anywhere that you can send IP packets to. For example: remote announce = 192.168.2.255/SERVERS 192.168.4.255/STAFF the above line would cause nmbd to announce itself to the two given IP addresses using the given workgroup names. If you leave out the workgroup name, then the one given in the parameter is used instead. The IP addresses you choose would normally be the broadcast addresses of the remote networks, but can also be the IP addresses of known browse masters if your network config is that stable. See the chapter on Network Browsing in the Samba-HOWTO book. remote browse sync This option allows you to setup nmbd 8 to periodically request synchronization of browse lists with the master browser of a Samba server that is on a remote segment. This option will allow you to gain browse lists for multiple workgroups across routed networks. This is done in a manner that does not work with any non-Samba servers. This is useful if you want your Samba server and all local clients to appear in a remote workgroup for which the normal browse propagation rules don't work. The remote workgroup can be anywhere that you can send IP packets to. For example: remote browse sync = 192.168.2.255 192.168.4.255 the above line would cause nmbd to request the master browser on the specified subnets or addresses to synchronize their browse lists with the local server. The IP addresses you choose would normally be the broadcast addresses of the remote networks, but can also be the IP addresses of known browse masters if your network config is that stable. If a machine IP address is given Samba makes NO attempt to validate that the remote machine is available, is listening, nor that it is in fact the browse master on its segment. The may be used on networks where there is no WINS server, and may be used on disjoint networks where each network has its own WINS server. reset on zero vc This boolean option controls whether an incoming SMB1 session setup should kill other connections coming from the same IP. This matches the default Windows 2003 behaviour. Setting this parameter to yes becomes necessary when you have a flaky network and windows decides to reconnect while the old connection still has files with share modes open. These files become inaccessible over the new connection. The client sends a zero VC on the new connection, and Windows 2003 kills all other connections coming from the same IP. This way the locked files are accessible again. Please be aware that enabling this option will kill connections behind a masquerading router, and will not trigger for clients that only use SMB2 or SMB3. rpc_daemon:DAEMON Defines whether to use the embedded code or start a separate daemon for the defined rpc services. The rpc_daemon prefix must be followed by the server name, and a value. Two possible values are currently supported: disabled fork The classic method is to run rpc services as internal daemons embedded in smbd, therefore the external daemons are disabled by default. Choosing the fork option will cause samba to fork a separate process for each daemon configured this way. Each daemon may in turn fork a number of children used to handle requests from multiple smbds and direct tcp/ip connections (if the Endpoint Mapper is enabled). Communication with smbd happens over named pipes and require that said pipes are forward to the external daemon (see ). Forked RPC Daemons support dynamically forking children to handle connections. The heuristics about how many children to keep around and how fast to allow them to fork and also how many clients each child is allowed to handle concurrently is defined by parametrical options named after the daemon. Five options are currently supported: prefork_min_children prefork_max_children prefork_spawn_rate prefork_max_allowed_clients prefork_child_min_life To set one of these options use the following syntax: daemonname:prefork_min_children = 5 Samba includes separate daemons for spoolss, lsarpc/lsass, netlogon, samr, FSRVP and mdssvc(Spotlight). Currently five daemons are available and they are called: epmd lsasd spoolssd fssd mdssd Example: rpc_daemon:spoolssd = fork rpc_server:SERVER With this option you can define if a rpc service should be running internal/embedded in smbd or should be redirected to an external daemon like Samba4, the endpoint mapper daemon, the spoolss daemon or the new LSA service daemon. The rpc_server prefix must be followed by the pipe name, and a value. This option can be set for each available rpc service in Samba. The following list shows all available pipe names services you can modify with this option. epmapper - Endpoint Mapper winreg - Remote Registry Service srvsvc - Remote Server Services lsarpc - Local Security Authority samr - Security Account Management netlogon - Netlogon Remote Protocol netdfs - Settings for Distributed File System dssetup - Active Directory Setup wkssvc - Workstation Services spoolss - Network Printing Spooler svcctl - Service Control ntsvcs - Plug and Play Services eventlog - Event Logger initshutdown - Init Shutdown Service mdssvc - Spotlight Three possible values currently supported are: embedded external disabled The classic method is to run every pipe as an internal function embedded in smbd. The defaults may vary depending on the service. Choosing the external option allows one to run a separate daemon or even a completely independent (3rd party) server capable of interfacing with samba via the MS-RPC interface over named pipes. Currently in Samba3 we support four daemons, spoolssd, epmd, lsasd and mdssd. These daemons can be enabled using the rpc_daemon option. For spoolssd you have to enable the daemon and proxy the named pipe with: Examples: rpc_daemon:lsasd = fork rpc_server:lsarpc = external rpc_server:samr = external rpc_server:netlogon = external rpc_server:spoolss = external rpc_server:epmapper = disabled rpc_daemon:mdssd = fork rpc_server:mdssvc = external There is one special option which allows you to enable rpc services to listen for ncacn_ip_tcp connections too. Currently this is only used for testing and doesn't scale! rpc_server:tcpip = yes smbd profiling level This parameter allows the administrator to enable profiling support. Possible values are off, count and on. Example: on state directory Usually, most of the TDB files are stored in the lock directory. Since Samba 3.4.0, it is possible to differentiate between TDB files with persistent data and TDB files with non-persistent data using the state directory and the cache directory options. This option specifies the directory where TDB files containing important persistent data will be stored. Example: /var/run/samba/locks/state usershare allow guests This parameter controls whether user defined shares are allowed to be accessed by non-authenticated users or not. It is the equivalent of allowing people who can create a share the option of setting guest ok = yes in a share definition. Due to its security sensitive nature, the default is set to off. usershare max shares This parameter specifies the number of user defined shares that are allowed to be created by users belonging to the group owning the usershare directory. If set to zero (the default) user defined shares are ignored. usershare owner only This parameter controls whether the pathname exported by a user defined shares must be owned by the user creating the user defined share or not. If set to True (the default) then smbd checks that the directory path being shared is owned by the user who owns the usershare file defining this share and refuses to create the share if not. If set to False then no such check is performed and any directory path may be exported regardless of who owns it. usershare path This parameter specifies the absolute path of the directory on the filesystem used to store the user defined share definition files. This directory must be owned by root, and have no access for other, and be writable only by the group owner. In addition the "sticky" bit must also be set, restricting rename and delete to owners of a file (in the same way the /tmp directory is usually configured). Members of the group owner of this directory are the users allowed to create usershares. For example, a valid usershare directory might be /usr/local/samba/lib/usershares, set up as follows. ls -ld /usr/local/samba/lib/usershares/ drwxrwx--T 2 root power_users 4096 2006-05-05 12:27 /usr/local/samba/lib/usershares/ In this case, only members of the group "power_users" can create user defined shares. usershare prefix allow list This parameter specifies a list of absolute pathnames the root of which are allowed to be exported by user defined share definitions. If the pathname to be exported doesn't start with one of the strings in this list, the user defined share will not be allowed. This allows the Samba administrator to restrict the directories on the system that can be exported by user defined shares. If there is a "usershare prefix deny list" and also a "usershare prefix allow list" the deny list is processed first, followed by the allow list, thus leading to the most restrictive interpretation. Example: /home /data /space usershare prefix deny list This parameter specifies a list of absolute pathnames the root of which are NOT allowed to be exported by user defined share definitions. If the pathname exported starts with one of the strings in this list the user defined share will not be allowed. Any pathname not starting with one of these strings will be allowed to be exported as a usershare. This allows the Samba administrator to restrict the directories on the system that can be exported by user defined shares. If there is a "usershare prefix deny list" and also a "usershare prefix allow list" the deny list is processed first, followed by the allow list, thus leading to the most restrictive interpretation. Example: /etc /dev /private usershare template share User defined shares only have limited possible parameters such as path, guest ok, etc. This parameter allows usershares to "cloned" from an existing share. If "usershare template share" is set to the name of an existing share, then all usershares created have their defaults set from the parameters set on this share. The target share may be set to be invalid for real file sharing by setting the parameter "-valid = False" on the template share definition. This causes it not to be seen as a real exported share but to be able to be used as a template for usershares. Example: template_share utmp This boolean parameter is only available if Samba has been configured and compiled with the option --with-utmp. If set to yes then Samba will attempt to add utmp or utmpx records (depending on the UNIX system) whenever a connection is made to a Samba server. Sites may use this to record the user connecting to a Samba share. Due to the requirements of the utmp record, we are required to create a unique identifier for the incoming user. Enabling this option creates an n^2 algorithm to find this number. This may impede performance on large installations. utmp directory This parameter is only available if Samba has been configured and compiled with the option --with-utmp. It specifies a directory pathname that is used to store the utmp or utmpx files (depending on the UNIX system) that record user connections to a Samba server. By default this is not set, meaning the system will use whatever utmp file the native system is set to use (usually /var/run/utmp on Linux). Example: /var/run/utmp wtmp directory This parameter is only available if Samba has been configured and compiled with the option --with-utmp. It specifies a directory pathname that is used to store the wtmp or wtmpx files (depending on the UNIX system) that record user connections to a Samba server. The difference with the utmp directory is the fact that user info is kept after a user has logged out. By default this is not set, meaning the system will use whatever utmp file the native system is set to use (usually /var/run/wtmp on Linux). Example: /var/log/wtmp addport command Samba 3.0.23 introduced support for adding printer ports remotely using the Windows "Add Standard TCP/IP Port Wizard". This option defines an external program to be executed when smbd receives a request to add a new Port to the system. The script is passed two parameters: port name device URI The deviceURI is in the format of socket://<hostname>[:<portnumber>] or lpd://<hostname>/<queuename>. Example: /etc/samba/scripts/addport.sh addprinter command With the introduction of MS-RPC based printing support for Windows NT/2000 clients in Samba 2.2, The MS Add Printer Wizard (APW) icon is now also available in the "Printers..." folder displayed a share listing. The APW allows for printers to be add remotely to a Samba or Windows NT/2000 print server. For a Samba host this means that the printer must be physically added to the underlying printing system. The addprinter command defines a script to be run which will perform the necessary operations for adding the printer to the print system and to add the appropriate service definition to the smb.conf file in order that it can be shared by smbd 8. The addprinter command is automatically invoked with the following parameter (in order): printer name share name port name driver name location Windows 9x driver location All parameters are filled in from the PRINTER_INFO_2 structure sent by the Windows NT/2000 client with one exception. The "Windows 9x driver location" parameter is included for backwards compatibility only. The remaining fields in the structure are generated from answers to the APW questions. Once the addprinter command has been executed, smbd will reparse the smb.conf to determine if the share defined by the APW exists. If the sharename is still invalid, then smbd will return an ACCESS_DENIED error to the client. The addprinter command program can output a single line of text, which Samba will set as the port the new printer is connected to. If this line isn't output, Samba won't reload its printer shares. Example: /usr/bin/addprinter cups connection timeout This parameter is only applicable if is set to cups. If set, this option specifies the number of seconds that smbd will wait whilst trying to contact to the CUPS server. The connection will fail if it takes longer than this number of seconds. Example: 60 cups encrypt This parameter is only applicable if is set to cups and if you use CUPS newer than 1.0.x.It is used to define whether or not Samba should use encryption when talking to the CUPS server. Possible values are auto, yes and no When set to auto we will try to do a TLS handshake on each CUPS connection setup. If that fails, we will fall back to unencrypted operation. cups server This parameter is only applicable if is set to cups. If set, this option overrides the ServerName option in the CUPS client.conf. This is necessary if you have virtual samba servers that connect to different CUPS daemons. Optionally, a port can be specified by separating the server name and port number with a colon. If no port was specified, the default port for IPP (631) will be used. Example: mycupsserver Example: mycupsserver:1631 deleteprinter command With the introduction of MS-RPC based printer support for Windows NT/2000 clients in Samba 2.2, it is now possible to delete a printer at run time by issuing the DeletePrinter() RPC call. For a Samba host this means that the printer must be physically deleted from the underlying printing system. The defines a script to be run which will perform the necessary operations for removing the printer from the print system and from smb.conf. The is automatically called with only one parameter: . Once the has been executed, smbd will reparse the smb.conf to check that the associated printer no longer exists. If the sharename is still valid, then smbd will return an ACCESS_DENIED error to the client. Example: /usr/bin/removeprinter disable spoolss Enabling this parameter will disable Samba's support for the SPOOLSS set of MS-RPC's and will yield identical behavior as Samba 2.0.x. Windows NT/2000 clients will downgrade to using Lanman style printing commands. Windows 9x/ME will be unaffected by the parameter. However, this will also disable the ability to upload printer drivers to a Samba server via the Windows NT Add Printer Wizard or by using the NT printer properties dialog window. It will also disable the capability of Windows NT/2000 clients to download print drivers from the Samba host upon demand. Be very careful about enabling this parameter. enable spoolss Inverted synonym for . enumports command The concept of a "port" is fairly foreign to UNIX hosts. Under Windows NT/2000 print servers, a port is associated with a port monitor and generally takes the form of a local port (i.e. LPT1:, COM1:, FILE:) or a remote port (i.e. LPD Port Monitor, etc...). By default, Samba has only one port defined--"Samba Printer Port". Under Windows NT/2000, all printers must have a valid port name. If you wish to have a list of ports displayed (smbd does not use a port name for anything) other than the default "Samba Printer Port", you can define enumports command to point to a program which should generate a list of ports, one per line, to standard output. This listing will then be used in response to the level 1 and 2 EnumPorts() RPC. Example: /usr/bin/listports iprint server This parameter is only applicable if is set to iprint. If set, this option overrides the ServerName option in the CUPS client.conf. This is necessary if you have virtual samba servers that connect to different CUPS daemons. Example: MYCUPSSERVER load printers A boolean variable that controls whether all printers in the printcap will be loaded for browsing by default. See the section for more details. lpq cache time This controls how long lpq info will be cached for to prevent the lpq command being called too often. A separate cache is kept for each variation of the lpq command used by the system, so if you use different lpq commands for different users then they won't share cache information. The cache files are stored in /tmp/lpq.xxxx where xxxx is a hash of the lpq command in use. The default is 30 seconds, meaning that the cached results of a previous identical lpq command will be used if the cached data is less than 30 seconds old. A large value may be advisable if your lpq command is very slow. A value of 0 will disable caching completely. Example: 10 os2 driver map The parameter is used to define the absolute path to a file containing a mapping of Windows NT printer driver names to OS/2 printer driver names. The format is: <nt driver name> = <os2 driver name>.<device name> For example, a valid entry using the HP LaserJet 5 printer driver would appear as HP LaserJet 5L = LASERJET.HP LaserJet 5L. The need for the file is due to the printer driver namespace problem described in the chapter on Classical Printing in the Samba3-HOWTO book. For more details on OS/2 clients, please refer to chapter on other clients in the Samba3-HOWTO book. printcap cache time This option specifies the number of seconds before the printing subsystem is again asked for the known printers. Setting this parameter to 0 disables any rescanning for new or removed printers after the initial startup. Example: 600 printcap name This parameter may be used to override the compiled-in default printcap name used by the server (usually /etc/printcap). See the discussion of the [printers] section above for reasons why you might want to do this. To use the CUPS printing interface set printcap name = cups . This should be supplemented by an additional setting cups in the [global] section. printcap name = cups will use the "dummy" printcap created by CUPS, as specified in your CUPS configuration file. On System V systems that use lpstat to list available printers you can use printcap name = lpstat to automatically obtain lists of available printers. This is the default for systems that define SYSV at configure time in Samba (this includes most System V based systems). If printcap name is set to lpstat on these systems then Samba will launch lpstat -v and attempt to parse the output to obtain a printer list. A minimal printcap file would look something like this: print1|My Printer 1 print2|My Printer 2 print3|My Printer 3 print4|My Printer 4 print5|My Printer 5 where the '|' separates aliases of a printer. The fact that the second alias has a space in it gives a hint to Samba that it's a comment. Under AIX the default printcap name is /etc/qconfig. Samba will assume the file is in AIX qconfig format if the string qconfig appears in the printcap filename. Example: /etc/myprintcap show add printer wizard With the introduction of MS-RPC based printing support for Windows NT/2000 client in Samba 2.2, a "Printers..." folder will appear on Samba hosts in the share listing. Normally this folder will contain an icon for the MS Add Printer Wizard (APW). However, it is possible to disable this feature regardless of the level of privilege of the connected user. Under normal circumstances, the Windows NT/2000 client will open a handle on the printer server with OpenPrinterEx() asking for Administrator privileges. If the user does not have administrative access on the print server (i.e is not root or has granted the SePrintOperatorPrivilege), the OpenPrinterEx() call fails and the client makes another open call with a request for a lower privilege level. This should succeed, however the APW icon will not be displayed. Disabling the show add printer wizard parameter will always cause the OpenPrinterEx() on the server to fail. Thus the APW icon will never be displayed. This does not prevent the same user from having administrative privilege on an individual printer. spoolss: architecture Windows spoolss print clients only allow association of server-side drivers with printers when the driver architecture matches the advertised print server architecture. Samba's spoolss print server architecture can be changed using this parameter. Example: Windows x64 spoolss: os_major Windows might require a new os version number. This option allows to modify the build number. The complete default version number is: 5.0.2195 (Windows 2000). The example is 6.1.7601 (Windows 2008 R2). Example: 6 spoolss: os_minor Windows might require a new os version number. This option allows to modify the build number. The complete default version number is: 5.0.2195 (Windows 2000). The example is 6.1.7601 (Windows 2008 R2). Example: 1 spoolss: os_build Windows might require a new os version number. This option allows to modify the build number. The complete default version number is: 5.0.2195 (Windows 2000). The example is 6.1.7601 (Windows 2008 R2). Example: 7601 spoolss_client: os_major Windows might require a new os version number. This option allows to modify the build number. The complete default version number is: 6.1.7007 (Windows 7 and Windows Server 2008 R2). spoolss_client: os_minor Windows might require a new os version number. This option allows to modify the build number. The complete default version number is: 6.1.7007 (Windows 7 and Windows Server 2008 R2). spoolss_client: os_build Windows might require a new os version number. This option allows to modify the build number. The complete default version number is: 6.1.7007 (Windows 7 and Windows Server 2008 R2). cldap port This option controls the port used by the CLDAP protocol. Example: 3389 client ipc max protocol The value of the parameter (a string) is the highest protocol level that will be supported for IPC$ connections as DCERPC transport. Normally this option should not be set as the automatic negotiation phase in the SMB protocol takes care of choosing the appropriate protocol. The value default refers to the latest supported protocol, currently SMB3_11. See for a full list of available protocols. The values CORE, COREPLUS, LANMAN1, LANMAN2 are silently upgraded to NT1. Example: SMB2_10 client ipc min protocol This setting controls the minimum protocol version that the will be attempted to use for IPC$ connections as DCERPC transport. Normally this option should not be set as the automatic negotiation phase in the SMB protocol takes care of choosing the appropriate protocol. The value default refers to the higher value of NT1 and the effective value of . See for a full list of available protocols. The values CORE, COREPLUS, LANMAN1, LANMAN2 are silently upgraded to NT1. Example: SMB3_11 client max protocol The value of the parameter (a string) is the highest protocol level that will be supported by the client. Possible values are : CORE: Earliest version. No concept of user names. COREPLUS: Slight improvements on CORE for efficiency. LANMAN1: First modern version of the protocol. Long filename support. LANMAN2: Updates to Lanman1 protocol. NT1: Current up to date version of the protocol. Used by Windows NT. Known as CIFS. SMB2: Re-implementation of the SMB protocol. Used by Windows Vista and later versions of Windows. SMB2 has sub protocols available. SMB2_02: The earliest SMB2 version. SMB2_10: Windows 7 SMB2 version. By default SMB2 selects the SMB2_10 variant. SMB3: The same as SMB2. Used by Windows 8. SMB3 has sub protocols available. SMB3_00: Windows 8 SMB3 version. SMB3_02: Windows 8.1 SMB3 version. SMB3_11: Windows 10 SMB3 version. By default SMB3 selects the SMB3_11 variant. Normally this option should not be set as the automatic negotiation phase in the SMB protocol takes care of choosing the appropriate protocol. The value default refers to SMB3_11. IPC$ connections for DCERPC e.g. in winbindd, are handled by the option. Example: LANMAN1 client min protocol This setting controls the minimum protocol version that the client will attempt to use. Normally this option should not be set as the automatic negotiation phase in the SMB protocol takes care of choosing the appropriate protocol unless you connect to a legacy SMB1-only server. See client max protocol for a full list of available protocols. IPC$ connections for DCERPC e.g. in winbindd, are handled by the option. Note that most command line tools support --option='client min protocol=NT1', so it may not be required to enable SMB1 protocols globally in smb.conf. Example: NT1 client use spnego This variable controls whether Samba clients will try to use Simple and Protected NEGOtiation (as specified by rfc2478) with supporting servers (including WindowsXP, Windows2000 and Samba 3.0) to agree upon an authentication mechanism. This enables Kerberos authentication in particular. When is also set to yes extended security (SPNEGO) is required in order to use NTLMv2 only within NTLMSSP. This behavior was introduced with the patches for CVE-2016-2111. dcerpc endpoint servers Specifies which DCE/RPC endpoint servers should be run. Example: rpcecho defer sharing violations Windows allows specifying how a file will be shared with other processes when it is opened. Sharing violations occur when a file is opened by a different process using options that violate the share settings specified by other processes. This parameter causes smbd to act as a Windows server does, and defer returning a "sharing violation" error message for up to one second, allowing the client to close the file causing the violation in the meantime. UNIX by default does not have this behaviour. There should be no reason to turn off this parameter, as it is designed to enable Samba to more correctly emulate Windows. dgram port Specifies which ports the server should listen on for NetBIOS datagram traffic. disable netbios Enabling this parameter will disable netbios support in Samba. Netbios is the only available form of browsing in all windows versions except for 2000 and XP. Clients that only support netbios won't be able to see your samba server when netbios support is disabled. enable asu support Hosts running the "Advanced Server for Unix (ASU)" product require some special accommodations such as creating a builtin [ADMIN$] share that only supports IPC connections. The has been the default behavior in smbd for many years. However, certain Microsoft applications such as the Print Migrator tool require that the remote server support an [ADMIN$] file share. Disabling this parameter allows for creating an [ADMIN$] file share in smb.conf. eventlog list This option defines a list of log names that Samba will report to the Microsoft EventViewer utility. The listed eventlogs will be associated with tdb file on disk in the $(statedir)/eventlog. The administrator must use an external process to parse the normal Unix logs such as /var/log/messages and write then entries to the eventlog tdb files. Refer to the eventlogadm(8) utility for how to write eventlog entries. Example: Security Application Syslog Apache large readwrite This parameter determines whether or not smbd 8 supports the new 64k streaming read and write variant SMB requests introduced with Windows 2000. Note that due to Windows 2000 client redirector bugs this requires Samba to be running on a 64-bit capable operating system such as IRIX, Solaris or a Linux 2.4 kernel. Can improve performance by 10% with Windows 2000 clients. Defaults to on. Not as tested as some other Samba code paths. lsa over netlogon Setting this deprecated option will allow the RPC server in the AD DC to answer the LSARPC interface on the \pipe\netlogon IPC pipe. When enabled, this matches the behaviour of Microsoft's Windows, due to their internal implementation choices. If it is disabled (the default), the AD DC can offer improved performance, as the netlogon server is decoupled and can run as multiple processes. max mux This option controls the maximum number of outstanding simultaneous SMB operations that Samba tells the client it will allow. You should never need to set this parameter. max ttl This option tells nmbd 8 what the default 'time to live' of NetBIOS names should be (in seconds) when nmbd is requesting a name using either a broadcast packet or from a WINS server. You should never need to change this parameter. The default is 3 days. max xmit This option controls the maximum packet size that will be negotiated by Samba's smbd8 for the SMB1 protocol. The default is 16644, which matches the behavior of Windows 2000. A value below 2048 is likely to cause problems. You should never need to change this parameter from its default value. Example: 8192 min receivefile size This option changes the behavior of smbd 8 when processing SMBwriteX calls. Any incoming SMBwriteX call on a non-signed SMB/CIFS connection greater than this value will not be processed in the normal way but will be passed to any underlying kernel recvfile or splice system call (if there is no such call Samba will emulate in user space). This allows zero-copy writes directly from network socket buffers into the filesystem buffer cache, if available. It may improve performance but user testing is recommended. If set to zero Samba processes SMBwriteX calls in the normal way. To enable POSIX large write support (SMB/CIFS writes up to 16Mb) this option must be nonzero. The maximum value is 128k. Values greater than 128k will be silently set to 128k. Note this option will have NO EFFECT if set on a SMB signed connection. The default is zero, which disables this option. name resolve order This option is used by the programs in the Samba suite to determine what naming services to use and in what order to resolve host names to IP addresses. Its main purpose to is to control how netbios name resolution is performed. The option takes a space separated string of name resolution options. The options are: "lmhosts", "host", "wins" and "bcast". They cause names to be resolved as follows: lmhosts : Lookup an IP address in the Samba lmhosts file. If the line in lmhosts has no name type attached to the NetBIOS name (see the manpage for lmhosts for details) then any name type matches for lookup. host : Do a standard host name to IP address resolution, using the system /etc/hosts , NIS, or DNS lookups. This method of name resolution is operating system depended for instance on IRIX or Solaris this may be controlled by the /etc/nsswitch.conf file. Note that this method is used only if the NetBIOS name type being queried is the 0x20 (server) name type or 0x1c (domain controllers). The latter case is only useful for active directory domains and results in a DNS query for the SRV RR entry matching _ldap._tcp.domain. wins : Query a name with the IP address listed in the wins server parameter. If no WINS server has been specified this method will be ignored. bcast : Do a broadcast on each of the known local interfaces listed in the parameter. This is the least reliable of the name resolution methods as it depends on the target host being on a locally connected subnet. The example below will cause the local lmhosts file to be examined first, followed by a broadcast attempt, followed by a normal system hostname lookup. When Samba is functioning in ADS security mode (security = ads) it is advised to use following settings for name resolve order: name resolve order = wins bcast DC lookups will still be done via DNS, but fallbacks to netbios names will not inundate your DNS servers with needless queries for DOMAIN<0x1c> lookups. Example: lmhosts bcast host nbt port Specifies which port the server should use for NetBIOS over IP name services traffic. nt pipe support This boolean parameter controls whether smbd 8 will allow Windows NT clients to connect to the NT SMB specific IPC$ pipes. This is a developer debugging option and can be left alone. nt status support This boolean parameter controls whether smbd 8 will negotiate NT specific status support with Windows NT/2k/XP clients. This is a developer debugging option and should be left alone. If this option is set to no then Samba offers exactly the same DOS error codes that versions prior to Samba 2.2.3 reported. You should not need to ever disable this parameter. read raw This is ignored if is set, because this feature is incompatible with raw read SMB requests If enabled, raw reads allow reads of 65535 bytes in one packet. This typically provides a major performance benefit for some very, very old clients. However, some clients either negotiate the allowable block size incorrectly or are incapable of supporting larger block sizes, and for these clients you may need to disable raw reads. In general this parameter should be viewed as a system tuning tool and left severely alone. rpc big endian Setting this option will force the RPC client and server to transfer data in big endian. If it is disabled, data will be transferred in little endian. The behaviour is independent of the endianness of the host machine. rpc server port Specifies which port the server should listen on for DCE/RPC over TCP/IP traffic. This controls the default port for all protocols, except for NETLOGON. If unset, the first available port from is used, e.g. 49152. The NETLOGON server will use the next available port, e.g. 49153. To change this port use (eg) rpc server port:netlogon = 4000. Furthermore, all RPC servers can have the port they use specified independenty, with (for example) rpc server port:drsuapi = 5000. This option applies currently only when samba 8 runs as an active directory domain controller. The default value 0 causes Samba to select the first available port from . server max protocol The value of the parameter (a string) is the highest protocol level that will be supported by the server. Possible values are : LANMAN1: First modern version of the protocol. Long filename support. LANMAN2: Updates to Lanman1 protocol. NT1: Current up to date version of the protocol. Used by Windows NT. Known as CIFS. SMB2: Re-implementation of the SMB protocol. Used by Windows Vista and later versions of Windows. SMB2 has sub protocols available. SMB2_02: The earliest SMB2 version. SMB2_10: Windows 7 SMB2 version. By default SMB2 selects the SMB2_10 variant. SMB3: The same as SMB2. Used by Windows 8. SMB3 has sub protocols available. SMB3_00: Windows 8 SMB3 version. SMB3_02: Windows 8.1 SMB3 version. SMB3_11: Windows 10 SMB3 version. By default SMB3 selects the SMB3_11 variant. Normally this option should not be set as the automatic negotiation phase in the SMB protocol takes care of choosing the appropriate protocol. Example: LANMAN1 server min protocol This setting controls the minimum protocol version that the server will allow the client to use. Normally this option should not be set as the automatic negotiation phase in the SMB protocol takes care of choosing the appropriate protocol unless you have legacy clients which are SMB1 capable only. See server max protocol for a full list of available protocols. Example: NT1 share:fake_fscaps This is needed to support some special application that makes QFSINFO calls to check whether we set the SPARSE_FILES bit (0x40). If this bit is not set that particular application refuses to work against Samba. With 64 the SPARSE_FILES file system capability flag is set. Use other decimal values to specify the bitmask you need to fake. smb2 max credits This option controls the maximum number of outstanding simultaneous SMB2 operations that Samba tells the client it will allow. This is similar to the parameter for SMB1. You should never need to set this parameter. The default is 8192 credits, which is the same as a Windows 2008R2 SMB2 server. smb2 max read This option specifies the protocol value that smbd 8 will return to a client, informing the client of the largest size that may be returned by a single SMB2 read call. The maximum is 8388608 bytes (8MiB), which is the same as a Windows Server 2012 r2. Please note that the default is 8MiB, but it's limit is based on the smb2 dialect (64KiB for SMB == 2.0, 8MiB for SMB >= 2.1 with LargeMTU). Large MTU is not supported over NBT (tcp port 139). smb2 max trans This option specifies the protocol value that smbd 8 will return to a client, informing the client of the largest size of buffer that may be used in querying file meta-data via QUERY_INFO and related SMB2 calls. The maximum is 8388608 bytes (8MiB), which is the same as a Windows Server 2012 r2. Please note that the default is 8MiB, but it's limit is based on the smb2 dialect (64KiB for SMB == 2.0, 1MiB for SMB >= 2.1 with LargeMTU). Large MTU is not supported over NBT (tcp port 139). smb2 max write This option specifies the protocol value that smbd 8 will return to a client, informing the client of the largest size that may be sent to the server by a single SMB2 write call. The maximum is 8388608 bytes (8MiB), which is the same as a Windows Server 2012 r2. Please note that the default is 8MiB, but it's limit is based on the smb2 dialect (64KiB for SMB == 2.0, 8MiB for SMB => 2.1 with LargeMTU). Large MTU is not supported over NBT (tcp port 139). smb ports Specifies which ports the server should listen on for SMB traffic. svcctl list This option defines a list of init scripts that smbd will use for starting and stopping Unix services via the Win32 ServiceControl API. This allows Windows administrators to utilize the MS Management Console plug-ins to manage a Unix server running Samba. The administrator must create a directory name svcctl in Samba's $(libdir) and create symbolic links to the init scripts in /etc/init.d/. The name of the links must match the names given as part of the svcctl list. Example: cups postfix portmap httpd time server This parameter determines if nmbd 8 advertises itself as a time server to Windows clients. unicode Specifies whether the server and client should support unicode. If this option is set to false, the use of ASCII will be forced. unix extensions This boolean parameter controls whether Samba implements the CIFS UNIX extensions, as defined by HP. These extensions enable Samba to better serve UNIX CIFS clients by supporting features such as symbolic links, hard links, etc... These extensions require a similarly enabled client, and are of no current use to Windows clients. Note if this parameter is turned on, the parameter will automatically be disabled. See the parameter if you wish to change this coupling between the two parameters. write raw This is ignored if is set, because this feature is incompatible with raw write SMB requests If enabled, raw writes allow writes of 65535 bytes in one packet. This typically provides a major performance benefit for some very, very old clients. However, some clients either negotiate the allowable block size incorrectly or are incapable of supporting larger block sizes, and for these clients you may need to disable raw writes. In general this parameter should be viewed as a system tuning tool and left severely alone. server multi channel support This boolean parameter controls whether smbd 8 will support SMB3 multi-channel. This parameter was added with version 4.4. Warning: Note that this feature is still considered experimental. Use it at your own risk: Even though it may seem to work well in testing, it may result in data corruption under some race conditions. Future releases may improve this situation. Due to dependencies to kernel APIs of Linux or FreeBSD, it's only possible to use this feature on Linux and FreeBSD for now. For testing this restriction can be overwritten by specifying force:server multi channel support=yes in addition. smb2 disable lock sequence checking This boolean parameter controls whether smbd 8 will disable lock sequence checking even for multi-channel connections as well as durable handles. The [MS-SMB2] specification (under 3.3.5.14 Receiving an SMB2 LOCK Request) documents that a server should do lock sequence if Open.IsResilient or Open.IsDurable or Open.IsPersistent is TRUE or if Connection.Dialect belongs to the SMB 3.x dialect family and Connection.ServerCapabilities includes SMB2_GLOBAL_CAP_MULTI_CHANNEL. But Windows Server (at least up to v2004) only does these checks for the Open.IsResilient and Open.IsPersistent. That means they do not implement the behavior specified in [MS-SMB2]. By default Samba behaves according to the specification and sends smb2 oplock break notification retries. Warning: Only enable this option if existing clients can't handle lock sequence checking for handles without Open.IsResilient and Open.IsPersistent. And it turns out that the Windows Server behavior is required. Note: it's likely that this option will be removed again if future Windows versions change their behavior. Note: Samba does not implement Open.IsResilient and Open.IsPersistent yet. Example: yes smb2 disable oplock break retry This boolean parameter controls whether smbd 8 will trigger smb2 oplock break notification retries when using yes. The [MS-SMB2] specification documents that a server should send smb2 oplock break notification retries on all available channel to the given client. But Windows Server versions (at least up to 2019) do not send smb2 oplock break notification retries on channel failures. That means they do not implement the behavior specified in [MS-SMB2]. By default Samba behaves according to the specification and send smb2 oplock break notification retries. Warning: Only enable this option if existing clients can't handle possible retries and it turns out that the Windows Server behavior is required. Note: it's likely that this option gets removed again if future Windows versions change their behavior. Note: this only applies to oplocks and not SMB2 leases. Example: yes rpc server dynamic port range This parameter tells the RPC server which port range it is allowed to use to create a listening socket for LSA, SAM, Netlogon and others without wellknown tcp ports. The first value is the lowest number of the port range and the second the highest. This applies to RPC servers in all server roles. algorithmic rid base This determines how Samba will use its algorithmic mapping from uids/gid to the RIDs needed to construct NT Security Identifiers. Setting this option to a larger value could be useful to sites transitioning from WinNT and Win2k, as existing user and group rids would otherwise clash with system users etc. All UIDs and GIDs must be able to be resolved into SIDs for the correct operation of ACLs on the server. As such the algorithmic mapping can't be 'turned off', but pushing it 'out of the way' should resolve the issues. Users and groups can then be assigned 'low' RIDs in arbitrary-rid supporting backends. Example: 100000 allow dcerpc auth level connect This option controls whether DCERPC services are allowed to be used with DCERPC_AUTH_LEVEL_CONNECT, which provides authentication, but no per message integrity nor privacy protection. Some interfaces like samr, lsarpc and netlogon have a hard-coded default of no and epmapper, mgmt and rpcecho have a hard-coded default of yes. The behavior can be overwritten per interface name (e.g. lsarpc, netlogon, samr, srvsvc, winreg, wkssvc ...) by using 'allow dcerpc auth level connect:interface = yes' as option. This option yields precedence to the implementation specific restrictions. E.g. the drsuapi and backupkey protocols require DCERPC_AUTH_LEVEL_PRIVACY. The dnsserver protocol requires DCERPC_AUTH_LEVEL_INTEGRITY. Example: yes allow trusted domains This option only takes effect when the option is set to server, domain or ads. If it is set to no, then attempts to connect to a resource from a domain or workgroup other than the one which smbd is running in will fail, even if that domain is trusted by the remote server doing the authentication. This is useful if you only want your Samba server to serve resources to users in the domain it is a member of. As an example, suppose that there are two domains DOMA and DOMB. DOMB is trusted by DOMA, which contains the Samba server. Under normal circumstances, a user with an account in DOMB can then access the resources of a UNIX account with the same account name on the Samba server even if they do not have an account in DOMA. This can make implementing a security boundary difficult. binddns dir This parameters defines the directory samba will use to store the configuration files for bind, such as named.conf. NOTE: The bind dns directory needs to be on the same mount point as the private directory! check password script The name of a program that can be used to check password complexity. The password is sent to the program's standard input. The program must return 0 on a good password, or any other value if the password is bad. In case the password is considered weak (the program does not return 0) the user will be notified and the password change will fail. In Samba AD, this script will be run AS ROOT by samba 8 without any substitutions. Note that starting with Samba 4.11 the following environment variables are exported to the script: SAMBA_CPS_ACCOUNT_NAME is always present and contains the sAMAccountName of user, the is the same as the %u substitutions in the none AD DC case. SAMBA_CPS_USER_PRINCIPAL_NAME is optional in the AD DC case if the userPrincipalName is present. SAMBA_CPS_FULL_NAME is optional if the displayName is present. Note: In the example directory is a sample program called crackcheck that uses cracklib to check the password quality. Example: /usr/local/sbin/crackcheck client ipc signing This controls whether the client is allowed or required to use SMB signing for IPC$ connections as DCERPC transport. Possible values are auto, mandatory and disabled. When set to mandatory or default, SMB signing is required. When set to auto, SMB signing is offered, but not enforced and if set to disabled, SMB signing is not offered either. Connections from winbindd to Active Directory Domain Controllers always enforce signing. client lanman auth This parameter determines whether or not smbclient 8 and other samba client tools will attempt to authenticate itself to servers using the weaker LANMAN password hash. If disabled, only server which support NT password hashes (e.g. Windows NT/2000, Samba, etc... but not Windows 95/98) will be able to be connected from the Samba client. The LANMAN encrypted response is easily broken, due to its case-insensitive nature, and the choice of algorithm. Clients without Windows 95/98 servers are advised to disable this option. Disabling this option will also disable the client plaintext auth option. Likewise, if the client ntlmv2 auth parameter is enabled, then only NTLMv2 logins will be attempted. client NTLMv2 auth This parameter determines whether or not smbclient 8 will attempt to authenticate itself to servers using the NTLMv2 encrypted password response. If enabled, only an NTLMv2 and LMv2 response (both much more secure than earlier versions) will be sent. Older servers (including NT4 < SP4, Win9x and Samba 2.2) are not compatible with NTLMv2 when not in an NTLMv2 supporting domain Similarly, if enabled, NTLMv1, client lanman auth and client plaintext auth authentication will be disabled. This also disables share-level authentication. If disabled, an NTLM response (and possibly a LANMAN response) will be sent by the client, depending on the value of client lanman auth. Note that Windows Vista and later versions already use NTLMv2 by default, and some sites (particularly those following 'best practice' security polices) only allow NTLMv2 responses, and not the weaker LM or NTLM. When is also set to yes extended security (SPNEGO) is required in order to use NTLMv2 only within NTLMSSP. This behavior was introduced with the patches for CVE-2016-2111. client plaintext auth Specifies whether a client should send a plaintext password if the server does not support encrypted passwords. client schannel This option is deprecated with Samba 4.8 and will be removed in future. At the same time the default changed to yes, which will be the hardcoded behavior in future. This controls whether the client offers or even demands the use of the netlogon schannel. no does not offer the schannel, auto offers the schannel but does not enforce it, and yes denies access if the server is not able to speak netlogon schannel. Note that for active directory domains this is hardcoded to yes. This option yields precedence to the option. Example: auto client signing This controls whether the client is allowed or required to use SMB signing. Possible values are auto, mandatory and disabled. When set to auto or default, SMB signing is offered, but not enforced. When set to mandatory, SMB signing is required and if set to disabled, SMB signing is not offered either. IPC$ connections for DCERPC e.g. in winbindd, are handled by the option. client use spnego principal This parameter determines whether or not smbclient 8 and other samba components acting as a client will attempt to use the server-supplied principal sometimes given in the SPNEGO exchange. If enabled, Samba can attempt to use Kerberos to contact servers known only by IP address. Kerberos relies on names, so ordinarily cannot function in this situation. This is a VERY BAD IDEA for security reasons, and so this parameter SHOULD NOT BE USED. It will be removed in a future version of Samba. If disabled, Samba will use the name used to look up the server when asking the KDC for a ticket. This avoids situations where a server may impersonate another, soliciting authentication as one principal while being known on the network as another. Note that Windows XP SP2 and later versions already follow this behaviour, and Windows Vista and later servers no longer supply this 'rfc4178 hint' principal on the server side. This parameter is deprecated in Samba 4.2.1 and will be removed (along with the functionality) in a later release of Samba. debug encryption This option will make the smbd server and client code using libsmb (smbclient, smbget, smbspool, ...) dump the Session Id, the decrypted Session Key, the Signing Key, the Application Key, the Encryption Key and the Decryption Key every time an SMB3+ session is established. This information will be printed in logs at level 0. Warning: access to these values enables the decryption of any encrypted traffic on the dumped sessions. This option should only be enabled for debugging purposes. dedicated keytab file Specifies the absolute path to the kerberos keytab file when is set to "dedicated keytab". Example: /usr/local/etc/krb5.keytab encrypt passwords This parameter has been deprecated since Samba 4.11 and support for plaintext (as distinct from NTLM, NTLMv2 or Kerberos authentication) will be removed in a future Samba release. That is, in the future, the current default of encrypt passwords = yes will be the enforced behaviour. This boolean controls whether encrypted passwords will be negotiated with the client. Note that Windows NT 4.0 SP3 and above and also Windows 98 will by default expect encrypted passwords unless a registry entry is changed. To use encrypted passwords in Samba see the chapter "User Database" in the Samba HOWTO Collection. MS Windows clients that expect Microsoft encrypted passwords and that do not have plain text password support enabled will be able to connect only to a Samba server that has encrypted password support enabled and for which the user accounts have a valid encrypted password. Refer to the smbpasswd command man page for information regarding the creation of encrypted passwords for user accounts. The use of plain text passwords is NOT advised as support for this feature is no longer maintained in Microsoft Windows products. If you want to use plain text passwords you must set this parameter to no. In order for encrypted passwords to work correctly smbd 8 must either have access to a local smbpasswd 5 file (see the smbpasswd 8 program for information on how to set up and maintain this file), or set the [domain|ads] parameter which causes smbd to authenticate against another server. guest account This is a username which will be used for access to services which are specified as (see below). Whatever privileges this user has will be available to any client connecting to the guest service. This user must exist in the password file, but does not require a valid login. The user account "ftp" is often a good choice for this parameter. On some systems the default guest account "nobody" may not be able to print. Use another account in this case. You should test this by trying to log in as your guest user (perhaps by using the su - command) and trying to print using the system print command such as lpr(1) or lp(1). This parameter does not accept % macros, because many parts of the system require this value to be constant for correct operation. Example: ftp kerberos encryption types This parameter determines the encryption types to use when operating as a Kerberos client. Possible values are all, strong, and legacy. Samba uses a Kerberos library (MIT or Heimdal) to obtain Kerberos tickets. This library is normally configured outside of Samba, using the krb5.conf file. This file may also include directives to configure the encryption types to be used. However, Samba implements Active Directory protocols and algorithms to locate a domain controller. In order to force the Kerberos library into using the correct domain controller, some Samba processes, such as winbindd 8 and net 8, build a private krb5.conf file for use by the Kerberos library while being invoked from Samba. This private file controls all aspects of the Kerberos library operation, and this parameter controls how the encryption types are configured within this generated file, and therefore also controls the encryption types negotiable by Samba. When set to all, all active directory encryption types are allowed. When set to strong, only AES-based encryption types are offered. This can be used in hardened environments to prevent downgrade attacks. When set to legacy, only RC4-HMAC-MD5 is allowed. Avoiding AES this way has one a very specific use. Normally, the encryption type is negotiated between the peers. However, there is one scenario in which a Windows read-only domain controller (RODC) advertises AES encryption, but then proxies the request to a writeable DC which may not support AES encryption, leading to failure of the handshake. Setting this parameter to legacy would cause samba not to negotiate AES encryption. It is assumed of course that the weaker legacy encryption types are acceptable for the setup. kerberos method Controls how kerberos tickets are verified. Valid options are: secrets only - use only the secrets.tdb for ticket verification (default) system keytab - use only the system keytab for ticket verification dedicated keytab - use a dedicated keytab for ticket verification secrets and keytab - use the secrets.tdb first, then the system keytab The major difference between "system keytab" and "dedicated keytab" is that the latter method relies on kerberos to find the correct keytab entry instead of filtering based on expected principals. When the kerberos method is in "dedicated keytab" mode, must be set to specify the location of the keytab file. kpasswd port Specifies which ports the Kerberos server should listen on for password changes. krb5 port Specifies which port the KDC should listen on for Kerberos traffic. lanman auth This parameter has been deprecated since Samba 4.11 and support for LanMan (as distinct from NTLM, NTLMv2 or Kerberos authentication) will be removed in a future Samba release. That is, in the future, the current default of lanman auth = no will be the enforced behaviour. This parameter determines whether or not smbd 8 will attempt to authenticate users or permit password changes using the LANMAN password hash. If disabled, only clients which support NT password hashes (e.g. Windows NT/2000 clients, smbclient, but not Windows 95/98 or the MS DOS network client) will be able to connect to the Samba host. The LANMAN encrypted response is easily broken, due to its case-insensitive nature, and the choice of algorithm. Servers without Windows 95/98/ME or MS DOS clients are advised to disable this option. When this parameter is set to no this will also result in sambaLMPassword in Samba's passdb being blanked after the next password change. As a result of that lanman clients won't be able to authenticate, even if lanman auth is re-enabled later on. Unlike the encrypt passwords option, this parameter cannot alter client behaviour, and the LANMAN response will still be sent over the network. See the client lanman auth to disable this for Samba's clients (such as smbclient) This parameter is overridden by ntlm auth, so unless that it is also set to ntlmv1-permitted or yes, then only NTLMv2 logins will be permitted and no LM hash will be stored. All modern clients support NTLMv2, and but some older clients require special configuration to use it. log nt token command This option can be set to a command that will be called when new nt tokens are created. This is only useful for development purposes. map to guest This parameter can take four different values, which tell smbd 8 what to do with user login requests that don't match a valid UNIX user in some way. The four settings are : Never - Means user login requests with an invalid password are rejected. This is the default. Bad User - Means user logins with an invalid password are rejected, unless the username does not exist, in which case it is treated as a guest login and mapped into the . Bad Password - Means user logins with an invalid password are treated as a guest login and mapped into the . Note that this can cause problems as it means that any user incorrectly typing their password will be silently logged on as "guest" - and will not know the reason they cannot access files they think they should - there will have been no message given to them that they got their password wrong. Helpdesk services will hate you if you set the map to guest parameter this way :-). Bad Uid - Is only applicable when Samba is configured in some type of domain mode security (security = {domain|ads}) and means that user logins which are successfully authenticated but which have no valid Unix user account (and smbd is unable to create one) should be mapped to the defined guest account. This was the default behavior of Samba 2.x releases. Note that if a member server is running winbindd, this option should never be required because the nss_winbind library will export the Windows domain users and groups to the underlying OS via the Name Service Switch interface. Note that this parameter is needed to set up "Guest" share services. This is because in these modes the name of the resource being requested is not sent to the server until after the server has successfully authenticated the client so the server cannot make authentication decisions at the correct time (connection to the share) for "Guest" shares. Example: Bad User mit kdc command This option specifies the path to the MIT kdc binary. If the KDC is not installed in the default location and wasn't correctly detected during build then you should modify this variable and point it to the correct binary. Example: /opt/mit/sbin/krb5kdc ntlm auth This parameter determines whether or not smbd 8 will attempt to authenticate users using the NTLM encrypted password response for this local passdb (SAM or account database). If disabled, both NTLM and LanMan authentication against the local passdb is disabled. Note that these settings apply only to local users, authentication will still be forwarded to and NTLM authentication accepted against any domain we are joined to, and any trusted domain, even if disabled or if NTLMv2-only is enforced here. To control NTLM authentiation for domain users, this must option must be configured on each DC. By default with ntlm auth set to ntlmv2-only only NTLMv2 logins will be permitted. All modern clients support NTLMv2 by default, but some older clients will require special configuration to use it. The primary user of NTLMv1 is MSCHAPv2 for VPNs and 802.1x. The available settings are: ntlmv1-permitted (alias yes) - Allow NTLMv1 and above for all clients. This is the required setting for to enable the lanman auth parameter. ntlmv2-only (alias no) - Do not allow NTLMv1 to be used, but permit NTLMv2. mschapv2-and-ntlmv2-only - Only allow NTLMv1 when the client promises that it is providing MSCHAPv2 authentication (such as the ntlm_auth tool). disabled - Do not accept NTLM (or LanMan) authentication of any level, nor permit NTLM password changes. The default changed from yes to no with Samba 4.5. The default changed again to ntlmv2-only with Samba 4.7, however the behaviour is unchanged. ntp signd socket directory This setting controls the location of the socket that the NTP daemon uses to communicate with Samba for signing packets. If a non-default path is specified here, then it is also necessary to make NTP aware of the new path using the ntpsigndsocket directive in ntp.conf. null passwords Allow or disallow client access to accounts that have null passwords. See also smbpasswd 5. obey pam restrictions When Samba 3.0 is configured to enable PAM support (i.e. --with-pam), this parameter will control whether or not Samba should obey PAM's account and session management directives. The default behavior is to use PAM for clear text authentication only and to ignore any account or session management. Note that Samba always ignores PAM for authentication in the case of yes. The reason is that PAM modules cannot support the challenge/response authentication mechanism needed in the presence of SMB password encryption. old password allowed period Number of minutes to permit an NTLM login after a password change or reset using the old password. This allows the user to re-cache the new password on multiple clients without disrupting a network reconnection in the meantime. This parameter only applies when is set to Active Directory Domain Controller pam password change With the addition of better PAM support in Samba 2.2, this parameter, it is possible to use PAM's password change control flag for Samba. If enabled, then PAM will be used for password changes when requested by an SMB client instead of the program listed in . It should be possible to enable this without changing your parameter for most setups. passdb backend This option allows the administrator to chose which backend will be used for storing user and possibly group information. This allows you to swap between different storage mechanisms without recompile. The parameter value is divided into two parts, the backend's name, and a 'location' string that has meaning only to that particular backed. These are separated by a : character. Available backends can include: smbpasswd - The old plaintext passdb backend. Some Samba features will not work if this passdb backend is used. Takes a path to the smbpasswd file as an optional argument. tdbsam - The TDB based password storage backend. Takes a path to the TDB as an optional argument (defaults to passdb.tdb in the directory. ldapsam - The LDAP based passdb backend. Takes an LDAP URL as an optional argument (defaults to ldap://localhost) LDAP connections should be secured where possible. This may be done using either Start-TLS (see ) or by specifying ldaps:// in the URL argument. Multiple servers may also be specified in double-quotes. Whether multiple servers are supported or not and the exact syntax depends on the LDAP library you use. Examples of use are: passdb backend = tdbsam:/etc/samba/private/passdb.tdb or multi server LDAP URL with OpenLDAP library: passdb backend = ldapsam:"ldap://ldap-1.example.com ldap://ldap-2.example.com" or multi server LDAP URL with Netscape based LDAP library: passdb backend = ldapsam:"ldap://ldap-1.example.com ldap-2.example.com" passdb expand explicit This parameter controls whether Samba substitutes %-macros in the passdb fields if they are explicitly set. We used to expand macros here, but this turned out to be a bug because the Windows client can expand a variable %G_osver% in which %G would have been substituted by the user's primary group. passwd chat This string controls the "chat" conversation that takes places between smbd 8 and the local password changing program to change the user's password. The string describes a sequence of response-receive pairs that smbd 8 uses to determine what to send to the and what to expect back. If the expected output is not received then the password is not changed. This chat sequence is often quite site specific, depending on what local methods are used for password control (such as NIS etc). Note that this parameter only is used if the parameter is set to yes. This sequence is then called AS ROOT when the SMB password in the smbpasswd file is being changed, without access to the old password cleartext. This means that root must be able to reset the user's password without knowing the text of the previous password. In the presence of NIS/YP, this means that the must be executed on the NIS master. The string can contain the macro %n which is substituted for the new password. The old password (%o) is only available when has been disabled. The chat sequence can also contain the standard macros \n, \r, \t and \s to give line-feed, carriage-return, tab and space. The chat sequence string can also contain a '*' which matches any sequence of characters. Double quotes can be used to collect strings with spaces in them into a single string. If the send string in any part of the chat sequence is a full stop ".", then no string is sent. Similarly, if the expect string is a full stop then no string is expected. If the parameter is set to yes, the chat pairs may be matched in any order, and success is determined by the PAM result, not any particular output. The \n macro is ignored for PAM conversions. Example: "*Enter NEW password*" %n\n "*Reenter NEW password*" %n\n "*Password changed*" passwd chat debug This boolean specifies if the passwd chat script parameter is run in debug mode. In this mode the strings passed to and received from the passwd chat are printed in the smbd 8 log with a of 100. This is a dangerous option as it will allow plaintext passwords to be seen in the smbd log. It is available to help Samba admins debug their passwd chat scripts when calling the passwd program and should be turned off after this has been done. This option has no effect if the parameter is set. This parameter is off by default. passwd chat timeout This integer specifies the number of seconds smbd will wait for an initial answer from a passwd chat script being run. Once the initial answer is received the subsequent answers must be received in one tenth of this time. The default it two seconds. passwd program The name of a program that can be used to set UNIX user passwords. Any occurrences of %u will be replaced with the user name. The user name is checked for existence before calling the password changing program. Also note that many passwd programs insist in reasonable passwords, such as a minimum length, or the inclusion of mixed case chars and digits. This can pose a problem as some clients (such as Windows for Workgroups) uppercase the password before sending it. Note that if the unix password sync parameter is set to yes then this program is called AS ROOT before the SMB password in the smbpasswd file is changed. If this UNIX password change fails, then smbd will fail to change the SMB password also (this is by design). If the unix password sync parameter is set this parameter MUST USE ABSOLUTE PATHS for ALL programs called, and must be examined for security implications. Note that by default unix password sync is set to no. Example: /bin/passwd %u password hash gpg key ids If samba is running as an active directory domain controller, it is possible to store the cleartext password of accounts in a PGP/OpenGPG encrypted form. You can specify one or more recipients by key id or user id. Note that 32bit key ids are not allowed, specify at least 64bit. The value is stored as 'Primary:SambaGPG' in the supplementalCredentials attribute. As password changes can occur on any domain controller, you should configure this on each of them. Note that this feature is currently available only on Samba domain controllers. This option is only available if samba was compiled with gpgme support. You may need to export the GNUPGHOME environment variable before starting samba. It is strongly recommended to only store the public key in this location. The private key is not used for encryption and should be only stored where decryption is required. Being able to restore the cleartext password helps, when they need to be imported into other authentication systems later (see samba-tool user getpassword) or you want to keep the passwords in sync with another system, e.g. an OpenLDAP server (see samba-tool user syncpasswords). While this option needs to be configured on all domain controllers, the samba-tool user syncpasswords command should run on a single domain controller only (typically the PDC-emulator). Example: 4952E40301FAB41A Example: selftest@samba.example.com Example: selftest@samba.example.com, 4952E40301FAB41A password hash userPassword schemes This parameter determines whether or not samba 8 acting as an Active Directory Domain Controller will attempt to store additional passwords hash types for the user The values are stored as 'Primary:userPassword' in the supplementalCredentials attribute. The value of this option is a hash type. The currently supported hash types are: CryptSHA256 CryptSHA512 Multiple instances of a hash type may be computed and stored. The password hashes are calculated using the crypt 3 call. The number of rounds used to compute the hash can be specified by adding ':rounds=xxxx' to the hash type, i.e. CryptSHA512:rounds=4500 would calculate an SHA512 hash using 4500 rounds. If not specified the Operating System defaults for crypt 3 are used. As password changes can occur on any domain controller, you should configure this on each of them. Note that this feature is currently available only on Samba domain controllers. Currently the NT Hash of the password is recorded when these hashes are calculated and stored. When retrieving the hashes the current value of the NT Hash is checked against the stored NT Hash. This detects password changes that have not updated the password hashes. In this case samba-tool user will ignore the stored hash values. Being able to obtain the hashed password helps, when they need to be imported into other authentication systems later (see samba-tool user getpassword) or you want to keep the passwords in sync with another system, e.g. an OpenLDAP server (see samba-tool user syncpasswords). unix password sync Example: CryptSHA256 Example: CryptSHA256 CryptSHA512 Example: CryptSHA256:rounds=5000 CryptSHA512:rounds=7000 password server By specifying the name of a domain controller with this option, and using security = [ads|domain] it is possible to get Samba to do all its username/password validation using a specific remote server. Ideally, this option should not be used, as the default '*' indicates to Samba to determine the best DC to contact dynamically, just as all other hosts in an AD domain do. This allows the domain to be maintained (addition and removal of domain controllers) without modification to the smb.conf file. The cryptographic protection on the authenticated RPC calls used to verify passwords ensures that this default is safe. It is strongly recommended that you use the default of '*', however if in your particular environment you have reason to specify a particular DC list, then the list of machines in this option must be a list of names or IP addresses of Domain controllers for the Domain. If you use the default of '*', or list several hosts in the password server option then smbd will try each in turn till it finds one that responds. This is useful in case your primary server goes down. If the list of servers contains both names/IP's and the '*' character, the list is treated as a list of preferred domain controllers, but an auto lookup of all remaining DC's will be added to the list as well. Samba will not attempt to optimize this list by locating the closest DC. If parameter is a name, it is looked up using the parameter and so may resolved by any method and order described in that parameter. Example: NT-PDC, NT-BDC1, NT-BDC2, * Example: windc.mydomain.com:389 192.168.1.101 * preload modules This is a list of paths to modules that should be loaded into smbd before a client connects. This improves the speed of smbd when reacting to new connections somewhat. Example: /usr/lib/samba/passdb/mysql.so private dir This parameters defines the directory smbd will use for storing such files as smbpasswd and secrets.tdb. raw NTLMv2 auth This parameter determines whether or not smbd 8 will allow SMB1 clients without extended security (without SPNEGO) to use NTLMv2 authentication. If this option, lanman auth and ntlm auth are all disabled, then only clients with SPNEGO support will be permitted. That means NTLMv2 is only supported within NTLMSSP. rename user script This is the full pathname to a script that will be run as root by smbd 8 under special circumstances described below. When a user with admin authority or SeAddUserPrivilege rights renames a user (e.g.: from the NT4 User Manager for Domains), this script will be run to rename the POSIX user. Two variables, %uold and %unew, will be substituted with the old and new usernames, respectively. The script should return 0 upon successful completion, and nonzero otherwise. The script has all responsibility to rename all the necessary data that is accessible in this posix method. This can mean different requirements for different backends. The tdbsam and smbpasswd backends will take care of the contents of their respective files, so the script is responsible only for changing the POSIX username, and other data that may required for your circumstances, such as home directory. Please also consider whether or not you need to rename the actual home directories themselves. The ldapsam backend will not make any changes, because of the potential issues with renaming the LDAP naming attribute. In this case the script is responsible for changing the attribute that samba uses (uid) for locating users, as well as any data that needs to change for other applications using the same directory. restrict anonymous The setting of this parameter determines whether SAMR and LSA DCERPC services can be accessed anonymously. This corresponds to the following Windows Server registry options: HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Lsa\RestrictAnonymous The option also affects the browse option which is required by legacy clients which rely on Netbios browsing. While modern Windows version should be fine with restricting the access there could still be applications relying on anonymous access. Setting 1 will disable anonymous SAMR access. Setting 2 will, in addition to restricting SAMR access, disallow anonymous connections to the IPC$ share in general. Setting yes on any share will remove the security advantage. root directory The server will chroot() (i.e. Change its root directory) to this directory on startup. This is not strictly necessary for secure operation. Even without it the server will deny access to files not in one of the service entries. It may also check for, and deny access to, soft links to other parts of the filesystem, or attempts to use ".." in file names to access other directories (depending on the setting of the parameter). Adding a root directory entry other than "/" adds an extra level of security, but at a price. It absolutely ensures that no access is given to files not in the sub-tree specified in the root directory option, including some files needed for complete operation of the server. To maintain full operability of the server you will need to mirror some system files into the root directory tree. In particular you will need to mirror /etc/passwd (or a subset of it), and any binaries or configuration files needed for printing (if required). The set of files that must be mirrored is operating system dependent. Example: /homes/smb samba kcc command This option specifies the path to the Samba KCC command. This script is used for replication topology replication. It should not be necessary to modify this option except for testing purposes or if the samba_kcc was installed in a non-default location. Example: /usr/local/bin/kcc security This option affects how clients respond to Samba and is one of the most important settings in the smb.conf file. The default is security = user, as this is the most common setting, used for a standalone file server or a DC. The alternatives are security = ads or security = domain , which support joining Samba to a Windows domain You should use security = user and if you want to mainly setup shares without a password (guest shares). This is commonly used for a shared printer server. The different settings will now be explained. SECURITY = AUTO This is the default security setting in Samba, and causes Samba to consult the parameter (if set) to determine the security mode. SECURITY = USER If is not specified, this is the default security setting in Samba. With user-level security a client must first "log-on" with a valid username and password (which can be mapped using the parameter). Encrypted passwords (see the parameter) can also be used in this security mode. Parameters such as and if set are then applied and may change the UNIX user to use on this connection, but only after the user has been successfully authenticated. Note that the name of the resource being requested is not sent to the server until after the server has successfully authenticated the client. This is why guest shares don't work in user level security without allowing the server to automatically map unknown users into the . See the parameter for details on doing this. SECURITY = DOMAIN This mode will only work correctly if net 8 has been used to add this machine into a Windows NT Domain. It expects the parameter to be set to yes. In this mode Samba will try to validate the username/password by passing it to a Windows NT Primary or Backup Domain Controller, in exactly the same way that a Windows NT Server would do. Note that a valid UNIX user must still exist as well as the account on the Domain Controller to allow Samba to have a valid UNIX account to map file access to. Note that from the client's point of view security = domain is the same as security = user. It only affects how the server deals with the authentication, it does not in any way affect what the client sees. Note that the name of the resource being requested is not sent to the server until after the server has successfully authenticated the client. This is why guest shares don't work in user level security without allowing the server to automatically map unknown users into the . See the parameter for details on doing this. See also the parameter and the parameter. SECURITY = ADS In this mode, Samba will act as a domain member in an ADS realm. To operate in this mode, the machine running Samba will need to have Kerberos installed and configured and Samba will need to be joined to the ADS realm using the net utility. Note that this mode does NOT make Samba operate as a Active Directory Domain Controller. Note that this forces yes and yes for the primary domain. Read the chapter about Domain Membership in the HOWTO for details. Example: DOMAIN server role This option determines the basic operating mode of a Samba server and is one of the most important settings in the smb.conf file. The default is server role = auto, as causes Samba to operate according to the setting, or if not specified as a simple file server that is not connected to any domain. The alternatives are server role = standalone or server role = member server , which support joining Samba to a Windows domain, along with server role = domain controller, which run Samba as a Windows domain controller. You should use server role = standalone and if you want to mainly setup shares without a password (guest shares). This is commonly used for a shared printer server. SERVER ROLE = AUTO This is the default server role in Samba, and causes Samba to consult the parameter (if set) to determine the server role, giving compatible behaviours to previous Samba versions. SERVER ROLE = STANDALONE If is also not specified, this is the default security setting in Samba. In standalone operation, a client must first "log-on" with a valid username and password (which can be mapped using the parameter) stored on this machine. Encrypted passwords (see the parameter) are by default used in this security mode. Parameters such as and if set are then applied and may change the UNIX user to use on this connection, but only after the user has been successfully authenticated. SERVER ROLE = MEMBER SERVER This mode will only work correctly if net 8 has been used to add this machine into a Windows Domain. It expects the parameter to be set to yes. In this mode Samba will try to validate the username/password by passing it to a Windows or Samba Domain Controller, in exactly the same way that a Windows Server would do. Note that a valid UNIX user must still exist as well as the account on the Domain Controller to allow Samba to have a valid UNIX account to map file access to. Winbind can provide this. SERVER ROLE = CLASSIC PRIMARY DOMAIN CONTROLLER This mode of operation runs a classic Samba primary domain controller, providing domain logon services to Windows and Samba clients of an NT4-like domain. Clients must be joined to the domain to create a secure, trusted path across the network. There must be only one PDC per NetBIOS scope (typically a broadcast network or clients served by a single WINS server). SERVER ROLE = CLASSIC BACKUP DOMAIN CONTROLLER This mode of operation runs a classic Samba backup domain controller, providing domain logon services to Windows and Samba clients of an NT4-like domain. As a BDC, this allows multiple Samba servers to provide redundant logon services to a single NetBIOS scope. SERVER ROLE = ACTIVE DIRECTORY DOMAIN CONTROLLER This mode of operation runs Samba as an active directory domain controller, providing domain logon services to Windows and Samba clients of the domain. This role requires special configuration, see the Samba4 HOWTO Example: ACTIVE DIRECTORY DOMAIN CONTROLLER server schannel This option is deprecated with Samba 4.8 and will be removed in future. At the same time the default changed to yes, which will be the hardcoded behavior in future. If you have the need for the behavior of "auto" to be kept, please file a bug at https://bugzilla.samba.org. This controls whether the server offers or even demands the use of the netlogon schannel. no does not offer the schannel, auto offers the schannel but does not enforce it, and yes denies access if the client is not able to speak netlogon schannel. This is only the case for Windows NT4 before SP4. Please note that with this set to no, you will have to apply the WindowsXP WinXP_SignOrSeal.reg registry patch found in the docs/registry subdirectory of the Samba distribution tarball. Example: auto server signing This controls whether the client is allowed or required to use SMB1 and SMB2 signing. Possible values are default, auto, mandatory and disabled. By default, and when smb signing is set to default, smb signing is required when is active directory domain controller and disabled otherwise. When set to auto, SMB1 signing is offered, but not enforced. When set to mandatory, SMB1 signing is required and if set to disabled, SMB signing is not offered either. For the SMB2 protocol, by design, signing cannot be disabled. In the case where SMB2 is negotiated, if this parameter is set to disabled, it will be treated as auto. Setting it to mandatory will still require SMB2 clients to use signing. smb passwd file This option sets the path to the encrypted smbpasswd file. By default the path to the smbpasswd file is compiled into Samba. An example of use is: smb passwd file = /etc/samba/smbpasswd tls cafile This option can be set to a file (PEM format) containing CA certificates of root CAs to trust to sign certificates or intermediate CA certificates. This path is relative to if the path does not start with a /. tls certfile This option can be set to a file (PEM format) containing the RSA certificate. This path is relative to if the path does not start with a /. tls crlfile This option can be set to a file containing a certificate revocation list (CRL). This path is relative to if the path does not start with a /. tls dh params file This option can be set to a file with Diffie-Hellman parameters which will be used with DH ciphers. This path is relative to if the path does not start with a /. tls enabled If this option is set to yes, then Samba will use TLS when possible in communication. tls keyfile This option can be set to a file (PEM format) containing the RSA private key. This file must be accessible without a pass-phrase, i.e. it must not be encrypted. This path is relative to if the path does not start with a /. tls verify peer This controls if and how strict the client will verify the peer's certificate and name. Possible values are (in increasing order): no_check, ca_only, ca_and_name_if_available, ca_and_name and as_strict_as_possible. When set to no_check the certificate is not verified at all, which allows trivial man in the middle attacks. When set to ca_only the certificate is verified to be signed from a ca specified in the option. Setting to a valid file is required. The certificate lifetime is also verified. If the option is configured, the certificate is also verified against the ca crl. When set to ca_and_name_if_available all checks from ca_only are performed. In addition, the peer hostname is verified against the certificate's name, if it is provided by the application layer and not given as an ip address string. When set to ca_and_name all checks from ca_and_name_if_available are performed. In addition the peer hostname needs to be provided and even an ip address is checked against the certificate's name. When set to as_strict_as_possible all checks from ca_and_name are performed. In addition the needs to be configured. Future versions of Samba may implement additional checks. unix password sync This boolean parameter controls whether Samba attempts to synchronize the UNIX password with the SMB password when the encrypted SMB password in the smbpasswd file is changed. If this is set to yes the program specified in the passwd program parameter is called AS ROOT - to allow the new UNIX password to be set without access to the old UNIX password (as the SMB password change code has no access to the old password cleartext, only the new). This option has no effect if samba is running as an active directory domain controller, in that case have a look at the option and the samba-tool user syncpasswords command. username level This option helps Samba to try and 'guess' at the real UNIX username, as many DOS clients send an all-uppercase username. By default Samba tries all lowercase, followed by the username with the first letter capitalized, and fails if the username is not found on the UNIX machine. If this parameter is set to non-zero the behavior changes. This parameter is a number that specifies the number of uppercase combinations to try while trying to determine the UNIX user name. The higher the number the more combinations will be tried, but the slower the discovery of usernames will be. Use this parameter when you have strange usernames on your UNIX machine, such as AstrangeUser . This parameter is needed only on UNIX systems that have case sensitive usernames. Example: 5 username map This option allows you to specify a file containing a mapping of usernames from the clients to the server. This can be used for several purposes. The most common is to map usernames that users use on DOS or Windows machines to those that the UNIX box uses. The other is to map multiple users to a single username so that they can more easily share files. Please note that for user mode security, the username map is applied prior to validating the user credentials. Domain member servers (domain or ads) apply the username map after the user has been successfully authenticated by the domain controller and require fully qualified entries in the map table (e.g. biddle = DOMAIN\foo). The map file is parsed line by line. Each line should contain a single UNIX username on the left then a '=' followed by a list of usernames on the right. The list of usernames on the right may contain names of the form @group in which case they will match any UNIX username in that group. The special client name '*' is a wildcard and matches any name. Each line of the map file may be up to 1023 characters long. The file is processed on each line by taking the supplied username and comparing it with each username on the right hand side of the '=' signs. If the supplied name matches any of the names on the right hand side then it is replaced with the name on the left. Processing then continues with the next line. If any line begins with a '#' or a ';' then it is ignored. If any line begins with an '!' then the processing will stop after that line if a mapping was done by the line. Otherwise mapping continues with every line being processed. Using '!' is most useful when you have a wildcard mapping line later in the file. For example to map from the name admin or administrator to the UNIX name root you would use: root = admin administrator Or to map anyone in the UNIX group system to the UNIX name sys you would use: sys = @system You can have as many mappings as you like in a username map file. If your system supports the NIS NETGROUP option then the netgroup database is checked before the /etc/group database for matching groups. You can map Windows usernames that have spaces in them by using double quotes around the name. For example: tridge = "Andrew Tridgell" would map the windows username "Andrew Tridgell" to the unix username "tridge". The following example would map mary and fred to the unix user sys, and map the rest to guest. Note the use of the '!' to tell Samba to stop processing if it gets a match on that line: !sys = mary fred guest = * Note that the remapping is applied to all occurrences of usernames. Thus if you connect to \\server\fred and fred is remapped to mary then you will actually be connecting to \\server\mary and will need to supply a password suitable for mary not fred. The only exception to this is the username passed to a Domain Controller (if you have one). The DC will receive whatever username the client supplies without modification. Also note that no reverse mapping is done. The main effect this has is with printing. Users who have been mapped may have trouble deleting print jobs as PrintManager under WfWg will think they don't own the print job. Samba versions prior to 3.0.8 would only support reading the fully qualified username (e.g.: DOMAIN\user) from the username map when performing a kerberos login from a client. However, when looking up a map entry for a user authenticated by NTLM[SSP], only the login name would be used for matches. This resulted in inconsistent behavior sometimes even on the same server. The following functionality is obeyed in version 3.0.8 and later: When performing local authentication, the username map is applied to the login name before attempting to authenticate the connection. When relying upon a external domain controller for validating authentication requests, smbd will apply the username map to the fully qualified username (i.e. DOMAIN\user) only after the user has been successfully authenticated. An example of use is: username map = /usr/local/samba/lib/users.map username map cache time Mapping usernames with the or features of Samba can be relatively expensive. During login of a user, the mapping is done several times. In particular, calling the can slow down logins if external databases have to be queried from the script being called. The parameter controls a mapping cache. It specifies the number of seconds a mapping from the username map file or script is to be efficiently cached. The default of 0 means no caching is done. Example: 60 username map script This script is a mutually exclusive alternative to the parameter. This parameter specifies and external program or script that must accept a single command line option (the username transmitted in the authentication request) and return a line on standard output (the name to which the account should mapped). In this way, it is possible to store username map tables in an LDAP or NIS directory services. Example: /etc/samba/scripts/mapusers.sh tls priority This option can be set to a string describing the TLS protocols to be supported in the parts of Samba that use GnuTLS, specifically the AD DC. The string is appended to the default priority list of GnuTLS. The valid options are described in the GNUTLS Priority-Strings documentation at http://gnutls.org/manual/html_node/Priority-Strings.html The SSL3.0 protocol will be disabled. aio max threads The integer parameter specifies the maximum number of threads each smbd process will create when doing parallel asynchronous IO calls. If the number of outstanding calls is greater than this number the requests will not be refused but go onto a queue and will be scheduled in turn as outstanding requests complete. aio read size aio write size deadtime The value of the parameter (a decimal integer) represents the number of minutes of inactivity before a connection is considered dead, and it is disconnected. The deadtime only takes effect if the number of open files is zero. This is useful to stop a server's resources being exhausted by a large number of inactive connections. Most clients have an auto-reconnect feature when a connection is broken so in most cases this parameter should be transparent to users. Using this parameter with a timeout of a few minutes is recommended for most systems. A deadtime of zero indicates that no auto-disconnection should be performed. Example: 15 getwd cache This is a tuning option. When this is enabled a caching algorithm will be used to reduce the time taken for getwd() calls. This can have a significant impact on performance, especially when the parameter is set to no. hostname lookups Specifies whether samba should use (expensive) hostname lookups or use the ip addresses instead. An example place where hostname lookups are currently used is when checking the hosts deny and hosts allow. Example: yes keepalive The value of the parameter (an integer) represents the number of seconds between keepalive packets. If this parameter is zero, no keepalive packets will be sent. Keepalive packets, if sent, allow the server to tell whether a client is still present and responding. Keepalives should, in general, not be needed if the socket has the SO_KEEPALIVE attribute set on it by default. (see ). Basically you should only use this option if you strike difficulties. Please note this option only applies to SMB1 client connections, and has no effect on SMB2 clients. Example: 600 max disk size This option allows you to put an upper limit on the apparent size of disks. If you set this option to 100 then all shares will appear to be not larger than 100 MB in size. Note that this option does not limit the amount of data you can put on the disk. In the above case you could still store much more than 100 MB on the disk, but if a client ever asks for the amount of free disk space or the total disk size then the result will be bounded by the amount specified in max disk size. This option is primarily useful to work around bugs in some pieces of software that can't handle very large disks, particularly disks over 1GB in size. A max disk size of 0 means no limit. Example: 1000 max open files This parameter limits the maximum number of open files that one smbd 8 file serving process may have open for a client at any one time. This parameter can be set very high (16384) as Samba uses only one bit per unopened file. Setting this parameter lower than 16384 will cause Samba to complain and set this value back to the minimum of 16384, as Windows 7 depends on this number of open file handles being available. The limit of the number of open files is usually set by the UNIX per-process file descriptor limit rather than this parameter so you should never need to touch this parameter. max smbd processes This parameter limits the maximum number of smbd 8 processes concurrently running on a system and is intended as a stopgap to prevent degrading service to clients in the event that the server has insufficient resources to handle more than this number of connections. Remember that under normal operating conditions, each user will have an smbd 8 associated with him or her to handle connections to all shares from a given host. For a Samba ADDC running the standard process model this option limits the number of processes forked to handle requests. Currently new processes are only forked for ldap and netlogon requests. Example: 1000 name cache timeout Specifies the number of seconds it takes before entries in samba's hostname resolve cache time out. If the timeout is set to 0. the caching is disabled. Example: 0 socket options Modern server operating systems are tuned for high network performance in the majority of situations; when you set socket options you are overriding those settings. Linux in particular has an auto-tuning mechanism for buffer sizes that will be disabled if you specify a socket buffer size. This can potentially cripple your TCP/IP stack. Getting the socket options correct can make a big difference to your performance, but getting them wrong can degrade it by just as much. As with any other low level setting, if you must make changes to it, make small changes and test the effect before making any large changes. This option allows you to set socket options to be used when talking with the client. Socket options are controls on the networking layer of the operating systems which allow the connection to be tuned. This option will typically be used to tune your Samba server for optimal performance for your local network. There is no way that Samba can know what the optimal parameters are for your net, so you must experiment and choose them yourself. We strongly suggest you read the appropriate documentation for your operating system first (perhaps man setsockopt will help). You may find that on some systems Samba will say "Unknown socket option" when you supply an option. This means you either incorrectly typed it or you need to add an include file to includes.h for your OS. If the latter is the case please send the patch to samba-technical@lists.samba.org. Any of the supported socket options may be combined in any way you like, as long as your OS allows it. This is the list of socket options currently settable using this option: SO_KEEPALIVE SO_REUSEADDR SO_BROADCAST TCP_NODELAY TCP_KEEPCNT * TCP_KEEPIDLE * TCP_KEEPINTVL * IPTOS_LOWDELAY IPTOS_THROUGHPUT SO_REUSEPORT SO_SNDBUF * SO_RCVBUF * SO_SNDLOWAT * SO_RCVLOWAT * SO_SNDTIMEO * SO_RCVTIMEO * TCP_FASTACK * TCP_QUICKACK TCP_NODELAYACK TCP_KEEPALIVE_THRESHOLD * TCP_KEEPALIVE_ABORT_THRESHOLD * TCP_DEFER_ACCEPT * TCP_USER_TIMEOUT * Those marked with a '*' take an integer argument. The others can optionally take a 1 or 0 argument to enable or disable the option, by default they will be enabled if you don't specify 1 or 0. To specify an argument use the syntax SOME_OPTION = VALUE for example SO_SNDBUF = 8192. Note that you must not have any spaces before or after the = sign. If you are on a local network then a sensible option might be: socket options = IPTOS_LOWDELAY If you have a local network then you could try: socket options = IPTOS_LOWDELAY TCP_NODELAY If you are on a wide area network then perhaps try setting IPTOS_THROUGHPUT. Note that several of the options may cause your Samba server to fail completely. Use these options with caution! Example: IPTOS_LOWDELAY use mmap This global parameter determines if the tdb internals of Samba can depend on mmap working correctly on the running system. Samba requires a coherent mmap/read-write system memory cache. Currently only OpenBSD and HPUX do not have such a coherent cache, and on those platforms this parameter is overridden internally to be effectively no. On all systems this parameter should be left alone. This parameter is provided to help the Samba developers track down problems with the tdb internal code. get quota command The get quota command should only be used whenever there is no operating system API available from the OS that samba can use. This option is only available Samba was compiled with quotas support. This parameter should specify the path to a script that queries the quota information for the specified user/group for the partition that the specified directory is on. Such a script is being given 3 arguments: directory type of query uid of user or gid of group The directory is actually mostly just "." - It needs to be treated relatively to the current working directory that the script can also query. The type of query can be one of: 1 - user quotas 2 - user default quotas (uid = -1) 3 - group quotas 4 - group default quotas (gid = -1) This script should print one line as output with spaces between the columns. The printed columns should be: 1 - quota flags (0 = no quotas, 1 = quotas enabled, 2 = quotas enabled and enforced) 2 - number of currently used blocks 3 - the softlimit number of blocks 4 - the hardlimit number of blocks 5 - currently used number of inodes 6 - the softlimit number of inodes 7 - the hardlimit number of inodes 8 (optional) - the number of bytes in a block(default is 1024) Example: /usr/local/sbin/query_quota host msdfs If set to yes, Samba will act as a Dfs server, and allow Dfs-aware clients to browse Dfs trees hosted on the server. See also the share level parameter. For more information on setting up a Dfs tree on Samba, refer to the MSFDS chapter in the book Samba3-HOWTO. set quota command The set quota command should only be used whenever there is no operating system API available from the OS that samba can use. This option is only available if Samba was compiled with quota support. This parameter should specify the path to a script that can set quota for the specified arguments. The specified script should take the following arguments: 1 - path to where the quota needs to be set. This needs to be interpreted relative to the current working directory that the script may also check for. 2 - quota type 1 - user quotas 2 - user default quotas (uid = -1) 3 - group quotas 4 - group default quotas (gid = -1) 3 - id (uid for user, gid for group, -1 if N/A) 4 - quota state (0 = disable, 1 = enable, 2 = enable and enforce) 5 - block softlimit 6 - block hardlimit 7 - inode softlimit 8 - inode hardlimit 9(optional) - block size, defaults to 1024 The script should output at least one line of data on success. And nothing on failure. Example: /usr/local/sbin/set_quota apply group policies This option controls whether winbind will execute the gpupdate command defined in on the Group Policy update interval. The Group Policy update interval is defined as every 90 minutes, plus a random offset between 0 and 30 minutes. This applies Group Policy Machine polices to the client or KDC and machine policies to a server. Example: yes create krb5 conf Setting this parameter to no prevents winbind from creating custom krb5.conf files. Winbind normally does this because the krb5 libraries are not AD-site-aware and thus would pick any domain controller out of potentially very many. Winbind is site-aware and makes the krb5 libraries use a local DC by creating its own krb5.conf files. Preventing winbind from doing this might become necessary if you have to add special options into your system-krb5.conf that winbind does not see. idmap backend The idmap backend provides a plugin interface for Winbind to use varying backends to store SID/uid/gid mapping tables. This option specifies the default backend that is used when no special configuration set, but it is now deprecated in favour of the new spelling . idmap cache time This parameter specifies the number of seconds that Winbind's idmap interface will cache positive SID/uid/gid query results. By default, Samba will cache these results for one week. idmap gid The idmap gid parameter specifies the range of group ids for the default idmap configuration. It is now deprecated in favour of . See the option. Example: 10000-20000 idmap negative cache time This parameter specifies the number of seconds that Winbind's idmap interface will cache negative SID/uid/gid query results. idmap uid The idmap uid parameter specifies the range of user ids for the default idmap configuration. It is now deprecated in favour of . See the option. Example: 10000-20000 include system krb5 conf Setting this parameter to no will prevent winbind to include the system /etc/krb5.conf file into the krb5.conf file it creates. See also . This option only applies to Samba built with MIT Kerberos. neutralize nt4 emulation This option controls whether winbindd sends the NETLOGON_NEG_NEUTRALIZE_NT4_EMULATION flag in order to bypass the NT4 emulation of a domain controller. Typically you should not need set this. It can be useful for upgrades from NT4 to AD domains. The behavior can be controlled per netbios domain by using 'neutralize nt4 emulation:NETBIOSDOMAIN = yes' as option. reject md5 servers This option controls whether winbindd requires support for aes support for the netlogon secure channel. The following flags will be required NETLOGON_NEG_ARCFOUR, NETLOGON_NEG_SUPPORTS_AES, NETLOGON_NEG_PASSWORD_SET2 and NETLOGON_NEG_AUTHENTICATED_RPC. You can set this to yes if all domain controllers support aes. This will prevent downgrade attacks. The behavior can be controlled per netbios domain by using 'reject md5 servers:NETBIOSDOMAIN = yes' as option. This option takes precedence to the option. require strong key This option controls whether winbindd requires support for md5 strong key support for the netlogon secure channel. The following flags will be required NETLOGON_NEG_STRONG_KEYS, NETLOGON_NEG_ARCFOUR and NETLOGON_NEG_AUTHENTICATED_RPC. You can set this to no if some domain controllers only support des. This might allows weak crypto to be negotiated, may via downgrade attacks. The behavior can be controlled per netbios domain by using 'require strong key:NETBIOSDOMAIN = no' as option. Note for active directory domain this option is hardcoded to 'yes' This option yields precedence to the option. This option takes precedence to the option. template homedir When filling out the user information for a Windows NT user, the winbindd 8 daemon uses this parameter to fill in the home directory for that user. If the string %D is present it is substituted with the user's Windows NT domain name. If the string %U is present it is substituted with the user's Windows NT user name. template shell When filling out the user information for a Windows NT user, the winbindd 8 daemon uses this parameter to fill in the login shell for that user. winbind cache time This parameter specifies the number of seconds the winbindd 8 daemon will cache user and group information before querying a Windows NT server again. This does not apply to authentication requests, these are always evaluated in real time unless the option has been enabled. winbindd socket directory This setting controls the location of the winbind daemon's socket. Except within automated test scripts, this should not be altered, as the client tools (nss_winbind etc) do not honour this parameter. Client tools must then be advised of the altered path with the WINBINDD_SOCKET_DIR environment variable. winbind enum groups On large installations using winbindd 8 it may be necessary to suppress the enumeration of groups through the setgrent(), getgrent() and endgrent() group of system calls. If the winbind enum groups parameter is no, calls to the getgrent() system call will not return any data. Turning off group enumeration may cause some programs to behave oddly. winbind enum users On large installations using winbindd 8 it may be necessary to suppress the enumeration of users through the setpwent(), getpwent() and endpwent() group of system calls. If the winbind enum users parameter is no, calls to the getpwent system call will not return any data. Turning off user enumeration may cause some programs to behave oddly. For example, the finger program relies on having access to the full user list when searching for matching usernames. winbind expand groups This option controls the maximum depth that winbindd will traverse when flattening nested group memberships of Windows domain groups. This is different from the option which implements the Windows NT4 model of local group nesting. The "winbind expand groups" parameter specifically applies to the membership of domain groups. This option also affects the return of non nested group memberships of Windows domain users. With the new default "winbind expand groups = 0" winbind does not query group memberships at all. Be aware that a high value for this parameter can result in system slowdown as the main parent winbindd daemon must perform the group unrolling and will be unable to answer incoming NSS or authentication requests during this time. The default value was changed from 1 to 0 with Samba 4.2. Some broken applications (including some implementations of newgrp and sg) calculate the group memberships of users by traversing groups, such applications will require "winbind expand groups = 1". But the new default makes winbindd more reliable as it doesn't require SAMR access to domain controllers of trusted domains. winbind:ignore domains Allows one to enter a list of trusted domains winbind should ignore (untrust). This can avoid the overhead of resources from attempting to login to DCs that should not be communicated with. Example: DOMAIN1, DOMAIN2 winbind max clients This parameter specifies the maximum number of clients the winbindd 8 daemon can connect with. The parameter is not a hard limit. The winbindd 8 daemon configures itself to be able to accept at least that many connections, and if the limit is reached, an attempt is made to disconnect idle clients. winbind max domain connections This parameter specifies the maximum number of simultaneous connections that the winbindd 8 daemon should open to the domain controller of one domain. Setting this parameter to a value greater than 1 can improve scalability with many simultaneous winbind requests, some of which might be slow. Note that if is set to Yes, then only one DC connection is allowed per domain, regardless of this setting. Example: 10 winbind nested groups If set to yes, this parameter activates the support for nested groups. Nested groups are also called local groups or aliases. They work like their counterparts in Windows: Nested groups are defined locally on any machine (they are shared between DC's through their SAM) and can contain users and global groups from any trusted SAM. To be able to use nested groups, you need to run nss_winbind. winbind normalize names This parameter controls whether winbindd will replace whitespace in user and group names with an underscore (_) character. For example, whether the name "Space Kadet" should be replaced with the string "space_kadet". Frequently Unix shell scripts will have difficulty with usernames contains whitespace due to the default field separator in the shell. If your domain possesses names containing the underscore character, this option may cause problems unless the name aliasing feature is supported by your nss_info plugin. This feature also enables the name aliasing API which can be used to make domain user and group names to a non-qualified version. Please refer to the manpage for the configured idmap and nss_info plugin for the specifics on how to configure name aliasing for a specific configuration. Name aliasing takes precedence (and is mutually exclusive) over the whitespace replacement mechanism discussed previously. Example: yes winbind nss info This parameter is designed to control how Winbind retrieves Name Service Information to construct a user's home directory and login shell. Currently the following settings are available: template - The default, using the parameters of template shell and template homedir) <sfu | sfu20 | rfc2307 > - When Samba is running in security = ads and your Active Directory Domain Controller does support the Microsoft "Services for Unix" (SFU) LDAP schema, winbind can retrieve the login shell and the home directory attributes directly from your Directory Server. For SFU 3.0 or 3.5 simply choose "sfu", if you use SFU 2.0 please choose "sfu20". Note that for the idmap backend idmap_ad you need to configure those settings in the idmap configuration section. Make sure to consult the documentation of the idmap backend that you are using. Example: sfu winbind offline logon This parameter is designed to control whether Winbind should allow one to login with the pam_winbind module using Cached Credentials. If enabled, winbindd will store user credentials from successful logins encrypted in a local cache. Example: yes winbind reconnect delay This parameter specifies the number of seconds the winbindd 8 daemon will wait between attempts to contact a Domain controller for a domain that is determined to be down or not contactable. winbind refresh tickets This parameter is designed to control whether Winbind should refresh Kerberos Tickets retrieved using the pam_winbind module. Example: yes winbind request timeout This parameter specifies the number of seconds the winbindd 8 daemon will wait before disconnecting either a client connection with no outstanding requests (idle) or a client connection with a request that has remained outstanding (hung) for longer than this number of seconds. winbind rpc only Setting this parameter to yes forces winbindd to use RPC instead of LDAP to retrieve information from Domain Controllers. winbind scan trusted domains This option only takes effect when the option is set to domain or ads. If it is set to yes (the default), winbindd periodically tries to scan for new trusted domains and adds them to a global list inside of winbindd. The list can be extracted with wbinfo --trusted-domains --verbose. This matches the behaviour of Samba 4.7 and older. The construction of that global list is not reliable and often incomplete in complex trust setups. In most situations the list is not needed any more for winbindd to operate correctly. E.g. for plain file serving via SMB using a simple idmap setup with autorid, tdb or ad. However some more complex setups require the list, e.g. if you specify idmap backends for specific domains. Some pam_winbind setups may also require the global list. If you have a setup that doesn't require the global list, you should set no. winbind sealed pipes This option controls whether any requests from winbindd to domain controllers pipe will be sealed. Disabling sealing can be useful for debugging purposes. The behavior can be controlled per netbios domain by using 'winbind sealed pipes:NETBIOSDOMAIN = no' as option. winbind separator This parameter allows an admin to define the character used when listing a username of the form of DOMAIN \user. This parameter is only applicable when using the pam_winbind.so and nss_winbind.so modules for UNIX services. Please note that setting this parameter to + causes problems with group membership at least on glibc systems, as the character + is used as a special character for NIS in /etc/group. Example: + winbind use default domain This parameter specifies whether the winbindd 8 daemon should operate on users without domain component in their username. Users without a domain component are treated as is part of the winbindd server's own domain. While this does not benefit Windows users, it makes SSH, FTP and e-mail function in a way much closer to the way they would in a native unix system. This option should be avoided if possible. It can cause confusion about responsibilities for a user or group. In many situations it is not clear whether winbind or /etc/passwd should be seen as authoritative for a user, likewise for groups. Example: yes winbind use krb5 enterprise principals winbindd is able to get kerberos tickets for pam_winbind with krb5_auth or wbinfo -K/--krb5auth=. winbindd (at least on a domain member) is never be able to have a complete picture of the trust topology (which is managed by the DCs). There might be uPNSuffixes and msDS-SPNSuffixes values, which don't belong to any AD domain at all. With no winbindd don't even get an incomplete picture of the topology. It is not really required to know about the trust topology. We can just rely on the [K]DCs of our primary domain (e.g. PRIMARY.A.EXAMPLE.COM) and use enterprise principals e.g. upnfromB@B.EXAMPLE.COM@PRIMARY.A.EXAMPLE.COM and follow the WRONG_REALM referrals in order to find the correct DC. The final principal might be userfromB@INTERNALB.EXAMPLE.PRIVATE. With yes winbindd enterprise principals will be used. Example: yes dns proxy Specifies that nmbd 8 when acting as a WINS server and finding that a NetBIOS name has not been registered, should treat the NetBIOS name word-for-word as a DNS name and do a lookup with the DNS server for that name on behalf of the name-querying client. Note that the maximum length for a NetBIOS name is 15 characters, so the DNS name (or DNS alias) can likewise only be 15 characters, maximum. nmbd spawns a second copy of itself to do the DNS name lookup requests, as doing a name lookup is a blocking action. max wins ttl This option tells smbd 8 when acting as a WINS server (yes) what the maximum 'time to live' of NetBIOS names that nmbd will grant will be (in seconds). You should never need to change this parameter. The default is 6 days (518400 seconds). min wins ttl This option tells nmbd 8 when acting as a WINS server (yes) what the minimum 'time to live' of NetBIOS names that nmbd will grant will be (in seconds). You should never need to change this parameter. The default is 6 hours (21600 seconds). nbtd:wins_prepend1Bto1Cqueries Normally queries for 0x1C names (all logon servers for a domain) will return the first address of the 0x1B names (domain master browser and PDC) as first address in the result list. As many client only use the first address in the list by default, all clients will use the same server (the PDC). Windows servers have an option to disable this behavior (since Windows 2000 Service Pack 2). nbtd:wins_wins_randomize1Clist Normally queries for 0x1C names will return the addresses in the same order as they're stored in the database, that means first all addresses which have been directly registered at the local wins server and then all addresses registered at other servers. Windows servers have an option to change this behavior and randomize the returned addresses. Set this parameter to "yes" and Samba will sort the address list depending on the client address and the matching bits of the addresses, the first address is randomized based on depending on the "nbtd:wins_randomize1Clist_mask" parameter. nbtd:wins_randomize1Clist_mask If the "nbtd:wins_randomize1Clist" parameter is set to "yes", then randomizing of the first returned address is based on the specified netmask. If there are addresses which are in the same subnet as the client address, the first returned address is randomly chosen out them. Otherwise the first returned address is randomly chosen out of all addresses. winsdb:local_owner This specifies the address that is stored in the winsOwner attribute, of locally registered winsRecord-objects. The default is to use the ip-address of the first network interface. winsdb:dbnosync This parameter disables fsync() after changes of the WINS database. wins hook When Samba is running as a WINS server this allows you to call an external program for all changes to the WINS database. The primary use for this option is to allow the dynamic update of external name resolution databases such as dynamic DNS. The wins hook parameter specifies the name of a script or executable that will be called as follows: wins_hook operation name nametype ttl IP_list The first argument is the operation and is one of "add", "delete", or "refresh". In most cases the operation can be ignored as the rest of the parameters provide sufficient information. Note that "refresh" may sometimes be called when the name has not previously been added, in that case it should be treated as an add. The second argument is the NetBIOS name. If the name is not a legal name then the wins hook is not called. Legal names contain only letters, digits, hyphens, underscores and periods. The third argument is the NetBIOS name type as a 2 digit hexadecimal number. The fourth argument is the TTL (time to live) for the name in seconds. The fifth and subsequent arguments are the IP addresses currently registered for that name. If this list is empty then the name should be deleted. An example script that calls the BIND dynamic DNS update program nsupdate is provided in the examples directory of the Samba source code. wins proxy This is a boolean that controls if nmbd 8 will respond to broadcast name queries on behalf of other hosts. You may need to set this to yes for some older clients. wins server This specifies the IP address (or DNS name: IP address for preference) of the WINS server that nmbd 8 should register with. If you have a WINS server on your network then you should set this to the WINS server's IP. You should point this at your WINS server if you have a multi-subnetted network. If you want to work in multiple namespaces, you can give every wins server a 'tag'. For each tag, only one (working) server will be queried for a name. The tag should be separated from the ip address by a colon. You need to set up Samba to point to a WINS server if you have multiple subnets and wish cross-subnet browsing to work correctly. See the chapter in the Samba3-HOWTO on Network Browsing. Example: mary:192.9.200.1 fred:192.168.3.199 mary:192.168.2.61 Example: 192.9.200.1 192.168.2.61 wins support This boolean controls if the nmbd 8 process in Samba will act as a WINS server. You should not set this to yes unless you have a multi-subnetted network and you wish a particular nmbd to be your WINS server. Note that you should NEVER set this to yes on more than one machine in your network. wreplsrv:periodic_interval This maximum interval in seconds between 2 periodically scheduled runs where we check for wins.ldb changes and do push notifications to our push partners. Also wins_config.ldb changes are checked in that interval and partner configuration reloads are done. wreplsrv:propagate name releases If this parameter is enabled, then explicit (from the client) and implicit (via the scavenging) name releases are propagated to the other servers directly, even if there are still other addresses active, this applies to SPECIAL GROUP (2) and MULTIHOMED (3) entries. Also the replication conflict merge algorithm for SPECIAL GROUP (2) entries discards replica addresses where the address owner is the local server, if the address was not stored locally before. The merge result is propagated directly in case an address was discarded. A Windows servers doesn't propagate name releases of SPECIAL GROUP (2) and MULTIHOMED (3) entries directly, which means that Windows servers may return different results to name queries for SPECIAL GROUP (2) and MULTIHOMED (3) names. The option doesn't have much negative impact if Windows servers are around, but be aware that they might return unexpected results. wreplsrv:scavenging_interval This is the interval in s between 2 scavenging runs which clean up the WINS database and changes the states of expired name records. Defaults to half of the value of wreplsrv:renew_interval. wreplsrv:tombstone_extra_timeout This is the time in s the server needs to be up till we'll remove tombstone records from our database. Defaults to 3 days. wreplsrv:tombstone_interval This is the interval in s till released records of the WINS server become tombstone. Defaults to 6 days. wreplsrv:tombstone_timeout This is the interval in s till tombstone records are deleted from the WINS database. Defaults to 1 day. wreplsrv:verify_interval This is the interval in s till we verify active replica records with the owning WINS server. Unfortunately not implemented yet. Defaults to 24 days. Messages Message of the day The contents of /etc/motd are displayed after a successful login but just before it executes the login shell. Login Prompt Message The issue file may contain certain escape codes to display the system name, date, time etc. All escape codes consist of a backslash (\) immediately followed by one of the characters listed below. 4 or 4{interface} Insert the IPv4 address of the specified network interface (for example: \4{eth0}). If the interface argument is not specified, then select the first fully configured (UP, non-LOCALBACK, RUNNING) interface. If not any configured interface is found, fall back to the IP address of the machine's hostname. 6 or 6{interface} The same as \4 but for IPv6. b Insert the baudrate of the current line. d Insert the current date. e or e{name} Translate the human-readable name to an escape sequence and insert it (for example: \e{red}Alert text.\e{reset}). If the name argument is not specified, then insert \033. The currently supported names are: black, blink, blue, bold, brown, cyan, darkgray, gray, green, halfbright, lightblue, lightcyan, lightgray, lightgreen, lightmagenta, lightred, magenta, red, reset, reverse, and yellow. All unknown names are silently ignored. s Insert the system name (the name of the operating system). Same as 'uname -s'. See also the \S escape code. S or S{VARIABLE} Insert the VARIABLE data from /etc/os-release. If this file does not exist then fall back to /usr/lib/os-release. If the VARIABLE argument is not specified, then use PRETTY_NAME from the file or the system name (see \s). This escape code allows to keep /etc/issue distribution and release independent. Note that \S{ANSI_COLOR} is converted to the real terminal escape sequence. l Insert the name of the current tty line. m Insert the architecture identifier of the machine. Same as 'uname -m'. n Insert the nodename of the machine, also known as the hostname. Same as 'uname -n'. o Insert the NIS domainname of the machine. Same as 'hostname -d'. O Insert the DNS domainname of the machine. r Insert the release number of the OS. Same as 'uname -r'. t Insert the current time. u Insert the number of current users logged in. U Insert the string "1 user" or "<n> users" where <n> is the number of current users logged in. v Insert the version of the OS, that is, the build-date and such. Firewalld Zones A list of zones to create. Existing zones on the host will be unaffected. Rule creation for zones is handled in the Rules setting. Rules A JSON dictionary, containing zones paired with a list of rules. For example, to create rules for the Work and Home zones, specify the following JSON: { "work": [ {"rule": {"family": "ipv4"}, "source address": "172.25.1.7", "service name": "ftp", "reject": {}}, {"rule": {}, "source address": "172.25.1.8", "service name": "ftp", "reject": {}} ], "home": [ {"rule": {}, "protocol value": "icmp", "reject": {}}, {"rule": {"family": "ipv4"}, "source address": "192.168.1.2/32", "service name": "telnet", "accept": {"limit value": "1/m"}} ] } An improperly formatted JSON will be ignored. The rule structure loosely follows the Firewalld Rich Language Documentation. General rule structure: { "rule": { "family": "ipv4 | ipv6", "priority": "priority" }, "source [not] address | mac | ipset": "address[/mask] | mac-address | ipset", "destination [not] address": "address[/mask]", "service name": "service name", "port": { "port": "port value", "protocol": "tcp | udp" } "protocol value": "protocol value", "icmp-block name": "icmptype name", "Masquerade": true|false, "icmp-type": "icmptype name", "forward-port": { "port": "port value", "protocol": "tcp | udp", "to-port": "port value", "to-addr": "address" }, "source-port": { "port": "port value", "protocol": "tcp | udp" }, "log": { "prefix": "prefix text", "level": "emerg | alert | crit | error | warning | notice | info | debug", "limit value": "rate/duration" }, "audit": { "limit value": "rate/duration" }, "accept" : { "limit value": "rate/duration" } | "reject": { "type": "reject type", "limit value": "rate/duration" } | "drop": { "limit value": "rate/duration" } | "mark": { "set": "mark[/mask]", "limit value": "rate/duration" } } Script and arguments Script and arguments Script and arguments Script and arguments Sudoers commands additional dns hostnames bind interfaces only config backend file dos charset enable core files mdns name netbios multicast dns register netbios aliases netbios name netbios scope realm server services s3fs, rpc, nbt, wrepl, ldap, cldap, kdc, drepl, winbindd, ntp_signd, kcc, dnsupdate, dns server string Samba %v share backend classic unix charset UTF-8 workgroup WORKGROUP interfaces browse list domain master auto enhanced browsing lm announce auto local master preferred master auto allow dns updates secure only dns forwarder dns update command /samba_dnsupdate dns zone scavenging gpo update command /samba-gpupdate nsupdate command /usr/bin/nsupdate -g spn update command /samba_spnupdate mangling method hash2 stat cache client ldap sasl wrapping sign ldap admin dn ldap delete dn ldap deref auto ldap follow referral auto ldap group suffix ldap idmap suffix ldap machine suffix ldap passwd sync no ldapsam:editposix no ldapsam:trusted no ldap server require strong auth yes ldap ssl start tls ldap ssl ads ldap suffix ldap user suffix smb2 leases debug class debug hires timestamp debug pid debug prefix timestamp debug uid log file logging log level 0 syslog only timestamp logs abort shutdown script "" add group script add machine script add user script add user to group script allow nt4 crypto auth event notification delete group script delete user from group script delete user script domain logons enable privileges init logon delayed hosts logon drive logon home \\%N\%U logon path \\%N\%U\profile logon script reject md5 clients set primary group script shutdown script add share command afs username map allow insecure wide links allow unsafe cluster upgrade async smb echo handler auto services cache directory change notify change share command cluster addresses clustering config file ctdbd socket default service delete share command dsdb event notification dsdb group change notification dsdb password event notification elasticsearch:mappings /elasticsearch_mappings.json fss: prune stale homedir map kernel change notify lock directory log writeable files on exit message command nbt client socket address 0.0.0.0 ncalrpc dir NIS homedir nmbd bind explicit broadcast panic action perfcount module pid directory registry shares remote announce remote browse sync reset on zero vc rpc_daemon:DAEMON disabled rpc_server:SERVER embedded smbd profiling level off state directory usershare allow guests usershare owner only usershare path /usershares usershare prefix allow list usershare prefix deny list usershare template share utmp utmp directory wtmp directory addport command addprinter command cups encrypt no cups server "" deleteprinter command disable spoolss enable spoolss enumports command iprint server "" load printers os2 driver map printcap name /etc/printcap show add printer wizard spoolss: architecture Windows NT x86 client ipc max protocol default client ipc min protocol default client max protocol default client min protocol SMB2_02 client use spnego dcerpc endpoint servers epmapper, wkssvc, rpcecho, samr, netlogon, lsarpc, drsuapi, dssetup, unixinfo, browser, eventlog6, backupkey, dnsserver defer sharing violations disable netbios enable asu support eventlog list large readwrite lsa over netlogon name resolve order lmhosts wins host bcast nt pipe support nt status support read raw rpc big endian server max protocol SMB3 server min protocol SMB2_02 share:fake_fscaps 0 smb ports 445 139 svcctl list time server unicode unix extensions write raw server multi channel support smb2 disable lock sequence checking smb2 disable oplock break retry rpc server dynamic port range 49152-65535 allow dcerpc auth level connect allow trusted domains binddns dir check password script client ipc signing default client lanman auth client NTLMv2 auth client plaintext auth client schannel yes client signing default client use spnego principal debug encryption dedicated keytab file encrypt passwords guest account nobody kerberos encryption types all kerberos method default lanman auth log nt token command map to guest Never mit kdc command ntlm auth ntlmv2-only ntp signd socket directory null passwords obey pam restrictions pam password change passdb backend tdbsam passdb expand explicit passwd chat *new*password* %n\n *new*password* %n\n *changed* passwd chat debug passwd program password hash gpg key ids password hash userPassword schemes password server * preload modules private dir raw NTLMv2 auth rename user script root directory samba kcc command /samba_kcc security AUTO server role AUTO server schannel yes server signing default smb passwd file tls cafile tls/ca.pem tls certfile tls/cert.pem tls crlfile tls dh params file tls enabled tls keyfile tls/key.pem tls verify peer as_strict_as_possible unix password sync username map username map script tls priority NORMAL:-VERS-SSL3.0 getwd cache hostname lookups socket options TCP_NODELAY use mmap get quota command host msdfs set quota command apply group policies create krb5 conf idmap backend tdb idmap gid idmap uid include system krb5 conf neutralize nt4 emulation reject md5 servers require strong key template homedir /home/%D/%U template shell /bin/false winbindd socket directory winbind enum groups winbind enum users winbind:ignore domains winbind nested groups winbind normalize names winbind nss info template winbind offline logon winbind refresh tickets winbind rpc only winbind scan trusted domains winbind sealed pipes winbind separator \ winbind use default domain winbind use krb5 enterprise principals dns proxy nbtd:wins_prepend1Bto1Cqueries yes nbtd:wins_wins_randomize1Clist no nbtd:wins_randomize1Clist_mask 255.255.255.0 winsdb:local_owner winsdb:dbnosync no wins hook wins proxy wins server wins support wreplsrv:periodic_interval 15 wreplsrv:propagate name releases no wreplsrv:scavenging_interval wreplsrv:tombstone_extra_timeout 259200 wreplsrv:tombstone_interval 518400 wreplsrv:tombstone_timeout 86400 wreplsrv:verify_interval 2073600 Message of the day Login Prompt Message Welcome to \s \r \l Firewalld Zones Firewalld Rules {}