editreg — A utility for printing and editing NT4 registry files +
editreg [-v] [-c file] {file}
This tool is part of the samba(7) suite.
editreg is a utility that + can visualize windows registry files (currently only NT4) and apply + so-called commandfiles to them. +
findsmb — list info about machines that respond to SMB + name queries on a subnet
findsmb [subnet broadcast address]
This perl script is part of the samba(7) + suite.
findsmb is a perl script that + prints out several pieces of information about machines + on a subnet that respond to SMB name query requests. + It uses nmblookup(1) + and smbclient(1) + to obtain this information. +
Controls whether findsmb takes
+ bugs in Windows95 into account when trying to find a Netbios name
+ registered of the remote machine. This option is disabled by default
+ because it is specific to Windows 95 and Windows 95 machines only.
+ If set, nmblookup(1)
+ will be called with -B option.
Without this option, findsmb
+ will probe the subnet of the machine where
+ findsmb(1)
+ is run. This value is passed to
+ nmblookup(1)
+ as part of the -B option.
The output of findsmb lists the following + information for all machines that respond to the initial + nmblookup for any name: IP address, NetBIOS name, + Workgroup name, operating system, and SMB server version.
There will be a '+' in front of the workgroup name for + machines that are local master browsers for that workgroup. There + will be an '*' in front of the workgroup name for + machines that are the domain master browser for that workgroup. + Machines that are running Windows for Workgroups, Windows 95 or + Windows 98 will + not show any information about the operating system or server + version.
The command with -r option
+ must be run on a system without nmbd(8) running.
+
+ If nmbd is running on the system, you will
+ only get the IP address and the DNS name of the machine. To
+ get proper responses from Windows 95 and Windows 98 machines,
+ the command must be run as root and with -r
+ option on a machine without nmbd running.
For example, running findsmb
+ without -r option set would yield output similar
+ to the following
+IP ADDR NETBIOS NAME WORKGROUP/OS/VERSION +--------------------------------------------------------------------- +192.168.35.10 MINESET-TEST1 [DMVENGR] +192.168.35.55 LINUXBOX *[MYGROUP] [Unix] [Samba 2.0.6] +192.168.35.56 HERBNT2 [HERB-NT] +192.168.35.63 GANDALF [MVENGR] [Unix] [Samba 2.0.5a for IRIX] +192.168.35.65 SAUNA [WORKGROUP] [Unix] [Samba 1.9.18p10] +192.168.35.71 FROGSTAR [ENGR] [Unix] [Samba 2.0.0 for IRIX] +192.168.35.78 HERBDHCP1 +[HERB] +192.168.35.88 SCNT2 +[MVENGR] [Windows NT 4.0] [NT LAN Manager 4.0] +192.168.35.93 FROGSTAR-PC [MVENGR] [Windows 5.0] [Windows 2000 LAN Manager] +192.168.35.97 HERBNT1 *[HERB-NT] [Windows NT 4.0] [NT LAN Manager 4.0] +
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.
A utility for printing and editing NT4 registry files + +
list info about machines that respond to SMB + name queries on a subnet +
An extension library for browsers and that can be used as a generic browsing API. +
The Samba NetBIOS hosts file +
Extract network traces from Samba log files +
mount using the Common Internet File System (CIFS) +
Tool for administration of Samba and remote + CIFS servers. + +
NetBIOS name server to provide NetBIOS + over IP naming services to clients +
NetBIOS over TCP/IP client used to lookup NetBIOS + names +
tool to allow external access to Winbind's NTLM authentication function +
PAM module for Winbind +
manage the SAM database (Database of Samba Users) +
A utility to report and change SIDs in registry files + +
tool for executing client side + MS-RPC functions +
A Windows SMB/CIFS fileserver for UNIX +
The configuration file for the Samba suite +
Set or get ACLs on an NT file or directory names +
ftp-like client to access SMB/CIFS resources + on servers +
send messages to smbd, nmbd or winbindd processes +
Set or get QUOTAs of NTFS 5 shares +
server to provide SMB/CIFS services to clients +
wget-like utility for download files over SMB +
configuration file for smbget +
helper utility for mounting SMB filesystems +
mount an smbfs filesystem +
The Samba encrypted password file +
change a user's SMB password +
Allows access to remote SMB shares + using UNIX commands +
send a print file to an SMB printer +
report on current Samba connections +
shell script for backing up SMB/CIFS shares + directly to UNIX tape drives +
A text based smb network browser + +
smbfs umount for normal users +
Samba Web Administration Tool +
tool for backing up and for validating the integrity of samba .tdb files +
tool for printing the contents of a TDB file +
check an smb.conf configuration file for + internal correctness +
check printer name for validity with smbd +
for normal, non-root users, to unmount their own Common Internet File System (CIFS) mounts +
tool for testing samba VFS modules +
Query information from winbind daemon +
Name Service Switch daemon for resolving names + from NT servers +
libsmbclient — An extension library for browsers and that can be used as a generic browsing API.
Browser URL:
+ smb://[[[domain:]user[:password@]]server[/share[/path[/file]]]] [?options] +
+ This tool is part of the samba(8) suite. +
+ libsmbclient is a library toolset that permits applications + to manipulate CIFS/SMB network resources using many of the standards POSIX functions + available for manipulating local UNIX/Linux files. It permits much more than just browsing, + files can be opened and read or written, permissions changed, file times modified, attributes + and ACL's can be manipulated, and so on. Of course, its functionality includes all the + capabilities commonly called browsing. +
+ libsmbclient can not be used directly from the command line, instead + it provides an extension of the capabilities of tools such as file managers and browsers. + This man page describes the configuration options for this tool so that the user may + obtain greatest utility of use. +
+ What the URLs mean: +
+ Shows all workgroups or domains that are visible in the network. The behavior matches + that of the Microsoft Windows Explorer. +
+ The method of locating the list of workgroups (domains also) varies depending on the setting of
+ the context variable (context->options.browse_max_lmb_count). It is the
+ responsibility of the application that calls this library to set this to a sensible value. This
+ is a compile-time option. This value determines the maximum number of local master browsers to
+ query for the list of workgroups. In order to ensure that the list is complete for those present
+ on the network, all master browsers must be querried. If there are a large number of workgroups
+ on the network, the time spent querying will be significant. For small networks (just a few
+ workgroups), it is suggested to set this value to 0, instructing libsmbclient to query all local
+ master browsers. In an environment that has many workgroups a more reasonable setting may be around 3.
+
+ This command causes libsmbclient to perform a name look-up. If the NAME<1D> or + NAME<1B> exists (workgroup name), libsmbclient will list all servers in the + workgroup (or domain). Otherwise, a name look-up for the NAME<20> (machine name) + will be performed, and the list of shared resources on the server will be displayed. +
+ When libsmbclient is invoked by an application it searches for a directory called
+ .smb in the $HOME directory that is specified in the users shell
+ environment. It then searches for a file called smb.conf which,
+ if present, will fully over-ride the system /etc/samba/smb.conf file. If
+ instead libsmbclient finds a file called ~/.smb/smb.conf.append,
+ it will read the system /etc/samba/smb.conf and then append the
+ contents of the ~/.smb/smb.conf.append to it.
+
+ libsmbclient will check the users shell environment for the USER
+ parameter and will use its value when if the user parameter was not included
+ in the URL.
+
lmhosts — The Samba NetBIOS hosts file
lmhosts is the samba(7) NetBIOS name to IP address mapping file.
This file is part of the samba(7) suite.
lmhosts is the Samba
+ NetBIOS name to IP address mapping file. It
+ is very similar to the /etc/hosts file
+ format, except that the hostname component must correspond
+ to the NetBIOS naming format.
It is an ASCII file containing one line for NetBIOS name. + The two fields on each line are separated from each other by + white space. Any entry beginning with '#' is ignored. Each line + in the lmhosts file contains the following information:
IP Address - in dotted decimal format.
NetBIOS Name - This name format is a + maximum fifteen character host name, with an optional + trailing '#' character followed by the NetBIOS name type + as two hexadecimal digits.
If the trailing '#' is omitted then the given IP + address will be returned for all names that match the given + name, whatever the NetBIOS name type in the lookup.
An example follows:
+# +# Sample Samba lmhosts file. +# +192.9.200.1 TESTPC +192.9.200.20 NTSERVER#20 +192.9.200.21 SAMBASERVER +
Contains three IP to NetBIOS name mappings. The first + and third will be returned for any queries for the names "TESTPC" + and "SAMBASERVER" respectively, whatever the type component of + the NetBIOS name requested.
The second mapping will be returned only when the "0x20" name + type for a name "NTSERVER" is queried. Any other name type will not + be resolved.
The default location of the lmhosts file
+ is in the same directory as the smb.conf(5) file.
lmhosts is loaded from the configuration directory. This is
+ usually /etc/samba or /usr/local/samba/lib.
+
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 was done by Alexander Bokovoy.
log2pcap — Extract network traces from Samba log files
log2pcap [-h] [-q] [logfile] [pcap_file]
This tool is part of the samba(7) suite.
log2pcap reads in a + samba log file and generates a pcap file (readable + by most sniffers, such as ethereal or tcpdump) based on the packet + dumps in the log file.
The log file must have a log level
+ of at least 5 to get the SMB header/parameters
+ right, 10 to get the first 512 data bytes of the
+ packet and 50 to get the whole packet.
+
If this parameter is + specified the output file will be a + hex dump, in a format that is readable + by the text2pcap utility.
Be quiet. No warning messages about missing + or incomplete data will be given.
+ Samba log file. log2pcap will try to read the log from stdin + if the log file is not specified. +
+ Name of the output file to write the pcap (or hexdump) data to. + If this argument is not specified, output data will be written + to stdout. +
Print a summary of command line options. +
Extract all network traffic from all samba log files:
+ $ log2pcap < /var/log/* > trace.pcap
+ Convert to pcap using text2pcap:
+ $ log2pcap -h samba.log | text2pcap -T 139,139 - trace.pcap
+ mount.cifs — mount using the Common Internet File System (CIFS)
mount.cifs {service} {mount-point} [-o options]
This tool is part of the samba(7) suite.
mount.cifs mounts a Linux CIFS filesystem. It +is usually invoked indirectly by +the mount(8) command when using the +"-t cifs" option. This command only works in Linux, and the kernel must +support the cifs filesystem. The CIFS protocol is the successor to the +SMB protocol and is supported by most Windows servers and many other +commercial servers and Network Attached Storage appliances as well as +by the popular Open Source server Samba. +
+ The mount.cifs utility attaches the UNC name (exported network resource) to + the local directory mount-point. It is possible to set the mode for mount.cifs to +setuid root to allow non-root users to mount shares to directories for which they +have write permission. +
+ Options to mount.cifs are specified as a comma-separated +list of key=value pairs. It is possible to send options other +than those listed here, assuming that the cifs filesystem kernel module (cifs.ko) supports them. +Unrecognized cifs mount options passed to the cifs vfs kernel code will be logged to the +kernel log. + +
mount.cifs causes the cifs vfs to launch a thread named cifsd. After mounting it keeps running until + the mounted resource is unmounted (usually via the umount utility). +
argspecifies the username to connect as. If + this is not given, then the environment variable USER is used. This option can also take the +form "user%password" or "workgroup/user" or +"workgroup/user%password" to allow the password and workgroup +to be specified as part of the username. +
+ The cifs vfs accepts the parameter user=, or for users familiar with smbfs it accepts the longer form of the parameter username=. Similarly the longer smbfs style parameter names may be accepted as synonyms for the shorter cifs parameters pass=,dom= and cred=.
+
argspecifies the CIFS password. If this +option is not given then the environment variable +PASSWD is used. If the password is not specified +directly or indirectly via an argument to mount mount.cifs will prompt +for a password, unless the guest option is specified. +
Note that a password which contains the delimiter +character (i.e. a comma ',') will fail to be parsed correctly +on the command line. However, the same password defined +in the PASSWD environment variable or via a credentials file (see +below) or entered at the password prompt will be read correctly. +
filename+ specifies a file that contains a username + and/or password. The format of the file is: +
+ username=value+ password=value+
+This is preferred over having passwords in plaintext in a
+shared file, such as /etc/fstab. Be sure to protect any
+credentials file properly.
+
argsets the uid that will own all files on + the mounted filesystem. + It may be specified as either a username or a numeric uid. + This parameter is ignored when the target server supports + the CIFS Unix extensions.
argsets the gid that will own all files on +the mounted filesystem. +It may be specified as either a groupname or a numeric +gid. This parameter is ignored when the target server supports +the CIFS Unix extensions. +
argsets the port number on the server to attempt to contact to negotiate +CIFS support. If the CIFS server is not listening on this port or +if it is not specified, the default ports will be tried i.e. +port 445 is tried and if no response then port 139 is tried. +
argWhen mounting to servers via port 139, specifies the RFC1001 + source name to use to represent the client netbios machine + name when doing the RFC1001 netbios session initialize. +
argIf the server does not support the CIFS Unix extensions this + overrides the default file mode.
argIf the server does not support the CIFS Unix extensions this + overrides the default mode for directories.
argsets the destination host or IP address.
argsets the domain (workgroup) of the user
don't prompt for a password
Charset used to convert local path names to and from + Unicode. Unicode is used by default for network path + names if the server supports it. If iocharset is + not specified then the nls_default specified + during the local client kernel build will be used. + If server does not support Unicode, this parameter is + unused.
mount read-only
mount read-write
If the CIFS Unix extensions are negotiated with the server + the client will attempt to set the effective uid and gid of + the local process on newly created files, directories, and + devices (create, mkdir, mknod).
The client will not attempt to set the uid and gid on + on newly created files, directories, and devices (create, + mkdir, mknod) which will result in the server setting the + uid and gid to the default (usually the server uid of the + user who mounted the share). Letting the server (rather than + the client) set the uid and gid is the default. This + parameter has no effect if the CIFS Unix Extensions are not + negotiated.
Client does permission checks (vfs_permission check of uid + and gid of the file against the mode and desired operation), + Note that this is in addition to the normal ACL check on the + target machine done by the server software. + Client permission checking is enabled by default.
Client does not do permission checks. This can expose + files on this mount to access by other users on the local + client system. It is typically only needed when the server + supports the CIFS Unix Extensions but the UIDs/GIDs on the + client and server system do not match closely enough to allow + access by the user doing the mount. + Note that this does not affect the normal ACL check on the + target machine done by the server software (of the server + ACL against the user name provided at mount time).
Do not do inode data caching on files opened on this mount. + This precludes mmaping files on this mount. In some cases + with fast networks and little or no caching benefits on the + client (e.g. when the application is doing large sequential + reads bigger than page size without rereading the same data) + this can provide better performance than the default + behavior which caches reads (readahead) and writes + (writebehind) through the local Linux client pagecache + if oplock (caching token) is granted and held. Note that + direct allows write operations larger than page size + to be sent to the server. On some kernels this requires the cifs.ko module + to be built with the CIFS_EXPERIMENTAL configure option.
Translate six of the seven reserved characters (not backslash, but including the colon, question mark, pipe, asterik, greater than and less than characters) + to the remap range (above 0xF000), which also + allows the CIFS client to recognize files created with + such characters by Windows's POSIX emulation. This can + also be useful when mounting to most versions of Samba + (which also forbids creating and opening files + whose names contain any of these seven characters). + This has no effect if the server does not support + Unicode on the wire.
Do not translate any of these seven characters (default)
currently unimplemented
(default) currently unimplemented
The program accessing a file on the cifs mounted file system will hang when the + server crashes.
(default) The program accessing a file on the cifs mounted file system will not hang when the server crashes and will return errors to the user application.
Print additional debugging information for the mount. Note that this parameter must be specified before the -o. For example:
mount -t cifs //server/share /mnt --verbose -o user=username
Do not allow POSIX ACL operations even if server would support them.
+ The CIFS client can get and set POSIX ACLs (getfacl, setfacl) to Samba servers + version 3.10 and later. Setting POSIX ACLs requires enabling both XATTR and + then POSIX support in the CIFS configuration options when building the cifs + module. POSIX ACL support can be disabled on a per mount basic by specifying + "noacl" on mount.
Use inode numbers (unique persistent file identifiers) + returned by the server instead of automatically generating + temporary inode numbers on the client. Although server inode numbers + make it easier to spot hardlinked files (as they will have + the same inode numbers) and inode numbers may be persistent (which is + userful for some sofware), + the server does not guarantee that the inode numbers + are unique if multiple server side mounts are exported under a + single share (since inode numbers on the servers might not + be unique if multiple filesystems are mounted under the same + shared higher level directory). Note that not all + servers support returning server inode numbers, although + those that support the CIFS Unix Extensions, and Windows 2000 and + later servers typically do support this (although not necessarily + on every local server filesystem). Parameter has no effect if + the server lacks support for returning inode numbers or equivalent. +
client generates inode numbers (rather than using the actual one + from the server) by default. +
(default) Do not allow getfattr/setfattr to get/set xattrs, even if server would support it otherwise.
argdefault network read size
argdefault network write size
+ The variable USER may contain the username of the +person to be used to authenticate to the server. +The variable can be used to set both username and +password by using the format username%password. +
+ The variable PASSWD may contain the password of the +person using the client. +
+ The variable PASSWD_FILE may contain the pathname +of a file to read the password from. A single line of input is +read and used as the password. +
This command may be used only by root, unless installed setuid, in which case the noeexec and nosuid mount flags are enabled.
+The primary mechanism for making configuration changes and for reading
+debug information for the cifs vfs is via the Linux /proc filesystem.
+In the directory /proc/fs/cifs are various
+configuration files and pseudo files which can display debug information.
+For more information see the kernel file fs/cifs/README.
+
Mounting using the CIFS URL specification is currently not supported. +
The credentials file does not handle usernames or passwords with + leading space.
+Note that the typical response to a bug report is a suggestion +to try the latest version first. So please try doing that first, +and always include which versions you use of relevant software +when reporting bugs (minimum: mount.cifs (try mount.cifs -V), kernel (see /proc/version) and +server type you are trying to contact. +
This man page is correct for version 1.34 of + the cifs vfs filesystem (roughly Linux kernel 2.6.12).
+ Documentation/filesystems/cifs.txt and fs/cifs/README in the linux kernel + source tree may contain additional options and information. +
Steve French
The syntax and manpage were loosely based on that of smbmount. It + was converted to Docbook/XML by Jelmer Vernooij.
The maintainer of the Linux cifs vfs and the userspace + tool mount.cifs is Steve French. + The Linux CIFS Mailing list + is the preferred place to ask questions regarding these programs. +
net — Tool for administration of Samba and remote + CIFS servers. +
net {<ads|rap|rpc>} [-h] [-w workgroup] [-W myworkgroup] [-U user] [-I ip-address] [-p port] [-n myname] [-s conffile] [-S server] [-l] [-P] [-D debuglevel]
This tool is part of the samba(7) suite.
The samba net utility is meant to work just like the net utility + available for windows and DOS. The first argument should be used + to specify the protocol to use when executing a certain command. + ADS is used for ActiveDirectory, RAP is using for old (Win9x/NT3) + clients and RPC can be used for NT4 and Windows 2000. If this + argument is omitted, net will try to determine it automatically. + Not all commands are available on all protocols. +
Print a summary of command line options. +
+ Sets target workgroup or domain. You have to specify + either this option or the IP address or the name of a server. +
+ Sets client workgroup or domain +
+ User name to use +
+ IP address of target server to use. You have to + specify either this option or a target workgroup or + a target server. +
+ Port on the target server to connect to (usually 139 or 445). + Defaults to trying 445 first, then 139. +
This option allows you to override
+the NetBIOS name that Samba uses for itself. This is identical
+to setting the parameter in the smb.conf file.
+However, a command
+line setting will take precedence over settings in
+smb.conf.
The file specified contains the
+configuration details required by the server. The
+information in this file includes server-specific
+information such as what printcap file to use, as well
+as descriptions of all the services that the server is
+to provide. See smb.conf for more information.
+The default configuration file name is determined at
+compile time.
+ Name of target server. You should specify either + this option or a target workgroup or a target IP address. +
+ When listing data, give more information on each item. +
+ Make queries to the external server using the machine account of the local server. +
debuglevel is an integer
+from 0 to 10. The default value if this parameter is
+not specified is zero.
The higher this value, the more detail will be +logged to the log files about the activities of the +server. At level 0, only critical errors and serious +warnings will be logged. Level 1 is a reasonable level for +day-to-day running - it generates a small amount of +information about operations carried out.
Levels above 1 will generate considerable +amounts of log data, and should only be used when +investigating a problem. Levels above 3 are designed for +use only by developers and generate HUGE amounts of log +data, most of which is extremely cryptic.
Note that specifying this parameter here will
+override the parameter
+in the smb.conf file.
This command allows the Samba machine account password to be set from an external application +to a machine account password that has already been stored in Active Directory. DO NOT USE this command +unless you know exactly what you are doing. The use of this command requires that the force flag (-f) +be used also. There will be NO command prompt. Whatever information is piped into stdin, either by +typing at the command line or otherwise, will be stored as the literal machine password. Do NOT use +this without care and attention as it will overwrite a legitimate machine password without warning. +YOU HAVE BEEN WARNED. +
The NET TIME command allows you to view the time on a remote server + or synchronise the time on the local server with the time on the remote server.
+Join a domain. If the account already exists on the server, and +[TYPE] is MEMBER, the machine will attempt to join automatically. +(Assuming that the machine has been created in server manager) +Otherwise, a password will be prompted for, and a new account may +be created.
+[TYPE] may be PDC, BDC or MEMBER to specify the type of server +joining the domain. +
Join a domain. Use the OLDJOIN option to join the domain +using the old style of domain joining - you need to create a trust +account in server manager first.
Enumerates all exported resources (network shares) on target server.
user [password]+Validate whether the specified user can log in to the +remote server. If the password is not specified on the commandline, it +will be prompted. +
Currently NOT implemented.
commandExecute the specified command on
+the remote server. Only works with OS/2 servers.
+
Currently NOT implemented.
Samba uses a general caching interface called 'gencache'. It +can be controlled using 'NET CACHE'.
All the timeout parameters support the suffixes: + +
| s - Seconds |
| m - Minutes |
| h - Hours |
| d - Days |
| w - Weeks |
+ +
Print the SID of the specified domain, or if the parameter is +omitted, the SID of the domain the local server is in.
Manage the mappings between Windows group SIDs and UNIX groups. +Parameters take the for "parameter=value". Common options include:
unixgroup - Name of the UNIX group
ntgroup - Name of the Windows NT group (must be + resolvable to a SID
rid - Unsigned 32-bit integer
sid - Full SID in the form of "S-1-..."
type - Type of the group; either 'domain', 'local', + or 'builtin'
comment - Freeform text description of the group
+Add a new group mapping entry: +
+net groupmap add {rid=int|sid=string} unixgroup=string \
+ [type={domain|local}] [ntgroup=string] [comment=string]
++
Delete a group mapping entry. If more then one group name matches, the first entry found is deleted.
net groupmap delete {ntgroup=string|sid=SID}
Prints out the highest RID currently in use on the local +server (by the active 'passdb backend'). +
Print information about the domain of the remote server, +such as domain name, domain sid and number of users and groups. +
DOMAIMRemove interdomain trust account for
+DOMAIN from the remote server.
+
Currently NOT implemented.
Shut down the remote server.
+Reboot after shutdown. +
+Force shutting down all applications. +
+Timeout before system will be shut down. An interactive +user of the system can use this time to cancel the shutdown. +
Display the specified message on the screen to +announce the shutdown.
Export users, aliases and groups from remote server to +local server. Can only be run an a BDC. +
Print out status of machine account of the local machine in ADS. +Prints out quite some debug info. Aimed at developers, regular +users should use NET ADS TESTJOIN.
EXPRESSION ATTRIBUTES...Perform a raw LDAP search on a ADS server and dump the results. The +expression is a standard LDAP search expression, and the +attributes are a list of LDAP fields to show in the results.
Example: net ads search '(objectCategory=group)' sAMAccountName
+
nmbd — NetBIOS name server to provide NetBIOS + over IP naming services to clients
nmbd [-D] [-F] [-S] [-a] [-i] [-o] [-h] [-V] [-d <debug level>] [-H <lmhosts file>] [-l <log directory>] [-p <port number>] [-s <configuration file>]
This program is part of the samba(7) suite.
nmbd is a server that understands + and can reply to NetBIOS over IP name service requests, like + those produced by SMB/CIFS clients such as Windows 95/98/ME, + Windows NT, Windows 2000, Windows XP and LanManager clients. It also + participates in the browsing protocols which make up the + Windows "Network Neighborhood" view.
SMB/CIFS clients, when they start up, may wish to + locate an SMB/CIFS server. That is, they wish to know what + IP number a specified host is using.
Amongst other services, nmbd will
+ listen for such requests, and if its own NetBIOS name is
+ specified it will respond with the IP number of the host it
+ is running on. Its "own NetBIOS name" is by
+ default the primary DNS name of the host it is running on,
+ but this can be overridden by the netbios name
+ in smb.conf. Thus nmbd will
+ reply to broadcast queries for its own name(s). Additional
+ names for nmbd to respond on can be set
+ via parameters in the smb.conf(5) configuration file.
nmbd can also be used as a WINS + (Windows Internet Name Server) server. What this basically means + is that it will act as a WINS database server, creating a + database from name registration requests that it receives and + replying to queries from clients for these names.
In addition, nmbd can act as a WINS + proxy, relaying broadcast queries from clients that do + not understand how to talk the WINS protocol to a WINS + server.
If specified, this parameter causes + nmbd to operate as a daemon. That is, + it detaches itself and runs in the background, fielding + requests on the appropriate port. By default, nmbd + will operate as a daemon if launched from a command shell. + nmbd can also be operated from the inetd + meta-daemon, although this is not recommended. +
If specified, this parameter causes + the main nmbd process to not daemonize, + i.e. double-fork and disassociate with the terminal. + Child processes are still created as normal to service + each connection request, but the main process does not + exit. This operation mode is suitable for running + nmbd under process supervisors such + as supervise and svscan + from Daniel J. Bernstein's daemontools + package, or the AIX process monitor. +
If specified, this parameter causes + nmbd to log to standard output rather + than a file.
If this parameter is specified it causes the
+ server to run "interactively", not as a daemon, even if the
+ server is executed on the command line of a shell. Setting this
+ parameter negates the implicit daemon mode when run from the
+ command line. nmbd also logs to standard
+ output, as if the -S parameter had been
+ given.
Print a summary of command line options. +
NetBIOS lmhosts file. The lmhosts + file is a list of NetBIOS names to IP addresses that + is loaded by the nmbd server and used via the name + resolution mechanism name resolve order described in smb.conf(5) to resolve any + NetBIOS name queries needed by the server. Note + that the contents of this file are NOT + used by nmbd to answer any name queries. + Adding a line to this file affects name NetBIOS resolution + from this host ONLY.
The default path to this file is compiled into
+ Samba as part of the build process. Common defaults
+ are /usr/local/samba/lib/lmhosts,
+ /usr/samba/lib/lmhosts or
+ /etc/samba/lmhosts. See the lmhosts(5) man page for details on the contents of this file.
Prints the program version number. +
The file specified contains the
+configuration details required by the server. The
+information in this file includes server-specific
+information such as what printcap file to use, as well
+as descriptions of all the services that the server is
+to provide. See smb.conf for more information.
+The default configuration file name is determined at
+compile time.
debuglevel is an integer
+from 0 to 10. The default value if this parameter is
+not specified is zero.
The higher this value, the more detail will be +logged to the log files about the activities of the +server. At level 0, only critical errors and serious +warnings will be logged. Level 1 is a reasonable level for +day-to-day running - it generates a small amount of +information about operations carried out.
Levels above 1 will generate considerable +amounts of log data, and should only be used when +investigating a problem. Levels above 3 are designed for +use only by developers and generate HUGE amounts of log +data, most of which is extremely cryptic.
Note that specifying this parameter here will
+override the parameter
+in the smb.conf file.
Base directory name for log/debug files. The extension
+".progname" will be appended (e.g. log.smbclient,
+log.smbd, etc...). The log file is never removed by the client.
+
UDP port number is a positive integer value. + This option changes the default UDP port number (normally 137) + that nmbd responds to name queries on. Don't + use this option unless you are an expert, in which case you + won't need help!
/etc/inetd.confIf the server is to be run by the + inetd meta-daemon, this file + must contain suitable startup information for the + meta-daemon. +
/etc/rcor whatever initialization script your + system uses).
If running the server as a daemon at startup, + this file will need to contain an appropriate startup + sequence for the server.
/etc/servicesIf running the server via the + meta-daemon inetd, this file + must contain a mapping of service name (e.g., netbios-ssn) + to service port (e.g., 139) and protocol type (e.g., tcp). +
/usr/local/samba/lib/smb.confThis is the default location of
+ the smb.conf(5) server
+ configuration file. Other common places that systems
+ install this file are /usr/samba/lib/smb.conf
+ and /etc/samba/smb.conf.
When run as a WINS server (see the
+ wins support
+ parameter in the smb.conf(5) man page),
+ nmbd
+ will store the WINS database in the file wins.dat
+ in the var/locks directory configured under
+ wherever Samba was configured to install itself.
If nmbd is acting as a
+ browse master (see the local master
+ parameter in the smb.conf(5) man page, nmbd
+ will store the browsing database in the file browse.dat
+ in the var/locks directory
+ configured under wherever Samba was configured to install itself.
+
To shut down an nmbd process it is recommended + that SIGKILL (-9) NOT be used, except as a last + resort, as this may leave the name database in an inconsistent state. + The correct way to terminate nmbd is to send it + a SIGTERM (-15) signal and wait for it to die on its own.
nmbd will accept SIGHUP, which will cause
+ it to dump out its namelists into the file namelist.debug
+ in the /usr/local/samba/var/locks
+ directory (or the var/locks directory configured
+ under wherever Samba was configured to install itself). This will also
+ cause nmbd to dump out its server database in
+ the log.nmb file.
The debug log level of nmbd may be raised or lowered + using smbcontrol(1) (SIGUSR[1|2] signals + are no longer used since Samba 2.2). This is to allow + transient problems to be diagnosed, whilst still running + at a normally low log level.
+ inetd(8), smbd(8), smb.conf(5), smbclient(1), testparm(1), testprns(1), and the Internet
+ RFC's rfc1001.txt, rfc1002.txt.
+ In addition the CIFS (formerly SMB) specification is available
+ as a link from the Web page
+ http://samba.org/cifs/.
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.
nmblookup — NetBIOS over TCP/IP client used to lookup NetBIOS + names
nmblookup [-M] [-R] [-S] [-r] [-A] [-h] [-B <broadcast address>] [-U <unicast address>] [-d <debug level>] [-s <smb config file>] [-i <NetBIOS scope>] [-T] [-f] {name}
This tool is part of the samba(7) suite.
nmblookup is used to query NetBIOS names + and map them to IP addresses in a network using NetBIOS over TCP/IP + queries. The options allow the name queries to be directed at a + particular IP broadcast area or to a particular machine. All queries + are done over UDP.
Searches for a master browser by looking
+ up the NetBIOS name name with a
+ type of 0x1d. If
+ name is "-" then it does a lookup on the special name
+ __MSBROWSE__. Please note that in order to
+ use the name "-", you need to make sure "-" isn't parsed as an
+ argument, e.g. use :
+ nmblookup -M -- -.
Set the recursion desired bit in the packet + to do a recursive lookup. This is used when sending a name + query to a machine running a WINS server and the user wishes + to query the names in the WINS server. If this bit is unset + the normal (broadcast responding) NetBIOS processing code + on a machine is used instead. See RFC1001, RFC1002 for details. +
Once the name query has returned an IP + address then do a node status query as well. A node status + query returns the NetBIOS names registered by a host. +
Try and bind to UDP port 137 to send and receive UDP + datagrams. The reason for this option is a bug in Windows 95 + where it ignores the source port of the requesting packet + and only replies to UDP port 137. Unfortunately, on most UNIX + systems root privilege is needed to bind to this port, and + in addition, if the nmbd(8) daemon is running on this machine it also binds to this port. +
Interpret name as
+ an IP Address and do a node status query on this address.
This option allows you to override
+the NetBIOS name that Samba uses for itself. This is identical
+to setting the parameter in the smb.conf file.
+However, a command
+line setting will take precedence over settings in
+smb.conf.
This specifies a NetBIOS scope that +nmblookup will use to communicate with when +generating NetBIOS names. For details on the use of NetBIOS +scopes, see rfc1001.txt and rfc1002.txt. NetBIOS scopes are +very rarely used, only set this parameter +if you are the system administrator in charge of all the +NetBIOS systems you communicate with.
Set the SMB domain of the username. This +overrides the default domain which is the domain defined in +smb.conf. If the domain specified is the same as the servers +NetBIOS name, it causes the client to log on using the servers local +SAM (as opposed to the Domain SAM).
TCP socket options to set on the client
+socket. See the socket options parameter in
+the smb.conf manual page for the list of valid
+options.
Print a summary of command line options. +
Send the query to the given broadcast address. Without
+ this option the default behavior of nmblookup is to send the
+ query to the broadcast address of the network interfaces as
+ either auto-detected or defined in the interfaces
+ parameter of the smb.conf(5) file.
+
Do a unicast query to the specified address or
+ host unicast address. This option
+ (along with the -R option) is needed to
+ query a WINS server.
Prints the program version number. +
The file specified contains the
+configuration details required by the server. The
+information in this file includes server-specific
+information such as what printcap file to use, as well
+as descriptions of all the services that the server is
+to provide. See smb.conf for more information.
+The default configuration file name is determined at
+compile time.
debuglevel is an integer
+from 0 to 10. The default value if this parameter is
+not specified is zero.
The higher this value, the more detail will be +logged to the log files about the activities of the +server. At level 0, only critical errors and serious +warnings will be logged. Level 1 is a reasonable level for +day-to-day running - it generates a small amount of +information about operations carried out.
Levels above 1 will generate considerable +amounts of log data, and should only be used when +investigating a problem. Levels above 3 are designed for +use only by developers and generate HUGE amounts of log +data, most of which is extremely cryptic.
Note that specifying this parameter here will
+override the parameter
+in the smb.conf file.
Base directory name for log/debug files. The extension
+".progname" will be appended (e.g. log.smbclient,
+log.smbd, etc...). The log file is never removed by the client.
+
This causes any IP addresses found in the + lookup to be looked up via a reverse DNS lookup into a + DNS name, and printed out before each
IP address .... NetBIOS name
pair that is the normal output.
+ Show which flags apply to the name that has been looked up. Possible + answers are zero or more of: Response, Authoritative, + Truncated, Recursion_Desired, Recursion_Available, Broadcast. +
This is the NetBIOS name being queried. Depending + upon the previous options this may be a NetBIOS name or IP address. + If a NetBIOS name then the different name types may be specified + by appending '#<type>' to the name. This name may also be + '*', which will return all registered names within a broadcast + area.
nmblookup can be used to query + a WINS server (in the same way nslookup is + used to query DNS servers). To query a WINS server, nmblookup + must be called like this:
nmblookup -U server -R 'name'
For example, running :
nmblookup -U samba.org -R 'IRIX#1B'
would query the WINS server samba.org for the domain + master browser (1B name type) for the IRIX workgroup.
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.
ntlm_auth — tool to allow external access to Winbind's NTLM authentication function
ntlm_auth [-d debuglevel] [-l logdir] [-s <smb config file>]
This tool is part of the samba(7) suite.
ntlm_auth is a helper utility that authenticates + users using NT/LM authentication. It returns 0 if the users is authenticated + successfully and 1 if access was denied. ntlm_auth uses winbind to access + the user and authentication data for a domain. This utility + is only indended to be used by other programs (currently + Squid + and mod_ntlm_winbind) +
+ The winbindd(8) daemon must be operational + for many of these commands to function.
Some of these commands also require access to the directory
+ winbindd_privileged in
+ $LOCKDIR. This should be done either by running
+ this command as root or providing group access
+ to the winbindd_privileged directory. For
+ security reasons, this directory should not be world-accessable.
+ Operate as a stdio-based helper. Valid helper protocols are: +
+ Server-side helper for use with Squid 2.4's basic (plaintext) + authentication.
+ Server-side helper for use with Squid 2.5's basic (plaintext) + authentication.
+ Server-side helper for use with Squid 2.5's NTLMSSP + authentication.
Requires access to the directory
+ winbindd_privileged in
+ $LOCKDIR. The protocol used is
+ described here: http://devel.squid-cache.org/ntlm/squid_helper_protocol.html.
+ This protocol has been extended to allow the
+ NTLMSSP Negotiate packet to be included as an argument
+ to the YR command. (Thus avoiding
+ loss of information in the protocol exchange).
+
+ Client-side helper for use with arbitary external + programs that may wish to use Samba's NTLMSSP + authentication knowlege.
This helper is a client, and as such may be run by any + user. The protocol used is + effectivly the reverse of the previous protocol. A + YR command (without any arguments) + starts the authentication exchange. +
+ Server-side helper that implements GSS-SPNEGO. This + uses a protocol that is almost the same as + squid-2.5-ntlmssp, but has some + subtle differences that are undocumented outside the + source at this stage. +
Requires access to the directory
+ winbindd_privileged in
+ $LOCKDIR.
+
+ Client-side helper that implements GSS-SPNEGO. This + also uses a protocol similar to the above helpers, but + is currently undocumented. +
+ Server-side helper protocol, intended for use by a + RADIUS server or the 'winbind' plugin for pppd, for + the provision of MSCHAP and MSCHAPv2 authentication. +
This protocol consists of lines in for form: + Parameter: value and Paramter:: + Base64-encode value. The presence of a single + period . indicates that one side has + finished supplying data to the other. (Which in turn + could cause the helper to authenticate the + user).
Curently implemented parameters from the + external program to the helper are:
The user's domain, expected to be in + Samba's unix charset. +
The fully qualified username, expected to be in + Samba's and qualified with the + winbind separator. +
The 8 byte LANMAN Challenge value, + generated randomly by the server, or (in cases such as + MSCHAPv2) generated in some way by both the server and + the client. +
The 24 byte LANMAN Response value, + calculated from the user's password and the supplied + LANMAN Challenge. Typically, this + is provided over the network by a client wishing to authenticate. +
The >= 24 byte NT Response + calculated from the user's password and the supplied + LANMAN Challenge. Typically, this is + provided over the network by a client wishing to authenticate. +
The user's password. This would be + provided by a network client, if the helper is being + used in a legacy situation that exposes plaintext + passwords in this way. +
Apon sucessful authenticaiton, return + the user session key associated with the login. +
Apon sucessful authenticaiton, return + the LANMAN session key associated with the login. +
+ Specify username of user to authenticate +
+ Specify domain of user to authenticate +
+ Specify the workstation the user authenticated from +
NTLM challenge (in HEXADECIMAL)
LM Response to the challenge (in HEXADECIMAL)
NT or NTLMv2 Response to the challenge (in HEXADECIMAL)
User's plaintext password
If + not specified on the command line, this is prompted for when + required.
For the NTLMSSP based server roles, this paramter + specifies the expected password, allowing testing without + winbindd operational.
Retreive LM session key
Request NT key
Perform Diagnostics on the authentication + chain. Uses the password from --password + or prompts for one.
Require that a user be a member of specified + group (either name or SID) for authentication to succeed.
Prints the program version number. +
The file specified contains the
+configuration details required by the server. The
+information in this file includes server-specific
+information such as what printcap file to use, as well
+as descriptions of all the services that the server is
+to provide. See smb.conf for more information.
+The default configuration file name is determined at
+compile time.
debuglevel is an integer
+from 0 to 10. The default value if this parameter is
+not specified is zero.
The higher this value, the more detail will be +logged to the log files about the activities of the +server. At level 0, only critical errors and serious +warnings will be logged. Level 1 is a reasonable level for +day-to-day running - it generates a small amount of +information about operations carried out.
Levels above 1 will generate considerable +amounts of log data, and should only be used when +investigating a problem. Levels above 3 are designed for +use only by developers and generate HUGE amounts of log +data, most of which is extremely cryptic.
Note that specifying this parameter here will
+override the parameter
+in the smb.conf file.
Base directory name for log/debug files. The extension
+".progname" will be appended (e.g. log.smbclient,
+log.smbd, etc...). The log file is never removed by the client.
+
Print a summary of command line options. +
To setup ntlm_auth for use by squid 2.5, with both basic and
+ NTLMSSP authentication, the following
+ should be placed in the squid.conf file.
+
+auth_param ntlm program ntlm_auth --helper-protocol=squid-2.5-ntlmssp +auth_param basic program ntlm_auth --helper-protocol=squid-2.5-basic +auth_param basic children 5 +auth_param basic realm Squid proxy-caching web server +auth_param basic credentialsttl 2 hours +
This example assumes that ntlm_auth has been installed into your
+ path, and that the group permissions on
+ winbindd_privileged are as described above.
To setup ntlm_auth for use by squid 2.5 with group limitation in addition to the above
+ example, the following should be added to the squid.conf file.
+
+auth_param ntlm program ntlm_auth --helper-protocol=squid-2.5-ntlmssp --require-membership-of='WORKGROUP\Domain Users' +auth_param basic program ntlm_auth --helper-protocol=squid-2.5-basic --require-membership-of='WORKGROUP\Domain Users' +
If you're experiencing problems with authenticating Internet Explorer running + under MS Windows 9X or Millenium Edition against ntlm_auth's NTLMSSP authentication + helper (--helper-protocol=squid-2.5-ntlmssp), then please read + + the Microsoft Knowledge Base article #239869 and follow instructions described there. +
pam_winbind — PAM module for Winbind
This tool is part of the samba(7) suite.
pam_winbind is a PAM module that can authenticate users against the local domain + by talking to the Winbind daemon.
+ pam_winbind supports several options: +
Gives debugging output to syslog.
+ If this option is set, pam_winbind will only succeed if the
+ user is a member of the given SID or NAME. A SID can be either a group-SID, a
+ alias-SID or even a user-SID. It is also possible to give a NAME instead of the
+ SID. That name must have the form: MYDOMAIN\mygroup or
+ MYDOMAIN\myuser. pam_winbind will, in that case, lookup
+ the SID internally. Note that NAME may not contain any spaces. It is thus
+ recommended to only use SIDs. You can verify the list of SIDs a user is a member
+ of with wbinfo --user-sids=SID.
+
+ By default, pam_winbind tries to get the + authentication token from a previous module. If no token is available it asks the user + for the old password. With this option, pam_winbind aborts with an + error if no authentication token from a previous module is available. +
+ Set the new password to the one provided by the previously + stacked password module. If this option is not set pam_winbind will ask the + user for the new password. +
+ + +
pdbedit — manage the SAM database (Database of Samba Users)
pdbedit [-L] [-v] [-w] [-u username] [-f fullname] [-h homedir] [-D drive] [-S script] [-p profile] [-a] [-m] [-r] [-x] [-i passdb-backend] [-e passdb-backend] [-b passdb-backend] [-g] [-d debuglevel] [-s configfile] [-P account-policy] [-C value] [-c account-control]
This tool is part of the samba(7) suite.
The pdbedit program is used to manage the users accounts + stored in the sam database and can only be run by root.
The pdbedit tool uses the passdb modular interface and is + independent from the kind of users database used (currently there + are smbpasswd, ldap, nis+ and tdb based and more can be added + without changing the tool).
There are five main ways to use pdbedit: adding a user account, + removing a user account, modifing a user account, listing user + accounts, importing users accounts.
This option lists all the user accounts + present in the users database. + This option prints a list of user/uid pairs separated by + the ':' character.
Example: pdbedit -L
+sorce:500:Simo Sorce +samba:45:Test User +
This option enables the verbose listing format. + It causes pdbedit to list the users in the database, printing + out the account fields in a descriptive format.
Example: pdbedit -L -v
+--------------- +username: sorce +user ID/Group: 500/500 +user RID/GRID: 2000/2001 +Full Name: Simo Sorce +Home Directory: \\BERSERKER\sorce +HomeDir Drive: H: +Logon Script: \\BERSERKER\netlogon\sorce.bat +Profile Path: \\BERSERKER\profile +--------------- +username: samba +user ID/Group: 45/45 +user RID/GRID: 1090/1091 +Full Name: Test User +Home Directory: \\BERSERKER\samba +HomeDir Drive: +Logon Script: +Profile Path: \\BERSERKER\profile +
This option sets the "smbpasswd" listing format.
+ It will make pdbedit list the users in the database, printing
+ out the account fields in a format compatible with the
+ smbpasswd file format. (see the
+ smbpasswd(5) for details)
Example: pdbedit -L -w
+sorce:500:508818B733CE64BEAAD3B435B51404EE: + D2A2418EFC466A8A0F6B1DBB5C3DB80C: + [UX ]:LCT-00000000: +samba:45:0F2B255F7B67A7A9AAD3B435B51404EE: + BC281CE3F53B6A5146629CD4751D3490: + [UX ]:LCT-3BFA1E8D: +
This option specifies the username to be + used for the operation requested (listing, adding, removing). + It is required in add, remove and modify + operations and optional in list + operations.
This option can be used while adding or + modifing a user account. It will specify the user's full + name.
Example: -f "Simo Sorce"
This option can be used while adding or + modifing a user account. It will specify the user's home + directory network path.
Example: -h "\\\\BERSERKER\\sorce" +
This option can be used while adding or + modifing a user account. It will specify the windows drive + letter to be used to map the home directory.
Example: -d "H:" +
This option can be used while adding or + modifing a user account. It will specify the user's logon + script path.
Example: -S "\\\\BERSERKER\\netlogon\\sorce.bat" +
This option can be used while adding or + modifing a user account. It will specify the user's profile + directory.
Example: -p "\\\\BERSERKER\\netlogon" +
+ This option can be used while adding or modifying a user account. It + will specify the users' new primary group SID (Security Identifier) or + rid.
Example: -G S-1-5-21-2447931902-1787058256-3961074038-1201
+ This option can be used while adding or modifying a user account. It + will specify the users' new SID (Security Identifier) or + rid.
Example: -U S-1-5-21-2447931902-1787058256-3961074038-5004
This option can be used while adding or modifying a user + account. It will specify the users' account control property. Possible flags are listed below. +
+
N: No password required
D: Account disabled
H: Home directory required
T: Temporary duplicate of other account
U: Regular user account
M: MNS logon user account
W: Workstation Trust Account
S: Server Trust Account
L: Automatic Locking
X: Password does not expire
I: Domain Trust Account
+
Example: -c "[X ]"
This option is used to add a user into the + database. This command needs a user name specified with + the -u switch. When adding a new user, pdbedit will also + ask for the password to be used.
Example: pdbedit -a -u sorce +
new password: +retype new password +
+
This option is used to modify an existing user + in the database. This command needs a user name specified with the -u + switch. Other options can be specified to modify the properties of + the specified user. This flag is kept for backwards compatibility, but + it is no longer necessary to specify it. +
This option may only be used in conjunction
+ with the -a option. It will make
+ pdbedit to add a machine trust account instead of a user
+ account (-u username will provide the machine name).
Example: pdbedit -a -m -u w2k-wks +
This option causes pdbedit to delete an account + from the database. It needs a username specified with the + -u switch.
Example: pdbedit -x -u bob
Use a different passdb backend to retrieve users + than the one specified in smb.conf. Can be used to import data into + your local user database.
This option will ease migration from one passdb backend to + another.
Example: pdbedit -i smbpasswd:/etc/smbpasswd.old +
Exports all currently available users to the + specified password database backend.
This option will ease migration from one passdb backend to + another and will ease backing up.
Example: pdbedit -e smbpasswd:/root/samba-users.backup
If you specify -g,
+ then -i in-backend -e out-backend
+ applies to the group mapping instead of the user database.
This option will ease migration from one passdb backend to + another and will ease backing up.
Use a different default passdb backend.
Example: pdbedit -b xml:/root/pdb-backup.xml -l
Display an account policy
Valid policies are: minimum password age, reset count minutes, disconnect time, + user must logon to change password, password history, lockout duration, min password length, + maximum password age and bad lockout attempt.
Example: pdbedit -P "bad lockout attempt"
+account policy value for bad lockout attempt is 0 +
Sets an account policy to a specified value.
+ This option may only be used in conjunction
+ with the -P option.
+
Example: pdbedit -P "bad lockout attempt" -C 3
+account policy value for bad lockout attempt was 0 +account policy value for bad lockout attempt is now 3 +
Print a summary of command line options. +
Prints the program version number. +
The file specified contains the
+configuration details required by the server. The
+information in this file includes server-specific
+information such as what printcap file to use, as well
+as descriptions of all the services that the server is
+to provide. See smb.conf for more information.
+The default configuration file name is determined at
+compile time.
debuglevel is an integer
+from 0 to 10. The default value if this parameter is
+not specified is zero.
The higher this value, the more detail will be +logged to the log files about the activities of the +server. At level 0, only critical errors and serious +warnings will be logged. Level 1 is a reasonable level for +day-to-day running - it generates a small amount of +information about operations carried out.
Levels above 1 will generate considerable +amounts of log data, and should only be used when +investigating a problem. Levels above 3 are designed for +use only by developers and generate HUGE amounts of log +data, most of which is extremely cryptic.
Note that specifying this parameter here will
+override the parameter
+in the smb.conf file.
Base directory name for log/debug files. The extension
+".progname" will be appended (e.g. log.smbclient,
+log.smbd, etc...). The log file is never removed by the client.
+
profiles — A utility to report and change SIDs in registry files +
profiles [-v] [-c SID] [-n SID] {file}
This tool is part of the samba(7) suite.
profiles is a utility that + reports and changes SIDs in windows registry files. It currently only + supports NT. +
rpcclient — tool for executing client side + MS-RPC functions
rpcclient [-A authfile] [-c <command string>] [-d debuglevel] [-h] [-l logdir] [-N] [-s <smb config file>] [-U username[%password]] [-W workgroup] [-N] [-I destinationIP] {server}
This tool is part of the samba(7) suite.
rpcclient is a utility initially developed + to test MS-RPC functionality in Samba itself. It has undergone + several stages of development and stability. Many system administrators + have now written scripts around it to manage Windows NT clients from + their UNIX workstation.
NetBIOS name of Server to which to connect. + The server can be any SMB/CIFS server. The name is + resolved using the name resolve order line from smb.conf(5).
execute semicolon separated commands (listed + below))
IP address is the address of the server to connect to.
+ It should be specified in standard "a.b.c.d" notation.
Normally the client would attempt to locate a named
+ SMB/CIFS server by looking it up via the NetBIOS name resolution
+ mechanism described above in the name resolve order
+ parameter above. Using this parameter will force the client
+ to assume that the server is on the machine with the specified IP
+ address and the NetBIOS name component of the resource being
+ connected to will be ignored.
There is no default for this parameter. If not supplied, + it will be determined automatically by the client as described + above.
Prints the program version number. +
The file specified contains the
+configuration details required by the server. The
+information in this file includes server-specific
+information such as what printcap file to use, as well
+as descriptions of all the services that the server is
+to provide. See smb.conf for more information.
+The default configuration file name is determined at
+compile time.
debuglevel is an integer
+from 0 to 10. The default value if this parameter is
+not specified is zero.
The higher this value, the more detail will be +logged to the log files about the activities of the +server. At level 0, only critical errors and serious +warnings will be logged. Level 1 is a reasonable level for +day-to-day running - it generates a small amount of +information about operations carried out.
Levels above 1 will generate considerable +amounts of log data, and should only be used when +investigating a problem. Levels above 3 are designed for +use only by developers and generate HUGE amounts of log +data, most of which is extremely cryptic.
Note that specifying this parameter here will
+override the parameter
+in the smb.conf file.
Base directory name for log/debug files. The extension
+".progname" will be appended (e.g. log.smbclient,
+log.smbd, etc...). The log file is never removed by the client.
+
If specified, this parameter suppresses the normal +password prompt from the client to the user. This is useful when +accessing a service that does not require a password.
Unless a password is specified on the command line or +this parameter is specified, the client will request a +password.
+Try to authenticate with kerberos. Only useful in +an Active Directory environment. +
This option allows +you to specify a file from which to read the username and +password used in the connection. The format of the file is +
+username = <value> +password = <value> +domain = <value> +
Make certain that the permissions on the file restrict +access from unwanted users.
Sets the SMB username or username and password.
If %password is not specified, the user will be prompted. The
+client will first check the USER environment variable, then the
+LOGNAME variable and if either exists, the
+string is uppercased. If these environmental variables are not
+found, the username GUEST is used.
A third option is to use a credentials file which
+contains the plaintext of the username and password. This
+option is mainly provided for scripts where the admin does not
+wish to pass the credentials on the command line or via environment
+variables. If this method is used, make certain that the permissions
+on the file restrict access from unwanted users. See the
+-A for more details.
Be cautious about including passwords in scripts. Also, on +many systems the command line of a running process may be seen +via the ps command. To be safe always allow +rpcclient to prompt for a password and type +it in directly.
This option allows you to override
+the NetBIOS name that Samba uses for itself. This is identical
+to setting the parameter in the smb.conf file.
+However, a command
+line setting will take precedence over settings in
+smb.conf.
This specifies a NetBIOS scope that +nmblookup will use to communicate with when +generating NetBIOS names. For details on the use of NetBIOS +scopes, see rfc1001.txt and rfc1002.txt. NetBIOS scopes are +very rarely used, only set this parameter +if you are the system administrator in charge of all the +NetBIOS systems you communicate with.
Set the SMB domain of the username. This +overrides the default domain which is the domain defined in +smb.conf. If the domain specified is the same as the servers +NetBIOS name, it causes the client to log on using the servers local +SAM (as opposed to the Domain SAM).
TCP socket options to set on the client
+socket. See the socket options parameter in
+the smb.conf manual page for the list of valid
+options.
Print a summary of command line options. +
Query info policy
Resolve a list + of SIDs to usernames. +
Resolve a list + of usernames to SIDs. +
Enumerate trusted domains
Enumerate privileges
Get the privilege name
Enumerate the LSA SIDS
Enumerate the privileges of an SID
Enumerate the rights of an SID
Enumerate accounts with a right
Add rights to an account
Remove rights from an account
Get a privilege value given its name
Query LSA security object
Get Primary Domain Information
DFS
Query DFS support
Add a DFS share
Remove a DFS share
Query DFS share info
Enumerate dfs shares
Server query info
Enumerate shares
Enumerate open files
Fetch remote time of day
Query user info
Query group info
Query user groups
Query group membership
Query alias membership
Query display info
Query domain info
Enumerate domain users
Enumerate domain groups
Enumerate alias groups
Create domain user
Look up names
Look up names
Delete domain user
Query SAMR security object
Retrieve domain password info
Look up domain
+ Execute an AddPrinterDriver() RPC to install the printer driver
+ information on the server. Note that the driver files should
+ already exist in the directory returned by
+ getdriverdir. Possible values for
+ arch are the same as those for
+ the getdriverdir command.
+ The config parameter is defined as
+ follows:
+Long Printer Name:\ +Driver File Name:\ +Data File Name:\ +Config File Name:\ +Help File Name:\ +Language Monitor Name:\ +Default Data Type:\ +Comma Separated list of Files +
Any empty fields should be enter as the string "NULL".
Samba does not need to support the concept of Print Monitors + since these only apply to local printers whose driver can make + use of a bi-directional link for communication. This field should + be "NULL". On a remote NT print server, the Print Monitor for a + driver must already be installed prior to adding the driver or + else the RPC will fail.
The version parameter lets you
+ specify the printer driver version number. If omitted, the
+ default driver version for the specified architecture will
+ be used. This option can be used to upload Windows 2000
+ (version 3) printer drivers.
+ Add a printer on the remote server. This printer
+ will be automatically shared. Be aware that the printer driver
+ must already be installed on the server (see adddriver)
+ and the portmust be a valid port name (see
+ enumports.
Delete the + specified printer driver for all architectures. This + does not delete the actual driver files from the server, + only the entry from the server's list of drivers. +
Delete the specified printer driver including driver files. + You can limit this action to a specific architecture and a specific version. + If no architecure is given, all driver files of that driver will be deleted. +
Enumerate all + printer setting data stored on the server. On Windows NT clients, + these values are stored in the registry, while Samba servers + store them in the printers TDB. This command corresponds + to the MS Platform SDK GetPrinterData() function (* This + command is currently unimplemented).
Enumerate printer data for a key
List the jobs and status of a given printer. + This command corresponds to the MS Platform SDK EnumJobs() + function
Enumerate + printer keys
+ Executes an EnumPorts() call using the specified + info level. Currently only info levels 1 and 2 are supported. +
+ Execute an EnumPrinterDrivers() call. This lists the various installed + printer drivers for all architectures. Refer to the MS Platform SDK + documentation for more details of the various flags and calling + options. Currently supported info levels are 1, 2, and 3.
Execute an EnumPrinters() call. This lists the various installed + and share printers. Refer to the MS Platform SDK documentation for + more details of the various flags and calling options. Currently + supported info levels are 1, 2 and 5.
Retrieve the data for a given printer setting. See + the enumdata command for more information. + This command corresponds to the GetPrinterData() MS Platform + SDK function.
Get + printer driver data with + keyname
+ Retrieve the printer driver information (such as driver file, + config file, dependent files, etc...) for + the given printer. This command corresponds to the GetPrinterDriver() + MS Platform SDK function. Currently info level 1, 2, and 3 are supported. +
+ Execute a GetPrinterDriverDirectory()
+ RPC to retrieve the SMB share name and subdirectory for
+ storing printer driver files for a given architecture. Possible
+ values for arch are "Windows 4.0"
+ (for Windows 95/98), "Windows NT x86", "Windows NT PowerPC", "Windows
+ Alpha_AXP", and "Windows NT R4000".
Retrieve the current printer information. This command + corresponds to the GetPrinter() MS Platform SDK function. +
Get + print processor + directory
Execute an OpenPrinterEx() and ClosePrinter() RPC + against a given printer.
Execute a SetPrinter() command to update the printer driver + associated with an installed printer. The printer driver must + already be correctly installed on the print server.
See also the enumprinters and + enumdrivers commands for obtaining a list of + of installed printers and drivers.
Add form
Set form
Get form
Delete form
Enumerate form
Set printer comment
Set REG_SZ printer data
Set printer name
Rffpcnex test
rpcclient is designed as a developer testing tool + and may not be robust in certain areas (such as command line parsing). + It has been known to generate a core dump upon failures when invalid + parameters where passed to the interpreter.
From Luke Leighton's original rpcclient man page:
WARNING! The MSRPC over SMB code has + been developed from examining Network traces. No documentation is + available from the original creators (Microsoft) on how MSRPC over + SMB works, or how the individual MSRPC services work. Microsoft's + implementation of these services has been demonstrated (and reported) + to be... a bit flaky in places.
The development of Samba's implementation is also a bit rough, + and as more of the services are understood, it can even result in + versions of smbd(8) and rpcclient(1) that are incompatible for some commands or services. Additionally, + the developers are sending reports to Microsoft, and problems found + or reported to Microsoft are fixed in Service Packs, which may + result in incompatibilities.
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 rpcclient man page was written by Matthew + Geddes, Luke Kenneth Casson Leighton, and rewritten by Gerald Carter. + 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.
samba — A Windows SMB/CIFS fileserver for UNIX
samba
The Samba software suite is a collection of programs + that implements the Server Message Block (commonly abbreviated + as SMB) protocol for UNIX systems. This protocol is sometimes + also referred to as the Common Internet File System (CIFS). For a + more thorough description, see + http://www.ubiqx.org/cifs/. Samba also implements the NetBIOS + protocol in nmbd.
The smbd daemon provides the file and print services to + SMB clients, such as Windows 95/98, Windows NT, Windows + for Workgroups or LanManager. The configuration file + for this daemon is described in smb.conf(5) +
The nmbd + daemon provides NetBIOS nameservice and browsing + support. The configuration file for this daemon + is described in smb.conf(5)
The smbclient + program implements a simple ftp-like client. This + is useful for accessing SMB shares on other compatible + servers (such as Windows NT), and can also be used + to allow a UNIX box to print to a printer attached to + any SMB server (such as a PC running Windows NT).
The testparm + utility is a simple syntax checker for Samba's smb.conf(5) configuration file.
The testprns
+ utility supports testing printer names defined
+ in your printcap file used
+ by Samba.
The smbstatus + tool provides access to information about the + current connections to smbd.
The nmblookup + tools allows NetBIOS name queries to be made + from a UNIX host.
The smbpasswd + command is a tool for changing LanMan and Windows NT + password hashes on Samba and Windows NT servers.
The smbcacls command is + a tool to set ACL's on remote CIFS servers.
The smbsh command is + a program that allows you to run a unix shell with + with an overloaded VFS.
The smbtree command + is a text-based network neighborhood tool.
The smbtar can make + backups of data on CIFS/SMB servers.
smbspool is a + helper utility for printing on printers connected + to CIFS servers.
smbcontrol is a utility + that can change the behaviour of running samba daemons. +
rpcclient is a utility + that can be used to execute RPC commands on remote + CIFS servers.
The pdbedit command + can be used to maintain the local user database on + a samba server.
The findsmb command + can be used to find SMB servers on the local network. +
The net command + is supposed to work similar to the DOS/Windows + NET.EXE command.
swat is a web-based
+ interface to configuring smb.conf.
+
winbindd is a daemon + that is used for integrating authentication and + the user database into unix.
wbinfo is a utility + that retrieves and stores information related to winbind. +
editreg is a command-line + utility that can edit windows registry files. +
profiles is a command-line + utility that can be used to replace all occurences of + a certain SID with another SID. +
log2pcap is a utility + for generating pcap trace files from Samba log + files.
vfstest is a utility + that can be used to test vfs modules.
ntlm_auth is a helper-utility + for external programs wanting to do NTLM-authentication. +
smbmount,smbumount and smbmnt are commands that can be used to + mount CIFS/SMB shares on Linux. +
smbcquotas is a tool that + can set remote QUOTA's on server with NTFS 5.
The Samba suite is made up of several components. Each + component is described in a separate manual page. It is strongly + recommended that you read the documentation that comes with Samba + and the manual pages of those components that you use. If the + manual pages and documents aren't clear enough then please visit + http://devel.samba.org + for information on how to file a bug report or submit a patch.
If you require help, visit the Samba webpage at + http://www.samba.org/ and + explore the many option available to you. +
The Samba software suite is licensed under the + GNU Public License(GPL). A copy of that license should + have come with the package in the file COPYING. You are + encouraged to distribute copies of the Samba suite, but + please obey the terms of this license.
The latest version of the Samba suite can be + obtained via anonymous ftp from samba.org in the + directory pub/samba/. It is also available on several + mirror sites worldwide.
You may also find useful information about Samba + on the newsgroup + comp.protocol.smb and the Samba mailing + list. Details on how to join the mailing list are given in + the README file that comes with Samba.
If you have access to a WWW viewer (such as Mozilla + or Konqueror) then you will also find lots of useful information, + including back issues of the Samba mailing list, at + http://lists.samba.org.
If you wish to contribute to the Samba project, + then I suggest you join the Samba mailing list at + http://lists.samba.org. +
If you have patches to submit, visit + http://devel.samba.org/ + for information on how to do it properly. We prefer patches + in diff -u format.
Contributors to the project are now too numerous
+ to mention here but all deserve the thanks of all Samba
+ users. To see a full list, look at the
+ change-log in the source package
+ for the pre-CVS changes and at
+ http://cvs.samba.org/
+ for the contributors to Samba post-CVS. CVS is the Open Source
+ source code control system used by the Samba Team to develop
+ Samba. The project would have been unmanageable without it.
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.
smbcacls — Set or get ACLs on an NT file or directory names
smbcacls {//server/share} {filename} [-D acls] [-M acls] [-a acls] [-S acls] [-C name] [-G name] [--numeric] [-t] [-U username] [-h] [-d]
This tool is part of the samba(7) suite.
The smbcacls program manipulates NT Access Control + Lists (ACLs) on SMB file shares.
The following options are available to the smbcacls program. + The format of ACLs is described in the section ACL FORMAT
Add the ACLs specified to the ACL list. Existing + access control entries are unchanged.
Modify the mask value (permissions) for the ACLs + specified on the command line. An error will be printed for each + ACL specified that was not already present in the ACL list +
Delete any ACLs specified on the command line. + An error will be printed for each ACL specified that was not + already present in the ACL list.
This command sets the ACLs on the file with + only the ones specified on the command line. All other ACLs are + erased. Note that the ACL specified must contain at least a revision, + type, owner and group for the call to succeed.
Specifies a username used to connect to the + specified service. The username may be of the form "username" in + which case the user is prompted to enter in a password and the + workgroup specified in the smb.conf(5) file is + used, or "username%password" or "DOMAIN\username%password" and the + password and workgroup names are used as provided.
The owner of a file or directory can be changed
+ to the name given using the -C option.
+ The name can be a sid in the form S-1-x-y-z or a name resolved
+ against the server specified in the first argument.
This command is a shortcut for -M OWNER:name. +
The group owner of a file or directory can
+ be changed to the name given using the -G
+ option. The name can be a sid in the form S-1-x-y-z or a name
+ resolved against the server specified n the first argument.
+
This command is a shortcut for -M GROUP:name.
This option displays all ACL information in numeric + format. The default is to convert SIDs to names and ACE types + and masks to a readable string format.
+ Don't actually do anything, only validate the correctness of + the arguments. +
Print a summary of command line options. +
Prints the program version number. +
The file specified contains the
+configuration details required by the server. The
+information in this file includes server-specific
+information such as what printcap file to use, as well
+as descriptions of all the services that the server is
+to provide. See smb.conf for more information.
+The default configuration file name is determined at
+compile time.
debuglevel is an integer
+from 0 to 10. The default value if this parameter is
+not specified is zero.
The higher this value, the more detail will be +logged to the log files about the activities of the +server. At level 0, only critical errors and serious +warnings will be logged. Level 1 is a reasonable level for +day-to-day running - it generates a small amount of +information about operations carried out.
Levels above 1 will generate considerable +amounts of log data, and should only be used when +investigating a problem. Levels above 3 are designed for +use only by developers and generate HUGE amounts of log +data, most of which is extremely cryptic.
Note that specifying this parameter here will
+override the parameter
+in the smb.conf file.
Base directory name for log/debug files. The extension
+".progname" will be appended (e.g. log.smbclient,
+log.smbd, etc...). The log file is never removed by the client.
+
The format of an ACL is one or more ACL entries separated by + either commas or newlines. An ACL entry is one of the following:
+REVISION:<revision number> +OWNER:<sid or name> +GROUP:<sid or name> +ACL:<sid or name>:<type>/<flags>/<mask> +
The revision of the ACL specifies the internal Windows + NT ACL revision for the security descriptor. + If not specified it defaults to 1. Using values other than 1 may + cause strange behaviour.
The owner and group specify the owner and group sids for the + object. If a SID in the format S-1-x-y-z is specified this is used, + otherwise the name specified is resolved using the server on which + the file or directory resides.
ACLs specify permissions granted to the SID. This SID again + can be specified in S-1-x-y-z format or as a name in which case + it is resolved against the server on which the file or directory + resides. The type, flags and mask values determine the type of + access granted to the SID.
The type can be either 0 or 1 corresponding to ALLOWED or + DENIED access to the SID. The flags values are generally + zero for file ACLs and either 9 or 2 for directory ACLs. Some + common flags are:
#define SEC_ACE_FLAG_OBJECT_INHERIT 0x1
#define SEC_ACE_FLAG_CONTAINER_INHERIT 0x2
#define SEC_ACE_FLAG_NO_PROPAGATE_INHERIT 0x4
#define SEC_ACE_FLAG_INHERIT_ONLY 0x8
At present flags can only be specified as decimal or + hexadecimal values.
The mask is a value which expresses the access right + granted to the SID. It can be given as a decimal or hexadecimal value, + or by using one of the following text strings which map to the NT + file permissions of the same name.
R - Allow read access
W - Allow write access
X - Execute permission on the object
D - Delete the object
P - Change permissions
O - Take ownership
The following combined permissions can be specified:
READ - Equivalent to 'RX' + permissions
CHANGE - Equivalent to 'RXWD' permissions +
FULL - Equivalent to 'RWXDPO' + permissions
The smbcacls program sets the exit status + depending on the success or otherwise of the operations performed. + The exit status may be one of the following values.
If the operation succeeded, smbcacls returns and exit + status of 0. If smbcacls couldn't connect to the specified server, + or there was an error getting or setting the ACLs, an exit status + of 1 is returned. If there was an error parsing any command line + arguments, an exit status of 2 is returned.
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.
smbcacls was written by Andrew Tridgell + and Tim Potter.
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.
smbclient — ftp-like client to access SMB/CIFS resources + on servers
smbclient [-b <buffer size>] [-d debuglevel] [-L <netbios name>] [-U username] [-I destinationIP] [-M <netbios name>] [-m maxprotocol] [-A authfile] [-N] [-i scope] [-O <socket options>] [-p port] [-R <name resolve order>] [-s <smb config file>] [-k]
smbclient {servicename} [password] [-b <buffer size>] [-d debuglevel] [-D Directory] [-U username] [-W workgroup] [-M <netbios name>] [-m maxprotocol] [-A authfile] [-N] [-l logdir] [-I destinationIP] [-E] [-c <command string>] [-i scope] [-O <socket options>] [-p port] [-R <name resolve order>] [-s <smb config file>] [-T<c|x>IXFqgbNan] [-k]
This tool is part of the samba(7) suite.
smbclient is a client that can + 'talk' to an SMB/CIFS server. It offers an interface + similar to that of the ftp program (see ftp(1)). + Operations include things like getting files from the server + to the local machine, putting files from the local machine to + the server, retrieving directory information from the server + and so on.
servicename is the name of the service
+ you want to use on the server. A service name takes the form
+ //server/service where server
+ is the NetBIOS name of the SMB/CIFS server
+ offering the desired service and service
+ is the name of the service offered. Thus to connect to
+ the service "printer" on the SMB/CIFS server "smbserver",
+ you would use the servicename //smbserver/printer
+
Note that the server name required is NOT necessarily + the IP (DNS) host name of the server ! The name required is + a NetBIOS server name, which may or may not be the + same as the IP hostname of the machine running the server. +
The server name is looked up according to either
+ the -R parameter to smbclient or
+ using the name resolve order parameter in
+ the smb.conf(5) file,
+ allowing an administrator to change the order and methods
+ by which server names are looked up.
The password required to access the specified
+ service on the specified server. If this parameter is
+ supplied, the -N option (suppress
+ password prompt) is assumed.
There is no default password. If no password is supplied
+ on the command line (either by using this parameter or adding
+ a password to the -U option (see
+ below)) and the -N option is not
+ specified, the client will prompt for a password, even if
+ the desired service does not require one. (If no password is
+ required, simply press ENTER to provide a null password.)
+
Note: Some servers (including OS/2 and Windows for + Workgroups) insist on an uppercase password. Lowercase + or mixed case passwords may be rejected by these servers. +
Be cautious about including passwords in scripts. +
This option is used by the programs in the Samba + suite to determine what naming services and in what order to resolve + host names to IP addresses. The option takes a space-separated + string of different 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 dependent, for instance on IRIX or Solaris this
+ may be controlled by the /etc/nsswitch.conf
+ file). Note that this method is only used if the NetBIOS name
+ type being queried is the 0x20 (server) name type, otherwise
+ it is ignored.
wins: Query a name with
+ the IP address listed in the wins server
+ parameter. If no WINS server has
+ been specified this method will be ignored.
bcast: Do a broadcast on
+ each of the known local interfaces listed in the
+ interfaces
+ parameter. This is the least reliable of the name resolution
+ methods as it depends on the target host being on a locally
+ connected subnet.
If this parameter is not set then the name resolve order + defined in the smb.conf(5) file parameter + (name resolve order) will be used.
The default order is lmhosts, host, wins, bcast and without
+ this parameter or any entry in the name resolve order
+ parameter of the smb.conf(5) file the name resolution
+ methods will be attempted in this order.
This options allows you to send messages, using + the "WinPopup" protocol, to another computer. Once a connection is + established you then type your message, pressing ^D (control-D) to + end.
If the receiving computer is running WinPopup the user will + receive the message and probably a beep. If they are not running + WinPopup the message will be lost, and no error message will + occur.
The message is also automatically truncated if the message + is over 1600 bytes, as this is the limit of the protocol. +
One useful trick is to cat the message through
+ smbclient. For example:
+ cat mymessage.txt | smbclient -M FRED will
+ send the message in the file mymessage.txt
+ to the machine FRED.
You may also find the -U and
+ -I options useful, as they allow you to
+ control the FROM and TO parts of the message.
See the message command parameter in the smb.conf(5) for a description of how to handle incoming
+ WinPopup messages in Samba.
Note: Copy WinPopup into the startup group + on your WfWg PCs if you want them to always be able to receive + messages.
This number is the TCP port number that will be used + when making connections to the server. The standard (well-known) + TCP port number for an SMB/CIFS server is 139, which is the + default.
Print a summary of command line options. +
IP address is the address of the server to connect to.
+ It should be specified in standard "a.b.c.d" notation.
Normally the client would attempt to locate a named
+ SMB/CIFS server by looking it up via the NetBIOS name resolution
+ mechanism described above in the name resolve order
+ parameter above. Using this parameter will force the client
+ to assume that the server is on the machine with the specified IP
+ address and the NetBIOS name component of the resource being
+ connected to will be ignored.
There is no default for this parameter. If not supplied, + it will be determined automatically by the client as described + above.
This parameter causes the client to write messages + to the standard error stream (stderr) rather than to the standard + output stream.
By default, the client writes messages to standard output + - typically the user's tty.
This option allows you to look at what services
+ are available on a server. You use it as smbclient -L
+ host and a list should appear. The -I
+ option may be useful if your NetBIOS names don't
+ match your TCP/IP DNS host names or if you are trying to reach a
+ host on another network.
This option tells smbclient how to interpret + filenames coming from the remote server. Usually Asian language + multibyte UNIX implementations use different character sets than + SMB/CIFS servers (EUC instead of + SJIS for example). Setting this parameter will let + smbclient convert between the UNIX filenames and + the SMB filenames correctly. This option has not been seriously tested + and may have some problems.
The terminal codes include CWsjis, CWeuc, CWjis7, CWjis8, + CWjunet, CWhex, CWcap. This is not a complete list, check the Samba + source code for the complete list.
This option changes the transmit/send buffer + size when getting or putting a file from/to the server. The default + is 65520 bytes. Setting this value smaller (to 1200 bytes) has been + observed to speed up file transfers to and from a Win9x server. +
Prints the program version number. +
The file specified contains the
+configuration details required by the server. The
+information in this file includes server-specific
+information such as what printcap file to use, as well
+as descriptions of all the services that the server is
+to provide. See smb.conf for more information.
+The default configuration file name is determined at
+compile time.
debuglevel is an integer
+from 0 to 10. The default value if this parameter is
+not specified is zero.
The higher this value, the more detail will be +logged to the log files about the activities of the +server. At level 0, only critical errors and serious +warnings will be logged. Level 1 is a reasonable level for +day-to-day running - it generates a small amount of +information about operations carried out.
Levels above 1 will generate considerable +amounts of log data, and should only be used when +investigating a problem. Levels above 3 are designed for +use only by developers and generate HUGE amounts of log +data, most of which is extremely cryptic.
Note that specifying this parameter here will
+override the parameter
+in the smb.conf file.
Base directory name for log/debug files. The extension
+".progname" will be appended (e.g. log.smbclient,
+log.smbd, etc...). The log file is never removed by the client.
+
If specified, this parameter suppresses the normal +password prompt from the client to the user. This is useful when +accessing a service that does not require a password.
Unless a password is specified on the command line or +this parameter is specified, the client will request a +password.
+Try to authenticate with kerberos. Only useful in +an Active Directory environment. +
This option allows +you to specify a file from which to read the username and +password used in the connection. The format of the file is +
+username = <value> +password = <value> +domain = <value> +
Make certain that the permissions on the file restrict +access from unwanted users.
Sets the SMB username or username and password.
If %password is not specified, the user will be prompted. The
+client will first check the USER environment variable, then the
+LOGNAME variable and if either exists, the
+string is uppercased. If these environmental variables are not
+found, the username GUEST is used.
A third option is to use a credentials file which
+contains the plaintext of the username and password. This
+option is mainly provided for scripts where the admin does not
+wish to pass the credentials on the command line or via environment
+variables. If this method is used, make certain that the permissions
+on the file restrict access from unwanted users. See the
+-A for more details.
Be cautious about including passwords in scripts. Also, on +many systems the command line of a running process may be seen +via the ps command. To be safe always allow +rpcclient to prompt for a password and type +it in directly.
This option allows you to override
+the NetBIOS name that Samba uses for itself. This is identical
+to setting the parameter in the smb.conf file.
+However, a command
+line setting will take precedence over settings in
+smb.conf.
This specifies a NetBIOS scope that +nmblookup will use to communicate with when +generating NetBIOS names. For details on the use of NetBIOS +scopes, see rfc1001.txt and rfc1002.txt. NetBIOS scopes are +very rarely used, only set this parameter +if you are the system administrator in charge of all the +NetBIOS systems you communicate with.
Set the SMB domain of the username. This +overrides the default domain which is the domain defined in +smb.conf. If the domain specified is the same as the servers +NetBIOS name, it causes the client to log on using the servers local +SAM (as opposed to the Domain SAM).
TCP socket options to set on the client
+socket. See the socket options parameter in
+the smb.conf manual page for the list of valid
+options.
smbclient may be used to create tar(1) + compatible backups of all the files on an SMB/CIFS + share. The secondary tar flags that can be given to this option + are :
c - Create a tar file on UNIX.
+ Must be followed by the name of a tar file, tape device
+ or "-" for standard output. If using standard output you must
+ turn the log level to its lowest value -d0 to avoid corrupting
+ your tar file. This flag is mutually exclusive with the
+ x flag.
x - Extract (restore) a local
+ tar file back to a share. Unless the -D option is given, the tar
+ files will be restored from the top level of the share. Must be
+ followed by the name of the tar file, device or "-" for standard
+ input. Mutually exclusive with the c flag.
+ Restored files have their creation times (mtime) set to the
+ date saved in the tar file. Directories currently do not get
+ their creation dates restored properly.
I - Include files and directories.
+ Is the default behavior when filenames are specified above. Causes
+ tar files to be included in an extract or create (and therefore
+ everything else to be excluded). See example below. Filename globbing
+ works in one of two ways. See r below.
X - Exclude files and directories.
+ Causes tar files to be excluded from an extract or create. See
+ example below. Filename globbing works in one of two ways now.
+ See r below.
b - Blocksize. Must be followed
+ by a valid (greater than zero) blocksize. Causes tar file to be
+ written out in blocksize*TBLOCK (usually 512 byte) blocks.
+
g - Incremental. Only back up
+ files that have the archive bit set. Useful only with the
+ c flag.
q - Quiet. Keeps tar from printing
+ diagnostics as it works. This is the same as tarmode quiet.
+
r - Regular expression include
+ or exclude. Uses regular expression matching for
+ excluding or excluding files if compiled with HAVE_REGEX_H.
+ However this mode can be very slow. If not compiled with
+ HAVE_REGEX_H, does a limited wildcard match on '*' and '?'.
+
N - Newer than. Must be followed
+ by the name of a file whose date is compared against files found
+ on the share during a create. Only files newer than the file
+ specified are backed up to the tar file. Useful only with the
+ c flag.
a - Set archive bit. Causes the
+ archive bit to be reset when a file is backed up. Useful with the
+ g and c flags.
+
Tar Long File Names
smbclient's tar option now supports long + file names both on backup and restore. However, the full path + name of the file must be less than 1024 bytes. Also, when + a tar archive is created, smbclient's tar option places all + files in the archive with relative names, not absolute names. +
Tar Filenames
All file names can be given as DOS path names (with '\\' + as the component separator) or as UNIX path names (with '/' as + the component separator).
Examples
Restore from tar file backup.tar into myshare on mypc
+ (no password on share).
smbclient //mypc/yshare "" -N -Tx backup.tar +
Restore everything except users/docs
+
smbclient //mypc/myshare "" -N -TXx backup.tar + users/docs
Create a tar file of the files beneath
+ users/docs.
smbclient //mypc/myshare "" -N -Tc + backup.tar users/docs
Create the same tar file as above, but now use + a DOS path name.
smbclient //mypc/myshare "" -N -tc backup.tar + users\edocs
Create a tar file of all the files and directories in + the share.
smbclient //mypc/myshare "" -N -Tc backup.tar * +
Change to initial directory before starting. Probably + only of any use with the tar -T option.
command string is a semicolon-separated list of
+ commands to be executed instead of prompting from stdin.
+ -N is implied by -c.
This is particularly useful in scripts and for printing stdin + to the server, e.g. -c 'print -'.
Once the client is running, the user is presented with + a prompt :
smb:\>
The backslash ("\\") indicates the current working directory + on the server, and will change if the current working directory + is changed.
The prompt indicates that the client is ready and waiting to + carry out a user command. Each command is a single word, optionally + followed by parameters specific to that command. Command and parameters + are space-delimited unless these notes specifically + state otherwise. All commands are case-insensitive. Parameters to + commands may or may not be case sensitive, depending on the command. +
You can specify file names which have spaces in them by quoting + the name with double quotes, for example "a long file name".
Parameters shown in square brackets (e.g., "[parameter]") are + optional. If not given, the command will use suitable defaults. Parameters + shown in angle brackets (e.g., "<parameter>") are required. +
Note that all commands operating on the server are actually + performed by issuing a request to the server. Thus the behavior may + vary from server to server, depending on how the server was implemented. +
The commands available are given here in alphabetical order.
If command is specified, the ? command will display
+ a brief informative message about the specified command. If no
+ command is specified, a list of available commands will
+ be displayed.
If shell command is specified, the !
+ command will execute a shell locally and run the specified shell
+ command. If no command is specified, a local shell will be run.
+
The client will request that the server return + the "alternate" name (the 8.3 name) for a file or directory. +
Toggles the setting of the flag in SMB packets that + tells the server to treat filenames as case sensitive. Set to OFF by + default (tells file server to treat filenames as case insensitive). Only + currently affects Samba 3.0.5 and above file servers with the case sensitive + parameter set to auto in the smb.conf. +
The client will request that the server cancel + the printjobs identified by the given numeric print job ids. +
This command depends on the server supporting the CIFS + UNIX extensions and will fail if the server does not. The client requests that the server + change the UNIX permissions to the given octal mode, in standard UNIX format. +
This command depends on the server supporting the CIFS + UNIX extensions and will fail if the server does not. The client requests that the server + change the UNIX user and group ownership to the given decimal values. Note there is + currently no way to remotely look up the UNIX uid and gid values for a given name. + This may be addressed in future versions of the CIFS UNIX extensions. +
If "directory name" is specified, the current + working directory on the server will be changed to the directory + specified. This operation will fail if for any reason the specified + directory is inaccessible.
If no directory name is specified, the current working + directory on the server will be reported.
The client will request that the server attempt
+ to delete all files matching mask from the current working
+ directory on the server.
A list of the files matching mask in the current
+ working directory on the server will be retrieved from the server
+ and displayed.
Terminate the connection with the server and exit + from the program.
Copy the file called remote file name from
+ the server to the machine running the client. If specified, name
+ the local copy local file name. Note that all transfers in
+ smbclient are binary. See also the
+ lowercase command.
See the ? command above.
If directory name is specified, the current
+ working directory on the local machine will be changed to
+ the directory specified. This operation will fail if for any
+ reason the specified directory is inaccessible.
If no directory name is specified, the name of the + current working directory on the local machine will be reported. +
This command depends on the server supporting the CIFS + UNIX extensions and will fail if the server does not. The client requests that the server + create a hard link between the linkname and target files. The linkname file + must not exist. +
Toggle lowercasing of filenames for the get and + mget commands.
When lowercasing is toggled ON, local filenames are converted + to lowercase when using the get and mget commands. This is + often useful when copying (say) MSDOS files from a server, because + lowercase filenames are the norm on UNIX systems.
See the dir command above.
This command allows the user to set up a mask + which will be used during recursive operation of the mget and + mput commands.
The masks specified to the mget and mput commands act as + filters for directories rather than files when recursion is + toggled ON.
The mask specified with the mask command is necessary + to filter files within those directories. For example, if the + mask specified in an mget command is "source*" and the mask + specified with the mask command is "*.c" and recursion is + toggled ON, the mget command will retrieve all files matching + "*.c" in all directories below and including all directories + matching "source*" in the current working directory.
Note that the value for mask defaults to blank (equivalent + to "*") and remains so until the mask command is used to change it. + It retains the most recently specified value indefinitely. To + avoid unexpected results it would be wise to change the value of + mask back to "*" after using the mget or mput commands.
See the mkdir command.
Copy all files matching mask from the server to
+ the machine running the client.
Note that mask is interpreted differently during recursive
+ operation and non-recursive operation - refer to the recurse and
+ mask commands for more information. Note that all transfers in
+ smbclient are binary. See also the lowercase command.
Create a new directory on the server (user access + privileges permitting) with the specified name.
Copy all files matching mask in the current working
+ directory on the local machine to the current working directory on
+ the server.
Note that mask is interpreted differently during recursive
+ operation and non-recursive operation - refer to the recurse and mask
+ commands for more information. Note that all transfers in smbclient
+ are binary.
Print the specified file from the local machine + through a printable service on the server.
See also the printmode command.
Set the print mode to suit either binary data + (such as graphical information) or text. Subsequent print + commands will use the currently set print mode.
Toggle prompting for filenames during operation + of the mget and mput commands.
When toggled ON, the user will be prompted to confirm + the transfer of each file during these commands. When toggled + OFF, all specified files will be transferred without prompting. +
Copy the file called local file name from the
+ machine running the client to the server. If specified,
+ name the remote copy remote file name. Note that all transfers
+ in smbclient are binary. See also the lowercase command.
+
Displays the print queue, showing the job id, + name, size and current status.
See the exit command.
See the rmdir command.
Toggle directory recursion for the commands mget + and mput.
When toggled ON, these commands will process all directories + in the source directory (i.e., the directory they are copying + from ) and will recurse into any that match the mask specified + to the command. Only files that match the mask specified using + the mask command will be retrieved. See also the mask command. +
When recursion is toggled OFF, only files from the current + working directory on the source machine that match the mask specified + to the mget or mput commands will be copied, and any mask specified + using the mask command will be ignored.
Remove all files matching mask from the current
+ working directory on the server.
Remove the specified directory (user access + privileges permitting) from the server.
A version of the DOS attrib command to set + file permissions. For example:
setmode myfile +r
would make myfile read only.
This command depends on the server supporting the CIFS + UNIX extensions and will fail if the server does not. The client requests the + UNIX basic info level and prints out the same info that the Linux stat command + would about the file. This includes the size, blocks used on disk, file type, + permissions, inode number, number of links and finally the three timestamps + (access, modify and change). If the file is a special file (symlink, character or + block device, fifo or socket) then extra information may also be printed. +
This command depends on the server supporting the CIFS + UNIX extensions and will fail if the server does not. The client requests that the server + create a symbolic hard link between the target and linkname files. The linkname file + must not exist. Note that the server will not create a link to any path that lies + outside the currently connected share. This is enforced by the Samba server. +
Performs a tar operation - see the -T
+ command line option above. Behavior may be affected
+ by the tarmode command (see below). Using g (incremental) and N
+ (newer) will affect tarmode settings. Note that using the "-" option
+ with tar x may not work - use the command line option instead.
+
Blocksize. Must be followed by a valid (greater
+ than zero) blocksize. Causes tar file to be written out in
+ blocksize*TBLOCK (usually 512 byte) blocks.
Changes tar's behavior with regard to archive + bits. In full mode, tar will back up everything regardless of the + archive bit setting (this is the default mode). In incremental mode, + tar will only back up files with the archive bit set. In reset mode, + tar will reset the archive bit on all files it backs up (implies + read/write share).
Some servers are fussy about the case of supplied usernames, + passwords, share names (AKA service names) and machine names. + If you fail to connect try giving all parameters in uppercase. +
It is often necessary to use the -n option when connecting + to some types of servers. For example OS/2 LanManager insists + on a valid NetBIOS name being used, so you need to supply a valid + name that would be known to the server.
smbclient supports long file names where the server + supports the LANMAN2 protocol or above.
The variable USER may contain the
+ username of the person using the client. This information is
+ used only if the protocol level is high enough to support
+ session-level passwords.
The variable PASSWD may contain
+ the password of the person using the client. This information is
+ used only if the protocol level is high enough to support
+ session-level passwords.
The variable LIBSMB_PROG may contain
+ the path, executed with system(), which the client should connect
+ to instead of connecting to a server. This functionality is primarily
+ intended as a development aid, and works best when using a LMHOSTS
+ file
The location of the client program is a matter for + individual system administrators. The following are thus + suggestions only.
It is recommended that the smbclient software be installed
+ in the /usr/local/samba/bin/ or
+ /usr/samba/bin/ directory, this directory readable
+ by all, writeable only by root. The client program itself should
+ be executable by all. The client should NOT be
+ setuid or setgid!
The client log files should be put in a directory readable + and writeable only by the user.
To test the client, you will need to know the name of a + running SMB/CIFS server. It is possible to run smbd(8) as an ordinary user - running that server as a daemon + on a user-accessible port (typically any port number over 1024) + would provide a suitable test server.
Most diagnostics issued by the client are logged in a + specified log file. The log file name is specified at compile time, + but may be overridden on the command line.
The number and nature of diagnostics available depends + on the debug level used by the client. If you have problems, + set the debug level to 3 and peruse the log files.
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.
smb.conf — The configuration file for the Samba suite
+ The smb.conf file is a configuration file for the Samba suite. smb.conf contains runtime configuration information for the Samba programs. The
+ smb.conf file is designed to be configured and administered by the
+ swat(8) program. The
+ complete description of the file format and possible parameters held within are here for reference purposes.
+
+ The file consists of sections and parameters. A section begins with the name of the section in square brackets + and continues until the next section begins. Sections contain parameters of the form: +
+name=value+
+
+ The file is line-based - that is, each newline-terminated line represents either a comment, a section name or + a parameter. +
Section and parameter names are not case sensitive.
+ Only the first equals sign in a parameter is significant. Whitespace before or after the first equals sign is + discarded. Leading, trailing and internal whitespace in section and parameter names is irrelevant. Leading + and trailing whitespace in a parameter value is discarded. Internal whitespace within a parameter value is + retained verbatim. +
+ Any line beginning with a semicolon (“;”) or a hash (“#”) + character is ignored, as are lines containing only whitespace. +
+ Any line ending in a “\” is continued on the next line in the customary UNIX fashion. +
+ The values following the equals sign in parameters are all either a string (no quotes needed) or a boolean, + which may be given as yes/no, 0/1 or true/false. Case is not significant in boolean values, but is preserved + in string values. Some items such as create masks are numeric. +
+ Each section in the configuration file (except for the [global] section) describes a shared resource (known as + a “share”). The section name is the name of the shared resource and the parameters within the + section define the shares attributes. +
+ There are three special sections, [global], [homes] and [printers], which are described under + special sections. The following notes apply to ordinary section descriptions. +
+ A share consists of a directory to which access is being given plus a description of the access rights + which are granted to the user of the service. Some housekeeping options are also specifiable. +
+ Sections are either file share services (used by the client as an extension of their native file systems) + or printable services (used by the client to access print services on the host running the server). +
+ Sections may be designated guest services, in which case no password is required to + access them. A specified UNIX guest account is used to define access privileges in this + case. +
+ Sections other than guest services will require a password to access them. The client provides the
+ username. As older clients only provide passwords and not usernames, you may specify a list of usernames to
+ check against the password using the user = option in the share definition. For modern clients
+ such as Windows 95/98/ME/NT/2000, this should not be necessary.
+
+ The access rights granted by the server are masked by the access rights granted to the specified or guest + UNIX user by the host system. The server does not grant more access than the host system grants. +
+ The following sample section defines a file space share. The user has write access to the path /home/bar. The share is accessed via the share name foo:
+
[foo] |
path = /home/bar |
read only = read only = no |
+ The following sample section defines a printable share. The share is read-only, but printable. That is, + the only write access permitted is via calls to open, write to and close a spool file. The guest + ok parameter means access will be permitted as the default guest user (specified elsewhere): +
[aprinter] |
path = /usr/spool/public |
read only = yes |
printable = yes |
guest ok = yes |
+ Parameters in this section apply to the server as a whole, or are defaults for sections that do not + specifically define certain items. See the notes under PARAMETERS for more information. +
+ If a section called [homes] is included in the configuration file, services connecting clients + to their home directories can be created on the fly by the server. +
+ When the connection request is made, the existing sections are scanned. If a match is found, it is + used. If no match is found, the requested section name is treated as a username and looked up in the local + password file. If the name exists and the correct password has been given, a share is created by cloning the + [homes] section. +
+ Some modifications are then made to the newly created share: +
+ 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, it may be useful + to use the %S macro. For example: +
+path = /data/pchome/%S
++ is useful if you have different home directories for your PCs than for UNIX access. +
+ This is a fast and simple way to give a large number of clients access to their home directories with a minimum + of fuss. +
+ A similar process occurs if the requested section name is “homes”, except that the share + name is not changed to that of the requesting user. This method of using the [homes] section works well if + different users share a client PC. +
+ The [homes] section can specify all the parameters a normal service section can specify, though some make more sense + than others. The following is a typical and suitable [homes] section: +
[homes] |
read only = no |
+ An important point is that if guest access is specified in the [homes] section, all home directories will be + visible to all clients without a password. In the very unlikely event that this is actually + desirable, it is wise to also specify read only access. +
+ The browseable flag for auto home directories will be inherited from the global browseable + flag, not the [homes] browseable flag. This is useful as it means setting browseable = no in + the [homes] section will hide the [homes] share but make any auto home directories visible. +
+ This section works like [homes], but for printers. +
+ If a [printers] section occurs in the configuration file, users are able to connect to any printer + specified in the local host's printcap file. +
+ When a connection request is made, the existing sections are scanned. If a match is found, it is used. + If no match is found, but a [homes] section exists, it is used as described above. Otherwise, the requested + section name is treated as a printer name and the appropriate printcap file is scanned to see if the requested + section name is a valid printer share name. If a match is found, a new printer share is created by cloning the + [printers] section. +
+ A few modifications are then made to the newly created share: +
The 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.
+ The [printers] service MUST be printable - if you specify otherwise, the server will refuse + to load the configuration file. +
+ Typically the path specified is that of a world-writeable spool directory with the sticky bit set on + it. A typical [printers] entry looks like this: +
[printers] |
path = /usr/spool/public |
guest ok = yes |
printable = yes |
+ All aliases given for a printer in the printcap file are legitimate printer names as far as the server is concerned. + If your printing subsystem doesn't work like that, you will have to set up a pseudo-printcap. This is a file + consisting of one or more lines like this: +
+alias|alias|alias|alias... +
+
+ Each alias should be an acceptable printer name for your printing subsystem. In the [global] section, + specify the new file as your printcap. The server will only recognize names found in your pseudo-printcap, + which of course can contain whatever aliases you like. The same technique could be used simply to limit access + to a subset of your local printers. +
+ An alias, by the way, is defined as any component of the first entry of a printcap record. Records are separated by newlines,
+ components (if there are more than one) are separated by vertical bar symbols (|).
+
+ 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 define the specific attributes of sections.
+ Some parameters are specific to the [global] section (e.g., security). Some parameters + are usable in all sections (e.g., create mask). All others are permissible only in normal + sections. For the purposes of the following descriptions the [homes] and [printers] sections will be + considered normal. The letter G in parentheses indicates that a parameter is specific to + the [global] section. The letter S indicates that a parameter can be specified in a + service specific section. All S parameters can also be specified in the [global] section + - in which case they will define the default behavior for all services. +
+ Parameters are arranged here in alphabetical order - this may not create best bedfellows, but at least you can + find them! Where there are synonyms, the preferred synonym is described, others refer to the preferred + synonym. +
+ Many of the strings that are settable in the config file can take substitutions. For example the option + “path = /tmp/%u” is interpreted as “path = /tmp/john” if the user connected with the + username john. +
+ These substitutions are mostly noted in the descriptions below, but there are some general substitutions + which apply whenever they might be relevant. These are: +
session username (the username that the client wanted, not + necessarily the same as the one they got).
primary group name of %U.
the Internet hostname that Samba is running on.
the NetBIOS name of the client machine (very useful).
This parameter is not available when Samba listens on port 445, as clients no longer
+ send this information. If you use this macro in an include statement on a domain that has
+ a Samba domain controller be sure to set in the [global] section smb ports =
+ 139. This will cause Samba to not listen on port 445 and will permit include
+ functionality to function as it did with Samba 2.x.
+
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”. +
the Internet name of the client machine. +
the selected protocol level after protocol negotiation. It can be one of CORE, COREPLUS, + LANMAN1, LANMAN2 or NT1.
the process id of the current server + process.
the architecture of the remote
+ machine. It currently recognizes Samba (Samba),
+ the Linux CIFS file system (CIFSFS), OS/2, (OS2),
+ Windows for Workgroups (WfWg), Windows 9x/ME
+ (Win95), Windows NT (WinNT),
+ Windows 2000 (Win2K), Windows XP (WinXP),
+ and Windows 2003 (Win2K3). Anything else will be known as
+ UNKNOWN.
the IP address of the client machine.
the local IP address to which a client connected.
the current date and time.
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): +
the name of the current service, if any.
the root directory of the current service, if any.
username of the current service, if any.
primary group name of %u.
the home directory of the user given by %u.
+ 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, this + value will be the same as %L.
+ 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.
+
+ 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: +
+ controls whether filenames are case sensitive. If they aren't, Samba must do a filename search and match on + passed names. The default setting of auto allows clients that support case sensitive filenames (Linux CIFSVFS + and smbclient 3.0.5 and above currently) to tell the Samba server on a per-packet basis that they wish to + access the file system in a case-sensitive manner (to support UNIX case sensitive semantics). No Windows or + DOS system supports case-sensitive filename so setting this option to auto is that same as setting it to no + for them. Default auto. +
+ controls what the default case is for new filenames. Default lower. +
+ controls whether new files are created with the case that the client passes, or if they are forced to be the
+ default case. Default yes.
+
+ 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
+ used 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. +
+ There are a number of ways in which a user can connect to a service. The server uses the following steps + in determining if it will allow a connection to a specified service. If all the steps fail, the connection + request is rejected. However, if one of the steps succeeds, the following steps are not checked. +
+ If the service is marked “guest only = yes” and the server is running with share-level + security (“security = share”, steps 1 to 5 are skipped. +
+ If the client has passed a username/password pair and that username/password pair is validated by the UNIX
+ system's password programs, the connection is made as that username. This includes the
+ \\server\service% method of passing a username.
+ username
+ If the client has previously registered a username with the system and now supplies a correct password for that + username, the connection is allowed. +
+ The client's NetBIOS name and any previously used usernames are checked against the supplied password. If + they match, 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, 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, the connection is made as
+ the username in the user = line. If one of the usernames in the user = list
+ begins with a @, that name expands to a list of names in the group of the same name.
+
+ If the service is a guest service, a connection is made as the username given in the guest account
+ = for the service, irrespective of the supplied password.
+
This a full path name to a script called by smbd(8) that + should stop a shutdown procedure issued by the shutdown script.
If the connected user posseses the SeRemoteShutdownPrivilege,
+ right, this command will be run as user.
Default: abort shutdown script =
+
+
Example: abort shutdown script = /sbin/shutdown -c
+
+
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
+
+
+ In a POSIX filesystem, only the owner of a file or directory and the superuser can modify the permissions + and ACLs on a file. If this parameter is set, then Samba overrides this restriction, and also allows the + primary group owner of a file or directory to modify the permissions and ACLs + on that file. +
+ On a Windows server, groups may be the owner of a file or directory - thus allowing anyone in + that group to modify the permissions on it. This allows the delegation of security controls + on a point in the filesystem to the group owner of a directory and anything below it also owned + by that group. This means there are multiple people with permissions to modify ACLs on a file + or directory, easing managability. +
+ This parameter allows Samba to also permit delegation of the control over a point in the exported + directory hierarchy in much the same was as Windows. This allows all members of a UNIX group to + control the permissions on a file or directory they have group ownership on. +
+ This parameter is best used with the inherit owner option and also + on on a share containing directories with the UNIX setgid bit bit set + on them, which causes new files and directories created within it to inherit the group + ownership from the containing directory. +
+ This is a new parameter introduced in Samba 3.0.20. +
+ This can be particularly useful to allow groups to manage their own security on a part + of the filesystem they have group ownership of, removing the bottleneck of having only + the user owner or superuser able to reset permissions. +
Default: acl group control = no
+
+
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.
No default
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 =
+
+
Example: add machine script = /usr/sbin/adduser -n -g machines -c Machine -d /var/lib/nobody -s /bin/false %u
+
+
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. +
Default: addprinter command =
+
+
Example: addprinter command = /usr/bin/addprinter
+
+
Samba 2.2.0 introduced the ability to dynamically
+ add and delete shares via the Windows NT 4.0 Server Manager. The
+ add share command is used to define an
+ external program or script which will add a new service definition
+ to smb.conf. In order to successfully
+ execute the add share command, smbd
+ requires that the administrator be connected using a root account (i.e.
+ uid == 0).
+
+ When executed, smbd will automatically invoke the
+ add share command with four parameters.
+
configFile - the location
+ of the global smb.conf file.
+
shareName - the name of the new
+ share.
+
pathName - path to an **existing**
+ directory on disk.
+
comment - comment string to associate
+ with the new share.
+
+ This parameter is only used for add file shares. To add printer shares, + see the addprinter command. +
Default: add share command =
+
+
Example: add share command = /usr/local/bin/addshare
+
+
This is the full pathname to a script that will + be run AS ROOT by smbd(8) under special circumstances described below.
Normally, a Samba server requires that UNIX users are + created for all users accessing files on this server. For sites + that use Windows NT account databases as their primary user database + creating these users and keeping the user list in sync with the + Windows NT PDC is an onerous task. This option allows smbd to create the required UNIX users + ON DEMAND when a user accesses the Samba server.
In order to use this option, smbd(8) must NOT be set to security = share
+ and add user script
+ must be set to a full pathname for a script that will create a UNIX
+ user given one argument of %u, which expands into
+ the UNIX user name to create.
When the Windows user attempts to access the Samba server,
+ at login (session setup in the SMB protocol) time, smbd(8) contacts the password server and
+ attempts to authenticate the given user with the given password. If the
+ authentication succeeds then smbd
+ attempts to find a UNIX user in the UNIX password database to map the
+ Windows user into. If this lookup fails, and add user script
+ is set then smbd will
+ call the specified script AS ROOT, expanding
+ any %u argument to be the user name to create.
If this script successfully creates the user then smbd + will continue on as though the UNIX user + already existed. In this way, UNIX users are dynamically created to + match existing Windows NT accounts.
+ See also security, password server, + delete user script. +
Default: add user script =
+
+
Example: add user script = /usr/local/samba/bin/add_user %u
+
+
Full path to the script that will be called when
+ a user is added to a group using the Windows NT domain administration
+ tools. It will be run by smbd(8) AS ROOT.
+ Any %g will be replaced with the group name and
+ any %u will be replaced with the user name.
+
Note that the adduser command used in the example below does + not support the used syntax on all systems.
Default: add user to group script =
+
+
Example: add user to group script = /usr/sbin/adduser %u %g
+
+
This is a list of users who will be granted + administrative privileges on the share. This means that they + will do all file operations as the super-user (root).
You should use this option very carefully, as any user in + this list will be able to do anything they like on the share, + irrespective of file permissions.
This parameter will not work with the security = share in + Samba 3.0. This is by design.
Default: admin users =
+
+
Example: admin users = jason
+
+
This parameter controls whether special AFS features are enabled
+ for this share. If enabled, it assumes that the directory exported via
+ the path parameter is a local AFS import. The
+ special AFS features include the attempt to hand-craft an AFS token
+ if you enabled --with-fake-kaserver in configure.
+
Default: afs share = no
+
+
If you are using the fake kaserver AFS feature, you might + want to hand-craft the usernames you are creating tokens for. + For example this is necessary if you have users from several domain + in your AFS Protection Database. One possible scheme to code users + as DOMAIN+User as it is done by winbind with the + as a separator. +
The mapped user name must contain the cell name to log into, + so without setting this parameter there will be no token.
Default: afs username map =
+
+
Example: afs username map = %u@afs.samba.org
+
+
This determines how Samba will use its + algorithmic mapping from uids/gid to the RIDs needed to construct + NT Security Identifiers. +
Setting this option to a larger value could be useful to sites + transitioning from WinNT and Win2k, as existing user and + group rids would otherwise clash with sytem users etc. +
All UIDs and GIDs must be able to be resolved into SIDs for + the correct operation of ACLs on the server. As such the algorithmic + mapping can't be 'turned off', but pushing it 'out of the way' should + resolve the issues. Users and groups can then be assigned 'low' RIDs + in arbitary-rid supporting backends. +
Default: algorithmic rid base = 1000
+
+
Example: algorithmic rid base = 100000
+
+
This parameter allows an administrator to tune the + allocation size reported to Windows clients. The default + size of 1Mb generally results in improved Windows client + performance. However, rounding the allocation size may cause + difficulties for some applications, e.g. MS Visual Studio. + If the MS Visual Studio compiler starts to crash with an + internal error, set this parameter to zero for this share. +
The integer parameter specifies the roundup size in bytes.
Default: allocation roundup size = 1048576
+
+
Example: allocation roundup size = 0
+# (to disable roundups)
+
+
+ This option only takes effect when the security option is set to
+ server,domain or ads.
+ If it is set to no, then attempts to connect to a resource from
+ a domain or workgroup other than the one which smbd is running
+ in will fail, even if that domain is trusted by the remote server
+ doing the authentication.
This is useful if you only want your Samba server to + serve resources to users in the domain it is a member of. As + an example, suppose that there are two domains DOMA and DOMB. DOMB + is trusted by DOMA, which contains the Samba server. Under normal + circumstances, a user with an account in DOMB can then access the + resources of a UNIX account with the same account name on the + Samba server even if they do not have an account in DOMA. This + can make implementing a security boundary difficult.
Default: allow trusted domains = yes
+
+
This specifies what type of server nmbd(8) will announce itself as, to a network neighborhood browse + list. By default this is set to Windows NT. The valid options + are : "NT Server" (which can also be written as "NT"), + "NT Workstation", "Win95" or "WfW" meaning Windows NT Server, + Windows NT Workstation, Windows 95 and Windows for Workgroups + respectively. Do not change this parameter unless you have a + specific need to stop Samba appearing as an NT server as this + may prevent Samba servers from participating as browser servers + correctly.
Default: announce as = NT Server
+
+
Example: announce as = Win95
+
+
This specifies the major and minor version numbers + that nmbd will use when announcing itself as a server. The default + is 4.9. Do not change this parameter unless you have a specific + need to set a Samba server to be a downlevel server.
Default: announce version = 4.9
+
+
Example: announce version = 2.0
+
+
+ This option allows the administrator to chose what authentication methods smbd will use when authenticating a user. This option defaults to sensible values + based on security. This should be considered a developer option and used only in rare + circumstances. In the majority (if not all) of production servers, the default setting should be adequate. +
Each entry in the list attempts to authenticate the user in turn, until + the user authenticates. In practice only one method will ever actually + be able to complete the authentication. +
Possible options include guest (anonymous access),
+ sam (lookups in local list of accounts based on netbios
+ name or domain name), winbind (relay authentication requests
+ for remote users through winbindd), ntdomain (pre-winbindd
+ method of authentication for remote domain users; deprecated in favour of winbind method),
+ trustdomain (authenticate trusted users by contacting the
+ remote DC directly from smbd; deprecated in favour of winbind method).
Default: auth methods =
+
+
Example: auth methods = guest sam winbind
+
+
This parameter lets you "turn off" a service. If
+ available = no, then ALL
+ attempts to connect to the service will fail. Such failures are
+ logged.
Default: available = yes
+
+
This global parameter allows the Samba admin + to limit what interfaces on a machine will serve SMB requests. It + affects file service smbd(8) and name service nmbd(8) in a slightly different ways.
+ For name service it causes nmbd to bind to ports 137 and 138 on the + interfaces listed in the interfaces parameter. nmbd + also binds to the "all addresses" interface (0.0.0.0) on ports 137 and 138 for the purposes of + reading broadcast messages. If this option is not set then nmbd will + service name requests on all of these sockets. If bind interfaces only is set then + nmbd will check the source address of any packets coming in on the + broadcast sockets and discard any that don't match the broadcast addresses of the interfaces in the + interfaces parameter list. As unicast packets are received on the other sockets it + allows nmbd to refuse to serve names to machines that send packets that + arrive through any interfaces not listed in the interfaces list. IP Source address + spoofing does defeat this simple check, however, so it must not be used seriously as a security feature for + nmbd. +
+ For file service it causes smbd(8) to bind only to the interface list given in the interfaces parameter. This restricts the networks that smbd will + serve to packets coming in those interfaces. Note that you should not use this parameter for machines that + are serving PPP or other intermittent or non-broadcast network interfaces as it will not cope with + non-permanent interfaces. +
+ If bind interfaces only is set then unless the network address + 127.0.0.1 is added to the interfaces parameter list + smbpasswd(8) and + swat(8) may not work as + expected due to the reasons covered below. +
+ To change a users SMB password, the smbpasswd by default connects to the
+ localhost - 127.0.0.1 address as an SMB client to issue the password change request. If
+ bind interfaces only is set then unless the network address
+ 127.0.0.1 is added to the interfaces parameter list then smbpasswd will fail to connect in it's default mode. smbpasswd can be forced to use the primary IP interface of the local host by using
+ its smbpasswd(8) -r parameter, with remote machineremote
+ machine set to the IP name of the primary interface of the local host.
+
+ The swat status page tries to connect with smbd and nmbd at the address + 127.0.0.1 to determine if they are running. Not adding 127.0.0.1 + will cause smbd and nmbd to always show + "not running" even if they really are. This can prevent swat + from starting/stopping/restarting smbd and nmbd. +
Default: bind interfaces only = no
+
+
This parameter controls the behavior + of smbd(8) when given a request by a client + to obtain a byte range lock on a region of an open file, and the + request has a time limit associated with it.
If this parameter is set and the lock range requested + cannot be immediately satisfied, samba will internally + queue the lock request, and periodically attempt to obtain + the lock until the timeout period expires.
If this parameter is set to no, then
+ samba will behave as previous versions of Samba would and
+ will fail the lock request immediately if the lock range
+ cannot be obtained.
Default: blocking locks = yes
+
+
This parameter controls the behavior of smbd(8) when reporting disk free + sizes. By default, this reports a disk block size of 1024 bytes. +
Changing this parameter may have some effect on the + efficiency of client writes, this is not yet confirmed. This + parameter was added to allow advanced administrators to change + it (usually to a higher value) and test the effect it has on + client write performance without re-compiling the code. As this + is an experimental option it may be removed in a future release. +
Changing this option does not change the disk free reporting + size, just the block size unit reported to the client. +
No default
This parameter is a synonym for browseable.
This controls whether this share is seen in + the list of available shares in a net view and in the browse list.
Default: browseable = yes
+
+
This controls whether smbd(8) will serve a browse list to
+ a client doing a NetServerEnum call. Normally
+ set to yes. You should never need to change
+ this.
Default: browse list = yes
+
+
This parameter is a synonym for case sensitive.
See the discussion in the section name mangling.
Default: case sensitive = no
+
+
This SMB allows a client to tell a server to
+ "watch" a particular directory for any changes and only reply to
+ the SMB request when a change has occurred. Such constant scanning of
+ a directory is expensive under UNIX, hence an smbd(8) daemon only performs such a scan
+ on each requested directory once every change notify
+ timeout seconds.
Default: change notify timeout = 60
+
+
Example: change notify timeout = 300
+# Would change the scan time to every 5 minutes.
+
+
Samba 2.2.0 introduced the ability to dynamically
+ add and delete shares via the Windows NT 4.0 Server Manager. The
+ change share command is used to define an
+ external program or script which will modify an existing service definition
+ in smb.conf. In order to successfully
+ execute the change share command, smbd
+ requires that the administrator be connected using a root account (i.e.
+ uid == 0).
+
+ When executed, smbd will automatically invoke the
+ change share command with four parameters.
+
configFile - the location
+ of the global smb.conf file.
+
shareName - the name of the new
+ share.
+
pathName - path to an **existing**
+ directory on disk.
+
comment - comment string to associate
+ with the new share.
+
+ This parameter is only used modify existing file shares definitions. To modify + printer shares, use the "Printers..." folder as seen when browsing the Samba host. +
Default: change share command =
+
+
Example: change share command = /usr/local/bin/addshare
+
+
The name of a program that can be used to check password + complexity. The password is sent to the program's standrad input.
The program must return 0 on good password any other value otherwise. + In case the password is considered weak (the program do not return 0) the + user will be notified and the password change will fail.
Note: In the example directory there is a sample program called crackcheck + that uses cracklib to checkpassword quality
. + + +Default: check password script = Disabled
+
+
Example: check password script = check password script = /usr/local/sbin/crackcheck
+
+
This parameter determines whether or not smbclient(8) and other samba client + tools will attempt to authenticate itself to servers using the + weaker LANMAN password hash. If disabled, only server which support NT + password hashes (e.g. Windows NT/2000, Samba, etc... but not + Windows 95/98) will be able to be connected from the Samba client.
The LANMAN encrypted response is easily broken, due to it's + case-insensitive nature, and the choice of algorithm. Clients + without Windows 95/98 servers are advised to disable + this option.
Disabling this option will also disable the client plaintext auth option
Likewise, if the client ntlmv2 + auth parameter is enabled, then only NTLMv2 logins will be + attempted.
Default: client lanman auth = yes
+
+
This parameter determines whether or not smbclient(8) will attempt to + authenticate itself to servers using the NTLMv2 encrypted password + response.
If enabled, only an NTLMv2 and LMv2 response (both much more + secure than earlier versions) will be sent. Many servers + (including NT4 < SP4, Win9x and Samba 2.2) are not compatible with + NTLMv2.
Similarly, if enabled, NTLMv1, client lanman auth and client plaintext auth + authentication will be disabled. This also disables share-level + authentication.
If disabled, an NTLM response (and possibly a LANMAN response) + will be sent by the client, depending on the value of client lanman auth.
Note that some sites (particularly + those following 'best practice' security polices) only allow NTLMv2 + responses, and not the weaker LM or NTLM.
Default: client ntlmv2 auth = no
+
+
Specifies whether a client should send a plaintext + password if the server does not support encrypted passwords.
Default: client plaintext auth = yes
+
+
This controls whether the client offers or even
+ demands the use of the netlogon schannel.
+ client schannel = no does not
+ offer the schannel, client schannel =
+ auto offers the schannel but does not
+ enforce it, and client schannel =
+ yes denies access if the server is not
+ able to speak netlogon schannel.
Default: client schannel = auto
+
+
Example: client schannel = yes
+
+
This controls whether the client offers or requires + the server it talks to to use SMB signing. Possible values + are auto, mandatory + and disabled. +
When set to auto, SMB signing is offered, but not enforced. + When set to mandatory, SMB signing is required and if set + to disabled, SMB signing is not offered either.
Default: client signing = auto
+
+
This variable controls whether Samba clients will try + to use Simple and Protected NEGOciation (as specified by rfc2478) with + supporting servers (including WindowsXP, Windows2000 and Samba + 3.0) to agree upon an authentication + mechanism. This enables Kerberos authentication in particular.
Default: client use spnego = yes
+
+
This is a text field that is seen next to a share + when a client does a queries the server, either via the network + neighborhood or via net view to list what shares + are available.
If you want to set the string that is displayed next to the + machine name then see the server string parameter.
Default: comment =
+# No comment
+
+
Example: comment = Fred's Files
+
+
This allows you to override the config file
+ to use, instead of the default (usually smb.conf).
+ There is a chicken and egg problem here as this option is set
+ in the config file!
For this reason, if the name of the config file has changed + when the parameters are loaded then it will reload them from + the new config file.
This option takes the usual substitutions, which can + be very useful.
If the config file doesn't exist then it won't be loaded + (allowing you to special case the config files of just a few + clients).
No default
Example: config file = /usr/local/samba/lib/smb.conf.%m
+
+
This parameter allows you to "clone" service + entries. The specified service is simply duplicated under the + current service's name. Any parameters specified in the current + section will override those in the section being copied.
This feature lets you set up a 'template' service and + create similar services easily. Note that the service being + copied must occur earlier in the configuration file than the + service doing the copying.
Default: copy =
+
+
Example: copy = otherservice
+
+
This parameter is a synonym for create mask.
+ When a file 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 file. Any bit not set here will + be removed from the modes set on a file when it is created. +
+ The default value of this parameter removes the group and other
+ write and execute bits from the UNIX modes.
+
+ Following this Samba will bit-wise 'OR' the UNIX mode created from this parameter with the value of the + force create mode parameter which is set to 000 by default. +
+ This parameter does not affect directory masks. See the parameter directory mask + for details. +
+ Note that this parameter does not apply to permissions set by Windows NT/2000 ACL editors. If the + administrator wishes to enforce a mask on access control lists also, they need to set the security mask. +
Default: create mask = 0744
+
+
Example: create mask = 0775
+
+
This stands for client-side caching + policy, and specifies how clients capable of offline + caching will cache the files in the share. The valid values + are: manual, documents, programs, disable.
These values correspond to those used on Windows servers.
For example, shares containing roaming profiles can have + offline caching disabled using csc policy = disable.
Default: csc policy = manual
+
+
Example: csc policy = programs
+
+
+ This parameter is only applicable if printing is
+ set to cups. Its value is a free form string of options
+ passed directly to the cups library.
+
You can pass any generic print option known to CUPS (as listed + in the CUPS "Software Users' Manual"). You can also pass any printer + specific option (as listed in "lpoptions -d printername -l") + valid for the target queue.
You should set this parameter to raw if your CUPS server
+ error_log file contains messages such as
+ "Unsupported format 'application/octet-stream'" when printing from a Windows client
+ through Samba. It is no longer necessary to enable
+ system wide raw printing in /etc/cups/mime.{convs,types}.
+
Default: cups options = ""
+
+
Example: cups options = "raw,media=a4,job-sheets=secret,secret"
+
+
This parameter is only applicable if printing is set to cups.
+
If set, this option overrides the ServerName option in the CUPS
+ client.conf. This is necessary if you have virtual
+ samba servers that connect to different CUPS daemons.
Default: cups server = ""
+
+
Example: cups server = MYCUPSSERVER
+
+
The value of the parameter (a decimal integer) + represents the number of minutes of inactivity before a connection + is considered dead, and it is disconnected. The deadtime only takes + effect if the number of open files is zero.
This is useful to stop a server's resources being + exhausted by a large number of inactive connections.
Most clients have an auto-reconnect feature when a + connection is broken so in most cases this parameter should be + transparent to users.
Using this parameter with a timeout of a few minutes + is recommended for most systems.
A deadtime of zero indicates that no auto-disconnection + should be performed.
Default: deadtime = 0
+
+
Example: deadtime = 15
+
+
Sometimes the timestamps in the log messages + are needed with a resolution of higher that seconds, this + boolean parameter adds microsecond resolution to the timestamp + message header when turned on.
+ Note that the parameter debug timestamp must be on for this to have an + effect.
Default: debug hires timestamp = no
+
+
When using only one log file for more then one forked + smbd(8)-process there may be hard to + follow which process outputs which message. This boolean parameter + is adds the process-id to the timestamp message headers in the + logfile when turned on.
Note that the parameter debug timestamp must be on for this to have an + effect.
Default: debug pid = no
+
+
This parameter is a synonym for debug timestamp.
Samba debug log messages are timestamped + by default. If you are running at a high debug level these timestamps + can be distracting. This boolean parameter allows timestamping + to be turned off.
Default: debug timestamp = yes
+
+
Samba is sometimes run as root and sometime + run as the connected user, this boolean parameter inserts the + current euid, egid, uid and gid to the timestamp message headers + in the log file if turned on.
Note that the parameter debug timestamp must be on for this to have an + effect.
Default: debug uid = no
+
+
See the section on name mangling + . Also note the short preserve case parameter.
Default: default case = lower
+
+
This parameter is only applicable to printable services. + When smbd is serving Printer Drivers to Windows NT/2k/XP clients, each printer on the Samba + server has a Device Mode which defines things such as paper size and + orientation and duplex settings. The device mode can only correctly be + generated by the printer driver itself (which can only be executed on a + Win32 platform). Because smbd is unable to execute the driver code + to generate the device mode, the default behavior is to set this field + to NULL. +
Most problems with serving printer drivers to Windows NT/2k/XP clients + can be traced to a problem with the generated device mode. Certain drivers + will do things such as crashing the client's Explorer.exe with a NULL devmode. + However, other printer drivers can cause the client's spooler service + (spoolsv.exe) to die if the devmode was not created by the driver itself + (i.e. smbd generates a default devmode). +
This parameter should be used with care and tested with the printer + driver in question. It is better to leave the device mode to NULL + and let the Windows client set the correct values. Because drivers do not + do this all the time, setting default devmode = yes + will instruct smbd to generate a default one. +
For more information on Windows NT/2k printing and Device Modes, + see the MSDN documentation. +
Default: default devmode = no
+
+
This parameter is a synonym for default service.
This parameter specifies the name of a service + which will be connected to if the service actually requested cannot + be found. Note that the square brackets are NOT + given in the parameter value (see example below).
There is no default value for this parameter. If this + parameter is not given, attempting to connect to a nonexistent + service results in an error.
+ Typically the default service would be a guest ok, read-only service.
Also note that the apparent service name will be changed to equal
+ that of the requested service, this is very useful as it allows you to use macros like %S to make a wildcard service.
+
Note also that any "_" characters in the name of the service + used in the default service will get mapped to a "/". This allows for + interesting things.
Default: default service =
+
+
Example: default service = pub
+
+
+ Windows allows specifying how a file will be shared with + other processes when it is opened. Sharing violations occur when + a file is opened by a different process using options that violate + the share settings specified by other processes. This parameter causes + smbd to act as a Windows server does, and defer returning a "sharing + violation" error message for up to one second, allowing the client + to close the file causing the violation in the meantime. +
Unix by default does not have this behaviour.
+ There should be no reason to turn off this parameter, as it is + designed to enable Samba to more correctly emulate Windows. +
Default: defer sharing violations = True
+
+
This is the full pathname to a script that will
+ be run AS ROOT smbd(8) when a group is requested to be deleted.
+ It will expand any %g to the group name passed.
+ This script is only useful for installations using the Windows NT domain administration tools.
+
Default: delete group script =
+
+
With the introduction of MS-RPC based printer + support for Windows NT/2000 clients in Samba 2.2, it is now + possible to delete printer at run time by issuing the + DeletePrinter() RPC call.
For a Samba host this means that the printer must be
+ physically deleted from underlying printing system. The
+ deleteprinter command defines a script to be run which
+ will perform the necessary operations for removing the printer
+ from the print system and from smb.conf.
+
The deleteprinter command is + automatically called with only one parameter: printer name. +
Once the deleteprinter command has
+ been executed, smbd will reparse the
+ smb.conf to associated printer no longer exists.
+ If the sharename is still valid, then smbd
+ will return an ACCESS_DENIED error to the client.
Default: deleteprinter command =
+
+
Example: deleteprinter command = /usr/bin/removeprinter
+
+
This parameter allows readonly files to be deleted. + This is not normal DOS semantics, but is allowed by UNIX.
This option may be useful for running applications such + as rcs, where UNIX file ownership prevents changing file + permissions, and DOS semantics prevent deletion of a read only file.
Default: delete readonly = no
+
+
Samba 2.2.0 introduced the ability to dynamically
+ add and delete shares via the Windows NT 4.0 Server Manager. The
+ delete share command is used to define an
+ external program or script which will remove an existing service
+ definition from smb.conf. In order to successfully
+ execute the delete share command, smbd
+ requires that the administrator be connected using a root account (i.e.
+ uid == 0).
+
+ When executed, smbd will automatically invoke the
+ delete share command with two parameters.
+
configFile - the location
+ of the global smb.conf file.
+
shareName - the name of
+ the existing service.
+
+ This parameter is only used to remove file shares. To delete printer shares, + see the deleteprinter command. +
Default: delete share command =
+
+
Example: delete share command = /usr/local/bin/delshare
+
+
Full path to the script that will be called when
+ a user is removed from a group using the Windows NT domain administration
+ tools. It will be run by smbd(8) AS ROOT.
+ Any %g will be replaced with the group name and
+ any %u will be replaced with the user name.
+
Default: delete user from group script =
+
+
Example: delete user from group script = /usr/sbin/deluser %u %g
+
+
This is the full pathname to a script that will + be run by smbd(8) when managing users + with remote RPC (NT) tools. +
This script is called when a remote client removes a user + from the server, normally using 'User Manager for Domains' or + rpcclient.
This script should delete the given UNIX username.
Default: delete user script =
+
+
Example: delete user script = /usr/local/samba/bin/del_user %u
+
+
This option is used when Samba is attempting to
+ delete a directory that contains one or more vetoed directories
+ (see the veto files
+ option). If this option is set to no (the default) then if a vetoed
+ directory contains any non-vetoed files or directories then the
+ directory delete will fail. This is usually what you want.
If this option is set to yes, then Samba
+ will attempt to recursively delete any files and directories within
+ the vetoed directory. This can be useful for integration with file
+ serving systems such as NetAtalk which create meta-files within
+ directories you might normally veto DOS/Windows users from seeing
+ (e.g. .AppleDouble)
Setting delete veto files = yes allows these + directories to be transparently deleted when the parent directory + is deleted (so long as the user has permissions to do so).
Default: delete veto files = no
+
+
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!
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.
Default: dfree command =
+# By default internal routines for
+ determining the disk capacity and remaining space will be used.
+
+
Example: dfree command = /usr/local/samba/bin/dfree
+
+
This parameter is a synonym for directory mask.
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 force directory mode parameter. + This parameter is set to 000 by default (i.e. no extra mode bits are added).
Note that this parameter does not apply to permissions + set by Windows NT/2000 ACL editors. If the administrator wishes to enforce + a mask on access control lists also, they need to set the directory security mask.
Default: directory mask = 0755
+
+
Example: directory mask = 0775
+
+
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. Make sure not to mix up this parameter with force directory security mode, which works similar like this one but uses logical OR instead of AND. + Essentially, zero bits in this mask may be treated as a set of bits the user is not allowed to change. +
If not set explicitly this parameter is set to 0777 + meaning a user is allowed to modify all the user/group/world + permissions on a directory.
Note that users who can access the
+ Samba server through other means can easily bypass this restriction,
+ so it is primarily useful for standalone "appliance" systems.
+ Administrators of most normal systems will probably want to leave
+ it as the default of 0777.
Default: directory security mask = 0777
+
+
Example: directory security mask = 0700
+
+
Enabling this parameter will disable netbios support + in Samba. Netbios is the only available form of browsing in + all windows versions except for 2000 and XP.
Clients that only support netbios won't be able to + see your samba server when netbios support is disabled. +
Default: disable netbios = no
+
+
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. +
Default: disable spoolss = no
+
+
Specifies the charset that samba will use + to print messages to stdout and stderr and SWAT will use. + Should generally be the same as the unix charset. +
Default: display charset = ASCII
+
+
Example: display charset = UTF8
+
+
Specifies that nmbd(8) when acting as a WINS server and + finding that a NetBIOS name has not been registered, should treat the + NetBIOS name word-for-word as a DNS name and do a lookup with the DNS server + for that name on behalf of the name-querying client.
Note that the maximum length for a NetBIOS name is 15 + characters, so the DNS name (or DNS alias) can likewise only be + 15 characters, maximum.
nmbd spawns a second copy of itself to do the + DNS name lookup requests, as doing a name lookup is a blocking + action.
Default: dns proxy = yes
+
+
+ If set to yes, the Samba server will
+ provide the netlogon service for Windows 9X network logons for the
+ workgroup it is in.
+ This will also cause the Samba server to act as a domain
+ controller for NT4 style domain services. For more details on
+ setting up this feature see the Domain Control chapter of the
+ Samba HOWTO Collection.
+
Default: domain logons = no
+
+
Tell smbd(8) to enable WAN-wide browse list + collation. Setting this option causes nmbd to + claim a special domain specific NetBIOS name that identifies + it as a domain master browser for its given + workgroup. Local master browsers + in the same workgroup on broadcast-isolated + subnets will give this nmbd their local browse lists, + and then ask smbd(8) for a complete copy of the browse + list for the whole wide area network. Browser clients will then contact + their local master browser, and will receive the domain-wide browse list, + instead of just the list for their broadcast-isolated subnet.
Note that Windows NT Primary Domain Controllers expect to be + able to claim this workgroup specific special + NetBIOS name that identifies them as domain master browsers for + that workgroup by default (i.e. there is no + way to prevent a Windows NT PDC from attempting to do this). This + means that if this parameter is set and nmbd claims + the special name for a workgroup before a Windows + NT PDC is able to do so then cross subnet browsing will behave + strangely and may fail.
If domain logons = yes + , then the default behavior is to enable the domain master parameter. If domain logons is + not enabled (the default setting), then neither will domain master be enabled by default.
Default: domain master = auto
+
+
There are certain directories on some systems
+ (e.g., the /proc tree under Linux) that are either not
+ of interest to clients or are infinitely deep (recursive). This
+ parameter allows you to specify a comma-delimited list of directories
+ that the server should always show as empty.
Note that Samba can be very fussy about the exact format
+ of the "dont descend" entries. For example you may need
+ ./proc instead of just /proc.
+ Experimentation is the best policy :-)
Default: dont descend =
+
+
Example: dont descend = /proc,/dev
+
+
DOS SMB clients assume the server has + the same charset as they do. This option specifies which + charset Samba should talk to DOS clients. +
The default depends on which charsets you have installed. + Samba tries to use charset 850 but falls back to ASCII in + case it is not available. Run testparm(1) to check the default on your system.
No default
The default behavior in Samba is to provide + UNIX-like behavior where only the owner of a file/directory is + able to change the permissions on it. However, this behavior + is often confusing to DOS/Windows users. Enabling this parameter + allows a user who has write access to the file (by whatever + means) to modify the permissions on it. Note that a user + belonging to the group owning the file will not be allowed to + change permissions if the group is only granted read access. + Ownership of the file/directory is not changed, only the permissions + are modified.
Default: dos filemode = no
+
+
Under the DOS and Windows FAT filesystem, the finest + granularity on time resolution is two seconds. Setting this parameter + for a share causes Samba to round the reported time down to the + nearest two second boundary when a query call that requires one second + resolution is made to smbd(8).
This option is mainly used as a compatibility option for Visual + C++ when used against Samba shares. If oplocks are enabled on a + share, Visual C++ uses two different time reading calls to check if a + file has changed since it was last read. One of these calls uses a + one-second granularity, the other uses a two second granularity. As + the two second call rounds any odd second down, then if the file has a + timestamp of an odd number of seconds then the two timestamps will not + match and Visual C++ will keep reporting the file has changed. Setting + this option causes the two timestamps to match, and Visual C++ is + happy.
Default: dos filetime resolution = no
+
+
Under DOS and Windows, if a user can write to a
+ file they can change the timestamp on it. Under POSIX semantics,
+ only the owner of the file or root may change the timestamp. By
+ default, Samba runs with POSIX semantics and refuses to change the
+ timestamp on a file if the user smbd is acting
+ on behalf of is not the file owner. Setting this option to
+ yes allows DOS semantics and smbd(8) will change the file
+ timestamp as DOS requires. Due to changes in Microsoft Office 2000 and beyond,
+ the default for this parameter has been changed from "no" to "yes" in Samba 3.0.14
+ and above. Microsoft Excel will display dialog box warnings about the file being
+ changed by another user if this parameter is not set to "yes" and files are being
+ shared between users.
+
Default: dos filetimes = yes
+
+
This boolean parameter controls whether smbd(8) will allow clients to attempt to store OS/2 style Extended + attributes on a share. In order to enable this parameter the underlying filesystem exported by + the share must support extended attributes (such as provided on XFS and EXT3 on Linux, with the + correct kernel patches). On Linux the filesystem must have been mounted with the mount + option user_xattr in order for extended attributes to work, also + extended attributes must be compiled into the Linux kernel.
Default: ea support = no
+
+
Hosts running the "Advanced Server for Unix (ASU)" product + require some special accomodations such as creating a builting [ADMIN$] + share that only supports IPC connections. The has been the default + behavior in smbd for many years. However, certain Microsoft applications + such as the Print Migrator tool require that the remote server support + an [ADMIN$} file share. Disabling this parameter allows for creating + an [ADMIN$] file share in smb.conf.
Default: enable asu support = yes
+
+
This parameter controls whether or not smbd will honor + privileges assigned to specific SIDs via either net rpc rights + or one of the Windows user and group manager tools. This parameter is + disabled by default to prevent members of the Domain Admins group from + being able to assign privileges to users or groups which can then result in certain + smbd operations running as root that would normally run under the context + of the connected user.
An example of how privileges can be used is to assign + the right to join clients to a Samba controlled domain without + providing root access to the server via smbd.
Please read the extended description provided in the + Samba documentation before enabling this option.
Default: enable privileges = no
+
+
This option is used to control whether or not smbd in Samba 3.0 should fallback + to the algorithm used by Samba 2.2 to generate user and group RIDs. The longterm + development goal is to remove the algorithmic mappings of RIDs altogether, but + this has proved to be difficult. This parameter is mainly provided so that + developers can turn the algorithm on and off and see what breaks. This parameter + should not be disabled by non-developers because certain features in Samba will fail + to work without it. +
Default: enable rid algorithm = yes
+
+
This boolean controls whether encrypted passwords + will be negotiated with the client. Note that Windows NT 4.0 SP3 and + above and also Windows 98 will by default expect encrypted passwords + unless a registry entry is changed. To use encrypted passwords in + Samba see the chapter "User Database" in the Samba HOWTO Collection. +
+ MS Windows clients that expect Microsoft encrypted passwords and that + do not have plain text password support enabled will be able to + connect only to a Samba server that has encypted password support + enabled and for which the user accounts have a valid encrypted password. + Refer to the smbpasswd command man page for information regarding the + creation of encrypted passwords for user accounts. +
+ The use of plain text passwords is NOT advised as support for this feature + is no longer maintained in Microsoft Windows products. If you want to use + plain text passwords you must set this parameter to no. +
In order for encrypted passwords to work correctly + smbd(8) must either + have access to a local smbpasswd(5) file (see the smbpasswd(8) program for information on how to set up + and maintain this file), or set the security = [server|domain|ads] parameter which + causes smbd to authenticate against another + server.
Default: encrypt passwords = yes
+
+
This option enables a couple of enhancements to + cross-subnet browse propagation that have been added in Samba + but which are not standard in Microsoft implementations. +
The first enhancement to browse propagation consists of a regular + wildcard query to a Samba WINS server for all Domain Master Browsers, + followed by a browse synchronization with each of the returned + DMBs. The second enhancement consists of a regular randomised browse + synchronization with all currently known DMBs.
You may wish to disable this option if you have a problem with empty + workgroups not disappearing from browse lists. Due to the restrictions + of the browse protocols these enhancements can cause a empty workgroup + to stay around forever which can be annoying.
In general you should leave this option enabled as it makes + cross-subnet browse propagation much more reliable.
Default: enhanced browsing = yes
+
+
The concept of a "port" is fairly foreign
+ to UNIX hosts. Under Windows NT/2000 print servers, a port
+ is associated with a port monitor and generally takes the form of
+ a local port (i.e. LPT1:, COM1:, FILE:) or a remote port
+ (i.e. LPD Port Monitor, etc...). By default, Samba has only one
+ port defined--"Samba Printer Port". Under
+ Windows NT/2000, all printers must have a valid port name.
+ If you wish to have a list of ports displayed (smbd
+ does not use a port name for anything) other than
+ the default "Samba Printer Port", you
+ can define enumports command to point to
+ a program which should generate a list of ports, one per line,
+ to standard output. This listing will then be used in response
+ to the level 1 and 2 EnumPorts() RPC.
Default: enumports command =
+
+
Example: enumports command = /usr/bin/listports
+
+
NTFS and Windows VFAT file systems keep a create + time for all files and directories. This is not the same as the + ctime - status change time - that Unix keeps, so Samba by default + reports the earliest of the various times Unix does keep. Setting + this parameter for a share causes Samba to always report midnight + 1-1-1980 as the create time for directories.
This option is mainly used as a compatibility option for + Visual C++ when used against Samba shares. Visual C++ generated + makefiles have the object directory as a dependency for each object + file, and a make rule to create the directory. Also, when NMAKE + compares timestamps it uses the creation time when examining a + directory. Thus the object directory will be created if it does not + exist, but once it does exist it will always have an earlier + timestamp than the object files it contains.
However, Unix time semantics mean that the create time + reported by Samba will be updated whenever a file is created or + or deleted in the directory. NMAKE finds all object files in + the object directory. The timestamp of the last one built is then + compared to the timestamp of the object directory. If the + directory's timestamp if newer, then all object files + will be rebuilt. Enabling this option + ensures directories always predate their contents and an NMAKE build + will proceed as expected.
Default: fake directory create times = no
+
+
Oplocks are the way that SMB clients get permission + from a server to locally cache file operations. If a server grants + an oplock (opportunistic lock) then the client is free to assume + that it is the only one accessing the file and it will aggressively + cache file data. With some oplock types the client may even cache + file open/close operations. This can give enormous performance benefits. +
When you set fake oplocks = yes, smbd(8) will + always grant oplock requests no matter how many clients are using the file.
It is generally much better to use the real oplocks support rather + than this parameter.
If you enable this option on all read-only shares or + shares that you know will only be accessed from one client at a + time such as physically read-only media like CDROMs, you will see + a big performance improvement on many operations. If you enable + this option on shares where multiple clients may be accessing the + files read-write at the same time you can get data corruption. Use + this option carefully!
Default: fake oplocks = no
+
+
This parameter allows the Samba administrator
+ to stop smbd(8) from following symbolic
+ links in a particular share. Setting this
+ parameter to no prevents any file or directory
+ that is a symbolic link from being followed (the user will get an
+ error). This option is very useful to stop users from adding a
+ symbolic link to /etc/passwd in their home
+ directory for instance. However it will slow filename lookups
+ down slightly.
This option is enabled (i.e. smbd will + follow symbolic links) by default.
Default: follow symlinks = yes
+
+
This parameter specifies a set of UNIX mode bit
+ permissions that will always be set on a
+ file created by Samba. This is done by bitwise 'OR'ing these bits onto
+ the mode bits of a file that is being created or having its
+ permissions changed. The default for this parameter is (in octal)
+ 000. The modes in this parameter are bitwise 'OR'ed onto the file
+ mode after the mask set in the create mask
+ parameter is applied.
The example below would force all created files to have read and execute + permissions set for 'group' and 'other' as well as the + read/write/execute bits set for the 'user'.
Default: force create mode = 000
+
+
Example: force create mode = 0755
+
+
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.
The example below would force all created directories to have read and execute + permissions set for 'group' and 'other' as well as the + read/write/execute bits set for the 'user'.
Default: force directory mode = 000
+
+
Example: force directory mode = 0755
+
+
+ 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. Make sure not to mix up this parameter with directory security mask, which works in a similar manner to this one, but uses a logical AND instead + of an OR. +
+ Essentially, this mask may be treated as a set of bits that, when modifying security on a directory, + to will enable (1) any flags that are off (0) but which the mask has set to on (1). +
+ If not set explicitly this parameter is 0000, which allows a user to modify all the user/group/world + permissions on a directory without restrictions. +
+ Users who can access the Samba server through other means can easily bypass this restriction, so it is + primarily useful for standalone "appliance" systems. Administrators of most normal systems will + probably want to leave it set as 0000. +
Default: force directory security mode = 0
+
+
Example: force directory security mode = 700
+
+
This parameter is a synonym for force group.
This specifies a UNIX group name that will be + assigned as the default primary group for all users connecting + to this service. This is useful for sharing files by ensuring + that all access to files on service will use the named group for + their permissions checking. Thus, by assigning permissions for this + group to the files and directories within this service the Samba + administrator can restrict or allow sharing of these files.
In Samba 2.0.5 and above this parameter has extended
+ functionality in the following way. If the group name listed here
+ has a '+' character prepended to it then the current user accessing
+ the share only has the primary group default assigned to this group
+ if they are already assigned as a member of that group. This allows
+ an administrator to decide that only users who are already in a
+ particular group will create files with group ownership set to that
+ group. This gives a finer granularity of ownership assignment. For
+ example, the setting force group = +sys means
+ that only users who are already in group sys will have their default
+ primary group assigned to sys when accessing this Samba share. All
+ other users will retain their ordinary primary group.
+ If the force user parameter is also set the group specified in
+ force group will override the primary group
+ set in force user.
Default: force group =
+
+
Example: force group = agroup
+
+
When printing from Windows NT (or later),
+ each printer in smb.conf has two
+ associated names which can be used by the client. The first
+ is the sharename (or shortname) defined in smb.conf. This
+ is the only printername available for use by Windows 9x clients.
+ The second name associated with a printer can be seen when
+ browsing to the "Printers" (or "Printers and Faxes") folder
+ on the Samba server. This is referred to simply as the printername
+ (not to be confused with the printer name option).
+
When assigning a new driver to a printer on a remote
+ Windows compatible print server such as Samba, the Windows client
+ will rename the printer to match the driver name just uploaded.
+ This can result in confusion for users when multiple
+ printers are bound to the same driver. To prevent Samba from
+ allowing the printer's printername to differ from the sharename
+ defined in smb.conf, set force printername = yes.
+
Be aware that enabling this parameter may affect migrating + printers from a Windows server to Samba since Windows has no way to + force the sharename and printername to match.
It is recommended that this parameter's value not be changed + once the printer is in use by clients as this could cause a user + not be able to delete printer connections from their local Printers + folder.
Default: force printername = no
+
+
+ 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. +
+ This parameter is applied as a mask (OR'ed with) to the changed permission bits, thus forcing any bits in this + mask that the user may have modified to be on. Make sure not to mix up this parameter with security mask, which works similar like this one but uses logical AND instead of OR. +
+ Essentially, one bits in this mask may be treated as a set of bits that, when modifying security on a file, + the user has always set to be on. +
+ If not set explicitly this parameter is set to 0, and allows a user to modify all the user/group/world + permissions on a file, with no restrictions. +
+ Note that users who can access the Samba server through other means can easily bypass this + restriction, so it is primarily useful for standalone "appliance" systems. Administrators of most + normal systems will probably want to leave this set to 0000. +
Default: force security mode = 0
+
+
Example: force security mode = 700
+
+
If this parameter is set, a Windows NT ACL that contains an unknown + SID (security descriptor, or representation of a user or group + id) as the owner or group owner of the file will be silently + mapped into the current UNIX uid or gid of the currently + connected user.
This is designed to allow Windows NT clients to copy files and + folders containing ACLs that were created locally on the client + machine and contain users local to that machine only (no domain + users) to be copied to a Samba server (usually with XCOPY /O) + and have the unknown userid and groupid of the file owner map to + the current connected user. This can only be fixed correctly + when winbindd allows arbitrary mapping from any Windows NT SID + to a UNIX uid or gid.
Try using this parameter when XCOPY /O gives an ACCESS_DENIED + error.
Default: force unknown acl user = no
+
+
This specifies a UNIX user name that will be + assigned as the default user for all users connecting to this service. + This is useful for sharing files. You should also use it carefully + as using it incorrectly can cause security problems.
This user name only gets used once a connection is established. + Thus clients still need to connect as a valid user and supply a + valid password. Once connected, all file operations will be performed + as the "forced user", no matter what username the client connected + as. This can be very useful.
In Samba 2.0.5 and above this parameter also causes the + primary group of the forced user to be used as the primary group + for all file activity. Prior to 2.0.5 the primary group was left + as the primary group of the connecting user (this was a bug).
Default: force user =
+
+
Example: force user = auser
+
+
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
+
+
The get quota command should only be used + whenever there is no operating system API available from the OS that + samba can use.
This option is only available with ./configure --with-sys-quotas. + Or on linux when ./configure --with-quotas was used and a working quota api + was found in the system.
This parameter should specify the path to a script that + queries the quota information for the specified + user/group for the partition that + the specified directory is on.
Such a script should take 3 arguments:
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 one line as output with spaces between the arguments. The arguments are: +
Arg 1 - quota flags (0 = no quotas, 1 = quotas enabled, 2 = quotas enabled and enforced)
Arg 2 - number of currently used blocks
Arg 3 - the softlimit number of blocks
Arg 4 - the hardlimit number of blocks
Arg 5 - currently used number of inodes
Arg 6 - the softlimit number of inodes
Arg 7 - the hardlimit number of inodes
Arg 8(optional) - the number of bytes in a block(default is 1024)
Default: get quota command =
+
+
Example: get quota command = /usr/local/sbin/query_quota
+
+
This is a tuning option. When this is enabled a
+ caching algorithm will be used to reduce the time taken for getwd()
+ calls. This can have a significant impact on performance, especially
+ when the wide smbconfoptions parameter is set to no.
Default: getwd cache = yes
+
+
This is a username which will be used for access + to services which are specified as guest ok (see below). Whatever privileges this + user has will be available to any client connecting to the guest service. + This user must exist in the password file, but does not require + a valid login. The user account "ftp" is often a good choice + for this parameter. +
On some systems the default guest account "nobody" may not + be able to print. Use another account in this case. You should test + this by trying to log in as your guest user (perhaps by using the + su - command) and trying to print using the + system print command such as lpr(1) or + lp(1).
This parameter does not accept % macros, because + many parts of the system require this value to be + constant for correct operation.
Default: guest account = nobody
+# default can be changed at compile-time
+
+
Example: guest account = ftp
+
+
This parameter is a synonym for guest ok.
If this parameter is yes for
+ a service, then no password is required to connect to the service.
+ Privileges will be those of the guest account.
This paramater nullifies the benifits of setting + restrict anonymous = 2 +
See the section below on security for more information about this option. +
Default: guest ok = no
+
+
This parameter is a synonym for guest only.
If this parameter is yes for
+ a service, then only guest connections to the service are permitted.
+ This parameter will have no effect if guest ok is not set for the service.
See the section below on security for more information about this option. +
Default: guest only = no
+
+
This is a boolean parameter that controls whether + files starting with a dot appear as hidden files.
Default: hide dot files = yes
+
+
This is a list of files or directories that are not + visible but are accessible. The DOS 'hidden' attribute is applied + to any files or directories that match.
Each entry in the list must be separated by a '/', + which allows spaces to be included in the entry. '*' + and '?' can be used to specify multiple files or directories + as in DOS wildcards.
Each entry must be a Unix path, not a DOS path and must + not include the Unix directory separator '/'.
Note that the case sensitivity option is applicable + in hiding files.
Setting this parameter will affect the performance of Samba, + as it will be forced to check all files and directories for a match + as they are scanned.
+ The example shown above is based on files that the Macintosh + SMB client (DAVE) available from + Thursby creates for internal use, and also still hides + all files beginning with a dot. +
+ An example of us of this parameter is: +
+hide files = /.*/DesktopFolderDB/TrashFor%m/resource.frk/ +
+
Default: hide files =
+# no file are hidden
+
+
This parameter prevents clients from seeing + special files such as sockets, devices and fifo's in directory + listings. +
Default: hide special files = no
+
+
This parameter prevents clients from seeing the + existance of files that cannot be read. Defaults to off.
Default: hide unreadable = no
+
+
This parameter prevents clients from seeing + the existance of files that cannot be written to. Defaults to off. + Note that unwriteable directories are shown as usual. +
Default: hide unwriteable files = no
+
+
If nis homedir is yes,
+ and smbd(8) is also acting
+ as a Win95/98 logon server then this parameter
+ specifies the NIS (or YP) map from which the server for the user's
+ home directory should be extracted. At present, only the Sun
+ auto.home map format is understood. The form of the map is:
username server:/some/file/system
and the program will extract the servername from before + the first ':'. There should probably be a better parsing system + that copes with different map formats and also Amd (another + automounter) maps.
A working NIS client is required on + the system for this option to work.
Default: homedir map =
+
+
Example: homedir map = amd.homedir
+
+
If set to yes, Samba will act as a Dfs
+ server, and allow Dfs-aware clients to browse Dfs trees hosted
+ on the server.
See also the msdfs root share level parameter. For + more information on setting up a Dfs tree on Samba, + refer to the MSFDS chapter in the book Samba3-HOWTO. +
Default: host msdfs = no
+
+
Specifies whether samba should use (expensive) + hostname lookups or use the ip addresses instead. An example place + where hostname lookups are currently used is when checking + the hosts deny and hosts allow. +
Default: hostname lookups = no
+
+
Example: hostname lookups = yes
+
+
This parameter is a synonym for hosts allow.
A synonym for this parameter is allow
+ hosts.
This parameter is a comma, space, or tab delimited + set of hosts which are permitted to access a service.
If specified in the [global] section then it will + apply to all services, regardless of whether the individual + service has a different setting.
You can specify the hosts by name or IP number. For
+ example, you could restrict access to only the hosts on a
+ Class C subnet with something like allow hosts = 150.203.5.
+ . The full syntax of the list is described in the man
+ page hosts_access(5). Note that this man
+ page may not be present on your system, so a brief description will
+ be given here also.
Note that the localhost address 127.0.0.1 will always + be allowed access unless specifically denied by a hosts deny option.
You can also specify hosts by network/netmask pairs and + by netgroup names if your system supports netgroups. The + EXCEPT keyword can also be used to limit a + wildcard list. The following examples may provide some help:
Example 1: allow all IPs in 150.203.*.*; except one
hosts allow = 150.203. EXCEPT 150.203.6.66
Example 2: allow hosts that match the given network/netmask
hosts allow = 150.203.15.0/255.255.255.0
Example 3: allow a couple of hosts
hosts allow = lapland, arvidsjaur
Example 4: allow only hosts in NIS netgroup "foonet", but + deny access from one particular host
hosts allow = @foonet
hosts deny = pirate
Note that access still requires suitable user-level passwords.
See testparm(1) for a way of testing your host access + to see if it does what you expect.
Default: hosts allow =
+# none (i.e., all hosts permitted access)
+
+
Example: hosts allow = 150.203.5. myhost.mynet.edu.au
+
+
This parameter is a synonym for hosts deny.
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: hosts deny =
+# none (i.e., no hosts specifically excluded)
+
+
Example: hosts deny = 150.203.4. badhost.mynet.edu.au
+
+
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 hosts allow 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.
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: hosts equiv =
+# no host equivalences
+
+
Example: hosts equiv = hosts equiv = /etc/hosts.equiv
+
+
+ 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). +
+ An alternate method of SID to UID / GID mapping can be achieved using the idmap_rid + plug-in. This plug-in uses the account RID to derive the UID and GID by adding the + RID to a base value specified. This utility requires that the parameter + “allow trusted domains = No” must be specified, as it is not compatible + with multiple domain environments. The idmap uid and idmap gid ranges must also be + specified. +
Default: idmap backend =
+
+
Example: idmap backend = ldap:ldap://ldapslave.example.com
+
+
Example: idmap backend = idmap_rid:DOMNAME=1000-100000000
+
+
This parameter is a synonym for idmap gid.
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 =
+
+
Example: idmap gid = 10000-20000
+
+
This parameter is a synonym for idmap uid.
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 =
+
+
Example: idmap uid = 10000-20000
+
+
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: include =
+
+
Example: include = /usr/local/samba/lib/admin_smb.conf
+
+
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
+
+
The ownership of new files and directories + is normally governed by effective uid of the connected user. + This option allows the Samba administrator to specify that + the ownership for new files and directories should be controlled + by the ownership of the parent directory.
Common scenarios where this behavior is useful is in + implementing drop-boxes where users can create and edit files but not + delete them and to ensure that newly create files in a user's + roaming profile directory are actually owner by the user.
Default: inherit owner = no
+
+
+ The permissions on new files and directories are normally governed by create mask, + directory mask, force create mode and force directory mode 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 map archive, map hidden and map system as usual. +
Note that the setuid bit is never set via + inheritance (the code explicitly prohibits this).
This can be particularly useful on large systems with + many users, perhaps several thousand, to allow a single [homes] + share to be used flexibly by each user.
Default: inherit permissions = no
+
+
This option allows you to override the default + network interfaces list that Samba will use for browsing, name + registration and other NBT traffic. By default Samba will query + the kernel for the list of all active interfaces and use any + interfaces except 127.0.0.1 that are broadcast capable.
The option takes a list of interface strings. Each string + can be in any of the following forms:
a network interface name (such as eth0). + This may include shell-like wildcards so eth* will match + any interface starting with the substring "eth"
an IP address. In this case the netmask is + determined from the list of interfaces obtained from the + kernel
an IP/mask pair.
a broadcast/mask pair.
The "mask" parameters can either be a bit length (such + as 24 for a C class network) or a full netmask in dotted + decimal form.
The "IP" parameters above can either be a full dotted + decimal IP address or a hostname which will be looked up via + the OS's normal hostname resolution mechanisms.
Default: interfaces =
+# all active interfaces except 127.0.0.1 that are broadcast capable
+
+
Example: interfaces =
+
+# This would configure three network interfaces corresponding
+ to the eth0 device and IP addresses 192.168.2.10 and 192.168.3.10.
+ The netmasks of the latter two interfaces would be set to 255.255.255.0.
+ eth0 192.168.2.10/24 192.168.3.10/255.255.255.0
+
+
+
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.
Default: invalid users =
+# no invalid users
+
+
Example: invalid users = root fred admin @wheel
+
+
The value of the parameter (an integer) represents
+ the number of seconds between keepalive
+ packets. If this parameter is zero, no keepalive packets will be
+ sent. Keepalive packets, if sent, allow the server to tell whether
+ a client is still present and responding.
Keepalives should, in general, not be needed if the socket + has the SO_KEEPALIVE attribute set on it by default. (see socket options). +Basically you should only use this option if you strike difficulties.
Default: keepalive = 300
+
+
Example: keepalive = 600
+
+
This parameter specifies whether Samba should ask the + kernel for change notifications in directories so that + SMB clients can refresh whenever the data on the server changes. +
This parameter is only used when your kernel supports + change notification to user programs, using the F_NOTIFY fcntl. +
Default: kernel change notify = yes
+
+
For UNIXes that support kernel based oplocks + (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.
Default: kernel oplocks = yes
+
+
This parameter determines whether or not smbd(8) will attempt to + authenticate users or permit password changes + using the LANMAN password hash. If disabled, only clients which support NT + password hashes (e.g. Windows NT/2000 clients, smbclient, but not + Windows 95/98 or the MS DOS network client) will be able to + connect to the Samba host.
The LANMAN encrypted response is easily broken, due to it's + case-insensitive nature, and the choice of algorithm. Servers + without Windows 95/98/ME or MS DOS clients are advised to disable + this option.
Unlike the encypt + passwords option, this parameter cannot alter client + behaviour, and the LANMAN response will still be sent over the + network. See the client lanman + auth to disable this for Samba's clients (such as smbclient)
If this option, and ntlm + auth are both disabled, then only NTLMv2 logins will be + permited. Not all clients support NTLMv2, and most will require + special configuration to use it.
Default: lanman auth = yes
+
+
This parameter determines whether or not + smbd(8) supports the new 64k + streaming read and write varient SMB requests introduced with + Windows 2000. Note that due to Windows 2000 client redirector bugs + this requires Samba to be running on a 64-bit capable operating + system such as IRIX, Solaris or a Linux 2.4 kernel. Can improve + performance by 10% with Windows 2000 clients. Defaults to on. Not as + tested as some other Samba code paths.
Default: large readwrite = yes
+
+
+ The ldap admin dn defines the Distinguished Name (DN) name used by Samba to contact
+ the ldap server when retreiving user account information. The ldap admin dn is used
+ in conjunction with the admin dn password stored in the private/secrets.tdb
+ file. See the smbpasswd(8)
+ man page for more information on how to accomplish this.
+
+ The ldap admin dn requires a fully specified DN. The ldap suffix is not appended to the ldap admin dn. +
No default
This parameter specifies whether a delete + operation in the ldapsam deletes the complete entry or only the attributes + specific to Samba. +
Default: ldap delete dn = no
+
+
This parameters specifies the suffix that is + used for groups when these are added to the LDAP directory. + If this parameter is unset, the value of ldap suffix will be used instead. The suffix string is pre-pended to the + ldap suffix string so use a partial DN.
Default: ldap group suffix =
+
+
Example: ldap group suffix = ou=Groups
+
+
This parameters specifies the suffix that is + used when storing idmap mappings. If this parameter + is unset, the value of ldap suffix + will be used instead. The suffix string is pre-pended to the + ldap suffix string so use a partial DN.
Default: ldap idmap suffix =
+
+
Example: ldap idmap suffix = ou=Idmap
+
+
It specifies where machines should be added to the ldap tree. + If this parameter is unset, the value of ldap suffix will be used instead. The suffix string is pre-pended to the + ldap suffix string so use a partial DN.
Default: ldap machine suffix =
+
+
Example: ldap machine suffix = ou=Computers
+
+
+ This option is used to define whether or not Samba should sync the LDAP password with the NT + and LM hashes for normal accounts (NOT for workstation, server or domain trusts) on a password + change via SAMBA. +
The ldap passwd sync can be set to one of three values:
Yes = Try
+ to update the LDAP, NT and LM passwords and update the pwdLastSet time.
No = Update NT and
+ LM passwords and update the pwdLastSet time.
Only = Only update
+ the LDAP password and let the LDAP server do the rest.
Default: ldap passwd sync = no
+
+
This parameter is only available if Samba has been + configure to include the --with-ldapsam option + at compile time.
This option is used to control the tcp port number used to contact + the ldap server. + The default is to use the stand LDAPS port 636.
Default: ldap port = 636
+# if ldap ssl = on
+
+
Default: ldap port = 389
+# if ldap ssl = off
+
+
When Samba is asked to write to a read-only LDAP +replica, we are redirected to talk to the read-write master server. +This server then replicates our changes back to the 'local' server, +however the replication might take some seconds, especially over slow +links. Certain client activities, particularly domain joins, can become +confused by the 'success' that does not immediately change the LDAP +back-end's data.
This option simply causes Samba to wait a short time, to +allow the LDAP server to catch up. If you have a particularly +high-latency network, you may wish to time the LDAP replication with a +network sniffer, and increase this value accordingly. Be aware that no +checking is performed that the data has actually replicated.
The value is specified in milliseconds, the maximum +value is 5000 (5 seconds).
Default: ldap replication sleep = 1000
+
+
+By default, Samba as a Domain Controller with an LDAP backend needs to use the +Unix-style NSS subsystem to access user and group information. Due to the way +Unix stores user information in /etc/passwd and /etc/group this inevitably +leads to inefficiencies. One important question a user needs to know is the +list of groups he is member of. The plain Unix model involves a complete +enumeration of the file /etc/group and its NSS counterparts in LDAP. In this +particular case there often optimized functions are available in Unix, but for +other queries there is no optimized function available.
To make Samba scale well in large environments, the ldapsam:trusted=yes +option assumes that the complete user and group database that is relevant to +Samba is stored in LDAP with the standard posixAccount/posixGroup model, and +that the Samba auxiliary object classes are stored together with the the posix +data in the same LDAP object. If these assumptions are met, +ldapsam:trusted=yes can be activated and Samba can completely bypass the NSS +system to query user information. Optimized LDAP queries can speed up domain +logon and administration tasks a lot. Depending on the size of the LDAP +database a factor of 100 or more for common queries is easily achieved.
Default: ldapsam:trusted = no
+
+
This parameter is only available if Samba has been + configure to include the --with-ldapsam + option at compile time.
This parameter should contain the FQDN of the ldap directory + server which should be queried to locate user account information. +
Default: ldap server = localhost
+
+
This option is used to define whether or not Samba should
+ use SSL when connecting to the ldap server
+ This is NOT related to
+ Samba's previous SSL support which was enabled by specifying the
+ --with-ssl option to the configure
+ script.
The ldap ssl can be set to one of three values:
Off = Never
+ use SSL when querying the directory.
Start_tls = Use
+ the LDAPv3 StartTLS extended operation (RFC2830) for
+ communicating with the directory server.
On = Use SSL
+ on the ldaps port when contacting the ldap server. Only available when the
+ backwards-compatiblity --with-ldapsam option is specified
+ to configure. See passdb backend
Default: ldap ssl = start_tls
+
+
Specifies the base for all ldap suffixes and for storing the sambaDomain object.
+ The ldap suffix will be appended to the values specified for the ldap user suffix, + ldap group suffix, ldap machine suffix, and the + ldap idmap suffix. Each of these should be given only a DN relative to the + ldap suffix. +
Default: ldap suffix =
+
+
Example: ldap suffix = dc=samba,dc=org
+
+
When Samba connects to an ldap server that server +may be down or unreachable. To prevent Samba from hanging whilst +waiting for the connection this parameter specifies in seconds how +long Samba should wait before failing the connect. The default is +to only wait fifteen seconds for the ldap server to respond to the +connect request.
Default: ldap timeout = 15
+
+
This parameter specifies where users are added to the tree. + If this parameter is unset, the value of ldap suffix will be used instead. The suffix string is pre-pended to the + ldap suffix string so use a partial DN.
Default: ldap user suffix =
+
+
Example: ldap user suffix = ou=people
+
+
This parameter controls whether Samba supports + level2 (read-only) oplocks on a share.
Level2, or read-only oplocks allow Windows NT clients + that have an oplock on a file to downgrade from a read-write oplock + to a read-only oplock once a second client opens the file (instead + of releasing all oplocks on a second open, as in traditional, + exclusive oplocks). This allows all openers of the file that + support level2 oplocks to cache the file for read-ahead only (ie. + they may not cache writes or lock requests) and increases performance + for many accesses of files that are not commonly written (such as + application .EXE files).
Once one of the clients which have a read-only oplock + writes to the file all clients are notified (no reply is needed + or waited for) and told to break their oplocks to "none" and + delete any read-ahead caches.
It is recommended that this parameter be turned on to + speed access to shared executables.
For more discussions on level2 oplocks see the CIFS spec.
+ Currently, if kernel oplocks are supported then
+ level2 oplocks are not granted (even if this parameter is set to
+ yes). Note also, the oplocks
+ parameter must be set to yes on this share in order for
+ this parameter to have any effect.
Default: level2 oplocks = yes
+
+
This parameter determines if nmbd(8) will produce Lanman announce
+ broadcasts that are needed by OS/2 clients in order for them to see
+ the Samba server in their browse list. This parameter can have three
+ values, yes, no, or
+ auto. The default is auto.
+ If set to no Samba will never produce these
+ broadcasts. If set to yes Samba will produce
+ Lanman announce broadcasts at a frequency set by the parameter
+ lm interval. If set to auto
+ Samba will not send Lanman announce broadcasts by default but will
+ listen for them. If it hears such a broadcast on the wire it will
+ then start sending them at a frequency set by the parameter
+ lm interval.
Default: lm announce = auto
+
+
Example: lm announce = yes
+
+
If Samba is set to produce Lanman announce + broadcasts needed by OS/2 clients (see the + lm announce 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.
Default: lm interval = 60
+
+
Example: lm interval = 120
+
+
A boolean variable that controls whether all + printers in the printcap will be loaded for browsing by default. + See the printers section for + more details.
Default: load printers = yes
+
+
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
+
+
This parameter is a synonym for lock directory.
This option specifies the directory where lock + files will be placed. The lock files are used to implement the + max connections option. +
Default: lock directory = ${prefix}/var/locks
+
+
Example: lock directory = /var/run/samba/locks
+
+
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.
No default
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 acquired. This behavior + is used to support PC database formats such as MS Access + and FoxPro. +
Default: lock spin count = 3
+
+
The time in microseconds that smbd should + pause before attempting to gain a failed lock. See + lock spin count for more details.
Default: lock spin time = 10
+
+
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.
No default
Example: log file = /usr/local/samba/var/log.%m
+
+
This parameter is a synonym for log level.
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.
No default
Example: log level = 3 passdb:5 auth:10 winbind:2
+
+
+ This parameter specifies the local path to which the home directory will be + connected (see logon home) 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:
+
+
+ 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 logon path was returned rather than
+ logon home. This broke net use /home
+ but allowed profiles outside the home directory. The current implementation is correct, and can be used for
+ profiles if you use the above trick.
+
+ Disable this feature by setting logon home = "" - using the empty string. +
+ This option is only useful if Samba is set up as a logon server. +
Default: logon home = \\%N\%U
+
+
Example: logon home = \\remote_smb_server\%U
+
+
+ This parameter specifies the directory where roaming profiles (Desktop, NTuser.dat, etc) are + stored. Contrary to previous versions of these manual pages, it has nothing to do with Win 9X roaming + profiles. To find out how to handle roaming profiles for Win 9X system, see the + logon home parameter. +
+ This option takes the standard substitutions, allowing you to have separate logon scripts for each user or
+ machine. It also specifies the directory from which the "Application Data", (desktop, start menu, network neighborhood, programs and other
+ folders, and their contents, are loaded and displayed on your Windows NT client.
+
+ The share and the path must be readable by the user for the preferences and directories to be loaded onto the + Windows NT client. The share must be writeable when the user logs in for the first time, in order that the + Windows NT client can create the NTuser.dat and other directories. + Thereafter, the directories and any of the contents can, if required, be made read-only. It is not advisable + that the NTuser.dat file be made read-only - rename it to NTuser.man to achieve the desired effect (a + MANdatory profile). +
+ Windows clients can sometimes maintain a connection to the [homes] share, even though there is no user logged + in. Therefore, it is vital that the logon path does not include a reference to the homes share (i.e. setting + this parameter to \\%N\homes\profile_path will cause problems). +
+ This option takes the standard substitutions, allowing you to have separate logon scripts for each user or machine. +
+ Do not quote the value. Setting this as “\\%N\profile\%U” + will break profile handling. Where the tdbsam or ldapsam passdb backend + is used, at the time the user account is created the value configured + for this parameter is written to the passdb backend and that value will + over-ride the parameter value present in the smb.conf file. Any error + present in the passdb backend account record must be editted using the + appropriate tool (pdbedit on the command-line, or any other locally + provided system tool. +
Note that this option is only useful if Samba is set up as a domain controller.
+ Disable the use of roaming profiles by setting the value of this parameter to the empty string. For + example, logon path = "". Take note that even if the default setting + in the smb.conf file is the empty string, any value specified in the user account settings in the passdb + backend will over-ride the effect of setting this parameter to null. Disabling of all roaming profile use + requires that the user account settings must also be blank. +
+ An example of use is: +
+logon path = \\PROFILESERVER\PROFILE\%U +
+
Default: logon path = \\%N\%U\profile
+
+
+ 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 path of /usr/local/samba/netlogon, and logon script = STARTUP.BAT, then the file that will be downloaded is:
+
+ /usr/local/samba/netlogon/STARTUP.BAT +
+
+ The contents of the batch file are entirely your choice. A suggested command would be to add NET TIME \\SERVER /SET /YES, to force every machine to synchronize clocks with the + same time server. Another use would be to add NET USE U: \\SERVER\UTILS + for commonly used utilities, or
NET USE Q: \\SERVER\ISO9001_QAfor + example. +
+ Note that it is particularly important not to allow write access to the [netlogon] share, or to grant users + write permission on the batch files in a secure environment, as this would allow the batch files to be + arbitrarily modified and security to be breached. +
+ This option takes the standard substitutions, allowing you to have separate logon scripts for each user or + machine. +
+ This option is only useful if Samba is set up as a logon server. +
Default: logon script =
+
+
Example: logon script = scripts\%U.bat
+
+
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.
Default: lppause command =
+# 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: lppause command = /usr/bin/lpalt %p-%j -p0
+
+
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.
Default: lpq cache time = 10
+
+
Example: lpq cache time = 30
+
+
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.
Default: lpq command =
+
+
Example: lpq command = /usr/bin/lpq -P%p
+
+
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 lppause command parameter.
If a %p is given then the printer name
+ is put in its place. A %j is replaced with
+ the job number (an integer).
Note that it is good practice to include the absolute path
+ in the lpresume command as the PATH may not
+ be available to the server.
See also the printing parameter.
Default: Currently no default value is given
+ to this string, unless the value of the printing
+ parameter is SYSV, in which case the default is :
lp -i %p-%j -H resume
or if the value of the printing parameter
+ is SOFTQ, then the default is:
qstat -s -j%j -r
Default: lpresume command = lpresume command = /usr/bin/lpalt %p-%j -p2
+
+
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.
+ Examples of use are: +
+lprm command = /usr/bin/lprm -P%p %j + +or + +lprm command = /usr/bin/cancel %p-%j +
+
Default: lprm command = determined by printing parameter
+
+
If a Samba server is a member of a Windows
+ NT Domain (see the security = domain
+ 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 security = domain parameter.
Default: machine password timeout = 604800
+
+
+ This parameter specifies the name of a file + which will contain output created by a magic script (see the + magic script parameter below). +
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
+
+
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 magic output + parameter (see above).
Note that some shells are unable to interpret scripts + containing CR/LF instead of CR as + the end-of-line marker. Magic scripts must be executable + as is on the host, which for some hosts and + some shells will require filtering at the DOS end.
Magic scripts are EXPERIMENTAL and + should NOT be relied upon.
Default: magic script =
+
+
Example: magic script = user.csh
+
+
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:
One very useful case is to remove the annoying ;1
+ off the ends of filenames on some CDROMs (only visible
+ under some UNIXes). To do this use a map of (*;1 *;).
Default: mangled map =
+# no mangled map
+
+
Example: mangled map = (*;1 *;)
+
+
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 name mangling 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 mangling char + option, if you don't like '~'.
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
+
+
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
+
+
This controls what character is used as + the magic character in name mangling. 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 = ^
+
+
controls the algorithm used for the generating + the mangled names. Can take two different values, "hash" and + "hash2". "hash" is the algorithm that was used + used in Samba for many years and was the default in Samba 2.2.x "hash2" is + now the default and is newer and considered a better algorithm (generates less collisions) in + the names. Many Win32 applications store the mangled names and so + changing to algorithms must not be done lightly as these applications + may break unless reinstalled.
Default: mangling method = hash2
+
+
Example: mangling method = hash
+
+
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
+
+
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 create mask for details.
Default: map archive = yes
+
+
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 create mask for details.
No default
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 create mask + for details.
Default: map system = no
+
+
This parameter is only useful in SECURITY =
+ security modes other than security = share
+ - i.e. user, server,
+ and domain.
This parameter can take four different values, which tell + smbd(8) what to do with user + login requests that don't match a valid UNIX user in some way.
The 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 guest account.
Bad Password - Means user logins
+ with an invalid password are treated as a guest login and mapped
+ into the guest account. Note that
+ this can cause problems as it means that any user incorrectly typing
+ their password will be silently logged on as "guest" - and
+ will not know the reason they cannot access files they think
+ they should - there will have been no message given to them
+ that they got their password wrong. Helpdesk services will
+ hate you if you set the map to
+ guest parameter this way :-).
Bad Uid - Is only applicable when Samba is configured
+ in some type of domain mode security (security = {domain|ads}) and means that
+ user logins which are successfully authenticated but which have no valid Unix
+ user account (and smbd is unable to create one) should be mapped to the defined
+ guest account. This was the default behavior of Samba 2.x releases. Note that
+ if a member server is running winbindd, this option should never be required
+ because the nss_winbind library will export the Windows domain users and groups
+ to the underlying OS via the Name Service Switch interface.
Note that this parameter is needed to set up "Guest"
+ share services 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
+
+
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 lock directory option.
Default: max connections = 0
+
+
Example: max connections = 10
+
+
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
+
+
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
+
+
Default: max log size = 1000
+
+
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
+
+
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
+
+
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. +
Default: max print jobs = 1000
+
+
Example: max print jobs = 5000
+
+
This parameter is a synonym for max protocol.
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.
Default: max protocol = NT1
+
+
Example: max protocol = LANMAN1
+
+
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.
Default: max reported print jobs = 0
+
+
Example: max reported print jobs = 1000
+
+
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
+
+
Example: max smbd processes = 1000
+
+
This parameter limits the size in memory of any
+ stat cache being used
+ to speed up case insensitive name mappings. This parameter is
+ the number of kilobyte (1024) units the stat cache can use.
+ The default is zero, which means unlimited. You should not need
+ to change this parameter.
Default: max stat cache size = 0
+
+
Example: max stat cache size = 1024
+
+
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
+
+
This option tells smbd(8) when acting as a WINS server + (wins support = yes) what the maximum + 'time to live' of NetBIOS names that nmbd + will grant will be (in seconds). You should never need to change this + parameter. The default is 6 days (518400 seconds).
Default: max wins ttl = 518400
+
+
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
+
+
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: message command =
+
+
Example: message command = csh -c 'xedit %s; rm %s' &
+
+
This sets the minimum amount of free disk + space that must be available before a user will be able to spool + a print job. It is specified in kilobytes. The default is 0, which + means a user can always spool a print job.
Default: min print space = 0
+
+
Example: min print space = 2000
+
+
The value of the parameter (a string) is the
+ lowest SMB protocol dialect than Samba will support. Please refer
+ to the max protocol
+ 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 lanman auth parameter. Otherwise, you should never need + to change this parameter.
Default: min protocol = CORE
+
+
Example: min protocol = NT1
+
+
This option tells nmbd(8) + when acting as a WINS server (wins support = yes) what the minimum 'time to live' + of NetBIOS names that nmbd will grant will be (in + seconds). You should never need to change this parameter. The default + is 6 hours (21600 seconds).
Default: min wins ttl = 21600
+
+
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 + msdfs root and host msdfs + options to find out how to set up a Dfs root share.
No default
Example: msdfs proxy = \otherserver\someshare
+
+
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 the MSDFS chapter in the Samba3-HOWTO book.
Default: msdfs root = no
+
+
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
+
+
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 <usmbconfoption>lmhosts(5)</usmbconfoption> 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 WINSSERVER 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 interfaces
+ parameter. This is the least reliable of the name resolution
+ methods as it depends on the target host being on a locally
+ connected subnet.
The example below will cause the local lmhosts file to be examined + first, followed by a broadcast attempt, followed by a normal + system hostname lookup.
When Samba is functioning in ADS security mode (security = ads)
+ it is advised to use following settings for name resolve order:
name resolve order = wins bcast
DC lookups will still be done via DNS, but fallbacks to netbios names will + not inundate your DNS servers with needless querys for DOMAIN<0x1c> lookups.
Default: name resolve order = lmhosts host wins bcast
+
+
Example: name resolve order = lmhosts bcast host
+
+
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. +
Default: netbios aliases =
+# empty string (no additional names)
+
+
Example: netbios aliases = TEST TEST1 TEST2
+
+
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.
Default: netbios name =
+# machine DNS name
+
+
Example: netbios name = MYNAME
+
+
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.
Default: netbios scope =
+
+
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 + homedir map and return the server + listed there.
Note that for this option to work there must be a working + NIS system and the Samba server with this option must also + be a logon server.
Default: nis homedir = no
+
+
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
+
+
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
+
+
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
+
+
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
+
+
Allow or disallow client access to accounts that have null passwords.
See also smbpasswd(5).
Default: null passwords = no
+
+
When Samba 3.0 is configured to enable PAM support + (i.e. --with-pam), this parameter will control whether or not Samba + should obey PAM's account and session management directives. The + default behavior is to use PAM for clear text authentication only + and to ignore any account or session management. Note that Samba + always ignores PAM for authentication in the case of encrypt passwords = yes. The reason + is that PAM modules cannot support the challenge/response + authentication mechanism needed in the presence of SMB password encryption. +
Default: obey pam restrictions = no
+
+
This is a boolean option that controls whether
+ connections with usernames not in the user
+ list will be allowed. By default this option is disabled so that a
+ client can supply a username to be used by the server. Enabling
+ this parameter will force the server to only use the login
+ names from the user list and is only really
+ useful in security = share level security.
Note that this also means Samba won't try to deduce
+ usernames from the service name. This can be annoying for
+ the [homes] section. To get around this you could use user =
+ %S which means your user list
+ will be just the service name, which for home directories is the
+ name of the user.
Default: only user = no
+
+
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
+
+
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
+
+
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 veto oplock files parameter. On some systems
+ oplocks are recognized by the underlying operating system. This
+ allows data synchronization between all access to oplocked files,
+ whether it be via Samba or NFS or a local UNIX process. See the
+ kernel oplocks parameter for details.
Default: oplocks = yes
+
+
The parameter is used to define the absolute + path to a file containing a mapping of Windows NT printer driver + names to OS/2 printer driver names. The format is:
<nt driver name> = <os2 driver name>.<device name>
For example, a valid entry using the HP LaserJet 5 + printer driver would appear as HP LaserJet 5L = LASERJET.HP + LaserJet 5L.
+ The need for the file is due to the printer driver namespace problem described in the chapter on Classical Printing in the book Samba3-HOWTO. For more + details on OS/2 clients, please refer to ???. +
Default: os2 driver map =
+
+
This integer value controls what level Samba + advertises itself as for browse elections. The value of this + parameter determines whether nmbd(8) +has a chance of becoming a local master browser for the workgroup in the local broadcast area.
Note :By default, Samba will win
+ a local master browsing election over all Microsoft operating
+ systems except a Windows NT 4.0/2000 Domain Controller. This
+ means that a misconfigured Samba host can effectively isolate
+ a subnet for browsing purposes. See BROWSING.txt
+ in the Samba docs/ directory
+ for details.
Default: os level = 20
+
+
Example: os level = 65
+
+
With the addition of better PAM support in Samba 2.2, + this parameter, it is possible to use PAM's password change control + flag for Samba. If enabled, then PAM will be used for password + changes when requested by an SMB client instead of the program listed in + passwd program. + It should be possible to enable this without changing your + passwd chat parameter for most setups.
Default: pam password change = no
+
+
This is a Samba developer option that allows a + system command to be called when either smbd(8) or smbd(8) crashes. This is usually used to +draw attention to the fact that a problem occurred.
Default: panic action =
+
+
Example: panic action = "/bin/sleep 90000"
+
+
Some version of NT 4.x allow non-guest + users with a bad passowrd. When this option is enabled, samba will not + use a broken NT 4.x server as password server, but instead complain + to the logs and exit. +
Disabling this option prevents Samba from making + this check, which involves deliberatly attempting a + bad logon to the remote server.
Default: paranoid server security = yes
+
+
This option allows the administrator to chose which backends + to retrieve and store passwords with. This allows (for example) both + smbpasswd and tdbsam to be used without a recompile. Multiple + backends can be specified, separated by spaces. The backends will be + searched in the order they are specified. New users are always added + to the first backend specified.
This parameter is in two parts, the backend's name, and a 'location' + string that has meaning only to that particular backed. These are separated + by a : character.
Available backends can include: +
smbpasswd - The default smbpasswd + backend. Takes a path to the smbpasswd file as an optional argument. +
tdbsam - The TDB based password storage + backend. Takes a path to the TDB as an optional argument (defaults to passdb.tdb + in the private dir directory.
ldapsam - The LDAP based passdb + backend. Takes an LDAP URL as an optional argument (defaults to + ldap://localhost)
LDAP connections should be secured where possible. This may be done using either
+ Start-TLS (see ldap ssl) or by
+ specifying ldaps:// in
+ the URL argument.
Multiple servers may also be specified in double-quotes, if your + LDAP libraries supports the LDAP URL notation. + (OpenLDAP does). +
nisplussam - + The NIS+ based passdb backend. Takes name NIS domain as + an optional argument. Only works with sun NIS+ servers. +
mysql - + The MySQL based passdb backend. Takes an identifier as + argument. Read the Samba HOWTO Collection for configuration + details. +
+ +
+ Examples of use are: ++passdb backend = tdbsam:/etc/samba/private/passdb.tdb \ + smbpasswd:/etc/samba/smbpasswd + +or + +passdb backend = ldapsam:ldaps://ldap.example.com + +or + +passdb backend = ldapsam:"ldap://ldap-1.example.com \ + ldap://ldap-2.example.com" + +or + +passdb backend = mysql:my_plugin_args tdbsam +
Default: passdb backend = smbpasswd
+
+
This string controls the "chat" + conversation that takes places between smbd(8) and the local password changing + program to change the user's password. The string describes a + sequence of response-receive pairs that smbd(8) uses to determine what to send to the + passwd program and what to expect back. If the expected output is not + received then the password is not changed.
This chat sequence is often quite site specific, depending + on what local methods are used for password control (such as NIS + etc).
Note that this parameter only is only used if the unix password sync parameter is set to yes. This sequence is
+ then called AS ROOT when the SMB password in the
+ smbpasswd file is being changed, without access to the old password
+ cleartext. This means that root must be able to reset the user's password without
+ knowing the text of the previous password. In the presence of
+ NIS/YP, this means that the passwd program must
+ be executed on the NIS master.
+
The string can contain the macro %n which is substituted
+ for the new password. The chat sequence can also contain the standard
+ macros \n, \r, \t and \s to
+ give line-feed, carriage-return, tab and space. The chat sequence string can also contain
+ a '*' which matches any sequence of characters. Double quotes can be used to collect strings with spaces
+ in them into a single string.
If the send string in any part of the chat sequence is a full + stop ".", then no string is sent. Similarly, if the + expect string is a full stop then no string is expected.
If the pam password change parameter is set to yes, the
+ chat pairs may be matched in any order, and success is determined by the PAM result, not any particular
+ output. The \n macro is ignored for PAM conversions.
+
Default: passwd chat = *new*password* %n\n*new*password* %n\n *changed*
+
+
Example: passwd chat = "*Enter OLD password*" %o\n "*Enter NEW password*" %n\n "*Reenter NEW password*" %n\n "*Password changed*"
+
+
This boolean specifies if the passwd chat script
+ parameter is run in debug mode. In this mode the
+ strings passed to and received from the passwd chat are printed
+ in the smbd(8) log with a
+ debug level
+ of 100. This is a dangerous option as it will allow plaintext passwords
+ to be seen in the smbd log. It is available to help
+ Samba admins debug their passwd chat scripts
+ when calling the passwd program and should
+ be turned off after this has been done. This option has no effect if the
+ pam password change
+ paramter is set. This parameter is off by default.
Default: passwd chat debug = no
+
+
This integer specifies the number of seconds smbd will wait for an initial + answer from a passwd chat script being run. Once the initial answer is received + the subsequent answers must be received in one tenth of this time. The default it + two seconds.
Default: passwd chat timeout = 2
+
+
The name of a program that can be used to set
+ UNIX user passwords. Any occurrences of %u
+ will be replaced with the user name. The user name is checked for
+ existence before calling the password changing program.
Also note that many passwd programs insist in reasonable + passwords, such as a minimum length, or the inclusion + of mixed case chars and digits. This can pose a problem as some clients + (such as Windows for Workgroups) uppercase the password before sending + it.
Note that if the unix
+ password sync parameter is set to yes
+ then this program is called AS ROOT
+ before the SMB password in the smbpasswd
+ file is changed. If this UNIX password change fails, then
+ smbd will fail to change the SMB password also
+ (this is by design).
If the unix password sync parameter
+ is set this parameter MUST USE ABSOLUTE PATHS
+ for ALL programs called, and must be examined
+ for security implications. Note that by default unix
+ password sync is set to no.
Default: passwd program =
+
+
Example: passwd program = /bin/passwd %u
+
+
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.
This parameter is used only when using plain-text passwords. It is + not at all used when encrypted passwords as in use (that is the default + since samba-3.0.0). Use this only when encrypt passwords = No.
Default: password level = 0
+
+
Example: password level = 4
+
+
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 name resolve order and so may resolved + by any method and order described in that parameter.
The password server must be a machine capable of using + the "LM1.2X002" or the "NT LM 0.12" protocol, and it must be in + user level security mode.
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.
Default: password server =
+
+
Example: password server = NT-PDC, NT-BDC1, NT-BDC2, *
+
+
Example: password server = windc.mydomain.com:389 192.168.1.101 *
+
+
Example: password server = *
+
+
This parameter is a synonym for path.
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 root dir + if one was specified.
Default: path =
+
+
Example: path = /home/fred
+
+
This option specifies the directory where pid + files will be placed.
Default: pid directory = ${prefix}/var/locks
+
+
Example: pid directory = pid directory = /var/run/
+
+
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
+
+
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
Default: postexec =
+
+
Example: postexec = echo \"%u disconnected from %S from %m (%I)\" >> /tmp/log
+
+
This parameter is a synonym for preexec.
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 preexec close and postexec. +
Default: preexec =
+
+
Example: preexec = echo \"%u connected to %S from %m (%I)\" >> /tmp/log
+
+
This boolean option controls whether a non-zero + return code from preexec should close the service being connected to.
Default: preexec close = no
+
+
This parameter is a synonym for preferred master.
This boolean parameter controls if + nmbd(8) is a preferred master + browser for its workgroup.
If this is set to yes, on startup, nmbd
+ will force an election, and it will have a slight advantage in
+ winning the election. It is recommended that this parameter is
+ used in conjunction with
+ domain master = yes, so
+ that nmbd can guarantee becoming a domain master.
Use this option with caution, because if there are several + hosts (whether Samba servers, Windows 95 or NT) that are + preferred master browsers on the same subnet, they will each + periodically and continuously attempt to become the local + master browser. This will result in unnecessary broadcast + traffic and reduced browsing capabilities.
Default: preferred master = auto
+
+
This parameter is a synonym for preload.
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 load printers + option is easier. +
Default: preload =
+
+
Example: preload = fred lp colorlp
+
+
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
+
+
This controls if new filenames are created + with the case that the client passes, or if they are forced to + be the default case.
See the section on NAME MANGLING for a fuller discussion.
Default: preserve case = yes
+
+
This parameter is a synonym for printable.
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 read only parameter controls only non-printing access to + the resource.
Default: printable = no
+
+
This option specifies the number of seconds before the printing + subsystem is again asked for the known printers. If the value + is greater than 60 the initial waiting time is set to 60 seconds + to allow an earlier first rescan of the printing subsystem. +
Setting this parameter to 0 (the default) disables any + rescanning for new or removed printers after the initial startup. +
Default: printcap cache time = 0
+
+
Example: printcap cache time = 600
+
+
This parameter is a synonym for printcap name.
This parameter may be used to override the
+ compiled-in default printcap name used by the server (usually
+ /etc/printcap). See the discussion of the [printers] section above for reasons
+ why you might want to do this.
To use the CUPS printing interface set printcap name = cups + . This should be supplemented by an addtional setting + printing = cups in the [global] + section. printcap name = cups will use the + "dummy" printcap created by CUPS, as specified in your CUPS + configuration file. +
On System V systems that use lpstat to
+ list available printers you can use printcap name = lpstat
+ to automatically obtain lists of available printers. This
+ is the default for systems that define SYSV at configure time in
+ Samba (this includes most System V based systems). If
+ printcap name is set to lpstat on
+ these systems then Samba will launch lpstat -v and
+ attempt to parse the output to obtain a printer list.
A minimal printcap file would look something like this:
+print1|My Printer 1 +print2|My Printer 2 +print3|My Printer 3 +print4|My Printer 4 +print5|My Printer 5 +
where the '|' separates aliases of a printer. The fact + that the second alias has a space in it gives a hint to Samba + that it's a comment.
Under AIX the default printcap
+ name is /etc/qconfig. Samba will assume the
+ file is in AIX qconfig format if the string
+ qconfig appears in the printcap filename.
Default: printcap name = /etc/printcap
+
+
Example: printcap name = /etc/myprintcap
+
+
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 guest account
+ in the [global] section.
You can form quite complex print commands by realizing + that they are just passed to a shell. For example the following + will log a print job, print the file, then remove it. Note that + ';' is the usual separator for command in shell scripts.
print command = echo Printing %s >> + /tmp/print.log; lpr -P %p %s; rm %s
You may have to vary this command considerably depending + on how you normally print files on your system. The default for + the parameter varies depending on the setting of the printing + parameter.
Default: For printing = BSD, AIX, QNX, LPRNG + or PLP :
print command = lpr -r -P%p %s
For printing = SYSV or HPUX :
print command = lp -c -d%p %s; rm %s
For printing = SOFTQ :
print command = lp -d%p -s %s; rm %s
For printing = CUPS : If SAMBA is compiled against + libcups, then printcap = cups + uses the CUPS API to + submit jobs, etc. Otherwise it maps to the System V + commands with the -oraw option for printing, i.e. it + uses lp -c -d%p -oraw; rm %s. + With printing = cups, + and if SAMBA is compiled against libcups, any manually + set print command will be ignored.
No default
Example: print command = /usr/local/samba/bin/myprintscript %p %s
+
+
+ This lists users who can do anything to printers + via the remote administration interfaces offered + by MS-RPC (usually using a NT workstation). + This parameter can be set per-share or globally. + Note: The root user always has admin rights. Use + caution with use in the global stanza as this can + cause side effects. +
Default: printer admin =
+
+
Example: printer admin = admin, @staff
+
+
This parameter is a synonym for printer name.
+ 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. +
+ The default value of the printer name may be lp on many
+ systems.
+
Default: printer name = none
+
+
Example: printer name = laserwriter
+
+
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. Please be
+ aware however, that you must place any of the various printing
+ commands (e.g. print command, lpq command, etc...) after defining
+ the value for the printing option since it will
+ reset the printing commands to default values.
See also the discussion in the + [printers] section.
No default
This parameters defines the directory
+ smbd will use for storing such files as smbpasswd
+ and secrets.tdb.
+
Default: private dir = ${prefix}/private
+
+
+ This boolean parameter was added to fix the problems that people have been + having with storing user profiles on Samba shares from Windows 2000 or + Windows XP clients. New versions of Windows 2000 or Windows XP service + packs do security ACL checking on the owner and ability to write of the + profile directory stored on a local workstation when copied from a Samba + share. +
When not in domain mode with winbindd then the security info copied + onto the local workstation has no meaning to the logged in user (SID) on + that workstation so the profile storing fails. Adding this parameter + onto a share used for profile storage changes two things about the + returned Windows ACL. Firstly it changes the owner and group owner + of all reported files and directories to be BUILTIN\\Administrators, + BUILTIN\\Users respectively (SIDs S-1-5-32-544, S-1-5-32-545). Secondly + it adds an ACE entry of "Full Control" to the SID BUILTIN\\Users to + every returned ACL. This will allow any Windows 2000 or XP workstation + user to access the profile.
Note that if you have multiple users logging + on to a workstation then in order to prevent them from being able to access + each others profiles you must remove the "Bypass traverse checking" advanced + user right. This will prevent access to other users profile directories as + the top level profile directory (named after the user) is created by the + workstation profile code and has an ACL restricting entry to the directory + tree to the owning user. +
Default: profile acls = no
+
+
This parameter specifies the command to be + executed on the server host in order to pause the printer queue.
This command should be a program or script which takes + a printer name as its only parameter and stops the printer queue, + such that no longer jobs are submitted to the printer.
This command is not supported by Windows for Workgroups, + but can be issued from the Printers window under Windows 95 + and NT.
If a %p is given then the printer name
+ is put in its place. Otherwise it is placed at the end of the command.
+
Note that it is good practice to include the absolute + path in the command as the PATH may not be available to the + server.
No default
Example: queuepause command = disable %p
+
+
This parameter specifies the command to be + executed on the server host in order to resume the printer queue. It + is the command to undo the behavior that is caused by the + previous parameter (queuepause command).
This command should be a program or script which takes + a printer name as its only parameter and resumes the printer queue, + such that queued jobs are resubmitted to the printer.
This command is not supported by Windows for Workgroups, + but can be issued from the Printers window under Windows 95 + and NT.
If a %p is given then the printer name
+ is put in its place. Otherwise it is placed at the end of the
+ command.
Note that it is good practice to include the absolute + path in the command as the PATH may not be available to the + server.
Default: queueresume command =
+
+
Example: queueresume command = enable %p
+
+
This boolean parameter controls whether
+ smbd(8) will support the "Read
+ Block Multiplex" SMB. This is now rarely used and defaults to
+ no. You should never need to set this
+ parameter.
Default: read bmpx = no
+
+
+ This is a list of users that are given read-only access to a service. If the connecting user is in this list + then they will not be given write access, no matter what the read only option is set + to. The list can include group names using the syntax described in the invalid users + parameter. +
This parameter will not work with the security = share in + Samba 3.0. This is by design.
Default: read list =
+
+
Example: read list = mary, @students
+
+
An inverted synonym is writeable.
If this parameter is yes, then users
+ of a service may not create or modify files in the service's
+ directory.
Note that a printable service (printable = yes) + will ALWAYS allow writing to the directory + (user privileges permitting), but only via spooling operations.
Default: read only = yes
+
+
This parameter controls whether or not the server + will support the raw read SMB requests when transferring data + to clients.
If enabled, raw reads allow reads of 65535 bytes in + one packet. This typically provides a major performance benefit. +
However, some clients either negotiate the allowable + block size incorrectly or are incapable of supporting larger block + sizes, and for these clients you may need to disable raw reads.
In general this parameter should be viewed as a system tuning + tool and left severely alone.
Default: read raw = yes
+
+
This option specifies the kerberos realm to use. The realm is + used as the ADS equivalent of the NT4 domain. It + is usually set to the DNS name of the kerberos server. +
Default: realm =
+
+
Example: realm = mysambabox.mycompany.com
+
+
This option allows you to setup nmbd(8)to periodically announce itself + to arbitrary IP addresses with an arbitrary workgroup name.
This is useful if you want your Samba server to appear + in a remote workgroup for which the normal browse propagation + rules don't work. The remote workgroup can be anywhere that you + can send IP packets to.
For example:
remote announce = 192.168.2.255/SERVERS + 192.168.4.255/STAFF
the above line would cause nmbd to announce itself + to the two given IP addresses using the given workgroup names. + If you leave out the workgroup name then the one given in + the workgroup parameter is used instead.
The IP addresses you choose would normally be the broadcast + addresses of the remote networks, but can also be the IP addresses + of known browse masters if your network config is that stable.
Default: remote announce =
+
+
This option allows you to setup nmbd(8) to periodically request + synchronization of browse lists with the master browser of a Samba + server that is on a remote segment. This option will allow you to + gain browse lists for multiple workgroups across routed networks. This + is done in a manner that does not work with any non-Samba servers.
This is useful if you want your Samba server and all local + clients to appear in a remote workgroup for which the normal browse + propagation rules don't work. The remote workgroup can be anywhere + that you can send IP packets to.
For example:
remote browse sync = 192.168.2.255 192.168.4.255
the above line would cause nmbd to request + the master browser on the specified subnets or addresses to + synchronize their browse lists with the local server.
The IP addresses you choose would normally be the broadcast + addresses of the remote networks, but can also be the IP addresses + of known browse masters if your network config is that stable. If + a machine IP address is given Samba makes NO attempt to validate + that the remote machine is available, is listening, nor that it + is in fact the browse master on its segment.
Default: remote browse sync =
+
+
The setting of this parameter determines whether user and + group list information is returned for an anonymous connection. + and mirrors the effects of the +
+HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\ + Control\LSA\RestrictAnonymous +
+ registry key in Windows 2000 and Windows NT. When set to 0, user + and group list information is returned to anyone who asks. When set + to 1, only an authenticated user can retrive user and + group list information. For the value 2, supported by + Windows 2000/XP and Samba, no anonymous connections are allowed at + all. This can break third party and Microsoft + applications which expect to be allowed to perform + operations anonymously.
+ The security advantage of using restrict anonymous = 1 is dubious, + as user and group list information can be obtained using other + means. +
+ The security advantage of using restrict anonymous = 2 is removed + by setting guest ok = yes on any share. +
Default: restrict anonymous = 0
+
+
This parameter is a synonym for root directory.
This parameter is a synonym for root directory.
The server will chroot() (i.e. + Change its root directory) to this directory on startup. This is + not strictly necessary for secure operation. Even without it the + server will deny access to files not in one of the service entries. + It may also check for, and deny access to, soft links to other + parts of the filesystem, or attempts to use ".." in file names + to access other directories (depending on the setting of the + wide smbconfoptions 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
+
+
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.
Default: root postexec =
+
+
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.
Default: root preexec =
+
+
This is the same as the preexec close
+ parameter except that the command is run as root.
Default: root preexec close = no
+
+
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 map to guestparameter for details.
It is possible to use smbd in a + hybrid mode where it is offers both user and share + level security under different NetBIOS aliases.
The different settings will now be explained.
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 guest only parameter is set, then all the other + stages are missed and only the guest account username is checked. +
Is a username is sent with the share connection + request, then this username (after mapping - see username map), + 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 user 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 + NOTE ABOUT USERNAME/PASSWORD VALIDATION.
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 username map + parameter). Encrypted passwords (see the encrypted passwords parameter) can also + be used in this security mode. Parameters such as user and guest only 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 guest account. + See the map to guest parameter for details on doing this.
See also the section NOTE ABOUT USERNAME/PASSWORD VALIDATION.
This mode will only work correctly if net(8) has been used to add this
+ machine into a Windows NT Domain. It expects the encrypted passwords
+ parameter to be set to yes. In this
+ mode Samba will try to validate the username/password by passing
+ it to a Windows NT Primary or Backup Domain Controller, in exactly
+ the same way that a Windows NT Server would do.
Note that a valid UNIX user must still + exist as well as the account on the Domain Controller to allow + Samba to have a valid UNIX account to map file access to.
Note that from the client's point + of view security = domain is the same + as security = user. It only + affects how the server deals with the authentication, + it does not in any way affect what the client sees.
Note that the name of the resource being + requested is not sent to the server until after + the server has successfully authenticated the client. This is why + guest shares don't work in user level security without allowing + the server to automatically map unknown users into the guest account. + See the map to guest parameter for details on doing this.
See also the section + NOTE ABOUT USERNAME/PASSWORD VALIDATION.
See also the password server parameter and + the encrypted passwords parameter.
+ 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
+ encrypted passwords 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.
+
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). +
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.
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 guest account. + See the map to guest parameter for details on doing this.
See also the section + NOTE ABOUT USERNAME/PASSWORD VALIDATION.
See also the password server parameter and the + encrypted passwords parameter.
In this mode, Samba will act as a domain member in an ADS realm. To operate + in this mode, the machine running Samba will need to have Kerberos installed + and configured and Samba will need to be joined to the ADS realm using the + net utility.
Note that this mode does NOT make Samba operate as a Active Directory Domain + Controller.
Read the chapter about Domain Membership in the HOWTO for details.
Default: security = USER
+
+
Example: security = DOMAIN
+
+
+ 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. +
+ This parameter is applied as a mask (AND'ed with) to the changed permission bits, thus preventing any bits not + in this mask from being modified. Make sure not to mix up this parameter with force security mode, which works in a manner similar to this one but uses a logical OR instead of an AND. +
+ Essentially, zero bits in this mask may be treated as a set of bits the user is not allowed to change. +
+ If not set explicitly this parameter is 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.
+
Default: security mask = 0777
+
+
Example: security mask = 0770
+
+
+ This controls whether the server offers or even demands the use of the netlogon schannel. + server schannel = no does not offer the schannel, server schannel = auto offers the schannel but does not enforce it, and server schannel = yes denies access if the client is not able to speak netlogon schannel. + This is only the case for Windows NT4 before SP4. +
+ Please note that with this set to no you will have to apply the WindowsXP
+ WinXP_SignOrSeal.reg registry patch found in the docs/registry subdirectory of the Samba distribution tarball.
+
Default: server schannel = auto
+
+
Example: server schannel = yes
+
+
This controls whether the server offers or requires + the client it talks to to use SMB signing. Possible values + are auto, mandatory + and disabled. +
When set to auto, SMB signing is offered, but not enforced. + When set to mandatory, SMB signing is required and if set + to disabled, SMB signing is not offered either.
Default: server signing = Disabled
+
+
This controls what string will show up in the printer comment box in print + manager and next to the IPC connection in net view. It + can be any string that you wish to show to your users.
It also sets what will appear in browse lists next + to the machine name.
A %v will be replaced with the Samba
+ version number.
A %h will be replaced with the
+ hostname.
Default: server string = Samba %v
+
+
Example: server string = University of GNUs Samba Server
+
+
If set directory = no, then + users of the service may not use the setdir command to change + directory.
The setdir command is only implemented + in the Digital Pathworks client. See the Pathworks documentation + for details.
Default: set directory = no
+
+
Thanks to the Posix subsystem in NT a Windows User has a
+ primary group in addition to the auxiliary groups. This script
+ sets the primary group in the unix userdatase when an
+ administrator sets the primary group from the windows user
+ manager or when fetching a SAM with net rpc
+ vampire. %u will be replaced
+ with the user whose primary group is to be set.
+ %g will be replaced with the group to
+ set.
Default: set primary group script =
+
+
Example: set primary group script = /usr/sbin/usermod -g '%g' '%u'
+
+
The set quota command should only be used + whenever there is no operating system API available from the OS that + samba can use.
This option is only available if Samba was configured with the argument --with-sys-quotas or + on linux when ./configure --with-quotas was used and a working quota api + was found in the system. Most packages are configured with these options already.
This parameter should specify the path to a script that + can set quota for the specified arguments.
The specified script should take the following arguments:
1 - quota type +
1 - user quotas
2 - user default quotas (uid = -1)
3 - group quotas
4 - group default quotas (gid = -1)
+
2 - id (uid for user, gid for group, -1 if N/A)
3 - quota state (0 = disable, 1 = enable, 2 = enable and enforce)
4 - block softlimit
5 - block hardlimit
6 - inode softlimit
7 - inode hardlimit
8(optional) - block size, defaults to 1024
The script should output at least one line of data on success. And nothing on failure.
Default: set quota command =
+
+
Example: set quota command = /usr/local/sbin/set_quota
+
+
This enables or disables the honoring of
+ the share modes during a file open. These
+ modes are used by clients to gain exclusive read or write access
+ to a file.
These open modes are not directly supported by UNIX, so + they are simulated using shared memory, or lock files if your + UNIX doesn't support shared memory (almost all do).
The share modes that are enabled by this option are
+ DENY_DOS, DENY_ALL,
+ DENY_READ, DENY_WRITE,
+ DENY_NONE and DENY_FCB.
+
This option gives full share compatibility and enabled + by default.
You should NEVER turn this parameter + off as many Windows applications will break if you do so.
Default: share modes = yes
+
+
This boolean parameter 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 lowered.
See the section on NAME MANGLING.
Default: short preserve case = yes
+
+
With the introduction of MS-RPC based printing support + for Windows NT/2000 client in Samba 2.2, a "Printers..." folder will + appear on Samba hosts in the share listing. Normally this folder will + contain an icon for the MS Add Printer Wizard (APW). However, it is + possible to disable this feature regardless of the level of privilege + of the connected user.
Under normal circumstances, the Windows NT/2000 client will
+ open a handle on the printer server with OpenPrinterEx() asking for
+ Administrator privileges. If the user does not have administrative
+ access on the print server (i.e is not root or a member of the
+ printer admin group), the OpenPrinterEx()
+ call fails and the client makes another open call with a request for
+ a lower privilege level. This should succeed, however the APW
+ icon will not be displayed.
Disabling the show add printer wizard
+ parameter will always cause the OpenPrinterEx() on the server
+ to fail. Thus the APW icon will never be displayed.
+
This does not prevent the same user from having + administrative privilege on an individual printer.
Default: show add printer wizard = yes
+
+
This a full path name to a script called by + smbd(8) that should + start a shutdown procedure.
If the connected user posseses the SeRemoteShutdownPrivilege,
+ right, this command will be run as user.
The %z %t %r %f variables are expanded as follows:
%z will be substituted with the
+ shutdown message sent to the server.
%t will be substituted with the
+ number of seconds to wait before effectively starting the
+ shutdown procedure.
%r will be substituted with the
+ switch -r. It means reboot after shutdown
+ for NT.
%f will be substituted with the
+ switch -f. It means force the shutdown
+ even if applications do not respond for NT.
Shutdown script example: +
+#!/bin/bash + +$time=0 +let "time/60" +let "time++" + +/sbin/shutdown $3 $4 +$time $1 & +
+Shutdown does not return so we need to launch it in background. +
Default: shutdown script =
+
+
Example: shutdown script = /usr/local/samba/sbin/shutdown %m %t %r %f
+
+
This option sets the path to the encrypted smbpasswd file. By + default the path to the smbpasswd file is compiled into Samba.
+ An example of use is: +
+smb passwd file = /etc/samba/smbpasswd +
+
Default: smb passwd file = ${prefix}/private/smbpasswd
+
+
Specifies which ports the server should listen on for SMB traffic.
Default: smb ports = 445 139
+
+
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.
Default: socket address =
+
+
Example: socket address = 192.168.2.20
+
+
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
+
+
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
+
+
If this parameter is set Samba no longer attempts to + map DOS attributes like SYSTEM, HIDDEN, ARCHIVE or READ-ONLY + to UNIX permission bits (such as the map hidden. Instead, DOS attributes will be stored onto an extended + attribute in the UNIX filesystem, associated with the file or directory. + For this to operate correctly, the parameters map hidden, map system, map archive must be set to off. + This parameter writes the DOS attributes as a string into the + extended attribute named "user.DOSATTRIB". This extended attribute + is explicitly hidden from smbd clients requesting an EA list. + On Linux the filesystem must have been mounted with the mount + option user_xattr in order for extended attributes to work, also + extended attributes must be compiled into the Linux kernel. +
Default: store dos attributes = no
+
+
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
+
+
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 acceptable.
Default: strict locking = yes
+
+
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.
Default: strict sync = no
+
+
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.
Default: sync always = no
+
+
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
+
+
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
+
+
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
+
+
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.
No default
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
+
+
This parameter determines if nmbd(8) advertises itself as a time server to Windows +clients.
Default: time server = no
+
+
Specifies the charset the unix machine + Samba runs on uses. Samba needs to know this in order to be able to + convert text to the charsets other SMB clients use. +
This is also the charset Samba will use when specifying arguments + to scripts that it invokes. +
Default: unix charset = UTF8
+
+
Example: unix charset = ASCII
+
+
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
+
+
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).
Default: unix password sync = no
+
+
+ This boolean parameter allows a user logging on with a plaintext password to have their encrypted (hashed)
+ password in the smbpasswd file to be updated automatically as they log on. This option allows a site to
+ migrate from plaintext password authentication (users authenticate with plaintext password over the
+ wire, and are checked against a UNIX account atabase) to encrypted password authentication (the SMB
+ challenge/response authentication mechanism) without forcing all users to re-enter their passwords via
+ smbpasswd at the time the change is made. This is a convenience option to allow the change over to encrypted
+ passwords to be made over a longer period. Once all users have encrypted representations of their passwords
+ in the smbpasswd file this parameter should be set to no.
+
+ In order for this parameter to be operative the encrypt passwords parameter must
+ be set to no. The default value of encrypt passwords = Yes. Note: This must be set to no for this update encrypted to work.
+
+ Note that even when this parameter is set a user authenticating to smbd + must still enter a valid password in order to connect correctly, and to update their hashed (smbpasswd) + passwords. +
Default: update encrypted = no
+
+
This parameter applies only to Windows NT/2000 + clients. It has no effect on Windows 95/98/ME clients. When + serving a printer to Windows NT/2000 clients without first installing + a valid printer driver on the Samba host, the client will be required + to install a local printer driver. From this point on, the client + will treat the print as a local printer and not a network printer + connection. This is much the same behavior that will occur + when disable spoolss = yes. +
The differentiating factor is that under normal + circumstances, the NT/2000 client will attempt to open the network + printer using MS-RPC. The problem is that because the client + considers the printer to be local, it will attempt to issue the + OpenPrinterEx() call requesting access rights associated with the + logged on user. If the user possesses local administator rights but + not root privilege on the Samba host (often the case), the + OpenPrinterEx() call will fail. The result is that the client will + now display an "Access Denied; Unable to connect" message + in the printer queue window (even though jobs may successfully be + printed).
If this parameter is enabled for a printer, then any attempt + to open the printer with the PRINTER_ACCESS_ADMINISTER right is mapped + to PRINTER_ACCESS_USE instead. Thus allowing the OpenPrinterEx() + call to succeed. This parameter MUST not be able enabled + on a print share which has valid print driver installed on the Samba + server.
Default: use client driver = no
+
+
+Specifies whether Samba should attempt to maintain service principals in the systems
+keytab file for host/FQDN and cifs/FQDN.
+
When you are using the heimdal Kerberos libraries, you must also
+specify the following in /etc/krb5.conf:
+[libdefaults] + default_keytab_name = FILE:/etc/krb5.keytab +
Default: use kerberos keytab = False
+
+
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
+
+
This parameter is a synonym for username.
This parameter is a synonym for username.
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 valid users parameter.
If any of the usernames begin with a '@' then the name + will be looked up first in the NIS netgroups list (if Samba + is compiled with netgroup support), followed by a lookup in + the UNIX groups database and will expand to a list of all users + in the group of that name.
If any of the usernames begin with a '+' then the name + will be looked up only in the UNIX groups database and will + expand to a list of all users in the group of that name.
If any of the usernames begin with a '&' then the name + will be looked up only in the NIS netgroups database (if Samba + is compiled with netgroup support) and will expand to a list + of all users in the netgroup group of that name.
Note that searching though a groups database can take + quite some time, and some clients may time out during the + search.
See the section NOTE ABOUT + USERNAME/PASSWORD VALIDATION for more information on how + this parameter determines access to the services.
Default: username =
+# The guest account if a guest service,
+ else <empty string>.
+
+
Example: username = fred, mary, jack, jane, @users, @pcgroup
+
+
This option helps Samba to try and 'guess' at + the real UNIX username, as many DOS clients send an all-uppercase + username. By default Samba tries all lowercase, followed by the + username with the first letter capitalized, and fails if the + username is not found on the UNIX machine.
If this parameter is set to non-zero the behavior changes.
+ This parameter is a number that specifies the number of uppercase
+ combinations to try while trying to determine the UNIX user name. The
+ higher the number the more combinations will be tried, but the slower
+ the discovery of usernames will be. Use this parameter when you have
+ strange usernames on your UNIX machine, such as AstrangeUser
+ .
This parameter is needed only on UNIX systems that have case + sensitive usernames.
Default: username level = 0
+
+
Example: username level = 5
+
+
This option allows you to specify a file containing + a mapping of usernames from the clients to the server. This can be + used for several purposes. The most common is to map usernames + that users use on DOS or Windows machines to those that the UNIX + box uses. The other is to map multiple users to a single username + so that they can more easily share files.
Please note that for user or share mode security, the + username map is applied prior to validating the user credentials. + Domain member servers (domain or ads) apply the username map + after the user has been successfully authenticated by the domain + controller and require fully qualified enties in the map table + (e.g. biddle = DOMAIN\foo).
The map file is parsed line by line. Each line should + contain a single UNIX username on the left then a '=' followed + by a list of usernames on the right. The list of usernames on the + right may contain names of the form @group in which case they + will match any UNIX username in that group. The special client + name '*' is a wildcard and matches any name. Each line of the + map file may be up to 1023 characters long.
The file is processed on each line by taking the + supplied username and comparing it with each username on the right + hand side of the '=' signs. If the supplied name matches any of + the names on the right hand side then it is replaced with the name + on the left. Processing then continues with the next line.
If any line begins with a '#' or a ';' then it is ignored
If any line begins with an '!' then the processing + will stop after that line if a mapping was done by the line. + Otherwise mapping continues with every line being processed. + Using '!' is most useful when you have a wildcard mapping line + later in the file.
For example to map from the name admin
+ or administrator to the UNIX name
+ root you would use:
root = admin administrator
Or to map anyone in the UNIX group system
+ to the UNIX name sys you would use:
sys = @system
You can have as many mappings as you like in a username map file.
If your system supports the NIS NETGROUP option then
+ the netgroup database is checked before the /etc/group
+ database for matching groups.
You can map Windows usernames that have spaces in them + by using double quotes around the name. For example:
tridge = "Andrew Tridgell"
would map the windows username "Andrew Tridgell" to the + unix username "tridge".
The following example would map mary and fred to the + unix user sys, and map the rest to guest. Note the use of the + '!' to tell Samba to stop processing if it gets a match on + that line.
+!sys = mary fred +guest = * +
Note that the remapping is applied to all occurrences
+ of usernames. Thus if you connect to \\server\fred and
+ fred is remapped to mary then you
+ will actually be connecting to \\server\mary and will need to
+ supply a password suitable for mary not
+ fred. The only exception to this is the
+ username passed to the password server (if you have one). The password
+ server will receive whatever username the client supplies without
+ modification.
Also note that no reverse mapping is done. The main effect + this has is with printing. Users who have been mapped may have + trouble deleting print jobs as PrintManager under WfWg will think + they don't own the print job.
+ Samba versions prior to 3.0.8 would only support reading the fully qualified + username (e.g.: DOMAIN\user) from the username map when performing a + kerberos login from a client. However, when looking up a map + entry for a user authenticated by NTLM[SSP], only the login name would be + used for matches. This resulted in inconsistent behavior sometimes + even on the same server. +
+ The following functionality is obeyed in version 3.0.8 and later: +
+ When performing local authentication, the username map is + applied to the login name before attempting to authenticate + the connection. +
+ When relying upon a external domain controller for validating + authentication requests, smbd will apply the username map + to the fully qualified username (i.e. DOMAIN\user) only + after the user has been successfully authenticated. +
+ An example of use is: +
+username map = /usr/local/samba/lib/users.map +
+
Default: username map =
+# no username map
+
+
This script is a mutually exclusive alternative to the + username map parameter. This parameter + specifies and external program or script that must accept a single + command line option (the username transmitted in the authentication + request) and return a line line on standard output (the name to which + the account should mapped). In this way, it is possible to store + username map tables in an LDAP or NIS directory services. +
Default: username map script =
+
+
Example: username map script = /etc/samba/scripts/mapusers.sh
+
+
If this parameter is yes, and the sendfile() system call is supported by the underlying operating system, 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. Samba automatically turns this off for clients
+ that use protocol levels lower than NT LM 0.12 and when it detects a client is
+ Windows 9x (using sendfile from Linux will cause these clients to fail).
+
Default: use sendfile = yes
+
+
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
+
+
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.
Default: utmp = no
+
+
This parameter is only available if Samba has
+ been configured and compiled with the option
+ --with-utmp. It specifies a directory pathname that is
+ used to store the utmp or utmpx files (depending on the UNIX system) that
+ record user connections to a Samba server. By default this is
+ not set, meaning the system will use whatever utmp file the
+ native system is set to use (usually
+ /var/run/utmp on Linux).
Default: utmp directory =
+# Determined automatically
+
+
Example: utmp directory = /var/run/utmp
+
+
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: -valid = yes
+
+
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.
Default: valid users =
+# No valid users list (anyone can login)
+
+
Example: valid users = greg, @pcusers
+
+
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.
+ Examples of use include: +
+; Veto any files containing the word Security, +; any ending in .tmp, and any directory containing the +; word root. +veto files = /*Security*/*.tmp/*root*/ + +; Veto the Apple specific files that a NetAtalk server +; creates. +veto files = /.AppleDouble/.bin/.AppleDesktop/Network Trash Folder/ +
+
Default: veto files = No files or directories are vetoed.
+
+
This parameter is only valid when the + oplocks + 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 + veto files + parameter.
You might want to do this on files that you know will
+ be heavily contended for by clients. A good example of this
+ is in the NetBench SMB benchmark program, which causes heavy
+ client contention for files ending in .SEM.
+ To cause Samba not to grant oplocks on these files you would use
+ the line (either in the [global] section or in the section for
+ the particular NetBench share :
+ An example of use is: +
+veto oplock files = /.*SEM/ +
+
Default: veto oplock files =
+# No files are vetoed for oplock grants
+
+
This parameter is a synonym for vfs objects.
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: vfs objects =
+
+
Example: vfs objects = extd_audit recycle
+
+
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: volume =
+# the name of the share
+
+
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
+
+
This parameter specifies the number of + seconds the winbindd(8) daemon will cache + user and group information before querying a Windows NT server + again.
This does not apply to authentication requests, + these are always evaluated in real time.
Default: winbind cache time = 300
+
+
On large installations using winbindd(8) it may be necessary to suppress
+ the enumeration of groups through the setgrent(),
+ getgrent() and
+ endgrent() group of system calls. If
+ the winbind enum groups parameter is
+ no, calls to the getgrent() system
+ call will not return any data.
Turning off group enumeration may cause some programs to behave oddly.
Default: winbind enum groups = yes
+
+
On large installations using winbindd(8) it may be
+ necessary to suppress the enumeration of users through the setpwent(),
+ getpwent() and
+ endpwent() group of system calls. If
+ the winbind enum users parameter is
+ no, calls to the getpwent system call
+ will not return any data.
Turning off user + enumeration may cause some programs to behave oddly. For + example, the finger program relies on having access to the + full user list when searching for matching + usernames.
Default: winbind enum users = yes
+
+
If set to yes, this parameter activates the support for nested + groups. Nested groups are also called local groups or + aliases. They work like their counterparts in Windows: Nested + groups are defined locally on any machine (they are shared + between DC's through their SAM) and can contain users and + global groups from any trusted SAM. To be able to use nested + groups, you need to run nss_winbind.
Please note that per 3.0.3 this is a new feature, so + handle with care.
Default: winbind nested groups = no
+
+
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 = +
+
+
This parameter is designed to allow Samba servers that + are members of a Samba controlled domain to use UNIX accounts + distributed via NIS, rsync, or LDAP as the uid's for winbindd users + in the hosts primary domain. Therefore, the user DOMAIN\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
+
+
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
+
+
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.
No default
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
+
+
This specifies the IP address (or DNS name: IP + address for preference) of the WINS server that nmbd(8) should register with. If you have a WINS server on + your network then you should set this to the WINS server's IP.
You should point this at your WINS server if you have a + multi-subnetted network.
If you want to work in multiple namespaces, you can + give every wins server a 'tag'. For each tag, only one + (working) server will be queried for a name. The tag should be + separated from the ip address by a colon. +
You need to set up Samba to point + to a WINS server if you have multiple subnets and wish cross-subnet + browsing to work correctly.
See the ???.
Default: wins server =
+
+
Example: wins server = mary:192.9.200.1 fred:192.168.3.199 mary:192.168.2.61
+
+# For this example when querying a certain name, 192.19.200.1 will
+ be asked first and if that doesn't respond 192.168.2.61. If either
+ of those doesn't know the name 192.168.3.199 will be queried.
+
+
Example: wins server = 192.9.200.1 192.168.2.61
+
+
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
+
+
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 security = domain + setting.
Default: workgroup = WORKGROUP
+
+
Example: workgroup = MYGROUP
+
+
This parameter is a synonym for writeable.
Inverted synonym for read only.
No default
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
+
+
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 read only + 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.
This parameter will not work with the security = share in + Samba 3.0. This is by design.
Default: write list =
+
+
Example: write list = admin, root, @staff
+
+
This parameter controls whether or not the server + will support raw write SMB's when transferring data from clients. + You should never need to change this parameter.
Default: write raw = yes
+
+
This parameter is only available if Samba has + been configured and compiled with the option + --with-utmp. It specifies a directory pathname that is + used to store the wtmp or wtmpx files (depending on the UNIX system) that + record user connections to a Samba server. The difference with + the utmp directory is the fact that user info is kept after a user + has logged out.
+ By default this is
+ not set, meaning the system will use whatever utmp file the
+ native system is set to use (usually
+ /var/run/wtmp on Linux).
Default: wtmp directory =
+
+
Example: wtmp directory = /var/log/wtmp
+
+
+ Although the configuration file permits service names to contain spaces, your client software may not. + Spaces will be ignored in comparisons anyway, so it shouldn't be a problem - but be aware of the possibility. +
+ On a similar note, many clients - especially DOS clients - limit service names to eight characters. + smbd(8) has no such + limitation, but attempts to connect from such clients will fail if they truncate the service names. For this + reason you should probably keep your service names down to eight characters in length. +
+ Use of the [homes] and [printers] special sections make life
+ for an administrator easy, but the various combinations of default attributes can be tricky. Take extreme
+ care when designing these sections. In particular, ensure that the permissions on spool directories are
+ correct.
+
+ samba(7), smbpasswd(8), swat(8), smbd(8), nmbd(8), smbclient(1), nmblookup(1), testparm(1), testprns(1).
+ The original Samba software and related utilities were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar to the way the Linux kernel is developed. +
+ The original Samba man pages were written by Karl Auer. The man page sources were converted to YODL format (another + excellent piece of Open Source software, available at + ftp://ftp.icce.rug.nl/pub/unix/) and updated for the Samba 2.0 release by Jeremy Allison. The conversion + to DocBook for Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0 was done by + Alexander Bokovoy. +
smbcontrol — send messages to smbd, nmbd or winbindd processes
smbcontrol [-i] [-s]
smbcontrol [destination] [message-type] [parameter]
This tool is part of the samba(7) suite.
smbcontrol is a very small program, which + sends messages to a smbd(8), a nmbd(8), or a winbindd(8) daemon running on the system.
Print a summary of command line options. +
The file specified contains the
+configuration details required by the server. The
+information in this file includes server-specific
+information such as what printcap file to use, as well
+as descriptions of all the services that the server is
+to provide. See smb.conf for more information.
+The default configuration file name is determined at
+compile time.
Run interactively. Individual commands + of the form destination message-type parameters can be entered + on STDIN. An empty command line or a "q" will quit the + program.
One of nmbd, smbd or a process ID.
The smbd destination causes the
+ message to "broadcast" to all smbd daemons.
The nmbd destination causes the
+ message to be sent to the nmbd daemon specified in the
+ nmbd.pid file.
If a single process ID is given, the message is sent + to only that process.
Type of message to send. See
+ the section MESSAGE-TYPES for details.
+
any parameters required for the message-type
Available message types are:
Order smbd to close the client
+ connections to the named share. Note that this doesn't affect client
+ connections to any other shares. This message-type takes an argument of the
+ share name for which client connections will be closed, or the
+ "*" character which will close all currently open shares.
+ This may be useful if you made changes to the access controls on the share.
+ This message can only be sent to smbd.
Set debug level to the value specified by the + parameter. This can be sent to any of the destinations.
This message causes the nmbd daemon to + force a new browse master election.
+ Send specified number of "ping" messages and + wait for the same number of reply "pong" messages. This can be sent to + any of the destinations.
Change profile settings of a daemon, based on the + parameter. The parameter can be "on" to turn on profile stats + collection, "off" to turn off profile stats collection, "count" + to enable only collection of count stats (time stats are + disabled), and "flush" to zero the current profile stats. This can + be sent to any smbd or nmbd destinations.
+ Request debuglevel of a certain daemon and write it to stdout. This + can be sent to any of the destinations.
+ Request profilelevel of a certain daemon and write it to stdout. + This can be sent to any smbd or nmbd destinations.
+ Order smbd to send a printer notify message to any Windows NT clients + connected to a printer. This message-type takes the following arguments: +
Send a queue pause change notify + message to the printer specified.
Send a queue resume change notify + message for the printer specified.
Send a job pause change notify + message for the printer and unix jobid + specified.
Send a job resume change notify + message for the printer and unix jobid + specified.
Send a job delete change notify + message for the printer and unix jobid + specified.
+ Note that this message only sends notification that an + event has occured. It doesn't actually cause the + event to happen. +
This message can only be sent to smbd.
Order smbd to synchronise sam database from PDC (being BDC). Can only be sent to smbd.
Not working at the moment
Send sam replication message, with specified serial. Can only be sent to smbd. Should not be used manually.
Set a mark for dmalloc. Can be sent to both smbd and nmbd. Only available if samba is built with dmalloc support.
+ Dump the pointers that have changed since the mark set by dmalloc-mark. + Can be sent to both smbd and nmbd. Only available if samba is built with dmalloc support.
Shut down specified daemon. Can be sent to both smbd and nmbd.
Print a human-readable description of all + talloc(pool) memory usage by the specified daemon/process. Available + for both smbd and nmbd.
Force clients of printers using specified driver + to update their local version of the driver. Can only be + sent to smbd.
Force daemon to reload smb.conf configuration file. Can be sent
+ to smbd, nmbd, or winbindd.
+
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.
smbcquotas — Set or get QUOTAs of NTFS 5 shares
smbcquotas {//server/share} [-u user] [-L] [-F] [-S QUOTA_SET_COMMAND] [-n] [-t] [-v] [-d debuglevel] [-s configfile] [-l logdir] [-V] [-U username] [-N] [-k] [-A]
This tool is part of the samba(7) suite.
The smbcquotas program manipulates NT Quotas on SMB file shares.
The following options are available to the smbcquotas program.
Specifies the user of whom the quotas are get or set. + By default the current user's username will be used.
Lists all quota records of the share.
Show the share quota status and default limits.
This command sets/modifies quotas for a user or on the share, + depending on the QUOTA_SET_COMMAND parameter which is described later.
This option displays all QUOTA information in numeric + format. The default is to convert SIDs to names and QUOTA limits + to a readable string format.
+ Don't actually do anything, only validate the correctness of the arguments. +
+ Be verbose. +
Print a summary of command line options. +
Prints the program version number. +
The file specified contains the
+configuration details required by the server. The
+information in this file includes server-specific
+information such as what printcap file to use, as well
+as descriptions of all the services that the server is
+to provide. See smb.conf for more information.
+The default configuration file name is determined at
+compile time.
debuglevel is an integer
+from 0 to 10. The default value if this parameter is
+not specified is zero.
The higher this value, the more detail will be +logged to the log files about the activities of the +server. At level 0, only critical errors and serious +warnings will be logged. Level 1 is a reasonable level for +day-to-day running - it generates a small amount of +information about operations carried out.
Levels above 1 will generate considerable +amounts of log data, and should only be used when +investigating a problem. Levels above 3 are designed for +use only by developers and generate HUGE amounts of log +data, most of which is extremely cryptic.
Note that specifying this parameter here will
+override the parameter
+in the smb.conf file.
Base directory name for log/debug files. The extension
+".progname" will be appended (e.g. log.smbclient,
+log.smbd, etc...). The log file is never removed by the client.
+
If specified, this parameter suppresses the normal +password prompt from the client to the user. This is useful when +accessing a service that does not require a password.
Unless a password is specified on the command line or +this parameter is specified, the client will request a +password.
+Try to authenticate with kerberos. Only useful in +an Active Directory environment. +
This option allows +you to specify a file from which to read the username and +password used in the connection. The format of the file is +
+username = <value> +password = <value> +domain = <value> +
Make certain that the permissions on the file restrict +access from unwanted users.
Sets the SMB username or username and password.
If %password is not specified, the user will be prompted. The
+client will first check the USER environment variable, then the
+LOGNAME variable and if either exists, the
+string is uppercased. If these environmental variables are not
+found, the username GUEST is used.
A third option is to use a credentials file which
+contains the plaintext of the username and password. This
+option is mainly provided for scripts where the admin does not
+wish to pass the credentials on the command line or via environment
+variables. If this method is used, make certain that the permissions
+on the file restrict access from unwanted users. See the
+-A for more details.
Be cautious about including passwords in scripts. Also, on +many systems the command line of a running process may be seen +via the ps command. To be safe always allow +rpcclient to prompt for a password and type +it in directly.
The format of an ACL is one or more ACL entries separated by + either commas or newlines. An ACL entry is one of the following:
+ for setting user quotas for the user specified by -u or the current username: +
+ UQLIM:<username>:<softlimit>/<hardlimit>
+
+ for setting the default quotas for a share: +
+ FSQLIM:<softlimit>/<hardlimit>
+
+ for changing the share quota settings: +
+ FSQFLAGS:QUOTA_ENABLED/DENY_DISK/LOG_SOFTLIMIT/LOG_HARD_LIMIT
+
The smbcquotas program sets the exit status + depending on the success or otherwise of the operations performed. + The exit status may be one of the following values.
If the operation succeeded, smbcquotas returns an exit + status of 0. If smbcquotas couldn't connect to the specified server, + or when there was an error getting or setting the quota(s), an exit status + of 1 is returned. If there was an error parsing any command line + arguments, an exit status of 2 is returned.
smbd — server to provide SMB/CIFS services to clients
smbd [-D] [-F] [-S] [-i] [-h] [-V] [-b] [-d <debug level>] [-l <log directory>] [-p <port number(s)>] [-O <socket option>] [-s <configuration file>]
This program is part of the samba(7) suite.
smbd is the server daemon that + provides filesharing and printing services to Windows clients. + The server provides filespace and printer services to + clients using the SMB (or CIFS) protocol. This is compatible + with the LanManager protocol, and can service LanManager + clients. These include MSCLIENT 3.0 for DOS, Windows for + Workgroups, Windows 95/98/ME, Windows NT, Windows 2000, + OS/2, DAVE for Macintosh, and smbfs for Linux.
An extensive description of the services that the + server can provide is given in the man page for the + configuration file controlling the attributes of those + services (see smb.conf(5). This man page will not describe the + services, but will concentrate on the administrative aspects + of running the server.
Please note that there are significant security + implications to running this server, and the smb.conf(5) manual page should be regarded as mandatory reading before + proceeding with installation.
A session is created whenever a client requests one. + Each client gets a copy of the server for each session. This + copy then services all connections made by the client during + that session. When all connections from its client are closed, + the copy of the server for that client terminates.
The configuration file, and any files that it includes, + are automatically reloaded every minute, if they change. You + can force a reload by sending a SIGHUP to the server. Reloading + the configuration file will not affect connections to any service + that is already established. Either the user will have to + disconnect from the service, or smbd killed and restarted.
If specified, this parameter causes + the server to operate as a daemon. That is, it detaches + itself and runs in the background, fielding requests + on the appropriate port. Operating the server as a + daemon is the recommended way of running smbd for + servers that provide more than casual use file and + print services. This switch is assumed if smbd + is executed on the command line of a shell. +
If specified, this parameter causes + the main smbd process to not daemonize, + i.e. double-fork and disassociate with the terminal. + Child processes are still created as normal to service + each connection request, but the main process does not + exit. This operation mode is suitable for running + smbd under process supervisors such + as supervise and svscan + from Daniel J. Bernstein's daemontools + package, or the AIX process monitor. +
If specified, this parameter causes + smbd to log to standard output rather + than a file.
If this parameter is specified it causes the + server to run "interactively", not as a daemon, even if the + server is executed on the command line of a shell. Setting this + parameter negates the implicit deamon mode when run from the + command line. smbd also logs to standard + output, as if the -S parameter had been + given. +
Prints the program version number. +
The file specified contains the
+configuration details required by the server. The
+information in this file includes server-specific
+information such as what printcap file to use, as well
+as descriptions of all the services that the server is
+to provide. See smb.conf for more information.
+The default configuration file name is determined at
+compile time.
debuglevel is an integer
+from 0 to 10. The default value if this parameter is
+not specified is zero.
The higher this value, the more detail will be +logged to the log files about the activities of the +server. At level 0, only critical errors and serious +warnings will be logged. Level 1 is a reasonable level for +day-to-day running - it generates a small amount of +information about operations carried out.
Levels above 1 will generate considerable +amounts of log data, and should only be used when +investigating a problem. Levels above 3 are designed for +use only by developers and generate HUGE amounts of log +data, most of which is extremely cryptic.
Note that specifying this parameter here will
+override the parameter
+in the smb.conf file.
Base directory name for log/debug files. The extension
+".progname" will be appended (e.g. log.smbclient,
+log.smbd, etc...). The log file is never removed by the client.
+
Print a summary of command line options. +
Prints information about how + Samba was built.
port number(s) is a
+ space or comma-separated list of TCP ports smbd should listen on.
+ The default value is taken from the ports parameter in smb.conf
The default ports are 139 (used for SMB over NetBIOS over TCP) + and port 445 (used for plain SMB over TCP). +
/etc/inetd.confIf the server is to be run by the + inetd meta-daemon, this file + must contain suitable startup information for the + meta-daemon. +
/etc/rcor whatever initialization script your + system uses).
If running the server as a daemon at startup, + this file will need to contain an appropriate startup + sequence for the server.
/etc/servicesIf running the server via the + meta-daemon inetd, this file + must contain a mapping of service name (e.g., netbios-ssn) + to service port (e.g., 139) and protocol type (e.g., tcp). +
/usr/local/samba/lib/smb.confThis is the default location of the smb.conf(5) server configuration file. Other common places that systems
+ install this file are /usr/samba/lib/smb.conf
+ and /etc/samba/smb.conf.
This file describes all the services the server + is to make available to clients. See smb.conf(5) for more information.
On some systems smbd cannot change uid back + to root after a setuid() call. Such systems are called + trapdoor uid systems. If you have such a system, + you will be unable to connect from a client (such as a PC) as + two different users at once. Attempts to connect the + second user will result in access denied or + similar.
PRINTERIf no printer name is specified to
+ printable services, most systems will use the value of
+ this variable (or lp if this variable is
+ not defined) as the name of the printer to use. This
+ is not specific to the server, however.
Samba uses PAM for authentication (when presented with a plaintext + password), for account checking (is this account disabled?) and for + session management. The degree too which samba supports PAM is restricted + by the limitations of the SMB protocol and the obey pam restrictions smb.conf(5) paramater. When this is set, the following restrictions apply: +
Account Validation: All accesses to a + samba server are checked + against PAM to see if the account is vaild, not disabled and is permitted to + login at this time. This also applies to encrypted logins. +
Session Management: When not using share + level secuirty, users must pass PAM's session checks before access + is granted. Note however, that this is bypassed in share level secuirty. + Note also that some older pam configuration files may need a line + added for session support. +
Most diagnostics issued by the server are logged + in a specified log file. The log file name is specified + at compile time, but may be overridden on the command line.
The number and nature of diagnostics available depends + on the debug level used by the server. If you have problems, set + the debug level to 3 and peruse the log files.
Most messages are reasonably self-explanatory. Unfortunately, + at the time this man page was created, there are too many diagnostics + available in the source code to warrant describing each and every + diagnostic. At this stage your best bet is still to grep the + source code and inspect the conditions that gave rise to the + diagnostics you are seeing.
Samba stores it's data in several TDB (Trivial Database) files, usually located in /var/lib/samba.
+ (*) information persistent across restarts (but not + necessarily important to backup). +
NT account policy settings such as pw expiration, etc...
byte range locks
browse lists
share connections (used to enforce max connections, etc...)
generic caching db
group mapping information
share modes & oplocks
bad pw attempts
Samba messaging system
cache of user net_info_3 struct from net_samlogon() request (as a domain member)
installed printer drivers
installed printer forms
installed printer information
directory containing tdb per print queue of cached lpq output
Windows registry skeleton (connect via regedit.exe)
session information (e.g. support for 'utmp = yes')
share acls
winbindd's cache of user lists, etc...
winbindd's local idmap db
wins database when 'wins support = yes'
Sending the smbd a SIGHUP will cause it to
+ reload its smb.conf configuration
+ file within a short period of time.
To shut down a user's smbd process it is recommended + that SIGKILL (-9) NOT + be used, except as a last resort, as this may leave the shared + memory area in an inconsistent state. The safe way to terminate + an smbd is to send it a SIGTERM (-15) signal and wait for + it to die on its own.
The debug log level of smbd may be raised + or lowered using smbcontrol(1) program (SIGUSR[1|2] signals are no longer + used since Samba 2.2). This is to allow transient problems to be diagnosed, + whilst still running at a normally low log level.
Note that as the signal handlers send a debug write, + they are not re-entrant in smbd. This you should wait until + smbd is in a state of waiting for an incoming SMB before + issuing them. It is possible to make the signal handlers safe + by un-blocking the signals before the select call and re-blocking + them after, however this would affect performance.
hosts_access(5), inetd(8), nmbd(8), smb.conf(5), smbclient(1), testparm(1), testprns(1), and the
+ Internet RFC's rfc1001.txt, rfc1002.txt.
+ In addition the CIFS (formerly SMB) specification is available
+ as a link from the Web page
+ http://samba.org/cifs/.
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.
smbget — wget-like utility for download files over SMB
smbget [-a, --guest] [-r, --resume] [-R, --recursive] [-u, --username=STRING] [-p, --password=STRING] [-w, --workgroup=STRING] [-n, --nonprompt] [-d, --debuglevel=INT] [-D, --dots] [-P, --keep-permissions] [-o, --outputfile] [-f, --rcfile] [-q, --quiet] [-v, --verbose] [-b, --blocksize] [-?, --help] [--usage] {smb://host/share/path/to/file} [smb://url2/] [...]
This tool is part of the samba(7) suite.
smbget is a simple utility with wget-like semantics, that can download files from SMB servers. You can specify the files you would like to download on the command-line. +
+ The files should be in the smb-URL standard, e.g. use smb://host/share/file + for the UNC path \\\\HOST\\SHARE\\file. +
Work as user guest
Automatically resume aborted files
Recursively download files
Username to use
Password to use
Workgroup to use (optional)
Don't ask anything (non-interactive)
Debuglevel to use
Show dots as progress indication
Set same permissions on local file as are set on remote file.
Write the file that is being download to the specified file. Can not be used together with -R.
Use specified rcfile. This will be loaded in the order it was specified - e.g. if you specify any options before this one, they might get overriden by the contents of the rcfile.
Be quiet
Be verbose
Number of bytes to download in a block. Defaults to 64000.
Show help message
Display brief usage message
SMB URL's should be specified in the following format:
+smb://[[[domain;]user[:password@]]server[/share[/path[/file]]]] +
+smb:// means all the workgroups +
+smb://name/ means, ifnameis a workgroup, all the servers in this workgroup, or ifnameis a server, all the shares on this server. +
+# Recursively download 'src' directory +smbget -R smb://rhonwyn/jelmer/src +# Download FreeBSD ISO and enable resuming +smbget -r smb://rhonwyn/isos/FreeBSD5.1.iso +# Recursively download all ISOs +smbget -Rr smb://rhonwyn/isos +# Backup my data on rhonwyn +smbget -Rr smb://rhonwyn/ +
smbgetrc — configuration file for smbget
smbgetrc
+ This manual page documents the format and options of the smbgetrc + file. This is the configuration file used by the smbget(1) + utility. The file contains of key-value pairs, one pair on each line. The key + and value should be separated by a space. +
By default, smbget reads its configuration from $HOME/.smbgetrc, though + other locations can be specified using the command-line options.
+ The following keys can be set: +
+ Whether aborted downloads should be automatically resumed. +
Whether directories should be downloaded recursively
nameUsername to use when logging in to the remote server. Use an empty string for anonymous access. +
passPassword to use when logging in.
wgWorkgroup to use when logging in
Turns off asking for username and password. Useful for scripts.
int(Samba) debuglevel to run at. Useful for tracking down protocol level problems.
Whether a single dot should be printed for each block that has been downloaded, instead of the default progress indicator.
intNumber of bytes to put in a block.
smbmnt — helper utility for mounting SMB filesystems
smbmnt {mount-point} [-s <share>] [-r] [-u <uid>] [-g <gid>] [-f <mask>] [-d <mask>] [-o <options>] [-h]
smbmnt is a helper application used + by the smbmount program to do the actual mounting of SMB shares. + smbmnt can be installed setuid root if you want + normal users to be able to mount their SMB shares.
A setuid smbmnt will only allow mounts on directories owned + by the user, and that the user has write permission on.
The smbmnt program is normally invoked + by smbmount(8). It should not be invoked directly by users.
smbmount searches the normal PATH for smbmnt. You must ensure + that the smbmnt version in your path matches the smbmount used.
mount the filesystem read-only +
specify the uid that the files will + be owned by
specify the gid that the files will be + owned by
specify the octal file mask applied +
specify the octal directory mask + applied
+ list of options that are passed as-is to smbfs, if this + command is run on a 2.4 or higher Linux kernel. +
Print a summary of command line options. +
Volker Lendecke, Andrew Tridgell, Michael H. Warfield + and others.
The current maintainer of smbfs and the userspace + tools smbmount, smbumount, + and smbmnt is Urban Widmark. + The SAMBA Mailing list + is the preferred place to ask questions regarding these programs. +
The conversion of this manpage for Samba 2.2 was performed + by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0 + was done by Alexander Bokovoy.
smbmount — mount an smbfs filesystem
smbmount {service} {mount-point} [-o options]
smbmount mounts a Linux SMB filesystem. It + is usually invoked as mount.smbfs by + the mount(8) command when using the + "-t smbfs" option. This command only works in Linux, and the kernel must + support the smbfs filesystem.
Options to smbmount are specified as a comma-separated + list of key=value pairs. It is possible to send options other + than those listed here, assuming that smbfs supports them. If + you get mount failures, check your kernel log for errors on + unknown options.
smbmount is a daemon. After mounting it keeps running until
+ the mounted smbfs is umounted. It will log things that happen
+ when in daemon mode using the "machine name" smbmount, so
+ typically this output will end up in log.smbmount. The
+ smbmount process may also be called mount.smbfs.
smbmount + calls smbmnt(8) to do the actual mount. You + must make sure that smbmnt is in the path so + that it can be found.
specifies the username to connect as. If
+ this is not given, then the environment variable
+ USER is used. This option can also take the
+ form "user%password" or "user/workgroup" or
+ "user/workgroup%password" to allow the password and workgroup
+ to be specified as part of the username.
specifies the SMB password. If this
+ option is not given then the environment variable
+ PASSWD is used. If it can find
+ no password smbmount will prompt
+ for a passeword, unless the guest option is
+ given.
+ Note that passwords which contain the argument delimiter + character (i.e. a comma ',') will failed to be parsed correctly + on the command line. However, the same password defined + in the PASSWD environment variable or a credentials file (see + below) will be read correctly. +
specifies a file that contains a username and/or password. +The format of the file is: +
+username = <value> +password = <value> +
This is preferred over having passwords in plaintext in a
+ shared file, such as /etc/fstab. Be sure to protect any
+ credentials file properly.
+
Use kerberos (Active Directory).
sets the source NetBIOS name. It defaults + to the local hostname.
sets the uid that will own all files on + the mounted filesystem. + It may be specified as either a username or a numeric uid. +
sets the gid that will own all files on + the mounted filesystem. + It may be specified as either a groupname or a numeric + gid.
sets the remote SMB port number. The default + is 445, fallback is 139.
sets the file mask. This determines the + permissions that remote files have in the local filesystem. + This is not a umask, but the actual permissions for the files. + The default is based on the current umask.
Sets the directory mask. This determines the + permissions that remote directories have in the local filesystem. + This is not a umask, but the actual permissions for the directories. + The default is based on the current umask.
Sets the debug level. This is useful for + tracking down SMB connection problems. A suggested value to + start with is 4. If set too high there will be a lot of + output, possibly hiding the useful output.
Sets the destination host or IP address. +
Sets the workgroup on the destination
Sets the TCP socket options. See the smb.conf(5) socket options option.
+
Sets the NetBIOS scope
Don't prompt for a password
mount read-only
mount read-write
+ sets the charset used by the Linux side for codepage + to charset translations (NLS). Argument should be the + name of a charset, like iso8859-1. (Note: only kernel + 2.4.0 or later) +
+ sets the codepage the server uses. See the iocharset + option. Example value cp850. (Note: only kernel 2.4.0 + or later) +
+ sets how long a directory listing is cached in milliseconds + (also affects visibility of file size and date + changes). A higher value means that changes on the + server take longer to be noticed but it can give + better performance on large directories, especially + over long distances. Default is 1000ms but something + like 10000ms (10 seconds) is probably more reasonable + in many cases. + (Note: only kernel 2.4.2 or later) +
The variable USER may contain the username of the
+ person using the client. This information is used only if the
+ protocol level is high enough to support session-level
+ passwords. The variable can be used to set both username and
+ password by using the format username%password.
The variable PASSWD may contain the password of the
+ person using the client. This information is used only if the
+ protocol level is high enough to support session-level
+ passwords.
The variable PASSWD_FILE may contain the pathname
+ of a file to read the password from. A single line of input is
+ read and used as the password.
Passwords and other options containing , can not be handled. + For passwords an alternative way of passing them is in a credentials + file or in the PASSWD environment.
The credentials file does not handle usernames or passwords with + leading space.
One smbfs bug is important enough to mention here, even if it + is a bit misplaced:
Mounts sometimes stop working. This is usually + caused by smbmount terminating. Since smbfs needs smbmount to + reconnect when the server disconnects, the mount will eventually go + dead. An umount/mount normally fixes this. At least 2 ways to + trigger this bug are known.
Note that the typical response to a bug report is suggestion + to try the latest version first. So please try doing that first, + and always include which versions you use of relevant software + when reporting bugs (minimum: samba, kernel, distribution)
Documentation/filesystems/smbfs.txt in the linux kernel + source tree may contain additional options and information.
FreeBSD also has a smbfs, but it is not related to smbmount
For Solaris, HP-UX and others you may want to look at smbsh(1) or at other solutions, such as + Sharity or perhaps replacing the SMB server with a NFS server.
Volker Lendecke, Andrew Tridgell, Michael H. Warfield + and others.
The current maintainer of smbfs and the userspace + tools smbmount, smbumount, + and smbmnt is Urban Widmark. + The SAMBA Mailing list + is the preferred place to ask questions regarding these programs. +
The conversion of this manpage for Samba 2.2 was performed + by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0 + was done by Alexander Bokovoy.
smbpasswd — The Samba encrypted password file
smbpasswd
This tool is part of the samba(7) suite.
smbpasswd is the Samba encrypted password file. It contains + the username, Unix user id and the SMB hashed passwords of the + user, as well as account flag information and the time the + password was last changed. This file format has been evolving with + Samba and has had several different formats in the past.
The format of the smbpasswd file used by Samba 2.2
+ is very similar to the familiar Unix passwd(5)
+ file. It is an ASCII file containing one line for each user. Each field
+ ithin each line is separated from the next by a colon. Any entry
+ beginning with '#' is ignored. The smbpasswd file contains the
+ following information for each user:
This is the user name. It must be a name that + already exists in the standard UNIX passwd file.
This is the UNIX uid. It must match the uid + field for the same user entry in the standard UNIX passwd file. + If this does not match then Samba will refuse to recognize + this smbpasswd file entry as being valid for a user. +
This is the LANMAN hash of the user's password,
+ encoded as 32 hex digits. The LANMAN hash is created by DES
+ encrypting a well known string with the user's password as the
+ DES key. This is the same password used by Windows 95/98 machines.
+ Note that this password hash is regarded as weak as it is
+ vulnerable to dictionary attacks and if two users choose the
+ same password this entry will be identical (i.e. the password
+ is not "salted" as the UNIX password is). If the user has a
+ null password this field will contain the characters "NO PASSWORD"
+ as the start of the hex string. If the hex string is equal to
+ 32 'X' characters then the user's account is marked as
+ disabled and the user will not be able to
+ log onto the Samba server.
WARNING !! Note that, due to + the challenge-response nature of the SMB/CIFS authentication + protocol, anyone with a knowledge of this password hash will + be able to impersonate the user on the network. For this + reason these hashes are known as plain text + equivalents and must NOT be made + available to anyone but the root user. To protect these passwords + the smbpasswd file is placed in a directory with read and + traverse access only to the root user and the smbpasswd file + itself must be set to be read/write only by root, with no + other access.
This is the Windows NT hash of the user's + password, encoded as 32 hex digits. The Windows NT hash is + created by taking the user's password as represented in + 16-bit, little-endian UNICODE and then applying the MD4 + (internet rfc1321) hashing algorithm to it.
This password hash is considered more secure than + the LANMAN Password Hash as it preserves the case of the + password and uses a much higher quality hashing algorithm. + However, it is still the case that if two users choose the same + password this entry will be identical (i.e. the password is + not "salted" as the UNIX password is).
WARNING !!. Note that, due to + the challenge-response nature of the SMB/CIFS authentication + protocol, anyone with a knowledge of this password hash will + be able to impersonate the user on the network. For this + reason these hashes are known as plain text + equivalents and must NOT be made + available to anyone but the root user. To protect these passwords + the smbpasswd file is placed in a directory with read and + traverse access only to the root user and the smbpasswd file + itself must be set to be read/write only by root, with no + other access.
This section contains flags that describe + the attributes of the users account. In the Samba 2.2 release + this field is bracketed by '[' and ']' characters and is always + 13 characters in length (including the '[' and ']' characters). + The contents of this field may be any of the following characters: +
U - This means + this is a "User" account, i.e. an ordinary user. Only User + and Workstation Trust accounts are currently supported + in the smbpasswd file.
N - This means the
+ account has no password (the passwords in the fields LANMAN
+ Password Hash and NT Password Hash are ignored). Note that this
+ will only allow users to log on with no password if the
+ null passwords parameter is set in the
+ smb.conf(5) config file.
D - This means the account + is disabled and no SMB/CIFS logins will be allowed for this user.
W - This means this account + is a "Workstation Trust" account. This kind of account is used + in the Samba PDC code stream to allow Windows NT Workstations + and Servers to join a Domain hosted by a Samba PDC.
Other flags may be added as the code is extended in future. + The rest of this field space is filled in with spaces.
This field consists of the time the account was + last modified. It consists of the characters 'LCT-' (standing for + "Last Change Time") followed by a numeric encoding of the UNIX time + in seconds since the epoch (1970) that the last change was made. +
All other colon separated fields are ignored at this time.
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.
smbpasswd — change a user's SMB password
smbpasswd [-a] [-x] [-d] [-e] [-D debuglevel] [-n] [-r <remote machine>] [-R <name resolve order>] [-m] [-U username[%password]] [-h] [-s] [-w pass] [-i] [-L] [username]
This tool is part of the samba(7) suite.
The smbpasswd program has several different + functions, depending on whether it is run by the root user + or not. When run as a normal user it allows the user to change + the password used for their SMB sessions on any machines that store + SMB passwords.
By default (when run with no arguments) it will attempt to + change the current user's SMB password on the local machine. This is + similar to the way the passwd(1) program works. + smbpasswd differs from how the passwd program works + however in that it is not setuid root but works in + a client-server mode and communicates with a + locally running smbd(8). As a consequence in order for this to + succeed the smbd daemon must be running on the local machine. On a + UNIX machine the encrypted SMB passwords are usually stored in + the smbpasswd(5) file.
When run by an ordinary user with no options, smbpasswd + will prompt them for their old SMB password and then ask them + for their new password twice, to ensure that the new password + was typed correctly. No passwords will be echoed on the screen + whilst being typed. If you have a blank SMB password (specified by + the string "NO PASSWORD" in the smbpasswd file) then just press + the <Enter> key when asked for your old password.
smbpasswd can also be used by a normal user to change their
+ SMB password on remote machines, such as Windows NT Primary Domain
+ Controllers. See the (-r) and -U options
+ below.
When run by root, smbpasswd allows new users to be added + and deleted in the smbpasswd file, as well as allows changes to + the attributes of the user in this file to be made. When run by root, + smbpasswd accesses the local smbpasswd file + directly, thus enabling changes to be made even if smbd is not + running.
This option specifies that the username
+ following should be added to the local smbpasswd file, with the
+ new password typed (type <Enter> for the old password). This
+ option is ignored if the username following already exists in
+ the smbpasswd file and it is treated like a regular change
+ password command. Note that the default passdb backends require
+ the user to already exist in the system password file (usually
+ /etc/passwd), else the request to add the
+ user will fail.
This option is only available when running smbpasswd + as root.
This option specifies that the username + following should be deleted from the local smbpasswd file. +
This option is only available when running smbpasswd as + root.
This option specifies that the username following
+ should be disabled in the local smbpasswd
+ file. This is done by writing a 'D' flag
+ into the account control space in the smbpasswd file. Once this
+ is done all attempts to authenticate via SMB using this username
+ will fail.
If the smbpasswd file is in the 'old' format (pre-Samba 2.0 + format) there is no space in the user's password entry to write + this information and the command will FAIL. See smbpasswd(5) for details on the 'old' and new password file formats. +
This option is only available when running smbpasswd as + root.
This option specifies that the username following
+ should be enabled in the local smbpasswd file,
+ if the account was previously disabled. If the account was not
+ disabled this option has no effect. Once the account is enabled then
+ the user will be able to authenticate via SMB once again.
If the smbpasswd file is in the 'old' format, then + smbpasswd will FAIL to enable the account. + See smbpasswd(5) for + details on the 'old' and new password file formats.
This option is only available when running smbpasswd as root. +
debuglevel is an integer
+ from 0 to 10. The default value if this parameter is not specified
+ is zero.
The higher this value, the more detail will be logged to the + log files about the activities of smbpasswd. At level 0, only + critical errors and serious warnings will be logged.
Levels above 1 will generate considerable amounts of log + data, and should only be used when investigating a problem. Levels + above 3 are designed for use only by developers and generate + HUGE amounts of log data, most of which is extremely cryptic. +
This option specifies that the username following + should have their password set to null (i.e. a blank password) in + the local smbpasswd file. This is done by writing the string "NO + PASSWORD" as the first part of the first password stored in the + smbpasswd file.
Note that to allow users to logon to a Samba server once
+ the password has been set to "NO PASSWORD" in the smbpasswd
+ file the administrator must set the following parameter in the [global]
+ section of the smb.conf file :
null passwords = yes
This option is only available when running smbpasswd as + root.
This option allows a user to specify what machine
+ they wish to change their password on. Without this parameter
+ smbpasswd defaults to the local host. The remote
+ machine name is the NetBIOS name of the SMB/CIFS
+ server to contact to attempt the password change. This name is
+ resolved into an IP address using the standard name resolution
+ mechanism in all programs of the Samba suite. See the -R
+ name resolve order parameter for details on changing
+ this resolving mechanism.
The username whose password is changed is that of the
+ current UNIX logged on user. See the -U username
+ parameter for details on changing the password for a different
+ username.
Note that if changing a Windows NT Domain password the + remote machine specified must be the Primary Domain Controller for + the domain (Backup Domain Controllers only have a read-only + copy of the user account database and will not allow the password + change).
Note that Windows 95/98 do not have + a real password database so it is not possible to change passwords + specifying a Win95/98 machine as remote machine target.
This option allows the user of smbpasswd to determine + what name resolution services to use when looking up the NetBIOS + name of the host being connected to.
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 only used if the NetBIOS name
+ type being queried is the 0x20 (server) name type, otherwise
+ it is ignored.
wins: Query a name with
+ the IP address listed in the wins server
+ parameter. If no WINS server has been specified this method
+ will be ignored.
bcast: Do a broadcast on
+ each of the known local interfaces listed in the
+ interfaces parameter. This is the least
+ reliable of the name resolution methods as it depends on the
+ target host being on a locally connected subnet.
The default order is lmhosts, host, wins, bcast + and without this parameter or any entry in the smb.conf(5) file the name resolution methods will + be attempted in this order.
This option tells smbpasswd that the account + being changed is a MACHINE account. Currently this is used + when Samba is being used as an NT Primary Domain Controller.
This option is only available when running smbpasswd as root. +
This option may only be used in conjunction
+ with the -r option. When changing
+ a password on a remote machine it allows the user to specify
+ the user name on that machine whose password will be changed. It
+ is present to allow users who have different user names on
+ different systems to change these passwords.
This option prints the help string for + smbpasswd, selecting the correct one for running as root + or as an ordinary user.
This option causes smbpasswd to be silent (i.e.
+ not issue prompts) and to read its old and new passwords from
+ standard input, rather than from /dev/tty
+ (like the passwd(1) program does). This option
+ is to aid people writing scripts to drive smbpasswd
This parameter is only available if Samba
+ has been compiled with LDAP support. The -w
+ switch is used to specify the password to be used with the
+ ldap admin dn. Note that the password is stored in
+ the secrets.tdb and is keyed off
+ of the admin's DN. This means that if the value of ldap
+ admin dn ever changes, the password will need to be
+ manually updated as well.
+
This option tells smbpasswd that the account + being changed is an interdomain trust account. Currently this is used + when Samba is being used as an NT Primary Domain Controller. + The account contains the info about another trusted domain.
This option is only available when running smbpasswd as root. +
Run in local mode.
This specifies the username for all of the + root only options to operate on. Only root + can specify this parameter as only root has the permission needed + to modify attributes directly in the local smbpasswd file. +
Since smbpasswd works in client-server
+ mode communicating with a local smbd for a non-root user then
+ the smbd daemon must be running for this to work. A common problem
+ is to add a restriction to the hosts that may access the
+ smbd running on the local machine by specifying either allow
+ hosts or deny hosts entry in
+ the smb.conf(5) file and neglecting to
+ allow "localhost" access to the smbd.
In addition, the smbpasswd command is only useful if Samba + has been set up to use encrypted passwords.
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.
smbsh — Allows access to remote SMB shares + using UNIX commands
smbsh [-W workgroup] [-U username] [-P prefix] [-R <name resolve order>] [-d <debug level>] [-l logdir] [-L libdir]
This tool is part of the samba(7) suite.
smbsh allows you to access an NT filesystem + using UNIX commands such as ls, + egrep, and rcp. You must use a + shell that is dynamically linked in order for smbsh + to work correctly.
Override the default workgroup specified in the + workgroup parameter of the smb.conf(5) file + for this session. This may be needed to connect to some + servers.
Sets the SMB username or username and password. + If this option is not specified, the user will be prompted for + both the username and the password. If %pass is not specified, + the user will be prompted for the password. +
This option allows + the user to set the directory prefix for SMB access. The + default value if this option is not specified is + smb. +
The file specified contains the
+configuration details required by the server. The
+information in this file includes server-specific
+information such as what printcap file to use, as well
+as descriptions of all the services that the server is
+to provide. See smb.conf for more information.
+The default configuration file name is determined at
+compile time.
debuglevel is an integer
+from 0 to 10. The default value if this parameter is
+not specified is zero.
The higher this value, the more detail will be +logged to the log files about the activities of the +server. At level 0, only critical errors and serious +warnings will be logged. Level 1 is a reasonable level for +day-to-day running - it generates a small amount of +information about operations carried out.
Levels above 1 will generate considerable +amounts of log data, and should only be used when +investigating a problem. Levels above 3 are designed for +use only by developers and generate HUGE amounts of log +data, most of which is extremely cryptic.
Note that specifying this parameter here will
+override the parameter
+in the smb.conf file.
This option is used to determine what naming +services and in what order to resolve +host names to IP addresses. The option takes a space-separated +string of different 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 dependent, for instance on IRIX or Solaris this
+may be controlled by the /etc/nsswitch.conf
+ file). Note that this method is only used
+if the NetBIOS name type being queried is the 0x20
+(server) name type, otherwise it is ignored.
+
wins:
+Query a name with the IP address listed in the
+wins server parameter. If no
+WINS server has been specified this method will be
+ignored.
+
bcast:
+Do a broadcast on each of the known local interfaces
+listed in the interfaces
+parameter. This is the least reliable of the name
+resolution methods as it depends on the target host
+being on a locally connected subnet.
+
If this parameter is not set then the name resolve order
+defined in the smb.conf file parameter
+() will be used.
+
The default order is lmhosts, host, wins, bcast. Without
+this parameter or any entry in the parameter of the smb.conf file, the name
+resolution methods will be attempted in this order.
This parameter specifies the location of the + shared libraries used by smbsh. The default + value is specified at compile time. +
To use the smbsh command, execute + smbsh from the prompt and enter the username and password + that authenticates you to the machine running the Windows NT + operating system. +
+system%smbsh+Username:user+Password:XXXXXXX+
Any dynamically linked command you execute from
+ this shell will access the /smb directory
+ using the smb protocol. For example, the command ls /smb
+ will show a list of workgroups. The command
+ ls /smb/MYGROUP will show all the machines in
+ the workgroup MYGROUP. The command
+ ls /smb/MYGROUP/<machine-name> will show the share
+ names for that machine. You could then, for example, use the
+ cd command to change directories, vi to
+ edit files, and rcp to copy files.
smbsh works by intercepting the standard
+ libc calls with the dynamically loaded versions in
+ smbwrapper.o. Not all calls have been "wrapped", so
+ some programs may not function correctly under smbsh
+ .
Programs which are not dynamically linked cannot make + use of smbsh's functionality. Most versions + of UNIX have a file command that will + describe how a program was linked.
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.
smbspool — send a print file to an SMB printer
smbspool {job} {user} {title} {copies} {options} [filename]
This tool is part of the samba(7) suite.
smbspool is a very small print spooling program that + sends a print file to an SMB printer. The command-line arguments + are position-dependent for compatibility with the Common UNIX + Printing System, but you can use smbspool with any printing system + or from a program or script.
DEVICE URI
smbspool specifies the destination using a Uniform Resource + Identifier ("URI") with a method of "smb". This string can take + a number of forms:
smb://server[:port]/printer
smb://workgroup/server[:port]/printer
smb://username:password@server[:port]/printer
smb://username:password@workgroup/server[:port]/printer
smbspool tries to get the URI from the environment variable
+ DEVICE_URI. If DEVICE_URI is not present,
+ smbspool will use argv[0] if that starts with “smb://”
+ or argv[1] if that is not the case.
Programs using the exec(2) functions can
+ pass the URI in argv[0], while shell scripts must set the
+ DEVICE_URI environment variable prior to
+ running smbspool.
The job argument (argv[1]) contains the + job ID number and is presently not used by smbspool. +
The user argument (argv[2]) contains the + print user's name and is presently not used by smbspool. +
The title argument (argv[3]) contains the + job title string and is passed as the remote file name + when sending the print job.
The copies argument (argv[4]) contains + the number of copies to be printed of the named file. If + no filename is provided then this argument is not used by + smbspool.
The options argument (argv[5]) contains + the print options in a single string and is currently + not used by smbspool.
The filename argument (argv[6]) contains the + name of the file to print. If this argument is not specified + then the print file is read from the standard input.
smbspool was written by Michael Sweet + at Easy Software Products.
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.
smbstatus — report on current Samba connections
smbstatus [-P] [-b] [-d <debug level>] [-v] [-L] [-B] [-p] [-S] [-s <configuration file>] [-u <username>]
This tool is part of the samba(7) suite.
smbstatus is a very simple program to + list the current Samba connections.
If samba has been compiled with the + profiling option, print only the contents of the profiling + shared memory area.
gives brief output.
Prints the program version number. +
The file specified contains the
+configuration details required by the server. The
+information in this file includes server-specific
+information such as what printcap file to use, as well
+as descriptions of all the services that the server is
+to provide. See smb.conf for more information.
+The default configuration file name is determined at
+compile time.
debuglevel is an integer
+from 0 to 10. The default value if this parameter is
+not specified is zero.
The higher this value, the more detail will be +logged to the log files about the activities of the +server. At level 0, only critical errors and serious +warnings will be logged. Level 1 is a reasonable level for +day-to-day running - it generates a small amount of +information about operations carried out.
Levels above 1 will generate considerable +amounts of log data, and should only be used when +investigating a problem. Levels above 3 are designed for +use only by developers and generate HUGE amounts of log +data, most of which is extremely cryptic.
Note that specifying this parameter here will
+override the parameter
+in the smb.conf file.
Base directory name for log/debug files. The extension
+".progname" will be appended (e.g. log.smbclient,
+log.smbd, etc...). The log file is never removed by the client.
+
gives verbose output.
causes smbstatus to only list locks.
causes smbstatus to include byte range locks. +
print a list of smbd(8) processes and exit. + Useful for scripting.
causes smbstatus to only list shares.
Print a summary of command line options. +
selects information relevant to username only.
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.
smbtar — shell script for backing up SMB/CIFS shares + directly to UNIX tape drives
smbtar [-r] [-i] [-a] [-v] {-s server} [-p password] [-x services] [-X] [-N filename] [-b blocksize] [-d directory] [-l loglevel] [-u user] [-t tape] {filenames}
This tool is part of the samba(7) suite.
smbtar is a very small shell script on top + of smbclient(1) which dumps SMB shares directly to tape.
The SMB/CIFS server that the share resides + upon.
The share name on the server to connect to. + The default is "backup".
Exclude mode. Exclude filenames... from tar + create or restore.
Change to initial directory
+ before restoring / backing up files.
Verbose mode.
The password to use to access a share. + Default: none
The user id to connect as. Default: + UNIX login name.
Reset DOS archive bit mode to + indicate file has been archived.
Tape device. May be regular file or tape
+ device. Default: $TAPE environmental
+ variable; if not set, a file called tar.out
+ .
Blocking factor. Defaults to 20. See + tar(1) for a fuller explanation.
Backup only files newer than filename. Could + be used (for example) on a log file to implement incremental + backups.
Incremental mode; tar files are only backed + up if they have the archive bit set. The archive bit is reset + after each file is read.
Restore. Files are restored to the share + from the tar file.
Log (debug) level. Corresponds to the
+ -d flag of smbclient(1).
The $TAPE variable specifies the
+ default tape device to write to. May be overridden
+ with the -t option.
Sites that are more careful about security may not like + the way the script handles PC passwords. Backup and restore work + on entire shares; should work on file lists. smbtar works best + with GNU tar and may not work well with other versions.
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.
Ricky Poulten + wrote the tar extension and this man page. The smbtar + script was heavily rewritten and improved by Martin Kraemer. Many + thanks to everyone who suggested extensions, improvements, bug + fixes, etc. 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.
smbtree — A text based smb network browser +
smbtree [-b] [-D] [-S]
This tool is part of the samba(7) suite.
smbtree is a smb browser program + in text mode. It is similar to the "Network Neighborhood" found + on Windows computers. It prints a tree with all + the known domains, the servers in those domains and + the shares on the servers. +
Query network nodes by sending requests + as broadcasts instead of querying the local master browser. +
Only print a list of all + the domains known on broadcast or by the + master browser
Only print a list of + all the domains and servers responding on broadcast or + known by the master browser. +
Prints the program version number. +
The file specified contains the
+configuration details required by the server. The
+information in this file includes server-specific
+information such as what printcap file to use, as well
+as descriptions of all the services that the server is
+to provide. See smb.conf for more information.
+The default configuration file name is determined at
+compile time.
debuglevel is an integer
+from 0 to 10. The default value if this parameter is
+not specified is zero.
The higher this value, the more detail will be +logged to the log files about the activities of the +server. At level 0, only critical errors and serious +warnings will be logged. Level 1 is a reasonable level for +day-to-day running - it generates a small amount of +information about operations carried out.
Levels above 1 will generate considerable +amounts of log data, and should only be used when +investigating a problem. Levels above 3 are designed for +use only by developers and generate HUGE amounts of log +data, most of which is extremely cryptic.
Note that specifying this parameter here will
+override the parameter
+in the smb.conf file.
Base directory name for log/debug files. The extension
+".progname" will be appended (e.g. log.smbclient,
+log.smbd, etc...). The log file is never removed by the client.
+
If specified, this parameter suppresses the normal +password prompt from the client to the user. This is useful when +accessing a service that does not require a password.
Unless a password is specified on the command line or +this parameter is specified, the client will request a +password.
+Try to authenticate with kerberos. Only useful in +an Active Directory environment. +
This option allows +you to specify a file from which to read the username and +password used in the connection. The format of the file is +
+username = <value> +password = <value> +domain = <value> +
Make certain that the permissions on the file restrict +access from unwanted users.
Sets the SMB username or username and password.
If %password is not specified, the user will be prompted. The
+client will first check the USER environment variable, then the
+LOGNAME variable and if either exists, the
+string is uppercased. If these environmental variables are not
+found, the username GUEST is used.
A third option is to use a credentials file which
+contains the plaintext of the username and password. This
+option is mainly provided for scripts where the admin does not
+wish to pass the credentials on the command line or via environment
+variables. If this method is used, make certain that the permissions
+on the file restrict access from unwanted users. See the
+-A for more details.
Be cautious about including passwords in scripts. Also, on +many systems the command line of a running process may be seen +via the ps command. To be safe always allow +rpcclient to prompt for a password and type +it in directly.
Print a summary of command line options. +
smbumount — smbfs umount for normal users
smbumount {mount-point}
With this program, normal users can unmount smb-filesystems, + provided that it is suid root. smbumount has + been written to give normal Linux users more control over their + resources. It is safe to install this program suid root, because only + the user who has mounted a filesystem is allowed to unmount it again. + For root it is not necessary to use smbumount. The normal umount + program works perfectly well, but it would certainly be problematic + to make umount setuid root.
Volker Lendecke, Andrew Tridgell, Michael H. Warfield + and others.
The current maintainer of smbfs and the userspace + tools smbmount, smbumount, + and smbmnt is Urban Widmark. + The SAMBA Mailing list + is the preferred place to ask questions regarding these programs. +
The conversion of this manpage for Samba 2.2 was performed + by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0 + was done by Alexander Bokovoy.
swat — Samba Web Administration Tool
swat [-s <smb config file>] [-a] [-P]
This tool is part of the samba(7) suite.
swat allows a Samba administrator to
+ configure the complex smb.conf(5) file via a Web browser. In addition,
+ a swat configuration page has help links
+ to all the configurable options in the smb.conf file allowing an
+ administrator to easily look up the effects of any change.
swat is run from inetd
The default configuration file path is
+ determined at compile time. The file specified contains
+ the configuration details required by the smbd(8) server. This is the file
+ that swat will modify.
+ The information in this file includes server-specific
+ information such as what printcap file to use, as well as
+ descriptions of all the services that the server is to provide.
+ See smb.conf for more information.
+
This option disables authentication and puts
+ swat in demo mode. In that mode anyone will be able to modify
+ the smb.conf file.
WARNING: Do NOT enable this option on a production + server.
This option restricts read-only users to the password + management page. swat can then be used to change + user passwords without users seeing the "View" and "Status" menu + buttons.
Prints the program version number. +
The file specified contains the
+configuration details required by the server. The
+information in this file includes server-specific
+information such as what printcap file to use, as well
+as descriptions of all the services that the server is
+to provide. See smb.conf for more information.
+The default configuration file name is determined at
+compile time.
debuglevel is an integer
+from 0 to 10. The default value if this parameter is
+not specified is zero.
The higher this value, the more detail will be +logged to the log files about the activities of the +server. At level 0, only critical errors and serious +warnings will be logged. Level 1 is a reasonable level for +day-to-day running - it generates a small amount of +information about operations carried out.
Levels above 1 will generate considerable +amounts of log data, and should only be used when +investigating a problem. Levels above 3 are designed for +use only by developers and generate HUGE amounts of log +data, most of which is extremely cryptic.
Note that specifying this parameter here will
+override the parameter
+in the smb.conf file.
Base directory name for log/debug files. The extension
+".progname" will be appended (e.g. log.smbclient,
+log.smbd, etc...). The log file is never removed by the client.
+
Print a summary of command line options. +
Swat is included as binary package with most distributions. The + package manager in this case takes care of the installation and + configuration. This section is only for those who have compiled + swat from scratch. +
After you compile SWAT you need to run make install + to install the swat binary + and the various help files and images. A default install would put + these in:
/usr/local/samba/sbin/swat
/usr/local/samba/swat/images/*
/usr/local/samba/swat/help/*
You need to edit your /etc/inetd.conf
+ and /etc/services
+ to enable SWAT to be launched via inetd.
In /etc/services you need to
+ add a line like this:
swat 901/tcp
Note for NIS/YP and LDAP users - you may need to rebuild the
+ NIS service maps rather than alter your local
+ /etc/services file.
the choice of port number isn't really important + except that it should be less than 1024 and not currently + used (using a number above 1024 presents an obscure security + hole depending on the implementation details of your + inetd daemon).
In /etc/inetd.conf you should
+ add a line like this:
swat stream tcp nowait.400 root + /usr/local/samba/sbin/swat swat
Once you have edited /etc/services
+ and /etc/inetd.conf you need to send a
+ HUP signal to inetd. To do this use kill -1 PID
+ where PID is the process ID of the inetd daemon.
To launch SWAT just run your favorite web browser and + point it at "http://localhost:901/".
Note that you can attach to SWAT from any IP connected + machine but connecting from a remote machine leaves your + connection open to password sniffing as passwords will be sent + in the clear over the wire.
/etc/inetd.confThis file must contain suitable startup + information for the meta-daemon.
/etc/servicesThis file must contain a mapping of service name + (e.g., swat) to service port (e.g., 901) and protocol type + (e.g., tcp).
/usr/local/samba/lib/smb.confThis is the default location of the smb.conf(5) server configuration file that swat edits. Other
+ common places that systems install this file are
+ /usr/samba/lib/smb.conf and /etc/smb.conf
+ . This file describes all the services the server
+ is to make available to clients.
swat will rewrite your smb.conf(5) file. It will rearrange the entries and delete all
+ comments, include= and copy=
+ options. If you have a carefully crafted
+ smb.conf then back it up or don't use swat!
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.
tdbbackup — tool for backing up and for validating the integrity of samba .tdb files
tdbbackup [-s suffix] [-v] [-h]
This tool is part of the samba(1) suite.
tdbbackup is a tool that may be used to backup samba .tdb + files. This tool may also be used to verify the integrity of the .tdb files prior + to samba startup or during normal operation. If it finds file damage and it finds + a prior backup the backup file will be restored. +
+ Get help information. +
+ The -s option allows the adminisistrator to specify a file + backup extension. This way it is possible to keep a history of tdb backup + files by using a new suffix for each backup. +
+ The -v will check the database for damages (currupt data) + which if detected causes the backup to be restored. +
GENERAL INFORMATION
+ The tdbbackup utility can safely be run at any time. It was designed so + that it can be used at any time to validate the integrity of tdb files, even during Samba + operation. Typical usage for the command will be: +
tdbbackup [-s suffix] *.tdb
+ Before restarting samba the following command may be run to validate .tdb files: +
tdbbackup -v [-s suffix] *.tdb
+ Samba .tdb files are stored in various locations, be sure to run backup all + .tdb file on the system. Important files includes: +
+ secrets.tdb - usual location is in the /usr/local/samba/private + directory, or on some systems in /etc/samba. +
+ passdb.tdb - usual location is in the /usr/local/samba/private + directory, or on some systems in /etc/samba. +
+ *.tdb located in the /usr/local/samba/var directory or on some + systems in the /var/cache or /var/lib/samba directories. +
tdbdump — tool for printing the contents of a TDB file
tdbdump {filename}
This tool is part of the samba(1) suite.
tdbdump is a very simple utility that 'dumps' the + contents of a TDB (Trivial DataBase) file to standard output in a + human-readable format. +
This tool can be used when debugging problems with TDB files. It is + intended for those who are somewhat familiar with Samba internals. +
testparm — check an smb.conf configuration file for + internal correctness
testparm [-s] [-h] [-v] [-L <servername>] [-t <encoding>] {config filename} [hostname hostIP]
This tool is part of the samba(7) suite.
testparm is a very simple test program + to check an smbd(8) configuration file for + internal correctness. If this program reports no problems, you + can use the configuration file with confidence that smbd + will successfully load the configuration file.
Note that this is NOT a guarantee that + the services specified in the configuration file will be + available or will operate as expected.
If the optional host name and host IP address are + specified on the command line, this test program will run through + the service entries reporting whether the specified host + has access to each service.
If testparm finds an error in the
+ smb.conf file it returns an exit code of 1 to the calling
+ program, else it returns an exit code of 0. This allows shell scripts
+ to test the output from testparm.
Without this option, testparm + will prompt for a carriage return after printing the service + names and before dumping the service definitions.
Print a summary of command line options. +
Prints the program version number. +
Sets the value of the %L macro to servername.
+ This is useful for testing include files specified with the
+ %L macro.
If this option is specified, testparm + will also output all options that were not used in smb.conf(5) and are thus set to their defaults.
+ Output data in specified encoding. +
This is the name of the configuration file + to check. If this parameter is not present then the + default smb.conf(5) file will be checked. +
If this parameter and the following are
+ specified, then testparm will examine the hosts
+ allow and hosts deny
+ parameters in the smb.conf(5) file to
+ determine if the hostname with this IP address would be
+ allowed access to the smbd server. If
+ this parameter is supplied, the hostIP parameter must also
+ be supplied.
This is the IP address of the host specified + in the previous parameter. This address must be supplied + if the hostname parameter is supplied.
The program will issue a message saying whether the + configuration file loaded OK or not. This message may be preceded by + errors and warnings if the file did not load. If the file was + loaded OK, the program then dumps all known service details + to stdout.
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.
testprns — check printer name for validity with smbd
testprns {printername} [printcapname]
This tool is part of the samba(7) suite.
testprns is a very simple test program + to determine whether a given printer name is valid for use in + a service to be provided by smbd(8).
"Valid" in this context means "can be found in the + printcap specified". This program is very stupid - so stupid in + fact that it would be wisest to always specify the printcap file + to use.
The printer name to validate.
Printer names are taken from the first field in each + record in the printcap file, single printer names and sets + of aliases separated by vertical bars ("|") are recognized. + Note that no validation or checking of the printcap syntax is + done beyond that required to extract the printer name. It may + be that the print spooling system is more forgiving or less + forgiving than testprns. However, if + testprns finds the printer then smbd(8) should do so as well.
This is the name of the printcap file within + which to search for the given printer name.
If no printcap name is specified testprns + will attempt to scan the printcap file name + specified at compile time.
If a printer is found to be valid, the message + "Printer name <printername> is valid" will be + displayed.
If a printer is found to be invalid, the message + "Printer name <printername> is not valid" will be + displayed.
All messages that would normally be logged during
+ operation of the Samba daemons are logged by this program to the
+ file test.log in the current directory. The
+ program runs at debuglevel 3, so quite extensive logging
+ information is written. The log should be checked carefully
+ for errors and warnings.
Other messages are self-explanatory.
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.
umount.cifs — for normal, non-root users, to unmount their own Common Internet File System (CIFS) mounts
umount.cifs {mount-point} [-nVvhfle]
This tool is part of the samba(7) suite.
umount.cifs unmounts a Linux CIFS filesystem. It can be invoked +indirectly by the +umount(8) command +when umount.cifs is in /sbin directory, unless you specify the "-i" option to umount. Specifying -i to umount avoids execution of umount helpers such as umount.cifs. The umount.cifs command only works in Linux, and the kernel must +support the cifs filesystem. The CIFS protocol is the successor to the +SMB protocol and is supported by most Windows servers and many other +commercial servers and Network Attached Storage appliances as well as +by the popular Open Source server Samba. +
+ The umount.cifs utility detaches the local directory mount-point from the corresponding UNC name (exported network resource) and frees the associated kernel resources. +It is possible to set the mode for umount.cifs to +setuid root (or equivalently update the /etc/permissions file) to allow non-root users to umount shares to directories for which they have write permission. The umount.cifs utility is typically +not needed if unmounts need only be performed by root users, or if user mounts and unmounts +can rely on specifying explicit entries in /etc/fstab See
print additional debugging information
Do not update the mtab even if unmount completes successfully (/proc/mounts will still display the correct information)
This command is normally intended to be installed setuid (since root users can already run unmount). An alternative to using umount.cifs is to add specfic entries for the user mounts that you wish a particular user or users to mount and unmount to /etc/fstab
+The primary mechanism for making configuration changes and for reading
+debug information for the cifs vfs is via the Linux /proc filesystem.
+In the directory /proc/fs/cifs are various
+configuration files and pseudo files which can display debug information.
+For more information see the kernel file fs/cifs/README.
+
At this time umount.cifs does not lock the mount table using the same lock as the umount utility does, so do not attempt to do multiple unmounts from different processes (and in particular unmounts of a cifs mount and another type of filesystem mount at the same time). +
If the same mount point is mounted multiple times by cifs, umount.cifs will remove all of the matching entries from the mount table (although umount.cifs will actually only unmount the last one), rather than only removing the last matching entry in /etc/mtab. The pseudofile /proc/mounts will display correct information though, and the lack of an entry in /etc/mtab does not prevent subsequent unmounts.
+Note that the typical response to a bug report is a suggestion +to try the latest version first. So please try doing that first, +and always include which versions you use of relevant software +when reporting bugs (minimum: umount.cifs (try umount.cifs -V), kernel (see /proc/version) and +server type you are trying to contact. +
This man page is correct for version 1.34 of + the cifs vfs filesystem (roughly Linux kernel 2.6.12).
+ Documentation/filesystems/cifs.txt and fs/cifs/README in the linux kernel + source tree may contain additional options and information. +
Steve French
The syntax was loosely based on the umount utility and the manpage was loosely based on that of mount.cifs.8. The man page was created by Steve French
The maintainer of the Linux cifs vfs and the userspace + tool umount.cifs is Steve French. + The Linux CIFS Mailing list + is the preferred place to ask questions regarding these programs. +
vfstest — tool for testing samba VFS modules
vfstest [-d debuglevel] [-c command] [-l logdir] [-h]
This tool is part of the samba(7) suite.
vfstest is a small command line + utility that has the ability to test dso samba VFS modules. It gives the + user the ability to call the various VFS functions manually and + supports cascaded VFS modules. +
Execute the specified (colon-separated) commands. + See below for the commands that are available. +
Print a summary of command line options. +
File name for log/debug files. The extension
+ '.client' will be appended. The log file is never removed
+ by the client.
+
Prints the program version number. +
The file specified contains the
+configuration details required by the server. The
+information in this file includes server-specific
+information such as what printcap file to use, as well
+as descriptions of all the services that the server is
+to provide. See smb.conf for more information.
+The default configuration file name is determined at
+compile time.
debuglevel is an integer
+from 0 to 10. The default value if this parameter is
+not specified is zero.
The higher this value, the more detail will be +logged to the log files about the activities of the +server. At level 0, only critical errors and serious +warnings will be logged. Level 1 is a reasonable level for +day-to-day running - it generates a small amount of +information about operations carried out.
Levels above 1 will generate considerable +amounts of log data, and should only be used when +investigating a problem. Levels above 3 are designed for +use only by developers and generate HUGE amounts of log +data, most of which is extremely cryptic.
Note that specifying this parameter here will
+override the parameter
+in the smb.conf file.
Base directory name for log/debug files. The extension
+".progname" will be appended (e.g. log.smbclient,
+log.smbd, etc...). The log file is never removed by the client.
+
VFS COMMANDS
load <module.so> - Load specified VFS module
populate <char> <size> - Populate a data buffer with the specified data +
showdata [<offset> <len>] - Show data currently in data buffer +
connect - VFS connect()
disconnect - VFS disconnect()
disk_free - VFS disk_free()
opendir - VFS opendir()
readdir - VFS readdir()
mkdir - VFS mkdir()
rmdir - VFS rmdir()
closedir - VFS closedir()
open - VFS open()
close - VFS close()
read - VFS read()
write - VFS write()
lseek - VFS lseek()
rename - VFS rename()
fsync - VFS fsync()
stat - VFS stat()
fstat - VFS fstat()
lstat - VFS lstat()
unlink - VFS unlink()
chmod - VFS chmod()
fchmod - VFS fchmod()
chown - VFS chown()
fchown - VFS fchown()
chdir - VFS chdir()
getwd - VFS getwd()
utime - VFS utime()
ftruncate - VFS ftruncate()
lock - VFS lock()
symlink - VFS symlink()
readlink - VFS readlink()
link - VFS link()
mknod - VFS mknod()
realpath - VFS realpath()
GENERAL COMMANDS
conf <smb.conf> - Load a different configuration file
help [<command>] - Get list of commands or info about specified command
debuglevel <level> - Set debug level
freemem - Free memory currently in use
exit - Exit vfstest
wbinfo — Query information from winbind daemon
wbinfo [-a user%password] [-c username] [-C groupname] [--domain domain] [-I ip] [-s sid] [-u] [-U uid] [-g] [--get-auth-user] [-G gid] [-m] [-n name] [-N netbios-name] [-o user:group] [-O user:group] [-p] [-r user] [--set-auth-user user%password] [--sequence] [-S sid] [-t] [-x username] [-X groupname] [-Y sid]
This tool is part of the samba(7) suite.
The wbinfo program queries and returns information + created and used by the winbindd(8) daemon.
The winbindd(8) daemon must be configured + and running for the wbinfo program to be able + to return information.
Attempt to authenticate a user via winbindd. + This checks both authenticaion methods and reports its results. +
Do not be tempted to use this + functionality for authentication in third-party + applications. Instead use ntlm_auth(1).
Create a local winbind user. +
Create a local winbindd group. +
This parameter sets the domain on which any specified
+ operations will performed. If special domain name '.' is used to represent
+ the current domain to which winbindd belongs. Currently only the
+ --sequence,
+ -u, and -g options honor this parameter.
+
This option will list all groups available + in the Windows NT domain for which the samba(7) daemon is operating in. Groups in all trusted domains + will also be listed. Note that this operation does not assign + group ids to any groups that have not already been + seen by winbindd(8).
Print username and password used by winbindd + during session setup to a domain controller. Username + and password can be set using '-A'. Only available for + root.
Try to convert a UNIX group id to a Windows + NT SID. If the gid specified does not refer to one within + the idmap gid range then the operation will fail.
The -I option
+ queries winbindd(8) to send a node status
+ request to get the NetBIOS name associated with the IP address
+ specified by the ip parameter.
+
Produce a list of domains trusted by the + Windows NT server winbindd(8) contacts + when resolving names. This list does not include the Windows + NT domain the server is a Primary Domain Controller for. +
The -n option
+ queries winbindd(8) for the SID
+ associated with the name specified. Domain names can be specified
+ before the user name by using the winbind separator character.
+ For example CWDOM1/Administrator refers to the Administrator
+ user in the domain CWDOM1. If no domain is specified then the
+ domain used is the one specified in the smb.conf(5) workgroup
+ parameter.
The -N option
+ queries winbindd(8) to query the WINS
+ server for the IP address associated with the NetBIOS name
+ specified by the name parameter.
+
Add a winbindd local group as a secondary group + for the specified winbindd local user. +
Remove a winbindd local group as a secondary group + for the specified winbindd local user. +
Check whether winbindd is still alive. + Prints out either 'succeeded' or 'failed'. +
Try to obtain the list of UNIX group ids + to which the user belongs. This only works for users + defined on a Domain Controller. +
Use -s to resolve
+ a SID to a name. This is the inverse of the -n
+ option above. SIDs must be specified as ASCII strings
+ in the traditional Microsoft format. For example,
+ S-1-5-21-1455342024-3071081365-2475485837-500.
Store username and password used by winbindd + during session setup to a domain controller. This enables + winbindd to operate in a Windows 2000 domain with Restrict + Anonymous turned on (a.k.a. Permissions compatiable with + Windows 2000 servers only). +
Show sequence numbers of + all known domains
Convert a SID to a UNIX user id. If the SID + does not correspond to a UNIX user mapped by winbindd(8) then the operation will fail.
Verify that the workstation trust account + created when the Samba server is added to the Windows NT + domain is working.
This option will list all users available + in the Windows NT domain for which the winbindd(8) daemon is operating in. Users in all trusted domains + will also be listed. Note that this operation does not assign + user ids to any users that have not already been seen by winbindd(8) + .
Try to convert a UNIX user id to a Windows NT + SID. If the uid specified does not refer to one within + the idmap uid range then the operation will fail.
Delete an existing local winbind user. +
Delete an existing local winbindd group. +
Convert a SID to a UNIX group id. If the SID + does not correspond to a UNIX group mapped by winbindd(8) then + the operation will fail.
Prints the program version number. +
Print a summary of command line options. +
The wbinfo program returns 0 if the operation + succeeded, or 1 if the operation failed. If the winbindd(8) daemon is not working wbinfo will always return + failure.
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.
wbinfo and winbindd + were written by Tim Potter.
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.
winbindd — Name Service Switch daemon for resolving names + from NT servers
winbindd [-F] [-S] [-i] [-Y] [-d <debug level>] [-s <smb config file>] [-n]
This program is part of the samba(7) suite.
winbindd is a daemon that provides + a number of services to the Name Service Switch capability found + in most modern C libraries, to arbitary applications via PAM + and ntlm_auth and to Samba itself.
Even if winbind is not used for nsswitch, it still provides a + service to smbd, ntlm_auth + and the pam_winbind.so PAM module, by managing connections to + domain controllers. In this configuraiton the + idmap uid and + idmap gid + parameters are not required. (This is known as `netlogon proxy only mode'.)
The Name Service Switch allows user
+ and system information to be obtained from different databases
+ services such as NIS or DNS. The exact behaviour can be configured
+ throught the /etc/nsswitch.conf file.
+ Users and groups are allocated as they are resolved to a range
+ of user and group ids specified by the administrator of the
+ Samba system.
The service provided by winbindd is called `winbind' and + can be used to resolve user and group information from a + Windows NT server. The service can also provide authentication + services via an associated PAM module.
+ The pam_winbind module supports the
+ auth, account
+ and password
+ module-types. It should be noted that the
+ account module simply performs a getpwnam() to verify that
+ the system can obtain a uid for the user, as the domain
+ controller has already performed access control. If the
+ libnss_winbind library has been correctly
+ installed, or an alternate source of names configured, this should always succeed.
+
The following nsswitch databases are implemented by + the winbindd service:
This feature is only available on IRIX.
+ User information traditionally stored in
+ the hosts(5) file and used by
+ gethostbyname(3) functions. Names are
+ resolved through the WINS server or by broadcast.
+
User information traditionally stored in
+ the passwd(5) file and used by
+ getpwent(3) functions.
Group information traditionally stored in
+ the group(5) file and used by
+ getgrent(3) functions.
For example, the following simple configuration in the
+ /etc/nsswitch.conf file can be used to initially
+ resolve user and group information from /etc/passwd
+ and /etc/group and then from the
+ Windows NT server.
+
+passwd: files winbind +group: files winbind +## only available on IRIX; Linux users should us libnss_wins.so +hosts: files dns winbind +
The following simple configuration in the
+ /etc/nsswitch.conf file can be used to initially
+ resolve hostnames from /etc/hosts and then from the
+ WINS server.
+hosts: files wins +
If specified, this parameter causes + the main winbindd process to not daemonize, + i.e. double-fork and disassociate with the terminal. + Child processes are still created as normal to service + each connection request, but the main process does not + exit. This operation mode is suitable for running + winbindd under process supervisors such + as supervise and svscan + from Daniel J. Bernstein's daemontools + package, or the AIX process monitor. +
If specified, this parameter causes + winbindd to log to standard output rather + than a file.
Prints the program version number. +
The file specified contains the
+configuration details required by the server. The
+information in this file includes server-specific
+information such as what printcap file to use, as well
+as descriptions of all the services that the server is
+to provide. See smb.conf for more information.
+The default configuration file name is determined at
+compile time.
debuglevel is an integer
+from 0 to 10. The default value if this parameter is
+not specified is zero.
The higher this value, the more detail will be +logged to the log files about the activities of the +server. At level 0, only critical errors and serious +warnings will be logged. Level 1 is a reasonable level for +day-to-day running - it generates a small amount of +information about operations carried out.
Levels above 1 will generate considerable +amounts of log data, and should only be used when +investigating a problem. Levels above 3 are designed for +use only by developers and generate HUGE amounts of log +data, most of which is extremely cryptic.
Note that specifying this parameter here will
+override the parameter
+in the smb.conf file.
Base directory name for log/debug files. The extension
+".progname" will be appended (e.g. log.smbclient,
+log.smbd, etc...). The log file is never removed by the client.
+
Print a summary of command line options. +
Tells winbindd to not + become a daemon and detach from the current terminal. This + option is used by developers when interactive debugging + of winbindd is required. + winbindd also logs to standard output, + as if the -S parameter had been given. +
Disable caching. This means winbindd will + always have to wait for a response from the domain controller + before it can respond to a client and this thus makes things + slower. The results will however be more accurate, since + results from the cache might not be up-to-date. This + might also temporarily hang winbindd if the DC doesn't respond. +
Single daemon mode. This means winbindd will run + as a single process (the mode of operation in Samba 2.2). Winbindd's + default behavior is to launch a child process that is responsible for + updating expired cache entries. +
Users and groups on a Windows NT server are assigned + a security id (SID) which is globally unique when the + user or group is created. To convert the Windows NT user or group + into a unix user or group, a mapping between SIDs and unix user + and group ids is required. This is one of the jobs that + winbindd performs.
As winbindd users and groups are resolved from a server, user + and group ids are allocated from a specified range. This + is done on a first come, first served basis, although all existing + users and groups will be mapped as soon as a client performs a user + or group enumeration command. The allocated unix ids are stored + in a database file under the Samba lock directory and will be + remembered.
WARNING: The SID to unix id database is the only location + where the user and group mappings are stored by winbindd. If this + file is deleted or corrupted, there is no way for winbindd to + determine which user and group ids correspond to Windows NT user + and group rids.
See the parameter in
+ smb.conf for options for sharing this
+ database, such as via LDAP.
Configuration of the winbindd daemon + is done through configuration parameters in the smb.conf(5) file. All parameters should be specified in the + [global] section of smb.conf.
+ To setup winbindd for user and group lookups plus + authentication from a domain controller use something like the + following setup. This was tested on an early Red Hat Linux box. +
In /etc/nsswitch.conf put the
+ following:
+
+passwd: files winbind +group: files winbind +
+
In /etc/pam.d/* replace the
+ auth lines with something like this:
+
+auth required /lib/security/pam_securetty.so +auth required /lib/security/pam_nologin.so +auth sufficient /lib/security/pam_winbind.so +auth required /lib/security/pam_pwdb.so \ + use_first_pass shadow nullok +
+
Note in particular the use of the sufficient
+ keyword and the use_first_pass keyword.
Now replace the account lines with this:
account required /lib/security/pam_winbind.so +
The next step is to join the domain. To do that use the + net program like this:
net join -S PDC -U Administrator
The username after the -U can be any
+ Domain user that has administrator privileges on the machine.
+ Substitute the name or IP of your PDC for "PDC".
Next copy libnss_winbind.so to
+ /lib and pam_winbind.so
+ to /lib/security. A symbolic link needs to be
+ made from /lib/libnss_winbind.so to
+ /lib/libnss_winbind.so.2. If you are using an
+ older version of glibc then the target of the link should be
+ /lib/libnss_winbind.so.1.
Finally, setup a smb.conf(5) containing directives like the + following: +
+[global] + winbind separator = + + winbind cache time = 10 + template shell = /bin/bash + template homedir = /home/%D/%U + idmap uid = 10000-20000 + idmap gid = 10000-20000 + workgroup = DOMAIN + security = domain + password server = * +
Now start winbindd and you should find that your user and + group database is expanded to include your NT users and groups, + and that you can login to your unix box as a domain user, using + the DOMAIN+user syntax for the username. You may wish to use the + commands getent passwd and getent group + to confirm the correct operation of winbindd.
The following notes are useful when configuring and + running winbindd:
nmbd(8) must be running on the local machine + for winbindd to work.
PAM is really easy to misconfigure. Make sure you know what + you are doing when modifying PAM configuration files. It is possible + to set up PAM such that you can no longer log into your system.
If more than one UNIX machine is running winbindd, + then in general the user and groups ids allocated by winbindd will not + be the same. The user and group ids will only be valid for the local + machine, unless a shared is configured.
If the the Windows NT SID to UNIX user and group id mapping + file is damaged or destroyed then the mappings will be lost.
The following signals can be used to manipulate the + winbindd daemon.
Reload the smb.conf(5) file and + apply any parameter changes to the running + version of winbindd. This signal also clears any cached + user and group information. The list of other domains trusted + by winbindd is also reloaded.
The SIGUSR2 signal will cause + winbindd to write status information to the winbind + log file.
Log files are stored in the filename specified by the + log file parameter.
/etc/nsswitch.conf(5)Name service switch configuration file.
The UNIX pipe over which clients communicate with
+ the winbindd program. For security reasons, the
+ winbind client will only attempt to connect to the winbindd daemon
+ if both the /tmp/.winbindd directory
+ and /tmp/.winbindd/pipe file are owned by
+ root.
The UNIX pipe over which 'privileged' clients
+ communicate with the winbindd program. For security
+ reasons, access to some winbindd functions - like those needed by
+ the ntlm_auth utility - is restricted. By default,
+ only users in the 'root' group will get this access, however the administrator
+ may change the group permissions on $LOCKDIR/winbindd_privileged to allow
+ programs like 'squid' to use ntlm_auth.
+ Note that the winbind client will only attempt to connect to the winbindd daemon
+ if both the $LOCKDIR/winbindd_privileged directory
+ and $LOCKDIR/winbindd_privileged/pipe file are owned by
+ root.
Implementation of name service switch library. +
Storage for the Windows NT rid to UNIX user/group
+ id mapping. The lock directory is specified when Samba is initially
+ compiled using the --with-lockdir option.
+ This directory is by default /usr/local/samba/var/locks
+ .
Storage for cached user and group information. +
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.
wbinfo and winbindd were + written by Tim Potter.
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.
editreg — A utility for printing and editing NT4 registry files -
editreg [-v] [-c file] {file}
This tool is part of the samba(7) suite.
editreg is a utility that - can visualize windows registry files (currently only NT4) and apply - so-called commandfiles to them. -
findsmb — list info about machines that respond to SMB - name queries on a subnet
findsmb [subnet broadcast address]
This perl script is part of the samba(7) - suite.
findsmb is a perl script that - prints out several pieces of information about machines - on a subnet that respond to SMB name query requests. - It uses nmblookup(1) - and smbclient(1) - to obtain this information. -
Controls whether findsmb takes
- bugs in Windows95 into account when trying to find a Netbios name
- registered of the remote machine. This option is disabled by default
- because it is specific to Windows 95 and Windows 95 machines only.
- If set, nmblookup(1)
- will be called with -B option.
Without this option, findsmb
- will probe the subnet of the machine where
- findsmb(1)
- is run. This value is passed to
- nmblookup(1)
- as part of the -B option.
The output of findsmb lists the following - information for all machines that respond to the initial - nmblookup for any name: IP address, NetBIOS name, - Workgroup name, operating system, and SMB server version.
There will be a '+' in front of the workgroup name for - machines that are local master browsers for that workgroup. There - will be an '*' in front of the workgroup name for - machines that are the domain master browser for that workgroup. - Machines that are running Windows for Workgroups, Windows 95 or - Windows 98 will - not show any information about the operating system or server - version.
The command with -r option
- must be run on a system without nmbd(8) running.
-
- If nmbd is running on the system, you will
- only get the IP address and the DNS name of the machine. To
- get proper responses from Windows 95 and Windows 98 machines,
- the command must be run as root and with -r
- option on a machine without nmbd running.
For example, running findsmb
- without -r option set would yield output similar
- to the following
-IP ADDR NETBIOS NAME WORKGROUP/OS/VERSION ---------------------------------------------------------------------- -192.168.35.10 MINESET-TEST1 [DMVENGR] -192.168.35.55 LINUXBOX *[MYGROUP] [Unix] [Samba 2.0.6] -192.168.35.56 HERBNT2 [HERB-NT] -192.168.35.63 GANDALF [MVENGR] [Unix] [Samba 2.0.5a for IRIX] -192.168.35.65 SAUNA [WORKGROUP] [Unix] [Samba 1.9.18p10] -192.168.35.71 FROGSTAR [ENGR] [Unix] [Samba 2.0.0 for IRIX] -192.168.35.78 HERBDHCP1 +[HERB] -192.168.35.88 SCNT2 +[MVENGR] [Windows NT 4.0] [NT LAN Manager 4.0] -192.168.35.93 FROGSTAR-PC [MVENGR] [Windows 5.0] [Windows 2000 LAN Manager] -192.168.35.97 HERBNT1 *[HERB-NT] [Windows NT 4.0] [NT LAN Manager 4.0] -
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.
A utility for printing and editing NT4 registry files - -
list info about machines that respond to SMB - name queries on a subnet -
An extension library for browsers and that can be used as a generic browsing API. -
The Samba NetBIOS hosts file -
Extract network traces from Samba log files -
mount using the Common Internet File System (CIFS) -
Tool for administration of Samba and remote - CIFS servers. - -
NetBIOS name server to provide NetBIOS - over IP naming services to clients -
NetBIOS over TCP/IP client used to lookup NetBIOS - names -
tool to allow external access to Winbind's NTLM authentication function -
PAM module for Winbind -
manage the SAM database (Database of Samba Users) -
A utility to report and change SIDs in registry files - -
tool for executing client side - MS-RPC functions -
A Windows SMB/CIFS fileserver for UNIX -
The configuration file for the Samba suite -
Set or get ACLs on an NT file or directory names -
ftp-like client to access SMB/CIFS resources - on servers -
send messages to smbd, nmbd or winbindd processes -
Set or get QUOTAs of NTFS 5 shares -
server to provide SMB/CIFS services to clients -
wget-like utility for download files over SMB -
configuration file for smbget -
helper utility for mounting SMB filesystems -
mount an smbfs filesystem -
The Samba encrypted password file -
change a user's SMB password -
Allows access to remote SMB shares - using UNIX commands -
send a print file to an SMB printer -
report on current Samba connections -
shell script for backing up SMB/CIFS shares - directly to UNIX tape drives -
A text based smb network browser - -
smbfs umount for normal users -
Samba Web Administration Tool -
tool for backing up and for validating the integrity of samba .tdb files -
tool for printing the contents of a TDB file -
check an smb.conf configuration file for - internal correctness -
check printer name for validity with smbd -
for normal, non-root users, to unmount their own Common Internet File System (CIFS) mounts -
tool for testing samba VFS modules -
Query information from winbind daemon -
Name Service Switch daemon for resolving names - from NT servers -
libsmbclient — An extension library for browsers and that can be used as a generic browsing API.
Browser URL:
- smb://[[[domain:]user[:password@]]server[/share[/path[/file]]]] [?options] -
- This tool is part of the samba(8) suite. -
- libsmbclient is a library toolset that permits applications - to manipulate CIFS/SMB network resources using many of the standards POSIX functions - available for manipulating local UNIX/Linux files. It permits much more than just browsing, - files can be opened and read or written, permissions changed, file times modified, attributes - and ACL's can be manipulated, and so on. Of course, its functionality includes all the - capabilities commonly called browsing. -
- libsmbclient can not be used directly from the command line, instead - it provides an extension of the capabilities of tools such as file managers and browsers. - This man page describes the configuration options for this tool so that the user may - obtain greatest utility of use. -
- What the URLs mean: -
- Shows all workgroups or domains that are visible in the network. The behavior matches - that of the Microsoft Windows Explorer. -
- The method of locating the list of workgroups (domains also) varies depending on the setting of
- the context variable (context->options.browse_max_lmb_count). It is the
- responsibility of the application that calls this library to set this to a sensible value. This
- is a compile-time option. This value determines the maximum number of local master browsers to
- query for the list of workgroups. In order to ensure that the list is complete for those present
- on the network, all master browsers must be querried. If there are a large number of workgroups
- on the network, the time spent querying will be significant. For small networks (just a few
- workgroups), it is suggested to set this value to 0, instructing libsmbclient to query all local
- master browsers. In an environment that has many workgroups a more reasonable setting may be around 3.
-
- This command causes libsmbclient to perform a name look-up. If the NAME<1D> or - NAME<1B> exists (workgroup name), libsmbclient will list all servers in the - workgroup (or domain). Otherwise, a name look-up for the NAME<20> (machine name) - will be performed, and the list of shared resources on the server will be displayed. -
- When libsmbclient is invoked by an application it searches for a directory called
- .smb in the $HOME directory that is specified in the users shell
- environment. It then searches for a file called smb.conf which,
- if present, will fully over-ride the system /etc/samba/smb.conf file. If
- instead libsmbclient finds a file called ~/.smb/smb.conf.append,
- it will read the system /etc/samba/smb.conf and then append the
- contents of the ~/.smb/smb.conf.append to it.
-
- libsmbclient will check the users shell environment for the USER
- parameter and will use its value when if the user parameter was not included
- in the URL.
-
lmhosts — The Samba NetBIOS hosts file
lmhosts is the samba(7) NetBIOS name to IP address mapping file.
This file is part of the samba(7) suite.
lmhosts is the Samba
- NetBIOS name to IP address mapping file. It
- is very similar to the /etc/hosts file
- format, except that the hostname component must correspond
- to the NetBIOS naming format.
It is an ASCII file containing one line for NetBIOS name. - The two fields on each line are separated from each other by - white space. Any entry beginning with '#' is ignored. Each line - in the lmhosts file contains the following information:
IP Address - in dotted decimal format.
NetBIOS Name - This name format is a - maximum fifteen character host name, with an optional - trailing '#' character followed by the NetBIOS name type - as two hexadecimal digits.
If the trailing '#' is omitted then the given IP - address will be returned for all names that match the given - name, whatever the NetBIOS name type in the lookup.
An example follows:
-# -# Sample Samba lmhosts file. -# -192.9.200.1 TESTPC -192.9.200.20 NTSERVER#20 -192.9.200.21 SAMBASERVER -
Contains three IP to NetBIOS name mappings. The first - and third will be returned for any queries for the names "TESTPC" - and "SAMBASERVER" respectively, whatever the type component of - the NetBIOS name requested.
The second mapping will be returned only when the "0x20" name - type for a name "NTSERVER" is queried. Any other name type will not - be resolved.
The default location of the lmhosts file
- is in the same directory as the smb.conf(5) file.
lmhosts is loaded from the configuration directory. This is
- usually /etc/samba or /usr/local/samba/lib.
-
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 was done by Alexander Bokovoy.
log2pcap — Extract network traces from Samba log files
log2pcap [-h] [-q] [logfile] [pcap_file]
This tool is part of the samba(7) suite.
log2pcap reads in a - samba log file and generates a pcap file (readable - by most sniffers, such as ethereal or tcpdump) based on the packet - dumps in the log file.
The log file must have a log level
- of at least 5 to get the SMB header/parameters
- right, 10 to get the first 512 data bytes of the
- packet and 50 to get the whole packet.
-
If this parameter is - specified the output file will be a - hex dump, in a format that is readable - by the text2pcap utility.
Be quiet. No warning messages about missing - or incomplete data will be given.
- Samba log file. log2pcap will try to read the log from stdin - if the log file is not specified. -
- Name of the output file to write the pcap (or hexdump) data to. - If this argument is not specified, output data will be written - to stdout. -
Print a summary of command line options. -
Extract all network traffic from all samba log files:
- $ log2pcap < /var/log/* > trace.pcap
- Convert to pcap using text2pcap:
- $ log2pcap -h samba.log | text2pcap -T 139,139 - trace.pcap
- mount.cifs — mount using the Common Internet File System (CIFS)
mount.cifs {service} {mount-point} [-o options]
This tool is part of the samba(7) suite.
mount.cifs mounts a Linux CIFS filesystem. It -is usually invoked indirectly by -the mount(8) command when using the -"-t cifs" option. This command only works in Linux, and the kernel must -support the cifs filesystem. The CIFS protocol is the successor to the -SMB protocol and is supported by most Windows servers and many other -commercial servers and Network Attached Storage appliances as well as -by the popular Open Source server Samba. -
- The mount.cifs utility attaches the UNC name (exported network resource) to - the local directory mount-point. It is possible to set the mode for mount.cifs to -setuid root to allow non-root users to mount shares to directories for which they -have write permission. -
- Options to mount.cifs are specified as a comma-separated -list of key=value pairs. It is possible to send options other -than those listed here, assuming that the cifs filesystem kernel module (cifs.ko) supports them. -Unrecognized cifs mount options passed to the cifs vfs kernel code will be logged to the -kernel log. - -
mount.cifs causes the cifs vfs to launch a thread named cifsd. After mounting it keeps running until - the mounted resource is unmounted (usually via the umount utility). -
argspecifies the username to connect as. If - this is not given, then the environment variable USER is used. This option can also take the -form "user%password" or "workgroup/user" or -"workgroup/user%password" to allow the password and workgroup -to be specified as part of the username. -
- The cifs vfs accepts the parameter user=, or for users familiar with smbfs it accepts the longer form of the parameter username=. Similarly the longer smbfs style parameter names may be accepted as synonyms for the shorter cifs parameters pass=,dom= and cred=.
-
argspecifies the CIFS password. If this -option is not given then the environment variable -PASSWD is used. If the password is not specified -directly or indirectly via an argument to mount mount.cifs will prompt -for a password, unless the guest option is specified. -
Note that a password which contains the delimiter -character (i.e. a comma ',') will fail to be parsed correctly -on the command line. However, the same password defined -in the PASSWD environment variable or via a credentials file (see -below) or entered at the password prompt will be read correctly. -
filename- specifies a file that contains a username - and/or password. The format of the file is: -
- username=value- password=value-
-This is preferred over having passwords in plaintext in a
-shared file, such as /etc/fstab. Be sure to protect any
-credentials file properly.
-
argsets the uid that will own all files on - the mounted filesystem. - It may be specified as either a username or a numeric uid. - This parameter is ignored when the target server supports - the CIFS Unix extensions.
argsets the gid that will own all files on -the mounted filesystem. -It may be specified as either a groupname or a numeric -gid. This parameter is ignored when the target server supports -the CIFS Unix extensions. -
argsets the port number on the server to attempt to contact to negotiate -CIFS support. If the CIFS server is not listening on this port or -if it is not specified, the default ports will be tried i.e. -port 445 is tried and if no response then port 139 is tried. -
argWhen mounting to servers via port 139, specifies the RFC1001 - source name to use to represent the client netbios machine - name when doing the RFC1001 netbios session initialize. -
argIf the server does not support the CIFS Unix extensions this - overrides the default file mode.
argIf the server does not support the CIFS Unix extensions this - overrides the default mode for directories.
argsets the destination host or IP address.
argsets the domain (workgroup) of the user
don't prompt for a password
Charset used to convert local path names to and from - Unicode. Unicode is used by default for network path - names if the server supports it. If iocharset is - not specified then the nls_default specified - during the local client kernel build will be used. - If server does not support Unicode, this parameter is - unused.
mount read-only
mount read-write
If the CIFS Unix extensions are negotiated with the server - the client will attempt to set the effective uid and gid of - the local process on newly created files, directories, and - devices (create, mkdir, mknod).
The client will not attempt to set the uid and gid on - on newly created files, directories, and devices (create, - mkdir, mknod) which will result in the server setting the - uid and gid to the default (usually the server uid of the - user who mounted the share). Letting the server (rather than - the client) set the uid and gid is the default. This - parameter has no effect if the CIFS Unix Extensions are not - negotiated.
Client does permission checks (vfs_permission check of uid - and gid of the file against the mode and desired operation), - Note that this is in addition to the normal ACL check on the - target machine done by the server software. - Client permission checking is enabled by default.
Client does not do permission checks. This can expose - files on this mount to access by other users on the local - client system. It is typically only needed when the server - supports the CIFS Unix Extensions but the UIDs/GIDs on the - client and server system do not match closely enough to allow - access by the user doing the mount. - Note that this does not affect the normal ACL check on the - target machine done by the server software (of the server - ACL against the user name provided at mount time).
Do not do inode data caching on files opened on this mount. - This precludes mmaping files on this mount. In some cases - with fast networks and little or no caching benefits on the - client (e.g. when the application is doing large sequential - reads bigger than page size without rereading the same data) - this can provide better performance than the default - behavior which caches reads (readahead) and writes - (writebehind) through the local Linux client pagecache - if oplock (caching token) is granted and held. Note that - direct allows write operations larger than page size - to be sent to the server. On some kernels this requires the cifs.ko module - to be built with the CIFS_EXPERIMENTAL configure option.
Translate six of the seven reserved characters (not backslash, but including the colon, question mark, pipe, asterik, greater than and less than characters) - to the remap range (above 0xF000), which also - allows the CIFS client to recognize files created with - such characters by Windows's POSIX emulation. This can - also be useful when mounting to most versions of Samba - (which also forbids creating and opening files - whose names contain any of these seven characters). - This has no effect if the server does not support - Unicode on the wire.
Do not translate any of these seven characters (default)
currently unimplemented
(default) currently unimplemented
The program accessing a file on the cifs mounted file system will hang when the - server crashes.
(default) The program accessing a file on the cifs mounted file system will not hang when the server crashes and will return errors to the user application.
Print additional debugging information for the mount. Note that this parameter must be specified before the -o. For example:
mount -t cifs //server/share /mnt --verbose -o user=username
Do not allow POSIX ACL operations even if server would support them.
- The CIFS client can get and set POSIX ACLs (getfacl, setfacl) to Samba servers - version 3.10 and later. Setting POSIX ACLs requires enabling both XATTR and - then POSIX support in the CIFS configuration options when building the cifs - module. POSIX ACL support can be disabled on a per mount basic by specifying - "noacl" on mount.
Use inode numbers (unique persistent file identifiers) - returned by the server instead of automatically generating - temporary inode numbers on the client. Although server inode numbers - make it easier to spot hardlinked files (as they will have - the same inode numbers) and inode numbers may be persistent (which is - userful for some sofware), - the server does not guarantee that the inode numbers - are unique if multiple server side mounts are exported under a - single share (since inode numbers on the servers might not - be unique if multiple filesystems are mounted under the same - shared higher level directory). Note that not all - servers support returning server inode numbers, although - those that support the CIFS Unix Extensions, and Windows 2000 and - later servers typically do support this (although not necessarily - on every local server filesystem). Parameter has no effect if - the server lacks support for returning inode numbers or equivalent. -
client generates inode numbers (rather than using the actual one - from the server) by default. -
(default) Do not allow getfattr/setfattr to get/set xattrs, even if server would support it otherwise.
argdefault network read size
argdefault network write size
- The variable USER may contain the username of the -person to be used to authenticate to the server. -The variable can be used to set both username and -password by using the format username%password. -
- The variable PASSWD may contain the password of the -person using the client. -
- The variable PASSWD_FILE may contain the pathname -of a file to read the password from. A single line of input is -read and used as the password. -
This command may be used only by root, unless installed setuid, in which case the noeexec and nosuid mount flags are enabled.
-The primary mechanism for making configuration changes and for reading
-debug information for the cifs vfs is via the Linux /proc filesystem.
-In the directory /proc/fs/cifs are various
-configuration files and pseudo files which can display debug information.
-For more information see the kernel file fs/cifs/README.
-
Mounting using the CIFS URL specification is currently not supported. -
The credentials file does not handle usernames or passwords with - leading space.
-Note that the typical response to a bug report is a suggestion -to try the latest version first. So please try doing that first, -and always include which versions you use of relevant software -when reporting bugs (minimum: mount.cifs (try mount.cifs -V), kernel (see /proc/version) and -server type you are trying to contact. -
This man page is correct for version 1.34 of - the cifs vfs filesystem (roughly Linux kernel 2.6.12).
- Documentation/filesystems/cifs.txt and fs/cifs/README in the linux kernel - source tree may contain additional options and information. -
Steve French
The syntax and manpage were loosely based on that of smbmount. It - was converted to Docbook/XML by Jelmer Vernooij.
The maintainer of the Linux cifs vfs and the userspace - tool mount.cifs is Steve French. - The Linux CIFS Mailing list - is the preferred place to ask questions regarding these programs. -
net — Tool for administration of Samba and remote - CIFS servers. -
net {<ads|rap|rpc>} [-h] [-w workgroup] [-W myworkgroup] [-U user] [-I ip-address] [-p port] [-n myname] [-s conffile] [-S server] [-l] [-P] [-D debuglevel]
This tool is part of the samba(7) suite.
The samba net utility is meant to work just like the net utility - available for windows and DOS. The first argument should be used - to specify the protocol to use when executing a certain command. - ADS is used for ActiveDirectory, RAP is using for old (Win9x/NT3) - clients and RPC can be used for NT4 and Windows 2000. If this - argument is omitted, net will try to determine it automatically. - Not all commands are available on all protocols. -
Print a summary of command line options. -
- Sets target workgroup or domain. You have to specify - either this option or the IP address or the name of a server. -
- Sets client workgroup or domain -
- User name to use -
- IP address of target server to use. You have to - specify either this option or a target workgroup or - a target server. -
- Port on the target server to connect to (usually 139 or 445). - Defaults to trying 445 first, then 139. -
This option allows you to override
-the NetBIOS name that Samba uses for itself. This is identical
-to setting the parameter in the smb.conf file.
-However, a command
-line setting will take precedence over settings in
-smb.conf.
The file specified contains the
-configuration details required by the server. The
-information in this file includes server-specific
-information such as what printcap file to use, as well
-as descriptions of all the services that the server is
-to provide. See smb.conf for more information.
-The default configuration file name is determined at
-compile time.
- Name of target server. You should specify either - this option or a target workgroup or a target IP address. -
- When listing data, give more information on each item. -
- Make queries to the external server using the machine account of the local server. -
debuglevel is an integer
-from 0 to 10. The default value if this parameter is
-not specified is zero.
The higher this value, the more detail will be -logged to the log files about the activities of the -server. At level 0, only critical errors and serious -warnings will be logged. Level 1 is a reasonable level for -day-to-day running - it generates a small amount of -information about operations carried out.
Levels above 1 will generate considerable -amounts of log data, and should only be used when -investigating a problem. Levels above 3 are designed for -use only by developers and generate HUGE amounts of log -data, most of which is extremely cryptic.
Note that specifying this parameter here will
-override the parameter
-in the smb.conf file.
This command allows the Samba machine account password to be set from an external application -to a machine account password that has already been stored in Active Directory. DO NOT USE this command -unless you know exactly what you are doing. The use of this command requires that the force flag (-f) -be used also. There will be NO command prompt. Whatever information is piped into stdin, either by -typing at the command line or otherwise, will be stored as the literal machine password. Do NOT use -this without care and attention as it will overwrite a legitimate machine password without warning. -YOU HAVE BEEN WARNED. -
The NET TIME command allows you to view the time on a remote server - or synchronise the time on the local server with the time on the remote server.
-Join a domain. If the account already exists on the server, and -[TYPE] is MEMBER, the machine will attempt to join automatically. -(Assuming that the machine has been created in server manager) -Otherwise, a password will be prompted for, and a new account may -be created.
-[TYPE] may be PDC, BDC or MEMBER to specify the type of server -joining the domain. -
Join a domain. Use the OLDJOIN option to join the domain -using the old style of domain joining - you need to create a trust -account in server manager first.
Enumerates all exported resources (network shares) on target server.
user [password]-Validate whether the specified user can log in to the -remote server. If the password is not specified on the commandline, it -will be prompted. -
Currently NOT implemented.
commandExecute the specified command on
-the remote server. Only works with OS/2 servers.
-
Currently NOT implemented.
Samba uses a general caching interface called 'gencache'. It -can be controlled using 'NET CACHE'.
All the timeout parameters support the suffixes: - -
| s - Seconds |
| m - Minutes |
| h - Hours |
| d - Days |
| w - Weeks |
- -
Print the SID of the specified domain, or if the parameter is -omitted, the SID of the domain the local server is in.
Manage the mappings between Windows group SIDs and UNIX groups. -Parameters take the for "parameter=value". Common options include:
unixgroup - Name of the UNIX group
ntgroup - Name of the Windows NT group (must be - resolvable to a SID
rid - Unsigned 32-bit integer
sid - Full SID in the form of "S-1-..."
type - Type of the group; either 'domain', 'local', - or 'builtin'
comment - Freeform text description of the group
-Add a new group mapping entry: -
-net groupmap add {rid=int|sid=string} unixgroup=string \
- [type={domain|local}] [ntgroup=string] [comment=string]
--
Delete a group mapping entry. If more then one group name matches, the first entry found is deleted.
net groupmap delete {ntgroup=string|sid=SID}
Prints out the highest RID currently in use on the local -server (by the active 'passdb backend'). -
Print information about the domain of the remote server, -such as domain name, domain sid and number of users and groups. -
DOMAIMRemove interdomain trust account for
-DOMAIN from the remote server.
-
Currently NOT implemented.
Shut down the remote server.
-Reboot after shutdown. -
-Force shutting down all applications. -
-Timeout before system will be shut down. An interactive -user of the system can use this time to cancel the shutdown. -
Display the specified message on the screen to -announce the shutdown.
Export users, aliases and groups from remote server to -local server. Can only be run an a BDC. -
Print out status of machine account of the local machine in ADS. -Prints out quite some debug info. Aimed at developers, regular -users should use NET ADS TESTJOIN.
EXPRESSION ATTRIBUTES...Perform a raw LDAP search on a ADS server and dump the results. The -expression is a standard LDAP search expression, and the -attributes are a list of LDAP fields to show in the results.
Example: net ads search '(objectCategory=group)' sAMAccountName
-
nmbd — NetBIOS name server to provide NetBIOS - over IP naming services to clients
nmbd [-D] [-F] [-S] [-a] [-i] [-o] [-h] [-V] [-d <debug level>] [-H <lmhosts file>] [-l <log directory>] [-p <port number>] [-s <configuration file>]
This program is part of the samba(7) suite.
nmbd is a server that understands - and can reply to NetBIOS over IP name service requests, like - those produced by SMB/CIFS clients such as Windows 95/98/ME, - Windows NT, Windows 2000, Windows XP and LanManager clients. It also - participates in the browsing protocols which make up the - Windows "Network Neighborhood" view.
SMB/CIFS clients, when they start up, may wish to - locate an SMB/CIFS server. That is, they wish to know what - IP number a specified host is using.
Amongst other services, nmbd will
- listen for such requests, and if its own NetBIOS name is
- specified it will respond with the IP number of the host it
- is running on. Its "own NetBIOS name" is by
- default the primary DNS name of the host it is running on,
- but this can be overridden by the netbios name
- in smb.conf. Thus nmbd will
- reply to broadcast queries for its own name(s). Additional
- names for nmbd to respond on can be set
- via parameters in the smb.conf(5) configuration file.
nmbd can also be used as a WINS - (Windows Internet Name Server) server. What this basically means - is that it will act as a WINS database server, creating a - database from name registration requests that it receives and - replying to queries from clients for these names.
In addition, nmbd can act as a WINS - proxy, relaying broadcast queries from clients that do - not understand how to talk the WINS protocol to a WINS - server.
If specified, this parameter causes - nmbd to operate as a daemon. That is, - it detaches itself and runs in the background, fielding - requests on the appropriate port. By default, nmbd - will operate as a daemon if launched from a command shell. - nmbd can also be operated from the inetd - meta-daemon, although this is not recommended. -
If specified, this parameter causes - the main nmbd process to not daemonize, - i.e. double-fork and disassociate with the terminal. - Child processes are still created as normal to service - each connection request, but the main process does not - exit. This operation mode is suitable for running - nmbd under process supervisors such - as supervise and svscan - from Daniel J. Bernstein's daemontools - package, or the AIX process monitor. -
If specified, this parameter causes - nmbd to log to standard output rather - than a file.
If this parameter is specified it causes the
- server to run "interactively", not as a daemon, even if the
- server is executed on the command line of a shell. Setting this
- parameter negates the implicit daemon mode when run from the
- command line. nmbd also logs to standard
- output, as if the -S parameter had been
- given.
Print a summary of command line options. -
NetBIOS lmhosts file. The lmhosts - file is a list of NetBIOS names to IP addresses that - is loaded by the nmbd server and used via the name - resolution mechanism name resolve order described in smb.conf(5) to resolve any - NetBIOS name queries needed by the server. Note - that the contents of this file are NOT - used by nmbd to answer any name queries. - Adding a line to this file affects name NetBIOS resolution - from this host ONLY.
The default path to this file is compiled into
- Samba as part of the build process. Common defaults
- are /usr/local/samba/lib/lmhosts,
- /usr/samba/lib/lmhosts or
- /etc/samba/lmhosts. See the lmhosts(5) man page for details on the contents of this file.
Prints the program version number. -
The file specified contains the
-configuration details required by the server. The
-information in this file includes server-specific
-information such as what printcap file to use, as well
-as descriptions of all the services that the server is
-to provide. See smb.conf for more information.
-The default configuration file name is determined at
-compile time.
debuglevel is an integer
-from 0 to 10. The default value if this parameter is
-not specified is zero.
The higher this value, the more detail will be -logged to the log files about the activities of the -server. At level 0, only critical errors and serious -warnings will be logged. Level 1 is a reasonable level for -day-to-day running - it generates a small amount of -information about operations carried out.
Levels above 1 will generate considerable -amounts of log data, and should only be used when -investigating a problem. Levels above 3 are designed for -use only by developers and generate HUGE amounts of log -data, most of which is extremely cryptic.
Note that specifying this parameter here will
-override the parameter
-in the smb.conf file.
Base directory name for log/debug files. The extension
-".progname" will be appended (e.g. log.smbclient,
-log.smbd, etc...). The log file is never removed by the client.
-
UDP port number is a positive integer value. - This option changes the default UDP port number (normally 137) - that nmbd responds to name queries on. Don't - use this option unless you are an expert, in which case you - won't need help!
/etc/inetd.confIf the server is to be run by the - inetd meta-daemon, this file - must contain suitable startup information for the - meta-daemon. -
/etc/rcor whatever initialization script your - system uses).
If running the server as a daemon at startup, - this file will need to contain an appropriate startup - sequence for the server.
/etc/servicesIf running the server via the - meta-daemon inetd, this file - must contain a mapping of service name (e.g., netbios-ssn) - to service port (e.g., 139) and protocol type (e.g., tcp). -
/usr/local/samba/lib/smb.confThis is the default location of
- the smb.conf(5) server
- configuration file. Other common places that systems
- install this file are /usr/samba/lib/smb.conf
- and /etc/samba/smb.conf.
When run as a WINS server (see the
- wins support
- parameter in the smb.conf(5) man page),
- nmbd
- will store the WINS database in the file wins.dat
- in the var/locks directory configured under
- wherever Samba was configured to install itself.
If nmbd is acting as a
- browse master (see the local master
- parameter in the smb.conf(5) man page, nmbd
- will store the browsing database in the file browse.dat
- in the var/locks directory
- configured under wherever Samba was configured to install itself.
-
To shut down an nmbd process it is recommended - that SIGKILL (-9) NOT be used, except as a last - resort, as this may leave the name database in an inconsistent state. - The correct way to terminate nmbd is to send it - a SIGTERM (-15) signal and wait for it to die on its own.
nmbd will accept SIGHUP, which will cause
- it to dump out its namelists into the file namelist.debug
- in the /usr/local/samba/var/locks
- directory (or the var/locks directory configured
- under wherever Samba was configured to install itself). This will also
- cause nmbd to dump out its server database in
- the log.nmb file.
The debug log level of nmbd may be raised or lowered - using smbcontrol(1) (SIGUSR[1|2] signals - are no longer used since Samba 2.2). This is to allow - transient problems to be diagnosed, whilst still running - at a normally low log level.
- inetd(8), smbd(8), smb.conf(5), smbclient(1), testparm(1), testprns(1), and the Internet
- RFC's rfc1001.txt, rfc1002.txt.
- In addition the CIFS (formerly SMB) specification is available
- as a link from the Web page
- http://samba.org/cifs/.
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.
nmblookup — NetBIOS over TCP/IP client used to lookup NetBIOS - names
nmblookup [-M] [-R] [-S] [-r] [-A] [-h] [-B <broadcast address>] [-U <unicast address>] [-d <debug level>] [-s <smb config file>] [-i <NetBIOS scope>] [-T] [-f] {name}
This tool is part of the samba(7) suite.
nmblookup is used to query NetBIOS names - and map them to IP addresses in a network using NetBIOS over TCP/IP - queries. The options allow the name queries to be directed at a - particular IP broadcast area or to a particular machine. All queries - are done over UDP.
Searches for a master browser by looking
- up the NetBIOS name name with a
- type of 0x1d. If
- name is "-" then it does a lookup on the special name
- __MSBROWSE__. Please note that in order to
- use the name "-", you need to make sure "-" isn't parsed as an
- argument, e.g. use :
- nmblookup -M -- -.
Set the recursion desired bit in the packet - to do a recursive lookup. This is used when sending a name - query to a machine running a WINS server and the user wishes - to query the names in the WINS server. If this bit is unset - the normal (broadcast responding) NetBIOS processing code - on a machine is used instead. See RFC1001, RFC1002 for details. -
Once the name query has returned an IP - address then do a node status query as well. A node status - query returns the NetBIOS names registered by a host. -
Try and bind to UDP port 137 to send and receive UDP - datagrams. The reason for this option is a bug in Windows 95 - where it ignores the source port of the requesting packet - and only replies to UDP port 137. Unfortunately, on most UNIX - systems root privilege is needed to bind to this port, and - in addition, if the nmbd(8) daemon is running on this machine it also binds to this port. -
Interpret name as
- an IP Address and do a node status query on this address.
This option allows you to override
-the NetBIOS name that Samba uses for itself. This is identical
-to setting the parameter in the smb.conf file.
-However, a command
-line setting will take precedence over settings in
-smb.conf.
This specifies a NetBIOS scope that -nmblookup will use to communicate with when -generating NetBIOS names. For details on the use of NetBIOS -scopes, see rfc1001.txt and rfc1002.txt. NetBIOS scopes are -very rarely used, only set this parameter -if you are the system administrator in charge of all the -NetBIOS systems you communicate with.
Set the SMB domain of the username. This -overrides the default domain which is the domain defined in -smb.conf. If the domain specified is the same as the servers -NetBIOS name, it causes the client to log on using the servers local -SAM (as opposed to the Domain SAM).
TCP socket options to set on the client
-socket. See the socket options parameter in
-the smb.conf manual page for the list of valid
-options.
Print a summary of command line options. -
Send the query to the given broadcast address. Without
- this option the default behavior of nmblookup is to send the
- query to the broadcast address of the network interfaces as
- either auto-detected or defined in the interfaces
- parameter of the smb.conf(5) file.
-
Do a unicast query to the specified address or
- host unicast address. This option
- (along with the -R option) is needed to
- query a WINS server.
Prints the program version number. -
The file specified contains the
-configuration details required by the server. The
-information in this file includes server-specific
-information such as what printcap file to use, as well
-as descriptions of all the services that the server is
-to provide. See smb.conf for more information.
-The default configuration file name is determined at
-compile time.
debuglevel is an integer
-from 0 to 10. The default value if this parameter is
-not specified is zero.
The higher this value, the more detail will be -logged to the log files about the activities of the -server. At level 0, only critical errors and serious -warnings will be logged. Level 1 is a reasonable level for -day-to-day running - it generates a small amount of -information about operations carried out.
Levels above 1 will generate considerable -amounts of log data, and should only be used when -investigating a problem. Levels above 3 are designed for -use only by developers and generate HUGE amounts of log -data, most of which is extremely cryptic.
Note that specifying this parameter here will
-override the parameter
-in the smb.conf file.
Base directory name for log/debug files. The extension
-".progname" will be appended (e.g. log.smbclient,
-log.smbd, etc...). The log file is never removed by the client.
-
This causes any IP addresses found in the - lookup to be looked up via a reverse DNS lookup into a - DNS name, and printed out before each
IP address .... NetBIOS name
pair that is the normal output.
- Show which flags apply to the name that has been looked up. Possible - answers are zero or more of: Response, Authoritative, - Truncated, Recursion_Desired, Recursion_Available, Broadcast. -
This is the NetBIOS name being queried. Depending - upon the previous options this may be a NetBIOS name or IP address. - If a NetBIOS name then the different name types may be specified - by appending '#<type>' to the name. This name may also be - '*', which will return all registered names within a broadcast - area.
nmblookup can be used to query - a WINS server (in the same way nslookup is - used to query DNS servers). To query a WINS server, nmblookup - must be called like this:
nmblookup -U server -R 'name'
For example, running :
nmblookup -U samba.org -R 'IRIX#1B'
would query the WINS server samba.org for the domain - master browser (1B name type) for the IRIX workgroup.
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.
ntlm_auth — tool to allow external access to Winbind's NTLM authentication function
ntlm_auth [-d debuglevel] [-l logdir] [-s <smb config file>]
This tool is part of the samba(7) suite.
ntlm_auth is a helper utility that authenticates - users using NT/LM authentication. It returns 0 if the users is authenticated - successfully and 1 if access was denied. ntlm_auth uses winbind to access - the user and authentication data for a domain. This utility - is only indended to be used by other programs (currently - Squid - and mod_ntlm_winbind) -
- The winbindd(8) daemon must be operational - for many of these commands to function.
Some of these commands also require access to the directory
- winbindd_privileged in
- $LOCKDIR. This should be done either by running
- this command as root or providing group access
- to the winbindd_privileged directory. For
- security reasons, this directory should not be world-accessable.
- Operate as a stdio-based helper. Valid helper protocols are: -
- Server-side helper for use with Squid 2.4's basic (plaintext) - authentication.
- Server-side helper for use with Squid 2.5's basic (plaintext) - authentication.
- Server-side helper for use with Squid 2.5's NTLMSSP - authentication.
Requires access to the directory
- winbindd_privileged in
- $LOCKDIR. The protocol used is
- described here: http://devel.squid-cache.org/ntlm/squid_helper_protocol.html.
- This protocol has been extended to allow the
- NTLMSSP Negotiate packet to be included as an argument
- to the YR command. (Thus avoiding
- loss of information in the protocol exchange).
-
- Client-side helper for use with arbitary external - programs that may wish to use Samba's NTLMSSP - authentication knowlege.
This helper is a client, and as such may be run by any - user. The protocol used is - effectivly the reverse of the previous protocol. A - YR command (without any arguments) - starts the authentication exchange. -
- Server-side helper that implements GSS-SPNEGO. This - uses a protocol that is almost the same as - squid-2.5-ntlmssp, but has some - subtle differences that are undocumented outside the - source at this stage. -
Requires access to the directory
- winbindd_privileged in
- $LOCKDIR.
-
- Client-side helper that implements GSS-SPNEGO. This - also uses a protocol similar to the above helpers, but - is currently undocumented. -
- Server-side helper protocol, intended for use by a - RADIUS server or the 'winbind' plugin for pppd, for - the provision of MSCHAP and MSCHAPv2 authentication. -
This protocol consists of lines in for form: - Parameter: value and Paramter:: - Base64-encode value. The presence of a single - period . indicates that one side has - finished supplying data to the other. (Which in turn - could cause the helper to authenticate the - user).
Curently implemented parameters from the - external program to the helper are:
The user's domain, expected to be in - Samba's unix charset. -
The fully qualified username, expected to be in - Samba's and qualified with the - winbind separator. -
The 8 byte LANMAN Challenge value, - generated randomly by the server, or (in cases such as - MSCHAPv2) generated in some way by both the server and - the client. -
The 24 byte LANMAN Response value, - calculated from the user's password and the supplied - LANMAN Challenge. Typically, this - is provided over the network by a client wishing to authenticate. -
The >= 24 byte NT Response - calculated from the user's password and the supplied - LANMAN Challenge. Typically, this is - provided over the network by a client wishing to authenticate. -
The user's password. This would be - provided by a network client, if the helper is being - used in a legacy situation that exposes plaintext - passwords in this way. -
Apon sucessful authenticaiton, return - the user session key associated with the login. -
Apon sucessful authenticaiton, return - the LANMAN session key associated with the login. -
- Specify username of user to authenticate -
- Specify domain of user to authenticate -
- Specify the workstation the user authenticated from -
NTLM challenge (in HEXADECIMAL)
LM Response to the challenge (in HEXADECIMAL)
NT or NTLMv2 Response to the challenge (in HEXADECIMAL)
User's plaintext password
If - not specified on the command line, this is prompted for when - required.
For the NTLMSSP based server roles, this paramter - specifies the expected password, allowing testing without - winbindd operational.
Retreive LM session key
Request NT key
Perform Diagnostics on the authentication - chain. Uses the password from --password - or prompts for one.
Require that a user be a member of specified - group (either name or SID) for authentication to succeed.
Prints the program version number. -
The file specified contains the
-configuration details required by the server. The
-information in this file includes server-specific
-information such as what printcap file to use, as well
-as descriptions of all the services that the server is
-to provide. See smb.conf for more information.
-The default configuration file name is determined at
-compile time.
debuglevel is an integer
-from 0 to 10. The default value if this parameter is
-not specified is zero.
The higher this value, the more detail will be -logged to the log files about the activities of the -server. At level 0, only critical errors and serious -warnings will be logged. Level 1 is a reasonable level for -day-to-day running - it generates a small amount of -information about operations carried out.
Levels above 1 will generate considerable -amounts of log data, and should only be used when -investigating a problem. Levels above 3 are designed for -use only by developers and generate HUGE amounts of log -data, most of which is extremely cryptic.
Note that specifying this parameter here will
-override the parameter
-in the smb.conf file.
Base directory name for log/debug files. The extension
-".progname" will be appended (e.g. log.smbclient,
-log.smbd, etc...). The log file is never removed by the client.
-
Print a summary of command line options. -
To setup ntlm_auth for use by squid 2.5, with both basic and
- NTLMSSP authentication, the following
- should be placed in the squid.conf file.
-
-auth_param ntlm program ntlm_auth --helper-protocol=squid-2.5-ntlmssp -auth_param basic program ntlm_auth --helper-protocol=squid-2.5-basic -auth_param basic children 5 -auth_param basic realm Squid proxy-caching web server -auth_param basic credentialsttl 2 hours -
This example assumes that ntlm_auth has been installed into your
- path, and that the group permissions on
- winbindd_privileged are as described above.
To setup ntlm_auth for use by squid 2.5 with group limitation in addition to the above
- example, the following should be added to the squid.conf file.
-
-auth_param ntlm program ntlm_auth --helper-protocol=squid-2.5-ntlmssp --require-membership-of='WORKGROUP\Domain Users' -auth_param basic program ntlm_auth --helper-protocol=squid-2.5-basic --require-membership-of='WORKGROUP\Domain Users' -
If you're experiencing problems with authenticating Internet Explorer running - under MS Windows 9X or Millenium Edition against ntlm_auth's NTLMSSP authentication - helper (--helper-protocol=squid-2.5-ntlmssp), then please read - - the Microsoft Knowledge Base article #239869 and follow instructions described there. -
pam_winbind — PAM module for Winbind
This tool is part of the samba(7) suite.
pam_winbind is a PAM module that can authenticate users against the local domain - by talking to the Winbind daemon.
- pam_winbind supports several options: -
Gives debugging output to syslog.
- If this option is set, pam_winbind will only succeed if the
- user is a member of the given SID or NAME. A SID can be either a group-SID, a
- alias-SID or even a user-SID. It is also possible to give a NAME instead of the
- SID. That name must have the form: MYDOMAIN\mygroup or
- MYDOMAIN\myuser. pam_winbind will, in that case, lookup
- the SID internally. Note that NAME may not contain any spaces. It is thus
- recommended to only use SIDs. You can verify the list of SIDs a user is a member
- of with wbinfo --user-sids=SID.
-
- By default, pam_winbind tries to get the - authentication token from a previous module. If no token is available it asks the user - for the old password. With this option, pam_winbind aborts with an - error if no authentication token from a previous module is available. -
- Set the new password to the one provided by the previously - stacked password module. If this option is not set pam_winbind will ask the - user for the new password. -
- - -
pdbedit — manage the SAM database (Database of Samba Users)
pdbedit [-L] [-v] [-w] [-u username] [-f fullname] [-h homedir] [-D drive] [-S script] [-p profile] [-a] [-m] [-r] [-x] [-i passdb-backend] [-e passdb-backend] [-b passdb-backend] [-g] [-d debuglevel] [-s configfile] [-P account-policy] [-C value] [-c account-control]
This tool is part of the samba(7) suite.
The pdbedit program is used to manage the users accounts - stored in the sam database and can only be run by root.
The pdbedit tool uses the passdb modular interface and is - independent from the kind of users database used (currently there - are smbpasswd, ldap, nis+ and tdb based and more can be added - without changing the tool).
There are five main ways to use pdbedit: adding a user account, - removing a user account, modifing a user account, listing user - accounts, importing users accounts.
This option lists all the user accounts - present in the users database. - This option prints a list of user/uid pairs separated by - the ':' character.
Example: pdbedit -L
-sorce:500:Simo Sorce -samba:45:Test User -
This option enables the verbose listing format. - It causes pdbedit to list the users in the database, printing - out the account fields in a descriptive format.
Example: pdbedit -L -v
---------------- -username: sorce -user ID/Group: 500/500 -user RID/GRID: 2000/2001 -Full Name: Simo Sorce -Home Directory: \\BERSERKER\sorce -HomeDir Drive: H: -Logon Script: \\BERSERKER\netlogon\sorce.bat -Profile Path: \\BERSERKER\profile ---------------- -username: samba -user ID/Group: 45/45 -user RID/GRID: 1090/1091 -Full Name: Test User -Home Directory: \\BERSERKER\samba -HomeDir Drive: -Logon Script: -Profile Path: \\BERSERKER\profile -
This option sets the "smbpasswd" listing format.
- It will make pdbedit list the users in the database, printing
- out the account fields in a format compatible with the
- smbpasswd file format. (see the
- smbpasswd(5) for details)
Example: pdbedit -L -w
-sorce:500:508818B733CE64BEAAD3B435B51404EE: - D2A2418EFC466A8A0F6B1DBB5C3DB80C: - [UX ]:LCT-00000000: -samba:45:0F2B255F7B67A7A9AAD3B435B51404EE: - BC281CE3F53B6A5146629CD4751D3490: - [UX ]:LCT-3BFA1E8D: -
This option specifies the username to be - used for the operation requested (listing, adding, removing). - It is required in add, remove and modify - operations and optional in list - operations.
This option can be used while adding or - modifing a user account. It will specify the user's full - name.
Example: -f "Simo Sorce"
This option can be used while adding or - modifing a user account. It will specify the user's home - directory network path.
Example: -h "\\\\BERSERKER\\sorce" -
This option can be used while adding or - modifing a user account. It will specify the windows drive - letter to be used to map the home directory.
Example: -d "H:" -
This option can be used while adding or - modifing a user account. It will specify the user's logon - script path.
Example: -S "\\\\BERSERKER\\netlogon\\sorce.bat" -
This option can be used while adding or - modifing a user account. It will specify the user's profile - directory.
Example: -p "\\\\BERSERKER\\netlogon" -
- This option can be used while adding or modifying a user account. It - will specify the users' new primary group SID (Security Identifier) or - rid.
Example: -G S-1-5-21-2447931902-1787058256-3961074038-1201
- This option can be used while adding or modifying a user account. It - will specify the users' new SID (Security Identifier) or - rid.
Example: -U S-1-5-21-2447931902-1787058256-3961074038-5004
This option can be used while adding or modifying a user - account. It will specify the users' account control property. Possible flags are listed below. -
-
N: No password required
D: Account disabled
H: Home directory required
T: Temporary duplicate of other account
U: Regular user account
M: MNS logon user account
W: Workstation Trust Account
S: Server Trust Account
L: Automatic Locking
X: Password does not expire
I: Domain Trust Account
-
Example: -c "[X ]"
This option is used to add a user into the - database. This command needs a user name specified with - the -u switch. When adding a new user, pdbedit will also - ask for the password to be used.
Example: pdbedit -a -u sorce -
new password: -retype new password -
-
This option is used to modify an existing user - in the database. This command needs a user name specified with the -u - switch. Other options can be specified to modify the properties of - the specified user. This flag is kept for backwards compatibility, but - it is no longer necessary to specify it. -
This option may only be used in conjunction
- with the -a option. It will make
- pdbedit to add a machine trust account instead of a user
- account (-u username will provide the machine name).
Example: pdbedit -a -m -u w2k-wks -
This option causes pdbedit to delete an account - from the database. It needs a username specified with the - -u switch.
Example: pdbedit -x -u bob
Use a different passdb backend to retrieve users - than the one specified in smb.conf. Can be used to import data into - your local user database.
This option will ease migration from one passdb backend to - another.
Example: pdbedit -i smbpasswd:/etc/smbpasswd.old -
Exports all currently available users to the - specified password database backend.
This option will ease migration from one passdb backend to - another and will ease backing up.
Example: pdbedit -e smbpasswd:/root/samba-users.backup
If you specify -g,
- then -i in-backend -e out-backend
- applies to the group mapping instead of the user database.
This option will ease migration from one passdb backend to - another and will ease backing up.
Use a different default passdb backend.
Example: pdbedit -b xml:/root/pdb-backup.xml -l
Display an account policy
Valid policies are: minimum password age, reset count minutes, disconnect time, - user must logon to change password, password history, lockout duration, min password length, - maximum password age and bad lockout attempt.
Example: pdbedit -P "bad lockout attempt"
-account policy value for bad lockout attempt is 0 -
Sets an account policy to a specified value.
- This option may only be used in conjunction
- with the -P option.
-
Example: pdbedit -P "bad lockout attempt" -C 3
-account policy value for bad lockout attempt was 0 -account policy value for bad lockout attempt is now 3 -
Print a summary of command line options. -
Prints the program version number. -
The file specified contains the
-configuration details required by the server. The
-information in this file includes server-specific
-information such as what printcap file to use, as well
-as descriptions of all the services that the server is
-to provide. See smb.conf for more information.
-The default configuration file name is determined at
-compile time.
debuglevel is an integer
-from 0 to 10. The default value if this parameter is
-not specified is zero.
The higher this value, the more detail will be -logged to the log files about the activities of the -server. At level 0, only critical errors and serious -warnings will be logged. Level 1 is a reasonable level for -day-to-day running - it generates a small amount of -information about operations carried out.
Levels above 1 will generate considerable -amounts of log data, and should only be used when -investigating a problem. Levels above 3 are designed for -use only by developers and generate HUGE amounts of log -data, most of which is extremely cryptic.
Note that specifying this parameter here will
-override the parameter
-in the smb.conf file.
Base directory name for log/debug files. The extension
-".progname" will be appended (e.g. log.smbclient,
-log.smbd, etc...). The log file is never removed by the client.
-
profiles — A utility to report and change SIDs in registry files -
profiles [-v] [-c SID] [-n SID] {file}
This tool is part of the samba(7) suite.
profiles is a utility that - reports and changes SIDs in windows registry files. It currently only - supports NT. -
rpcclient — tool for executing client side - MS-RPC functions
rpcclient [-A authfile] [-c <command string>] [-d debuglevel] [-h] [-l logdir] [-N] [-s <smb config file>] [-U username[%password]] [-W workgroup] [-N] [-I destinationIP] {server}
This tool is part of the samba(7) suite.
rpcclient is a utility initially developed - to test MS-RPC functionality in Samba itself. It has undergone - several stages of development and stability. Many system administrators - have now written scripts around it to manage Windows NT clients from - their UNIX workstation.
NetBIOS name of Server to which to connect. - The server can be any SMB/CIFS server. The name is - resolved using the name resolve order line from smb.conf(5).
execute semicolon separated commands (listed - below))
IP address is the address of the server to connect to.
- It should be specified in standard "a.b.c.d" notation.
Normally the client would attempt to locate a named
- SMB/CIFS server by looking it up via the NetBIOS name resolution
- mechanism described above in the name resolve order
- parameter above. Using this parameter will force the client
- to assume that the server is on the machine with the specified IP
- address and the NetBIOS name component of the resource being
- connected to will be ignored.
There is no default for this parameter. If not supplied, - it will be determined automatically by the client as described - above.
Prints the program version number. -
The file specified contains the
-configuration details required by the server. The
-information in this file includes server-specific
-information such as what printcap file to use, as well
-as descriptions of all the services that the server is
-to provide. See smb.conf for more information.
-The default configuration file name is determined at
-compile time.
debuglevel is an integer
-from 0 to 10. The default value if this parameter is
-not specified is zero.
The higher this value, the more detail will be -logged to the log files about the activities of the -server. At level 0, only critical errors and serious -warnings will be logged. Level 1 is a reasonable level for -day-to-day running - it generates a small amount of -information about operations carried out.
Levels above 1 will generate considerable -amounts of log data, and should only be used when -investigating a problem. Levels above 3 are designed for -use only by developers and generate HUGE amounts of log -data, most of which is extremely cryptic.
Note that specifying this parameter here will
-override the parameter
-in the smb.conf file.
Base directory name for log/debug files. The extension
-".progname" will be appended (e.g. log.smbclient,
-log.smbd, etc...). The log file is never removed by the client.
-
If specified, this parameter suppresses the normal -password prompt from the client to the user. This is useful when -accessing a service that does not require a password.
Unless a password is specified on the command line or -this parameter is specified, the client will request a -password.
-Try to authenticate with kerberos. Only useful in -an Active Directory environment. -
This option allows -you to specify a file from which to read the username and -password used in the connection. The format of the file is -
-username = <value> -password = <value> -domain = <value> -
Make certain that the permissions on the file restrict -access from unwanted users.
Sets the SMB username or username and password.
If %password is not specified, the user will be prompted. The
-client will first check the USER environment variable, then the
-LOGNAME variable and if either exists, the
-string is uppercased. If these environmental variables are not
-found, the username GUEST is used.
A third option is to use a credentials file which
-contains the plaintext of the username and password. This
-option is mainly provided for scripts where the admin does not
-wish to pass the credentials on the command line or via environment
-variables. If this method is used, make certain that the permissions
-on the file restrict access from unwanted users. See the
--A for more details.
Be cautious about including passwords in scripts. Also, on -many systems the command line of a running process may be seen -via the ps command. To be safe always allow -rpcclient to prompt for a password and type -it in directly.
This option allows you to override
-the NetBIOS name that Samba uses for itself. This is identical
-to setting the parameter in the smb.conf file.
-However, a command
-line setting will take precedence over settings in
-smb.conf.
This specifies a NetBIOS scope that -nmblookup will use to communicate with when -generating NetBIOS names. For details on the use of NetBIOS -scopes, see rfc1001.txt and rfc1002.txt. NetBIOS scopes are -very rarely used, only set this parameter -if you are the system administrator in charge of all the -NetBIOS systems you communicate with.
Set the SMB domain of the username. This -overrides the default domain which is the domain defined in -smb.conf. If the domain specified is the same as the servers -NetBIOS name, it causes the client to log on using the servers local -SAM (as opposed to the Domain SAM).
TCP socket options to set on the client
-socket. See the socket options parameter in
-the smb.conf manual page for the list of valid
-options.
Print a summary of command line options. -
Query info policy
Resolve a list - of SIDs to usernames. -
Resolve a list - of usernames to SIDs. -
Enumerate trusted domains
Enumerate privileges
Get the privilege name
Enumerate the LSA SIDS
Enumerate the privileges of an SID
Enumerate the rights of an SID
Enumerate accounts with a right
Add rights to an account
Remove rights from an account
Get a privilege value given its name
Query LSA security object
Get Primary Domain Information
DFS
Query DFS support
Add a DFS share
Remove a DFS share
Query DFS share info
Enumerate dfs shares
Server query info
Enumerate shares
Enumerate open files
Fetch remote time of day
Query user info
Query group info
Query user groups
Query group membership
Query alias membership
Query display info
Query domain info
Enumerate domain users
Enumerate domain groups
Enumerate alias groups
Create domain user
Look up names
Look up names
Delete domain user
Query SAMR security object
Retrieve domain password info
Look up domain
- Execute an AddPrinterDriver() RPC to install the printer driver
- information on the server. Note that the driver files should
- already exist in the directory returned by
- getdriverdir. Possible values for
- arch are the same as those for
- the getdriverdir command.
- The config parameter is defined as
- follows:
-Long Printer Name:\ -Driver File Name:\ -Data File Name:\ -Config File Name:\ -Help File Name:\ -Language Monitor Name:\ -Default Data Type:\ -Comma Separated list of Files -
Any empty fields should be enter as the string "NULL".
Samba does not need to support the concept of Print Monitors - since these only apply to local printers whose driver can make - use of a bi-directional link for communication. This field should - be "NULL". On a remote NT print server, the Print Monitor for a - driver must already be installed prior to adding the driver or - else the RPC will fail.
The version parameter lets you
- specify the printer driver version number. If omitted, the
- default driver version for the specified architecture will
- be used. This option can be used to upload Windows 2000
- (version 3) printer drivers.
- Add a printer on the remote server. This printer
- will be automatically shared. Be aware that the printer driver
- must already be installed on the server (see adddriver)
- and the portmust be a valid port name (see
- enumports.
Delete the - specified printer driver for all architectures. This - does not delete the actual driver files from the server, - only the entry from the server's list of drivers. -
Delete the specified printer driver including driver files. - You can limit this action to a specific architecture and a specific version. - If no architecure is given, all driver files of that driver will be deleted. -
Enumerate all - printer setting data stored on the server. On Windows NT clients, - these values are stored in the registry, while Samba servers - store them in the printers TDB. This command corresponds - to the MS Platform SDK GetPrinterData() function (* This - command is currently unimplemented).
Enumerate printer data for a key
List the jobs and status of a given printer. - This command corresponds to the MS Platform SDK EnumJobs() - function
Enumerate - printer keys
- Executes an EnumPorts() call using the specified - info level. Currently only info levels 1 and 2 are supported. -
- Execute an EnumPrinterDrivers() call. This lists the various installed - printer drivers for all architectures. Refer to the MS Platform SDK - documentation for more details of the various flags and calling - options. Currently supported info levels are 1, 2, and 3.
Execute an EnumPrinters() call. This lists the various installed - and share printers. Refer to the MS Platform SDK documentation for - more details of the various flags and calling options. Currently - supported info levels are 1, 2 and 5.
Retrieve the data for a given printer setting. See - the enumdata command for more information. - This command corresponds to the GetPrinterData() MS Platform - SDK function.
Get - printer driver data with - keyname
- Retrieve the printer driver information (such as driver file, - config file, dependent files, etc...) for - the given printer. This command corresponds to the GetPrinterDriver() - MS Platform SDK function. Currently info level 1, 2, and 3 are supported. -
- Execute a GetPrinterDriverDirectory()
- RPC to retrieve the SMB share name and subdirectory for
- storing printer driver files for a given architecture. Possible
- values for arch are "Windows 4.0"
- (for Windows 95/98), "Windows NT x86", "Windows NT PowerPC", "Windows
- Alpha_AXP", and "Windows NT R4000".
Retrieve the current printer information. This command - corresponds to the GetPrinter() MS Platform SDK function. -
Get - print processor - directory
Execute an OpenPrinterEx() and ClosePrinter() RPC - against a given printer.
Execute a SetPrinter() command to update the printer driver - associated with an installed printer. The printer driver must - already be correctly installed on the print server.
See also the enumprinters and - enumdrivers commands for obtaining a list of - of installed printers and drivers.
Add form
Set form
Get form
Delete form
Enumerate form
Set printer comment
Set REG_SZ printer data
Set printer name
Rffpcnex test
rpcclient is designed as a developer testing tool - and may not be robust in certain areas (such as command line parsing). - It has been known to generate a core dump upon failures when invalid - parameters where passed to the interpreter.
From Luke Leighton's original rpcclient man page:
WARNING! The MSRPC over SMB code has - been developed from examining Network traces. No documentation is - available from the original creators (Microsoft) on how MSRPC over - SMB works, or how the individual MSRPC services work. Microsoft's - implementation of these services has been demonstrated (and reported) - to be... a bit flaky in places.
The development of Samba's implementation is also a bit rough, - and as more of the services are understood, it can even result in - versions of smbd(8) and rpcclient(1) that are incompatible for some commands or services. Additionally, - the developers are sending reports to Microsoft, and problems found - or reported to Microsoft are fixed in Service Packs, which may - result in incompatibilities.
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 rpcclient man page was written by Matthew - Geddes, Luke Kenneth Casson Leighton, and rewritten by Gerald Carter. - 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.
samba — A Windows SMB/CIFS fileserver for UNIX
samba
The Samba software suite is a collection of programs - that implements the Server Message Block (commonly abbreviated - as SMB) protocol for UNIX systems. This protocol is sometimes - also referred to as the Common Internet File System (CIFS). For a - more thorough description, see - http://www.ubiqx.org/cifs/. Samba also implements the NetBIOS - protocol in nmbd.
The smbd daemon provides the file and print services to - SMB clients, such as Windows 95/98, Windows NT, Windows - for Workgroups or LanManager. The configuration file - for this daemon is described in smb.conf(5) -
The nmbd - daemon provides NetBIOS nameservice and browsing - support. The configuration file for this daemon - is described in smb.conf(5)
The smbclient - program implements a simple ftp-like client. This - is useful for accessing SMB shares on other compatible - servers (such as Windows NT), and can also be used - to allow a UNIX box to print to a printer attached to - any SMB server (such as a PC running Windows NT).
The testparm - utility is a simple syntax checker for Samba's smb.conf(5) configuration file.
The testprns
- utility supports testing printer names defined
- in your printcap file used
- by Samba.
The smbstatus - tool provides access to information about the - current connections to smbd.
The nmblookup - tools allows NetBIOS name queries to be made - from a UNIX host.
The smbpasswd - command is a tool for changing LanMan and Windows NT - password hashes on Samba and Windows NT servers.
The smbcacls command is - a tool to set ACL's on remote CIFS servers.
The smbsh command is - a program that allows you to run a unix shell with - with an overloaded VFS.
The smbtree command - is a text-based network neighborhood tool.
The smbtar can make - backups of data on CIFS/SMB servers.
smbspool is a - helper utility for printing on printers connected - to CIFS servers.
smbcontrol is a utility - that can change the behaviour of running samba daemons. -
rpcclient is a utility - that can be used to execute RPC commands on remote - CIFS servers.
The pdbedit command - can be used to maintain the local user database on - a samba server.
The findsmb command - can be used to find SMB servers on the local network. -
The net command - is supposed to work similar to the DOS/Windows - NET.EXE command.
swat is a web-based
- interface to configuring smb.conf.
-
winbindd is a daemon - that is used for integrating authentication and - the user database into unix.
wbinfo is a utility - that retrieves and stores information related to winbind. -
editreg is a command-line - utility that can edit windows registry files. -
profiles is a command-line - utility that can be used to replace all occurences of - a certain SID with another SID. -
log2pcap is a utility - for generating pcap trace files from Samba log - files.
vfstest is a utility - that can be used to test vfs modules.
ntlm_auth is a helper-utility - for external programs wanting to do NTLM-authentication. -
smbmount,smbumount and smbmnt are commands that can be used to - mount CIFS/SMB shares on Linux. -
smbcquotas is a tool that - can set remote QUOTA's on server with NTFS 5.
The Samba suite is made up of several components. Each - component is described in a separate manual page. It is strongly - recommended that you read the documentation that comes with Samba - and the manual pages of those components that you use. If the - manual pages and documents aren't clear enough then please visit - http://devel.samba.org - for information on how to file a bug report or submit a patch.
If you require help, visit the Samba webpage at - http://www.samba.org/ and - explore the many option available to you. -
The Samba software suite is licensed under the - GNU Public License(GPL). A copy of that license should - have come with the package in the file COPYING. You are - encouraged to distribute copies of the Samba suite, but - please obey the terms of this license.
The latest version of the Samba suite can be - obtained via anonymous ftp from samba.org in the - directory pub/samba/. It is also available on several - mirror sites worldwide.
You may also find useful information about Samba - on the newsgroup - comp.protocol.smb and the Samba mailing - list. Details on how to join the mailing list are given in - the README file that comes with Samba.
If you have access to a WWW viewer (such as Mozilla - or Konqueror) then you will also find lots of useful information, - including back issues of the Samba mailing list, at - http://lists.samba.org.
If you wish to contribute to the Samba project, - then I suggest you join the Samba mailing list at - http://lists.samba.org. -
If you have patches to submit, visit - http://devel.samba.org/ - for information on how to do it properly. We prefer patches - in diff -u format.
Contributors to the project are now too numerous
- to mention here but all deserve the thanks of all Samba
- users. To see a full list, look at the
- change-log in the source package
- for the pre-CVS changes and at
- http://cvs.samba.org/
- for the contributors to Samba post-CVS. CVS is the Open Source
- source code control system used by the Samba Team to develop
- Samba. The project would have been unmanageable without it.
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.
smbcacls — Set or get ACLs on an NT file or directory names
smbcacls {//server/share} {filename} [-D acls] [-M acls] [-a acls] [-S acls] [-C name] [-G name] [--numeric] [-t] [-U username] [-h] [-d]
This tool is part of the samba(7) suite.
The smbcacls program manipulates NT Access Control - Lists (ACLs) on SMB file shares.
The following options are available to the smbcacls program. - The format of ACLs is described in the section ACL FORMAT
Add the ACLs specified to the ACL list. Existing - access control entries are unchanged.
Modify the mask value (permissions) for the ACLs - specified on the command line. An error will be printed for each - ACL specified that was not already present in the ACL list -
Delete any ACLs specified on the command line. - An error will be printed for each ACL specified that was not - already present in the ACL list.
This command sets the ACLs on the file with - only the ones specified on the command line. All other ACLs are - erased. Note that the ACL specified must contain at least a revision, - type, owner and group for the call to succeed.
Specifies a username used to connect to the - specified service. The username may be of the form "username" in - which case the user is prompted to enter in a password and the - workgroup specified in the smb.conf(5) file is - used, or "username%password" or "DOMAIN\username%password" and the - password and workgroup names are used as provided.
The owner of a file or directory can be changed
- to the name given using the -C option.
- The name can be a sid in the form S-1-x-y-z or a name resolved
- against the server specified in the first argument.
This command is a shortcut for -M OWNER:name. -
The group owner of a file or directory can
- be changed to the name given using the -G
- option. The name can be a sid in the form S-1-x-y-z or a name
- resolved against the server specified n the first argument.
-
This command is a shortcut for -M GROUP:name.
This option displays all ACL information in numeric - format. The default is to convert SIDs to names and ACE types - and masks to a readable string format.
- Don't actually do anything, only validate the correctness of - the arguments. -
Print a summary of command line options. -
Prints the program version number. -
The file specified contains the
-configuration details required by the server. The
-information in this file includes server-specific
-information such as what printcap file to use, as well
-as descriptions of all the services that the server is
-to provide. See smb.conf for more information.
-The default configuration file name is determined at
-compile time.
debuglevel is an integer
-from 0 to 10. The default value if this parameter is
-not specified is zero.
The higher this value, the more detail will be -logged to the log files about the activities of the -server. At level 0, only critical errors and serious -warnings will be logged. Level 1 is a reasonable level for -day-to-day running - it generates a small amount of -information about operations carried out.
Levels above 1 will generate considerable -amounts of log data, and should only be used when -investigating a problem. Levels above 3 are designed for -use only by developers and generate HUGE amounts of log -data, most of which is extremely cryptic.
Note that specifying this parameter here will
-override the parameter
-in the smb.conf file.
Base directory name for log/debug files. The extension
-".progname" will be appended (e.g. log.smbclient,
-log.smbd, etc...). The log file is never removed by the client.
-
The format of an ACL is one or more ACL entries separated by - either commas or newlines. An ACL entry is one of the following:
-REVISION:<revision number> -OWNER:<sid or name> -GROUP:<sid or name> -ACL:<sid or name>:<type>/<flags>/<mask> -
The revision of the ACL specifies the internal Windows - NT ACL revision for the security descriptor. - If not specified it defaults to 1. Using values other than 1 may - cause strange behaviour.
The owner and group specify the owner and group sids for the - object. If a SID in the format S-1-x-y-z is specified this is used, - otherwise the name specified is resolved using the server on which - the file or directory resides.
ACLs specify permissions granted to the SID. This SID again - can be specified in S-1-x-y-z format or as a name in which case - it is resolved against the server on which the file or directory - resides. The type, flags and mask values determine the type of - access granted to the SID.
The type can be either 0 or 1 corresponding to ALLOWED or - DENIED access to the SID. The flags values are generally - zero for file ACLs and either 9 or 2 for directory ACLs. Some - common flags are:
#define SEC_ACE_FLAG_OBJECT_INHERIT 0x1
#define SEC_ACE_FLAG_CONTAINER_INHERIT 0x2
#define SEC_ACE_FLAG_NO_PROPAGATE_INHERIT 0x4
#define SEC_ACE_FLAG_INHERIT_ONLY 0x8
At present flags can only be specified as decimal or - hexadecimal values.
The mask is a value which expresses the access right - granted to the SID. It can be given as a decimal or hexadecimal value, - or by using one of the following text strings which map to the NT - file permissions of the same name.
R - Allow read access
W - Allow write access
X - Execute permission on the object
D - Delete the object
P - Change permissions
O - Take ownership
The following combined permissions can be specified:
READ - Equivalent to 'RX' - permissions
CHANGE - Equivalent to 'RXWD' permissions -
FULL - Equivalent to 'RWXDPO' - permissions
The smbcacls program sets the exit status - depending on the success or otherwise of the operations performed. - The exit status may be one of the following values.
If the operation succeeded, smbcacls returns and exit - status of 0. If smbcacls couldn't connect to the specified server, - or there was an error getting or setting the ACLs, an exit status - of 1 is returned. If there was an error parsing any command line - arguments, an exit status of 2 is returned.
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.
smbcacls was written by Andrew Tridgell - and Tim Potter.
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.
smbclient — ftp-like client to access SMB/CIFS resources - on servers
smbclient [-b <buffer size>] [-d debuglevel] [-L <netbios name>] [-U username] [-I destinationIP] [-M <netbios name>] [-m maxprotocol] [-A authfile] [-N] [-i scope] [-O <socket options>] [-p port] [-R <name resolve order>] [-s <smb config file>] [-k]
smbclient {servicename} [password] [-b <buffer size>] [-d debuglevel] [-D Directory] [-U username] [-W workgroup] [-M <netbios name>] [-m maxprotocol] [-A authfile] [-N] [-l logdir] [-I destinationIP] [-E] [-c <command string>] [-i scope] [-O <socket options>] [-p port] [-R <name resolve order>] [-s <smb config file>] [-T<c|x>IXFqgbNan] [-k]
This tool is part of the samba(7) suite.
smbclient is a client that can - 'talk' to an SMB/CIFS server. It offers an interface - similar to that of the ftp program (see ftp(1)). - Operations include things like getting files from the server - to the local machine, putting files from the local machine to - the server, retrieving directory information from the server - and so on.
servicename is the name of the service
- you want to use on the server. A service name takes the form
- //server/service where server
- is the NetBIOS name of the SMB/CIFS server
- offering the desired service and service
- is the name of the service offered. Thus to connect to
- the service "printer" on the SMB/CIFS server "smbserver",
- you would use the servicename //smbserver/printer
-
Note that the server name required is NOT necessarily - the IP (DNS) host name of the server ! The name required is - a NetBIOS server name, which may or may not be the - same as the IP hostname of the machine running the server. -
The server name is looked up according to either
- the -R parameter to smbclient or
- using the name resolve order parameter in
- the smb.conf(5) file,
- allowing an administrator to change the order and methods
- by which server names are looked up.
The password required to access the specified
- service on the specified server. If this parameter is
- supplied, the -N option (suppress
- password prompt) is assumed.
There is no default password. If no password is supplied
- on the command line (either by using this parameter or adding
- a password to the -U option (see
- below)) and the -N option is not
- specified, the client will prompt for a password, even if
- the desired service does not require one. (If no password is
- required, simply press ENTER to provide a null password.)
-
Note: Some servers (including OS/2 and Windows for - Workgroups) insist on an uppercase password. Lowercase - or mixed case passwords may be rejected by these servers. -
Be cautious about including passwords in scripts. -
This option is used by the programs in the Samba - suite to determine what naming services and in what order to resolve - host names to IP addresses. The option takes a space-separated - string of different 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 dependent, for instance on IRIX or Solaris this
- may be controlled by the /etc/nsswitch.conf
- file). Note that this method is only used if the NetBIOS name
- type being queried is the 0x20 (server) name type, otherwise
- it is ignored.
wins: Query a name with
- the IP address listed in the wins server
- parameter. If no WINS server has
- been specified this method will be ignored.
bcast: Do a broadcast on
- each of the known local interfaces listed in the
- interfaces
- parameter. This is the least reliable of the name resolution
- methods as it depends on the target host being on a locally
- connected subnet.
If this parameter is not set then the name resolve order - defined in the smb.conf(5) file parameter - (name resolve order) will be used.
The default order is lmhosts, host, wins, bcast and without
- this parameter or any entry in the name resolve order
- parameter of the smb.conf(5) file the name resolution
- methods will be attempted in this order.
This options allows you to send messages, using - the "WinPopup" protocol, to another computer. Once a connection is - established you then type your message, pressing ^D (control-D) to - end.
If the receiving computer is running WinPopup the user will - receive the message and probably a beep. If they are not running - WinPopup the message will be lost, and no error message will - occur.
The message is also automatically truncated if the message - is over 1600 bytes, as this is the limit of the protocol. -
One useful trick is to cat the message through
- smbclient. For example:
- cat mymessage.txt | smbclient -M FRED will
- send the message in the file mymessage.txt
- to the machine FRED.
You may also find the -U and
- -I options useful, as they allow you to
- control the FROM and TO parts of the message.
See the message command parameter in the smb.conf(5) for a description of how to handle incoming
- WinPopup messages in Samba.
Note: Copy WinPopup into the startup group - on your WfWg PCs if you want them to always be able to receive - messages.
This number is the TCP port number that will be used - when making connections to the server. The standard (well-known) - TCP port number for an SMB/CIFS server is 139, which is the - default.
Print a summary of command line options. -
IP address is the address of the server to connect to.
- It should be specified in standard "a.b.c.d" notation.
Normally the client would attempt to locate a named
- SMB/CIFS server by looking it up via the NetBIOS name resolution
- mechanism described above in the name resolve order
- parameter above. Using this parameter will force the client
- to assume that the server is on the machine with the specified IP
- address and the NetBIOS name component of the resource being
- connected to will be ignored.
There is no default for this parameter. If not supplied, - it will be determined automatically by the client as described - above.
This parameter causes the client to write messages - to the standard error stream (stderr) rather than to the standard - output stream.
By default, the client writes messages to standard output - - typically the user's tty.
This option allows you to look at what services
- are available on a server. You use it as smbclient -L
- host and a list should appear. The -I
- option may be useful if your NetBIOS names don't
- match your TCP/IP DNS host names or if you are trying to reach a
- host on another network.
This option tells smbclient how to interpret - filenames coming from the remote server. Usually Asian language - multibyte UNIX implementations use different character sets than - SMB/CIFS servers (EUC instead of - SJIS for example). Setting this parameter will let - smbclient convert between the UNIX filenames and - the SMB filenames correctly. This option has not been seriously tested - and may have some problems.
The terminal codes include CWsjis, CWeuc, CWjis7, CWjis8, - CWjunet, CWhex, CWcap. This is not a complete list, check the Samba - source code for the complete list.
This option changes the transmit/send buffer - size when getting or putting a file from/to the server. The default - is 65520 bytes. Setting this value smaller (to 1200 bytes) has been - observed to speed up file transfers to and from a Win9x server. -
Prints the program version number. -
The file specified contains the
-configuration details required by the server. The
-information in this file includes server-specific
-information such as what printcap file to use, as well
-as descriptions of all the services that the server is
-to provide. See smb.conf for more information.
-The default configuration file name is determined at
-compile time.
debuglevel is an integer
-from 0 to 10. The default value if this parameter is
-not specified is zero.
The higher this value, the more detail will be -logged to the log files about the activities of the -server. At level 0, only critical errors and serious -warnings will be logged. Level 1 is a reasonable level for -day-to-day running - it generates a small amount of -information about operations carried out.
Levels above 1 will generate considerable -amounts of log data, and should only be used when -investigating a problem. Levels above 3 are designed for -use only by developers and generate HUGE amounts of log -data, most of which is extremely cryptic.
Note that specifying this parameter here will
-override the parameter
-in the smb.conf file.
Base directory name for log/debug files. The extension
-".progname" will be appended (e.g. log.smbclient,
-log.smbd, etc...). The log file is never removed by the client.
-
If specified, this parameter suppresses the normal -password prompt from the client to the user. This is useful when -accessing a service that does not require a password.
Unless a password is specified on the command line or -this parameter is specified, the client will request a -password.
-Try to authenticate with kerberos. Only useful in -an Active Directory environment. -
This option allows -you to specify a file from which to read the username and -password used in the connection. The format of the file is -
-username = <value> -password = <value> -domain = <value> -
Make certain that the permissions on the file restrict -access from unwanted users.
Sets the SMB username or username and password.
If %password is not specified, the user will be prompted. The
-client will first check the USER environment variable, then the
-LOGNAME variable and if either exists, the
-string is uppercased. If these environmental variables are not
-found, the username GUEST is used.
A third option is to use a credentials file which
-contains the plaintext of the username and password. This
-option is mainly provided for scripts where the admin does not
-wish to pass the credentials on the command line or via environment
-variables. If this method is used, make certain that the permissions
-on the file restrict access from unwanted users. See the
--A for more details.
Be cautious about including passwords in scripts. Also, on -many systems the command line of a running process may be seen -via the ps command. To be safe always allow -rpcclient to prompt for a password and type -it in directly.
This option allows you to override
-the NetBIOS name that Samba uses for itself. This is identical
-to setting the parameter in the smb.conf file.
-However, a command
-line setting will take precedence over settings in
-smb.conf.
This specifies a NetBIOS scope that -nmblookup will use to communicate with when -generating NetBIOS names. For details on the use of NetBIOS -scopes, see rfc1001.txt and rfc1002.txt. NetBIOS scopes are -very rarely used, only set this parameter -if you are the system administrator in charge of all the -NetBIOS systems you communicate with.
Set the SMB domain of the username. This -overrides the default domain which is the domain defined in -smb.conf. If the domain specified is the same as the servers -NetBIOS name, it causes the client to log on using the servers local -SAM (as opposed to the Domain SAM).
TCP socket options to set on the client
-socket. See the socket options parameter in
-the smb.conf manual page for the list of valid
-options.
smbclient may be used to create tar(1) - compatible backups of all the files on an SMB/CIFS - share. The secondary tar flags that can be given to this option - are :
c - Create a tar file on UNIX.
- Must be followed by the name of a tar file, tape device
- or "-" for standard output. If using standard output you must
- turn the log level to its lowest value -d0 to avoid corrupting
- your tar file. This flag is mutually exclusive with the
- x flag.
x - Extract (restore) a local
- tar file back to a share. Unless the -D option is given, the tar
- files will be restored from the top level of the share. Must be
- followed by the name of the tar file, device or "-" for standard
- input. Mutually exclusive with the c flag.
- Restored files have their creation times (mtime) set to the
- date saved in the tar file. Directories currently do not get
- their creation dates restored properly.
I - Include files and directories.
- Is the default behavior when filenames are specified above. Causes
- tar files to be included in an extract or create (and therefore
- everything else to be excluded). See example below. Filename globbing
- works in one of two ways. See r below.
X - Exclude files and directories.
- Causes tar files to be excluded from an extract or create. See
- example below. Filename globbing works in one of two ways now.
- See r below.
b - Blocksize. Must be followed
- by a valid (greater than zero) blocksize. Causes tar file to be
- written out in blocksize*TBLOCK (usually 512 byte) blocks.
-
g - Incremental. Only back up
- files that have the archive bit set. Useful only with the
- c flag.
q - Quiet. Keeps tar from printing
- diagnostics as it works. This is the same as tarmode quiet.
-
r - Regular expression include
- or exclude. Uses regular expression matching for
- excluding or excluding files if compiled with HAVE_REGEX_H.
- However this mode can be very slow. If not compiled with
- HAVE_REGEX_H, does a limited wildcard match on '*' and '?'.
-
N - Newer than. Must be followed
- by the name of a file whose date is compared against files found
- on the share during a create. Only files newer than the file
- specified are backed up to the tar file. Useful only with the
- c flag.
a - Set archive bit. Causes the
- archive bit to be reset when a file is backed up. Useful with the
- g and c flags.
-
Tar Long File Names
smbclient's tar option now supports long - file names both on backup and restore. However, the full path - name of the file must be less than 1024 bytes. Also, when - a tar archive is created, smbclient's tar option places all - files in the archive with relative names, not absolute names. -
Tar Filenames
All file names can be given as DOS path names (with '\\' - as the component separator) or as UNIX path names (with '/' as - the component separator).
Examples
Restore from tar file backup.tar into myshare on mypc
- (no password on share).
smbclient //mypc/yshare "" -N -Tx backup.tar -
Restore everything except users/docs
-
smbclient //mypc/myshare "" -N -TXx backup.tar - users/docs
Create a tar file of the files beneath
- users/docs.
smbclient //mypc/myshare "" -N -Tc - backup.tar users/docs
Create the same tar file as above, but now use - a DOS path name.
smbclient //mypc/myshare "" -N -tc backup.tar - users\edocs
Create a tar file of all the files and directories in - the share.
smbclient //mypc/myshare "" -N -Tc backup.tar * -
Change to initial directory before starting. Probably - only of any use with the tar -T option.
command string is a semicolon-separated list of
- commands to be executed instead of prompting from stdin.
- -N is implied by -c.
This is particularly useful in scripts and for printing stdin - to the server, e.g. -c 'print -'.
Once the client is running, the user is presented with - a prompt :
smb:\>
The backslash ("\\") indicates the current working directory - on the server, and will change if the current working directory - is changed.
The prompt indicates that the client is ready and waiting to - carry out a user command. Each command is a single word, optionally - followed by parameters specific to that command. Command and parameters - are space-delimited unless these notes specifically - state otherwise. All commands are case-insensitive. Parameters to - commands may or may not be case sensitive, depending on the command. -
You can specify file names which have spaces in them by quoting - the name with double quotes, for example "a long file name".
Parameters shown in square brackets (e.g., "[parameter]") are - optional. If not given, the command will use suitable defaults. Parameters - shown in angle brackets (e.g., "<parameter>") are required. -
Note that all commands operating on the server are actually - performed by issuing a request to the server. Thus the behavior may - vary from server to server, depending on how the server was implemented. -
The commands available are given here in alphabetical order.
If command is specified, the ? command will display
- a brief informative message about the specified command. If no
- command is specified, a list of available commands will
- be displayed.
If shell command is specified, the !
- command will execute a shell locally and run the specified shell
- command. If no command is specified, a local shell will be run.
-
The client will request that the server return - the "alternate" name (the 8.3 name) for a file or directory. -
Toggles the setting of the flag in SMB packets that - tells the server to treat filenames as case sensitive. Set to OFF by - default (tells file server to treat filenames as case insensitive). Only - currently affects Samba 3.0.5 and above file servers with the case sensitive - parameter set to auto in the smb.conf. -
The client will request that the server cancel - the printjobs identified by the given numeric print job ids. -
This command depends on the server supporting the CIFS - UNIX extensions and will fail if the server does not. The client requests that the server - change the UNIX permissions to the given octal mode, in standard UNIX format. -
This command depends on the server supporting the CIFS - UNIX extensions and will fail if the server does not. The client requests that the server - change the UNIX user and group ownership to the given decimal values. Note there is - currently no way to remotely look up the UNIX uid and gid values for a given name. - This may be addressed in future versions of the CIFS UNIX extensions. -
If "directory name" is specified, the current - working directory on the server will be changed to the directory - specified. This operation will fail if for any reason the specified - directory is inaccessible.
If no directory name is specified, the current working - directory on the server will be reported.
The client will request that the server attempt
- to delete all files matching mask from the current working
- directory on the server.
A list of the files matching mask in the current
- working directory on the server will be retrieved from the server
- and displayed.
Terminate the connection with the server and exit - from the program.
Copy the file called remote file name from
- the server to the machine running the client. If specified, name
- the local copy local file name. Note that all transfers in
- smbclient are binary. See also the
- lowercase command.
See the ? command above.
If directory name is specified, the current
- working directory on the local machine will be changed to
- the directory specified. This operation will fail if for any
- reason the specified directory is inaccessible.
If no directory name is specified, the name of the - current working directory on the local machine will be reported. -
This command depends on the server supporting the CIFS - UNIX extensions and will fail if the server does not. The client requests that the server - create a hard link between the linkname and target files. The linkname file - must not exist. -
Toggle lowercasing of filenames for the get and - mget commands.
When lowercasing is toggled ON, local filenames are converted - to lowercase when using the get and mget commands. This is - often useful when copying (say) MSDOS files from a server, because - lowercase filenames are the norm on UNIX systems.
See the dir command above.
This command allows the user to set up a mask - which will be used during recursive operation of the mget and - mput commands.
The masks specified to the mget and mput commands act as - filters for directories rather than files when recursion is - toggled ON.
The mask specified with the mask command is necessary - to filter files within those directories. For example, if the - mask specified in an mget command is "source*" and the mask - specified with the mask command is "*.c" and recursion is - toggled ON, the mget command will retrieve all files matching - "*.c" in all directories below and including all directories - matching "source*" in the current working directory.
Note that the value for mask defaults to blank (equivalent - to "*") and remains so until the mask command is used to change it. - It retains the most recently specified value indefinitely. To - avoid unexpected results it would be wise to change the value of - mask back to "*" after using the mget or mput commands.
See the mkdir command.
Copy all files matching mask from the server to
- the machine running the client.
Note that mask is interpreted differently during recursive
- operation and non-recursive operation - refer to the recurse and
- mask commands for more information. Note that all transfers in
- smbclient are binary. See also the lowercase command.
Create a new directory on the server (user access - privileges permitting) with the specified name.
Copy all files matching mask in the current working
- directory on the local machine to the current working directory on
- the server.
Note that mask is interpreted differently during recursive
- operation and non-recursive operation - refer to the recurse and mask
- commands for more information. Note that all transfers in smbclient
- are binary.
Print the specified file from the local machine - through a printable service on the server.
See also the printmode command.
Set the print mode to suit either binary data - (such as graphical information) or text. Subsequent print - commands will use the currently set print mode.
Toggle prompting for filenames during operation - of the mget and mput commands.
When toggled ON, the user will be prompted to confirm - the transfer of each file during these commands. When toggled - OFF, all specified files will be transferred without prompting. -
Copy the file called local file name from the
- machine running the client to the server. If specified,
- name the remote copy remote file name. Note that all transfers
- in smbclient are binary. See also the lowercase command.
-
Displays the print queue, showing the job id, - name, size and current status.
See the exit command.
See the rmdir command.
Toggle directory recursion for the commands mget - and mput.
When toggled ON, these commands will process all directories - in the source directory (i.e., the directory they are copying - from ) and will recurse into any that match the mask specified - to the command. Only files that match the mask specified using - the mask command will be retrieved. See also the mask command. -
When recursion is toggled OFF, only files from the current - working directory on the source machine that match the mask specified - to the mget or mput commands will be copied, and any mask specified - using the mask command will be ignored.
Remove all files matching mask from the current
- working directory on the server.
Remove the specified directory (user access - privileges permitting) from the server.
A version of the DOS attrib command to set - file permissions. For example:
setmode myfile +r
would make myfile read only.
This command depends on the server supporting the CIFS - UNIX extensions and will fail if the server does not. The client requests the - UNIX basic info level and prints out the same info that the Linux stat command - would about the file. This includes the size, blocks used on disk, file type, - permissions, inode number, number of links and finally the three timestamps - (access, modify and change). If the file is a special file (symlink, character or - block device, fifo or socket) then extra information may also be printed. -
This command depends on the server supporting the CIFS - UNIX extensions and will fail if the server does not. The client requests that the server - create a symbolic hard link between the target and linkname files. The linkname file - must not exist. Note that the server will not create a link to any path that lies - outside the currently connected share. This is enforced by the Samba server. -
Performs a tar operation - see the -T
- command line option above. Behavior may be affected
- by the tarmode command (see below). Using g (incremental) and N
- (newer) will affect tarmode settings. Note that using the "-" option
- with tar x may not work - use the command line option instead.
-
Blocksize. Must be followed by a valid (greater
- than zero) blocksize. Causes tar file to be written out in
- blocksize*TBLOCK (usually 512 byte) blocks.
Changes tar's behavior with regard to archive - bits. In full mode, tar will back up everything regardless of the - archive bit setting (this is the default mode). In incremental mode, - tar will only back up files with the archive bit set. In reset mode, - tar will reset the archive bit on all files it backs up (implies - read/write share).
Some servers are fussy about the case of supplied usernames, - passwords, share names (AKA service names) and machine names. - If you fail to connect try giving all parameters in uppercase. -
It is often necessary to use the -n option when connecting - to some types of servers. For example OS/2 LanManager insists - on a valid NetBIOS name being used, so you need to supply a valid - name that would be known to the server.
smbclient supports long file names where the server - supports the LANMAN2 protocol or above.
The variable USER may contain the
- username of the person using the client. This information is
- used only if the protocol level is high enough to support
- session-level passwords.
The variable PASSWD may contain
- the password of the person using the client. This information is
- used only if the protocol level is high enough to support
- session-level passwords.
The variable LIBSMB_PROG may contain
- the path, executed with system(), which the client should connect
- to instead of connecting to a server. This functionality is primarily
- intended as a development aid, and works best when using a LMHOSTS
- file
The location of the client program is a matter for - individual system administrators. The following are thus - suggestions only.
It is recommended that the smbclient software be installed
- in the /usr/local/samba/bin/ or
- /usr/samba/bin/ directory, this directory readable
- by all, writeable only by root. The client program itself should
- be executable by all. The client should NOT be
- setuid or setgid!
The client log files should be put in a directory readable - and writeable only by the user.
To test the client, you will need to know the name of a - running SMB/CIFS server. It is possible to run smbd(8) as an ordinary user - running that server as a daemon - on a user-accessible port (typically any port number over 1024) - would provide a suitable test server.
Most diagnostics issued by the client are logged in a - specified log file. The log file name is specified at compile time, - but may be overridden on the command line.
The number and nature of diagnostics available depends - on the debug level used by the client. If you have problems, - set the debug level to 3 and peruse the log files.
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.
smb.conf — The configuration file for the Samba suite
- The smb.conf file is a configuration file for the Samba suite. smb.conf contains runtime configuration information for the Samba programs. The
- smb.conf file is designed to be configured and administered by the
- swat(8) program. The
- complete description of the file format and possible parameters held within are here for reference purposes.
-
- The file consists of sections and parameters. A section begins with the name of the section in square brackets - and continues until the next section begins. Sections contain parameters of the form: -
-name=value-
-
- The file is line-based - that is, each newline-terminated line represents either a comment, a section name or - a parameter. -
Section and parameter names are not case sensitive.
- Only the first equals sign in a parameter is significant. Whitespace before or after the first equals sign is - discarded. Leading, trailing and internal whitespace in section and parameter names is irrelevant. Leading - and trailing whitespace in a parameter value is discarded. Internal whitespace within a parameter value is - retained verbatim. -
- Any line beginning with a semicolon (“;”) or a hash (“#”) - character is ignored, as are lines containing only whitespace. -
- Any line ending in a “\” is continued on the next line in the customary UNIX fashion. -
- The values following the equals sign in parameters are all either a string (no quotes needed) or a boolean, - which may be given as yes/no, 0/1 or true/false. Case is not significant in boolean values, but is preserved - in string values. Some items such as create masks are numeric. -
- Each section in the configuration file (except for the [global] section) describes a shared resource (known as - a “share”). The section name is the name of the shared resource and the parameters within the - section define the shares attributes. -
- There are three special sections, [global], [homes] and [printers], which are described under - special sections. The following notes apply to ordinary section descriptions. -
- A share consists of a directory to which access is being given plus a description of the access rights - which are granted to the user of the service. Some housekeeping options are also specifiable. -
- Sections are either file share services (used by the client as an extension of their native file systems) - or printable services (used by the client to access print services on the host running the server). -
- Sections may be designated guest services, in which case no password is required to - access them. A specified UNIX guest account is used to define access privileges in this - case. -
- Sections other than guest services will require a password to access them. The client provides the
- username. As older clients only provide passwords and not usernames, you may specify a list of usernames to
- check against the password using the user = option in the share definition. For modern clients
- such as Windows 95/98/ME/NT/2000, this should not be necessary.
-
- The access rights granted by the server are masked by the access rights granted to the specified or guest - UNIX user by the host system. The server does not grant more access than the host system grants. -
- The following sample section defines a file space share. The user has write access to the path /home/bar. The share is accessed via the share name foo:
-
[foo] |
path = /home/bar |
read only = read only = no |
- The following sample section defines a printable share. The share is read-only, but printable. That is, - the only write access permitted is via calls to open, write to and close a spool file. The guest - ok parameter means access will be permitted as the default guest user (specified elsewhere): -
[aprinter] |
path = /usr/spool/public |
read only = yes |
printable = yes |
guest ok = yes |
- Parameters in this section apply to the server as a whole, or are defaults for sections that do not - specifically define certain items. See the notes under PARAMETERS for more information. -
- If a section called [homes] is included in the configuration file, services connecting clients - to their home directories can be created on the fly by the server. -
- When the connection request is made, the existing sections are scanned. If a match is found, it is - used. If no match is found, the requested section name is treated as a username and looked up in the local - password file. If the name exists and the correct password has been given, a share is created by cloning the - [homes] section. -
- Some modifications are then made to the newly created share: -
- The share name is changed from homes to