smb.conf

Name

smb.conf — The configuration file for the Samba suite

SYNOPSIS

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.

FILE FORMAT

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 modes are numeric.

SECTION DESCRIPTIONS

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.

Note that 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 readonly, 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
-
-

SPECIAL SECTIONS

The [global] section

parameters in this section apply to the server - as a whole, or are defaults for sections which do not - specifically define certain items. See the notes - under PARAMETERS for more information.

The [homes] section

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 - user name 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:

The share name is changed from homes to - the located username.
If no path was given, the path is set to - the user's home directory.

If you decide to use a path = line - in your [homes] section then you may find it useful - to use the %S macro. For example :

path = /data/pchome/%S

would be 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 - would be wise to also specify read only - access.

Note that 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.

The [printers] section

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 share name is set to the located printer - name
If no printer name was given, the printer name - is set to the located printer name
If the share does not permit guest access and - no username was given, the username is set to the located - printer name.

Note that the [printers] service MUST be - printable - if you specify otherwise, the server will refuse - to load the configuration file.

Typically the path specified would be that of a - world-writeable spool directory with the sticky bit set on - it. A typical [printers] entry would look 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 then 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.

PARAMETERS

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 mode). 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. Note that 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.

VARIABLE SUBSTITUTIONS

Many of the strings that are settable in the config file - can take substitutions. For example the option "path = - /tmp/%u" would be 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

session user name (the user name that the client - wanted, not necessarily the same as the one they got).

%G

primary group name of %U.

%h

the Internet hostname that Samba is running - on.

%m

the NetBIOS name of the client machine - (very useful).

%L

the NetBIOS name of the server. This allows you - to change your config based on what the client calls you. Your - server can have a "dual personality".

Note that this parameter is not available when Samba listens - on port 445, as clients no longer send this information

%M

the Internet name of the client machine. -

%R

the selected protocol level after - protocol negotiation. It can be one of CORE, COREPLUS, - LANMAN1, LANMAN2 or NT1.

%d

The process id of the current server - process.

%a

the architecture of the remote - machine. Only some are recognized, and those may not be - 100% reliable. It currently recognizes Samba, WfWg, Win95, - WinNT and Win2k. Anything else will be known as - "UNKNOWN". If it gets it wrong then sending a level - 3 log to samba@samba.org - should allow it to be fixed.

%I

The IP address of the client machine.

%T

the current date and time.

%D

Name of the domain or workgroup of the current user.

%$(envvar)

The value of the environment variable - envar.

The following substitutes apply only to some configuration options(only those - that are used when a connection has been established):

%S: the name of the current service, if any.
%P: the root directory of the current service, - if any.
%u: user name of the current service, if any.
%g: primary group name of %u.
%H: the home directory of the user given - by %u.
%N: the name of your NIS home directory server. - This is obtained from your NIS auto.map entry. If you have - not compiled Samba with the --with-automount - option then this value will be the same as %L.
%p: the path of the service's home directory, - obtained from your NIS auto.map entry. The NIS auto.map entry - is split up as "%N:%p".

There are some quite creative things that can be done - with these substitutions and other smb.conf options.

NAME MANGLING

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.

All of these options can be set separately for each service - (or globally, of course).

The options are:

mangle case = yes/no: controls if names that have characters that - aren't of the "default" case are mangled. For example, - if this is yes then a name like "Mail" would be mangled. - Default no.
case sensitive = yes/no: controls whether filenames are case sensitive. If - they aren't then Samba must do a filename search and match on passed - names. Default no.
default case = upper/lower: controls what the default case is for new - filenames. Default lower.
preserve case = yes/no: controls if new files are created with the - case that the client passes, or if they are forced to be the - "default" case. Default yes. -
short preserve case = yes/no: controls if new files which conform to 8.3 syntax, - that is all in upper case and of suitable length, are created - upper case, or if they are forced to be the "default" - case. This option can be use with "preserve case = yes" - to permit long filenames to retain their case, while short names - are lowercased. Default yes.

By default, Samba 3.0 has the same semantics as a Windows - NT server, in that it is case insensitive but case preserving.

NOTE ABOUT USERNAME/PASSWORD VALIDATION

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, then the connection request is rejected. However, if one of the - steps succeeds, then 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") - then steps 1 to 5 are skipped.

If the client has passed a username/password - pair and that username/password pair is validated by the UNIX - system's password programs then the connection is made as that - username. Note that this includes the - \\server\service%username method of passing - a username.
If the client has previously registered a username - with the system and now supplies a correct password for that - username then the connection is allowed.
The client's NetBIOS name and any previously - used user names are checked against the supplied password, if - they match then the connection is allowed as the corresponding - user.
If the client has previously validated a - username/password pair with the server and the client has passed - the validation token then that username is used.
If a "user = " field is given in the - smb.conf file for the service and the client - has supplied a password, and that password matches (according to - the UNIX system's password checking) with one of the usernames - from the "user =" field then the connection is made as - the username in the "user =" line. If one - of the username in the "user =" list begins with a - '@' then that name expands to a list of names in - the group of the same name.
If the service is a guest service then a - connection is made as the username given in the "guest - account =" for the service, irrespective of the - supplied password.

COMPLETE LIST OF GLOBAL PARAMETERS

Here is a list of all global parameters. See the section of - each parameter for details. Note that some are synonyms.

COMPLETE LIST OF SERVICE PARAMETERS

Here is a list of all service parameters. See the section on - each parameter for details. Note that some are synonyms.

EXPLANATION OF EACH PARAMETER

abort shutdown script (G)

This parameter only exists in the HEAD cvs branch - This a full path name to a script called by smbd(8) that - should stop a shutdown procedure issued by the .

This command will be run as user.

Default: None.

Example: abort shutdown script = /sbin/shutdown -c

acl compatibility (S)

This parameter specifies what OS ACL semantics should - be compatible with. Possible values are winnt for Windows NT 4, - win2k for Windows 2000 and above and auto. - If you specify auto, the value for this parameter - will be based upon the version of the client. There should - be no reason to change this parameter from the default.

Default: acl compatibility = Auto

Example: acl compatibility = win2k

add group script (G)

This is the full pathname to a script that will be run - AS ROOT by smbd(8) - when a new group is requested. It will expand any %g to the group name passed. This - script is only useful for installations using the Windows NT - domain administration tools. The script is free to create a - group with an arbitrary name to circumvent unix group name - restrictions. In that case the script must print the numeric gid - of the created group on stdout.

add machine script (G)

This is the full pathname to a script that will be run by - smbd(8) when a machine is added - to it's domain using the administrator username and password - method.

This option is only required when using sam back-ends tied - to the Unix uid method of RID calculation such as smbpasswd. - This option is only available in Samba 3.0.

Default: add machine script = <empty string>

Example: add machine script = /usr/sbin/adduser -n -g - machines -c Machine -d /dev/null -s /bin/false %u

addprinter command (G)

With the introduction of MS-RPC based printing - support for Windows NT/2000 clients in Samba 2.2, The MS Add - Printer Wizard (APW) icon is now also available in the - "Printers..." folder displayed a share listing. The APW - allows for printers to be add remotely to a Samba or Windows - NT/2000 print server.

For a Samba host this means that the printer must be - physically added to the underlying printing system. The 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):

printer name
share name
port name
driver name
location
Windows 9x driver location

All parameters are filled in from the PRINTER_INFO_2 structure sent - by the Windows NT/2000 client with one exception. The "Windows 9x - driver location" parameter is included for backwards compatibility - only. The remaining fields in the structure are generated from answers - to the APW questions.

Once the addprinter command has - been executed, smbd will reparse the - smb.conf to determine if the share defined by the APW - exists. If the sharename is still invalid, then smbd - will return an ACCESS_DENIED error to the client.

- The "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. -

See also the parameter.

Default: delete veto files = no

deny hosts (S)

Synonym for .

dfree command (G)

The dfree command setting - should only be used on systems where a problem occurs with the - internal disk space calculations. This has been known to happen - with Ultrix, but may occur with other operating systems. The - symptom that was seen was an error of "Abort Retry - Ignore" at the end of each directory listing.

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.

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!

Default: By default internal routines for - determining the disk capacity and remaining space will be used. -

Example: dfree command = /usr/local/samba/bin/dfree

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.

directory (S)

Synonym for .

directory mask (S)

This parameter is the octal modes which are - used when converting DOS modes to UNIX modes when creating UNIX - directories.

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 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 .

See the parameter to cause particular mode - bits to always be set on created directories.

See also the parameter for masking mode bits on created files, - and the parameter.

Also refer to the parameter.

Default: directory mask = 0755

Example: directory mask = 0775

directory mode (S)

Synonym for

directory security mask (S)

This parameter controls what UNIX permission bits - can be modified when a Windows NT client is manipulating the UNIX - permission on a directory using the native NT security dialog - box.

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. 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.

Note

Note that clients that only support netbios won't be able to - see your samba server when netbios support is disabled. -

Default: disable netbios = no

Example: disable netbios = yes

disable spoolss (G)

Enabling this parameter will disable Samba's support - for the SPOOLSS set of MS-RPC's and will yield identical behavior - as Samba 2.0.x. Windows NT/2000 clients will downgrade to using - Lanman style printing commands. Windows 9x/ME will be uneffected by - the parameter. However, this will also disable the ability to upload - printer drivers to a Samba server via the Windows NT Add Printer - Wizard or by using the NT printer properties dialog window. It will - also disable the capability of Windows NT/2000 clients to download - print drivers from the Samba host upon demand. - Be very careful about enabling this parameter. -

See also the parameter.

Default: force create mode = 000

Example: force create mode = 0755

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'.

force directory mode (S)

