The FCsmb.confF[] file is a configuration file for the Samba suite. FCsmb.confF[] contains runtime configuration information for the Samba programs. The FCsmb.confF[] file is designed to be configured and administered by the swat(8) program. The complete description of the file format and possible parameters held within are here for reference purposes.
The file consists of sections and parameters. A section begins with the name of the section in square brackets and continues until the next section begins. Sections contain parameters of the form:
name = value
The file is line-based - that is, each newline-terminated line represents either a comment, a section name or a parameter.
Section and parameter names are not case sensitive.
Only the first equals sign in a parameter is significant. Whitespace before or after the first equals sign is discarded. Leading, trailing and internal whitespace in section and parameter names is irrelevant. Leading and trailing whitespace in a parameter value is discarded. Internal whitespace within a parameter value is retained verbatim.
Any line beginning with a semicolon (lq;rq) or a hash (lq#rq) character is ignored, as are lines containing only whitespace.
Any line ending in a lqFC\F[]rq is continued on the next line in the customary UNIX fashion.
The values following the equals sign in parameters are all either a string (no quotes needed) or a boolean, which may be given as yes/no, 1/0 or true/false. Case is not significant in boolean values, but is preserved in string values. Some items such as create masks are numeric.
Each section in the configuration file (except for the [global] section) describes a shared resource (known as a lqsharerq). The section name is the name of the shared resource and the parameters within the section define the shares attributes.
There are three special sections, [global], [homes] and [printers], which are described under special sections. The following notes apply to ordinary section descriptions.
A share consists of a directory to which access is being given plus a description of the access rights which are granted to the user of the service. Some housekeeping options are also specifiable.
Sections are either file share services (used by the client as an extension of their native file systems) or printable services (used by the client to access print services on the host running the server).
Sections may be designated guest services, in which case no password is required to access them. A specified UNIX guest account is used to define access privileges in this case.
Sections other than guest services will require a password to access them. The client provides the username. As older clients only provide passwords and not usernames, you may specify a list of usernames to check against the password using the FCuser =F[] option in the share definition. For modern clients such as Windows 95/98/ME/NT/2000, this should not be necessary.
The access rights granted by the server are masked by the access rights granted to the specified or guest UNIX user by the host system. The server does not grant more access than the host system grants.
The following sample section defines a file space share. The user has write access to the path FC/home/barF[]. The share is accessed via the share name FCfooF[]:
[foo]
m[blue]path = /home/barm[]
m[blue]read only = nom[]
The following sample section defines a printable share. The share is read-only, but printable. That is, the only write access permitted is via calls to open, write to and close a spool file. The guest ok parameter means access will be permitted as the default guest user (specified elsewhere):
[aprinter]
m[blue]path = /usr/spool/publicm[]
m[blue]read only = yesm[]
m[blue]printable = yesm[]
m[blue]guest ok = yesm[]
Parameters in this section apply to the server as a whole, or are defaults for sections that do not specifically define certain items. See the notes under PARAMETERS for more information.
If a section called [homes] is included in the configuration file, services connecting clients to their home directories can be created on the fly by the server.
When the connection request is made, the existing sections are scanned. If a match is found, it is used. If no match is found, the requested section name is treated as a username and looked up in the local password file. If the name exists and the correct password has been given, a share is created by cloning the [homes] section.
Some modifications are then made to the newly created share:
If you decide to use a path = line in your [homes] section, it may be useful to use the %S macro. For example:
path = /data/pchome/%S
is useful if you have different home directories for your PCs than for UNIX access.
This is a fast and simple way to give a large number of clients access to their home directories with a minimum of fuss.
A similar process occurs if the requested section name is lqhomesrq, except that the share name is not changed to that of the requesting user. This method of using the [homes] section works well if different users share a client PC.
The [homes] section can specify all the parameters a normal service section can specify, though some make more sense than others. The following is a typical and suitable [homes] section:
[homes] m[blue]read only = nom[]
An important point is that if guest access is specified in the [homes] section, all home directories will be visible to all clients without a password. In the very unlikely event that this is actually desirable, it is wise to also specify read only access.
The browseable flag for auto home directories will be inherited from the global browseable flag, not the [homes] browseable flag. This is useful as it means setting browseable = no in the [homes] section will hide the [homes] share but make any auto home directories visible.
This section works like [homes], but for printers.
If a [printers] section occurs in the configuration file, users are able to connect to any printer specified in the local host's printcap file.
When a connection request is made, the existing sections are scanned. If a match is found, it is used. If no match is found, but a [homes] section exists, it is used as described above. Otherwise, the requested section name is treated as a printer name and the appropriate printcap file is scanned to see if the requested section name is a valid printer share name. If a match is found, a new printer share is created by cloning the [printers] section.
A few modifications are then made to the newly created share:
The [printers] service MUST be printable - if you specify otherwise, the server will refuse to load the configuration file.
Typically the path specified is that of a world-writeable spool directory with the sticky bit set on it. A typical [printers] entry looks like this:
[printers] m[blue]path = /usr/spool/publicm[] m[blue]guest ok = yesm[] m[blue]printable = yesm[]
All aliases given for a printer in the printcap file are legitimate printer names as far as the server is concerned. If your printing subsystem doesn't work like that, you will have to set up a pseudo-printcap. This is a file consisting of one or more lines like this:
alias|alias|alias|alias...
Each alias should be an acceptable printer name for your printing subsystem. In the [global] section, specify the new file as your printcap. The server will only recognize names found in your pseudo-printcap, which of course can contain whatever aliases you like. The same technique could be used simply to limit access to a subset of your local printers.
An alias, by the way, is defined as any component of the first entry of a printcap record. Records are separated by newlines, components (if there are more than one) are separated by vertical bar symbols (FC|F[]).
On SYSV systems which use lpstat to determine what printers are defined on the system you may be able to use FCprintcap name = lpstatF[] to automatically obtain a list of printers. See the FCprintcap nameF[] option for more details.
Starting with Samba version 3.0.23 the capability for non-root users to add, modify, and delete their own share definitions has been added. This capability is called usershares and is controlled by a set of parameters in the [global] section of the smb.conf. The relevant parameters are :
usershare allow guests
usershare max shares
usershare owner only
usershare path
usershare prefix allow list
usershare prefix deny list
usershare template share
To allow members of the UNIX group FCfooF[] to create user defined shares, create the directory to contain the share definitions as follows:
Become root:
mkdir /usr/local/samba/lib/usershares chgrp foo /usr/local/samba/lib/usershares chmod 1770 /usr/local/samba/lib/usershares
Then add the parameters
m[blue]usershare path = /usr/local/samba/lib/usersharesm[]
m[blue]usershare max shares = 10m[] # (or the desired number of shares)
to the global section of your FCsmb.confF[]. Members of the group foo may then manipulate the user defined shares using the following commands.
net usershare add sharename path [comment] [acl] [guest_ok=[y|n]]
net usershare delete sharename
net usershare list wildcard-sharename
net usershare info wildcard-sharename
Parameters define the specific attributes of sections.
Some parameters are specific to the [global] section (e.g., security). Some parameters are usable in all sections (e.g., create mask). All others are permissible only in normal sections. For the purposes of the following descriptions the [homes] and [printers] sections will be considered normal. The letter G in parentheses indicates that a parameter is specific to the [global] section. The letter S indicates that a parameter can be specified in a service specific section. All S parameters can also be specified in the [global] section - in which case they will define the default behavior for all services.
Parameters are arranged here in alphabetical order - this may not create best bedfellows, but at least you can find them! Where there are synonyms, the preferred synonym is described, others refer to the preferred synonym.
Many of the strings that are settable in the config file can take substitutions. For example the option lqpath = /tmp/%urq is interpreted as lqpath = /tmp/johnrq if the user connected with the username john.
These substitutions are mostly noted in the descriptions below, but there are some general substitutions which apply whenever they might be relevant. These are:
%U
%G
%h
%m
This parameter is not available when Samba listens on port 445, as clients no longer send this information. If you use this macro in an include statement on a domain that has a Samba domain controller be sure to set in the [global] section smb ports = 139. This will cause Samba to not listen on port 445 and will permit include functionality to function as it did with Samba 2.x.
%L
%M
%R
%d
%a
%I
%i
%T
%D
%w
%$(envvar)
The following substitutes apply only to some configuration options (only those that are used when a connection has been established):
%S
%P
%u
%g
%H
%N
%p
There are some quite creative things that can be done with these substitutions and other FCsmb.confF[] options.
Samba supports FCname manglingF[] so that DOS and Windows clients can use files that don't conform to the 8.3 format. It can also be set to adjust the case of 8.3 format filenames.
There are several options that control the way mangling is performed, and they are grouped here rather than listed separately. For the defaults look at the output of the testparm program.
These options can be set separately for each service.
The options are:
case sensitive = yes/no/auto
default case = upper/lower
preserve case = yes/no
short preserve case = yes/no
By default, Samba 3.0 has the same semantics as a Windows NT server, in that it is case insensitive but case preserving. As a special case for directories with large numbers of files, if the case options are set as follows, "case sensitive = yes", "case preserve = no", "short preserve case = no" then the "default case" option will be applied and will modify all filenames sent from the client when accessing this share.
There are a number of ways in which a user can connect to a service. The server uses the following steps in determining if it will allow a connection to a specified service. If all the steps fail, the connection request is rejected. However, if one of the steps succeeds, the following steps are not checked.
If the service is marked lqguest only = yesrq and the server is running with share-level security (lqsecurity = sharerq, steps 1 to 5 are skipped.
Starting with Samba version 3.2.0, the capability to store Samba configuration in the registry is available. The configuration is stored in the registry key FCHKLM\Software\Samba\smbconfF[]. There are two levels of registry configuration:
The registry shares are loaded not at startup but on demand at runtime by smbd. Shares defined in smb.conf take priority over shares of the same name defined in registry.
Firstly, a registry only configuration is triggered by setting m[blue]config backend = registrym[] in the [global] section of smb.conf. This resets everything that has been read from config files to this point and reads the content of the global configuration section from the registry. This is the recommended method of using registry based configuration.
Secondly, a mixed configuration can be activated by a special new meaning of the parameter m[blue]include = registrym[] in the [global] section of smb.conf. This reads the global options from registry with the same priorities as for an include of a text file. This may be especially useful in cases where an initial configuration is needed to access the registry.
Activation of global registry options automatically activates registry shares. So in the registry only case, shares are loaded on demand only.
Note: To make registry-based configurations foolproof at least to a certain extent, the use of lock directory and config backend inside the registry configuration has been disabled: Especially by changing the lock directory inside the registry configuration, one would create a broken setup where the daemons do not see the configuration they loaded once it is active.
The registry configuration can be accessed with tools like regedit or net (rpc) registry in the key FCHKLM\Software\Samba\smbconfF[]. More conveniently, the conf subcommand of the net(8) utility offers a dedicated interface to read and write the registry based configuration locally, i.e. directly accessing the database file, circumventing the server.
abort shutdown script (G)
If the connected user posseses the SeRemoteShutdownPrivilege, right, this command will be run as root.
Default: abort shutdown script = FC""F[]
Example: abort shutdown script = FC/sbin/shutdown -cF[]
public
access based share enum (S)
Default: access based share enum = FCnoF[]
acl check permissions (S)
If this parameter is set to "false" Samba doesn't check permissions on "open for delete" and allows the open. If the user doesn't have permission to delete the file this will only be discovered at close time, which is too late for the Windows user tools to display an error message to the user. The symptom of this is files that appear to have been deleted "magically" re-appearing on a Windows explorer refresh. This is an extremely advanced protocol option which should not need to be changed. This parameter was introduced in its final form in 3.0.21, an earlier version with slightly different semantics was introduced in 3.0.20. That older version is not documented here.
Default: acl check permissions = FCTrueF[]
acl compatibility (G)
Default: acl compatibility = FCAutoF[]
Example: acl compatibility = FCwin2kF[]
acl group control (S)
On a Windows server, groups may be the owner of a file or directory - thus allowing anyone in that group to modify the permissions on it. This allows the delegation of security controls on a point in the filesystem to the group owner of a directory and anything below it also owned by that group. This means there are multiple people with permissions to modify ACLs on a file or directory, easing managability.
This parameter allows Samba to also permit delegation of the control over a point in the exported directory hierarchy in much the same way as Windows. This allows all members of a UNIX group to control the permissions on a file or directory they have group ownership on.
This parameter is best used with the m[blue]inherit ownerm[] option and also on on a share containing directories with the UNIX setgid bit set on them, which causes new files and directories created within it to inherit the group ownership from the containing directory.
This is parameter has been was deprecated in Samba 3.0.23, but re-activated in Samba 3.0.31 and above, as it now only controls permission changes if the user is in the owning primary group. It is now no longer equivalent to the dos filemode option.
Default: acl group control = FCnoF[]
acl map full control (S)
Default: acl map full control = FCTrueF[]
add group script (G)
Default: add group script = FCF[]
Example: add group script = FC/usr/sbin/groupadd %gF[]
add machine script (G)
This option is very similar to the m[blue]add user scriptm[], and likewise uses the %u substitution for the account name. Do not use the %m substitution.
Default: add machine script = FCF[]
Example: add machine script = FC/usr/sbin/adduser -n -g machines -c Machine -d /var/lib/nobody -s /bin/false %uF[]
add port command (G)
Default: add port command = FCF[]
Example: add port command = FC/etc/samba/scripts/addport.shF[]
addprinter command (G)
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 FCsmb.confF[] file in order that it can be shared by smbd(8).
The addprinter command is automatically invoked with the following parameter (in order):
Once the addprinter command has been executed, FCsmbdF[] will reparse the FC smb.confF[] to determine if the share defined by the APW exists. If the sharename is still invalid, then FCsmbd F[] 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.
Default: addprinter command = FCF[]
Example: addprinter command = FC/usr/bin/addprinterF[]
add share command (G)
In order to successfully execute the add share command, FCsmbdF[] requires that the administrator connects using a root account (i.e. uid == 0) or has the FCSeDiskOperatorPrivilegeF[]. Scripts defined in the add share command parameter are executed as root.
When executed, FCsmbdF[] will automatically invoke the add share command with five parameters.
Default: add share command = FCF[]
Example: add share command = FC/usr/local/bin/addshareF[]
add user script (G)
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.
In order to use this option, smbd(8) must NOT be set to m[blue]security = sharem[] and m[blue]add user scriptm[] must be set to a full pathname for a script that will create a UNIX user given one argument of %u, which expands into the UNIX user name to create.
When the Windows user attempts to access the Samba server, at login (session setup in the SMB protocol) time, smbd(8) contacts the m[blue]password serverm[] and attempts to authenticate the given user with the given password. If the authentication succeeds then FCsmbdF[] attempts to find a UNIX user in the UNIX password database to map the Windows user into. If this lookup fails, and m[blue]add user scriptm[] is set then FCsmbdF[] 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 FCsmbdF[] 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 m[blue]securitym[], m[blue]password serverm[], m[blue]delete user scriptm[].
Default: add user script = FCF[]
Example: add user script = FC/usr/local/samba/bin/add_user %uF[]
add user to group script (G)
Note that the FCadduserF[] command used in the example below does not support the used syntax on all systems.
Default: add user to group script = FCF[]
Example: add user to group script = FC/usr/sbin/adduser %u %gF[]
administrative share (S)
See the section below on m[blue]securitym[] for more information about this option.
Default: administrative share = FCnoF[]
admin users (S)
You should use this option very carefully, as any user in this list will be able to do anything they like on the share, irrespective of file permissions.
This parameter will not work with the m[blue]security = sharem[] in Samba 3.0. This is by design.
Default: admin users = FCF[]
Example: admin users = FCjasonF[]
afs share (S)
Default: afs share = FCnoF[]
afs username map (G)
The mapped user name must contain the cell name to log into, so without setting this parameter there will be no token.
Default: afs username map = FCF[]
Example: afs username map = FC%u@afs.samba.orgF[]
aio read size (S)
Current implementation of asynchronous I/O in Samba 3.0 does support only up to 10 outstanding asynchronous requests, read and write combined.
Related command: m[blue]write cache sizem[]
Related command: m[blue]aio write sizem[]
Default: aio read size = FC0F[]
Example: aio read size = FC16384 # Use asynchronous I/O for reads bigger than 16KB request sizeF[]
aio write size (S)
Current implementation of asynchronous I/O in Samba 3.0 does support only up to 10 outstanding asynchronous requests, read and write combined.
Related command: m[blue]write cache sizem[]
Related command: m[blue]aio read sizem[]
Default: aio write size = FC0F[]
Example: aio write size = FC16384 # Use asynchronous I/O for writes bigger than 16KB request sizeF[]
algorithmic rid base (G)
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 sytem 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.
Default: algorithmic rid base = FC1000F[]
Example: algorithmic rid base = FC100000F[]
allocation roundup size (S)
The integer parameter specifies the roundup size in bytes.
Default: allocation roundup size = FC1048576F[]
Example: allocation roundup size = FC0 # (to disable roundups)F[]
allow trusted domains (G)
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.
Default: allow trusted domains = FCyesF[]
announce as (G)
Default: announce as = FCNT ServerF[]
Example: announce as = FCWin95F[]
announce version (G)
Default: announce version = FC4.9F[]
Example: announce version = FC2.0F[]
auth methods (G)
Each entry in the list attempts to authenticate the user in turn, until the user authenticates. In practice only one method will ever actually be able to complete the authentication.
Possible options include guest (anonymous access), sam (lookups in local list of accounts based on netbios name or domain name), winbind (relay authentication requests for remote users through winbindd), ntdomain (pre-winbindd method of authentication for remote domain users; deprecated in favour of winbind method), trustdomain (authenticate trusted users by contacting the remote DC directly from smbd; deprecated in favour of winbind method).
Default: auth methods = FCF[]
Example: auth methods = FCguest sam winbindF[]
available (S)
Default: available = FCyesF[]
bind interfaces only (G)
For name service it causes FCnmbdF[] to bind to ports 137 and 138 on the interfaces listed in the m[blue]interfacesm[] parameter. FCnmbdF[] 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 FCnmbdF[] will service name requests on all of these sockets. If m[blue]bind interfaces onlym[] is set then FCnmbdF[] 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 m[blue]interfacesm[] parameter list. As unicast packets are received on the other sockets it allows FCnmbdF[] to refuse to serve names to machines that send packets that arrive through any interfaces not listed in the m[blue]interfacesm[] list. IP Source address spoofing does defeat this simple check, however, so it must not be used seriously as a security feature for FCnmbdF[].
For file service it causes smbd(8) to bind only to the interface list given in the m[blue]interfacesm[] parameter. This restricts the networks that FCsmbdF[] 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 m[blue]bind interfaces onlym[] is set and the network address 127.0.0.1 is not added to the m[blue]interfacesm[] parameter list smbpasswd(8) and swat(8) may not work as expected due to the reasons covered below.
To change a users SMB password, the FCsmbpasswdF[] by default connects to the localhost - 127.0.0.1 address as an SMB client to issue the password change request. If m[blue]bind interfaces onlym[] is set then unless the network address 127.0.0.1 is added to the m[blue]interfacesm[] parameter list then FC smbpasswdF[] will fail to connect in it's default mode. FCsmbpasswdF[] 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.
The FCswatF[] status page tries to connect with FCsmbdF[] and FCnmbdF[] at the address 127.0.0.1 to determine if they are running. Not adding 127.0.0.1 will cause FC smbdF[] and FCnmbdF[] to always show "not running" even if they really are. This can prevent FC swatF[] from starting/stopping/restarting FCsmbdF[] and FCnmbdF[].
Default: bind interfaces only = FCnoF[]
blocking locks (S)
If this parameter is set and the lock range requested cannot be immediately satisfied, samba will internally queue the lock request, and periodically attempt to obtain the lock until the timeout period expires.
If this parameter is set to no, then samba will behave as previous versions of Samba would and will fail the lock request immediately if the lock range cannot be obtained.
Default: blocking locks = FCyesF[]
block size (S)
Changing this parameter may have some effect on the efficiency of client writes, this is not yet confirmed. This parameter was added to allow advanced administrators to change it (usually to a higher value) and test the effect it has on client write performance without re-compiling the code. As this is an experimental option it may be removed in a future release.
Changing this option does not change the disk free reporting size, just the block size unit reported to the client.
Default: block size = FC1024F[]
Example: block size = FC4096F[]
browsable
browseable (S)
Default: browseable = FCyesF[]
browse list (G)
Default: browse list = FCyesF[]
casesignames
case sensitive (S)
Default: case sensitive = FCnoF[]
change notify (S)
You should never need to change this parameter
Default: change notify = FCyesF[]
change share command (G)
In order to successfully execute the change share command, FCsmbdF[] requires that the administrator connects using a root account (i.e. uid == 0) or has the FCSeDiskOperatorPrivilegeF[]. Scripts defined in the change share command parameter are executed as root.
When executed, FCsmbdF[] will automatically invoke the change share command with five parameters.
Default: change share command = FCF[]
Example: change share command = FC/usr/local/bin/changeshareF[]
check password script (G)
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.
Note: In the example directory is a sample program called FCcrackcheckF[] that uses cracklib to check the password quality.
Default: check password script = FCDisabledF[]
Example: check password script = FC/usr/local/sbin/crackcheckF[]
client lanman auth (G)
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 FCclient plaintext authF[] option.
Likewise, if the FCclient ntlmv2 authF[] parameter is enabled, then only NTLMv2 logins will be attempted.
Default: client lanman auth = FCnoF[]
client ldap sasl wrapping (G)
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 "FCHKLM\System\CurrentControlSet\Services\F[] FCNTDS\Parameters\LDAPServerIntegrityF[]" 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 plain which is not irritable to KRB5 clock skew errors. That implies synchronizing the time with the KDC in the case of using sign or seal.
Default: client ldap sasl wrapping = FCplainF[]
client ntlmv2 auth (G)
If enabled, only an NTLMv2 and LMv2 response (both much more secure than earlier versions) will be sent. Many servers (including NT4 < SP4, Win9x and Samba 2.2) are not compatible with NTLMv2.
Similarly, if enabled, NTLMv1, FCclient lanman authF[] and FCclient plaintext authF[] 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 FCclient lanman authF[].
Note that some sites (particularly those following 'best practice' security polices) only allow NTLMv2 responses, and not the weaker LM or NTLM.
Default: client ntlmv2 auth = FCnoF[]
client plaintext auth (G)
Default: client plaintext auth = FCnoF[]
client schannel (G)
Default: client schannel = FCautoF[]
Example: client schannel = FCyesF[]
client signing (G)
When set to auto, 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.
Default: client signing = FCautoF[]
client use spnego (G)
Default: client use spnego = FCyesF[]
cluster addresses (G)
Default: cluster addresses = FCF[]
Example: cluster addresses = FC10.0.0.1 10.0.0.2 10.0.0.3F[]
clustering (G)
Set this parameter to FCyesF[] only if you have a cluster setup with ctdb running.
Default: clustering = FCnoF[]
comment (S)
If you want to set the string that is displayed next to the machine name then see the m[blue]server stringm[] parameter.
Default: comment = FC # No commentF[]
Example: comment = FCFred's FilesF[]
config backend (G)
Note: This option can not be set inside the registry configuration itself.
Default: config backend = FCfileF[]
Example: config backend = FCregistryF[]
config file (G)
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).
No default
Example: config file = FC/usr/local/samba/lib/smb.conf.%mF[]
copy (S)
This feature lets you set up a 'template' service and create similar services easily. Note that the service being copied must occur earlier in the configuration file than the service doing the copying.
Default: copy = FCF[]
Example: copy = FCotherserviceF[]
create mode
create mask (S)
The default value of this parameter removes the FCgroupF[] and FCotherF[] write and execute bits from the UNIX modes.
Following this Samba will bit-wise 'OR' the UNIX mode created from this parameter with the value of the m[blue]force create modem[] parameter which is set to 000 by default.
This parameter does not affect directory masks. See the parameter m[blue]directory maskm[] for details.
Note that this parameter does not apply to permissions set by Windows NT/2000 ACL editors. If the administrator wishes to enforce a mask on access control lists also, they need to set the m[blue]security maskm[].
Default: create mask = FC0744F[]
Example: create mask = FC0775F[]
csc policy (S)
These values correspond to those used on Windows servers.
For example, shares containing roaming profiles can have offline caching disabled using m[blue]csc policy = disablem[].
Default: csc policy = FCmanualF[]
Example: csc policy = FCprogramsF[]
ctdbd socket (G)
Default: ctdbd socket = FCF[]
Example: ctdbd socket = FC/tmp/ctdb.socketF[]
cups connection timeout (G)
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.
Default: cups connection timeout = FC30F[]
Example: cups connection timeout = FC60F[]
cups options (S)
You can pass any generic print option known to CUPS (as listed in the CUPS "Software Users' Manual"). You can also pass any printer specific option (as listed in "lpoptions -d printername -l") valid for the target queue. Multiple parameters should be space-delimited name/value pairs according to the PAPI text option ABNF specification. Collection values ("name={a=... b=... c=...}") are stored with the curley brackets intact.
You should set this parameter to raw if your CUPS server FCerror_logF[] file contains messages such as "Unsupported format 'application/octet-stream'" when printing from a Windows client through Samba. It is no longer necessary to enable system wide raw printing in FC/etc/cups/mime.{convs,types}F[].
Default: cups options = FC""F[]
Example: cups options = FC"raw media=a4"F[]
cups server (G)
If set, this option overrides the ServerName option in the CUPS FCclient.confF[]. 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.
Default: cups server = FC""F[]
Example: cups server = FCmycupsserverF[]
Example: cups server = FCmycupsserver:1631F[]
deadtime (G)
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.
Default: deadtime = FC0F[]
Example: deadtime = FC15F[]
debug class (G)
For more information about currently available debug classes, see section about m[blue]log levelm[].
Default: debug class = FCnoF[]
debug hires timestamp (G)
Note that the parameter m[blue]debug timestampm[] must be on for this to have an effect.
Default: debug hires timestamp = FCnoF[]
debug pid (G)
Note that the parameter m[blue]debug timestampm[] must be on for this to have an effect.
Default: debug pid = FCnoF[]
debug prefix timestamp (G)
Note that this parameter overrides the m[blue]debug timestampm[] parameter.
Default: debug prefix timestamp = FCnoF[]
timestamp logs
debug timestamp (G)
Default: debug timestamp = FCyesF[]
debug uid (G)
Note that the parameter m[blue]debug timestampm[] must be on for this to have an effect.
Default: debug uid = FCnoF[]
dedicated keytab file (G)
Default: dedicated keytab file = FCF[]
Example: dedicated keytab file = FC/usr/local/etc/krb5.keytabF[]
default case (S)
Default: default case = FClowerF[]
default devmode (S)
Most problems with serving printer drivers to Windows NT/2k/XP clients can be traced to a problem with the generated device mode. Certain drivers will do things such as crashing the client's Explorer.exe with a NULL devmode. However, other printer drivers can cause the client's spooler service (spoolsv.exe) to die if the devmode was not created by the driver itself (i.e. smbd generates a default devmode).
This parameter should be used with care and tested with the printer driver in question. It is better to leave the device mode to NULL and let the Windows client set the correct values. Because drivers do not do this all the time, setting FCdefault devmode = yesF[] will instruct smbd to generate a default one.
For more information on Windows NT/2k printing and Device Modes, see the MSDN documentation.
Default: default devmode = FCyesF[]
default
default service (G)
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 m[blue]guest okm[], m[blue]read-onlym[] 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.
Default: default service = FCF[]
Example: default service = FCpubF[]
defer sharing violations (G)
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.
Default: defer sharing violations = FCTrueF[]
delete group script (G)
Default: delete group script = FCF[]
deleteprinter command (G)
For a Samba host this means that the printer must be physically deleted from the underlying printing system. The m[blue]deleteprinter commandm[] defines a script to be run which will perform the necessary operations for removing the printer from the print system and from FCsmb.confF[].
The m[blue]deleteprinter commandm[] is automatically called with only one parameter: m[blue]printer namem[].
Once the m[blue]deleteprinter commandm[] has been executed, FCsmbdF[] will reparse the FC smb.confF[] to check that the associated printer no longer exists. If the sharename is still valid, then FCsmbd F[] will return an ACCESS_DENIED error to the client.
Default: deleteprinter command = FCF[]
Example: deleteprinter command = FC/usr/bin/removeprinterF[]
delete readonly (S)
This option may be useful for running applications such as rcs, where UNIX file ownership prevents changing file permissions, and DOS semantics prevent deletion of a read only file.
Default: delete readonly = FCnoF[]
delete share command (G)
In order to successfully execute the delete share command, FCsmbdF[] requires that the administrator connects using a root account (i.e. uid == 0) or has the FCSeDiskOperatorPrivilegeF[]. Scripts defined in the delete share command parameter are executed as root.
When executed, FCsmbdF[] will automatically invoke the delete share command with two parameters.
Default: delete share command = FCF[]
Example: delete share command = FC/usr/local/bin/delshareF[]
delete user from group script (G)
Default: delete user from group script = FCF[]
Example: delete user from group script = FC/usr/sbin/deluser %u %gF[]
delete user script (G)
This script is called when a remote client removes a user from the server, normally using 'User Manager for Domains' or FCrpcclientF[].
This script should delete the given UNIX username.
Default: delete user script = FCF[]
Example: delete user script = FC/usr/local/samba/bin/del_user %uF[]
delete veto files (S)
If this option is set to yes, then Samba will attempt to recursively delete any files and directories within the vetoed directory. This can be useful for integration with file serving systems such as NetAtalk which create meta-files within directories you might normally veto DOS/Windows users from seeing (e.g. FC.AppleDoubleF[])
Setting m[blue]delete veto files = yesm[] allows these directories to be transparently deleted when the parent directory is deleted (so long as the user has permissions to do so).
Default: delete veto files = FCnoF[]
dfree cache time (S)
This is a new parameter introduced in Samba version 3.0.21. It specifies in seconds the time that smbd will cache the output of a disk free query. If set to zero (the default) no caching is done. This allows a heavily loaded server to prevent rapid spawning of m[blue]dfree commandm[] scripts increasing the load.
By default this parameter is zero, meaning no caching will be done.
No default
Example: dfree cache time = FCdfree cache time = 60F[]
dfree command (S)
This setting allows the replacement of the internal routines to calculate the total disk space and amount available with an external routine. The example below gives a possible script that might fulfill this function.
In Samba version 3.0.21 this parameter has been changed to be a per-share parameter, and in addition the parameter m[blue]dfree cache timem[] was added to allow the output of this script to be cached for systems under heavy load.
The external program will be passed a single parameter indicating a directory in the filesystem being queried. This will typically consist of the string FC./F[]. The script should return two integers in ASCII. The first should be the total disk space in blocks, and the second should be the number of available blocks. An optional third return value can give the block size in bytes. The default blocksize is 1024 bytes.
Note: Your script should NOT be setuid or setgid and should be owned by (and writeable only by) root!
Where the script dfree (which must be made executable) could be:
#!/bin/sh
df $1 | tail -1 | awk '{print $(NF-4),$(NF-2)}'
or perhaps (on Sys V based systems):
#!/bin/sh
/usr/bin/df -k $1 | tail -1 | awk '{print $3" "$5}'
Note that you may have to replace the command names with full path names on some systems.
By default internal routines for determining the disk capacity and remaining space will be used.
No default
Example: dfree command = FC/usr/local/samba/bin/dfreeF[]
directory mode
directory mask (S)
When a directory is created, the necessary permissions are calculated according to the mapping from DOS modes to UNIX permissions, and the resulting UNIX mode is then bit-wise 'AND'ed with this parameter. This parameter may be thought of as a bit-wise MASK for the UNIX modes of a directory. Any bit not set here will be removed from the modes set on a directory when it is created.
The default value of this parameter removes the 'group' and 'other' write bits from the UNIX mode, allowing only the user who owns the directory to modify it.
Following this Samba will bit-wise 'OR' the UNIX mode created from this parameter with the value of the m[blue]force directory modem[] parameter. This parameter is set to 000 by default (i.e. no extra mode bits are added).
Note that this parameter does not apply to permissions set by Windows NT/2000 ACL editors. If the administrator wishes to enforce a mask on access control lists also, they need to set the m[blue]directory security maskm[].
Default: directory mask = FC0755F[]
Example: directory mask = FC0775F[]
directory security mask (S)
This parameter is applied as a mask (AND'ed with) to the incoming permission bits, thus resetting any bits not in this mask. Make sure not to mix up this parameter with m[blue]force directory security modem[], which works similar like this one but uses logical OR instead of AND. Essentially, zero bits in this mask are a set of bits that will always be set to zero.
Essentially, all bits set to zero in this mask will result in setting to zero the corresponding bits on the file permissions regardless of the previous status of this bits on the file.
If not set explicitly this parameter is set to 0777 meaning a user is allowed to set all the user/group/world permissions on a directory.
Note that users who can access the Samba server through other means can easily bypass this restriction, so it is primarily useful for standalone "appliance" systems. Administrators of most normal systems will probably want to leave it as the default of 0777.
Default: directory security mask = FC0777F[]
Example: directory security mask = FC0700F[]
disable netbios (G)
disable spoolss (G)
Default: disable spoolss = FCnoF[]
display charset (G)
Default: display charset = FC"LOCALE" or "ASCII" (depending on the system)F[]
Example: display charset = FCUTF8F[]
dmapi support (S)
Note that Samba infers the status of a file by examining the events that a DMAPI application has registered interest in. This heuristic is satisfactory for a number of hierarchical storage systems, but there may be system for which it will fail. In this case, Samba may erroneously report files to be offline.
This parameter is only available if a supported DMAPI implementation was found at compilation time. It will only be used if DMAPI is found to enabled on the system at run time.
Default: dmapi support = FCnoF[]
dns proxy (G)
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.
FCnmbdF[] spawns a second copy of itself to do the DNS name lookup requests, as doing a name lookup is a blocking action.
Default: dns proxy = FCyesF[]
domain logons (G)
Default: domain logons = FCnoF[]
domain master (G)
Note that Windows NT Primary Domain Controllers expect to be able to claim this m[blue]workgroupm[] specific special NetBIOS name that identifies them as domain master browsers for that m[blue]workgroupm[] 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 FCnmbdF[] claims the special name for a m[blue]workgroupm[] before a Windows NT PDC is able to do so then cross subnet browsing will behave strangely and may fail.
If m[blue]domain logons = yesm[], then the default behavior is to enable the m[blue]domain masterm[] parameter. If m[blue]domain logonsm[] is not enabled (the default setting), then neither will m[blue]domain masterm[] be enabled by default.
When m[blue]domain logons = Yesm[] the default setting for this parameter is Yes, with the result that Samba will be a PDC. If m[blue]domain master = Nom[], Samba will function as a BDC. In general, this parameter should be set to 'No' only on a BDC.
Default: domain master = FCautoF[]
dont descend (S)
Note that Samba can be very fussy about the exact format of the "dont descend" entries. For example you may need FC ./procF[] instead of just FC/procF[]. Experimentation is the best policy :-)
Default: dont descend = FCF[]
Example: dont descend = FC/proc,/devF[]
dos charset (G)
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.
No default
dos filemode (S)
Default: dos filemode = FCnoF[]
dos filetime resolution (S)
This option is mainly used as a compatibility option for Visual C++ when used against Samba shares. If oplocks are enabled on a share, Visual C++ uses two different time reading calls to check if a file has changed since it was last read. One of these calls uses a one-second granularity, the other uses a two second granularity. As the two second call rounds any odd second down, then if the file has a timestamp of an odd number of seconds then the two timestamps will not match and Visual C++ will keep reporting the file has changed. Setting this option causes the two timestamps to match, and Visual C++ is happy.
Default: dos filetime resolution = FCnoF[]
dos filetimes (S)
Default: dos filetimes = FCyesF[]
ea support (S)
Default: ea support = FCnoF[]
enable asu support (G)
Default: enable asu support = FCnoF[]
enable privileges (G)
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.
Default: enable privileges = FCyesF[]
encrypt passwords (G)
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 m[blue]security = [server|domain|ads]m[] parameter which causes FCsmbdF[] to authenticate against another server.
Default: encrypt passwords = FCyesF[]
enhanced browsing (G)
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.
Default: enhanced browsing = FCyesF[]
enumports command (G)
Default: enumports command = FCF[]
Example: enumports command = FC/usr/bin/listportsF[]
eventlog list (G)
The administrator must use an external process to parse the normal Unix logs such as FC/var/log/messagesF[] and write then entries to the eventlog tdb files. Refer to the eventlogadm(8) utility for how to write eventlog entries.
Default: eventlog list = FCF[]
Example: eventlog list = FCSecurity Application Syslog ApacheF[]
fake directory create times (S)
This option is mainly used as a compatibility option for Visual C++ when used against Samba shares. Visual C++ generated makefiles have the object directory as a dependency for each object file, and a make rule to create the directory. Also, when NMAKE compares timestamps it uses the creation time when examining a directory. Thus the object directory will be created if it does not exist, but once it does exist it will always have an earlier timestamp than the object files it contains.
However, Unix time semantics mean that the create time reported by Samba will be updated whenever a file is created or or deleted in the directory. NMAKE finds all object files in the object directory. The timestamp of the last one built is then compared to the timestamp of the object directory. If the directory's timestamp if newer, then all object files will be rebuilt. Enabling this option ensures directories always predate their contents and an NMAKE build will proceed as expected.
Default: fake directory create times = FCnoF[]
fake oplocks (S)
When you set FCfake oplocks = yesF[], smbd(8) will always grant oplock requests no matter how many clients are using the file.
It is generally much better to use the real m[blue]oplocksm[] support rather than this parameter.
If you enable this option on all read-only shares or shares that you know will only be accessed from one client at a time such as physically read-only media like CDROMs, you will see a big performance improvement on many operations. If you enable this option on shares where multiple clients may be accessing the files read-write at the same time you can get data corruption. Use this option carefully!
Default: fake oplocks = FCnoF[]
follow symlinks (S)
This option is enabled (i.e. FCsmbdF[] will follow symbolic links) by default.
Default: follow symlinks = FCyesF[]
force create mode (S)
The example below would force all newly created files to have read and execute permissions set for 'group' and 'other' as well as the read/write/execute bits set for the 'user'.
Default: force create mode = FC000F[]
Example: force create mode = FC0755F[]
force directory mode (S)
The example below would force all created directories to have read and execute permissions set for 'group' and 'other' as well as the read/write/execute bits set for the 'user'.
Default: force directory mode = FC000F[]
Example: force directory mode = FC0755F[]
force directory security mode (S)
This parameter is applied as a mask (OR'ed with) to the changed permission bits, thus forcing any bits in this mask that the user may have modified to be on. Make sure not to mix up this parameter with m[blue]directory security maskm[], which works in a similar manner to this one, but uses a logical AND instead of an OR.
Essentially, this mask may be treated as a set of bits that, when modifying security on a directory, to will enable (1) any flags that are off (0) but which the mask has set to on (1).
If not set explicitly this parameter is 0000, which allows a user to modify all the user/group/world permissions on a directory without restrictions.
Example: force directory security mode = FC700F[]
group
force group (S)
In Samba 2.0.5 and above this parameter has extended functionality in the following way. If the group name listed here has a '+' character prepended to it then the current user accessing the share only has the primary group default assigned to this group if they are already assigned as a member of that group. This allows an administrator to decide that only users who are already in a particular group will create files with group ownership set to that group. This gives a finer granularity of ownership assignment. For example, the setting FCforce group = +sysF[] means that only users who are already in group sys will have their default primary group assigned to sys when accessing this Samba share. All other users will retain their ordinary primary group.
If the m[blue]force userm[] parameter is also set the group specified in force group will override the primary group set in force user.
Default: force group = FCF[]
Example: force group = FCagroupF[]
force printername (S)
When assigning a new driver to a printer on a remote Windows compatible print server such as Samba, the Windows client will rename the printer to match the driver name just uploaded. This can result in confusion for users when multiple printers are bound to the same driver. To prevent Samba from allowing the printer's printername to differ from the sharename defined in smb.conf, set force printername = yes.
Be aware that enabling this parameter may affect migrating printers from a Windows server to Samba since Windows has no way to force the sharename and printername to match.
It is recommended that this parameter's value not be changed once the printer is in use by clients as this could cause a user not be able to delete printer connections from their local Printers folder.
Default: force printername = FCnoF[]
force security mode (S)
This parameter is applied as a mask (OR'ed with) to the changed permission bits, thus forcing any bits in this mask that the user may have modified to be on. Make sure not to mix up this parameter with m[blue]security maskm[], which works similar like this one but uses logical AND instead of OR.
Essentially, one bits in this mask may be treated as a set of bits that, when modifying security on a file, the user has always set to be on.
If not set explicitly this parameter is set to 0, and allows a user to modify all the user/group/world permissions on a file, with no restrictions.
Note that users who can access the Samba server through other means can easily bypass this restriction, so it is primarily useful for standalone "appliance" systems. Administrators of most normal systems will probably want to leave this set to 0000.
Default: force security mode = FC0F[]
Example: force security mode = FC700F[]
force unknown acl user (S)
This is designed to allow Windows NT clients to copy files and folders containing ACLs that were created locally on the client machine and contain users local to that machine only (no domain users) to be copied to a Samba server (usually with XCOPY /O) and have the unknown userid and groupid of the file owner map to the current connected user. This can only be fixed correctly when winbindd allows arbitrary mapping from any Windows NT SID to a UNIX uid or gid.
Try using this parameter when XCOPY /O gives an ACCESS_DENIED error.
Default: force unknown acl user = FCnoF[]
force user (S)
This user name only gets used once a connection is established. Thus clients still need to connect as a valid user and supply a valid password. Once connected, all file operations will be performed as the "forced user", no matter what username the client connected as. This can be very useful.
In Samba 2.0.5 and above this parameter also causes the primary group of the forced user to be used as the primary group for all file activity. Prior to 2.0.5 the primary group was left as the primary group of the connecting user (this was a bug).
Default: force user = FCF[]
Example: force user = FCauserF[]
fstype (S)
Default: fstype = FCNTFSF[]
Example: fstype = FCSambaF[]
get quota command (G)
This option is only available you have compiled Samba with the FC--with-sys-quotasF[] option or on Linux with FC--with-quotasF[] and a working quota api was found in the system.
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 should take 3 arguments:
Example: get quota command = FC/usr/local/sbin/query_quotaF[]
getwd cache (G)
Default: getwd cache = FCyesF[]
guest account (G)
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 FCsu -F[] command) and trying to print using the system print command such as FClpr(1)F[] or FC lp(1)F[].
This parameter does not accept % macros, because many parts of the system require this value to be constant for correct operation.
Default: guest account = FCnobody # default can be changed at compile-timeF[]
Example: guest account = FCftpF[]
public
guest ok (S)
This paramater nullifies the benifits of setting m[blue]restrict anonymous = 2m[]
See the section below on m[blue]securitym[] for more information about this option.
Default: guest ok = FCnoF[]
only guest
guest only (S)
See the section below on m[blue]securitym[] for more information about this option.
Default: guest only = FCnoF[]
hide dot files (S)
Default: hide dot files = FCyesF[]
hide files (S)
Each entry in the list must be separated by a '/', which allows spaces to be included in the entry. '*' and '?' can be used to specify multiple files or directories as in DOS wildcards.
Each entry must be a Unix path, not a DOS path and must not include the Unix directory separator '/'.
Note that the case sensitivity option is applicable in hiding files.
Setting this parameter will affect the performance of Samba, as it will be forced to check all files and directories for a match as they are scanned.
The example shown above is based on files that the Macintosh SMB client (DAVE) available from Thursby creates for internal use, and also still hides all files beginning with a dot.
An example of us of this parameter is:
hide files = /.*/DesktopFolderDB/TrashFor%m/resource.frk/
Default: hide files = FC # no file are hiddenF[]
hide special files (S)
Default: hide special files = FCnoF[]
hide unreadable (S)
Default: hide unreadable = FCnoF[]
hide unwriteable files (S)
Default: hide unwriteable files = FCnoF[]
homedir map (G)
FCusername server:/some/file/systemF[]
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.
Example: homedir map = FCamd.homedirF[]
host msdfs (G)
See also the m[blue]msdfs rootm[] share level parameter. For more information on setting up a Dfs tree on Samba, refer to the MSFDS chapter in the book Samba3-HOWTO.
Default: host msdfs = FCyesF[]
hostname lookups (G)
Default: hostname lookups = FCnoF[]
Example: hostname lookups = FCyesF[]
allow hosts
hosts allow (S)
This parameter is a comma, space, or tab delimited set of hosts which are permitted to access a service.
If specified in the [global] section then it will apply to all services, regardless of whether the individual service has a different setting.
You can specify the hosts by name or IP number. For example, you could restrict access to only the hosts on a Class C subnet with something like FCallow hosts = 150.203.5.F[]. The full syntax of the list is described in the man page FChosts_access(5)F[]. Note that this man page may not be present on your system, so a brief description will be given here also.
Note that the localhost address 127.0.0.1 will always be allowed access unless specifically denied by a m[blue]hosts denym[] option.
You can also specify hosts by network/netmask pairs and by netgroup names if your system supports netgroups. The EXCEPT keyword can also be used to limit a wildcard list. The following examples may provide some help:
Example 1: allow all IPs in 150.203.*.*; except one
FChosts allow = 150.203. EXCEPT 150.203.6.66F[]
Example 2: allow hosts that match the given network/netmask
FChosts allow = 150.203.15.0/255.255.255.0F[]
Example 3: allow a couple of hosts
FChosts allow = lapland, arvidsjaurF[]
Example 4: allow only hosts in NIS netgroup "foonet", but deny access from one particular host
FChosts allow = @foonetF[]
FChosts deny = pirateF[]
Default: hosts allow = FC # none (i.e., all hosts permitted access)F[]
Example: hosts allow = FC150.203.5. myhost.mynet.edu.auF[]
deny hosts
hosts deny (S)
In the event that it is necessary to deny all by default, use the keyword ALL (or the netmask FC0.0.0.0/0F[]) and then explicitly specify to the m[blue]hosts allow = hosts allowm[] parameter those hosts that should be permitted access.
Default: hosts deny = FC # none (i.e., no hosts specifically excluded)F[]
Example: hosts deny = FC150.203.4. badhost.mynet.edu.auF[]
idmap alloc backend (G)
This parameter defaults to the value m[blue]idmap backendm[] was set to, so by default winbind will allocate Unix IDs from the default backend. You will only need to set this parameter explicitly if you have an external source for Unix IDs, like a central database service somewhere in your company.
Also refer to the m[blue]idmap alloc configm[] option.
No default
Example: idmap alloc backend = FCtdbF[]
idmap alloc config (G)
No default
idmap backend (G)
This option specifies the default backend that is used when no special configuration set by m[blue]idmap configm[] matches the specific request.
This default backend also specifies the place where winbind-generated idmap entries will be stored. So it is highly recommended that you specify a writable backend like idmap_tdb(8) or idmap_ldap(8) as the idmap backend. The idmap_rid(8) and idmap_ad(8) backends are not writable and thus will generate unexpected results if set as idmap backend.
To use the rid and ad backends, please specify them via the m[blue]idmap configm[] parameter, possibly also for the domain your machine is member of, specified by m[blue]workgroupm[].
Examples of SID/uid/gid backends include tdb (idmap_tdb(8)), ldap (idmap_ldap(8)), rid (idmap_rid(8)), and ad (idmap_ad(8)).
Default: idmap backend = FCtdbF[]
idmap cache time (G)
Default: idmap cache time = FC604800 (one week)F[]
idmap config (G)
backend = backend_name
range = low - high
winbind uses this parameter to find the backend that is authoritative for a unix ID to SID mapping, so it must be set for each individually configured domain, and it must be disjoint from the ranges set via m[blue]idmap uidm[] and m[blue]idmap gidm[].
The following example illustrates how to configure the idmap_ad(8) for the CORP domain and the idmap_tdb(8) backend for all other domains. This configuration assumes that the admin of CORP assigns unix ids below 1000000 via the SFU extensions, and winbind is supposed to use the next million entries for its own mappings from trusted domains and for local groups for example.
idmap backend = tdb
idmap uid = 1000000-1999999
idmap gid = 1000000-1999999
idmap config CORP : backend = ad
idmap config CORP : range = 1000-999999
No default
winbind gid
idmap gid (G)
See also the m[blue]idmap backendm[], and m[blue]idmap configm[] options.
Default: idmap gid = FCF[]
Example: idmap gid = FC10000-20000F[]
idmap negative cache time (G)
Default: idmap negative cache time = FC120F[]
winbind uid
idmap uid (G)
See also the m[blue]idmap backendm[] and m[blue]idmap configm[] options.
Default: idmap uid = FCF[]
Example: idmap uid = FC10000-20000F[]
include (G)
It takes the standard substitutions, except %u, %P and %S.
The parameter include = registry has a special meaning: It does not include a file named registry from the current working directory, but instead reads the global configuration options from the registry. See the section on registry-based configuration for details. Note that this option automatically activates registry shares.
Default: include = FCF[]
Example: include = FC/usr/local/samba/lib/admin_smb.confF[]
inherit acls (S)
Default: inherit acls = FCnoF[]
inherit owner (S)
Common scenarios where this behavior is useful is in implementing drop-boxes where users can create and edit files but not delete them and to ensure that newly create files in a user's roaming profile directory are actually owner by the user.
Default: inherit owner = FCnoF[]
inherit permissions (S)
New directories inherit the mode of the parent directory, including bits such as setgid.
New files inherit their read/write bits from the parent directory. Their execute bits continue to be determined by m[blue]map archivem[], m[blue]map hiddenm[] and m[blue]map systemm[] as usual.
Note that the setuid bit is never set via inheritance (the code explicitly prohibits this).
This can be particularly useful on large systems with many users, perhaps several thousand, to allow a single [homes] share to be used flexibly by each user.
Default: inherit permissions = FCnoF[]
init logon delayed hosts (G)
The length of the delay can be specified with the m[blue]init logon delaym[] parameter.
Default: init logon delayed hosts = FCF[]
Example: init logon delayed hosts = FC150.203.5. myhost.mynet.deF[]
init logon delay (G)
Default: init logon delay = FC100F[]
interfaces (G)
The option takes a list of interface strings. Each string can be in any of the following forms:
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).
The 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.
Default: interfaces = FCF[]
Example: interfaces = FCeth0 192.168.2.10/24 192.168.3.10/255.255.255.0F[]
invalid users (S)
A name starting with a '@' is interpreted as an NIS netgroup first (if your system supports NIS), and then as a UNIX group if the name was not found in the NIS netgroup database.
A name starting with '+' is interpreted only by looking in the UNIX group database via the NSS getgrnam() interface. A name starting with '&' is interpreted only by looking in the NIS netgroup database (this requires NIS to be working on your system). The characters '+' and '&' may be used at the start of the name in either order so the value +&group means check the UNIX group database, followed by the NIS netgroup database, and the value &+group means check the NIS netgroup database, followed by the UNIX group database (the same as the '@' prefix).
The current servicename is substituted for %S. This is useful in the [homes] section.
Default: invalid users = FC # no invalid usersF[]
Example: invalid users = FCroot fred admin @wheelF[]
iprint server (G)
If set, this option overrides the ServerName option in the CUPS FCclient.confF[]. This is necessary if you have virtual samba servers that connect to different CUPS daemons.
Default: iprint server = FC""F[]
Example: iprint server = FCMYCUPSSERVERF[]
keepalive (G)
Keepalives should, in general, not be needed if the socket has the SO_KEEPALIVE attribute set on it by default. (see m[blue]socket optionsm[]). Basically you should only use this option if you strike difficulties.
Default: keepalive = FC300F[]
Example: keepalive = FC600F[]
kerberos method (G)
Valid options are:
When the kerberos method is in "dedicated keytab" mode, m[blue]dedicated keytab filem[] must be set to specify the location of the keytab file.
Default: kerberos method = FCsecrets onlyF[]
kernel change notify (S)
This parameter is only used when your kernel supports change notification to user programs using the inotify interface.
Default: kernel change notify = FCyesF[]
kernel oplocks (G)
Kernel oplocks support allows Samba oplocks to be broken whenever a local UNIX process or NFS operation accesses a file that smbd(8) has oplocked. This allows complete data consistency between SMB/CIFS, NFS and local file access (and is a very cool feature :-).
This parameter defaults to on, but is translated to a no-op on systems that no not have the necessary kernel support. You should never need to touch this parameter.
Default: kernel oplocks = FCyesF[]
lanman auth (G)
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.
Unlike the FCencrypt passwordsF[] option, this parameter cannot alter client behaviour, and the LANMAN response will still be sent over the network. See the FCclient lanman authF[] to disable this for Samba's clients (such as smbclient)
If this option, and FCntlm authF[] are both disabled, then only NTLMv2 logins will be permited. Not all clients support NTLMv2, and most will require special configuration to use it.
Default: lanman auth = FCnoF[]
large readwrite (G)
Default: large readwrite = FCyesF[]
ldap admin dn (G)
The m[blue]ldap admin dnm[] requires a fully specified DN. The m[blue]ldap suffixm[] is not appended to the m[blue]ldap admin dnm[].
No default
ldap connection timeout (G)
This parameter is different from m[blue]ldap timeoutm[] which affects operations on LDAP servers using an existing connection and not establishing an initial connection.
Default: ldap connection timeout = FC2F[]
ldap debug level (G)
The debug ouput 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.
Default: ldap debug level = FC0F[]
Example: ldap debug level = FC1F[]
ldap debug threshold (G)
Default: ldap debug threshold = FC10F[]
Example: ldap debug threshold = FC5F[]
ldap delete dn (G)
Default: ldap delete dn = FCnoF[]
ldap group suffix (G)
Default: ldap group suffix = FCF[]
Example: ldap group suffix = FCou=GroupsF[]
ldap idmap suffix (G)
Default: ldap idmap suffix = FCF[]
Example: ldap idmap suffix = FCou=IdmapF[]
ldap machine suffix (G)
Default: ldap machine suffix = FCF[]
Example: ldap machine suffix = FCou=ComputersF[]
ldap passwd sync (G)
The m[blue]ldap passwd syncm[] can be set to one of three values:
ldap replication sleep (G)
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).
Default: ldap replication sleep = FC1000F[]
ldapsam:editposix (G)
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 FCnet sam provisionF[]. To run this command the ldap server must be running, Winindd must be running and the smb.conf ldap options must be properly configured. The typical ldap setup used with the m[blue]ldapsam:trusted = yesm[] option is usually sufficient to use m[blue]ldapsam:editposix = yesm[] 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
Default: ldapsam:editposix = FCnoF[]
ldapsam:trusted (G)
To make Samba scale well in large environments, the m[blue]ldapsam:trusted = yesm[] 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, m[blue]ldapsam:trusted = yesm[] 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.
Default: ldapsam:trusted = FCnoF[]
ldap ssl ads (G)
See smb.conf(5) for more information on m[blue]ldap sslm[].
Default: ldap ssl ads = FCnoF[]
ldap ssl (G)
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 m[blue]passdb backendm[].
The m[blue]ldap sslm[] can be set to one of two values:
Default: ldap ssl = FCstart tlsF[]
ldap suffix (G)
The ldap suffix will be appended to the values specified for the m[blue]ldap user suffixm[], m[blue]ldap group suffixm[], m[blue]ldap machine suffixm[], and the m[blue]ldap idmap suffixm[]. Each of these should be given only a DN relative to the m[blue]ldap suffixm[].
Default: ldap suffix = FCF[]
Example: ldap suffix = FCdc=samba,dc=orgF[]
ldap timeout (G)
Default: ldap timeout = FC15F[]
ldap user suffix (G)
Default: ldap user suffix = FCF[]
Example: ldap user suffix = FCou=peopleF[]
level2 oplocks (S)
Level2, or read-only oplocks allow Windows NT clients that have an oplock on a file to downgrade from a read-write oplock to a read-only oplock once a second client opens the file (instead of releasing all oplocks on a second open, as in traditional, exclusive oplocks). This allows all openers of the file that support level2 oplocks to cache the file for read-ahead only (ie. they may not cache writes or lock requests) and increases performance for many accesses of files that are not commonly written (such as application .EXE files).
Once one of the clients which have a read-only oplock writes to the file all clients are notified (no reply is needed or waited for) and told to break their oplocks to "none" and delete any read-ahead caches.
It is recommended that this parameter be turned on to speed access to shared executables.
For more discussions on level2 oplocks see the CIFS spec.
Currently, if m[blue]kernel oplocksm[] are supported then level2 oplocks are not granted (even if this parameter is set to yes). Note also, the m[blue]oplocksm[] parameter must be set to yes on this share in order for this parameter to have any effect.
Default: level2 oplocks = FCyesF[]
lm announce (G)
Default: lm announce = FCautoF[]
Example: lm announce = FCyesF[]
lm interval (G)
Default: lm interval = FC60F[]
Example: lm interval = FC120F[]
load printers (G)
Default: load printers = FCyesF[]
local master (G)
Setting this value to no will cause FCnmbdF[] never to become a local master browser.
Default: local master = FCyesF[]
lock dir
lock directory (G)
Note: This option can not be set inside registry configurations.
Default: lock directory = FC${prefix}/var/locksF[]
Example: lock directory = FC/var/run/samba/locksF[]
locking (S)
If FClocking = noF[], all lock and unlock requests will appear to succeed and all lock queries will report that the file in question is available for locking.
If FClocking = yesF[], real locking will be performed by the server.
This option may be useful for read-only filesystems which may not need locking (such as CDROM drives), although setting this parameter of no is not really recommended even in this case.
Be careful about disabling locking either globally or in a specific service, as lack of locking may result in data corruption. You should never need to set this parameter.
No default
lock spin count (G)
Default: lock spin count = FC0F[]
lock spin time (G)
Default: lock spin time = FC200F[]
log file (G)
This option takes the standard substitutions, allowing you to have separate log files for each user or machine.
No default
Example: log file = FC/usr/local/samba/var/log.%mF[]
debuglevel
log level (G)
This parameter has been extended since the 2.2.x series, now it allows to specify the debug level for multiple debug classes. This is to give greater flexibility in the configuration of the system. The following debug classes are currently implemented:
Example: log level = FC3 passdb:5 auth:10 winbind:2F[]
logon drive (G)
Note that this option is only useful if Samba is set up as a logon server.
Default: logon drive = FCF[]
Example: logon drive = FCh:F[]
logon home (G)
FCC:\>F[]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:
FClogon home = \\%N\%U\profileF[]
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 FCnet use /homeF[] but use the whole string when dealing with profiles.
Note that in prior versions of Samba, the m[blue]logon pathm[] was returned rather than logon home. This broke FCnet use /homeF[] 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 m[blue]logon home = ""m[] - using the empty string.
This option is only useful if Samba is set up as a logon server.
Default: logon home = FC\\%N\%UF[]
Example: logon home = FC\\remote_smb_server\%UF[]
logon path (G)
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", FCdesktopF[], FCstart menuF[], FCnetwork neighborhoodF[], FCprogramsF[] 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.
Disable the use of roaming profiles by setting the value of this parameter to the empty string. For example, m[blue]logon path = ""m[]. 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
Default: logon path = FC\\%N\%U\profileF[]
logon script (G)
The script must be a relative path to the [netlogon] service. If the [netlogon] service specifies a m[blue]pathm[] of FC/usr/local/samba/netlogonF[], and m[blue]logon script = STARTUP.BATm[], 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 FCNET TIME \\SERVER /SET /YESF[], to force every machine to synchronize clocks with the same time server. Another use would be to add FCNET USE U: \\SERVER\UTILSF[] 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.
Default: logon script = FCF[]
Example: logon script = FCscripts\%U.batF[]
lppause command (S)
This command should be a program or script which takes a printer name and job number to pause the print job. One way of implementing this is by using job priorities, where jobs having a too low priority won't be sent to the printer.
If a %p is given then the printer name is put in its place. A %j is replaced with the job number (an integer). On HPUX (see printing=hpux ), if the -p%p option is added to the lpq command, the job will show up with the correct status, i.e. if the job priority is lower than the set fence priority it will have the PAUSED status, whereas if the priority is equal or higher it will have the SPOOLED or PRINTING status.
Note that it is good practice to include the absolute path in the lppause command as the PATH may not be available to the server.
Default: lppause command = FC # Currently no default value is given to this string, unless the value of the m[blue]printingm[] parameter is SYSV, in which case the default is : FClp -i %p-%j -H holdF[] or if the value of the printing parameter is SOFTQ, then the default is: FCqstat -s -j%j -hF[]. F[]
Example: lppause command = FC/usr/bin/lpalt %p-%j -p0F[]
lpq cache time (G)
The cache files are stored in FC/tmp/lpq.xxxxF[] where xxxx is a hash of the FClpqF[] command in use.
The default is 30 seconds, meaning that the cached results of a previous identical FClpqF[] command will be used if the cached data is less than 30 seconds old. A large value may be advisable if your FClpqF[] command is very slow.
A value of 0 will disable caching completely.
Default: lpq cache time = FC30F[]
Example: lpq cache time = FC10F[]
lpq command (S)
This command should be a program or script which takes a printer name as its only parameter and outputs printer status information.
Currently nine styles of printer status information are supported; BSD, AIX, LPRNG, PLP, SYSV, HPUX, QNX, CUPS, and SOFTQ. This covers most UNIX systems. You control which type is expected using the printing = option.
Some clients (notably Windows for Workgroups) may not correctly send the connection number for the printer they are requesting status information about. To get around this, the server reports on the first printer service connected to by the client. This only happens if the connection number sent is invalid.
If a %p is given then the printer name is put in its place. Otherwise it is placed at the end of the command.
Note that it is good practice to include the absolute path in the lpq command as the $PATH may not be available to the server. When compiled with the CUPS libraries, no lpq command is needed because smbd will make a library call to obtain the print queue listing.
Default: lpq command = FCF[]
Example: lpq command = FC/usr/bin/lpq -P%pF[]
lpresume command (S)
This command should be a program or script which takes a printer name and job number to resume the print job. See also the m[blue]lppause commandm[] parameter.
If a %p is given then the printer name is put in its place. A %j is replaced with the job number (an integer).
Note that it is good practice to include the absolute path in the lpresume command as the PATH may not be available to the server.
See also the m[blue]printingm[] parameter.
Default: Currently no default value is given to this string, unless the value of the printing parameter is SYSV, in which case the default is:
FClp -i %p-%j -H resumeF[]
or if the value of the printing parameter is SOFTQ, then the default is:
FCqstat -s -j%j -rF[]
No default
Example: lpresume command = FC/usr/bin/lpalt %p-%j -p2F[]
lprm command (S)
This command should be a program or script which takes a printer name and job number, and deletes the print job.
If a %p is given then the printer name is put in its place. A %j is replaced with the job number (an integer).
Note that it is good practice to include the absolute path in the lprm command as the PATH may not be available to the server.
Examples of use are:
lprm command = /usr/bin/lprm -P%p %j or lprm command = /usr/bin/cancel %p-%j
Default: lprm command = FC determined by printing parameterF[]
machine password timeout (G)
See also smbpasswd(8), and the m[blue]security = domainm[] parameter.
Default: machine password timeout = FC604800F[]
magic output (S)
Example: magic output = FCmyfile.txtF[]
magic script (S)
Scripts executed in this way will be deleted upon completion assuming that the user has the appropriate level of privilege and the file permissions allow the deletion.
If the script generates output, output will be sent to the file specified by the m[blue]magic outputm[] parameter (see above).
Note that some shells are unable to interpret scripts containing CR/LF instead of CR as the end-of-line marker. Magic scripts must be executable as is on the host, which for some hosts and some shells will require filtering at the DOS end.
Magic scripts are EXPERIMENTAL and should NOT be relied upon.
Default: magic script = FCF[]
Example: magic script = FCuser.cshF[]
mangled names (S)
See the section on m[blue]name manglingm[] for details on how to control the mangling process.
If mangling is used then the mangling algorithm is as follows:
Note that the character to use may be specified using the m[blue]mangling charm[] option, if you don't like '~'.
This algorithm can cause name collisions only if files in a directory share the same first five alphanumeric characters. The probability of such a clash is 1/1300.
The name mangling (if enabled) allows a file to be copied between UNIX directories from Windows/DOS while retaining the long UNIX filename. UNIX files can be renamed to a new extension from Windows/DOS and will retain the same basename. Mangled names do not change between sessions.
Default: mangled names = FCyesF[]
mangle prefix (G)
mangle prefix is effective only when mangling method is hash2.
Default: mangle prefix = FC1F[]
Example: mangle prefix = FC4F[]
mangling char (S)
Default: mangling char = FC~F[]
Example: mangling char = FC^F[]
mangling method (G)
Default: mangling method = FChash2F[]
Example: mangling method = FChashF[]
map acl inherit (S)
Default: map acl inherit = FCnoF[]
map archive (S)
Note that this requires the m[blue]create maskm[] parameter to be set such that owner execute bit is not masked out (i.e. it must include 100). See the parameter m[blue]create maskm[] for details.
Default: map archive = FCyesF[]
map hidden (S)
Note that this requires the m[blue]create maskm[] to be set such that the world execute bit is not masked out (i.e. it must include 001). See the parameter m[blue]create maskm[] for details.
No default
map read only (S)
This parameter can take three different values, which tell smbd(8) how to display the read only attribute on files, where either m[blue]store dos attributesm[] is set to No, or no extended attribute is present. If m[blue]store dos attributesm[] is set to yes then this parameter is ignored. This is a new parameter introduced in Samba version 3.0.21.
The three settings are :
Yes - The read only DOS attribute is mapped to the inverse of the user or owner write bit in the unix permission mode set. If the owner write bit is not set, the read only attribute is reported as being set on the file. If the read only DOS attribute is set, Samba sets the owner, group and others write bits to zero. Write bits set in an ACL are ignored by Samba. If the read only DOS attribute is unset, Samba simply sets the write bit of the owner to one.
Permissions - The read only DOS attribute is mapped to the effective permissions of the connecting user, as evaluated by smbd(8) by reading the unix permissions and POSIX ACL (if present). If the connecting user does not have permission to modify the file, the read only attribute is reported as being set on the file.
No - The read only DOS attribute is unaffected by permissions, and can only be set by the m[blue]store dos attributesm[] method. This may be useful for exporting mounted CDs.
map system (S)
Note that this requires the m[blue]create maskm[] to be set such that the group execute bit is not masked out (i.e. it must include 010). See the parameter m[blue]create maskm[] for details.
Default: map system = FCnoF[]
map to guest (G)
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 :
For people familiar with the older Samba releases, this parameter maps to the old compile-time setting of the GUEST_SESSSETUP value in local.h.
Default: map to guest = FCNeverF[]
Example: map to guest = FCBad UserF[]
map untrusted to domain (G)
In previous versions of Samba (pre 3.4), if smbd was acting as a domain member server, the BOGUS domain name would instead be replaced by the primary domain which smbd was a member of. In this case authentication would be deferred off to a DC using the credentials DOMAIN\user.
When this parameter is set to yes smbd provides the legacy behavior of mapping untrusted domain names to the primary domain. When smbd is not acting as a domain member server, this parameter has no effect.
Default: map untrusted to domain = FCnoF[]
max connections (S)
Record lock files are used to implement this feature. The lock files will be stored in the directory specified by the m[blue]lock directorym[] option.
Default: max connections = FC0F[]
Example: max connections = FC10F[]
max disk size (G)
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.
Default: max disk size = FC0F[]
Example: max disk size = FC1000F[]
max log size (G)
A size of 0 means no limit.
Default: max log size = FC5000F[]
Example: max log size = FC1000F[]
max mux (G)
Default: max mux = FC50F[]
max open files (G)
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.
Default: max open files = FC10000F[]
max print jobs (S)
Default: max print jobs = FC1000F[]
Example: max print jobs = FC5000F[]
protocol
max protocol (G)
Possible values are :
Default: max protocol = FCNT1F[]
Example: max protocol = FCLANMAN1F[]
max reported print jobs (S)
Default: max reported print jobs = FC0F[]
Example: max reported print jobs = FC1000F[]
max smbd processes (G)
Default: max smbd processes = FC0F[]
Example: max smbd processes = FC1000F[]
max stat cache size (G)
Default: max stat cache size = FC256F[]
Example: max stat cache size = FC100F[]
max ttl (G)
Default: max ttl = FC259200F[]
max wins ttl (G)
Default: max wins ttl = FC518400F[]
max xmit (G)
Default: max xmit = FC16644F[]
Example: max xmit = FC8192F[]
message command (G)
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:
FCmessage command = csh -c 'xedit %s;rm %s' &F[]
This delivers the message using FCxeditF[], 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:
Here's a way of sending the messages as mail to root:
FCmessage command = /bin/mail -s 'message from %f on %m' root < %s; rm %sF[]
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:
FCmessage command = rm %sF[]
Default: message command = FCF[]
Example: message command = FCcsh -c 'xedit %s; rm %s' &F[]
min print space (S)
Default: min print space = FC0F[]
Example: min print space = FC2000F[]
min protocol (G)
If you are viewing this parameter as a security measure, you should also refer to the m[blue]lanman authm[] parameter. Otherwise, you should never need to change this parameter.
Default: min protocol = FCCOREF[]
Example: min protocol = FCNT1F[]
min receivefile size (G)
Note this option will have NO EFFECT if set on a SMB signed connection.
The default is zero, which diables this option.
Default: min receivefile size = FC0F[]
min wins ttl (G)
Default: min wins ttl = FC21600F[]
msdfs proxy (S)
Only Dfs roots can act as proxy shares. Take a look at the m[blue]msdfs rootm[] and m[blue]host msdfsm[] options to find out how to set up a Dfs root share.
No default
Example: msdfs proxy = FC\otherserver\someshareF[]
msdfs root (S)
Default: msdfs root = FCnoF[]
name cache timeout (G)
Default: name cache timeout = FC660F[]
Example: name cache timeout = FC0F[]
name resolve order (G)
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 FC/etc/hosts F[], 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 FC/etc/nsswitch.confF[] 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.
When Samba is functioning in ADS security mode (FCsecurity = adsF[]) it is advised to use following settings for name resolve order:
FCname resolve order = wins bcastF[]
DC lookups will still be done via DNS, but fallbacks to netbios names will not inundate your DNS servers with needless querys for DOMAIN<0x1c> lookups.
Default: name resolve order = FClmhosts host wins bcastF[]
Example: name resolve order = FClmhosts bcast hostF[]
netbios aliases (G)
Default: netbios aliases = FC # empty string (no additional names)F[]
Example: netbios aliases = FCTEST TEST1 TEST2F[]
netbios name (G)
There is a bug in Samba-3 that breaks operation of browsing and access to shares if the netbios name is set to the literal name FCPIPEF[]. To avoid this problem, do not name your Samba-3 server FCPIPEF[].
Default: netbios name = FC # machine DNS nameF[]
Example: netbios name = FCMYNAMEF[]
netbios scope (G)
Default: netbios scope = FCF[]
nis homedir (G)
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 m[blue]homedir mapm[] 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.
Default: nis homedir = FCnoF[]
nt acl support (S)
Default: nt acl support = FCyesF[]
ntlm auth (G)
If this option, and FClanman authF[] are both disabled, then only NTLMv2 logins will be permited. Not all clients support NTLMv2, and most will require special configuration to use it.
Default: ntlm auth = FCyesF[]
nt pipe support (G)
Default: nt pipe support = FCyesF[]
nt status support (G)
You should not need to ever disable this parameter.
Default: nt status support = FCyesF[]
null passwords (G)
See also smbpasswd(5).
Default: null passwords = FCnoF[]
obey pam restrictions (G)
Default: obey pam restrictions = FCnoF[]
only user (S)
Note that this also means Samba won't try to deduce usernames from the service name. This can be annoying for the [homes] section. To get around this you could use FCuser = %SF[] which means your user list will be just the service name, which for home directories is the name of the user.
Default: only user = FCnoF[]
oplock break wait time (G)
oplock contention limit (S)
In brief it specifies a number, which causes smbd(8)not to grant an oplock even when requested if the approximate number of clients contending for an oplock on the same file goes over this limit. This causes FCsmbdF[] to behave in a similar way to Windows NT.
oplocks (S)
Oplocks may be selectively turned off on certain files with a share. See the m[blue]veto oplock filesm[] parameter. On some systems oplocks are recognized by the underlying operating system. This allows data synchronization between all access to oplocked files, whether it be via Samba or NFS or a local UNIX process. See the m[blue]kernel oplocksm[] parameter for details.
Default: oplocks = FCyesF[]
os2 driver map (G)
<nt driver name> = <os2 driver name>.<device name>
For example, a valid entry using the HP LaserJet 5 printer driver would appear as FCHP LaserJet 5L = LASERJET.HP LaserJet 5LF[].
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.
Default: os2 driver map = FCF[]
os level (G)
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!
Default: os level = FC20F[]
Example: os level = FC65F[]
pam password change (G)
Default: pam password change = FCnoF[]
panic action (G)
Default: panic action = FCF[]
Example: panic action = FC"/bin/sleep 90000"F[]
paranoid server security (G)
Disabling this option prevents Samba from making this check, which involves deliberatly attempting a bad logon to the remote server.
Default: paranoid server security = FCyesF[]
passdb backend (G)
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:
LDAP connections should be secured where possible. This may be done using either Start-TLS (see m[blue]ldap sslm[]) 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"
Default: passdb backend = FCtdbsamF[]
passdb expand explicit (G)
Default: passdb expand explicit = FCnoF[]
passwd chat debug (G)
Default: passwd chat debug = FCnoF[]
passwd chat timeout (G)
Default: passwd chat timeout = FC2F[]
passwd chat (G)
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 m[blue]unix password syncm[] 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 m[blue]passwd programm[] must be executed on the NIS master.
The string can contain the macro %n which is substituted for the new password. The old passsword (%o) is only available when m[blue]encrypt passwordsm[] 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 m[blue]pam password changem[] 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.
Default: passwd chat = FC*new*password* %n\n*new*password* %n\n *changed*F[]
Example: passwd chat = FC"*Enter NEW password*" %n\n "*Reenter NEW password*" %n\n "*Password changed*"F[]
passwd program (G)
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 FCsmbdF[] 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.
Default: passwd program = FCF[]
Example: passwd program = FC/bin/passwd %uF[]
password level (G)
This parameter defines the maximum number of characters that may be upper case in passwords.
For example, say the password given was "FRED". If password level is set to 1, the following combinations would be tried if "FRED" failed:
"Fred", "fred", "fRed", "frEd","freD"
If password level was set to 2, the following combinations would also be tried:
"FRed", "FrEd", "FreD", "fREd", "fReD", "frED", ..
And so on.
The higher value this parameter is set to the more likely it is that a mixed case password will be matched against a single case password. However, you should be aware that use of this parameter reduces security and increases the time taken to process a new connection.
A value of zero will cause only two attempts to be made - the password as is and the password in all-lower case.
This parameter is used only when using plain-text passwords. It is not at all used when encrypted passwords as in use (that is the default since samba-3.0.0). Use this only when m[blue]encrypt passwords = Nom[].
Default: password level = FC0F[]
Example: password level = FC4F[]
password server (G)
This option sets the name or IP address of the password server to use. New syntax has been added to support defining the port to use when connecting to the server the case of an ADS realm. To define a port other than the default LDAP port of 389, add the port number using a colon after the name or IP address (e.g. 192.168.1.100:389). If you do not specify a port, Samba will use the standard LDAP port of tcp/389. Note that port numbers have no effect on password servers for Windows NT 4.0 domains or netbios connections.
If parameter is a name, it is looked up using the parameter m[blue]name resolve orderm[] and so may resolved by any method and order described in that parameter.
The password server must be a machine capable of using the "LM1.2X002" or the "NT LM 0.12" protocol, and it must be in user level security mode.
The name of the password server takes the standard substitutions, but probably the only useful one is %m , which means the Samba server will use the incoming client as the password server. If you use this then you better trust your clients, and you had better restrict them with hosts allow!
If the security parameter is set to domain or ads, then the list of machines in this option must be a list of Primary or Backup Domain controllers for the Domain or the character '*', as the Samba server is effectively in that domain, and will use cryptographically authenticated RPC calls to authenticate the user logging on. The advantage of using FC security = domainF[] is that if you list several hosts in the password server option then FCsmbd F[] will try each in turn till it finds one that responds. This is useful in case your primary server goes down.
If the password server option is set to the character '*', then Samba will attempt to auto-locate the Primary or Backup Domain controllers to authenticate against by doing a query for the name WORKGROUP<1C> and then contacting each server returned in the list of IP addresses from the name resolution source.
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 the security parameter is set to server, then there are different restrictions that FCsecurity = domainF[] doesn't suffer from:
Example: password server = FCNT-PDC, NT-BDC1, NT-BDC2, *F[]
Example: password server = FCwindc.mydomain.com:389 192.168.1.101 *F[]
directory
path (S)
For a printable service offering guest access, the service should be readonly and the path should be world-writeable and have the sticky bit set. This is not mandatory of course, but you probably won't get the results you expect if you do otherwise.
Any occurrences of %u in the path will be replaced with the UNIX username that the client is using on this connection. Any occurrences of %m will be replaced by the NetBIOS name of the machine they are connecting from. These replacements are very useful for setting up pseudo home directories for users.
Note that this path will be based on m[blue]root dirm[] if one was specified.
Default: path = FCF[]
Example: path = FC/home/fredF[]
perfcount module (G)
No default
pid directory (G)
Default: pid directory = FC${prefix}/var/locksF[]
Example: pid directory = FCpid directory = /var/run/F[]
posix locking (S)
Default: posix locking = FCyesF[]
postexec (S)
An interesting example may be to unmount server resources:
FCpostexec = /etc/umount /cdromF[]
Default: postexec = FCF[]
Example: postexec = FCecho \"%u disconnected from %S from %m (%I)\" >> /tmp/logF[]
preexec close (S)
Default: preexec close = FCnoF[]
exec
preexec (S)
An interesting example is to send the users a welcome message every time they log in. Maybe a message of the day? Here is an example:
FCpreexec = csh -c 'echo \"Welcome to %S!\" | /usr/local/samba/bin/smbclient -M %m -I %I' & F[]
Of course, this could get annoying after a while :-)
See also m[blue]preexec closem[] and m[blue]postexecm[].
Default: preexec = FCF[]
Example: preexec = FCecho \"%u connected to %S from %m (%I)\" >> /tmp/logF[]
prefered master
preferred master (G)
If this is set to yes, on startup, FCnmbdF[] 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 m[blue]domain master = yesm[], so that FCnmbdF[] 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.
Default: preferred master = FCautoF[]
preload modules (G)
Default: preload modules = FCF[]
Example: preload modules = FC/usr/lib/samba/passdb/mysql.soF[]
auto services
preload (G)
Note that if you just want all printers in your printcap file loaded then the m[blue]load printersm[] option is easier.
Default: preload = FCF[]
Example: preload = FCfred lp colorlpF[]
preserve case (S)
See the section on NAME MANGLING for a fuller discussion.
Default: preserve case = FCyesF[]
print ok
printable (S)
Note that a printable service will ALWAYS allow writing to the service path (user privileges permitting) via the spooling of print data. The m[blue]read onlym[] parameter controls only non-printing access to the resource.
Default: printable = FCnoF[]
printcap cache time (G)
Setting this parameter to 0 disables any rescanning for new or removed printers after the initial startup.
Default: printcap cache time = FC750F[]
Example: printcap cache time = FC600F[]
printcap
printcap name (G)
To use the CUPS printing interface set FCprintcap name = cups F[]. This should be supplemented by an addtional setting m[blue]printing = cupsm[] in the [global] section. FCprintcap name = cupsF[] will use the "dummy" printcap created by CUPS, as specified in your CUPS configuration file.
On System V systems that use FClpstatF[] to list available printers you can use FCprintcap name = lpstat F[] 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 FClpstatF[] on these systems then Samba will launch FClpstat -vF[] 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.
Example: printcap name = FC/etc/myprintcapF[]
print command (S)
The print command is simply a text string. It will be used verbatim after macro substitutions have been made:
%s, %f - the path to the spool file name
%p - the appropriate printer name
%J - the job name as transmitted by the client.
%c - The number of printed pages of the spooled job (if known).
%z - the size of the spooled print job (in bytes)
The print command MUST contain at least one occurrence of %s or %f - the %p is optional. At the time a job is submitted, if no printer name is supplied the %p will be silently removed from the printer command.
If specified in the [global] section, the print command given will be used for any printable service that does not have its own print command specified.
If there is neither a specified print command for a printable service nor a global print command, spool files will be created but not processed and (most importantly) not removed.
Note that printing may fail on some UNIXes from the nobody account. If this happens then create an alternative guest account that can print and set the m[blue]guest accountm[] in the [global] section.
You can form quite complex print commands by realizing that they are just passed to a shell. For example the following will log a print job, print the file, then remove it. Note that ';' is the usual separator for command in shell scripts.
FCprint command = echo Printing %s >> /tmp/print.log; lpr -P %p %s; rm %sF[]
You may have to vary this command considerably depending on how you normally print files on your system. The default for the parameter varies depending on the setting of the m[blue]printingm[] parameter.
Default: For FCprinting = BSD, AIX, QNX, LPRNG or PLP :F[]
FCprint command = lpr -r -P%p %sF[]
For FCprinting = SYSV or HPUX :F[]
FCprint command = lp -c -d%p %s; rm %sF[]
For FCprinting = SOFTQ :F[]
FCprint command = lp -d%p -s %s; rm %sF[]
For printing = CUPS : If SAMBA is compiled against libcups, then m[blue]printcap = cupsm[] uses the CUPS API to submit jobs, etc. Otherwise it maps to the System V commands with the -oraw option for printing, i.e. it uses FClp -c -d%p -oraw; rm %sF[]. With FCprinting = cupsF[], and if SAMBA is compiled against libcups, any manually set print command will be ignored.
No default
Example: print command = FC/usr/local/samba/bin/myprintscript %p %sF[]
printer admin (S)
This parameter has been marked deprecated in favor of using the SePrintOperatorPrivilege and individual print security descriptors. It will be removed in a future release.
Default: printer admin = FCF[]
Example: printer admin = FCadmin, @staffF[]
printer
printer name (S)
If specified in the [global] section, the printer name given will be used for any printable service that does not have its own printer name specified.
The default value of the m[blue]printer namem[] may be FClpF[] on many systems.
Default: printer name = FCnoneF[]
Example: printer name = FClaserwriterF[]
printing (S)
Currently nine printing styles are supported. They are BSD, AIX, LPRNG, PLP, SYSV, HPUX, QNX, SOFTQ, and CUPS.
To see what the defaults are for the other print commands when using the various options use the testparm(1) program.
This option can be set on a per printer basis. Please be aware however, that you must place any of the various printing commands (e.g. print command, lpq command, etc...) after defining the value for the printing option since it will reset the printing commands to default values.
See also the discussion in the [printers] section.
Default: printing = FCDepends on the operating system, see FCtestparm -v.F[]F[]
printjob username (S)
Default: printjob username = FC%UF[]
Example: printjob username = FC%D\%UF[]
private dir (G)
Default: private dir = FC${prefix}/privateF[]
profile acls (S)
When not in domain mode with winbindd then the security info copied onto the local workstation has no meaning to the logged in user (SID) on that workstation so the profile storing fails. Adding this parameter onto a share used for profile storage changes two things about the returned Windows ACL. Firstly it changes the owner and group owner of all reported files and directories to be BUILTIN\\Administrators, BUILTIN\\Users respectively (SIDs S-1-5-32-544, S-1-5-32-545). Secondly it adds an ACE entry of "Full Control" to the SID BUILTIN\\Users to every returned ACL. This will allow any Windows 2000 or XP workstation user to access the profile.
Note that if you have multiple users logging on to a workstation then in order to prevent them from being able to access each others profiles you must remove the "Bypass traverse checking" advanced user right. This will prevent access to other users profile directories as the top level profile directory (named after the user) is created by the workstation profile code and has an ACL restricting entry to the directory tree to the owning user.
Default: profile acls = FCnoF[]
queuepause command (S)
This command should be a program or script which takes a printer name as its only parameter and stops the printer queue, such that no longer jobs are submitted to the printer.
This command is not supported by Windows for Workgroups, but can be issued from the Printers window under Windows 95 and NT.
If a %p is given then the printer name is put in its place. Otherwise it is placed at the end of the command.
Note that it is good practice to include the absolute path in the command as the PATH may not be available to the server.
No default
Example: queuepause command = FCdisable %pF[]
queueresume command (S)
This command should be a program or script which takes a printer name as its only parameter and resumes the printer queue, such that queued jobs are resubmitted to the printer.
This command is not supported by Windows for Workgroups, but can be issued from the Printers window under Windows 95 and NT.
If a %p is given then the printer name is put in its place. Otherwise it is placed at the end of the command.
Note that it is good practice to include the absolute path in the command as the PATH may not be available to the server.
Default: queueresume command = FCF[]
Example: queueresume command = FCenable %pF[]
read list (S)
This parameter will not work with the m[blue]security = sharem[] in Samba 3.0. This is by design.
Default: read list = FCF[]
Example: read list = FCmary, @studentsF[]
read only (S)
If this parameter is yes, then users of a service may not create or modify files in the service's directory.
Note that a printable service (FCprintable = yesF[]) will ALWAYS allow writing to the directory (user privileges permitting), but only via spooling operations.
Default: read only = FCyesF[]
read raw (G)
If enabled, raw reads allow reads of 65535 bytes in one packet. This typically provides a major performance benefit.
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.
Default: read raw = FCyesF[]
realm (G)
Default: realm = FCF[]
Example: realm = FCmysambabox.mycompany.comF[]
registry shares (G)
Note that this parameter defaults to no, but it is set to yes when config backend is set to registry.
Default: registry shares = FCnoF[]
Example: registry shares = FCyesF[]
remote announce (G)
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:
FCremote announce = 192.168.2.255/SERVERS 192.168.4.255/STAFFF[]
the above line would cause FCnmbdF[] 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 m[blue]workgroupm[] 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.
Default: remote announce = FCF[]
remote browse sync (G)
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 FCnmbdF[] 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 m[blue]remote browse syncm[] 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.
Default: remote browse sync = FCF[]
rename user script (G)
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, FC%uoldF[] and FC%unewF[], will be substituted with the old and new usernames, respectively. The script should return 0 upon successful completion, and nonzero otherwise.
reset on zero vc (G)
Default: reset on zero vc = FCnoF[]
restrict anonymous (G)
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\
Control\LSA\RestrictAnonymous
registry key in Windows 2000 and Windows NT. When set to 0, user and group list information is returned to anyone who asks. When set to 1, only an authenticated user can retrive user and group list information. For the value 2, supported by Windows 2000/XP and Samba, no anonymous connections are allowed at all. This can break third party and Microsoft applications which expect to be allowed to perform operations anonymously.
The security advantage of using restrict anonymous = 1 is dubious, as user and group list information can be obtained using other means.
root
root dir
root directory (G)
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 FC/etc/passwdF[] (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.
Default: root directory = FC/F[]
Example: root directory = FC/homes/smbF[]
root postexec (S)
Default: root postexec = FCF[]
root preexec close (S)
Default: root preexec close = FCnoF[]
root preexec (S)
Default: root preexec = FCF[]
security mask (S)
This parameter is applied as a mask (AND'ed with) to the incoming permission bits, thus resetting any bits not in this mask. Make sure not to mix up this parameter with m[blue]force security modem[], which works in a manner similar to this one but uses a logical OR instead of an AND.
Essentially, all bits set to zero in this mask will result in setting to zero the corresponding bits on the file permissions regardless of the previous status of this bits on the file.
If not set explicitly this parameter is 0777, allowing a user to set all the user/group/world permissions on a file.
Note that users who can access the Samba server through other means can easily bypass this restriction, so it is primarily useful for standalone "appliance" systems. Administrators of most normal systems will probably want to leave it set to 0777.
Default: security mask = FC0777F[]
Example: security mask = FC0770F[]
security (G)
The option sets the "security mode bit" in replies to protocol negotiations with smbd(8) to turn share level security on or off. Clients decide based on this bit whether (and how) to transfer user and password information to the server.
The default is FCsecurity = userF[], as this is the most common setting needed when talking to Windows 98 and Windows NT.
The alternatives are FCsecurity = shareF[], FCsecurity = serverF[] or FCsecurity = domain F[].
In versions of Samba prior to 2.0.0, the default was FCsecurity = shareF[] mainly because that was the only option at one stage.
There is a bug in WfWg that has relevance to this setting. When in user or server level security a WfWg client will totally ignore the username and password you type in the "connect drive" dialog box. This makes it very difficult (if not impossible) to connect to a Samba service as anyone except the user that you are logged into WfWg as.
If your PCs use usernames that are the same as their usernames on the UNIX machine then you will want to use FCsecurity = userF[]. If you mostly use usernames that don't exist on the UNIX box then use FCsecurity = shareF[].
You should also use FCsecurity = shareF[] if you want to mainly setup shares without a password (guest shares). This is commonly used for a shared printer server. It is more difficult to setup guest shares with FCsecurity = userF[], see the m[blue]map to guestm[] parameter for details.
It is possible to use FCsmbdF[] in a hybrid mode where it is offers both user and share level security under different m[blue]NetBIOS aliasesm[].
The different settings will now be explained.
SECURITY = SHARE
When clients connect to a share level security server, they need not log onto the server with a valid username and password before attempting to connect to a shared resource (although modern clients such as Windows 95/98 and Windows NT will send a logon request with a username but no password when talking to a FCsecurity = share F[] server). Instead, the clients send authentication information (passwords) on a per-share basis, at the time they attempt to connect to that share.
Note that FCsmbdF[] ALWAYS uses a valid UNIX user to act on behalf of the client, even in FCsecurity = shareF[] level security.
As clients are not required to send a username to the server in share level security, FCsmbdF[] uses several techniques to determine the correct UNIX user to use on behalf of the client.
A list of possible UNIX usernames to match with the given client password is constructed using the following methods :
If the guest only parameter is set, or no username can be determined then if the share is marked as available to the guest account, then this guest user will be used, otherwise access is denied.
Note that it can be very confusing in share-level security as to which UNIX username will eventually be used in granting access.
See also the section NOTE ABOUT USERNAME/PASSWORD VALIDATION.
SECURITY = USER
This is the default security setting in Samba 3.0. With user-level security a client must first "log-on" with a valid username and password (which can be mapped using the m[blue]username mapm[] parameter). Encrypted passwords (see the m[blue]encrypted passwordsm[] parameter) can also be used in this security mode. Parameters such as m[blue]userm[] and m[blue]guest onlym[] 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 m[blue]guest accountm[]. See the m[blue]map to guestm[] parameter for details on doing this.
See also the section NOTE ABOUT USERNAME/PASSWORD VALIDATION.
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 m[blue]encrypted passwordsm[] 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 FCsecurity = domainF[] is the same as FCsecurity = userF[]. 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 m[blue]guest accountm[]. See the m[blue]map to guestm[] parameter for details on doing this.
See also the section NOTE ABOUT USERNAME/PASSWORD VALIDATION.
See also the m[blue]password serverm[] parameter and the m[blue]encrypted passwordsm[] parameter.
SECURITY = SERVER
In this mode Samba will try to validate the username/password by passing it to another SMB server, such as an NT box. If this fails it will revert to FCsecurity = userF[]. It expects the m[blue]encrypted passwordsm[] parameter to be set to yes, unless the remote server does not support them. However note that if encrypted passwords have been negotiated then Samba cannot revert back to checking the UNIX password file, it must have a valid FCsmbpasswdF[] file to check users against. See the chapter about the User Database in the Samba HOWTO Collection for details on how to set this up.
See also the section NOTE ABOUT USERNAME/PASSWORD VALIDATION.
See also the m[blue]password serverm[] parameter and the m[blue]encrypted passwordsm[] 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.
Read the chapter about Domain Membership in the HOWTO for details.
Default: security = FCUSERF[]
Example: security = FCDOMAINF[]
server schannel (G)
Please note that with this set to FCnoF[], you will have to apply the WindowsXP FCWinXP_SignOrSeal.regF[] registry patch found in the docs/registry subdirectory of the Samba distribution tarball.
Default: server schannel = FCautoF[]
Example: server schannel = FCyesF[]
server signing (G)
When set to auto, 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.
Default: server signing = FCDisabledF[]
server string (G)
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.
Default: server string = FCSamba %vF[]
Example: server string = FCUniversity of GNUs Samba ServerF[]
set directory (S)
The FCsetdirF[] command is only implemented in the Digital Pathworks client. See the Pathworks documentation for details.
Default: set directory = FCnoF[]
set primary group script (G)
Default: set primary group script = FCF[]
Example: set primary group script = FC/usr/sbin/usermod -g '%g' '%u'F[]
set quota command (G)
This option is only available if Samba was configured with the argument FC--with-sys-quotasF[] or on linux when FC./configure --with-quotasF[] was used and a working quota api was found in the system. Most packages are configured with these options already.
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:
Default: set quota command = FCF[]
Example: set quota command = FC/usr/local/sbin/set_quotaF[]
share modes (S)
This is a deprecated option from old versions of Samba, and will be removed in the next major release.
These open modes are not directly supported by UNIX, so they are simulated using shared memory.
The share modes that are enabled by this option are the standard Windows share modes.
This option gives full share compatibility and is enabled by default.
You should NEVER turn this parameter off as many Windows applications will break if you do so.
Default: share modes = FCyesF[]
short preserve case (S)
See the section on NAME MANGLING.
Default: short preserve case = FCyesF[]
show add printer wizard (G)
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 a member of the printer admin group), 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.
shutdown script (G)
If the connected user posseses the SeRemoteShutdownPrivilege, right, this command will be run as root.
The %z %t %r %f variables are expanded as follows:
#!/bin/bash
$time=0
let "time/60"
let "time++"
/sbin/shutdown $3 $4 +$time $1 &
Shutdown does not return so we need to launch it in background.
Default: shutdown script = FCF[]
Example: shutdown script = FC/usr/local/samba/sbin/shutdown %m %t %r %fF[]
smb encrypt (S)
This controls whether the remote client is allowed or required to use SMB encryption. Possible values are auto, mandatory and disabled. This may be set on a per-share basis, but clients may chose to encrypt the entire session, not just traffic to a specific share. If this is set to mandatory then all traffic to a share must must be encrypted once the connection has been made to the share. The server would return "access denied" to all non-encrypted requests on such a share. Selecting encrypted traffic reduces throughput as smaller packet sizes must be used (no huge UNIX style read/writes allowed) as well as the overhead of encrypting and signing all the data.
If SMB encryption is selected, Windows style SMB signing (see the m[blue]server signingm[] option) is no longer necessary, as the GSSAPI flags use select both signing and sealing of the data.
When set to auto, SMB encryption is offered, but not enforced. When set to mandatory, SMB encryption is required and if set to disabled, SMB encryption can not be negotiated.
Default: smb encrypt = FCautoF[]
smb passwd file (G)
An example of use is:
smb passwd file = /etc/samba/smbpasswd
Default: smb passwd file = FC${prefix}/private/smbpasswdF[]
smb ports (G)
Default: smb ports = FC445 139F[]
socket address (G)
Setting this option should never be necessary on usual Samba servers running only one nmbd.
By default Samba will accept connections on any address.
Default: socket address = FCF[]
Example: socket address = FC192.168.2.20F[]
socket options (G)
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 FCman setsockoptF[] 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@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:
To specify an argument use the syntax SOME_OPTION = VALUE for example FCSO_SNDBUF = 8192F[]. 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:
FCsocket options = IPTOS_LOWDELAYF[]
If you have a local network then you could try:
FCsocket options = IPTOS_LOWDELAY TCP_NODELAYF[]
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!
Default: socket options = FCTCP_NODELAYF[]
Example: socket options = FCIPTOS_LOWDELAYF[]
stat cache (G)
Default: stat cache = FCyesF[]
store dos attributes (S)
Default: store dos attributes = FCnoF[]
strict allocate (S)
When strict allocate is no the server does sparse disk block allocation when a file is extended.
Setting this to yes can help Samba return out of quota messages on systems that are restricting the disk quota of users.
Default: strict allocate = FCnoF[]
strict locking (S)
When strict locking is set to Auto (the default), the server performs file lock checks only on non-oplocked files. As most Windows redirectors perform file locking checks locally on oplocked files this is a good trade off for improved performance.
When strict locking is disabled, the server performs file lock checks only when the client explicitly asks for them.
Well-behaved clients always ask for lock checks when it is important. So in the vast majority of cases, FCstrict locking = AutoF[] or FCstrict locking = noF[] is acceptable.
Default: strict locking = FCAutoF[]
strict sync (S)
Default: strict sync = FCnoF[]
svcctl list (G)
The administrator must create a directory name FCsvcctlF[] in Samba's $(libdir) and create symbolic links to the init scripts in FC/etc/init.d/F[]. The name of the links must match the names given as part of the svcctl list.
Default: svcctl list = FCF[]
Example: svcctl list = FCcups postfix portmap httpdF[]
sync always (S)
Default: sync always = FCnoF[]
syslog only (G)
Default: syslog only = FCnoF[]
syslog (G)
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.
Default: syslog = FC1F[]
template homedir (G)
Default: template homedir = FC/home/%D/%UF[]
template shell (G)
No default
time offset (G)
Default: time offset = FC0F[]
Example: time offset = FC60F[]
time server (G)
Default: time server = FCnoF[]
unix charset (G)
This is also the charset Samba will use when specifying arguments to scripts that it invokes.
Default: unix charset = FCUTF8F[]
Example: unix charset = FCASCIIF[]
unix extensions (G)
Default: unix extensions = FCyesF[]
unix password sync (G)
Default: unix password sync = FCnoF[]
update encrypted (G)
In order for this parameter to be operative the m[blue]encrypt passwordsm[] parameter must be set to no. The default value of m[blue]encrypt passwords = Yesm[]. Note: This must be set to no for this m[blue]update encryptedm[] to work.
Note that even when this parameter is set, a user authenticating to FCsmbdF[] must still enter a valid password in order to connect correctly, and to update their hashed (smbpasswd) passwords.
Default: update encrypted = FCnoF[]
use client driver (S)
The differentiating factor is that under normal circumstances, the NT/2000 client will attempt to open the network printer using MS-RPC. The problem is that because the client considers the printer to be local, it will attempt to issue the OpenPrinterEx() call requesting access rights associated with the logged on user. If the user possesses local administator rights but not root privilege on the Samba host (often the case), the OpenPrinterEx() call will fail. The result is that the client will now display an "Access Denied; Unable to connect" message in the printer queue window (even though jobs may successfully be printed).
If this parameter is enabled for a printer, then any attempt to open the printer with the PRINTER_ACCESS_ADMINISTER right is mapped to PRINTER_ACCESS_USE instead. Thus allowing the OpenPrinterEx() call to succeed. This parameter MUST not be enabled on a print share which has valid print driver installed on the Samba server.
Default: use client driver = FCnoF[]
use mmap (G)
Default: use mmap = FCyesF[]
username level (G)
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.
Default: username level = FC0F[]
Example: username level = FC5F[]
username map script (G)
Default: username map script = FCF[]
Example: username map script = FC/etc/samba/scripts/mapusers.shF[]
username map (G)
Please note that for user or share 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 enties in the map table (e.g. biddle = FCDOMAIN\fooF[]).
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:
FCroot = admin administratorF[]
Or to map anyone in the UNIX group system to the UNIX name sys you would use:
FCsys = @systemF[]
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 FC/etc/group F[] database for matching groups.
You can map Windows usernames that have spaces in them by using double quotes around the name. For example:
FCtridge = "Andrew Tridgell"F[]
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 the m[blue]password serverm[] (if you have one). The password server 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.: FCDOMAIN\userF[]) 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. FCDOMAIN\userF[]) only after the user has been successfully authenticated.
An example of use is:
username map = /usr/local/samba/lib/users.map
Default: username map = FC # no username mapF[]
user
users
username (S)
The username line is needed only when the PC is unable to supply its own username. This is the case for the COREPLUS protocol or where your users have different WfWg usernames to UNIX usernames. In both these cases you may also be better using the \\server\share%user syntax instead.
The username line is not a great solution in many cases as it means Samba will try to validate the supplied password against each of the usernames in the username line in turn. This is slow and a bad idea for lots of users in case of duplicate passwords. You may get timeouts or security breaches using this parameter unwisely.
Samba relies on the underlying UNIX security. This parameter does not restrict who can login, it just offers hints to the Samba server as to what usernames might correspond to the supplied password. Users can login as whoever they please and they will be able to do no more damage than if they started a telnet session. The daemon runs as the user that they log in as, so they cannot do anything that user cannot do.
To restrict a service to a particular set of users you can use the m[blue]valid usersm[] parameter.
If any of the usernames begin with a '@' then the name will be looked up first in the NIS netgroups list (if Samba is compiled with netgroup support), followed by a lookup in the UNIX groups database and will expand to a list of all users in the group of that name.
If any of the usernames begin with a '+' then the name will be looked up only in the UNIX groups database and will expand to a list of all users in the group of that name.
If any of the usernames begin with a '&' then the name will be looked up only in the NIS netgroups database (if Samba is compiled with netgroup support) and will expand to a list of all users in the netgroup group of that name.
Note that searching though a groups database can take quite some time, and some clients may time out during the search.
See the section NOTE ABOUT USERNAME/PASSWORD VALIDATION for more information on how this parameter determines access to the services.
Default: username = FC # The guest account if a guest service, else <empty string>.F[]
Example: username = FCfred, mary, jack, jane, @users, @pcgroupF[]
usershare allow guests (G)
Default: usershare allow guests = FCnoF[]
usershare max shares (G)
Default: usershare max shares = FC0F[]
usershare owner only (G)
Default: usershare owner only = FCTrueF[]
usershare path (G)
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.
Default: usershare path = FCNULLF[]
usershare prefix allow list (G)
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.
Default: usershare prefix allow list = FCNULLF[]
Example: usershare prefix allow list = FC/home /data /spaceF[]
usershare prefix deny list (G)
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.
Default: usershare prefix deny list = FCNULLF[]
Example: usershare prefix deny list = FC/etc /dev /privateF[]
usershare template share (G)
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.
Default: usershare template share = FCNULLF[]
Example: usershare template share = FCtemplate_shareF[]
use sendfile (S)
Default: use sendfile = FCfalseF[]
use spnego (G)
Unless further issues are discovered with our SPNEGO implementation, there is no reason this should ever be disabled.
Default: use spnego = FCyesF[]
utmp directory (G)
Default: utmp directory = FC # Determined automaticallyF[]
Example: utmp directory = FC/var/run/utmpF[]
utmp (G)
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.
Default: utmp = FCnoF[]
valid users (S)
If this is empty (the default) then any user can login. If a username is in both this list and the invalid users list then access is denied for that user.
The current servicename is substituted for %S. This is useful in the [homes] section.
Default: valid users = FC # No valid users list (anyone can login) F[]
Example: valid users = FCgreg, @pcusersF[]
-valid (S)
This option should not be used by regular users but might be of help to developers. Samba uses this option internally to mark shares as deleted.
Default: -valid = FCyesF[]
veto files (S)
Each entry must be a unix path, not a DOS path and must not include the unix directory separator '/'.
Note that the m[blue]case sensitivem[] option is applicable in vetoing files.
One feature of the veto files parameter that it is important to be aware of is Samba's behaviour when trying to delete a directory. If a directory that is to be deleted contains nothing but veto files this deletion will fail unless you also set the m[blue]delete veto filesm[] parameter to yes.
Setting this parameter will affect the performance of Samba, as it will be forced to check all files and directories for a match as they are scanned.
Examples of use include:
; Veto any files containing the word Security, ; any ending in .tmp, and any directory containing the ; word root. veto files = /*Security*/*.tmp/*root*/ ; Veto the Apple specific files that a NetAtalk server ; creates. veto files = /.AppleDouble/.bin/.AppleDesktop/Network Trash Folder/
Default: veto files = FCNo files or directories are vetoed.F[]
veto oplock files (S)
You might want to do this on files that you know will be heavily contended for by clients. A good example of this is in the NetBench SMB benchmark program, which causes heavy client contention for files ending in FC.SEMF[]. To cause Samba not to grant oplocks on these files you would use the line (either in the [global] section or in the section for the particular NetBench share.
An example of use is:
veto oplock files = /.*SEM/
Default: veto oplock files = FC # No files are vetoed for oplock grantsF[]
vfs object
vfs objects (S)
Default: vfs objects = FCF[]
Example: vfs objects = FCextd_audit recycleF[]
volume (S)
Default: volume = FC # the name of the shareF[]
wide links (S)
Note that setting this parameter can have a negative effect on your server performance due to the extra system calls that Samba has to do in order to perform the link checks.
Default: wide links = FCyesF[]
winbind cache time (G)
This does not apply to authentication requests, these are always evaluated in real time unless the m[blue]winbind offline logonm[] option has been enabled.
Default: winbind cache time = FC300F[]
winbind enum groups (G)
winbind enum users (G)
winbind expand groups (G)
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.
Default: winbind expand groups = FC1F[]
winbind nested groups (G)
Default: winbind nested groups = FCyesF[]
winbind normalize names (G)
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 precendence (and is mutually exclusive) over the whitespace replacement mechanism discussed previsouly.
Default: winbind normalize names = FCnoF[]
Example: winbind normalize names = FCyesF[]
winbind nss info (G)
Default: winbind nss info = FCtemplateF[]
Example: winbind nss info = FCtemplate sfuF[]
winbind offline logon (G)
Default: winbind offline logon = FCfalseF[]
Example: winbind offline logon = FCtrueF[]
winbind reconnect delay (G)
Default: winbind reconnect delay = FC30F[]
winbind refresh tickets (G)
Default: winbind refresh tickets = FCfalseF[]
Example: winbind refresh tickets = FCtrueF[]
winbind rpc only (G)
Default: winbind rpc only = FCnoF[]
winbind separator (G)
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.
Default: winbind separator = FC'\'F[]
Example: winbind separator = FC+F[]
winbind trusted domains only (G)
This parameter is now deprecated in favor of the newer idmap_nss backend. Refer to the idmap_nss(8) man page for more information.
Default: winbind trusted domains only = FCnoF[]
winbind use default domain (G)
Default: winbind use default domain = FCnoF[]
Example: winbind use default domain = FCyesF[]
wins hook (G)
The wins hook parameter specifies the name of a script or executable that will be called as follows:
FCwins_hook operation name nametype ttl IP_listF[]
No default
wins proxy (G)
Default: wins proxy = FCnoF[]
wins server (G)
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.
Default: wins server = FCF[]
Example: wins server = FCmary:192.9.200.1 fred:192.168.3.199 mary:192.168.2.61 # For this example when querying a certain name, 192.19.200.1 will be asked first and if that doesn't respond 192.168.2.61. If either of those doesn't know the name 192.168.3.199 will be queried.F[]
Example: wins server = FC192.9.200.1 192.168.2.61F[]
wins support (G)
Default: wins support = FCnoF[]
workgroup (G)
Default: workgroup = FCWORKGROUPF[]
Example: workgroup = FCMYGROUPF[]
writable
writeable (S)
Default: writeable = FCnoF[]
write cache size (S)
This cache allows Samba to batch client writes into a more efficient write size for RAID disks (i.e. writes may be tuned to be the RAID stripe size) and can improve performance on systems where the disk subsystem is a bottleneck but there is free memory for userspace programs.
The integer parameter specifies the size of this cache (per oplocked file) in bytes.
Default: write cache size = FC0F[]
Example: write cache size = FC262144 # for a 256k cache size per fileF[]
write list (S)
Note that if a user is in both the read list and the write list then they will be given write access.
By design, this parameter will not work with the m[blue]security = sharem[] in Samba 3.0.
Default: write list = FCF[]
Example: write list = FCadmin, root, @staffF[]
write raw (G)
Default: write raw = FCyesF[]
wtmp directory (G)
By default this is not set, meaning the system will use whatever utmp file the native system is set to use (usually FC/var/run/wtmpF[] on Linux).
Default: wtmp directory = FCF[]
Example: wtmp directory = FC/var/log/wtmpF[]
Although the configuration file permits service names to contain spaces, your client software may not. Spaces will be ignored in comparisons anyway, so it shouldn't be a problem - but be aware of the possibility.
On a similar note, many clients - especially DOS clients - limit service names to eight characters. smbd(8) has no such limitation, but attempts to connect from such clients will fail if they truncate the service names. For this reason you should probably keep your service names down to eight characters in length.
Use of the FC[homes]F[] and FC[printers]F[] special sections make life for an administrator easy, but the various combinations of default attributes can be tricky. Take extreme care when designing these sections. In particular, ensure that the permissions on spool directories are correct.
This man page is correct for version 3 of the Samba suite.
samba(7), smbpasswd(8), swat(8), smbd(8), nmbd(8), smbclient(1), nmblookup(1), testparm(1), testprns(1).
The original Samba software and related utilities were created by Andrew Tridgell. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed.
The original Samba man pages were written by Karl Auer. The man page sources were converted to YODL format (another excellent piece of Open Source software, available at ftp://ftp.icce.rug.nl/pub/unix/) and updated for the Samba 2.0 release by Jeremy Allison. The conversion to DocBook for Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0 was done by Alexander Bokovoy.