Партнёры:
Хостинг:
smb.conf - The configuration file for the Samba suite
The smb.conf file is a configuration file for the Samba suite. smb.conf contains runtime configuration information for the Samba programs. The smb.conf 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 (;) or a hash (#) character is ignored, as are lines containing only whitespace.
Any line ending in a \ 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, 0/1 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 share). 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 user = 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 /home/bar. The share is accessed via the share name foo:
[foo]
path = /home/bar
read only = no
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]
path = /usr/spool/public
read only = yes
printable = yes
guest ok = yes
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/%Sis 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 homes, 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] read only = no
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] path = /usr/spool/public guest ok = yes printable = yes
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 (|).
Note
On SYSV systems which use lpstat to determine what printers are defined on the system you may be able to use printcap name = lpstat to automatically obtain a list of printers. See the printcap name 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 foo 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
usershare path = /usr/local/samba/lib/usershares
usershare max shares = 10 # (or the desired number of shares)
to the global section of your
smb.conf. 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 path = /tmp/%u is interpreted as path = /tmp/john 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 smb.conf options.
Samba supports name mangling 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 guest only = yes and the server is running with share-level security (security = share, steps 1 to 5 are skipped.
abort shutdown script (G)
If the connected user posseses the SeRemoteShutdownPrivilege, right, this command will be run as user.
Default: abort shutdown script = ""
Example: abort shutdown script = /sbin/shutdown -c
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 refersh. 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 = True
acl compatibility (S)
Default: acl compatibility = Auto
Example: acl compatibility = win2k
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 was 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 inherit owner option and also on on a share containing directories with the UNIX setgid bit 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 marked deprecated in Samba 3.0.23. The same behavior is now implemented by the dos filemode option.
Default: acl group control = no
acl map full control (S)
Default: acl map full control = True
add group script (G)
Default: add group script =
Example: add group script = /usr/sbin/groupadd %g
add machine script (G)
This option is very similar to the add user script, and likewise uses the %u substitution for the account name. Do not use the %m substitution.
Default: add machine script =
Example: add machine script = /usr/sbin/adduser -n -g machines -c Machine -d /var/lib/nobody -s /bin/false %u
add port command (G)
Default: add port command =
Example: add port command = /etc/samba/scripts/addport.sh
add printer command (G)
For a Samba host this means that the printer must be physically added to the underlying printing system. The add printer command defines a script to be run which will perform the necessary operations for adding the printer to the print system and to add the appropriate service definition to the smb.conf file in order that it can be shared by smbd(8).
The addprinter command is automatically invoked with the following parameter (in order):
Once the addprinter command has been executed, smbd will reparse the smb.conf to determine if the share defined by the APW exists. If the sharename is still invalid, then smbd will return an ACCESS_DENIED error to the client.
The "add printer 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: add printer command =
Example: add printer command = /usr/bin/addprinter
add share command (G)
When executed, smbd will automatically invoke the add share command with five parameters.
Default: add share command =
Example: add share command = /usr/local/bin/addshare
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 security = share and add user script 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 password server and attempts to authenticate the given user with the given password. If the authentication succeeds then smbd attempts to find a UNIX user in the UNIX password database to map the Windows user into. If this lookup fails, and add user script is set then smbd will call the specified script AS ROOT, expanding any %u argument to be the user name to create.
If this script successfully creates the user then smbd will continue on as though the UNIX user already existed. In this way, UNIX users are dynamically created to match existing Windows NT accounts.
See also security, password server, delete user script.
Default: add user script =
Example: add user script = /usr/local/samba/bin/add_user %u
add user to group script (G)
Note that the adduser command used in the example below does not support the used syntax on all systems.
Default: add user to group script =
Example: add user to group script = /usr/sbin/adduser %u %g
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 security = share in Samba 3.0. This is by design.
Default: admin users =
Example: admin users = jason
afs share (S)
Default: afs share = no
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 =
Example: afs username map = %u@afs.samba.org
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.
write cache size
aio write size
Default: aio read size = 0
Example: aio read size = 16384 # Use asynchronous I/O for reads bigger than 16KB request size
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.
write cache size
aio read size
Default: aio write size = 0
Example: aio write size = 16384 # Use asynchronous I/O for writes bigger than 16KB request size
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 arbitary-rid supporting backends.
Default: algorithmic rid base = 1000
Example: algorithmic rid base = 100000
allocation roundup size (S)
The integer parameter specifies the roundup size in bytes.
Default: allocation roundup size = 1048576
Example: allocation roundup size = 0 # (to disable roundups)
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 = yes
announce as (G)
Default: announce as = NT Server
Example: announce as = Win95
announce version (G)
Default: announce version = 4.9
Example: announce version = 2.0
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 =
Example: auth methods = guest sam winbind
available (S)
Default: available = yes
bind interfaces only (G)
For name service it causes nmbd to bind to ports 137 and 138 on the interfaces listed in the interfaces parameter. nmbd also binds to the "all addresses" interface (0.0.0.0) on ports 137 and 138 for the purposes of reading broadcast messages. If this option is not set then nmbd will service name requests on all of these sockets. If bind interfaces only is set then nmbd will check the source address of any packets coming in on the broadcast sockets and discard any that don't match the broadcast addresses of the interfaces in the interfaces parameter list. As unicast packets are received on the other sockets it allows nmbd to refuse to serve names to machines that send packets that arrive through any interfaces not listed in the interfaces list. IP Source address spoofing does defeat this simple check, however, so it must not be used seriously as a security feature for nmbd.
For file service it causes smbd(8) to bind only to the interface list given in the interfaces parameter. This restricts the networks that smbd will serve to packets coming in 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 bind interfaces only is set then unless the network address 127.0.0.1 is added to the interfaces 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 smbpasswd by default connects to the localhost - 127.0.0.1 address as an SMB client to issue the password change request. If bind interfaces only is set then unless the network address 127.0.0.1 is added to the interfaces parameter list then smbpasswd will fail to connect in it's default mode. smbpasswd can be forced to use the primary IP interface of the local host by using its smbpasswd(8) -r remote machine parameter, with remote machine set to the IP name of the primary interface of the local host.
The swat status page tries to connect with smbd and nmbd at the address 127.0.0.1 to determine if they are running. Not adding 127.0.0.1 will cause smbd and nmbd to always show "not running" even if they really are. This can prevent swat from starting/stopping/restarting smbd and nmbd.
Default: bind interfaces only = no
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 = yes
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 = 1024
Example: block size = 4096
browsable
browseable (S)
Default: browseable = yes
browse list (G)
Default: browse list = yes
casesignames
case sensitive (S)
Default: case sensitive = no
change notify (S)
You should never need to change this parameter
Default: change notify = no
change share command (G)
When executed, smbd will automatically invoke the change share command with five parameters.
Default: change share command =
Example: change share command = /usr/local/bin/addshare
check password script (G)
The program must return 0 on good password any other value otherwise. In case the password is considered weak (the program do not return 0) the user will be notified and the password change will fail.
Note: In the example directory there is a sample program called crackcheck that uses cracklib to checkpassword quality
Default: check password script = Disabled
Example: check password script = check password script = /usr/local/sbin/crackcheck
client lanman auth (G)
The LANMAN encrypted response is easily broken, due to it's case-insensitive nature, and the choice of algorithm. Clients without Windows 95/98 servers are advised to disable this option.
Disabling this option will also disable the client plaintext auth option
Likewise, if the client ntlmv2 auth parameter is enabled, then only NTLMv2 logins will be attempted.
Default: client lanman auth = yes
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, client lanman auth and client plaintext auth authentication will be disabled. This also disables share-level authentication.
If disabled, an NTLM response (and possibly a LANMAN response) will be sent by the client, depending on the value of client lanman auth.
Note that some sites (particularly those following 'best practice' security polices) only allow NTLMv2 responses, and not the weaker LM or NTLM.
Default: client ntlmv2 auth = no
client plaintext auth (G)
Default: client plaintext auth = yes
client schannel (G)
Default: client schannel = auto
Example: client schannel = yes
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 = auto
client use spnego (G)
Default: client use spnego = yes
comment (S)
If you want to set the string that is displayed next to the machine name then see the server string parameter.
Default: comment = # No comment
Example: comment = Fred's Files
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 = /usr/local/samba/lib/smb.conf.%m
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 =
Example: copy = otherservice
create mode
create mask (S)
The default value of this parameter removes the group and other 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 force create mode parameter which is set to 000 by default.
This parameter does not affect directory masks. See the parameter directory mask 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 security mask.
Default: create mask = 0744
Example: create mask = 0775
csc policy (S)
These values correspond to those used on Windows servers.
For example, shares containing roaming profiles can have offline caching disabled using csc policy = disable.
Default: csc policy = manual
Example: csc policy = programs
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.
You should set this parameter to raw if your CUPS server error_log 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 /etc/cups/mime.{convs,types}.
Default: cups options = ""
Example: cups options = "raw,media=a4,job-sheets=secret,secret"
cups server (G)
If set, this option overrides the ServerName option in the CUPS client.conf. This is necessary if you have virtual samba servers that connect to different CUPS daemons.
Optionally, a port can be specified by separating the server name and port number with a colon. If no port was specified, the default port for IPP (631) will be used.
Default: cups server = ""
Example: cups server = mycupsserver
Example: cups server = mycupsserver:1631
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 = 0
Example: deadtime = 15
debug hires timestamp (G)
Note that the parameter debug timestamp must be on for this to have an effect.
Default: debug hires timestamp = no
debug pid (G)
Note that the parameter debug timestamp must be on for this to have an effect.
Default: debug pid = no
debug prefix timestamp (G)
Note that this parameter overrides the debug timestamp parameter.
Default: debug prefix timestamp = no
timestamp logs
debug timestamp (G)
Default: debug timestamp = yes
debug uid (G)
Note that the parameter debug timestamp must be on for this to have an effect.
Default: debug uid = no
default case (S)
Default: default case = lower
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 default devmode = yes 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 = yes
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 guest ok, read-only 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 =
Example: default service = pub
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 = True
delete group script (G)
Default: delete group script =
deleteprinter command (G)
For a Samba host this means that the printer must be physically deleted from underlying printing system. The deleteprinter command defines a script to be run which will perform the necessary operations for removing the printer from the print system and from smb.conf.
The deleteprinter command is automatically called with only one parameter: printer name.
Once the deleteprinter command has been executed, smbd will reparse the smb.conf to associated printer no longer exists. If the sharename is still valid, then smbd will return an ACCESS_DENIED error to the client.
Default: deleteprinter command =
Example: deleteprinter command = /usr/bin/removeprinter
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 = no
delete share command (G)
When executed, smbd will automatically invoke the delete share command with two parameters.
Default: delete share command =
Example: delete share command = /usr/local/bin/delshare
delete user from group script (G)
Default: delete user from group script =
Example: delete user from group script = /usr/sbin/deluser %u %g
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 rpcclient.
This script should delete the given UNIX username.
Default: delete user script =
Example: delete user script = /usr/local/samba/bin/del_user %u
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. .AppleDouble)
Setting delete veto files = yes 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 = no
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 dfree command scripts increasing the load.
By default this parameter is zero, meaning no caching will be done.
No default
Example: dfree cache time = dfree cache time = 60
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 dfree cache time 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 ./. 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 $2" "$4}'
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 = /usr/local/samba/bin/dfree
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 force directory mode 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 directory security mask.
Default: directory mask = 0755
Example: directory mask = 0775
directory security mask (S)
This parameter is applied as a mask (AND'ed with) to the changed permission bits, thus preventing any bits not in this mask from being modified. Make sure not to mix up this parameter with force directory security mode, which works similar like this one but uses logical OR instead of AND. Essentially, zero bits in this mask may be treated as a set of bits the user is not allowed to change.
If not set explicitly this parameter is set to 0777 meaning a user is allowed to modify 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 = 0777
Example: directory security mask = 0700
disable netbios (G)
Note
Clients that only support netbios won't be able to see your samba server when netbios support is disabled.
Default:
disable netbios = no
disable spoolss (G)
Default: disable spoolss = no
display charset (G)
Default: display charset = "LOCALE" or "ASCII" (depending on the system)
Example: display charset = UTF8
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 = no
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.
nmbd 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 = yes
domain logons (G)
Default: domain logons = no
domain master (G)
Note that Windows NT Primary Domain Controllers expect to be able to claim this workgroup specific special NetBIOS name that identifies them as domain master browsers for that workgroup by default (i.e. there is no way to prevent a Windows NT PDC from attempting to do this). This means that if this parameter is set and nmbd claims the special name for a workgroup before a Windows NT PDC is able to do so then cross subnet browsing will behave strangely and may fail.
If domain logons = yes, then the default behavior is to enable the domain master parameter. If domain logons is not enabled (the default setting), then neither will domain master be enabled by default.
When domain logons = Yes the default setting for this parameter is Yes, with the result that Samba will be a PDC. If domain master = No, Samba will function as a BDC. In general, this parameter should be set to 'No' only on a BDC.
Default: domain master = auto
dont descend (S)
Note that Samba can be very fussy about the exact format of the "dont descend" entries. For example you may need ./proc instead of just /proc. Experimentation is the best policy :-)
Default: dont descend =
Example: dont descend = /proc,/dev
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 = no
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 = no
dos filetimes (S)
Default: dos filetimes = yes
ea support (S)
Default: ea support = no
enable asu support (G)
Default: enable asu support = no
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 = yes
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 security = [server|domain|ads] parameter which causes smbd to authenticate against another server.
Default: encrypt passwords = yes
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 = yes
enumports command (G)
Default: enumports command =
Example: enumports command = /usr/bin/listports
eventlog list (G)
The administrator must use an external process to parse the normal Unix logs such as /var/log/messages and write then entries to the eventlog tdb files. Refer to the eventlogadm(8) utility for how to write eventlog entries.
Default: eventlog list =
Example: eventlog list = Security Application Syslog Apache
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 = no
fake oplocks (S)
When you set fake oplocks = yes, 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 oplocks 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 = no
follow symlinks (S)
This option is enabled (i.e. smbd will follow symbolic links) by default.
Default: follow symlinks = yes
force create mode (S)
The example below would force all 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 = 000
Example: force create mode = 0755
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 = 000
Example: force directory mode = 0755
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 directory security mask, 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.
Note
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 as 0000.
Default:
force directory security mode = 0
Example: force directory security mode = 700
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 force group = +sys 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 force user parameter is also set the group specified in force group will override the primary group set in force user.
Default: force group =
Example: force group = agroup
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 = no
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 security mask, 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 = 0
Example: force security mode = 700
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 = no
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 =
Example: force user = auser
fstype (S)
Default: fstype = NTFS
Example: fstype = Samba
get quota command (G)
This option is only available with was used 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 = /usr/local/sbin/query_quota
getwd cache (G)
Default: getwd cache = yes
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 su - command) and trying to print using the system print command such as lpr(1) or lp(1).
This parameter does not accept % macros, because many parts of the system require this value to be constant for correct operation.
Default: guest account = nobody # default can be changed at compile-time
Example: guest account = ftp
public
guest ok (S)
This paramater nullifies the benifits of setting restrict anonymous = 2
See the section below on security for more information about this option.
Default: guest ok = no
only guest
guest only (S)
See the section below on security for more information about this option.
Default: guest only = no
hide dot files (S)
Default: hide dot files = yes
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 = # no file are hidden
hide special files (S)
Default: hide special files = no
hide unreadable (S)
Default: hide unreadable = no
hide unwriteable files (S)
Default: hide unwriteable files = no
homedir map (G)
username server:/some/file/systemand 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.
Note
A working NIS client is required on the system for this option to work.
Default:
homedir map =
Example: homedir map = amd.homedir
host msdfs (G)
See also the msdfs root 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 = yes
hostname lookups (G)
Default: hostname lookups = no
Example: hostname lookups = yes
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 allow hosts = 150.203.5.. The full syntax of the list is described in the man page hosts_access(5). 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 hosts deny 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
hosts allow = 150.203. EXCEPT 150.203.6.66
Example 2: allow hosts that match the given network/netmask
hosts allow = 150.203.15.0/255.255.255.0
Example 3: allow a couple of hosts
hosts allow = lapland, arvidsjaur
Example 4: allow only hosts in NIS netgroup "foonet", but deny access from one particular host
hosts allow = @foonet
hosts deny = pirate
Note
Note that access still requires suitable user-level passwords.
See
testparm(1)
for a way of testing your host access to see if it does what you expect.
Default: hosts allow = # none (i.e., all hosts permitted access)
Example: hosts allow = 150.203.5. myhost.mynet.edu.au
deny hosts
hosts deny (S)
In the event that it is necessary to deny all by default, use the keyword ALL (or the netmask 0.0.0.0/0) and then explicitly specify to the hosts allow = hosts allow parameter those hosts that should be permitted access.
Default: hosts deny = # none (i.e., no hosts specifically excluded)
Example: hosts deny = 150.203.4. badhost.mynet.edu.au
idmap alloc backend (G)
Also refer to the idmap alloc config option.
No default
Example: idmap alloc backend = tdb
idmap alloc config (G)
No default
idmap backend (G)
Examples of SID/uid/gid backends include tdb (idmap_tdb(8)), ldap (idmap_ldap(8)), rid (idmap_rid(8)), and ad (idmap_tdb(8)).
Default: idmap backend = tdb
idmap cache time (G)
Default: idmap cache time = 900
idmap config (G)
backend = backend_name
default = [yes|no]
readonly = [yes|no]
idmap domains = CORP TRUSTEDDOMAINS
idmap config CORP:backend = ad
idmap config CORP:readonly = yes
idmap config TRUSTEDDOMAINS:backend = tdb
idmap config TRUSTEDDOMAINS:default = yes
idmap config TRUSTEDDOMAINS:range = 1000 - 9999
No default
idmap domains (G)
Values consist of the short domain name for Winbind's primary or collection of trusted domains. You may also use an arbitrary string to represent a catchall domain backend for any domain not explicitly listed.
Refer to the idmap config for details about managing the SID/uid/gid backend for each domain.
No default
Example: idmap domains = default AD CORP
winbind gid
idmap gid (G)
See also the idmap backend, idmap domains, and idmap config options.
Default: idmap gid =
Example: idmap gid = 10000-20000
idmap negative cache time (G)
Default: idmap negative cache time = 120
winbind uid
idmap uid (G)
See also the idmap backend, idmap domains, and idmap config options.
Default: idmap uid =
Example: idmap uid = 10000-20000
include (G)
It takes the standard substitutions, except %u, %P and %S.
Default: include =
Example: include = /usr/local/samba/lib/admin_smb.conf
inherit acls (S)
Default: inherit acls = no
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 = no
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 map archive, map hidden and map system 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 = no
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 =
Example: interfaces = eth0 192.168.2.10/24 192.168.3.10/255.255.255.0
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 = # no invalid users
Example: invalid users = root fred admin @wheel
iprint server (G)
If set, this option overrides the ServerName option in the CUPS client.conf. This is necessary if you have virtual samba servers that connect to different CUPS daemons.
Default: iprint server = ""
Example: iprint server = MYCUPSSERVER
keepalive (G)
Keepalives should, in general, not be needed if the socket has the SO_KEEPALIVE attribute set on it by default. (see socket options). Basically you should only use this option if you strike difficulties.
Default: keepalive = 300
Example: keepalive = 600
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 = yes
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 = yes
lanman auth (G)
The LANMAN encrypted response is easily broken, due to it's 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 encrypt passwords option, this parameter cannot alter client behaviour, and the LANMAN response will still be sent over the network. See the client lanman auth to disable this for Samba's clients (such as smbclient)
If this option, and ntlm auth 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 = yes
large readwrite (G)
Default: large readwrite = yes
ldap admin dn (G)
The ldap admin dn requires a fully specified DN. The ldap suffix is not appended to the ldap admin dn.
No default
ldap delete dn (G)
Default: ldap delete dn = no
ldap group suffix (G)
Default: ldap group suffix =
Example: ldap group suffix = ou=Groups
ldap idmap suffix (G)
Default: ldap idmap suffix =
Example: ldap idmap suffix = ou=Idmap
ldap machine suffix (G)
Default: ldap machine suffix =
Example: ldap machine suffix = ou=Computers
ldap passwd sync (G)
The ldap passwd sync 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 = 1000
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 net sam provision. 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 ldapsam:trusted = yes option is usually sufficient to use ldapsam:editposix = yes as well.
An example configuration can be the following:
encrypt passwords = true
passdb backend = ldapsam
ldapsam:trusted=yes
ldapsam:editposix=yes
ldap admin dn = cn=admin,dc=samba,dc=org
ldap delete dn = yes
ldap group suffix = ou=groups
ldap idmap suffix = ou=idmap
ldap machine suffix = ou=computers
ldap user suffix = ou=users
ldap suffix = dc=samba,dc=org
idmap backend = ldap:"ldap://localhost"
idmap uid = 5000-50000
idmap gid = 5000-50000
This configuration assume the ldap server have been loaded with a base tree 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 = no
ldapsam:trusted (G)
To make Samba scale well in large environments, the ldapsam:trusted = yes option assumes that the complete user and group database that is relevant to Samba is stored in LDAP with the standard posixAccount/posixGroup attributes. It further assumes that the Samba auxiliary object classes are stored together with the POSIX data in the same LDAP object. If these assumptions are met, ldapsam:trusted = yes can be activated and Samba can bypass the NSS system to query user group memberships. Optimized LDAP queries can greatly speed up domain logon and administration tasks. Depending on the size of the LDAP database a factor of 100 or more for common queries is easily achieved.
Default: ldapsam:trusted = no
ldap ssl (G)
The ldap ssl can be set to one of three values:
ldap suffix (G)
The ldap suffix will be appended to the values specified for the ldap user suffix, ldap group suffix, ldap machine suffix, and the ldap idmap suffix. Each of these should be given only a DN relative to the ldap suffix.
Default: ldap suffix =
Example: ldap suffix = dc=samba,dc=org
ldap timeout (G)
Default: ldap timeout = 15
ldap user suffix (G)
Default: ldap user suffix =
Example: ldap user suffix = ou=people
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 kernel oplocks are supported then level2 oplocks are not granted (even if this parameter is set to yes). Note also, the oplocks parameter must be set to yes on this share in order for this parameter to have any effect.
Default: level2 oplocks = yes
lm announce (G)
Default: lm announce = auto
Example: lm announce = yes
lm interval (G)
Default: lm interval = 60
Example: lm interval = 120
load printers (G)
Default: load printers = yes
local master (G)
Setting this value to no will cause nmbd never to become a local master browser.
Default: local master = yes
lock dir
lock directory (G)
Default: lock directory = ${prefix}/var/locks
Example: lock directory = /var/run/samba/locks
locking (S)
If locking = no, 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 locking = yes, 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 = 0
lock spin time (G)
Default: lock spin time = 200
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 = /usr/local/samba/var/log.%m
debuglevel
log level (G)
The default will be the log level specified on the command line or level zero if none was specified.
No default
Example: log level = 3 passdb:5 auth:10 winbind:2
logon drive (G)
Note that this option is only useful if Samba is set up as a logon server.
Default: logon drive =
Example: logon drive = h:
logon home (G)
C:>NET USE H: /HOME
from a command prompt, for example.
This option takes the standard substitutions, allowing you to have separate logon scripts for each user or machine.
This parameter can be used with Win9X workstations to ensure that roaming profiles are stored in a subdirectory of the user's home directory. This is done in the following way:
logon home = \\%N\%U\profile
This tells Samba to return the above string, with substitutions made when a client requests the info, generally in a NetUserGetInfo request. Win9X clients truncate the info to \serverhare when a user does net use /home but use the whole string when dealing with profiles.
Note that in prior versions of Samba, the logon path was returned rather than logon home. This broke net use /home but allowed profiles outside the home directory. The current implementation is correct, and can be used for profiles if you use the above trick.
Disable this feature by setting logon home = "" - using the empty string.
This option is only useful if Samba is set up as a logon server.
Default: logon home = \\%N\%U
Example: logon home = \\remote_smb_server\%U
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", desktop, start menu, network neighborhood, programs and other folders, and their contents, are loaded and displayed on your Windows NT client.
The share and the path must be readable by the user for the preferences and directories to be loaded onto the Windows NT client. The share must be writeable when the user logs in for the first time, in order that the Windows NT client can create the NTuser.dat and other directories. Thereafter, the directories and any of the contents can, if required, be made read-only. It is not advisable that the NTuser.dat file be made read-only - rename it to NTuser.man to achieve the desired effect (a MANdatory profile).
Windows clients can sometimes maintain a connection to the [homes] share, even though there is no user logged in. Therefore, it is vital that the logon path does not include a reference to the homes share (i.e. setting this parameter to \%Nfile_path will cause problems).
This option takes the standard substitutions, allowing you to have separate logon scripts for each user or machine.
Warning
Do not quote the value. Setting this as
\%N
rofileU
will break profile handling. Where the tdbsam or ldapsam passdb backend is used, at the time the user account is created the value configured for this parameter is written to the passdb backend and that value will over-ride the parameter value present in the smb.conf file. Any error present in the passdb backend account record must be editted using the appropriate tool (pdbedit on the command-line, or any other locally provided system tool).
Note that this option is only useful if Samba is set up as a domain controller.
Disable the use of roaming profiles by setting the value of this parameter to the empty string. For example, logon path = "". 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 = \PROFILESERVERPROFILEU
Default: logon path = \\%N\%U\profile
logon script (G)
The script must be a relative path to the [netlogon] service. If the [netlogon] service specifies a path of /usr/local/samba/netlogon, and logon script = STARTUP.BAT, then the file that will be downloaded is:
/usr/local/samba/netlogon/STARTUP.BAT
The contents of the batch file are entirely your choice. A suggested command would be to add NET TIME \\SERVER /SET /YES, to force every machine to synchronize clocks with the same time server. Another use would be to add NET USE U: \\SERVER\UTILS for commonly used utilities, or
NET USE Q: \SERVERISO9001_QAfor 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 =
Example: logon script = scripts\%U.bat
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 = # Currently no default value is given to this string, unless the value of the printing parameter is \fBSYSV\fR, in which case the default is : lp -i %p-%j -H hold or if the value of the \fIprinting\fR parameter is \fBSOFTQ\fR, then the default is: qstat -s -j%j -h.
Example: lppause command = /usr/bin/lpalt %p-%j -p0
lpq cache time (G)
The cache files are stored in /tmp/lpq.xxxx where xxxx is a hash of the lpq command in use.
The default is 30 seconds, meaning that the cached results of a previous identical lpq command will be used if the cached data is less than 30 seconds old. A large value may be advisable if your lpq command is very slow.
A value of 0 will disable caching completely.
Default: lpq cache time = 30
Example: lpq cache time = 10
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 =
Example: lpq command = /usr/bin/lpq -P%p
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 lppause command 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 printing 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 :
lp -i %p-%j -H resume
or if the value of the printing parameter is SOFTQ, then the default is:
qstat -s -j%j -r
Default: lpresume command = lpresume command = /usr/bin/lpalt %p-%j -p2
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 = determined by printing parameter
machine password timeout (G)
See also smbpasswd(8), and the security = domain parameter.
Default: machine password timeout = 604800
magic output (S)
Warning
If two clients use the same
magic script
in the same directory the output file content is undefined.
Default:
magic output = <magic script name>.out
Example: magic output = myfile.txt
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 magic output 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 =
Example: magic script = user.csh
mangled map (S)
So to map html to htm you would use:
mangled map = (*.html *.htm).
One very useful case is to remove the annoying ;1 off the ends of filenames on some CDROMs (only visible under some UNIXes). To do this use a map of (*;1 *;).
Default: mangled map = # no mangled map
Example: mangled map = (*;1 *;)
mangled names (S)
See the section on name mangling 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 mangling char 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 = yes
mangle prefix (G)
mangle prefix is effective only when mangling method is hash2.
Default: mangle prefix = 1
Example: mangle prefix = 4
mangling char (S)
Default: mangling char = ~
Example: mangling char = ^
mangling method (G)
Default: mangling method = hash2
Example: mangling method = hash
map acl inherit (S)
Default: map acl inherit = no
map archive (S)
Note that this requires the create mask parameter to be set such that owner execute bit is not masked out (i.e. it must include 100). See the parameter create mask for details.
Default: map archive = yes
map hidden (S)
Note that this requires the create mask to be set such that the world execute bit is not masked out (i.e. it must include 001). See the parameter create mask 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 store dos attributes is set to No, or no extended attribute is present. If store dos attributes 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.
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 store dos attributes method. This may be useful for exporting mounted CDs.
map system (S)
Note that this requires the create mask to be set such that the group execute bit is not masked out (i.e. it must include 010). See the parameter create mask for details.
Default: map system = no
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 = Never
Example: map to guest = Bad User
max connections (S)
Record lock files are used to implement this feature. The lock files will be stored in the directory specified by the lock directory option.
Default: max connections = 0
Example: max connections = 10
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 = 0
Example: max disk size = 1000
max log size (G)
A size of 0 means no limit.
Default: max log size = 5000
Example: max log size = 1000
max mux (G)
Default: max mux = 50
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 = 10000
max print jobs (S)
Default: max print jobs = 1000
Example: max print jobs = 5000
protocol
max protocol (G)
Possible values are :
Default: max protocol = NT1
Example: max protocol = LANMAN1
max reported print jobs (S)
Default: max reported print jobs = 0
Example: max reported print jobs = 1000
max smbd processes (G)
Default: max smbd processes = 0
Example: max smbd processes = 1000
max stat cache size (G)
Default: max stat cache size = 1024
Example: max stat cache size = 100
max ttl (G)
Default: max ttl = 259200
max wins ttl (G)
Default: max wins ttl = 518400
max xmit (G)
Default: max xmit = 16644
Example: max xmit = 8192
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:
message command = csh -c 'xedit %s;rm %s' &
This delivers the message using xedit, then removes it afterwards. NOTE THAT IT IS VERY IMPORTANT THAT THIS COMMAND RETURN IMMEDIATELY. That's why I have the '&' on the end. If it doesn't return immediately then your PCs may freeze when sending messages (they should recover after 30 seconds, hopefully).
All messages are delivered as the global guest user. The command takes the standard substitutions, although %u won't work (%U may be better in this case).
Apart from the standard substitutions, some additional ones apply. In particular:
Here's a way of sending the messages as mail to root:
message command = /bin/mail -s 'message from %f on %m' root < %s; rm %s
If you don't have a message command then the message won't be delivered and Samba will tell the sender there was an error. Unfortunately WfWg totally ignores the error code and carries on regardless, saying that the message was delivered.
If you want to silently delete it then try:
message command = rm %s
Default: message command =
Example: message command = csh -c 'xedit %s; rm %s' &
min print space (S)
Default: min print space = 0
Example: min print space = 2000
min protocol (G)
If you are viewing this parameter as a security measure, you should also refer to the lanman auth parameter. Otherwise, you should never need to change this parameter.
Default: min protocol = CORE
Example: min protocol = NT1
min wins ttl (G)
Default: min wins ttl = 21600
msdfs proxy (S)
Only Dfs roots can act as proxy shares. Take a look at the msdfs root and host msdfs options to find out how to set up a Dfs root share.
No default
Example: msdfs proxy = \\otherserver\someshare
msdfs root (S)
Default: msdfs root = no
name cache timeout (G)
Default: name cache timeout = 660
Example: name cache timeout = 0
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 /etc/hosts , NIS, or DNS lookups. This method of name resolution is operating system depended for instance on IRIX or Solaris this may be controlled by the /etc/nsswitch.conf file. Note that this method is used only if the NetBIOS name type being queried is the 0x20 (server) name type or 0x1c (domain controllers). The latter case is only useful for active directory domains and results in a DNS query for the SRV RR entry matching _ldap._tcp.domain.
When Samba is functioning in ADS security mode (security = ads) it is advised to use following settings for name resolve order:
name resolve order = wins bcast
DC lookups will still be done via DNS, but fallbacks to netbios names will not inundate your DNS servers with needless querys for DOMAIN<0x1c> lookups.
Default: name resolve order = lmhosts host wins bcast
Example: name resolve order = lmhosts bcast host
netbios aliases (G)
Default: netbios aliases = # empty string (no additional names)
Example: netbios aliases = TEST TEST1 TEST2
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 PIPE. To avoid this problem, do not name your Samba-3 server PIPE.
Default: netbios name = # machine DNS name
Example: netbios name = MYNAME
netbios scope (G)
Default: netbios scope =
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 homedir map 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 = no
nt acl support (S)
Default: nt acl support = yes
ntlm auth (G)
If this option, and lanman auth are both disabled, then only NTLMv2 logins will be permited. Not all clients support NTLMv2, and most will require special configuration to us it.
Default: ntlm auth = yes
nt pipe support (G)
Default: nt pipe support = yes
nt status support (G)
You should not need to ever disable this parameter.
Default: nt status support = yes
null passwords (G)
See also smbpasswd(5).
Default: null passwords = no
obey pam restrictions (G)
Default: obey pam restrictions = no
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 user = %S which means your user list will be just the service name, which for home directories is the name of the user.
Default: only user = no
open files database hash size (G)
Default: open files database hash size = 10007
Example: open files database hash size = 1338457
oplock break wait time (G)
Warning
DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ AND UNDERSTOOD THE SAMBA OPLOCK CODE.
Default:
oplock break wait time = 0
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 smbd to behave in a similar way to Windows NT.
Warning
DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ AND UNDERSTOOD THE SAMBA OPLOCK CODE.
Default:
oplock contention limit = 2
oplocks (S)
Oplocks may be selectively turned off on certain files with a share. See the veto oplock files 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 kernel oplocks parameter for details.
Default: oplocks = yes
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 HP LaserJet 5L = LASERJET.HP LaserJet 5L.
The need for the file is due to the printer driver namespace problem described in the chapter on Classical Printing in the Samba3-HOWTO book. For more details on OS/2 clients, please refer to chapter on other clients in the Samba3-HOWTO book.
Default: os2 driver map =
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 over-ride the default setting. Please refer to chapter 9 of the Samba-3 HOWTO document for further information regarding the use of this parameter.
Default: os level = 20
Example: os level = 65
pam password change (G)
Default: pam password change = no
panic action (G)
Default: panic action =
Example: panic action = "/bin/sleep 90000"
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 = yes
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 ldap ssl) or by specifying ldaps:// in the URL argument.
Multiple servers may also be specified in double-quotes, if your LDAP libraries supports the LDAP URL notation. (OpenLDAP does).
Examples of use are:
passdb backend = tdbsam:/etc/samba/private/passdb.tdb or passdb backend = ldapsam:"ldap://ldap-1.example.com ldap://ldap-2.example.com"Default: passdb backend = smbpasswd
passdb expand explicit (G)
Default: passdb expand explicit = no
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 only used if the unix password sync 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 passwd program must be executed on the NIS master.
The string can contain the macro %n which is substituted for the new password. The chat sequence can also contain the standard macros , and 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 pam password change 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 macro is ignored for PAM conversions.
Default: passwd chat = *new*password* %n\n*new*password* %n\n *changed*
Example: passwd chat = "*Enter OLD password*" %o\n "*Enter NEW password*" %n\n "*Reenter NEW password*" %n\n "*Password changed*"
passwd chat debug (G)
Default: passwd chat debug = no
passwd chat timeout (G)
Default: passwd chat timeout = 2
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 smbd will fail to change the SMB password also (this is by design).
If the unix password sync parameter is set this parameter MUST USE ABSOLUTE PATHS for ALL programs called, and must be examined for security implications. Note that by default unix password sync is set to no.
Default: passwd program =
Example: passwd program = /bin/passwd %u
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 encrypt passwords = No.
Default: password level = 0
Example: password level = 4
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 name resolve order 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.
Note
Using a password server means your UNIX box (running Samba) is only as secure as your password server.
DO NOT CHOOSE A PASSWORD SERVER THAT YOU DON'T COMPLETELY TRUST.
Never point a Samba server at itself for password serving. This will cause a loop and could lock up your Samba server!
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 security = domain is that if you list several hosts in the password server option then smbd will try each in turn till it finds one that responds. This is useful in case your primary server goes down.
If the 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 security = domain doesn't suffer from:
Example: password server = NT-PDC, NT-BDC1, NT-BDC2, *
Example: password server = windc.mydomain.com:389 192.168.1.101 *
Example: password server = *
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 root dir if one was specified.
Default: path =
Example: path = /home/fred
pid directory (G)
Default: pid directory = ${prefix}/var/locks
Example: pid directory = pid directory = /var/run/
posix locking (S)
Default: posix locking = yes
postexec (S)
An interesting example may be to unmount server resources:
postexec = /etc/umount /cdrom
Default: postexec =
Example: postexec = echo \"%u disconnected from %S from %m (%I)\" >> /tmp/log
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:
preexec = csh -c 'echo \"Welcome to %S!\" | /usr/local/samba/bin/smbclient -M %m -I %I' &
Of course, this could get annoying after a while :-)
See also preexec close and postexec.
Default: preexec =
Example: preexec = echo \"%u connected to %S from %m (%I)\" >> /tmp/log
preexec close (S)
Default: preexec close = no
prefered master
preferred master (G)
If this is set to yes, on startup, nmbd will force an election, and it will have a slight advantage in winning the election. It is recommended that this parameter is used in conjunction with domain master = yes, so that nmbd can guarantee becoming a domain master.
Use this option with caution, because if there are several hosts (whether Samba servers, Windows 95 or NT) that are preferred master browsers on the same subnet, they will each periodically and continuously attempt to become the local master browser. This will result in unnecessary broadcast traffic and reduced browsing capabilities.
Default: preferred master = auto
auto services
preload (G)
Note that if you just want all printers in your printcap file loaded then the load printers option is easier.
Default: preload =
Example: preload = fred lp colorlp
preload modules (G)
Default: preload modules =
Example: preload modules = /usr/lib/samba/passdb/mysql.so
preserve case (S)
See the section on NAME MANGLING for a fuller discussion.
Default: preserve case = yes
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 read only parameter controls only non-printing access to the resource.
Default: printable = no
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 = 750
Example: printcap cache time = 600
printcap
printcap name (S)
To use the CUPS printing interface set printcap name = cups. This should be supplemented by an addtional setting printing = cups in the [global] section. printcap name = cups will use the "dummy" printcap created by CUPS, as specified in your CUPS configuration file.
On System V systems that use lpstat to list available printers you can use printcap name = lpstat to automatically obtain lists of available printers. This is the default for systems that define SYSV at configure time in Samba (this includes most System V based systems). If printcap name is set to lpstat on these systems then Samba will launch lpstat -v and attempt to parse the output to obtain a printer list.
A minimal printcap file would look something like this:
print1|My Printer 1 print2|My Printer 2 print3|My Printer 3 print4|My Printer 4 print5|My Printer 5where 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.
Note
Under AIX the default printcap name is
/etc/qconfig. Samba will assume the file is in AIX
qconfig
format if the string
qconfig
appears in the printcap filename.
Default:
printcap name = /etc/printcap
Example: printcap name = /etc/myprintcap
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 guest account 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.
print command = echo Printing %s >> /tmp/print.log; lpr -P %p %s; rm %s
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 printing parameter.
Default: For printing = BSD, AIX, QNX, LPRNG or PLP :
print command = lpr -r -P%p %s
For printing = SYSV or HPUX :
print command = lp -c -d%p %s; rm %s
For printing = SOFTQ :
print command = lp -d%p -s %s; rm %s
For printing = CUPS : If SAMBA is compiled against libcups, then printcap = cups 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 lp -c -d%p -oraw; rm %s. With printing = cups, and if SAMBA is compiled against libcups, any manually set print command will be ignored.
No default
Example: print command = /usr/local/samba/bin/myprintscript %p %s
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 =
Example: printer admin = admin, @staff
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 printer name may be lp on many systems.
Default: printer name = none
Example: printer name = laserwriter
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.
No default
printjob username (S)
Default: printjob username = %U
Example: printjob username = %D\%U
private dir (G)
Default: private dir = ${prefix}/private
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 = no
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 = disable %p
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 =
Example: queueresume command = enable %p
read bmpx (G)
Default: read bmpx = no
read list (S)
This parameter will not work with the security = share in Samba 3.0. This is by design.
Default: read list =
Example: read list = mary, @students
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 (printable = yes) will ALWAYS allow writing to the directory (user privileges permitting), but only via spooling operations.
Default: read only = yes
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 = yes
realm (G)
Default: realm =
Example: realm = mysambabox.mycompany.com
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:
remote announce = 192.168.2.255/SERVERS 192.168.4.255/STAFFthe above line would cause nmbd to announce itself to the two given IP addresses using the given workgroup names. If you leave out the workgroup name then the one given in the workgroup 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 =
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.255the above line would cause nmbd to request the master browser on the specified subnets or addresses to synchronize their browse lists with the local server.
The IP addresses you choose would normally be the broadcast addresses of the remote networks, but can also be the IP addresses of known browse masters if your network config is that stable. If a machine IP address is given Samba makes NO attempt to validate that the remote machine is available, is listening, nor that it is in fact the browse master on its segment.
The remote browse sync 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 =
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, %uold and %unew, will be substituted with the old and new usernames, respectively. The script should return 0 upon successful completion, and nonzero otherwise.
Note
The script has all responsibility to rename all the necessary data that is accessible in this posix method. This can mean different requirements for different backends. The tdbsam and smbpasswd backends will take care of the contents of their respective files, so the script is responsible only for changing the POSIX username, and other data that may required for your circumstances, such as home directory. Please also consider whether or not you need to rename the actual home directories themselves. The ldapsam backend will not make any changes, because of the potential issues with renaming the LDAP naming attribute. In this case the script is responsible for changing the attribute that samba uses (uid) for locating users, as well as any data that needs to change for other applications using the same directory.
Default:
rename user script = no
reset on zero vc (G)
Default: reset on zero vc = no
restrict anonymous (G)
HKEY_LOCAL_MACHINESYSTEMCurrentControlSet Controlamba, 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.
Note The security advantage of using restrict anonymous = 2 is removed by setting guest ok = yes on any share. Default: restrict anonymous = 0
Default: shutdown script =
Example: shutdown script = /usr/local/samba/sbin/shutdown %m %t %r %f
smb passwd file (G)
An example of use is:
smb passwd file = /etc/samba/smbpasswd
Default: smb passwd file = ${prefix}/private/smbpasswd
smb ports (G)
Default: smb ports = 445 139
socket address (G)
By default Samba will accept connections on any address.
Default: socket address =
Example: socket address = 192.168.2.20
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 man setsockopt will help).
You may find that on some systems Samba will say "Unknown socket option" when you supply an option. This means you either incorrectly typed it or you need to add an include file to includes.h for your OS. If the latter is the case please send the patch to samba-technical@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 SO_SNDBUF = 8192. Note that you must not have any spaces before or after the = sign.
If you are on a local network then a sensible option might be:
socket options = IPTOS_LOWDELAY
If you have a local network then you could try:
socket options = IPTOS_LOWDELAY TCP_NODELAY
If you are on a wide area network then perhaps try setting IPTOS_THROUGHPUT.
Note that several of the options may cause your Samba server to fail completely. Use these options with caution!
Default: socket options = TCP_NODELAY
Example: socket options = IPTOS_LOWDELAY
stat cache (G)
Default: stat cache = yes
store dos attributes (S)
Default: store dos attributes = no
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 = no
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 inproved 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, strict locking = Auto or strict locking = no is acceptable.
Default: strict locking = Auto
strict sync (S)
Default: strict sync = no
svcctl list (G)
The administrator must create a directory name svcctl in Samba's $(libdir) and create symbolic links to the init scripts in /etc/init.d/. The name of the links must match the names given as part of the svcctl list.
Default: svcctl list =
Example: svcctl list = cups postfix portmap httpd
sync always (S)
Default: sync always = no
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.
Default: syslog = 1
syslog only (G)
Default: syslog only = no
template homedir (G)
Default: template homedir = /home/%D/%U
template shell (G)
No default
time offset (G)
Default: time offset = 0
Example: time offset = 60
time server (G)
Default: time server = no
unix charset (G)
This is also the charset Samba will use when specifying arguments to scripts that it invokes.
Default: unix charset = UTF8
Example: unix charset = ASCII
unix extensions (G)
Default: unix extensions = yes
unix password sync (G)
Default: unix password sync = no
update encrypted (G)
In order for this parameter to be operative the encrypt passwords parameter must be set to no. The default value of encrypt passwords = Yes. Note: This must be set to no for this update encrypted to work.
Note that even when this parameter is set a user authenticating to smbd must still enter a valid password in order to connect correctly, and to update their hashed (smbpasswd) passwords.
Default: update encrypted = no
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 able enabled on a print share which has valid print driver installed on the Samba server.
Default: use client driver = no
use kerberos keytab (G)
When you are using the heimdal Kerberos libraries, you must also specify the following in /etc/krb5.conf:
[libdefaults] default_keytab_name = FILE:/etc/krb5.keytab
Default: use kerberos keytab = False
use mmap (G)
Default: use mmap = yes
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 \serverhare%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 valid users 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 = # The guest account if a guest service, else <empty string>.
Example: username = fred, mary, jack, jane, @users, @pcgroup
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 = 0
Example: username level = 5
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 = DOMAINo).
The map file is parsed line by line. Each line should contain a single UNIX username on the left then a '=' followed by a list of usernames on the right. The list of usernames on the right may contain names of the form @group in which case they will match any UNIX username in that group. The special client name '*' is a wildcard and matches any name. Each line of the map file may be up to 1023 characters long.
The file is processed on each line by taking the supplied username and comparing it with each username on the right hand side of the '=' signs. If the supplied name matches any of the names on the right hand side then it is replaced with the name on the left. Processing then continues with the next line.
If any line begins with a '#' or a ';' then it is ignored.
If any line begins with an '!' then the processing will stop after that line if a mapping was done by the line. Otherwise mapping continues with every line being processed. Using '!' is most useful when you have a wildcard mapping line later in the file.
For example to map from the name admin or administrator to the UNIX name root you would use:
root = admin administratorOr to map anyone in the UNIX group system to the UNIX name sys you would use:
sys = @system
You can have as many mappings as you like in a username map file.
If your system supports the NIS NETGROUP option then the netgroup database is checked before the /etc/group database for matching groups.
You can map Windows usernames that have spaces in them by using double quotes around the name. For example:
tridge = "Andrew Tridgell"would map the windows username "Andrew Tridgell" to the unix username "tridge".
The following example would map mary and fred to the unix user sys, and map the rest to guest. Note the use of the '!' to tell Samba to stop processing if it gets a match on that line:
!sys = mary fred guest = *
Note that the remapping is applied to all occurrences of usernames. Thus if you connect to \servered and fred is remapped to mary then you will actually be connecting to \servermary and will need to supply a password suitable for mary not fred. The only exception to this is the username passed to the password server (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.: DOMAINser) 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. DOMAINser) only after the user has been successfully authenticated.
An example of use is:
username map = /usr/local/samba/lib/users.map
Default: username map = # no username map
username map script (G)
Default: username map script =
Example: username map script = /etc/samba/scripts/mapusers.sh
usershare allow guests (G)
Default: usershare allow guests = no
usershare max shares (G)
Default: usershare max shares = 0
usershare owner only (G)
Default: usershare owner only = True
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 = NULL
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 = NULL
Example: usershare prefix allow list = /home /data /space
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 = NULL
Example: usershare prefix deny list = /etc /dev /private
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 = NULL
Example: usershare template share = template_share
use sendfile (S)
Default: use sendfile = false
use spnego (G)
Unless further issues are discovered with our SPNEGO implementation, there is no reason this should ever be disabled.
Default: use spnego = yes
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 = no
utmp directory (G)
Default: utmp directory = # Determined automatically
Example: utmp directory = /var/run/utmp
-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 = yes
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 = # No valid users list (anyone can login)
Example: valid users = greg, @pcusers
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 case sensitive 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 delete veto files 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 = No files or directories are vetoed.
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 .SEM. 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 = # No files are vetoed for oplock grants
vfs object
vfs objects (S)
Default: vfs objects =
Example: vfs objects = extd_audit recycle
volume (S)
Default: volume = # the name of the share
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 = yes
winbind cache time (G)
This does not apply to authentication requests, these are always evaluated in real time unless the winbind offline logon option has been enabled.
Default: winbind cache time = 300
winbind enum groups (G)
Warning
Turning off group enumeration may cause some programs to behave oddly.
Default:
winbind enum groups = no
winbind enum users (G)
Warning
Turning off user enumeration may cause some programs to behave oddly. For example, the finger program relies on having access to the full user list when searching for matching usernames.
Default:
winbind enum users = no
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 = 1
winbind nested groups (G)
Default: winbind nested groups = yes
winbind normalize names (G)
Default: winbind normalize names = no
Example: winbind normalize names = yes
winbind nss info (G)
Default: winbind nss info = template
Example: winbind nss info = template sfu
winbind offline logon (G)
Default: winbind offline logon = false
Example: winbind offline logon = true
winbind refresh tickets (G)
Default: winbind refresh tickets = false
Example: winbind refresh tickets = true
winbind rpc only (G)
Default: winbind rpc only = no
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 = '\'
Example: winbind separator = +
winbind trusted domains only (G)
This parameter is now deprecated in favor of the newer idmap_nss backend. Refer to the idmap domains smb.conf option and the idmap_nss(8) man page for more information.
Default: winbind trusted domains only = no
winbind use default domain (G)
Default: winbind use default domain = no
Example: winbind use default domain = yes
wins hook (G)
The wins hook parameter specifies the name of a script or executable that will be called as follows:
wins_hook operation name nametype ttl IP_list
No default
wins proxy (G)
Default: wins proxy = no
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.
Note
You need to set up Samba to point to a WINS server if you have multiple subnets and wish cross-subnet browsing to work correctly.
See the chapter in the Samba3-HOWTO on Network Browsing.
Default: wins server =
Example: wins server = mary: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.
Example: wins server = 192.9.200.1 192.168.2.61
wins support (G)
Default: wins support = no
workgroup (G)
Default: workgroup = WORKGROUP
Example: workgroup = MYGROUP
writable
writeable (S)
No default
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 = 0
Example: write cache size = 262144 # for a 256k cache size per file
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 security = share in Samba 3.0.
Default: write list =
Example: write list = admin, root, @staff
write raw (G)
Default: write raw = yes
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 /var/run/wtmp on Linux).
Default: wtmp directory =
Example: wtmp directory = /var/log/wtmp
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 [homes] and [printers] 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.0 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.
|
Закладки на сайте Проследить за страницей |
Created 1996-2024 by Maxim Chirkov Добавить, Поддержать, Вебмастеру |