This parameter specifies a set of UNIX mode bit - permissions that will always be set on a directory - created by Samba. This is done by bitwise 'OR'ing these bits onto the - mode bits of a directory that is being created. The default for this - parameter is (in octal) 0000 which will not add any extra permission - bits to a created directory. This operation is done after the mode - mask in the parameter directory mask is - applied.

See also the parameter for details on masking mode bits - on created directories.

See also the parameter.

Default: force directory mode = 000

Example: force directory mode = 0755

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'.

force directory security mode (S)

This parameter controls what UNIX permission bits - can be modified when a Windows NT client is manipulating the UNIX - permission on a directory using the native NT security dialog box.

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. Essentially, one bits in this - mask may be treated as a set of bits that, when modifying security - on a directory, the user has always set to be 'on'.

If not set explicitly this parameter is 000, which - allows a user to modify all the user/group/world permissions on a - directory without restrictions.

See also .

Default: no forced group

Example: force group = agroup

force security mode (S)

This parameter controls what UNIX permission - bits can be modified when a Windows NT client is manipulating - the UNIX permission on a file using the native NT security dialog - box.

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.

See also

Default: no forced user

Example: force user = auser

fstype (S)

This parameter allows the administrator to - configure the string that specifies the type of filesystem a share - is using that is reported by smbd(8) when a client queries the filesystem type - for a share. The default type is NTFS for - compatibility with Windows NT but this can be changed to other - strings such as Samba or FAT - if required.

Default: fstype = NTFS

Example: fstype = Samba

get quota command (G)

The get quota command should only be used - whenever there is no operating system API available from the OS that - samba can use.

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:

directory
type of query
uid of user or gid of group

The type of query can be one of :

1 - user quotas
2 - user default quotas (uid = -1)
3 - group quotas
4 - group default quotas (gid = -1)

This script should print its output according to the following format:

Line 1 - quota flags (0 = no quotas, 1 = quotas enabled, 2 = quotas enabled and enforced)
Line 2 - number of currently used blocks
Line 3 - the softlimit number of blocks
Line 4 - the hardlimit number of blocks
Line 5 - currently used number of inodes
Line 6 - the softlimit number of inodes
Line 7 - the hardlimit number of inodes
Line 8(optional) - the number of bytes in a block(default is 1024)

Note

A working NIS client is required on - the system for this option to work.

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: none (i.e., all hosts permitted access)

Example: allow hosts = 150.203.5. myhost.mynet.edu.au

hosts deny (S)

The opposite of hosts allow - - hosts listed here are NOT permitted access to - services unless the specific services have their own lists to override - this one. Where the lists conflict, the allow - list takes precedence.

Default: none (i.e., no hosts specifically excluded)

Example: hosts deny = 150.203.4. badhost.mynet.edu.au

hosts equiv (G)

If this global parameter is a non-null string, - it specifies the name of a file to read for the names of hosts - and users who will be allowed access without specifying a password. -

This is not be confused with which is about hosts - access to services and is more useful for guest services. - hosts equiv may be useful for NT clients which will - not supply passwords to Samba.

Note

The use of hosts equiv - can be a major security hole. This is because you are - trusting the PC to supply the correct username. It is very easy to - get a PC to supply a false username. I recommend that the - hosts equiv option be only used if you really - know what you are doing, or perhaps on a home network where you trust - your spouse and kids. And only if you really trust - them :-).

Default: no host equivalences

Example: hosts equiv = /etc/hosts.equiv

idmap backend (G)

- The purpose of the idmap backend parameter is to allow idmap to NOT use the local idmap - tdb file to obtain SID to UID / GID mappings, but instead to obtain them from a common - LDAP backend. This way all domain members and controllers will have the same UID and GID - to SID mappings. This avoids the risk of UID / GID inconsistencies across UNIX / Linux - systems that are sharing information over protocols other than SMB/CIFS (ie: NFS). -

Default: idmap backend = <empty string>

Example: idmap backend = ldap:ldap://ldapslave.example.com

idmap gid (G)

The idmap gid parameter specifies the range of group ids that are allocated for - the purpose of mapping UNX groups to NT group SIDs. This range of group ids should have no - existing local or NIS groups within it as strange conflicts can occur otherwise.

The availability of an idmap gid range is essential for correct operation of - all group mapping.

Default: idmap gid = <empty string>

Example: idmap gid = 10000-20000

idmap uid (G)

The idmap uid parameter specifies the range of user ids that are allocated for use - in mapping UNIX users to NT user SIDs. This range of ids should have no existing local - or NIS users within it as strange conflicts can occur otherwise.

Default: idmap uid = <empty string>

Example: idmap uid = 10000-20000

include (G)

This allows you to include one config file - inside another. The file is included literally, as though typed - in place.

It takes the standard substitutions, except %u -, %P and %S. -

Default: no file included

Example: include = /usr/local/samba/lib/admin_smb.conf

inherit acls (S)

This parameter can be used to ensure that if default acls - exist on parent directories, they are always honored when creating a - subdirectory. The default behavior is to use the mode specified when - creating the directory. Enabling this option sets the mode to 0777, - thus guaranteeing that default directory acls are propagated. -

Default: inherit acls = no -

inherit permissions (S)

The permissions on new files and directories - are normally governed by , , and but the boolean inherit - permissions parameter overrides this.

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 - , and 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.

See also .

Default: all active interfaces except 127.0.0.1 - that are broadcast capable

invalid users (S)

This is a list of users that should not be allowed - to login to this service. This is really a paranoid - check to absolutely ensure an improper setting does not breach - your security.

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. 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.

See also .

Default: no invalid users

Example: invalid users = root fred admin @wheel

keepalive (G)

The value of the parameter (an integer) represents - the number of seconds between keepalive - packets. If this parameter is zero, no keepalive packets will be - sent. Keepalive packets, if sent, allow the server to tell whether - a client is still present and responding.

Keepalives should, in general, not be needed if the socket - being used has the SO_KEEPALIVE attribute set on it (see ). - Basically you should only use this option if you strike difficulties.

Default: keepalive = 300

Example: keepalive = 600

kernel change notify (G)

This parameter specifies whether Samba should ask the - kernel for change notifications in directories so that - SMB clients can refresh whenever the data on the server changes. -

This parameter is only usd when your kernel supports - change notification to user programs, using the F_NOTIFY fcntl. -

Default: Yes

kernel oplocks (G)

For UNIXes that support kernel based - (currently only IRIX and the Linux 2.4 kernel), this parameter - allows the use of them to be turned on or off.

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.

See also .

Default: lm announce = auto

Example: lm announce = yes

lm interval (G)

If Samba is set to produce Lanman announce - broadcasts needed by OS/2 clients (see the parameter) then this - parameter defines the frequency in seconds with which they will be - made. If this is set to zero then no Lanman announcements will be - made despite the setting of the lm announce - parameter.

See also .

Default: lm interval = 60

Example: lm interval = 120

load printers (G)

A boolean variable that controls whether all - printers in the printcap will be loaded for browsing by default. - See the section for - more details.

Default: load printers = yes

local master (G)

This option allows nmbd(8) to try and become a local master browser - on a subnet. If set to no then - nmbd will not attempt to become a local master browser - on a subnet and will also lose in all browsing elections. By - default this value is set to yes. Setting this value to - yes doesn't mean that Samba will become the - local master browser on a subnet, just that nmbd - will participate in elections for local master browser.

Setting this value to no will cause nmbd never to become a local - master browser.

Default: local master = yes

lock dir (G)

Synonym for . -

lock directory (G)

This option specifies the directory where lock - files will be placed. The lock files are used to implement the - option.

Default: lock directory = ${prefix}/var/locks

Example: lock directory = /var/run/samba/locks

locking (S)

This controls whether or not locking will be - performed by the server in response to lock requests from the - client.

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.

Default: locking = yes

lock spin count (G)

This parameter controls the number of times - that smbd should attempt to gain a byte range lock on the - behalf of a client request. Experiments have shown that - Windows 2k servers do not reply with a failure if the lock - could not be immediately granted, but try a few more times - in case the lock could later be aquired. This behavior - is used to support PC database formats such as MS Access - and FoxPro. -

Default: lock spin count = 3

lock spin time (G)

The time in microseconds that smbd should - pause before attempting to gain a failed lock. See - for more details.

Default: lock spin time = 10

log file (G)

This option allows you to override the name - of the Samba log file (also known as the debug file).

This option takes the standard substitutions, allowing - you to have separate log files for each user or machine.

Example: log file = /usr/local/samba/var/log.%m

log level (G)

The value of the parameter (a astring) allows - the debug level (logging level) to be specified in the - smb.conf file. This parameter has been - extended since the 2.2.x series, now it allow to specify the debug - level for multiple debug classes. This is to give greater - flexibility in the configuration of the system.

The default will be the log level specified on - the command line or level zero if none was specified.

Example: log level = 3 passdb:5 auth:10 winbind:2

logon drive (G)

This parameter specifies the local path to - which the home directory will be connected (see ) - and is only used by NT Workstations.

Note that this option is only useful if Samba is set up as a - logon server.

Default: logon drive = z:

Example: logon drive = h:

logon home (G)

This parameter specifies the home directory - location when a Win95/98 or NT Workstation logs into a Samba PDC. - It allows you to do

C:\> - NET USE H: /HOME -

from a command prompt, for example.

This option takes the standard substitutions, allowing - you to have separate logon scripts for each user or machine.

This parameter can be used with Win9X workstations to ensure - that roaming profiles are stored in a subdirectory of the user's - home directory. This is done in the following way:

logon home = \\%N\%U\profile

This tells Samba to return the above string, with - substitutions made when a client requests the info, generally - in a NetUserGetInfo request. Win9X clients truncate the info to - \\server\share when a user does net use /home - but use the whole string when dealing with profiles.

Note that in prior versions of Samba, the was returned rather than - logon home. This broke net use /home but allowed profiles outside the home directory. - The current implementation is correct, and can be used for profiles if you use - the above trick.

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 parameter specifies the home directory - where roaming profiles (NTuser.dat etc files for Windows NT) are - stored. Contrary to previous versions of these manual pages, it has - nothing to do with Win 9X roaming profiles. To find out how to - handle roaming profiles for Win 9X system, see the parameter.

This option takes the standard substitutions, allowing you - to have separate logon scripts for each user or machine. It also - specifies the directory from which the "Application Data", - (desktop, start menu, - network neighborhood, programs - and other folders, and their contents, are loaded and displayed on - your Windows NT client.

The share and the path must be readable by the user for - the preferences and directories to be loaded onto the Windows NT - client. The share must be writeable when the user logs in for the first - time, in order that the Windows NT client can create the NTuser.dat - and other directories.

Thereafter, the directories and any of the contents can, - if required, be made read-only. It is not advisable that the - NTuser.dat file be made read-only - rename it to NTuser.man to - achieve the desired effect (a MANdatory - profile).

Windows clients can sometimes maintain a connection to - the [homes] share, even though there is no user logged in. - Therefore, it is vital that the logon path does not include a - reference to the homes share (i.e. setting this parameter to - \%N\%U\profile_path will cause problems).

This option takes the standard substitutions, allowing - you to have separate logon scripts for each user or machine.

Note that this option is only useful if Samba is set up - as a logon server.

Default: logon path = \\%N\%U\profile

Example: logon path = \\PROFILESERVER\PROFILE\%U

logon script (G)

This parameter specifies the batch file (.bat) or - NT command file (.cmd) to be downloaded and run on a machine when - a user successfully logs in. The file must contain the DOS - style CR/LF line endings. Using a DOS-style editor to create the - file is recommended.

The script must be a relative path to the [netlogon] - service. If the [netlogon] service specifies a 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: \\SERVER\ISO9001_QA

for example.

Note that it is particularly important not to allow write - access to the [netlogon] share, or to grant users write permission - on the batch files in a secure environment, as this would allow - the batch files to be arbitrarily modified and security to be - breached.

This option takes the standard substitutions, allowing you - to have separate logon scripts for each user or machine.

This option is only useful if Samba is set up as a logon - server.

Default: no logon script defined

Example: logon script = scripts\%U.bat

lppause command (S)

This parameter specifies the command to be - executed on the server host in order to stop printing or spooling - a specific print job.

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.

See also the 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 hold

or if the value of the printing parameter - is SOFTQ, then the default is:

qstat -s -j%j -h

Example for HPUX: lppause command = /usr/bin/lpalt %p-%j -p0

lpq cache time (G)

This controls how long lpq info will be cached - for to prevent the lpq command being called too - often. A separate cache is kept for each variation of the - lpq command used by the system, so if you use different - lpq commands for different users then they won't - share cache information.

The cache files are stored in /tmp/lpq.xxxx - where xxxx is a hash of the lpq command in use.

The default is 10 seconds, meaning that the cached results - of a previous identical lpq command will be used - if the cached data is less than 10 seconds old. A large value may - be advisable if your lpq command is very slow.

A value of 0 will disable caching completely.

See also the parameter.

Default: lpq cache time = 10

Example: lpq cache time = 30

lpq command (S)

This parameter specifies the command to be - executed on the server host in order to obtain lpq - -style printer status information.

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.

See also the parameter.

Default: depends on the setting of - printing

Example: lpq command = /usr/bin/lpq -P%p

lpresume command (S)

This parameter specifies the command to be - executed on the server host in order to restart or continue - printing or spooling a specific print job.

This command should be a program or script which takes - a printer name and job number to resume the print job. See - also the 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 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

Example for HPUX: lpresume command = /usr/bin/lpalt %p-%j -p2

lprm command (S)

This parameter specifies the command to be - executed on the server host in order to delete a print job.

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.

See also the parameter.

Default: depends on the setting of printing -

Example 1: lprm command = /usr/bin/lprm -P%p %j

Example 2: lprm command = /usr/bin/cancel %p-%j

machine password timeout (G)

If a Samba server is a member of a Windows - NT Domain (see the ) - parameter) then periodically a running smbd - process will try and change the MACHINE ACCOUNT - PASSWORD stored in the TDB called private/secrets.tdb -. This parameter specifies how often this password - will be changed, in seconds. The default is one week (expressed in - seconds), the same as a Windows NT Domain member server.

See also smbpasswd(8), and the ) parameter.

Default: machine password timeout = 604800

magic output (S)

This parameter specifies the name of a file - which will contain output created by a magic script (see the - - parameter below).

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)

This parameter specifies the name of a file which, - if opened, will be executed by the server when the file is closed. - This allows a UNIX script to be sent to the Samba host and - executed on behalf of the connected user.

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 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: None. Magic scripts disabled.

Example: magic script = user.csh

mangle case (S)

See the section on

Default: mangle case = no

mangled map (S)

This is for those who want to directly map UNIX - file names which cannot be represented on Windows/DOS. The mangling - of names is not always what is needed. In particular you may have - documents with file extensions that differ between DOS and UNIX. - For example, under UNIX it is common to use .html - for HTML files, whereas under Windows/DOS .htm - is more commonly used.

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: no mangled map

Example: mangled map = (*;1 *;)

mangled names (S)

This controls whether non-DOS names under UNIX - should be mapped to DOS-compatible names ("mangled") and made visible, - or whether non-DOS names should simply be ignored.

See the section on for - details on how to control the mangling process.

If mangling is used then the mangling algorithm is as follows:

The first (up to) five alphanumeric characters - before the rightmost dot of the filename are preserved, forced - to upper case, and appear as the first (up to) five characters - of the mangled name.
A tilde "~" is appended to the first part of the mangled - name, followed by a two-character unique sequence, based on the - original root name (i.e., the original filename minus its final - extension). The final extension is included in the hash calculation - only if it contains any upper case characters or is longer than three - characters.
Note that the character to use may be specified using - the option, if you don't like '~'.
The first three alphanumeric characters of the final - extension are preserved, forced to upper case and appear as the - extension of the mangled name. The final extension is defined as that - part of the original filename after the rightmost dot. If there are no - dots in the filename, the mangled name will have no extension (except - in the case of "hidden files" - see below).
Files whose UNIX name begins with a dot will be - presented as DOS hidden files. The mangled name will be created as - for other filenames, but with the leading dot removed and "___" as - its extension regardless of actual original extension (that's three - underscores).

The two-digit hash value consists of upper case alphanumeric characters.

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

mangled stack (G)

This parameter controls the number of mangled names - that should be cached in the Samba server smbd(8).

This stack is a list of recently mangled base names - (extensions are only maintained if they are longer than 3 characters - or contains upper case characters).

The larger this value, the more likely it is that mangled - names can be successfully converted to correct long UNIX names. - However, large stack sizes will slow most directory accesses. Smaller - stacks save memory in the server (each stack element costs 256 bytes). -

It is not possible to absolutely guarantee correct long - filenames, so be prepared for some surprises!

Default: mangled stack = 50

Example: mangled stack = 100

mangle prefix (G)

controls the number of prefix - characters from the original name used when generating - the mangled names. A larger value will give a weaker - hash and therefore more name collisions. The minimum - value is 1 and the maximum value is 6.

- mangle prefix is effective only when mangling method is hash2. -

Default: mangle prefix = 1

Example: mangle prefix = 4

mangling char (S)

This controls what character is used as - the magic character in . The - default is a '~' but this may interfere with some software. Use this option to set - it to whatever you prefer. This is effective only when mangling method is hash.

Default: mangling char = ~

Example: mangling char = ^

mangling method (G)

controls the algorithm used for the generating - the mangled names. Can take two different values, "hash" and - "hash2". "hash" is the default and is the algorithm that has been - used in Samba for many years. "hash2" is a newer and considered - a better algorithm (generates less collisions) in the names. - However, many Win32 applications store the mangled names and so - changing to the new algorithm must not be done - lightly as these applications may break unless reinstalled.

Default: mangling method = hash2

Example: mangling method = hash

map acl inherit (S)

This boolean parameter controls whether smbd(8) will attempt to map the 'inherit' and 'protected' - access control entry flags stored in Windows ACLs into an extended attribute - called user.SAMBA_PAI. This parameter only takes effect if Samba is being run - on a platform that supports extended attributes (Linux and IRIX so far) and - allows the Windows 2000 ACL editor to correctly use inheritance with the Samba - POSIX ACL mapping code. -

Default: map acl inherit = no

map archive (S)

This controls whether the DOS archive attribute - should be mapped to the UNIX owner execute bit. The DOS archive bit - is set when a file has been modified since its last backup. One - motivation for this option it to keep Samba/your PC from making - any file it touches from becoming executable under UNIX. This can - be quite annoying for shared source code, documents, etc...

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 for details.

Default: map archive = yes

map hidden (S)

This controls whether DOS style hidden files - should be mapped to the UNIX world execute bit.

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 for details.

Default: map hidden = no

map system (S)

This controls whether DOS style system files - should be mapped to the UNIX group execute bit.

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 for details.

Default: map system = no

map to guest (G)

This parameter is only useful in modes other than security = share - - i.e. user, server, - and domain.

This parameter can take three 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 three settings are :

Never - Means user login - requests with an invalid password are rejected. This is the - default.
Bad User - Means user - logins with an invalid password are rejected, unless the username - does not exist, in which case it is treated as a guest login and - mapped into the .
Bad Password - Means user logins - with an invalid password are treated as a guest login and mapped - into the . Note that - this can cause problems as it means that any user incorrectly typing - their password will be silently logged on as "guest" - and - will not know the reason they cannot access files they think - they should - there will have been no message given to them - that they got their password wrong. Helpdesk services will - hate you if you set the map to - guest parameter this way :-).

Note that this parameter is needed to set up "Guest" - share services when using security modes other than - share. This is because in these modes the name of the resource being - requested is not sent to the server until after - the server has successfully authenticated the client so the server - cannot make authentication decisions at the correct time (connection - to the share) for "Guest" shares.

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)

This option allows the number of simultaneous connections to a service to be limited. - If max connections is greater than 0 then connections - will be refused if this number of connections to the service are already open. A value - of zero mean an unlimited number of connections may be made.

Record lock files are used to implement this feature. The lock files will be stored in - the directory specified by the option.

Default: max connections = 0

Example: max connections = 10

max disk size (G)

This option allows you to put an upper limit - on the apparent size of disks. If you set this option to 100 - then all shares will appear to be not larger than 100 MB in - size.

Note that this option does not limit the amount of - data you can put on the disk. In the above case you could still - store much more than 100 MB on the disk, but if a client ever asks - for the amount of free disk space or the total disk size then the - result will be bounded by the amount specified in max - disk size.

This option is primarily useful to work around bugs - in some pieces of software that can't handle very large disks, - particularly disks over 1GB in size.

A max disk size of 0 means no limit.

Default: max disk size = 0

Example: max disk size = 1000

max log size (G)

This option (an integer in kilobytes) specifies - the max size the log file should grow to. Samba periodically checks - the size and if it is exceeded it will rename the file, adding - a .old extension.

A size of 0 means no limit.

Default: max log size = 5000

Example: max log size = 1000

max mux (G)

This option controls the maximum number of - outstanding simultaneous SMB operations that Samba tells the client - it will allow. You should never need to set this parameter.

Default: max mux = 50

max open files (G)

This parameter limits the maximum number of - open files that one smbd(8) file - serving process may have open for a client at any one time. The - default for this parameter is set very high (10,000) as Samba uses - only one bit per unopened file.

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)

This parameter limits the maximum number of - jobs allowable in a Samba printer queue at any given moment. - If this number is exceeded, smbd(8) will remote "Out of Space" to the client. - See all . -

Default: max print jobs = 1000

Example: max print jobs = 5000

max protocol (G)

The value of the parameter (a string) is the highest - protocol level that will be supported by the server.

Possible values are :

CORE: Earliest version. No - concept of user names.
COREPLUS: Slight improvements on - CORE for efficiency.
LANMAN1: First - modern version of the protocol. Long filename - support.
LANMAN2: Updates to Lanman1 protocol.
NT1: Current up to date version of the protocol. - Used by Windows NT. Known as CIFS.

Normally this option should not be set as the automatic - negotiation phase in the SMB protocol takes care of choosing - the appropriate protocol.

See also

Default: max protocol = NT1

Example: max protocol = LANMAN1

max reported print jobs (S)

This parameter limits the maximum number of - jobs displayed in a port monitor for Samba printer queue at any given - moment. If this number is exceeded, the excess jobs will not be shown. - A value of zero means there is no limit on the number of print - jobs reported. - - See all and parameters. -

Default: max reported print jobs = 0

Example: max reported print jobs = 1000

max smbd processes (G)

This parameter limits the maximum number of smbd(8) processes concurrently running on a system and is intended - as a stopgap to prevent degrading service to clients in the event that the server has insufficient - resources to handle more than this number of connections. Remember that under normal operating - conditions, each user will have an smbd(8) associated with him or her to handle connections to all - shares from a given host.

Default: max smbd processes = 0 ## no limit

Example: max smbd processes = 1000

max ttl (G)

This option tells nmbd(8) what the default 'time to live' - of NetBIOS names should be (in seconds) when nmbd is - requesting a name using either a broadcast packet or from a WINS server. You should - never need to change this parameter. The default is 3 days.

Default: max ttl = 259200

max wins ttl (G)

This option tells smbd(8) when acting as a WINS server () what the maximum - 'time to live' of NetBIOS names that nmbd - will grant will be (in seconds). You should never need to change this - parameter. The default is 6 days (518400 seconds).

See also the parameter.

Default: max wins ttl = 518400

max xmit (G)

This option controls the maximum packet size - that will be negotiated by Samba. The default is 65535, which - is the maximum. In some cases you may find you get better performance - with a smaller value. A value below 2048 is likely to cause problems. -

Default: max xmit = 65535

Example: max xmit = 8192

message command (G)

This specifies what command to run when the - server receives a WinPopup style message.

This would normally be a command that would - deliver the message somehow. How this is to be done is - up to your imagination.

An example is:

message command = csh -c 'xedit %s;rm %s' & -

This delivers the message using xedit, then - removes it afterwards. NOTE THAT IT IS VERY IMPORTANT - THAT THIS COMMAND RETURN IMMEDIATELY. That's why I - have the '&' on the end. If it doesn't return immediately then - your PCs may freeze when sending messages (they should recover - after 30 seconds, hopefully).

All messages are delivered as the global guest user. - The command takes the standard substitutions, although - %u won't work (%U may be better - in this case).

Apart from the standard substitutions, some additional - ones apply. In particular:

%s = the filename containing - the message.
%t = the destination that - the message was sent to (probably the server name).
%f = who the message - is from.

You could make this command send mail, or whatever else - takes your fancy. Please let us know of any really interesting - ideas you have.

Here's a way of sending the messages as mail to root:

message command = /bin/mail -s 'message from %f on - %m' root < %s; rm %s

If you don't have a message command then the message - won't be delivered and Samba will tell the sender there was - an error. Unfortunately WfWg totally ignores the error code - and carries on regardless, saying that the message was delivered. -

If you want to silently delete it then try:

message command = rm %s

Default: no message command

Example: message command = csh -c 'xedit %s; rm %s' &

min passwd length (G)

Synonym for . -

min password length (G)

This option sets the minimum length in characters of a - plaintext password that smbd will - accept when performing UNIX password changing.

See also the parameter.

Default: min print space = 0

Example: min print space = 2000

min protocol (G)

The value of the parameter (a string) is the - lowest SMB protocol dialect than Samba will support. Please refer - to the - parameter for a list of valid protocol names and a brief description - of each. You may also wish to refer to the C source code in - source/smbd/negprot.c for a listing of known protocol - dialects supported by clients.

If you are viewing this parameter as a security measure, you should - also refer to the parameter. Otherwise, you should never need - to change this parameter.

Default : min protocol = CORE

Example : min protocol = NT1 # disable DOS clients

min wins ttl (G)

This option tells nmbd(8) - when acting as a WINS server () what the minimum 'time to live' - of NetBIOS names that nmbd will grant will be (in - seconds). You should never need to change this parameter. The default - is 6 hours (21600 seconds).

Default: min wins ttl = 21600

msdfs proxy (S)

This parameter indicates that the share is a - stand-in for another CIFS share whose location is specified by - the value of the parameter. When clients attempt to connect to - this share, they are redirected to the proxied share using - the SMB-Dfs protocol.

Only Dfs roots can act as proxy shares. Take a look at the - - and - options to find out how to set up a Dfs root share.

Example: msdfs proxy = \\\\otherserver\\someshare

msdfs root (S)

If set to yes, Samba treats the - share as a Dfs root and allows clients to browse the - distributed file system tree rooted at the share directory. - Dfs links are specified in the share directory by symbolic - links of the form msdfs:serverA\\shareA,serverB\\shareB - and so on. For more information on setting up a Dfs tree on - Samba, refer to .

See also

Default: msdfs root = no

name cache timeout (G)

Specifies the number of seconds it takes before - entries in samba's hostname resolve cache time out. If - the timeout is set to 0. the caching is disabled. -

Default: name cache timeout = 660

Example: name cache timeout = 0

name resolve order (G)

This option is used by the programs in the Samba - suite to determine what naming services to use and in what order - to resolve host names to IP addresses. Its main purpose to is to - control how netbios name resolution is performed. The option takes a space - separated string of name resolution options.

The options are: "lmhosts", "host", - "wins" and "bcast". They cause names to be - resolved as follows:

lmhosts : Lookup an IP - address in the Samba lmhosts file. If the line in lmhosts has - no name type attached to the NetBIOS name (see the lmhosts(5) for details) then - any name type matches for lookup.
host : Do a standard host - name to IP address resolution, using the system /etc/hosts -, NIS, or DNS lookups. This method of name resolution - is operating system depended for instance on IRIX or Solaris this - may be controlled by the /etc/nsswitch.conf - file. Note that this method is used only if the NetBIOS name - type being queried is the 0x20 (server) name type or 0x1c (domain controllers). - The latter case is only useful for active directory domains and results in a DNS - query for the SRV RR entry matching _ldap._tcp.domain.
wins : Query a name with - the IP address listed in the parameter. If no WINS server has - been specified this method will be ignored.
bcast : Do a broadcast on - each of the known local interfaces listed in the - parameter. This is the least reliable of the name resolution - methods as it depends on the target host being on a locally - connected subnet.

Default: name resolve order = lmhosts host wins bcast

Example: name resolve order = lmhosts bcast host

This will cause the local lmhosts file to be examined - first, followed by a broadcast attempt, followed by a normal - system hostname lookup.

When Samba is functioning in ADS security mode (security = ads) - it is advised to use following settings for name resolve order:

name resolve order = wins bcast

DC lookups will still be done via DNS, but fallbacks to netbios names will - not inundate your DNS servers with needless querys for DOMAIN<0x1c> lookups.

netbios aliases (G)

This is a list of NetBIOS names that nmbd will - advertise as additional names by which the Samba server is known. This allows one machine - to appear in browse lists under multiple names. If a machine is acting as a browse server - or logon server none of these names will be advertised as either browse server or logon - servers, only the primary name of the machine will be advertised with these capabilities. -

See also .

Default: empty string (no additional names)

Example: netbios aliases = TEST TEST1 TEST2

netbios name (G)

This sets the NetBIOS name by which a Samba - server is known. By default it is the same as the first component - of the host's DNS name. If a machine is a browse server or - logon server this name (or the first component - of the hosts DNS name) will be the name that these services are - advertised under.

See also .

Default: machine DNS name

Example: netbios name = MYNAME

netbios scope (G)

This sets the NetBIOS scope that Samba will - operate under. This should not be set unless every machine - on your LAN also sets this value.

nis homedir (G)

Get the home share server from a NIS map. For - UNIX systems that use an automounter, the user's home directory - will often be mounted on a workstation on demand from a remote - server.

When the Samba logon server is not the actual home directory - server, but is mounting the home directories via NFS then two - network hops would be required to access the users home directory - if the logon server told the client to use itself as the SMB server - for home directories (one over SMB and one over NFS). This can - be very slow.

This option allows Samba to return the home share as - being on a different server to the logon server and as - long as a Samba daemon is running on the home directory server, - it will be mounted on the Samba client directly from the directory - server. When Samba is returning the home share to the client, it - will consult the NIS map specified in and return the server - listed there.

Note that for this option to work there must be a working - NIS system and the Samba server with this option must also - be a logon server.

Default: nis homedir = no

nt acl support (S)

This boolean parameter controls whether smbd(8) will attempt to map - UNIX permissions into Windows NT access control lists. - This parameter was formally a global parameter in releases - prior to 2.2.2.

Default: nt acl support = yes

ntlm auth (G)

This parameter determines whether or not smbd(8) will attempt to - authenticate users using the NTLM encrypted password response. - If disabled, either the lanman password hash or an NTLMv2 response - will need to be sent by the client.

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)

This boolean parameter controls whether - smbd(8) will allow Windows NT - clients to connect to the NT SMB specific IPC$ - pipes. This is a developer debugging option and can be left - alone.

Default: nt pipe support = yes

nt status support (G)

This boolean parameter controls whether smbd(8) will negotiate NT specific status - support with Windows NT/2k/XP clients. This is a developer debugging option and should be left alone. - If this option is set to no then Samba offers - exactly the same DOS error codes that versions prior to Samba 2.2.3 - reported.

You should not need to ever disable this parameter.

Default: nt status support = yes

null passwords (G)

Allow or disallow client access to accounts that have null passwords.

See also the parameter.

Default: only user = no

oplock break wait time (G)

This is a tuning parameter added due to bugs in - both Windows 9x and WinNT. If Samba responds to a client too - quickly when that client issues an SMB that can cause an oplock - break request, then the network client can fail and not respond - to the break request. This tuning parameter (which is set in milliseconds) - is the amount of time Samba will wait before sending an oplock break - request to such (broken) clients.

DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ AND - UNDERSTOOD THE SAMBA OPLOCK CODE.

Default: oplock break wait time = 0

oplock contention limit (S)

This is a very advanced - smbd(8) tuning option to - improve the efficiency of the granting of oplocks under multiple - client contention for the same file.

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.

DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ - AND UNDERSTOOD THE SAMBA OPLOCK CODE.

Default: oplock contention limit = 2

oplocks (S)

This boolean option tells smbd whether to - issue oplocks (opportunistic locks) to file open requests on this - share. The oplock code can dramatically (approx. 30% or more) improve - the speed of access to files on Samba servers. It allows the clients - to aggressively cache files locally and you may want to disable this - option for unreliable network environments (it is turned on by - default in Windows NT Servers). For more information see the file - Speed.txt in the Samba docs/ - directory.

Oplocks may be selectively turned off on certain files with a - share. See the 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.

See also .

Default: passwd program = /bin/passwd

Example: passwd program = /sbin/npasswd %u

password level (G)

Some client/server combinations have difficulty - with mixed-case passwords. One offending client is Windows for - Workgroups, which for some reason forces passwords to upper - case when using the LANMAN1 protocol, but leaves them alone when - using COREPLUS! Another problem child is the Windows 95/98 - family of operating systems. These clients upper case clear - text passwords even when NT LM 0.12 selected by the protocol - negotiation request/response.

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.

Default: password level = 0

Example: password level = 4

password server (G)

By specifying the name of another SMB server - or Active Directory domain controller with this option, - and using security = [ads|domain|server] - it is possible to get Samba to - to do all its username/password validation using a specific remote server.

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 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:

You may list several password servers in - the password server parameter, however if an - smbd makes a connection to a password server, - and then the password server fails, no more users will be able - to be authenticated from this smbd. This is a - restriction of the SMB/CIFS protocol when in security = server - mode and cannot be fixed in Samba.
If you are using a Windows NT server as your - password server then you will have to ensure that your users - are able to login from the Samba server, as when in - security = server mode the network logon will appear to - come from there rather than from the users workstation.

See also the parameter.

Default: password server = <empty string>

Example: password server = NT-PDC, NT-BDC1, NT-BDC2, *

Example: password server = windc.mydomain.com:389 192.168.1.101 *

Example: password server = *

path (S)

This parameter specifies a directory to which - the user of the service is to be given access. In the case of - printable services, this is where print data will spool prior to - being submitted to the host for printing.

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 if one was specified.

Default: none

Example: path = /home/fred

pid directory (G)

This option specifies the directory where pid - files will be placed.

Default: pid directory = ${prefix}/var/locks

Example: pid directory = /var/run/

posix locking (S)

The smbd(8) - daemon maintains an database of file locks obtained by SMB clients. - The default behavior is to map this internal database to POSIX - locks. This means that file locks obtained by SMB clients are - consistent with those seen by POSIX compliant applications accessing - the files via a non-SMB method (e.g. NFS or local file access). - You should never need to disable this parameter.

Default: posix locking = yes

postexec (S)

This option specifies a command to be run - whenever the service is disconnected. It takes the usual - substitutions. The command may be run as the root on some - systems.

An interesting example may be to unmount server - resources:

postexec = /etc/umount /cdrom

See also .

Default: none (no command executed)

Example: postexec = echo \"%u disconnected from %S from %m (%I)\" >> /tmp/log

preexec (S)

This option specifies a command to be run whenever - the service is connected to. It takes the usual substitutions.

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 and .

Default: none (no command executed)

Example: preexec = echo \"%u connected to %S from %m (%I)\" >> /tmp/log

preexec close (S)

This boolean option controls whether a non-zero - return code from should close the service being connected to.

Default: preexec close = no

prefered master (G)

Synonym for for people who cannot spell :-).

preferred master (G)

This boolean parameter controls if - nmbd(8) is a preferred master - browser for its workgroup.

If this is set to yes, on startup, nmbd - will force an election, and it will have a slight advantage in - winning the election. It is recommended that this parameter is - used in conjunction with = yes, so - that nmbd can guarantee becoming a domain master.

Use this option with caution, because if there are several - hosts (whether Samba servers, Windows 95 or NT) that are - preferred master browsers on the same subnet, they will each - periodically and continuously attempt to become the local - master browser. This will result in unnecessary broadcast - traffic and reduced browsing capabilities.

See also .

Default: preferred master = auto

preload (G)

This is a list of services that you want to be - automatically added to the browse lists. This is most useful - for homes and printers services that would otherwise not be - visible.

Note that if you just want all printers in your - printcap file loaded then the option is easier.

Default: no preloaded services

Example: preload = fred lp colorlp

preload modules (G)

This is a list of paths to modules that should - be loaded into smbd before a client connects. This improves - the speed of smbd when reacting to new connections somewhat.

Default: preload modules =

Example: preload modules = /usr/lib/samba/passdb/mysql.so+++

preserve case (S)

This controls if new filenames are created - with the case that the client passes, or if they are forced to - be the .

Default: preserve case = yes

See the section on for a fuller discussion.

printable (S)

If this parameter is yes, then - clients may open, write to and submit spool files on the directory - specified for the service.

Note that a printable service will ALWAYS allow writing - to the service path (user privileges permitting) via the spooling - of print data. The parameter controls only non-printing access to - the resource.

Default: printable = no

printcap (G)

Synonym for .

printcap name (S)

This parameter may be used to override the - compiled-in default printcap name used by the server (usually - /etc/printcap). See the discussion of the section above for reasons - why you might want to do this.

To use the CUPS printing interface set printcap name = cups - . This should be supplemented by an addtional setting - in the [global] - section. printcap name = cups will use the - "dummy" printcap created by CUPS, as specified in your CUPS - configuration file. -

On System V systems that use lpstat to - list available printers you can use printcap name = lpstat - to automatically obtain lists of available printers. This - is the default for systems that define SYSV at configure time in - Samba (this includes most System V based systems). If - printcap name is set to lpstat on - these systems then Samba will launch lpstat -v and - attempt to parse the output to obtain a printer list.

A minimal printcap file would look something like this:

-print1|My Printer 1
-print2|My Printer 2
-print3|My Printer 3
-print4|My Printer 4
-print5|My Printer 5
-

where the '|' separates aliases of a printer. The fact - that the second alias has a space in it gives a hint to Samba - that it's a comment.

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)

After a print job has finished spooling to - a service, this command will be used via a system() - call to process the spool file. Typically the command specified will - submit the spool file to the host's printing subsystem, but there - is no requirement that this be the case. The server will not remove - the spool file, so whatever command you specify should remove the - spool file when it has been processed, otherwise you will need to - manually remove old spool files.

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 - 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 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 - 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.

Example: print command = /usr/local/samba/bin/myprintscript %p %s

printer (S)

Synonym for .

printer admin (S)

This is a list of users that can do anything to - printers via the remote administration interfaces offered by MS-RPC - (usually using a NT workstation). Note that the root user always - has admin rights.

Default: printer admin = <empty string>

Example: printer admin = admin, @staff

printer name (S)

This parameter specifies the name of the printer - to which print jobs spooled through a printable service will be sent.

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.

Default: none (but may be lp - on many systems)

Example: printer name = laserwriter

printing (S)

This parameters controls how printer status information is - interpreted on your system. It also affects the default values for - the print command, lpq command, lppause command , lpresume command, and lprm command if specified in the - [global] section.

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

Note

- The security advantage of using restrict anonymous = 2 is removed - by setting on any share. -

Default: restrict anonymous = 0

root (G)

Synonym for . -

root dir (G)

Synonym for . -

root directory (G)

The server will chroot() (i.e. - Change its root directory) to this directory on startup. This is - not strictly necessary for secure operation. Even without it the - server will deny access to files not in one of the service entries. - It may also check for, and deny access to, soft links to other - parts of the filesystem, or attempts to use ".." in file names - to access other directories (depending on the setting of the - parameter). -

Adding a root directory entry other - than "/" adds an extra level of security, but at a price. It - absolutely ensures that no access is given to files not in the - sub-tree specified in the root directory - option, including some files needed for - complete operation of the server. To maintain full operability - of the server you will need to mirror some system files - into the root directory tree. In particular - you will need to mirror /etc/passwd (or a - subset of it), and any binaries or configuration files needed for - printing (if required). The set of files that must be mirrored is - operating system dependent.

Default: root directory = /

Example: root directory = /homes/smb

root postexec (S)

This is the same as the postexec - parameter except that the command is run as root. This - is useful for unmounting filesystems - (such as CDROMs) after a connection is closed.

See also .

Default: root postexec = <empty string>

root preexec (S)

This is the same as the preexec - parameter except that the command is run as root. This - is useful for mounting filesystems (such as CDROMs) when a - connection is opened.

See also and .

Default: root preexec = <empty string>

root preexec close (S)

This is the same as the preexec close - parameter except that the command is run as root.

See also and .

Default: root preexec close = no

security (G)

This option affects how clients respond to - Samba and is one of the most important settings in the - smb.conf file.

The option sets the "security mode bit" in replies to - protocol negotiations with smbd(8) to turn share level security on or off. Clients decide - based on this bit whether (and how) to transfer user and password - information to the server.

The default is security = user, as this is - the most common setting needed when talking to Windows 98 and - Windows NT.

The alternatives are security = share, - security = server or security = domain - .

In versions of Samba prior to 2.0.0, the default was - security = share mainly because that was - the only option at one stage.

There is a bug in WfWg that has relevance to this - setting. When in user or server level security a WfWg client - will totally ignore the password you type in the "connect - drive" dialog box. This makes it very difficult (if not impossible) - to connect to a Samba service as anyone except the user that - you are logged into WfWg as.

If your PCs use usernames that are the same as their - usernames on the UNIX machine then you will want to use - security = user. If you mostly use usernames - that don't exist on the UNIX box then use security = - share.

You should also use security = share if you - want to mainly setup shares without a password (guest shares). This - is commonly used for a shared printer server. It is more difficult - to setup guest shares with security = user, see - the parameter for details.

It is possible to use smbd in a - hybrid mode where it is offers both user and share - level security under different .

The different settings will now be explained.

SECURITY = SHARE

When clients connect to a share level security server they - need not log onto the server with a valid username and password before - attempting to connect to a shared resource (although modern clients - such as Windows 95/98 and Windows NT will send a logon request with - a username but no password when talking to a security = share - server). Instead, the clients send authentication information - (passwords) on a per-share basis, at the time they attempt to connect - to that share.

Note that smbd ALWAYS - uses a valid UNIX user to act on behalf of the client, even in - security = share level security.

As clients are not required to send a username to the server - in share level security, smbd uses several - techniques to determine the correct UNIX user to use on behalf - of the client.

A list of possible UNIX usernames to match with the given - client password is constructed using the following methods :

If the parameter is set, then all the other - stages are missed and only the username is checked. -
Is a username is sent with the share connection - request, then this username (after mapping - see ), - is added as a potential username. -
If the client did a previous logon - request (the SessionSetup SMB call) then the - username sent in this SMB will be added as a potential username. -
The name of the service the client requested is - added as a potential username. -
The NetBIOS name of the client is added to - the list as a potential username. -
Any users on the list are added as potential usernames. -

If the guest only parameter is - not set, then this list is then tried with the supplied password. - The first user for whom the password matches will be used as the - UNIX user.

If the guest only parameter is - set, or no username can be determined then if the share is marked - as available to the guest account, then this - guest user will be used, otherwise access is denied.

Note that it can be very confusing - in share-level security as to which UNIX username will eventually - be used in granting access.

See also the section .

SECURITY = USER

This is the default security setting in Samba 3.0. - With user-level security a client must first "log-on" with a - valid username and password (which can be mapped using the - parameter). Encrypted passwords (see the parameter) can also - be used in this security mode. Parameters such as and if set are then applied and - may change the UNIX user to use on this connection, but only after - the user has been successfully authenticated.

Note that the name of the resource being - requested is not sent to the server until after - the server has successfully authenticated the client. This is why - guest shares don't work in user level security without allowing - the server to automatically map unknown users into the . - See the parameter for details on doing this.

See also the section .

SECURITY = DOMAIN

This mode will only work correctly if net(8) has been used to add this - machine into a Windows NT Domain. It expects the parameter to be set to yes. In this - mode Samba will try to validate the username/password by passing - it to a Windows NT Primary or Backup Domain Controller, in exactly - the same way that a Windows NT Server would do.

Note that a valid UNIX user must still - exist as well as the account on the Domain Controller to allow - Samba to have a valid UNIX account to map file access to.

Note that from the client's point - of view security = domain is the same - as security = user. It only - affects how the server deals with the authentication, - it does not in any way affect what the client sees.

See also the section .

See also the parameter and the parameter.

SECURITY = SERVER

In this mode Samba will try to validate the username/password - by passing it to another SMB server, such as an NT box. If this - fails it will revert to security = - user. It expects the parameter - to be set to yes, unless the remote server - does not support them. However note that if encrypted passwords have been - negotiated then Samba cannot revert back to checking the UNIX password file, - it must have a valid smbpasswd file to check - users against. See the chapter about the User Database in the Samba HOWTO Collection for details on how to set this up.

Note

This mode of operation has - significant pitfalls, due to the fact that is activly initiates a - man-in-the-middle attack on the remote SMB server. In particular, - this mode of operation can cause significant resource consuption on - the PDC, as it must maintain an active connection for the duration - of the user's session. Furthermore, if this connection is lost, - there is no way to reestablish it, and futher authenticaions to the - Samba server may fail. (From a single client, till it disconnects). -

Note

From the client's point of - view security = server is the - same as security = user. It - only affects how the server deals with the authentication, it does - not in any way affect what the client sees.

See also the section .

See also the parameter and the parameter.

SECURITY = ADS

In this mode, Samba will act as a domain member in an ADS realm. To operate - in this mode, the machine running Samba will need to have Kerberos installed - and configured and Samba will need to be joined to the ADS realm using the - net utility.

Note that this mode does NOT make Samba operate as a Active Directory Domain - Controller.

Read the chapter about Domain Membership in the HOWTO for details.

See also the parameter, the paramter and the parameter.

Default: security = USER

Example: security = DOMAIN

security mask (S)

This parameter controls what UNIX permission - bits can be modified when a Windows NT client is manipulating - the UNIX permission on a file using the native NT security - dialog box.

If not set explicitly this parameter is 0777, allowing - a user to modify all the user/group/world permissions on a file. -

Note that users who can access the - Samba server through other means can easily bypass this - restriction, so it is primarily useful for standalone - "appliance" systems. Administrators of most normal systems will - probably want to leave it set to 0777.

See also .

smb passwd file (G)

This option sets the path to the encrypted smbpasswd file. By - default the path to the smbpasswd file is compiled into Samba.

Default: smb passwd file = ${prefix}/private/smbpasswd

Example: smb passwd file = /etc/samba/smbpasswd

smb ports (G)

Specifies which ports the server should listen on for SMB traffic.

Default: smb ports = 445 139

socket address (G)

This option allows you to control what - address Samba will listen for connections on. This is used to - support multiple virtual interfaces on the one server, each - with a different configuration.

By default Samba will accept connections on any - address.

Example: socket address = 192.168.2.20

socket options (G)

This option allows you to set socket options - to be used when talking with the client.

Socket options are controls on the networking layer - of the operating systems which allow the connection to be - tuned.

This option will typically be used to tune your Samba server - for optimal performance for your local network. There is no way - that Samba can know what the optimal parameters are for your net, - so you must experiment and choose them yourself. We strongly - suggest you read the appropriate documentation for your operating - system first (perhaps man - setsockopt will help).

You may find that on some systems Samba will say - "Unknown socket option" when you supply an option. This means you - either incorrectly typed it or you need to add an include file - to includes.h for your OS. If the latter is the case please - send the patch to - samba-technical@samba.org.

Any of the supported socket options may be combined - in any way you like, as long as your OS allows it.

This is the list of socket options currently settable - using this option:

SO_KEEPALIVE
SO_REUSEADDR
SO_BROADCAST
TCP_NODELAY
IPTOS_LOWDELAY
IPTOS_THROUGHPUT
SO_SNDBUF *
SO_RCVBUF *
SO_SNDLOWAT *
SO_RCVLOWAT *

Those marked with a '*' take an integer - argument. The others can optionally take a 1 or 0 argument to enable - or disable the option, by default they will be enabled if you - don't specify 1 or 0.

To specify an argument use the syntax SOME_OPTION = VALUE - for example SO_SNDBUF = 8192. Note that you must - not have any spaces before or after the = sign.

If you are on a local network then a sensible option - might be:

socket options = IPTOS_LOWDELAY

If you have a local network then you could try:

socket options = IPTOS_LOWDELAY TCP_NODELAY

If you are on a wide area network then perhaps try - setting IPTOS_THROUGHPUT.

Note that several of the options may cause your Samba - server to fail completely. Use these options with caution!

Default: socket options = TCP_NODELAY

Example: socket options = IPTOS_LOWDELAY

source environment (G)

This parameter causes Samba to set environment - variables as per the content of the file named.

If the value of this parameter starts with a "|" character - then Samba will treat that value as a pipe command to open and - will set the environment variables from the output of the pipe.

The contents of the file or the output of the pipe should - be formatted as the output of the standard Unix env(1) command. This is of the form:

Example environment entry:

SAMBA_NETBIOS_NAME = myhostname

Default: No default value

Examples: source environment = |/etc/smb.conf.sh

Example: source environment = - /usr/local/smb_env_vars

stat cache (G)

This parameter determines if smbd(8) will use a cache in order to - speed up case insensitive name mappings. You should never need - to change this parameter.

Default: stat cache = yes

strict allocate (S)

This is a boolean that controls the handling of - disk space allocation in the server. When this is set to yes - the server will change from UNIX behaviour of not committing real - disk storage blocks when a file is extended to the Windows behaviour - of actually forcing the disk system to allocate real storage blocks - when a file is created or extended to be a given size. In UNIX - terminology this means that Samba will stop creating sparse files. - This can be slow on some systems.

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)

This is a boolean that controls the handling of - file locking in the server. When this is set to yes, - the server will check every read and write access for file locks, and - deny access if locks exist. This can be slow on some systems.

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 = no is preferable.

Default: strict locking = no

strict sync (S)

Many Windows applications (including the Windows 98 explorer - shell) seem to confuse flushing buffer contents to disk with doing - a sync to disk. Under UNIX, a sync call forces the process to be - suspended until the kernel has ensured that all outstanding data in - kernel disk buffers has been safely stored onto stable storage. - This is very slow and should only be done rarely. Setting this - parameter to no (the default) means that - smbd(8) ignores the Windows - applications requests for a sync call. There is only a possibility - of losing data if the operating system itself that Samba is running - on crashes, so there is little danger in this default setting. In - addition, this fixes many performance problems that people have - reported with the new Windows98 explorer shell file copies.

See also the parameter.

Default: strict sync = no

sync always (S)

This is a boolean parameter that controls - whether writes will always be written to stable storage before - the write call returns. If this is no then the server will be - guided by the client's request in each write call (clients can - set a bit indicating that a particular write should be synchronous). - If this is yes then every write will be followed by a fsync() - call to ensure the data is written to disk. Note that - the strict sync parameter must be set to - yes in order for this parameter to have - any affect.

See also the parameter.

Default: sync always = no

syslog (G)

This parameter maps how Samba debug messages - are logged onto the system syslog logging levels. Samba debug - level zero maps onto syslog LOG_ERR, debug - level one maps onto LOG_WARNING, debug level - two maps onto LOG_NOTICE, debug level three - maps onto LOG_INFO. All higher levels are mapped to - LOG_DEBUG.

This parameter sets the threshold for sending messages - to syslog. Only messages with debug level less than this value - will be sent to syslog.

Default: syslog = 1

syslog only (G)

If this parameter is set then Samba debug - messages are logged into the system syslog only, and not to - the debug log files.

Default: syslog only = no

template homedir (G)

When filling out the user information for a Windows NT - user, the winbindd(8) daemon uses this - parameter to fill in the home directory for that user. If the - string %D is present it - is substituted with the user's Windows NT domain name. If the - string %U is present it - is substituted with the user's Windows NT user name.

Default: template homedir = /home/%D/%U

template primary group (G)

This option defines the default primary group for - each user created by winbindd(8)'s local account management - functions (similar to the 'add user script'). -

Default: template primary group = nobody

template shell (G)

When filling out the user information for a Windows NT - user, the winbindd(8) daemon uses this - parameter to fill in the login shell for that user.

Default: template shell = /bin/false

time offset (G)

This parameter is a setting in minutes to add - to the normal GMT to local time conversion. This is useful if - you are serving a lot of PCs that have incorrect daylight - saving time handling.

Default: time offset = 0

Example: time offset = 60

time server (G)

This parameter determines if nmbd(8) advertises itself as a time server to Windows - clients.

Default: time server = no

timestamp logs (G)

Synonym for .

unicode (G)

Specifies whether Samba should try - to use unicode on the wire by default. Note: This does NOT - mean that samba will assume that the unix machine uses unicode! -

Default: unicode = yes

unix charset (G)

Specifies the charset the unix machine - Samba runs on uses. Samba needs to know this in order to be able to - convert text to the charsets other SMB clients use. -

Default: unix charset = UTF8

Example: unix charset = ASCII

unix extensions (G)

This boolean parameter controls whether Samba - implments the CIFS UNIX extensions, as defined by HP. - These extensions enable Samba to better serve UNIX CIFS clients - by supporting features such as symbolic links, hard links, etc... - These extensions require a similarly enabled client, and are of - no current use to Windows clients.

Default: unix extensions = yes

unix password sync (G)

This boolean parameter controls whether Samba - attempts to synchronize the UNIX password with the SMB password - when the encrypted SMB password in the smbpasswd file is changed. - If this is set to yes the program specified in the passwd - programparameter is called AS ROOT - - to allow the new UNIX password to be set without access to the - old UNIX password (as the SMB password change code has no - access to the old password cleartext, only the new).

See also

Default: use client driver = no

use mmap (G)

This global parameter determines if the tdb internals of Samba can - depend on mmap working correctly on the running system. Samba requires a coherent - mmap/read-write system memory cache. Currently only HPUX does not have such a - coherent cache, and so this parameter is set to no by - default on HPUX. On all other systems this parameter should be left alone. This - parameter is provided to help the Samba developers track down problems with - the tdb internal code. -

Default: use mmap = yes

user (S)

Synonym for .

username (S)

Multiple users may be specified in a comma-delimited - list, in which case the supplied password will be tested against - each username in turn (left to right).

The username line is needed only when - the PC is unable to supply its own username. This is the case - for the COREPLUS protocol or where your users have different WfWg - usernames to UNIX usernames. In both these cases you may also be - better using the \\server\share%user syntax instead.

The username line is not a great - solution in many cases as it means Samba will try to validate - the supplied password against each of the usernames in the - username line in turn. This is slow and - a bad idea for lots of users in case of duplicate passwords. - You may get timeouts or security breaches using this parameter - unwisely.

Samba relies on the underlying UNIX security. This - parameter does not restrict who can login, it just offers hints - to the Samba server as to what usernames might correspond to the - supplied password. Users can login as whoever they please and - they will be able to do no more damage than if they started a - telnet session. The daemon runs as the user that they log in as, - so they cannot do anything that user cannot do.

To restrict a service to a particular set of users you - can use the 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 for more information on how - this parameter determines access to the services.

Default: The guest account if a guest service, - else <empty string>.

Examples:username = fred, mary, jack, jane, - @users, @pcgroup

username level (G)

This option helps Samba to try and 'guess' at - the real UNIX username, as many DOS clients send an all-uppercase - username. By default Samba tries all lowercase, followed by the - username with the first letter capitalized, and fails if the - username is not found on the UNIX machine.

If this parameter is set to non-zero the behavior changes. - This parameter is a number that specifies the number of uppercase - combinations to try while trying to determine the UNIX user name. The - higher the number the more combinations will be tried, but the slower - the discovery of usernames will be. Use this parameter when you have - strange usernames on your UNIX machine, such as AstrangeUser -.

Default: username level = 0

Example: username level = 5

username map (G)

This option allows you to specify a file containing - a mapping of usernames from the clients to the server. This can be - used for several purposes. The most common is to map usernames - that users use on DOS or Windows machines to those that the UNIX - box uses. The other is to map multiple users to a single username - so that they can more easily share files.

The map file is parsed line by line. Each line should - contain a single UNIX username on the left then a '=' followed - by a list of usernames on the right. The list of usernames on the - right may contain names of the form @group in which case they - will match any UNIX username in that group. The special client - name '*' is a wildcard and matches any name. Each line of the - map file may be up to 1023 characters long.

The file is processed on each line by taking the - supplied username and comparing it with each username on the right - hand side of the '=' signs. If the supplied name matches any of - the names on the right hand side then it is replaced with the name - on the left. Processing then continues with the next line.

If any line begins with a '#' or a ';' then it is ignored

If any line begins with an '!' then the processing - will stop after that line if a mapping was done by the line. - Otherwise mapping continues with every line being processed. - Using '!' is most useful when you have a wildcard mapping line - later in the file.

For example to map from the name admin - or administrator to the UNIX name - root you would use:

root = admin administrator

Or to map anyone in the UNIX group system - to the UNIX name sys you would use:

sys = @system

You can have as many mappings as you like in a username map file.

If your system supports the NIS NETGROUP option then - the netgroup database is checked before the /etc/group - database for matching groups.

You can map Windows usernames that have spaces in them - by using double quotes around the name. For example:

tridge = "Andrew Tridgell"

would map the windows username "Andrew Tridgell" to the - unix username "tridge".

The following example would map mary and fred to the - unix user sys, and map the rest to guest. Note the use of the - '!' to tell Samba to stop processing if it gets a match on - that line.

-!sys = mary fred
-guest = *
-

Note that the remapping is applied to all occurrences - of usernames. Thus if you connect to \\server\fred and - fred is remapped to mary then you - will actually be connecting to \\server\mary and will need to - supply a password suitable for mary not - fred. The only exception to this is the - username passed to the (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.

Default: no username map

Example: username map = /usr/local/samba/lib/users.map

users (S)

Synonym for .

use sendfile (S)

If this parameter is yes, and Samba - was built with the --with-sendfile-support option, and the underlying operating - system supports sendfile system call, then some SMB read calls (mainly ReadAndX - and ReadRaw) will use the more efficient sendfile system call for files that - are exclusively oplocked. This may make more efficient use of the system CPU's - and cause Samba to be faster. This is off by default as it's effects are unknown - as yet.

Default: use sendfile = no

use spnego (G)

This variable controls controls whether samba will try - to use Simple and Protected NEGOciation (as specified by rfc2478) with - WindowsXP and Windows2000 clients to agree upon an authentication mechanism. - Unless further issues are discovered with our SPNEGO - implementation, there is no reason this should ever be - disabled.

Default: use spnego = yes

utmp (G)

This boolean parameter is only available if - Samba has been configured and compiled with the option - --with-utmp. If set to yes then Samba will attempt - to add utmp or utmpx records (depending on the UNIX system) whenever a - connection is made to a Samba server. Sites may use this to record the - user connecting to a Samba share.

Due to the requirements of the utmp record, we - are required to create a unique identifier for the - incoming user. Enabling this option creates an n^2 - algorithm to find this number. This may impede - performance on large installations.

See also the parameter.

Default: utmp = no

utmp directory (G)

This parameter is only available if Samba has - been configured and compiled with the option - --with-utmp. It specifies a directory pathname that is - used to store the utmp or utmpx files (depending on the UNIX system) that - record user connections to a Samba server. See also the parameter. By default this is - not set, meaning the system will use whatever utmp file the - native system is set to use (usually - /var/run/utmp on Linux).

Default: no utmp directory

Example: utmp directory = /var/run/utmp

-valid (S)

This parameter indicates whether a share is - valid and thus can be used. When this parameter is set to false, - the share will be in no way visible nor accessible. -

- 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: True

valid users (S)

This is a list of users that should be allowed - to login to this service. Names starting with '@', '+' and '&' - are interpreted using the same rules as described in the - invalid users parameter.

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.

See also

Default: No valid users list (anyone can login) -

Example: valid users = greg, @pcusers

veto files (S)

This is a list of files and directories that - are neither visible nor accessible. 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 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.

See also and .

Default: No files or directories are vetoed. -

Examples: -

-; 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/
-

veto oplock files (S)

This parameter is only valid when the - parameter is turned on for a share. It allows the Samba administrator - to selectively turn off the granting of oplocks on selected files that - match a wildcarded list, similar to the wildcarded list used in the - - parameter.

Default: No files are vetoed for oplock grants

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 :

Example: veto oplock files = /*.SEM/

vfs object (S)

Synonym for - . -

vfs objects (S)

This parameter specifies the backend names which - are used for Samba VFS I/O operations. By default, normal - disk I/O operations are used but these can be overloaded - with one or more VFS objects.

Default: no value

Example: vfs objects = extd_audit recycle

volume (S)

This allows you to override the volume label - returned for a share. Useful for CDROMs with installation programs - that insist on a particular volume label.

Default: the name of the share

wide links (S)

This parameter controls whether or not links - in the UNIX file system may be followed by the server. Links - that point to areas within the directory tree exported by the - server are always allowed; this parameter controls access only - to areas that are outside the directory tree being exported.

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 parameter specifies the number of - seconds the winbindd(8) daemon will cache - user and group information before querying a Windows NT server - again.

Default: winbind cache type = 300

winbind enable local accounts (G)

This parameter controls whether or not winbindd - will act as a stand in replacement for the various account - management hooks in smb.conf (e.g. 'add user script'). - If enabled, winbindd will support the creation of local - users and groups as another source of UNIX account information - available via getpwnam() or getgrgid(), etc... -

Default: winbind enable local accounts = yes

winbind enum groups (G)

On large installations using winbindd(8) it may be necessary to suppress - the enumeration of groups through the setgrent(), - getgrent() and - endgrent() group of system calls. If - the winbind enum groups parameter is - no, calls to the getgrent() system - call will not return any data.

Warning: Turning off group - enumeration may cause some programs to behave oddly. -

Default: winbind enum groups = yes

winbind enum users (G)

On large installations using winbindd(8) it may be - necessary to suppress the enumeration of users through the setpwent(), - getpwent() and - endpwent() group of system calls. If - the winbind enum users parameter is - no, calls to the getpwent system call - will not return any data.

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 = yes

winbind gid (G)

This parameter is now an alias for idmap gid

The winbind gid parameter specifies the range of group - ids that are allocated by the winbindd(8) daemon. This range of group ids should have no - existing local or NIS groups within it as strange conflicts can - occur otherwise.

Default: winbind gid = <empty string>

Example: winbind gid = 10000-20000

winbind separator (G)

This parameter allows an admin to define the character - used when listing a username of the form of DOMAIN -\user. This parameter - is only applicable when using the pam_winbind.so - and nss_winbind.so modules for UNIX services. -

Please note that setting this parameter to + causes problems - with group membership at least on glibc systems, as the character + - is used as a special character for NIS in /etc/group.

Default: winbind separator = '\'

Example: winbind separator = +

winbind trusted domains only (G)

This parameter is designed to allow Samba servers that - are members of a Samba controlled domain to use UNIX accounts - distributed vi NIS, rsync, or LDAP as the uid's for winbindd users - in the hosts primary domain. Therefore, the user 'SAMBA\user1' would - be mapped to the account 'user1' in /etc/passwd instead of allocating - a new uid for him or her. -

Default: winbind trusted domains only = <no>

winbind uid (G)

This parameter is now an alias for idmap uid

The winbind gid parameter specifies the range of user ids that are allocated by the - winbindd(8) - daemon. This range of ids should have no existing local or NIS users within it as strange - conflicts can occur otherwise.

Default: winbind uid = <empty string>

Example: winbind uid = 10000-20000

winbind use default domain (G)

This parameter specifies whether the - winbindd(8) daemon should operate on users - without domain component in their username. Users without a domain - component are treated as is part of the winbindd server's own - domain. While this does not benifit Windows users, it makes SSH, FTP and - e-mail function in a way much closer to the way they - would in a native unix system.

Default: winbind use default domain = <no>

Example: winbind use default domain = yes

wins hook (G)

When Samba is running as a WINS server this - allows you to call an external program for all changes to the - WINS database. The primary use for this option is to allow the - dynamic update of external name resolution databases such as - dynamic DNS.

The wins hook parameter specifies the name of a script - or executable that will be called as follows:

wins_hook operation name nametype ttl IP_list

The first argument is the operation and is - one of "add", "delete", or - "refresh". In most cases the operation - can be ignored as the rest of the parameters - provide sufficient information. Note that - "refresh" may sometimes be called when - the name has not previously been added, in that - case it should be treated as an add.
The second argument is the NetBIOS name. If the - name is not a legal name then the wins hook is not called. - Legal names contain only letters, digits, hyphens, underscores - and periods.
The third argument is the NetBIOS name - type as a 2 digit hexadecimal number.
The fourth argument is the TTL (time to live) - for the name in seconds.
The fifth and subsequent arguments are the IP - addresses currently registered for that name. If this list is - empty then the name should be deleted.

An example script that calls the BIND dynamic DNS update - program nsupdate is provided in the examples - directory of the Samba source code.

wins partners (G)

A space separated list of partners' IP addresses for - WINS replication. WINS partners are always defined as push/pull - partners as defining only one way WINS replication is unreliable. - WINS replication is currently experimental and unreliable between - samba servers. -

Default: wins partners =

Example: wins partners = 192.168.0.1 172.16.1.2

wins proxy (G)

This is a boolean that controls if nmbd(8) will respond to broadcast name - queries on behalf of other hosts. You may need to set this - to yes for some older clients.

Default: wins proxy = no

wins server (G)

This specifies the IP address (or DNS name: IP - address for preference) of the WINS server that nmbd(8) should register with. If you have a WINS server on - your network then you should set this to the WINS server's IP.

You should point this at your WINS server if you have a - multi-subnetted network.

If you want to work in multiple namespaces, you can - give every wins server a 'tag'. For each tag, only one - (working) server will be queried for a name. The tag should be - seperated 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 .

Default: not enabled

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)

This boolean controls if the nmbd(8) process in Samba will act as a WINS server. You should - not set this to yes unless you have a multi-subnetted network and - you wish a particular nmbd to be your WINS server. - Note that you should NEVER set this to yes - on more than one machine in your network.

Default: wins support = no

workgroup (G)

This controls what workgroup your server will - appear to be in when queried by clients. Note that this parameter - also controls the Domain name used with - the - setting.

Default: set at compile time to WORKGROUP

Example: workgroup = MYGROUP

writable (S)

Synonym for for people who can't spell :-).

writeable (S)

Inverted synonym for .

write cache size (S)

If this integer parameter is set to non-zero value, - Samba will create an in-memory cache for each oplocked file - (it does not do this for - non-oplocked files). All writes that the client does not request - to be flushed directly to disk will be stored in this cache if possible. - The cache is flushed onto disk when a write comes in whose offset - would not fit into the cache or when the file is closed by the client. - Reads for the file are also served from this cache if the data is stored - within it.

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)

This is a list of users that are given read-write - access to a service. If the connecting user is in this list then - they will be given write access, no matter what the - option is set to. The list can include group names using the - @group syntax.

Note that if a user is in both the read list and the - write list then they will be given write access.

WARNINGS

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.

VERSION

This man page is correct for version 3.0 of the Samba suite.

AUTHOR

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.

Name

SYNOPSIS

FILE FORMAT

SECTION DESCRIPTIONS

SPECIAL SECTIONS

The [global] section

The [homes] section

The [printers] section

Note

PARAMETERS

VARIABLE SUBSTITUTIONS

NAME MANGLING

NOTE ABOUT USERNAME/PASSWORD VALIDATION

COMPLETE LIST OF GLOBAL PARAMETERS

COMPLETE LIST OF SERVICE PARAMETERS

EXPLANATION OF EACH PARAMETER

Note

Note

Note

Note

Note

Note

Note

Note

Note

Note

WARNINGS

VERSION

SEE ALSO

AUTHOR