From 31202ad025bcdeb2585d18dc3f4641b5cf9c0ec4 Mon Sep 17 00:00:00 2001 From: Ivo De Decker Date: Fri, 10 May 2013 13:33:02 +0200 Subject: Imported Upstream version 4.0.0+dfsg1 --- docs/htmldocs/manpages/eventlogadm.8.html | 128 - docs/htmldocs/manpages/findsmb.1.html | 62 - docs/htmldocs/manpages/idmap_ad.8.html | 54 - docs/htmldocs/manpages/idmap_adex.8.html | 43 - docs/htmldocs/manpages/idmap_autorid.8.html | 73 - docs/htmldocs/manpages/idmap_hash.8.html | 28 - docs/htmldocs/manpages/idmap_ldap.8.html | 67 - docs/htmldocs/manpages/idmap_nss.8.html | 22 - docs/htmldocs/manpages/idmap_rid.8.html | 69 - docs/htmldocs/manpages/idmap_tdb.8.html | 24 - docs/htmldocs/manpages/idmap_tdb2.8.html | 61 - docs/htmldocs/manpages/index.html | 99 - docs/htmldocs/manpages/libsmbclient.7.html | 59 - docs/htmldocs/manpages/lmhosts.5.html | 41 - docs/htmldocs/manpages/log2pcap.1.html | 29 - docs/htmldocs/manpages/net.8.html | 637 -- docs/htmldocs/manpages/nmbd.8.html | 147 - docs/htmldocs/manpages/nmblookup.1.html | 105 - docs/htmldocs/manpages/ntlm_auth.1.html | 157 - docs/htmldocs/manpages/pam_winbind.8.html | 103 - docs/htmldocs/manpages/pam_winbind.conf.5.html | 71 - docs/htmldocs/manpages/pdbedit.8.html | 170 - docs/htmldocs/manpages/profiles.1.html | 12 - docs/htmldocs/manpages/rpcclient.1.html | 211 - docs/htmldocs/manpages/samba.7.html | 113 - docs/htmldocs/manpages/sharesec.1.html | 82 - docs/htmldocs/manpages/smb.conf.5.html | 6976 -------------------- docs/htmldocs/manpages/smbcacls.1.html | 125 - docs/htmldocs/manpages/smbclient.1.html | 509 -- docs/htmldocs/manpages/smbcontrol.1.html | 83 - docs/htmldocs/manpages/smbcquotas.1.html | 88 - docs/htmldocs/manpages/smbd.8.html | 163 - docs/htmldocs/manpages/smbget.1.html | 26 - docs/htmldocs/manpages/smbgetrc.5.html | 17 - docs/htmldocs/manpages/smbpasswd.5.html | 91 - docs/htmldocs/manpages/smbpasswd.8.html | 171 - docs/htmldocs/manpages/smbspool.8.html | 36 - docs/htmldocs/manpages/smbstatus.1.html | 41 - docs/htmldocs/manpages/smbta-util.8.html | 25 - docs/htmldocs/manpages/smbtar.1.html | 39 - docs/htmldocs/manpages/smbtree.1.html | 76 - docs/htmldocs/manpages/swat.8.html | 88 - docs/htmldocs/manpages/tdbbackup.8.html | 36 - docs/htmldocs/manpages/tdbdump.8.html | 10 - docs/htmldocs/manpages/tdbtool.8.html | 68 - docs/htmldocs/manpages/testparm.1.html | 58 - docs/htmldocs/manpages/vfs_acl_tdb.8.html | 21 - docs/htmldocs/manpages/vfs_acl_xattr.8.html | 25 - docs/htmldocs/manpages/vfs_aio_fork.8.html | 25 - docs/htmldocs/manpages/vfs_aio_pthread.8.html | 42 - docs/htmldocs/manpages/vfs_audit.8.html | 19 - docs/htmldocs/manpages/vfs_cacheprime.8.html | 26 - docs/htmldocs/manpages/vfs_cap.8.html | 17 - docs/htmldocs/manpages/vfs_catia.8.html | 14 - docs/htmldocs/manpages/vfs_commit.8.html | 24 - docs/htmldocs/manpages/vfs_crossrename.8.html | 28 - docs/htmldocs/manpages/vfs_default_quota.8.html | 35 - docs/htmldocs/manpages/vfs_dirsort.8.html | 11 - docs/htmldocs/manpages/vfs_extd_audit.8.html | 14 - docs/htmldocs/manpages/vfs_fake_perms.8.html | 17 - docs/htmldocs/manpages/vfs_fileid.8.html | 32 - docs/htmldocs/manpages/vfs_full_audit.8.html | 45 - docs/htmldocs/manpages/vfs_gpfs.8.html | 121 - docs/htmldocs/manpages/vfs_netatalk.8.html | 15 - docs/htmldocs/manpages/vfs_notify_fam.8.html | 12 - docs/htmldocs/manpages/vfs_prealloc.8.html | 22 - docs/htmldocs/manpages/vfs_preopen.8.html | 28 - docs/htmldocs/manpages/vfs_readahead.8.html | 25 - docs/htmldocs/manpages/vfs_readonly.8.html | 24 - docs/htmldocs/manpages/vfs_recycle.8.html | 63 - docs/htmldocs/manpages/vfs_scannedonly.8.html | 90 - docs/htmldocs/manpages/vfs_shadow_copy.8.html | 32 - docs/htmldocs/manpages/vfs_shadow_copy2.8.html | 68 - .../manpages/vfs_smb_traffic_analyzer.8.html | 118 - docs/htmldocs/manpages/vfs_streams_depot.8.html | 15 - docs/htmldocs/manpages/vfs_streams_xattr.8.html | 17 - docs/htmldocs/manpages/vfs_time_audit.8.html | 21 - docs/htmldocs/manpages/vfs_xattr_tdb.8.html | 12 - docs/htmldocs/manpages/vfstest.1.html | 41 - docs/htmldocs/manpages/wbinfo.1.html | 117 - docs/htmldocs/manpages/winbind_krb5_locator.7.html | 43 - docs/htmldocs/manpages/winbindd.8.html | 239 - 82 files changed, 12911 deletions(-) delete mode 100644 docs/htmldocs/manpages/eventlogadm.8.html delete mode 100644 docs/htmldocs/manpages/findsmb.1.html delete mode 100644 docs/htmldocs/manpages/idmap_ad.8.html delete mode 100644 docs/htmldocs/manpages/idmap_adex.8.html delete mode 100644 docs/htmldocs/manpages/idmap_autorid.8.html delete mode 100644 docs/htmldocs/manpages/idmap_hash.8.html delete mode 100644 docs/htmldocs/manpages/idmap_ldap.8.html delete mode 100644 docs/htmldocs/manpages/idmap_nss.8.html delete mode 100644 docs/htmldocs/manpages/idmap_rid.8.html delete mode 100644 docs/htmldocs/manpages/idmap_tdb.8.html delete mode 100644 docs/htmldocs/manpages/idmap_tdb2.8.html delete mode 100644 docs/htmldocs/manpages/index.html delete mode 100644 docs/htmldocs/manpages/libsmbclient.7.html delete mode 100644 docs/htmldocs/manpages/lmhosts.5.html delete mode 100644 docs/htmldocs/manpages/log2pcap.1.html delete mode 100644 docs/htmldocs/manpages/net.8.html delete mode 100644 docs/htmldocs/manpages/nmbd.8.html delete mode 100644 docs/htmldocs/manpages/nmblookup.1.html delete mode 100644 docs/htmldocs/manpages/ntlm_auth.1.html delete mode 100644 docs/htmldocs/manpages/pam_winbind.8.html delete mode 100644 docs/htmldocs/manpages/pam_winbind.conf.5.html delete mode 100644 docs/htmldocs/manpages/pdbedit.8.html delete mode 100644 docs/htmldocs/manpages/profiles.1.html delete mode 100644 docs/htmldocs/manpages/rpcclient.1.html delete mode 100644 docs/htmldocs/manpages/samba.7.html delete mode 100644 docs/htmldocs/manpages/sharesec.1.html delete mode 100644 docs/htmldocs/manpages/smb.conf.5.html delete mode 100644 docs/htmldocs/manpages/smbcacls.1.html delete mode 100644 docs/htmldocs/manpages/smbclient.1.html delete mode 100644 docs/htmldocs/manpages/smbcontrol.1.html delete mode 100644 docs/htmldocs/manpages/smbcquotas.1.html delete mode 100644 docs/htmldocs/manpages/smbd.8.html delete mode 100644 docs/htmldocs/manpages/smbget.1.html delete mode 100644 docs/htmldocs/manpages/smbgetrc.5.html delete mode 100644 docs/htmldocs/manpages/smbpasswd.5.html delete mode 100644 docs/htmldocs/manpages/smbpasswd.8.html delete mode 100644 docs/htmldocs/manpages/smbspool.8.html delete mode 100644 docs/htmldocs/manpages/smbstatus.1.html delete mode 100644 docs/htmldocs/manpages/smbta-util.8.html delete mode 100644 docs/htmldocs/manpages/smbtar.1.html delete mode 100644 docs/htmldocs/manpages/smbtree.1.html delete mode 100644 docs/htmldocs/manpages/swat.8.html delete mode 100644 docs/htmldocs/manpages/tdbbackup.8.html delete mode 100644 docs/htmldocs/manpages/tdbdump.8.html delete mode 100644 docs/htmldocs/manpages/tdbtool.8.html delete mode 100644 docs/htmldocs/manpages/testparm.1.html delete mode 100644 docs/htmldocs/manpages/vfs_acl_tdb.8.html delete mode 100644 docs/htmldocs/manpages/vfs_acl_xattr.8.html delete mode 100644 docs/htmldocs/manpages/vfs_aio_fork.8.html delete mode 100644 docs/htmldocs/manpages/vfs_aio_pthread.8.html delete mode 100644 docs/htmldocs/manpages/vfs_audit.8.html delete mode 100644 docs/htmldocs/manpages/vfs_cacheprime.8.html delete mode 100644 docs/htmldocs/manpages/vfs_cap.8.html delete mode 100644 docs/htmldocs/manpages/vfs_catia.8.html delete mode 100644 docs/htmldocs/manpages/vfs_commit.8.html delete mode 100644 docs/htmldocs/manpages/vfs_crossrename.8.html delete mode 100644 docs/htmldocs/manpages/vfs_default_quota.8.html delete mode 100644 docs/htmldocs/manpages/vfs_dirsort.8.html delete mode 100644 docs/htmldocs/manpages/vfs_extd_audit.8.html delete mode 100644 docs/htmldocs/manpages/vfs_fake_perms.8.html delete mode 100644 docs/htmldocs/manpages/vfs_fileid.8.html delete mode 100644 docs/htmldocs/manpages/vfs_full_audit.8.html delete mode 100644 docs/htmldocs/manpages/vfs_gpfs.8.html delete mode 100644 docs/htmldocs/manpages/vfs_netatalk.8.html delete mode 100644 docs/htmldocs/manpages/vfs_notify_fam.8.html delete mode 100644 docs/htmldocs/manpages/vfs_prealloc.8.html delete mode 100644 docs/htmldocs/manpages/vfs_preopen.8.html delete mode 100644 docs/htmldocs/manpages/vfs_readahead.8.html delete mode 100644 docs/htmldocs/manpages/vfs_readonly.8.html delete mode 100644 docs/htmldocs/manpages/vfs_recycle.8.html delete mode 100644 docs/htmldocs/manpages/vfs_scannedonly.8.html delete mode 100644 docs/htmldocs/manpages/vfs_shadow_copy.8.html delete mode 100644 docs/htmldocs/manpages/vfs_shadow_copy2.8.html delete mode 100644 docs/htmldocs/manpages/vfs_smb_traffic_analyzer.8.html delete mode 100644 docs/htmldocs/manpages/vfs_streams_depot.8.html delete mode 100644 docs/htmldocs/manpages/vfs_streams_xattr.8.html delete mode 100644 docs/htmldocs/manpages/vfs_time_audit.8.html delete mode 100644 docs/htmldocs/manpages/vfs_xattr_tdb.8.html delete mode 100644 docs/htmldocs/manpages/vfstest.1.html delete mode 100644 docs/htmldocs/manpages/wbinfo.1.html delete mode 100644 docs/htmldocs/manpages/winbind_krb5_locator.7.html delete mode 100644 docs/htmldocs/manpages/winbindd.8.html (limited to 'docs/htmldocs/manpages') diff --git a/docs/htmldocs/manpages/eventlogadm.8.html b/docs/htmldocs/manpages/eventlogadm.8.html deleted file mode 100644 index 1a1d383cc4..0000000000 --- a/docs/htmldocs/manpages/eventlogadm.8.html +++ /dev/null @@ -1,128 +0,0 @@ -eventlogadm

Name

eventlogadm — push records into the Samba event log store

Synopsis

eventlogadm [-s] [-d] [-h] -o - addsource - EVENTLOG - SOURCENAME - MSGFILE -

eventlogadm [-s] [-d] [-h] -o - write - EVENTLOG -

eventlogadm [-s] [-d] [-h] -o - dump - EVENTLOG - RECORD_NUMBER -

DESCRIPTION

This tool is part of the samba(1) suite.

eventlogadm is a filter that accepts - formatted event log records on standard input and writes them - to the Samba event log store. Windows client can then manipulate - these record using the usual administration tools.

OPTIONS

- -s - FILENAME -

- The -s option causes eventlogadm to load the - configuration file given as FILENAME instead of the default one used by Samba. -

-d

- The -d option causes eventlogadm to emit debugging - information. -

- -o - addsource - EVENTLOG - SOURCENAME - MSGFILE -

- The -o addsource option creates a - new event log source. -

- -o - write - EVENTLOG -

- The -o write reads event log - records from standard input and writes them to the Samba - event log store named by EVENTLOG. -

- -o - dump - EVENTLOG - RECORD_NUMBER -

- The -o dump reads event log - records from a EVENTLOG tdb and dumps them to standard - output on screen. -

-h

- Print usage information. -

EVENTLOG RECORD FORMAT

For the write operation, eventlogadm - expects to be able to read structured records from standard - input. These records are a sequence of lines, with the record key - and data separated by a colon character. Records are separated - by at least one or more blank line.

The event log record field are:

  • - LEN - This field should be 0, since eventlogadm will calculate this value. -

  • - RS1 - This must be the value 1699505740. -

  • - RCN - This field should be 0. -

  • - TMG - The time the eventlog record - was generated; format is the number of seconds since - 00:00:00 January 1, 1970, UTC. -

  • - TMW - The time the eventlog record was - written; format is the number of seconds since 00:00:00 - January 1, 1970, UTC. -

  • - EID - The eventlog ID. -

  • - ETP - The event type -- one of - "INFO", - "ERROR", "WARNING", "AUDIT - SUCCESS" or "AUDIT FAILURE". -

  • - ECT - The event category; this depends - on the message file. It is primarily used as a means of - filtering in the eventlog viewer. -

  • - RS2 - This field should be 0. -

  • - CRN - This field should be 0. -

  • - USL - This field should be 0. -

  • - SRC - This field contains the source - name associated with the event log. If a message file is - used with an event log, there will be a registry entry - for associating this source name with a message file DLL. -

  • - SRN - The name of the machine on - which the eventlog was generated. This is typically the - host name. -

  • - STR - The text associated with the - eventlog. There may be more than one string in a record. -

  • - DAT - This field should be left unset. -

EXAMPLES

An example of the record format accepted by eventlogadm:

-	LEN: 0
-	RS1: 1699505740
-	RCN: 0
-	TMG: 1128631322
-	TMW: 1128631322
-	EID: 1000
-	ETP: INFO
-	ECT: 0
-	RS2: 0
-	CRN: 0
-	USL: 0
-	SRC: cron
-	SRN: dmlinux
-	STR: (root) CMD ( rm -f /var/spool/cron/lastrun/cron.hourly)
-	DAT:
-

Set up an eventlog source, specifying a message file DLL:

-	eventlogadm -o addsource Application MyApplication | \\
-	    	%SystemRoot%/system32/MyApplication.dll
-

Filter messages from the system log into an event log:

-	tail -f /var/log/messages | \\
-		my_program_to_parse_into_eventlog_records | \\
-	      	eventlogadm SystemLogEvents
-

VERSION

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

AUTHOR

The original Samba software and related utilities were - created by Andrew Tridgell. Samba is now developed by the - Samba Team as an Open Source project similar to the way the - Linux kernel is developed.

diff --git a/docs/htmldocs/manpages/findsmb.1.html b/docs/htmldocs/manpages/findsmb.1.html deleted file mode 100644 index 9902ee9473..0000000000 --- a/docs/htmldocs/manpages/findsmb.1.html +++ /dev/null @@ -1,62 +0,0 @@ -findsmb

Name

findsmb — list info about machines that respond to SMB - name queries on a subnet

Synopsis

findsmb [subnet broadcast address]

DESCRIPTION

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

OPTIONS

-r

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.

subnet broadcast address

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.

EXAMPLES

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

VERSION

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

SEE ALSO

nmbd(8), - smbclient(1), and nmblookup(1) -

AUTHOR

The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed.

The original Samba man pages were written by Karl Auer. - The man page sources were converted to YODL format (another - excellent piece of Open Source software, available at ftp://ftp.icce.rug.nl/pub/unix/) - and updated for the Samba 2.0 release by Jeremy Allison. The conversion to DocBook for - Samba 2.2 was done by Gerald Carter. The conversion to DocBook - XML 4.2 for Samba 3.0 was done by Alexander Bokovoy.

diff --git a/docs/htmldocs/manpages/idmap_ad.8.html b/docs/htmldocs/manpages/idmap_ad.8.html deleted file mode 100644 index be73584d4e..0000000000 --- a/docs/htmldocs/manpages/idmap_ad.8.html +++ /dev/null @@ -1,54 +0,0 @@ -idmap_ad

Name

idmap_ad — Samba's idmap_ad Backend for Winbind

DESCRIPTION

The idmap_ad plugin provides a way for Winbind to read - id mappings from an AD server that uses RFC2307/SFU schema - extensions. This module implements only the "idmap" - API, and is READONLY. Mappings must be provided in advance - by the administrator by adding the posixAccount/posixGroup - classes and relative attribute/value pairs to the user and - group objects in the AD.

- Note that the idmap_ad module has changed considerably since - Samba versions 3.0 and 3.2. - Currently, the ad backend - does not work as the the default idmap backend, but one has - to configure it separately for each domain for which one wants - to use it, using disjoint ranges. One usually needs to configure - a writeable default idmap range, using for example the - tdb or ldap - backend, in order to be able to map the BUILTIN sids and - possibly other trusted domains. The writeable default config - is also needed in order to be able to create group mappings. - This catch-all default idmap configuration should have a range - that is disjoint from any explicitly configured domain with - idmap backend ad. See the example below. -

IDMAP OPTIONS

range = low - high

- Defines the available matching UID and GID range for which the - backend is authoritative. Note that the range acts as a filter. - If specified any UID or GID stored in AD that fall outside the - range is ignored and the corresponding map is discarded. - It is intended as a way to avoid accidental UID/GID overlaps - between local and remotely defined IDs. -

schema_mode = <rfc2307 | sfu >

- Defines the schema that idmap_ad should use when querying - Active Directory regarding user and group information. - This can be either the RFC2307 schema support included - in Windows 2003 R2 or the Service for Unix (SFU) schema. -

EXAMPLES

- The following example shows how to retrieve idmappings from our principal and - trusted AD domains. If trusted domains are present id conflicts must be - resolved beforehand, there is no - guarantee on the order conflicting mappings would be resolved at this point. - - This example also shows how to leave a small non conflicting range for local - id allocation that may be used in internal backends like BUILTIN. - 

-	[global]
-	idmap config * : backend = tdb
-	idmap config * : range = 1000000-1999999
-
-	idmap config CORP : backend  = ad
-	idmap config CORP : range = 1000-999999
-

AUTHOR

- The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed. -

diff --git a/docs/htmldocs/manpages/idmap_adex.8.html b/docs/htmldocs/manpages/idmap_adex.8.html deleted file mode 100644 index d01c69108d..0000000000 --- a/docs/htmldocs/manpages/idmap_adex.8.html +++ /dev/null @@ -1,43 +0,0 @@ -idmap_adex

Name

idmap_adex — Samba's idmap_adex Backend for Winbind

DESCRIPTION

- The idmap_adex plugin provides a way for Winbind to read - id mappings from an AD server that uses RFC2307 schema - extensions. This module implements both the idmap and nss_info - APIs and supports domain trustes as well as two-way cross - forest trusts. It is a read-only plugin requiring that the - administrator provide mappings in advance by adding the - POSIX attribute information to the users and groups objects - in AD. The most common means of doing this is using "Identity - Services for Unix" support on Windows 2003 R2 and later. -

- Note that you must add the uidNumber, gidNumber, and uid - attributes to the partial attribute set of the forest global - catalog servers. This can be done using the Active Directory Schema - Management MMC plugin (schmmgmt.dll). -

NSS_INFO

- The nss_info plugin supports reading the unixHomeDirectory, - gidNumber, loginShell, and uidNumber attributes from the user - object and the gidNumber attribute from the group object to - fill in information required by the libc getpwnam() and - getgrnam() family of functions. Group membership is filled in - according to the Windows group membership and not the - msSFU30PosixMember attribute. -

- Username aliases are implement by setting the uid attribute - on the user object. While group name aliases are implemented - by reading the displayname attribute from the group object. -

EXAMPLES

- The following example shows how to retrieve idmappings and NSS data - from our principal and trusted AD domains. - 

-	[global]
-	idmap config * : backend = adex
-	idmap config * : range = 1000-4000000000
-
-	winbind nss info = adex
-	winbind normalize names = yes
-

AUTHOR

- The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed. -

diff --git a/docs/htmldocs/manpages/idmap_autorid.8.html b/docs/htmldocs/manpages/idmap_autorid.8.html deleted file mode 100644 index 06af316ee6..0000000000 --- a/docs/htmldocs/manpages/idmap_autorid.8.html +++ /dev/null @@ -1,73 +0,0 @@ -idmap_autorid

Name

idmap_autorid — Samba's idmap_autorid Backend for Winbind

DESCRIPTION

The idmap_autorid backend provides a way to use an algorithmic - mapping scheme to map UIDs/GIDs and SIDs that is more deterministic - than idmap_tdb and easier to configure than idmap_rid.

The module works similar to idmap_rid, but it automatically - configures the range to be used for each domain, so there is no need - to specify a specific range for each domain in the forest, the only - configuration that is needed is the range of uid/gids that shall - be used for user/group mappings and an optional size of the ranges - to be used.

The mappings of which domain is mapped to which range is stored - in autorid.tdb, thus you should backup this database regularly.

Due to the algorithm being used, it is the module that is - most easy to use as it only requires a minimal configuration.

IDMAP OPTIONS

rangesize = numberofidsperdomain

- Defines the available number of uids/gids per domain. The - minimum needed value is 2000. SIDs with RIDs larger than this - value cannot be mapped, are ignored and the corresponding map - is discarded. Choose this value carefully, as this should - not be changed after the first ranges for domains have been - defined, otherwise mappings between domains will get intermixed - leading to unpredictable results. Please note that RIDs in Windows - Domains usually start with 500 for builtin users and 1000 - for regular users. As the parameter cannot be changed later, please - plan accordingly for your expected number of users in a domain - with safety margins. -

One range will be used for local users and groups. - Thus the number of local users and groups that can be created is - limited by this option as well. If you plan to create a large amount - of local users or groups, you will need set this parameter accordingly. -

The default value is 100000.

THE MAPPING FORMULAS

- The Unix ID for a RID is calculated this way: - 

-			ID = IDMAP UID LOW VALUE + DOMAINRANGENUMBER * RANGESIZE + RID
-

-

- Correspondingly, the formula for calculating the RID for a - given Unix ID is this: - 

-			RID = ID - IDMAP UID LOW VALUE - DOMAINRANGENUMBER * RANGESIZE
-

-

EXAMPLES

- This example shows you the minimal configuration that will - work for the principial domain and 19 trusted domains. - 

-	[global]
-	security = ads
-	workgroup = CUSTOMER
-	realm = CUSTOMER.COM
-
-	idmap config * : backend = autorid
-	idmap config * : range = 1000000-1999999
-
-

- This example shows how to configure idmap_autorid as default - for all domains with a potentially large amount of users - plus a specific configuration for a trusted domain - that uses the SFU mapping scheme. Please note that idmap - ranges and sfu ranges are not allowed to overlap. - 

-	[global]
-	security = ads
-	workgroup = CUSTOMER
-	realm = CUSTOMER.COM
-
-	idmap config * : backend = autorid
-	idmap config * : range = 1000000-19999999
-	idmap config * : rangesize = 1000000
-
-	idmap config TRUSTED : backend  = ad
-	idmap config TRUSTED : range    = 50000 - 99999
-	idmap config TRUSTED : schema_mode = sfu
-

AUTHOR

- The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed. -

diff --git a/docs/htmldocs/manpages/idmap_hash.8.html b/docs/htmldocs/manpages/idmap_hash.8.html deleted file mode 100644 index 3d4698aca2..0000000000 --- a/docs/htmldocs/manpages/idmap_hash.8.html +++ /dev/null @@ -1,28 +0,0 @@ -idmap_hash

Name

idmap_hash — Samba's idmap_hash Backend for Winbind

DESCRIPTION

The idmap_hash plugin implements a hashing algorithm used to map - SIDs for domain users and groups to 31-bit uids and gids, respectively. - This plugin also implements the nss_info API and can be used - to support a local name mapping files if enabled via the - "winbind normalize names" and "winbind nss info" - parameters in smb.conf. -

IDMAP OPTIONS

name_map

- Specifies the absolute path to the name mapping - file used by the nss_info API. Entries in the file - are of the form "unix name - = qualified domain name". - Mapping of both user and group names is supported. -

EXAMPLES

The following example utilizes the idmap_hash plugin for - the idmap and nss_info information. - 

-	[global]
-	idmap config * : backend = hash
-	idmap config * : range = 1000-4000000000
-
-	winbind nss info = hash
-	winbind normalize names = yes
-	idmap_hash:name_map = /etc/samba/name_map.cfg
-

AUTHOR

- The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed. -

diff --git a/docs/htmldocs/manpages/idmap_ldap.8.html b/docs/htmldocs/manpages/idmap_ldap.8.html deleted file mode 100644 index 19ada558a3..0000000000 --- a/docs/htmldocs/manpages/idmap_ldap.8.html +++ /dev/null @@ -1,67 +0,0 @@ -idmap_ldap

Name

idmap_ldap — Samba's idmap_ldap Backend for Winbind

DESCRIPTION

The idmap_ldap plugin provides a means for Winbind to - store and retrieve SID/uid/gid mapping tables in an LDAP directory - service. -

- In contrast to read only backends like idmap_rid, it is an allocating - backend: This means that it needs to allocate new user and group IDs in - order to create new mappings. -

IDMAP OPTIONS

ldap_base_dn = DN

- Defines the directory base suffix to use for - SID/uid/gid mapping entries. If not defined, idmap_ldap will default - to using the "ldap idmap suffix" option from smb.conf. -

ldap_user_dn = DN

- Defines the user DN to be used for authentication. - The secret for authenticating this user should be - stored with net idmap secret - (see net(8)). - If absent, the ldap credentials from the ldap passdb configuration - are used, and if these are also absent, an anonymous - bind will be performed as last fallback. -

ldap_url = ldap://server/

- Specifies the LDAP server to use for - SID/uid/gid map entries. If not defined, idmap_ldap will - assume that ldap://localhost/ should be used. -

range = low - high

- Defines the available matching uid and gid range for which the - backend is authoritative. -

EXAMPLES

- The following example shows how an ldap directory is used as the - default idmap backend. It also configures the idmap range and base - directory suffix. The secret for the ldap_user_dn has to be set with - "net idmap secret '*' password". - 

-	[global]
-	idmap config * : backend      = ldap
-	idmap config * : range        = 1000000-1999999
-	idmap config * : ldap_url     = ldap://localhost/
-	idmap config * : ldap_base_dn = ou=idmap,dc=example,dc=com
-	idmap config * : ldap_user_dn = cn=idmap_admin,dc=example,dc=com
-

- This example shows how ldap can be used as a readonly backend while - tdb is the default backend used to store the mappings. - It adds an explicit configuration for some domain DOM1, that - uses the ldap idmap backend. Note that a range disjoint from the - default range is used. - 

-	[global]
-	# "backend = tdb" is redundant here since it is the default
-	idmap config * : backend = tdb
-	idmap config * : range = 1000000-1999999
-
-	idmap config DOM1 : backend = ldap
-	idmap config DOM1 : range = 2000000-2999999
-	idmap config DOM1 : read only = yes
-	idmap config DOM1 : ldap_url = ldap://server/
-	idmap config DOM1 : ldap_base_dn = ou=idmap,dc=dom1,dc=example,dc=com
-	idmap config DOM1 : ldap_user_dn = cn=idmap_admin,dc=dom1,dc=example,dc=com
-

NOTE

In order to use authentication against ldap servers you may - need to provide a DN and a password. To avoid exposing the password - in plain text in the configuration file we store it into a security - store. The "net idmap " command is used to store a secret - for the DN specified in a specific idmap domain. -

AUTHOR

- The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed. -

diff --git a/docs/htmldocs/manpages/idmap_nss.8.html b/docs/htmldocs/manpages/idmap_nss.8.html deleted file mode 100644 index b48f2fd515..0000000000 --- a/docs/htmldocs/manpages/idmap_nss.8.html +++ /dev/null @@ -1,22 +0,0 @@ -idmap_nss

Name

idmap_nss — Samba's idmap_nss Backend for Winbind

DESCRIPTION

The idmap_nss plugin provides a means to map Unix users and groups - to Windows accounts and obsoletes the "winbind trusted domains only" - smb.conf option. This provides a simple means of ensuring that the SID - for a Unix user named jsmith is reported as the one assigned to - DOMAIN\jsmith which is necessary for reporting ACLs on files and printers - stored on a Samba member server. -

EXAMPLES

- This example shows how to use idmap_nss to check the local accounts for its - own domain while using allocation to create new mappings for trusted domains - 

-	[global]
-	idmap config * : backend = tdb
-	idmap config * : range = 1000000-1999999
-
-	idmap config SAMBA : backend  = nss
-	idmap config SAMBA : range = 1000-999999
-

AUTHOR

- The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed. -

diff --git a/docs/htmldocs/manpages/idmap_rid.8.html b/docs/htmldocs/manpages/idmap_rid.8.html deleted file mode 100644 index 0458d78af2..0000000000 --- a/docs/htmldocs/manpages/idmap_rid.8.html +++ /dev/null @@ -1,69 +0,0 @@ -idmap_rid

Name

idmap_rid — Samba's idmap_rid Backend for Winbind

DESCRIPTION

The idmap_rid backend provides a way to use an algorithmic - mapping scheme to map UIDs/GIDs and SIDs. No database is required - in this case as the mapping is deterministic.

- Note that the idmap_rid module has changed considerably since Samba - versions 3.0. and 3.2. - Currently, there should to be an explicit idmap configuration for each - domain that should use the idmap_rid backend, using disjoint ranges. - One usually needs to define a writeable default idmap range, using - a backent like tdb or ldap - that can create unix ids, in order to be able to map the BUILTIN sids - and other domains, and also in order to be able to create group mappings. - See the example below. -

- Note that the old syntax - idmap backend = rid:"DOM1=range DOM2=range2 ..." - is not supported any more since Samba version 3.0.25. -

IDMAP OPTIONS

range = low - high

- Defines the available matching uid and gid range for which the - backend is authoritative. Note that the range acts as a filter. - If algorithmically determined UID or GID fall outside the - range, they are ignored and the corresponding map is discarded. - It is intended as a way to avoid accidental UID/GID overlaps - between local and remotely defined IDs. -

base_rid = INTEGER

- Defines the base integer used to build SIDs out of a UID or a GID, - and to rebase the UID or GID to be obtained from a SID. - This means SIDs with a RID less than the base rid are filtered. - The default is not to restrict the allowed rids at all, - i.e. a base_rid value of 0. - A good value for the base_rid can be 1000, since user - RIDs by default start at 1000 (512 hexadecimal). -

- Use of this parameter is deprecated. -

THE MAPPING FORMULAS

- The Unix ID for a RID is calculated this way: - 

-			ID = RID - BASE_RID + LOW_RANGE_ID.
-

-

- Correspondingly, the formula for calculating the RID for a - given Unix ID is this: - 

-			RID = ID + BASE_RID - LOW_RANGE_ID.
-

-

EXAMPLES

- This example shows how to configure two domains with idmap_rid, - the principal domain and a trusted domain, leaving the default - id mapping scheme at tdb. The example also demonstrates the use - of the base_rid parameter for the trusted domain. - 

-	[global]
-	security = domain
-	workgroup = MAIN
-
-	idmap config * : backend        = tdb
-	idmap config * : range          = 1000000-1999999
-
-	idmap config MAIN : backend     = rid
-	idmap config MAIN : range       = 10000 - 49999
-
-	idmap config TRUSTED : backend  = rid
-	idmap config TRUSTED : range    = 50000 - 99999
-	idmap config TRUSTED : base_rid = 1000
-

AUTHOR

- The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed. -

diff --git a/docs/htmldocs/manpages/idmap_tdb.8.html b/docs/htmldocs/manpages/idmap_tdb.8.html deleted file mode 100644 index ddf11e858a..0000000000 --- a/docs/htmldocs/manpages/idmap_tdb.8.html +++ /dev/null @@ -1,24 +0,0 @@ -idmap_tdb

Name

idmap_tdb — Samba's idmap_tdb Backend for Winbind

DESCRIPTION

- The idmap_tdb plugin is the default backend used by winbindd - for storing SID/uid/gid mapping tables. -

- In contrast to read only backends like idmap_rid, it is an allocating - backend: This means that it needs to allocate new user and group IDs in - order to create new mappings. -

IDMAP OPTIONS

range = low - high

- Defines the available matching uid and gid range for which the - backend is authoritative. -

EXAMPLES

- This example shows how tdb is used as a the default idmap backend. - This configured range is used for uid and gid allocation. - 

-	[global]
-	# "backend = tdb" is redundant here since it is the default
-	idmap config * : backend = tdb
-	idmap config * : range = 1000000-2000000
-

AUTHOR

- The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed. -

diff --git a/docs/htmldocs/manpages/idmap_tdb2.8.html b/docs/htmldocs/manpages/idmap_tdb2.8.html deleted file mode 100644 index b205fc49ed..0000000000 --- a/docs/htmldocs/manpages/idmap_tdb2.8.html +++ /dev/null @@ -1,61 +0,0 @@ -idmap_tdb2

Name

idmap_tdb2 — Samba's idmap_tdb2 Backend for Winbind

DESCRIPTION

- The idmap_tdb2 plugin is a substitute for the default idmap_tdb - backend used by winbindd for storing SID/uid/gid mapping tables - in clustered environments with Samba and CTDB. -

- In contrast to read only backends like idmap_rid, it is an allocating - backend: This means that it needs to allocate new user and group IDs in - order to create new mappings. -

IDMAP OPTIONS

range = low - high

- Defines the available matching uid and gid range for which the - backend is authoritative. -

script

- This option can be used to configure an external program - for performing id mappings instead of using the tdb - counter. The mappings are then stored int tdb2 idmap - database. For details see the section on IDMAP SCRIPT below. -

IDMAP SCRIPT

- The tdb2 idmap backend supports an external program for performing id mappings - through the smb.conf option idmap config * : script or - its deprecated legacy form idmap : script. -

- The mappings obtained by the script are then stored in the idmap tdb2 - database instead of mappings created by the incrementing id counters. - It is therefore important that the script covers the complete range of - SIDs that can be passed in for SID to Unix ID mapping, since otherwise - SIDs unmapped by the script might get mapped to IDs that had - previously been mapped by the script. -

- The script should accept the following command line options. - 

-	SIDTOID S-1-xxxx
-	IDTOSID UID xxxx
-	IDTOSID GID xxxx
-

- And it should return one of the following responses as a single line of - text. - 

-	UID:yyyy
-	GID:yyyy
-	SID:yyyy
-	ERR:yyyy
-

EXAMPLES

- This example shows how tdb2 is used as a the default idmap backend. - 

-	[global]
-	idmap config * : backend = tdb2
-	idmap config * : range = 1000000-2000000
-

- This example shows how tdb2 is used as a the default idmap backend - using an external program via the script parameter: - 

-	[global]
-	idmap config * : backend = tdb2
-	idmap config * : range = 1000000-2000000
-	idmap config * : script = /usr/local/samba/bin/idmap_script.sh
-

AUTHOR

- The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed. -

diff --git a/docs/htmldocs/manpages/index.html b/docs/htmldocs/manpages/index.html deleted file mode 100644 index 941fba0412..0000000000 --- a/docs/htmldocs/manpages/index.html +++ /dev/null @@ -1,99 +0,0 @@ -
eventlogadm(8)

push records into the Samba event log store -

findsmb(1)

list info about machines that respond to SMB - name queries on a subnet -

idmap_ad(8)

Samba's idmap_ad Backend for Winbind -

idmap_adex(8)

Samba's idmap_adex Backend for Winbind -

idmap_autorid(8)

Samba's idmap_autorid Backend for Winbind -

idmap_hash(8)

Samba's idmap_hash Backend for Winbind -

idmap_ldap(8)

Samba's idmap_ldap Backend for Winbind -

idmap_nss(8)

Samba's idmap_nss Backend for Winbind -

idmap_rid(8)

Samba's idmap_rid Backend for Winbind -

idmap_tdb2(8)

Samba's idmap_tdb2 Backend for Winbind -

idmap_tdb(8)

Samba's idmap_tdb Backend for Winbind -

libsmbclient(7)

An extension library for browsers and that can be used as a generic browsing API. -

lmhosts(5)

The Samba NetBIOS hosts file -

log2pcap(1)

Extract network traces from Samba log files -

net(8)

Tool for administration of Samba and remote - CIFS servers. - -

nmbd(8)

NetBIOS name server to provide NetBIOS - over IP naming services to clients -

nmblookup(1)

NetBIOS over TCP/IP client used to lookup NetBIOS - names -

ntlm_auth(1)

tool to allow external access to Winbind's NTLM authentication function -

pam_winbind(8)

PAM module for Winbind -

pam_winbind.conf(5)

Configuration file of PAM module for Winbind -

pdbedit(8)

manage the SAM database (Database of Samba Users) -

profiles(1)

A utility to report and change SIDs in registry files - -

rpcclient(1)

tool for executing client side - MS-RPC functions -

samba(7)

A Windows SMB/CIFS fileserver for UNIX -

sharesec(1)

Set or get share ACLs -

smbcacls(1)

Set or get ACLs on an NT file or directory names -

smbclient(1)

ftp-like client to access SMB/CIFS resources - on servers -

smb.conf(5)

The configuration file for the Samba suite -

smbcontrol(1)

send messages to smbd, nmbd or winbindd processes -

smbcquotas(1)

Set or get QUOTAs of NTFS 5 shares -

smbd(8)

server to provide SMB/CIFS services to clients -

smbget(1)

wget-like utility for download files over SMB -

smbgetrc(5)

configuration file for smbget -

smbpasswd(5)

The Samba encrypted password file -

smbpasswd(8)

change a user's SMB password -

smbspool(8)

send a print file to an SMB printer -

smbstatus(1)

report on current Samba connections -

smbtar(1)

shell script for backing up SMB/CIFS shares - directly to UNIX tape drives -

smbta-util(8)

control encryption in VFS smb_traffic_analyzer -

smbtree(1)

A text based smb network browser - -

swat(8)

Samba Web Administration Tool -

tdbbackup(8)

tool for backing up and for validating the integrity of samba .tdb files -

tdbdump(8)

tool for printing the contents of a TDB file -

tdbtool(8)

manipulate the contents TDB files -

testparm(1)

check an smb.conf configuration file for - internal correctness -

vfs_acl_tdb(8)

Save NTFS-ACLs in a tdb file -

vfs_acl_xattr(8)

Save NTFS-ACLs in Extended Attributes (EAs) -

vfs_aio_fork(8)

implement async I/O in Samba vfs -

vfs_aio_pthread(8)

implement async I/O in Samba vfs using a pthread pool -

vfs_audit(8)

record selected Samba VFS operations in the system log -

vfs_cacheprime(8)

prime the kernel file data cache -

vfs_cap(8)

CAP encode filenames -

vfs_catia(8)

translate illegal characters in Catia filenames -

vfs_commit(8)

flush dirty data at specified intervals -

vfs_crossrename(8)

server side rename files across filesystem boundaries -

vfs_default_quota(8)

store default quota records for Windows clients -

vfs_dirsort(8)

Sort directory contents -

vfs_extd_audit(8)

record selected Samba VFS operations -

vfs_fake_perms(8)

enable read only Roaming Profiles -

vfs_fileid(8)

Generates file_id structs with unique device id values for - cluster setups -

vfs_full_audit(8)

record Samba VFS operations in the system log -

vfs_gpfs(8)

gpfs specific samba extensions like acls and prealloc -

vfs_netatalk(8)

hide .AppleDouble files from CIFS clients -

vfs_notify_fam(8)

FAM support for file change notifications -

vfs_prealloc(8)

preallocate matching files to a predetermined size -

vfs_preopen(8)

Hide read latencies for applications reading numbered files -

vfs_readahead(8)

pre-load the kernel buffer cache -

vfs_readonly(8)

make a Samba share read only for a specified time period -

vfs_recycle(8)

Samba VFS recycle bin -

vfs_scannedonly(8)

Ensures that only files that have been scanned for viruses are - visible and accessible to the end user. -

vfs_shadow_copy2(8)

Expose snapshots to Windows clients as shadow copies. -

vfs_shadow_copy(8)

Make a Samba share read only for a specified time period -

smb_traffic_analyzer(8)

log Samba VFS read and write operations through a socket - to a helper application -

vfs_streams_depot(8)

EXPERIMENTAL module to store alternate data streams in a - central directory. - -

vfs_streams_xattr(8)

Store alternate data streams in posix xattrs -

vfstest(1)

tool for testing samba VFS modules -

vfs_time_audit(8)

samba vfs module to log slow VFS operations -

vfs_xattr_tdb(8)

Save Extended Attributes (EAs) in a tdb file -

wbinfo(1)

Query information from winbind daemon -

winbindd(8)

Name Service Switch daemon for resolving names - from NT servers -

winbind_krb5_locator(7)

A plugin for MIT and Heimdal Kerberos for detecting KDCs using Windows semantics. -

diff --git a/docs/htmldocs/manpages/libsmbclient.7.html b/docs/htmldocs/manpages/libsmbclient.7.html deleted file mode 100644 index 279c0a2887..0000000000 --- a/docs/htmldocs/manpages/libsmbclient.7.html +++ /dev/null @@ -1,59 +0,0 @@ -libsmbclient

Name

libsmbclient — An extension library for browsers and that can be used as a generic browsing API.

Synopsis

- Browser URL: - smb://[[[domain:]user[:password@]]server[/share[/path[/file]]]] [?options] - -

DESCRIPTION

- This tool is part of the samba(7) 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. -

OPTIONS

- What the URLs mean: -

smb://

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

smb://name/

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

PROGRAMMERS GUIDE

- Watch this space for future updates. -

VERSION

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

AUTHOR

- The original Samba software and related utilities were created by Andrew Tridgell. - Samba is now developed by the Samba Team as an Open Source project similar to the way - the Linux kernel is developed. -

- The libsmbclient manpage page was written by John H Terpstra. -

diff --git a/docs/htmldocs/manpages/lmhosts.5.html b/docs/htmldocs/manpages/lmhosts.5.html deleted file mode 100644 index 6526d41769..0000000000 --- a/docs/htmldocs/manpages/lmhosts.5.html +++ /dev/null @@ -1,41 +0,0 @@ -lmhosts

Name

lmhosts — The Samba NetBIOS hosts file

Synopsis

lmhosts is the samba(7) NetBIOS name to IP address mapping file.

DESCRIPTION

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.

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

FILES

lmhosts is loaded from the configuration directory. This is - usually /etc/samba or /usr/local/samba/lib. -

VERSION

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

SEE ALSO

smbclient(1), smb.conf(5), and smbpasswd(8) -

AUTHOR

The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed.

The original Samba man pages were written by Karl Auer. - The man page sources were converted to YODL format (another - excellent piece of Open Source software, available at - - ftp://ftp.icce.rug.nl/pub/unix/) and updated for the Samba 2.0 - release by Jeremy Allison. The conversion to DocBook for - Samba 2.2 was done by Gerald Carter. The conversion to DocBook - XML 4.2 was done by Alexander Bokovoy.

diff --git a/docs/htmldocs/manpages/log2pcap.1.html b/docs/htmldocs/manpages/log2pcap.1.html deleted file mode 100644 index f0829861d6..0000000000 --- a/docs/htmldocs/manpages/log2pcap.1.html +++ /dev/null @@ -1,29 +0,0 @@ -log2pcap

Name

log2pcap — Extract network traces from Samba log files

Synopsis

log2pcap [-h] [-q] [logfile] [pcap_file]

DESCRIPTION

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

OPTIONS

-h

If this parameter is - specified the output file will be a - hex dump, in a format that is readable - by the text2pcap utility.

-q

Be quiet. No warning messages about missing - or incomplete data will be given.

logfile

- Samba log file. log2pcap will try to read the log from stdin - if the log file is not specified. -

pcap_file

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

-h|--help

Print a summary of command line options. -

EXAMPLES

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
-

VERSION

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

BUGS

Only SMB data is extracted from the samba logs, no LDAP, - NetBIOS lookup or other data.

The generated TCP and IP headers don't contain a valid - checksum.

SEE ALSO

text2pcap(1), ethereal(1)

AUTHOR

The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed.

This manpage was written by Jelmer Vernooij.

diff --git a/docs/htmldocs/manpages/net.8.html b/docs/htmldocs/manpages/net.8.html deleted file mode 100644 index 8f913d0624..0000000000 --- a/docs/htmldocs/manpages/net.8.html +++ /dev/null @@ -1,637 +0,0 @@ -net

Name

net — Tool for administration of Samba and remote - CIFS servers. -

Synopsis

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] [-V] [--request-timeout seconds]

DESCRIPTION

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

OPTIONS

-h|--help

Print a summary of command line options. -

-k|--kerberos

-Try to authenticate with kerberos. Only useful in -an Active Directory environment. -

-w target-workgroup

- Sets target workgroup or domain. You have to specify - either this option or the IP address or the name of a server. -

-W workgroup

- Sets client workgroup or domain -

-U user

- User name to use -

-I ip-address

- IP address of target server to use. You have to - specify either this option or a target workgroup or - a target server. -

-p port

- Port on the target server to connect to (usually 139 or 445). - Defaults to trying 445 first, then 139. -

-n|--netbiosname <primary NetBIOS name>

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.

-s|--configfile <configuration file>

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.

-S server

- Name of target server. You should specify either - this option or a target workgroup or a target IP address. -

-l

- When listing data, give more information on each item. -

-P

- Make queries to the external server using the machine account of the local server. -

--request-timeout 30

- Let client requests timeout after 30 seconds the default is 10 - seconds. -

-d|--debuglevel=level

level is an integer -from 0 to 10. The default value if this parameter is -not specified is 0.

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.

COMMANDS

CHANGESECRETPW

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

TIME

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.

TIME

Without any options, the NET TIME command -displays the time on the remote server. -

TIME SYSTEM

Displays the time on the remote server in a format ready for /bin/date.

TIME SET

Tries to set the date and time of the local server to that on -the remote server using /bin/date.

TIME ZONE

Displays the timezone in hours from GMT on the remote computer.

[RPC|ADS] JOIN [TYPE] [-U username[%password]] [createupn=UPN] [createcomputer=OU] [options]

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

-[UPN] (ADS only) set the principalname attribute during the join. The default -format is host/netbiosname@REALM. -

-[OU] (ADS only) Precreate the computer account in a specific OU. The -OU string reads from top to bottom without RDNs, and is delimited by -a '/'. Please note that '\' is used for escape by both the shell -and ldap, so it may need to be doubled or quadrupled to pass through, -and it is not used as a delimiter. -

[RPC] OLDJOIN [options]

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.

[RPC|ADS] USER

[RPC|ADS] USER

List all users

[RPC|ADS] USER DELETE target

Delete specified user

[RPC|ADS] USER INFO target

List the domain groups of the specified user.

[RPC|ADS] USER RENAME oldname newname

Rename specified user.

[RPC|ADS] USER ADD name [password] [-F user flags] [-C comment]

Add specified user.

[RPC|ADS] GROUP

[RPC|ADS] GROUP [misc options] [targets]

List user groups.

[RPC|ADS] GROUP DELETE name [misc. options]

Delete specified group.

[RPC|ADS] GROUP ADD name [-C comment]

Create specified group.

[RAP|RPC] SHARE

[RAP|RPC] SHARE [misc. options] [targets]

Enumerates all exported resources (network shares) on target server.

[RAP|RPC] SHARE ADD name=serverpath [-C comment] [-M maxusers] [targets]

Adds a share from a server (makes the export active). Maxusers -specifies the number of users that can be connected to the -share simultaneously.

SHARE DELETE sharename

Delete specified share.

[RPC|RAP] FILE

[RPC|RAP] FILE

List all open files on remote server.

[RPC|RAP] FILE CLOSE fileid

Close file with specified fileid on -remote server.

[RPC|RAP] FILE INFO fileid

-Print information on specified fileid. -Currently listed are: file-id, username, locks, path, permissions. -

[RAP|RPC] FILE USER user

-List files opened by specified user. -Please note that net rap file user does not work -against Samba servers. -

SESSION

RAP SESSION

Without any other options, SESSION enumerates all active SMB/CIFS -sessions on the target server.

RAP SESSION DELETE|CLOSE CLIENT_NAME

Close the specified sessions.

RAP SESSION INFO CLIENT_NAME

Give a list with all the open files in specified session.

RAP SERVER DOMAIN

List all servers in specified domain or workgroup. Defaults -to local domain.

RAP DOMAIN

Lists all domains and workgroups visible on the -current network.

RAP PRINTQ

RAP PRINTQ INFO QUEUE_NAME

Lists the specified print queue and print jobs on the server. -If the QUEUE_NAME is omitted, all -queues are listed.

RAP PRINTQ DELETE JOBID

Delete job with specified id.

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

Note

Currently NOT implemented.

RAP GROUPMEMBER

RAP GROUPMEMBER LIST GROUP

List all members of the specified group.

RAP GROUPMEMBER DELETE GROUP USER

Delete member from group.

RAP GROUPMEMBER ADD GROUP USER

Add member to group.

RAP ADMIN command

Execute the specified command on -the remote server. Only works with OS/2 servers. -

Note

Currently NOT implemented.

RAP SERVICE

RAP SERVICE START NAME [arguments...]

Start the specified service on the remote server. Not implemented yet.

Note

Currently NOT implemented.

RAP SERVICE STOP

Stop the specified service on the remote server.

Note

Currently NOT implemented.

RAP PASSWORD USER OLDPASS NEWPASS

-Change password of USER from OLDPASS to NEWPASS. -

LOOKUP

LOOKUP HOST HOSTNAME [TYPE]

-Lookup the IP address of the given host with the specified type (netbios suffix). -The type defaults to 0x20 (workstation). -

LOOKUP LDAP [DOMAIN]

Give IP address of LDAP server of specified DOMAIN. Defaults to local domain.

LOOKUP KDC [REALM]

Give IP address of KDC for the specified REALM. -Defaults to local realm.

LOOKUP DC [DOMAIN]

Give IP's of Domain Controllers for specified -DOMAIN. Defaults to local domain.

LOOKUP MASTER DOMAIN

Give IP of master browser for specified DOMAIN -or workgroup. Defaults to local domain.

CACHE

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

- -

CACHE ADD key data time-out

Add specified key+data to the cache with the given timeout.

CACHE DEL key

Delete key from the cache.

CACHE SET key data time-out

Update data of existing cache entry.

CACHE SEARCH PATTERN

Search for the specified pattern in the cache data.

CACHE LIST

-List all current items in the cache. -

CACHE FLUSH

Remove all the current items from the cache.

GETLOCALSID [DOMAIN]

Prints the SID of the specified domain, or if the parameter is -omitted, the SID of the local server.

SETLOCALSID S-1-5-21-x-y-z

Sets SID for the local server to the specified SID.

GETDOMAINSID

Prints the local machine SID and the SID of the current -domain.

SETDOMAINSID

Sets the SID of the current domain.

GROUPMAP

Manage the mappings between Windows group SIDs and UNIX groups. -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

GROUPMAP ADD

-Add a new group mapping entry: -

-net groupmap add {rid=int|sid=string} unixgroup=string \
-	[type={domain|local}] [ntgroup=string] [comment=string]
-

-

GROUPMAP DELETE

Delete a group mapping entry. If more than one group name matches, the first entry found is deleted.

net groupmap delete {ntgroup=string|sid=SID}

GROUPMAP MODIFY

Update en existing group entry.

-

-net groupmap modify {ntgroup=string|sid=SID} [unixgroup=string] \
-       [comment=string] [type={domain|local}]
-

-

GROUPMAP LIST

List existing group mapping entries.

net groupmap list [verbose] [ntgroup=string] [sid=SID]

MAXRID

Prints out the highest RID currently in use on the local -server (by the active 'passdb backend'). -

RPC INFO

Print information about the domain of the remote server, -such as domain name, domain sid and number of users and groups. -

[RPC|ADS] TESTJOIN

Check whether participation in a domain is still valid.

[RPC|ADS] CHANGETRUSTPW

Force change of domain trust password.

RPC TRUSTDOM

RPC TRUSTDOM ADD DOMAIN

Add a interdomain trust account for DOMAIN. -This is in fact a Samba account named DOMAIN$ -with the account flag 'I' (interdomain trust account). -This is required for incoming trusts to work. It makes Samba be a -trusted domain of the foreign (trusting) domain. -Users of the Samba domain will be made available in the foreign domain. -If the command is used against localhost it has the same effect as -smbpasswd -a -i DOMAIN. Please note that both commands -expect a appropriate UNIX account. -

RPC TRUSTDOM DEL DOMAIN

Remove interdomain trust account for -DOMAIN. If it is used against localhost -it has the same effect as smbpasswd -x DOMAIN$. -

RPC TRUSTDOM ESTABLISH DOMAIN

-Establish a trust relationship to a trusted domain. -Interdomain account must already be created on the remote PDC. -This is required for outgoing trusts to work. It makes Samba be a -trusting domain of a foreign (trusted) domain. -Users of the foreign domain will be made available in our domain. -You'll need winbind and a working idmap config to make them -appear in your system. -

RPC TRUSTDOM REVOKE DOMAIN

Abandon relationship to trusted domain

RPC TRUSTDOM LIST

List all interdomain trust relationships.

RPC TRUSTDOM LIST

List all interdomain trust relationships.

RPC TRUST

RPC TRUST CREATE

Create a trust trust object by calling lsaCreateTrustedDomainEx2. -The can be done on a single server or on two servers at once with the -possibility to use a random trust password.

Options:

otherserver

Domain controller of the second domain

otheruser

Admin user in the second domain

otherdomainsid

SID of the second domain

other_netbios_domain

NetBIOS (short) name of the second domain

otherdomain

DNS (full) name of the second domain

trustpw

Trust password

Examples:

Create a trust object on srv1.dom1.dom for the domain dom2


-net rpc trust create \
-    otherdomainsid=S-x-x-xx-xxxxxxxxxx-xxxxxxxxxx-xxxxxxxxx \
-    other_netbios_domain=dom2 \
-    otherdomain=dom2.dom \
-    trustpw=12345678 \
-    -S srv1.dom1.dom
-

Create a trust relationship between dom1 and dom2


-net rpc trust create \
-    otherserver=srv2.dom2.test \
-    otheruser=dom2adm \
-    -S srv1.dom1.dom
-

RPC TRUST DELETE

Delete a trust trust object by calling lsaDeleteTrustedDomain. -The can be done on a single server or on two servers at once.

Options:

otherserver

Domain controller of the second domain

otheruser

Admin user in the second domain

otherdomainsid

SID of the second domain

Examples:

Delete a trust object on srv1.dom1.dom for the domain dom2


-net rpc trust delete \
-    otherdomainsid=S-x-x-xx-xxxxxxxxxx-xxxxxxxxxx-xxxxxxxxx \
-    -S srv1.dom1.dom
-

Delete a trust relationship between dom1 and dom2


-net rpc trust delete \
-    otherserver=srv2.dom2.test \
-    otheruser=dom2adm \
-    -S srv1.dom1.dom
-

RPC RIGHTS

This subcommand is used to view and manage Samba's rights assignments (also -referred to as privileges). There are three options currently available: -list, grant, and -revoke. More details on Samba's privilege model and its use -can be found in the Samba-HOWTO-Collection.

RPC ABORTSHUTDOWN

Abort the shutdown of a remote server.

RPC SHUTDOWN [-t timeout] [-r] [-f] [-C message]

Shut down the remote server.

-r

-Reboot after shutdown. -

-f

-Force shutting down all applications. -

-t timeout

-Timeout before system will be shut down. An interactive -user of the system can use this time to cancel the shutdown. -

-C message

Display the specified message on the screen to -announce the shutdown.

RPC SAMDUMP

Print out sam database of remote server. You need -to run this against the PDC, from a Samba machine joined as a BDC.

RPC VAMPIRE

Export users, aliases and groups from remote server to -local server. You need to run this against the PDC, from a Samba machine joined as a BDC. -

RPC VAMPIRE KEYTAB

Dump remote SAM database to local Kerberos keytab file. -

RPC VAMPIRE LDIF

Dump remote SAM database to local LDIF file or standard output. -

RPC GETSID

Fetch domain SID and store it in the local secrets.tdb.

ADS LEAVE

Make the remote host leave the domain it is part of.

ADS STATUS

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.

ADS PRINTER

ADS PRINTER INFO [PRINTER] [SERVER]

-Lookup info for PRINTER on SERVER. The printer name defaults to "*", the -server name defaults to the local host.

ADS PRINTER PUBLISH PRINTER

Publish specified printer using ADS.

ADS PRINTER REMOVE PRINTER

Remove specified printer from ADS directory.

ADS SEARCH 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 -

ADS DN DN (attributes)

-Perform a raw LDAP search on a ADS server and dump the results. The -DN standard LDAP DN, and the attributes are a list of LDAP fields -to show in the result. -

Example: net ads dn 'CN=administrator,CN=Users,DC=my,DC=domain' SAMAccountName

ADS WORKGROUP

Print out workgroup name for specified kerberos realm.

SAM CREATEBUILTINGROUP <NAME>

-(Re)Create a BUILTIN group. -Only a wellknown set of BUILTIN groups can be created with this command. -This is the list of currently recognized group names: Administrators, -Users, Guests, Power Users, Account Operators, Server Operators, Print -Operators, Backup Operators, Replicator, RAS Servers, Pre-Windows 2000 -compatible Access. - -This command requires a running Winbindd with idmap allocation properly -configured. The group gid will be allocated out of the winbindd range. -

SAM CREATELOCALGROUP <NAME>

-Create a LOCAL group (also known as Alias). - -This command requires a running Winbindd with idmap allocation properly -configured. The group gid will be allocated out of the winbindd range. -

SAM DELETELOCALGROUP <NAME>

-Delete an existing LOCAL group (also known as Alias). - -

SAM MAPUNIXGROUP <NAME>

-Map an existing Unix group and make it a Domain Group, the domain group -will have the same name. -

SAM UNMAPUNIXGROUP <NAME>

-Remove an existing group mapping entry. -

SAM ADDMEM <GROUP> <MEMBER>

-Add a member to a Local group. The group can be specified only by name, -the member can be specified by name or SID. -

SAM DELMEM <GROUP> <MEMBER>

-Remove a member from a Local group. The group and the member must be -specified by name. -

SAM LISTMEM <GROUP>

-List Local group members. The group must be specified by name. -

SAM LIST <users|groups|localgroups|builtin|workstations> [verbose]

-List the specified set of accounts by name. If verbose is specified, -the rid and description is also provided for each account. -

SAM RIGHTS LIST

-List all available privileges. -

SAM RIGHTS GRANT <NAME> <PRIVILEGE>

-Grant one or more privileges to a user. -

SAM RIGHTS REVOKE <NAME> <PRIVILEGE>

-Revoke one or more privileges from a user. -

SAM SHOW <NAME>

-Show the full DOMAIN\\NAME the SID and the type for the corresponding -account. -

SAM SET HOMEDIR <NAME> <DIRECTORY>

-Set the home directory for a user account. -

SAM SET PROFILEPATH <NAME> <PATH>

-Set the profile path for a user account. -

SAM SET COMMENT <NAME> <COMMENT>

-Set the comment for a user or group account. -

SAM SET FULLNAME <NAME> <FULL NAME>

-Set the full name for a user account. -

SAM SET LOGONSCRIPT <NAME> <SCRIPT>

-Set the logon script for a user account. -

SAM SET HOMEDRIVE <NAME> <DRIVE>

-Set the home drive for a user account. -

SAM SET WORKSTATIONS <NAME> <WORKSTATIONS>

-Set the workstations a user account is allowed to log in from. -

SAM SET DISABLE <NAME>

-Set the "disabled" flag for a user account. -

SAM SET PWNOTREQ <NAME>

-Set the "password not required" flag for a user account. -

SAM SET AUTOLOCK <NAME>

-Set the "autolock" flag for a user account. -

SAM SET PWNOEXP <NAME>

-Set the "password do not expire" flag for a user account. -

SAM SET PWDMUSTCHANGENOW <NAME> [yes|no]

-Set or unset the "password must change" flag for a user account. -

SAM POLICY LIST

-List the available account policies. -

SAM POLICY SHOW <account policy>

-Show the account policy value. -

SAM POLICY SET <account policy> <value>

-Set a value for the account policy. -Valid values can be: "forever", "never", "off", or a number. -

SAM PROVISION

-Only available if ldapsam:editposix is set and winbindd is running. -Properly populates the ldap tree with the basic accounts (Administrator) -and groups (Domain Users, Domain Admins, Domain Guests) on the ldap tree. -

IDMAP DUMP <local tdb file name>

-Dumps the mappings contained in the local tdb file specified. -This command is useful to dump only the mappings produced by the idmap_tdb backend. -

IDMAP RESTORE [input file]

-Restore the mappings from the specified file or stdin. -

IDMAP SECRET <DOMAIN> <secret>

-Store a secret for the specified domain, used primarily for domains -that use idmap_ldap as a backend. In this case the secret is used -as the password for the user DN used to bind to the ldap server. -

IDMAP DELETE [-f] [--db=<DB>] <ID>

-Delete a mapping sid <-> gid or sid <-> uid from the IDMAP database. -The mapping is given by <ID> which may either be a sid: S-x-..., a gid: "GID number" or a uid: "UID number". -Use -f to delete an invalid partial mapping <ID> -> xx -

- Use "smbcontrol all idmap ..." to notify running smbd instances. - See the smbcontrol(1) manpage for details. -

IDMAP CHECK [-v] [-r] [-a] [-T] [-f] [-l] [--db=<DB>]

- Check and repair the IDMAP database. If no option is given a read only check - of the database is done. Among others an interactive or automatic repair mode - may be chosen with one of the following options: - -

-r|--repair

- Interactive repair mode, ask a lot of questions. -

-a|--auto

- Noninteractive repair mode, use default answers. -

-v|--verbose

- Produce more output. -

-f|--force

- Try to apply changes, even if they do not apply cleanly. -

-T|--test

- Dry run, show what changes would be made but don't touch anything. -

-l|--lock

- Lock the database while doing the check. -

--db <DB>

- Check the specified database. -

-

- - It reports about the finding of the following errors: - -

Missing reverse mapping:

- A record with mapping A->B where there is no B->A. Default action - in repair mode is to "fix" this by adding the reverse mapping. -

Invalid mapping:

- A record with mapping A->B where B->C. Default action - is to "delete" this record. -

Missing or invalid HWM:

- A high water mark is not at least equal to the largest ID in the - database. Default action is to "fix" this by setting it to the - largest ID found +1. -

Invalid record:

- Something we failed to parse. Default action is to "edit" it - in interactive and "delete" it in automatic mode. -

-

USERSHARE

Starting with version 3.0.23, a Samba server now supports the ability for -non-root users to add user defined shares to be exported using the "net usershare" -commands. -

-To set this up, first set up your smb.conf by adding to the [global] section: - -usershare path = /usr/local/samba/lib/usershares - -Next create the directory /usr/local/samba/lib/usershares, change the owner to root and -set the group owner to the UNIX group who should have the ability to create usershares, -for example a group called "serverops". - -Set the permissions on /usr/local/samba/lib/usershares to 01770. - -(Owner and group all access, no access for others, plus the sticky bit, -which means that a file in that directory can be renamed or deleted only -by the owner of the file). - -Finally, tell smbd how many usershares you will allow by adding to the [global] -section of smb.conf a line such as : - -usershare max shares = 100. - -To allow 100 usershare definitions. Now, members of the UNIX group "serverops" -can create user defined shares on demand using the commands below. -

The usershare commands are: - -

net usershare add sharename path [comment [acl] [guest_ok=[y|n]]] - to add or change a user defined share.
net usershare delete sharename - to delete a user defined share.
net usershare info [-l|--long] [wildcard sharename] - to print info about a user defined share.
net usershare list [-l|--long] [wildcard sharename] - to list user defined shares.

- -

USERSHARE ADD sharename path [comment] [acl] [guest_ok=[y|n]]

-Add or replace a new user defined share, with name "sharename". -

-"path" specifies the absolute pathname on the system to be exported. -Restrictions may be put on this, see the global smb.conf parameters: -"usershare owner only", "usershare prefix allow list", and -"usershare prefix deny list". -

-The optional "comment" parameter is the comment that will appear -on the share when browsed to by a client. -

The optional "acl" field -specifies which users have read and write access to the entire share. -Note that guest connections are not allowed unless the smb.conf parameter -"usershare allow guests" has been set. The definition of a user -defined share acl is: "user:permission", where user is a valid -username on the system and permission can be "F", "R", or "D". -"F" stands for "full permissions", ie. read and write permissions. -"D" stands for "deny" for a user, ie. prevent this user from accessing -this share. -"R" stands for "read only", ie. only allow read access to this -share (no creation of new files or directories or writing to files). -

-The default if no "acl" is given is "Everyone:R", which means any -authenticated user has read-only access. -

-The optional "guest_ok" has the same effect as the parameter of the -same name in smb.conf, in that it allows guest access to this user -defined share. This parameter is only allowed if the global parameter -"usershare allow guests" has been set to true in the smb.conf. -

- -There is no separate command to modify an existing user defined share, -just use the "net usershare add [sharename]" command using the same -sharename as the one you wish to modify and specify the new options -you wish. The Samba smbd daemon notices user defined share modifications -at connect time so will see the change immediately, there is no need -to restart smbd on adding, deleting or changing a user defined share. -

USERSHARE DELETE sharename

-Deletes the user defined share by name. The Samba smbd daemon -immediately notices this change, although it will not disconnect -any users currently connected to the deleted share. -

USERSHARE INFO [-l|--long] [wildcard sharename]

-Get info on user defined shares owned by the current user matching the given pattern, or all users. -

-net usershare info on its own dumps out info on the user defined shares that were -created by the current user, or restricts them to share names that match the given -wildcard pattern ('*' matches one or more characters, '?' matches only one character). -If the '-l' or '--long' option is also given, it prints out info on user defined -shares created by other users. -

-The information given about a share looks like: - -[foobar] -path=/home/jeremy -comment=testme -usershare_acl=Everyone:F -guest_ok=n - -And is a list of the current settings of the user defined share that can be -modified by the "net usershare add" command. -

USERSHARE LIST [-l|--long] wildcard sharename

-List all the user defined shares owned by the current user matching the given pattern, or all users. -

-net usershare list on its own list out the names of the user defined shares that were -created by the current user, or restricts the list to share names that match the given -wildcard pattern ('*' matches one or more characters, '?' matches only one character). -If the '-l' or '--long' option is also given, it includes the names of user defined -shares created by other users. -

CONF

Starting with version 3.2.0, a Samba server can be configured by data -stored in registry. This configuration data can be edited with the new "net -conf" commands. -

-The deployment of this configuration data can be activated in two levels from the -smb.conf file: Share definitions from registry are -activated by setting registry shares to -“yes” in the [global] section and global configuration options are -activated by setting include = registry in -the [global] section for a mixed configuration or by setting -config backend = registry in the [global] -section for a registry-only configuration. -See the smb.conf(5) manpage for details. -

The conf commands are: -

net conf list - Dump the complete configuration in smb.conf like -format.
net conf import - Import configuration from file in smb.conf -format.
net conf listshares - List the registry shares.
net conf drop - Delete the complete configuration from -registry.
net conf showshare - Show the definition of a registry share.
net conf addshare - Create a new registry share.
net conf delshare - Delete a registry share.
net conf setparm - Store a parameter.
net conf getparm - Retrieve the value of a parameter.
net conf delparm - Delete a parameter.
net conf getincludes - Show the includes of a share definition.
net conf setincludes - Set includes for a share.
net conf delincludes - Delete includes from a share definition.

-

CONF LIST

-Print the configuration data stored in the registry in a smb.conf-like format to -standard output. -

CONF IMPORT [--test|-T] filename [section]

-This command imports configuration from a file in smb.conf format. -If a section encountered in the input file is present in registry, -its contents is replaced. Sections of registry configuration that have -no counterpart in the input file are not affected. If you want to delete these, -you will have to use the "net conf drop" or "net conf delshare" commands. -Optionally, a section may be specified to restrict the effect of the -import command to that specific section. A test mode is enabled by specifying -the parameter "-T" on the commandline. In test mode, no changes are made to the -registry, and the resulting configuration is printed to standard output instead. -

CONF LISTSHARES

-List the names of the shares defined in registry. -

CONF DROP

-Delete the complete configuration data from registry. -

CONF SHOWSHARE sharename

-Show the definition of the share or section specified. It is valid to specify -"global" as sharename to retrieve the global configuration options from -registry. -

CONF ADDSHARE sharename path [writeable={y|N} [guest_ok={y|N} [comment]]]

Create a new share definition in registry. -The sharename and path have to be given. The share name may -not be "global". Optionally, values for the very -common options "writeable", "guest ok" and a "comment" may be specified. -The same result may be obtained by a sequence of "net conf setparm" -commands. -

CONF DELSHARE sharename

-Delete a share definition from registry. -

CONF SETPARM section parameter value

-Store a parameter in registry. The section may be global or a sharename. -The section is created if it does not exist yet. -

CONF GETPARM section parameter

-Show a parameter stored in registry. -

CONF DELPARM section parameter

-Delete a parameter stored in registry. -

CONF GETINCLUDES section

-Get the list of includes for the provided section (global or share). -

-Note that due to the nature of the registry database and the nature of include directives, -the includes need special treatment: Parameters are stored in registry by the parameter -name as valuename, so there is only ever one instance of a parameter per share. -Also, a specific order like in a text file is not guaranteed. For all real -parameters, this is perfectly ok, but the include directive is rather a meta -parameter, for which, in the smb.conf text file, the place where it is specified -between the other parameters is very important. This can not be achieved by the -simple registry smbconf data model, so there is one ordered list of includes -per share, and this list is evaluated after all the parameters of the share. -

-Further note that currently, only files can be included from registry -configuration. In the future, there will be the ability to include configuration -data from other registry keys. -

CONF SETINCLUDES section [filename]+

-Set the list of includes for the provided section (global or share) to the given -list of one or more filenames. The filenames may contain the usual smb.conf -macros like %I. -

CONF DELINCLUDES section

-Delete the list of includes from the provided section (global or share). -

REGISTRY

-Manipulate Samba's registry. -

The registry commands are: -

net registry enumerate - Enumerate registry keys and values.
net registry enumerate_recursive - Enumerate registry key and its subkeys.
net registry createkey - Create a new registry key.
net registry deletekey - Delete a registry key.
net registry deletekey_recursive - Delete a registry key with subkeys.
net registry getvalue - Print a registry value.
net registry getvalueraw - Print a registry value (raw format).
net registry setvalue - Set a new registry value.
net registry increment - Increment a DWORD registry value under a lock. -
net registry deletevalue - Delete a registry value.
net registry getsd - Get security descriptor.
net registry getsd_sdd1 - Get security descriptor in sddl format. -
net registry setsd_sdd1 - Set security descriptor from sddl format -string.
net registry import - Import a registration entries (.reg) file. -
net registry export - Export a registration entries (.reg) file. -
net registry convert - Convert a registration entries (.reg) file. -

-

REGISTRY ENUMERATE key

Enumerate subkeys and values of key. -

REGISTRY ENUMERATE_RECURSIVE key

Enumerate values of key and its subkeys. -

REGISTRY CREATEKEY key

Create a new key if not yet existing. -

REGISTRY DELETEKEY key

Delete the given key and its - values from the registry, if it has no subkeys. -

REGISTRY DELETEKEY_RECURSIVE key

Delete the given key and all of its - subkeys and values from the registry. -

REGISTRY GETVALUE key name

Output type and actual value of the value name - of the given key. -

REGISTRY GETVALUERAW key name

Output the actual value of the value name - of the given key. -

REGISTRY SETVALUE key name type value ...

Set the value name - of an existing key. - type may be one of - sz, multi_sz or - dword. - In case of multi_sz value may - be given multiple times. -

REGISTRY INCREMENT key name [inc]

Increment the DWORD value name - of key by inc - while holding a g_lock. - inc defaults to 1. -

REGISTRY DELETEVALUE key name

Delete the value name - of the given key. -

REGISTRY GETSD key

Get the security descriptor of the given key. -

REGISTRY GETSD_SDDL key

Get the security descriptor of the given key as a - Security Descriptor Definition Language (SDDL) string. -

REGISTRY SETSD_SDDL keysd

Set the security descriptor of the given key from a - Security Descriptor Definition Language (SDDL) string sd. -

REGISTRY IMPORT file[opt]

Import a registration entries (.reg) file. -

REGISTRY EXPORT keyfile[opt]

Export a key to a registration entries (.reg) - file. -

REGISTRY CONVERT in out [[inopt] outopt]

Convert a registration entries (.reg) file in. -

EVENTLOG

Starting with version 3.4.0 net can read, dump, import and export native -win32 eventlog files (usually *.evt). evt files are used by the native Windows eventviewer tools. -

-The import and export of evt files can only succeed when eventlog list is used in -smb.conf file. -See the smb.conf(5) manpage for details. -

The eventlog commands are: -

net eventlog dump - Dump a eventlog *.evt file on the screen.
net eventlog import - Import a eventlog *.evt into the samba internal -tdb based representation of eventlogs.
net eventlog export - Export the samba internal tdb based representation -of eventlogs into an eventlog *.evt file.

-

EVENTLOG DUMP filename

-Prints a eventlog *.evt file to standard output. -

EVENTLOG IMPORT filename eventlog

-Imports a eventlog *.evt file defined by filename into the -samba internal tdb representation of eventlog defined by eventlog. -eventlog needs to part of the eventlog list -defined in smb.conf. -See the smb.conf(5) manpage for details. -

EVENTLOG EXPORT filename eventlog

-Exports the samba internal tdb representation of eventlog defined by eventlog -to a eventlog *.evt file defined by filename. -eventlog needs to part of the eventlog list -defined in smb.conf. -See the smb.conf(5) manpage for details. -

DOM

Starting with version 3.2.0 Samba has support for remote join and unjoin APIs, both client and server-side. Windows supports remote join capabilities since Windows 2000. -

In order for Samba to be joined or unjoined remotely an account must be used that is either member of the Domain Admins group, a member of the local Administrators group or a user that is granted the SeMachineAccountPrivilege privilege. -

The client side support for remote join is implemented in the net dom commands which are: -

net dom join - Join a remote computer into a domain.
net dom unjoin - Unjoin a remote computer from a domain.
net dom renamecomputer - Renames a remote computer joined to a domain.

-

DOM JOIN domain=DOMAIN ou=OU account=ACCOUNT password=PASSWORD reboot

-Joins a computer into a domain. This command supports the following additional parameters: -

  • DOMAIN can be a NetBIOS domain name (also known as short domain name) or a DNS domain name for Active Directory Domains. As in Windows, it is also possible to control which Domain Controller to use. This can be achieved by appending the DC name using the \ separator character. Example: MYDOM\MYDC. The DOMAIN parameter cannot be NULL.

  • OU can be set to a RFC 1779 LDAP DN, like ou=mymachines,cn=Users,dc=example,dc=com in order to create the machine account in a non-default LDAP container. This optional parameter is only supported when joining Active Directory Domains.

  • ACCOUNT defines a domain account that will be used to join the machine to the domain. This domain account needs to have sufficient privileges to join machines.

  • PASSWORD defines the password for the domain account defined with ACCOUNT.

  • REBOOT is an optional parameter that can be set to reboot the remote machine after successful join to the domain.

-Note that you also need to use standard net parameters to connect and authenticate to the remote machine that you want to join. These additional parameters include: -S computer and -U user. -

- Example: - net dom join -S xp -U XP\\administrator%secret domain=MYDOM account=MYDOM\\administrator password=topsecret reboot. -

-This example would connect to a computer named XP as the local administrator using password secret, and join the computer into a domain called MYDOM using the MYDOM domain administrator account and password topsecret. After successful join, the computer would reboot. -

DOM UNJOIN account=ACCOUNT password=PASSWORD reboot

-Unjoins a computer from a domain. This command supports the following additional parameters: -

  • ACCOUNT defines a domain account that will be used to unjoin the machine from the domain. This domain account needs to have sufficient privileges to unjoin machines.

  • PASSWORD defines the password for the domain account defined with ACCOUNT.

  • REBOOT is an optional parameter that can be set to reboot the remote machine after successful unjoin from the domain.

-Note that you also need to use standard net parameters to connect and authenticate to the remote machine that you want to unjoin. These additional parameters include: -S computer and -U user. -

- Example: - net dom unjoin -S xp -U XP\\administrator%secret account=MYDOM\\administrator password=topsecret reboot. -

-This example would connect to a computer named XP as the local administrator using password secret, and unjoin the computer from the domain using the MYDOM domain administrator account and password topsecret. After successful unjoin, the computer would reboot. -

DOM RENAMECOMPUTER newname=NEWNAME account=ACCOUNT password=PASSWORD reboot

-Renames a computer that is joined to a domain. This command supports the following additional parameters: -

  • NEWNAME defines the new name of the machine in the domain.

  • ACCOUNT defines a domain account that will be used to rename the machine in the domain. This domain account needs to have sufficient privileges to rename machines.

  • PASSWORD defines the password for the domain account defined with ACCOUNT.

  • REBOOT is an optional parameter that can be set to reboot the remote machine after successful rename in the domain.

-Note that you also need to use standard net parameters to connect and authenticate to the remote machine that you want to rename in the domain. These additional parameters include: -S computer and -U user. -

- Example: - net dom renamecomputer -S xp -U XP\\administrator%secret newname=XPNEW account=MYDOM\\administrator password=topsecret reboot. -

-This example would connect to a computer named XP as the local administrator using password secret, and rename the joined computer to XPNEW using the MYDOM domain administrator account and password topsecret. After successful rename, the computer would reboot. -

G_LOCK

Manage global locks.

G_LOCK DO lockname timeout command

-Execute a shell command under a global lock. This might be useful to define the -order in which several shell commands will be executed. The locking information -is stored in a file called g_lock.tdb. In setups with CTDB -running, the locking information will be available on all cluster nodes. -

  • LOCKNAME defines the name of the global lock.

  • TIMEOUT defines the timeout.

  • COMMAND defines the shell command to execute.

G_LOCK LOCKS

-Print a list of all currently existing locknames. -

G_LOCK DUMP lockname

-Dump the locking table of a certain global lock. -

HELP [COMMAND]

Gives usage information for the specified command.

VERSION

This man page is complete for version 3 of the Samba - suite.

AUTHOR

The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed.

The net manpage was written by Jelmer Vernooij.

diff --git a/docs/htmldocs/manpages/nmbd.8.html b/docs/htmldocs/manpages/nmbd.8.html deleted file mode 100644 index 2b06d3cd74..0000000000 --- a/docs/htmldocs/manpages/nmbd.8.html +++ /dev/null @@ -1,147 +0,0 @@ -nmbd

Name

nmbd — NetBIOS name server to provide NetBIOS - over IP naming services to clients

Synopsis

nmbd [-D] [-F] [-S] [-a] [-i] [-o] [-h] [-V] [-d <debug level>] [-H <lmhosts file>] [-l <log directory>] [-p <port number>] [-s <configuration file>]

DESCRIPTION

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.

OPTIONS

-D

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

-F

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

-S

If specified, this parameter causes - nmbd to log to standard output rather - than a file.

-i

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.

-h|--help

Print a summary of command line options. -

-H <filename>

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.

-d|--debuglevel=level

level is an integer -from 0 to 10. The default value if this parameter is -not specified is 0.

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.

-V|--version

Prints the program version number. -

-s|--configfile <configuration file>

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.

-l|--log-basename=logdirectory

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

-p <UDP port number>

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!

FILES

/etc/inetd.conf

If the server is to be run by the - inetd meta-daemon, this file - must contain suitable startup information for the - meta-daemon. -

/etc/rc

or 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/services

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

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

SIGNALS

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.

VERSION

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

SEE ALSO

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

AUTHOR

The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed.

The original Samba man pages were written by Karl Auer. - The man page sources were converted to YODL format (another - excellent piece of Open Source software, available at - ftp://ftp.icce.rug.nl/pub/unix/) and updated for the Samba 2.0 - release by Jeremy Allison. The conversion to DocBook for - Samba 2.2 was done by Gerald Carter. The conversion to DocBook - XML 4.2 for Samba 3.0 was done by Alexander Bokovoy.

diff --git a/docs/htmldocs/manpages/nmblookup.1.html b/docs/htmldocs/manpages/nmblookup.1.html deleted file mode 100644 index 05266ac1ba..0000000000 --- a/docs/htmldocs/manpages/nmblookup.1.html +++ /dev/null @@ -1,105 +0,0 @@ -nmblookup

Name

nmblookup — NetBIOS over TCP/IP client used to lookup NetBIOS - names

Synopsis

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}

DESCRIPTION

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.

OPTIONS

-M

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

-R

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

-S

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

-r

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

-A

Interpret name as - an IP Address and do a node status query on this address.

-n|--netbiosname <primary NetBIOS name>

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.

-i|--scope <scope>

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.

-W|--workgroup=domain

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

-O|--socket-options socket options

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.

-h|--help

Print a summary of command line options. -

-B <broadcast address>

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

-U <unicast address>

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.

-d|--debuglevel=level

level is an integer -from 0 to 10. The default value if this parameter is -not specified is 0.

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.

-V|--version

Prints the program version number. -

-s|--configfile <configuration file>

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.

-l|--log-basename=logdirectory

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

-T

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.

-f

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

name

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.

EXAMPLES

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.

VERSION

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

SEE ALSO

nmbd(8), samba(7), and smb.conf(5).

AUTHOR

The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed.

The original Samba man pages were written by Karl Auer. - The man page sources were converted to YODL format (another - excellent piece of Open Source software, available at - ftp://ftp.icce.rug.nl/pub/unix/) and updated for the Samba 2.0 - release by Jeremy Allison. The conversion to DocBook for - Samba 2.2 was done by Gerald Carter. The conversion to DocBook - XML 4.2 for Samba 3.0 was done by Alexander Bokovoy.

diff --git a/docs/htmldocs/manpages/ntlm_auth.1.html b/docs/htmldocs/manpages/ntlm_auth.1.html deleted file mode 100644 index 11c0db20a7..0000000000 --- a/docs/htmldocs/manpages/ntlm_auth.1.html +++ /dev/null @@ -1,157 +0,0 @@ -ntlm_auth

Name

ntlm_auth — tool to allow external access to Winbind's NTLM authentication function

Synopsis

ntlm_auth [-d debuglevel] [-l logdir] [-s <smb config file>]

DESCRIPTION

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 intended to be used by other programs (currently - Squid - and mod_ntlm_winbind) -

OPERATIONAL REQUIREMENTS

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

OPTIONS

--helper-protocol=PROTO

- Operate as a stdio-based helper. Valid helper protocols are: -

squid-2.4-basic

- Server-side helper for use with Squid 2.4's basic (plaintext) - authentication.

squid-2.5-basic

- Server-side helper for use with Squid 2.5's basic (plaintext) - authentication.

squid-2.5-ntlmssp

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

ntlmssp-client-1

- Client-side helper for use with arbitrary external - programs that may wish to use Samba's NTLMSSP - authentication knowledge.

This helper is a client, and as such may be run by any - user. The protocol used is - effectively the reverse of the previous protocol. A - YR command (without any arguments) - starts the authentication exchange. -

gss-spnego

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

gss-spnego-client

- Client-side helper that implements GSS-SPNEGO. This - also uses a protocol similar to the above helpers, but - is currently undocumented. -

ntlm-server-1

- 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 the form: - Parameter: value and Parameter:: - 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).

Currently implemented parameters from the - external program to the helper are:

Warning

Implementers should take care to base64 encode - any data (such as usernames/passwords) that may contain malicous user data, such as - a newline. They may also need to decode strings from - the helper, which likewise may have been base64 encoded.
Username

The username, expected to be in - Samba's unix charset. -

Example 1. 

Username: bob


Example 2. 

Username:: Ym9i


NT-Domain

The user's domain, expected to be in - Samba's unix charset. -

Example 3. 

NT-Domain: WORKGROUP


Example 4. 

NT-Domain:: V09SS0dST1VQ


Full-Username

The fully qualified username, expected to be in - Samba's unix charset and qualified with the - winbind separator. -

Example 5. 

Full-Username: WORKGROUP\bob


Example 6. 

Full-Username:: V09SS0dST1VQYm9i


LANMAN-Challenge

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

Example 7. 

LANMAN-Challenge: 0102030405060708


LANMAN-Response

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

Example 8. 

LANMAN-Response: 0102030405060708090A0B0C0D0E0F101112131415161718


NT-Response

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

Example 9. 

NT-Response: 0102030405060708090A0B0C0D0E0F101112131415161718


Password

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

Example 10. 

Password: samba2


Example 11. 

Password:: c2FtYmEy


Request-User-Session-Key

Upon successful authenticaiton, return - the user session key associated with the login. -

Example 12. 

Request-User-Session-Key: Yes


Request-LanMan-Session-Key

Upon successful authenticaiton, return - the LANMAN session key associated with the login. -

Example 13. 

Request-LanMan-Session-Key: Yes


--username=USERNAME

- Specify username of user to authenticate -

--domain=DOMAIN

- Specify domain of user to authenticate -

--workstation=WORKSTATION

- Specify the workstation the user authenticated from -

--challenge=STRING

NTLM challenge (in HEXADECIMAL)

--lm-response=RESPONSE

LM Response to the challenge (in HEXADECIMAL)

--nt-response=RESPONSE

NT or NTLMv2 Response to the challenge (in HEXADECIMAL)

--password=PASSWORD

User's plaintext password

If - not specified on the command line, this is prompted for when - required.

For the NTLMSSP based server roles, this parameter - specifies the expected password, allowing testing without - winbindd operational.

--request-lm-key

Retrieve LM session key

--request-nt-key

Request NT key

--diagnostics

Perform Diagnostics on the authentication - chain. Uses the password from --password - or prompts for one.

--require-membership-of={SID|Name}

Require that a user be a member of specified - group (either name or SID) for authentication to succeed.

-d|--debuglevel=level

level is an integer -from 0 to 10. The default value if this parameter is -not specified is 0.

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.

-V|--version

Prints the program version number. -

-s|--configfile <configuration file>

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.

-l|--log-basename=logdirectory

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

-h|--help

Print a summary of command line options. -

EXAMPLE SETUP

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
-

Note

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

TROUBLESHOOTING

If you're experiencing problems with authenticating Internet Explorer running - under MS Windows 9X or Millennium 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. -

VERSION

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

AUTHOR

The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed.

The ntlm_auth manpage was written by Jelmer Vernooij and - Andrew Bartlett.

diff --git a/docs/htmldocs/manpages/pam_winbind.8.html b/docs/htmldocs/manpages/pam_winbind.8.html deleted file mode 100644 index c782aae153..0000000000 --- a/docs/htmldocs/manpages/pam_winbind.8.html +++ /dev/null @@ -1,103 +0,0 @@ -pam_winbind

Name

pam_winbind — PAM module for Winbind

DESCRIPTION

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

SYNOPSIS

- Edit the PAM system config /etc/pam.d/service and modify it as the following example shows: - 

-			    ...
-			    auth      required        pam_env.so
-			    auth      sufficient      pam_unix2.so
-			+++ auth      required        pam_winbind.so  use_first_pass
-			    account   requisite       pam_unix2.so
-			+++ account   required        pam_winbind.so  use_first_pass
-			+++ password  sufficient      pam_winbind.so
-			    password  requisite       pam_pwcheck.so  cracklib
-			    password  required        pam_unix2.so    use_authtok
-			    session   required        pam_unix2.so
-			+++ session   required        pam_winbind.so
-			    ...
-

- - Make sure that pam_winbind is one of the first modules in the session part. It may retrieve - kerberos tickets which are needed by other modules. -

OPTIONS

- - pam_winbind supports several options which can either be set in - the PAM configuration files or in the pam_winbind configuration - file situated at - /etc/security/pam_winbind.conf. Options - from the PAM configuration file take precedence to those from - the configuration file. See - pam_winbind.conf(5) - for further details. - -

debug

Gives debugging output to syslog.

debug_state

Gives detailed PAM state debugging output to syslog.

require_membership_of=[SID or NAME]

- 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, an alias-SID or even an 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. -

use_first_pass

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

try_first_pass

- Same as the use_first_pass option (previous item), except that if the primary password is not - valid, PAM will prompt for a password. -

use_authtok

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

krb5_auth

- - pam_winbind can authenticate using Kerberos when winbindd is - talking to an Active Directory domain controller. Kerberos - authentication must be enabled with this parameter. When - Kerberos authentication can not succeed (e.g. due to clock - skew), winbindd will fallback to samlogon authentication over - MSRPC. When this parameter is used in conjunction with - winbind refresh tickets, winbind will - keep your Ticket Granting Ticket (TGT) uptodate by refreshing - it whenever necessary. - -

krb5_ccache_type=[type]

- - When pam_winbind is configured to try kerberos authentication - by enabling the krb5_auth option, it can - store the retrieved Ticket Granting Ticket (TGT) in a - credential cache. The type of credential cache can be set with - this option. Currently the only supported value is: - FILE. In that case a credential cache in - the form of /tmp/krb5cc_UID will be created, where UID is - replaced with the numeric user id. Leave empty to just do - kerberos authentication without having a ticket cache after the - logon has succeeded. - -

cached_login

- Winbind allows to logon using cached credentials when winbind offline logon is enabled. To use this feature from the PAM module this option must be set. -

silent

- Do not emit any messages. -

mkhomedir

- Create homedirectory for a user on-the-fly, option is valid in - PAM session block. -

warn_pwd_expire

- Defines number of days before pam_winbind starts to warn about passwords that are - going to expire. Defaults to 14 days. -

- -

PAM DATA EXPORTS

This section describes the data exported in the PAM stack which could be used in other PAM modules.

PAM_WINBIND_HOMEDIR

- This is the Windows Home Directory set in the profile tab in the user settings - on the Active Directory Server. This could be a local path or a directory on a - share mapped to a drive. -

PAM_WINBIND_LOGONSCRIPT

- The path to the logon script which should be executed if a user logs in. This is - normally a relative path to the script stored on the server. -

PAM_WINBIND_LOGONSERVER

- This exports the Active Directory server we are authenticating against. This can be - used as a variable later. -

PAM_WINBIND_PROFILEPATH

- This is the profile path set in the profile tab in the user settings. Normally - the home directory is synced with this directory on a share. -

SEE ALSO

pam_winbind.conf(5), wbinfo(1), winbindd(8), smb.conf(5)

VERSION

This man page is correct for version 3 of Samba.

AUTHOR

- The original Samba software and related utilities were created by Andrew Tridgell. Samba is now developed by - the Samba Team as an Open Source project similar to the way the Linux kernel is developed. -

This manpage was written by Jelmer Vernooij and Guenther Deschner.

diff --git a/docs/htmldocs/manpages/pam_winbind.conf.5.html b/docs/htmldocs/manpages/pam_winbind.conf.5.html deleted file mode 100644 index 67b93b459a..0000000000 --- a/docs/htmldocs/manpages/pam_winbind.conf.5.html +++ /dev/null @@ -1,71 +0,0 @@ -pam_winbind.conf

Name

pam_winbind.conf — Configuration file of PAM module for Winbind

DESCRIPTION

This configuration file is part of the samba(7) suite.

- pam_winbind.conf is the configuration file for the pam_winbind PAM - module. See - pam_winbind(8) - for further details. -

SYNOPSIS

- The pam_winbind.conf configuration file is a classic ini-style - configuration file. There is only one section (global) where - various options are defined. -

OPTIONS

- - pam_winbind supports several options which can either be set in - the PAM configuration files or in the pam_winbind configuration - file situated at - /etc/security/pam_winbind.conf. Options - from the PAM configuration file take precedence to those from - the pam_winbind.conf configuration file. - -

debug = yes|no

Gives debugging output to syslog. Defaults to "no".

debug_state = yes|no

Gives detailed PAM state debugging output to syslog. Defaults to "no".

require_membership_of = [SID or NAME]

- 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, an alias-SID or even an 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. This setting is empty by default. -

try_first_pass = yes|no

- 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. If a primary password is not valid, PAM will prompt for a password. - Default to "no". -

krb5_auth = yes|no

- - pam_winbind can authenticate using Kerberos when winbindd is - talking to an Active Directory domain controller. Kerberos - authentication must be enabled with this parameter. When - Kerberos authentication can not succeed (e.g. due to clock - skew), winbindd will fallback to samlogon authentication over - MSRPC. When this parameter is used in conjunction with - winbind refresh tickets, winbind will - keep your Ticket Granting Ticket (TGT) uptodate by refreshing - it whenever necessary. Defaults to "no". - -

krb5_ccache_type = [type]

- - When pam_winbind is configured to try kerberos authentication - by enabling the krb5_auth option, it can - store the retrieved Ticket Granting Ticket (TGT) in a - credential cache. The type of credential cache can be set with - this option. Currently the only supported value is: - FILE. In that case a credential cache in - the form of /tmp/krb5cc_UID will be created, where UID is - replaced with the numeric user id. Leave empty to just do - kerberos authentication without having a ticket cache after the - logon has succeeded. This setting is empty by default. - -

cached_login = yes|no

- Winbind allows to logon using cached credentials when winbind offline logon is enabled. To use this feature from the PAM module this option must be set. Defaults to "no". -

silent = yes|no

- Do not emit any messages. Defaults to "no". -

mkhomedir = yes|no

- Create homedirectory for a user on-the-fly, option is valid in - PAM session block. Defaults to "no". -

warn_pwd_expire = days

- Defines number of days before pam_winbind starts to warn about passwords that are - going to expire. Defaults to 14 days. -

- -

SEE ALSO

pam_winbind(8), wbinfo(1), winbindd(8), smb.conf(5)

VERSION

This man page is correct for version 3 of Samba.

AUTHOR

- The original Samba software and related utilities were created by Andrew Tridgell. Samba is now developed by - the Samba Team as an Open Source project similar to the way the Linux kernel is developed. -

This manpage was written by Jelmer Vernooij and Guenther Deschner.

diff --git a/docs/htmldocs/manpages/pdbedit.8.html b/docs/htmldocs/manpages/pdbedit.8.html deleted file mode 100644 index 6b4259c841..0000000000 --- a/docs/htmldocs/manpages/pdbedit.8.html +++ /dev/null @@ -1,170 +0,0 @@ -pdbedit

Name

pdbedit — manage the SAM database (Database of Samba Users)

Synopsis

pdbedit [-a] [-b passdb-backend] [-c account-control] [-C value] [-d debuglevel] [-D drive] [-e passdb-backend] [-f fullname] [--force-initialized-passwords] [-g] [-h homedir] [-i passdb-backend] [-I domain] [-K] [-L ] [-m] [-M SID|RID] [-N description] [-P account-policy] [-p profile] [--policies-reset] [-r] [-s configfile] [-S script] [-t] [--time-format] [-u username] [-U SID|RID] [-v] [-V] [-w] [-x] [-y] [-z] [-Z]

DESCRIPTION

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, modifying a user account, listing user - accounts, importing users accounts.

OPTIONS

-L|--list

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
-
-v|--verbose

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
-
-w|--smbpasswd-style

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:
-
-u|--user username

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.

-f|--fullname fullname

This option can be used while adding or - modifying a user account. It will specify the user's full - name.

Example: -f "Simo Sorce"

-h|--homedir homedir

This option can be used while adding or - modifying a user account. It will specify the user's home - directory network path.

Example: -h "\\\\BERSERKER\\sorce" -

-D|--drive drive

This option can be used while adding or - modifying a user account. It will specify the windows drive - letter to be used to map the home directory.

Example: -D "H:" -

-S|--script script

This option can be used while adding or - modifying a user account. It will specify the user's logon - script path.

Example: -S "\\\\BERSERKER\\netlogon\\sorce.bat" -

-p|--profile profile

This option can be used while adding or - modifying a user account. It will specify the user's profile - directory.

Example: -p "\\\\BERSERKER\\netlogon" -

-M|'--machine SID' SID|rid

- This option can be used while adding or modifying a machine account. It - will specify the machines' new primary group SID (Security Identifier) or - rid.

Example: -M S-1-5-21-2447931902-1787058256-3961074038-1201

-U|'--user SID' SID|rid

- 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

Example: '--user SID' S-1-5-21-2447931902-1787058256-3961074038-5004

Example: -U 5004

Example: '--user SID' 5004

-c|--account-control account-control

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 ]"

-K|--kickoff-time

This option is used to modify the kickoff - time for a certain user. Use "never" as argument to set the - kickoff time to unlimited. -

Example: pdbedit -K never user

-a|--create

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
-

-

Note

pdbedit does not call the unix password syncronisation - script if unix password sync - has been set. It only updates the data in the Samba - user database. -

If you wish to add a user and synchronise the password - that immediately, use smbpasswd's -a option. -

-t|--password-from-stdin

This option causes pdbedit to read the password - from standard input, rather than from /dev/tty (like the - passwd(1) program does). The password has - to be submitted twice and terminated by a newline each.

-r|--modify

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

-m|--machine

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 -

-x|--delete

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

-i|--import passdb-backend

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 -

-e|--export passdb-backend

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

-g|--group

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.

-b|--backend passdb-backend

Use a different default passdb backend.

Example: pdbedit -b xml:/root/pdb-backup.xml -l

-P|--account-policy account-policy

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
-
-C|--value account-policy-value

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
-
-y|--policies

If you specify -y, - then -i in-backend -e out-backend - applies to the account policies instead of the user database.

This option will allow to migrate account policies from their default - tdb-store into a passdb backend, e.g. an LDAP directory server.

Example: pdbedit -y -i tdbsam: -e ldapsam:ldap://my.ldap.host

--force-initialized-passwords

This option forces all users to change their - password upon next login. -

-N|--account-desc description

This option can be used while adding or - modifying a user account. It will specify the user's description - field.

Example: -N "test description" -

-Z|--logon-hours-reset

This option can be used while adding or - modifying a user account. It will reset the user's allowed logon - hours. A user may login at any time afterwards.

Example: -Z -

-z|--bad-password-count-reset

This option can be used while adding or - modifying a user account. It will reset the stored bad login - counter from a specified user.

Example: -z -

--policies-reset

This option can be used to reset the general - password policies stored for a domain to their - default values.

Example: --policies-reset -

-I|--domain

This option can be used while adding or - modifying a user account. It will specify the user's domain field.

Example: -I "MYDOMAIN" -

--time-format

This option is currently not being used.

-h|--help

Print a summary of command line options. -

-d|--debuglevel=level

level is an integer -from 0 to 10. The default value if this parameter is -not specified is 0.

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.

-V|--version

Prints the program version number. -

-s|--configfile <configuration file>

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.

-l|--log-basename=logdirectory

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

NOTES

This command may be used only by root.

VERSION

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

SEE ALSO

smbpasswd(5), samba(7)

AUTHOR

The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed.

The pdbedit manpage was written by Simo Sorce and Jelmer Vernooij.

diff --git a/docs/htmldocs/manpages/profiles.1.html b/docs/htmldocs/manpages/profiles.1.html deleted file mode 100644 index 2a7c77d73e..0000000000 --- a/docs/htmldocs/manpages/profiles.1.html +++ /dev/null @@ -1,12 +0,0 @@ -profiles

Name

profiles — A utility to report and change SIDs in registry files -

Synopsis

profiles [-v] [-c SID] [-n SID] {file}

DESCRIPTION

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

OPTIONS

file

Registry file to view or edit.

-v,--verbose

Increases verbosity of messages. -

-c SID1 -n SID2

Change all occurrences of SID1 in file by SID2. -

-h|--help

Print a summary of command line options. -

VERSION

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

AUTHOR

The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed.

The profiles man page was written by Jelmer Vernooij.

diff --git a/docs/htmldocs/manpages/rpcclient.1.html b/docs/htmldocs/manpages/rpcclient.1.html deleted file mode 100644 index 746b09599b..0000000000 --- a/docs/htmldocs/manpages/rpcclient.1.html +++ /dev/null @@ -1,211 +0,0 @@ -rpcclient

Name

rpcclient — tool for executing client side - MS-RPC functions

Synopsis

rpcclient [-A authfile] [-c <command string>] [-d debuglevel] [-h] [-l logdir] [-N] [-s <smb config file>] [-U username[%password]] [-W workgroup] [-I destinationIP] {server}

DESCRIPTION

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.

OPTIONS

server

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

-c|--command=<command string>

Execute semicolon separated commands (listed - below)

-I|--dest-ip IP-address

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.

-p|--port port

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.

-d|--debuglevel=level

level is an integer -from 0 to 10. The default value if this parameter is -not specified is 0.

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.

-V|--version

Prints the program version number. -

-s|--configfile <configuration file>

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.

-l|--log-basename=logdirectory

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

-N|--no-pass

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.

If a password is specified on the command line and this -option is also defined the password on the command line will -be silently ingnored and no password will be used.

-k|--kerberos

-Try to authenticate with kerberos. Only useful in -an Active Directory environment. -

-C|--use-ccache

-Try to use the credentials cached by winbind. -

-A|--authentication-file=filename

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.

-U|--user=username[%password]

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.

-n|--netbiosname <primary NetBIOS name>

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.

-i|--scope <scope>

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.

-W|--workgroup=domain

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

-O|--socket-options socket options

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.

-h|--help

Print a summary of command line options. -

COMMANDS

LSARPC

lsaquery

Query info policy

lookupsids

Resolve a list - of SIDs to usernames. -

lookupnames

Resolve a list - of usernames to SIDs. -

enumtrusts

Enumerate trusted domains

enumprivs

Enumerate privileges

getdispname

Get the privilege name

lsaenumsid

Enumerate the LSA SIDS

lsaenumprivsaccount

Enumerate the privileges of an SID

lsaenumacctrights

Enumerate the rights of an SID

lsaenumacctwithright

Enumerate accounts with a right

lsaaddacctrights

Add rights to an account

lsaremoveacctrights

Remove rights from an account

lsalookupprivvalue

Get a privilege value given its name

lsaquerysecobj

Query LSA security object

LSARPC-DS

dsroledominfo

Get Primary Domain Information

DFS

dfsexist

Query DFS support

dfsadd

Add a DFS share

dfsremove

Remove a DFS share

dfsgetinfo

Query DFS share info

dfsenum

Enumerate dfs shares

REG

shutdown

Remote Shutdown

abortshutdown

Abort Shutdown

SRVSVC

srvinfo

Server query info

netshareenum

Enumerate shares

netfileenum

Enumerate open files

netremotetod

Fetch remote time of day

SAMR

queryuser

Query user info

querygroup

Query group info

queryusergroups

Query user groups

querygroupmem

Query group membership

queryaliasmem

Query alias membership

querydispinfo

Query display info

querydominfo

Query domain info

enumdomusers

Enumerate domain users

enumdomgroups

Enumerate domain groups

enumalsgroups

Enumerate alias groups

createdomuser

Create domain user

samlookupnames

Look up names

samlookuprids

Look up names

deletedomuser

Delete domain user

samquerysecobj

Query SAMR security object

getdompwinfo

Retrieve domain password info

lookupdomain

Look up domain

SPOOLSS

adddriver <arch> <config> [<version>]

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

addprinter <printername> - <sharename> <drivername> <port>

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

deldriver <driver>

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

deldriverex <driver> [architecture] [version] -

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

enumdata

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

enumdataex

Enumerate printer data for a key

enumjobs <printer>

List the jobs and status of a given printer. - This command corresponds to the MS Platform SDK EnumJobs() - function

enumkey

Enumerate - printer keys

enumports [level]

- Executes an EnumPorts() call using the specified - info level. Currently only info levels 1 and 2 are supported. -

enumdrivers [level]

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

enumprinters [level]

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.

getdata <printername> <valuename;>

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.

getdataex

Get - printer driver data with - keyname

getdriver <printername>

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

getdriverdir <arch>

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

getprinter <printername>

Retrieve the current printer information. This command - corresponds to the GetPrinter() MS Platform SDK function. -

getprintprocdir

Get - print processor - directory

openprinter <printername>

Execute an OpenPrinterEx() and ClosePrinter() RPC - against a given printer.

setdriver <printername> - <drivername>

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.

addform

Add form

setform

Set form

getform

Get form

deleteform

Delete form

enumforms

Enumerate form

setprinter

Set printer comment

setprinterdata

Set REG_SZ printer data

setprintername <printername> - <newprintername>

Set printer name

rffpcnex

Rffpcnex test

NETLOGON

logonctrl2

Logon Control 2

logonctrl

Logon Control

samsync

Sam Synchronisation

samdeltas

Query Sam Deltas

samlogon

Sam Logon

GENERAL COMMANDS

debuglevel

Set the current - debug level used to log information.

help (?)

Print a listing of all - known commands or extended help on a particular command. -

quit (exit)

Exit rpcclient - .

BUGS

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.

VERSION

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

AUTHOR

The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed.

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

diff --git a/docs/htmldocs/manpages/samba.7.html b/docs/htmldocs/manpages/samba.7.html deleted file mode 100644 index 873e38452a..0000000000 --- a/docs/htmldocs/manpages/samba.7.html +++ /dev/null @@ -1,113 +0,0 @@ -samba

Name

samba — A Windows SMB/CIFS fileserver for UNIX

Synopsis

samba

DESCRIPTION

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.

smbd(8)

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

nmbd(8)

The nmbd - daemon provides NetBIOS nameservice and browsing - support. The configuration file for this daemon - is described in smb.conf(5)

smbclient(1)

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

testparm(1)

The testparm - utility is a simple syntax checker for Samba's smb.conf(5) configuration file.

testprns(1)

The testprns - utility supports testing printer names defined - in your printcap file used - by Samba.

smbstatus(1)

The smbstatus - tool provides access to information about the - current connections to smbd.

nmblookup(1)

The nmblookup - tools allows NetBIOS name queries to be made - from a UNIX host.

smbpasswd(8)

The smbpasswd - command is a tool for changing LanMan and Windows NT - password hashes on Samba and Windows NT servers.

smbcacls(1)

The smbcacls command is - a tool to set ACL's on remote CIFS servers.

smbsh(1)

The smbsh command is - a program that allows you to run a unix shell with - with an overloaded VFS.

smbtree(1)

The smbtree command - is a text-based network neighborhood tool.

smbtar(1)

The smbtar can make - backups of data on CIFS/SMB servers.

smbspool(8)

smbspool is a - helper utility for printing on printers connected - to CIFS servers.

smbcontrol(1)

smbcontrol is a utility - that can change the behaviour of running samba daemons. -

rpcclient(1)

rpcclient is a utility - that can be used to execute RPC commands on remote - CIFS servers.

pdbedit(8)

The pdbedit command - can be used to maintain the local user database on - a samba server.

findsmb(1)

The findsmb command - can be used to find SMB servers on the local network. -

net(8)

The net command - is supposed to work similar to the DOS/Windows - NET.EXE command.

swat(8)

swat is a web-based - interface to configuring smb.conf. -

winbindd(8)

winbindd is a daemon - that is used for integrating authentication and - the user database into unix.

wbinfo(1)

wbinfo is a utility - that retrieves and stores information related to winbind. -

profiles(1)

profiles is a command-line - utility that can be used to replace all occurrences of - a certain SID with another SID. -

log2pcap(1)

log2pcap is a utility - for generating pcap trace files from Samba log - files.

vfstest(1)

vfstest is a utility - that can be used to test vfs modules.

ntlm_auth(1)

ntlm_auth is a helper-utility - for external programs wanting to do NTLM-authentication. -

-smbmount(8), -smbumount(8), -smbmnt(8)

smbmount,smbumount and smbmnt are commands that can be used to - mount CIFS/SMB shares on Linux. -

smbcquotas(1)

smbcquotas is a tool that - can set remote QUOTA's on server with NTFS 5.

COMPONENTS

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

AVAILABILITY

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.

VERSION

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

CONTRIBUTIONS

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

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.

AUTHOR

The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed.

The original Samba man pages were written by Karl Auer. - The man page sources were converted to YODL format (another - excellent piece of Open Source software, available at - ftp://ftp.icce.rug.nl/pub/unix/) and updated for the Samba 2.0 - release by Jeremy Allison. The conversion to DocBook for - Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML - 4.2 for Samba 3.0 was done by Alexander Bokovoy.

diff --git a/docs/htmldocs/manpages/sharesec.1.html b/docs/htmldocs/manpages/sharesec.1.html deleted file mode 100644 index 5c591c0288..0000000000 --- a/docs/htmldocs/manpages/sharesec.1.html +++ /dev/null @@ -1,82 +0,0 @@ -sharesec

Name

sharesec — Set or get share ACLs

Synopsis

sharesec {sharename} [-r, --remove=ACL] [-m, --modify=ACL] [-a, --add=ACL] [-R, --replace=ACLs] [-D, --delete] [-v, --view] [-M, --machine-sid] [-F, --force] [-d, --debuglevel=DEBUGLEVEL] [-s, --configfile=CONFIGFILE] [-l, --log-basename=LOGFILEBASE] [-V, --version] [-?, --help] [--usage]

DESCRIPTION

This tool is part of the samba(7) suite.

The sharesec program manipulates share permissions - on SMB file shares.

OPTIONS

The following options are available to the sharesec program. - The format of ACLs is described in the section ACL FORMAT

-a|--add=ACL

Add the ACEs specified to the ACL list. -

-D|--delete

Delete the entire security descriptor. -

-F|--force

Force storing the ACL. -

-m|--modify=ACL

Modify existing ACEs. -

-M|--machine-sid

Initialize the machine SID. -

-r|--remove=ACL

Remove ACEs. -

-R|--replace=ACLS

- Overwrite an existing share permission ACL. -

-h|--help

Print a summary of command line options. -

-d|--debuglevel=level

level is an integer -from 0 to 10. The default value if this parameter is -not specified is 0.

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.

-V|--version

Prints the program version number. -

-s|--configfile <configuration file>

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.

-l|--log-basename=logdirectory

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

ACL FORMAT

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 - 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 ALLOWED or DENIED to allow/deny access - to the SID. The flags values are generally zero for share ACLs. -

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

EXIT STATUS

The sharesec 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, sharesec returns and exit - status of 0. If sharesec 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.

EXAMPLES

Add full access for SID - S-1-5-21-1866488690-1365729215-3963860297-17724 on - share: - 

-	host:~ # sharesec share -a S-1-5-21-1866488690-1365729215-3963860297-17724:ALLOWED/0/FULL
-

List all ACEs for share: - 

-	host:~ # sharesec share -v
-	REVISION:1
-	OWNER:(NULL SID)
-	GROUP:(NULL SID)
-	ACL:S-1-1-0:ALLOWED/0/0x101f01ff
-	ACL:S-1-5-21-1866488690-1365729215-3963860297-17724:ALLOWED/0/FULL
-

VERSION

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

AUTHOR

The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed.

diff --git a/docs/htmldocs/manpages/smb.conf.5.html b/docs/htmldocs/manpages/smb.conf.5.html deleted file mode 100644 index 144310ffce..0000000000 --- a/docs/htmldocs/manpages/smb.conf.5.html +++ /dev/null @@ -1,6976 +0,0 @@ -smb.conf

Name

smb.conf — The configuration file for the Samba suite

SYNOPSIS

- The smb.conf file is a configuration file for the Samba suite. smb.conf contains runtime configuration information for the Samba programs. The - smb.conf file is designed to be configured and administered by the - swat(8) program. The - complete description of the file format and possible parameters held within are here for reference purposes. -

FILE FORMAT

- The file consists of sections and parameters. A section begins with the name of the section in square brackets - and continues until the next section begins. Sections contain parameters of the form: -

-name = value 
-

-

- The file is line-based - that is, each newline-terminated line represents either a comment, a section name or - a parameter. -

Section and parameter names are not case sensitive.

- Only the first equals sign in a parameter is significant. Whitespace before or after the first equals sign is - discarded. Leading, trailing and internal whitespace in section and parameter names is irrelevant. Leading - and trailing whitespace in a parameter value is discarded. Internal whitespace within a parameter value is - retained verbatim. -

- Any line beginning with a semicolon (“;”) or a hash (“#”) - character is ignored, as are lines containing only whitespace. -

- Any line ending in a “\” is continued on the next line in the customary UNIX fashion. -

- The values following the equals sign in parameters are all either a string (no quotes needed) or a boolean, - which may be given as yes/no, 1/0 or true/false. Case is not significant in boolean values, but is preserved - in string values. Some items such as create masks are numeric. -

SECTION DESCRIPTIONS

- Each section in the configuration file (except for the [global] section) describes a shared resource (known as - a “share”). The section name is the name of the shared resource and the parameters within the - section define the shares attributes. -

- There are three special sections, [global], [homes] and [printers], which are described under - special sections. The following notes apply to ordinary section descriptions. -

- A share consists of a directory to which access is being given plus a description of the access rights - which are granted to the user of the service. Some housekeeping options are also specifiable. -

- Sections are either file share services (used by the client as an extension of their native file systems) - or printable services (used by the client to access print services on the host running the server). -

- Sections may be designated guest services, in which case no password is required to - access them. A specified UNIX guest account is used to define access privileges in this - case. -

- Sections other than guest services will require a password to access them. The client provides the - username. As older clients only provide passwords and not usernames, you may specify a list of usernames to - check against the password using the user = option in the share definition. For modern clients - such as Windows 95/98/ME/NT/2000, this should not be necessary. -

- The access rights granted by the server are masked by the access rights granted to the specified or guest - UNIX user by the host system. The server does not grant more access than the host system grants. -

- The following sample section defines a file space share. The user has write access to the path /home/bar. The share is accessed via the share name foo: -

-	[foo]
-	path = /home/bar
-	read only = no
-

-

- The following sample section defines a printable share. The share is read-only, but printable. That is, - the only write access permitted is via calls to open, write to and close a spool file. The guest - ok parameter means access will be permitted as the default guest user (specified elsewhere): -

-	[aprinter]
-	path = /usr/spool/public
-	read only = yes
-	printable = yes
-	guest ok = yes
-

-

SPECIAL SECTIONS

The [global] section

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

The [homes] section

- If a section called [homes] is included in the configuration file, services connecting clients - to their home directories can be created on the fly by the server. -

- When the connection request is made, the existing sections are scanned. If a match is found, it is - used. If no match is found, the requested section name is treated as a 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. -

The [printers] section

- This section works like [homes], but for printers. -

- If a [printers] section occurs in the configuration file, users are able to connect to any printer - specified in the local host's printcap file. -

- When a connection request is made, the existing sections are scanned. If a match is found, it is used. - If no match is found, but a [homes] section exists, it is used as described above. Otherwise, the requested - section name is treated as a printer name and the appropriate printcap file is scanned to see if the requested - section name is a valid printer share name. If a match is found, a new printer share is created by cloning the - [printers] section. -

- A few modifications are then made to the newly created share: -

  • The share name is set to the located printer name

  • If no printer name was given, the printer name is set to the located printer name

  • If the share does not permit guest access and no username was given, the username is set - to the located printer name.

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

- Typically the path specified is that of a world-writeable spool directory with the sticky bit set on - it. A typical [printers] entry looks like this: -

-[printers]
-path = /usr/spool/public
-guest ok = yes
-printable = yes
-

-

- All aliases given for a printer in the printcap file are legitimate printer names as far as the server is concerned. - If your printing subsystem doesn't work like that, you will have to set up a pseudo-printcap. This is a file - consisting of one or more lines like this: -

-alias|alias|alias|alias...    
-

-

- Each alias should be an acceptable printer name for your printing subsystem. In the [global] section, - specify the new file as your printcap. The server will only recognize names found in your pseudo-printcap, - which of course can contain whatever aliases you like. The same technique could be used simply to limit access - to a subset of your local printers. -

- An alias, by the way, is defined as any component of the first entry of a printcap record. Records are separated by newlines, - components (if there are more than one) are separated by vertical bar symbols (|). -

Note

- On SYSV systems which use lpstat to determine what printers are defined on the system you may be able to use - printcap name = lpstat to automatically obtain a list of printers. See the - printcap name option for more details. -

USERSHARES

Starting with Samba version 3.0.23 the capability for non-root users to add, modify, and delete - their own share definitions has been added. This capability is called usershares and - is controlled by a set of parameters in the [global] section of the smb.conf. - The relevant parameters are : -

usershare allow guests

Controls if usershares can permit guest access.

usershare max shares

Maximum number of user defined shares allowed.

usershare owner only

If set only directories owned by the sharing user can be shared.

usershare path

Points to the directory containing the user defined share definitions. - The filesystem permissions on this directory control who can create user defined shares.

usershare prefix allow list

Comma-separated list of absolute pathnames restricting what directories - can be shared. Only directories below the pathnames in this list are permitted.

usershare prefix deny list

Comma-separated list of absolute pathnames restricting what directories - can be shared. Directories below the pathnames in this list are prohibited.

usershare template share

Names a pre-existing share used as a template for creating new usershares. - All other share parameters not specified in the user defined share definition - are copied from this named share.

To allow members of the UNIX group foo to create user defined - shares, create the directory to contain the share definitions as follows: -

Become root:

-mkdir /usr/local/samba/lib/usershares
-chgrp foo /usr/local/samba/lib/usershares
-chmod 1770 /usr/local/samba/lib/usershares
-

Then add the parameters - -

-	usershare path = /usr/local/samba/lib/usershares
-	usershare max shares = 10 # (or the desired number of shares)
-

- - to the global - section of your smb.conf. Members of the group foo may then manipulate the user defined shares - using the following commands.

net usershare add sharename path [comment] [acl] [guest_ok=[y|n]]

To create or modify (overwrite) a user defined share.

net usershare delete sharename

To delete a user defined share.

net usershare list wildcard-sharename

To list user defined shares.

net usershare info wildcard-sharename

To print information about user defined shares.

PARAMETERS

Parameters define the specific attributes of sections.

- Some parameters are specific to the [global] section (e.g., security). Some parameters - are usable in all sections (e.g., create 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. -

VARIABLE SUBSTITUTIONS

- Many of the strings that are settable in the config file can take substitutions. For example the option - “path = /tmp/%u” is interpreted as “path = /tmp/john” if the user connected with the - username john. -

- These substitutions are mostly noted in the descriptions below, but there are some general substitutions - which apply whenever they might be relevant. These are: -

%U

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

%G

primary group name of %U.

%h

the Internet hostname that Samba is running on.

%m

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

This parameter is not available when Samba listens on port 445, as clients no longer - send this information. If you use this macro in an include statement on a domain that has - a Samba domain controller be sure to set in the [global] section smb ports = - 139. This will cause Samba to not listen on port 445 and will permit include - functionality to function as it did with Samba 2.x. -

%L

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

%M

the Internet name of the client machine. -

%R

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

%d

the process id of the current server - process.

%a

- The architecture of the remote - machine. It currently recognizes Samba (Samba), - the Linux CIFS file system (CIFSFS), OS/2, (OS2), - Mac OS X (OSX), Windows for Workgroups (WfWg), Windows 9x/ME - (Win95), Windows NT (WinNT), - Windows 2000 (Win2K), - Windows XP (WinXP), - Windows XP 64-bit(WinXP64), - Windows 2003 including - 2003R2 (Win2K3), and Windows - Vista (Vista). Anything else will be known as - UNKNOWN.

%I

the IP address of the client machine.

Before 3.6.0 it could contain IPv4 mapped IPv6 addresses, - now it only contains IPv4 or IPv6 addresses.

%i

the local IP address to which a client connected.

Before 3.6.0 it could contain IPv4 mapped IPv6 addresses, - now it only contains IPv4 or IPv6 addresses.

%T

the current date and time.

%D

name of the domain or workgroup of the current user.

%w

the winbind separator.

%$(envvar)

the value of the environment variable - envar.

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

%S

the name of the current service, if any.

%P

the root directory of the current service, if any.

%u

username of the current service, if any.

%g

primary group name of %u.

%H

the home directory of the user given by %u.

%N

- the name of your NIS home directory server. This is obtained from your NIS auto.map entry. - If you have not compiled Samba with the --with-automount option, this - value will be the same as %L.

%p

- the path of the service's home directory, obtained from your NIS auto.map entry. The NIS - auto.map entry is split up as %N:%p.

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

NAME MANGLING

- Samba supports name mangling so that DOS and Windows clients can use files that don't - conform to the 8.3 format. It can also be set to adjust the case of 8.3 format filenames. -

- There are several options that control the way mangling is performed, and they are grouped here rather - than listed separately. For the defaults look at the output of the testparm program. -

- These options can be set separately for each service. -

- The options are: -

case sensitive = yes/no/auto

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

default case = upper/lower

- controls what the default case is for new filenames (ie. files that don't currently exist in the filesystem). - Default lower. IMPORTANT NOTE: As part of the optimizations for directories containing - large numbers of files, the following special case applies. If the options - case sensitive = yes, preserve case = No, and - short preserve case = No are set, then the case of all - incoming client filenames, not just new filenames, will be modified. See additional notes below. -

preserve case = yes/no

- controls whether new files (ie. files that don't currently exist in the filesystem) are created with the case - that the client passes, or if they are forced to be the default case. Default - yes. -

short preserve case = yes/no

- controls if new files (ie. files that don't currently exist in the filesystem) 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. As a special case for directories with large numbers of files, if the case - options are set as follows, "case sensitive = yes", "case preserve = no", "short preserve case = no" - then the "default case" option will be applied and will modify all filenames sent from the client - when accessing this share. -

NOTE ABOUT USERNAME/PASSWORD VALIDATION

- There are a number of ways in which a user can connect to a service. The server uses the following steps - in determining if it will allow a connection to a specified service. If all the steps fail, 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. -

  1. - 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%username method of passing a username. -

  2. - If the client has previously registered a username with the system and now supplies a correct password for that - username, the connection is allowed. -

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

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

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

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

REGISTRY-BASED CONFIGURATION

- Starting with Samba version 3.2.0, the capability to - store Samba configuration in the registry is available. - The configuration is stored in the registry key - HKLM\Software\Samba\smbconf. - There are two levels of registry configuration: -

  1. Share definitions stored in registry are used. - This is triggered by setting the global - parameter registry shares - to “yes” in smb.conf. -

    The registry shares are loaded not at startup but - on demand at runtime by smbd. - Shares defined in smb.conf take - priority over shares of the same name defined in - registry.

  2. Global smb.conf - options stored in registry are used. This can be activated - in two different ways:

    Firstly, a registry only configuration is triggered - by setting - config backend = registry - in the [global] section of smb.conf. - This resets everything that has been read from config files - to this point and reads the content of the global configuration - section from the registry. - This is the recommended method of using registry based - configuration.

    Secondly, a mixed configuration can be activated - by a special new meaning of the parameter - include = registry - in the [global] section of smb.conf. - This reads the global options from registry with the same - priorities as for an include of a text file. - This may be especially useful in cases where an initial - configuration is needed to access the registry.

    Activation of global registry options automatically - activates registry shares. So in the registry only case, - shares are loaded on demand only.

- Note: To make registry-based configurations foolproof - at least to a certain extent, the use - of lock directory and - config backend - inside the registry configuration has been disabled: - Especially by changing the - lock directory inside the registry - configuration, one would create a broken setup where the daemons - do not see the configuration they loaded once it is active. -

- The registry configuration can be accessed with - tools like regedit or net (rpc) - registry in the key - HKLM\Software\Samba\smbconf. - - More conveniently, the conf subcommand of the - net(8) utility - offers a dedicated interface to read and write the - registry based configuration locally, i.e. directly - accessing the database file, circumventing the - server. -

EXPLANATION OF EACH PARAMETER

- -abort shutdown script (G) -

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

Default: abort shutdown script = "" - -

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

- -access based share enum (S) -

If this parameter is yes for a - service, then the share hosted by the service will only be visible - to users who have read or write access to the share during share - enumeration (for example net view \\sambaserver). This has - parallels to access based enumeration, the main difference being - that only share permissions are evaluated, and security - descriptors on files contained on the share are not used in - computing enumeration access rights.

Default: access based share enum = no - -

- -acl check permissions (S) -

This boolean parameter controls what smbd(8)does on receiving a protocol request of "open for delete" - from a Windows client. If a Windows client doesn't have permissions to delete a file then they - expect this to be denied at open time. POSIX systems normally only detect restrictions on delete by - actually attempting to delete the file or directory. As Windows clients can (and do) "back out" a - delete request by unsetting the "delete on close" bit Samba cannot delete the file immediately - on "open for delete" request as we cannot restore such a deleted file. With this parameter set to - true (the default) then smbd checks the file system permissions directly on "open for delete" and denies the - request without actually deleting the file if the file system permissions would seem to deny it. - This is not perfect, as it's possible a user could have deleted a file without Samba being able to - check the permissions correctly, but it is close enough to Windows semantics for mostly correct - behaviour. Samba will correctly check POSIX ACL semantics in this case. -

If this parameter is set to "false" Samba doesn't check permissions on "open for delete" - and allows the open. If the user doesn't have permission to delete the file this will only be - discovered at close time, which is too late for the Windows user tools to display an error message - to the user. The symptom of this is files that appear to have been deleted "magically" re-appearing - on a Windows explorer refresh. This is an extremely advanced protocol option which should not - need to be changed. This parameter was introduced in its final form in 3.0.21, an earlier version - with slightly different semantics was introduced in 3.0.20. That older version is not documented here. -

Default: acl check permissions = True - -

- -acl compatibility (G) -

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

- -acl group control (S) -

- 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 way as Windows. This allows all members of a UNIX group to - control the permissions on a file or directory they have group ownership on. -

- This parameter is best used with the inherit owner option and also - on on a share containing directories with the UNIX setgid bit set - on them, which causes new files and directories created within it to inherit the group - ownership from the containing directory. -

- This is parameter has been was deprecated in Samba 3.0.23, but re-activated in - Samba 3.0.31 and above, as it now only controls permission changes if the user - is in the owning primary group. It is now no longer equivalent to the - dos filemode option. -

Default: acl group control = no - -

- -acl map full control (S) -

- This boolean parameter controls whether smbd(8) maps a POSIX ACE entry of "rwx" (read/write/execute), the maximum - allowed POSIX permission set, into a Windows ACL of "FULL CONTROL". If this parameter is set to true any POSIX - ACE entry of "rwx" will be returned in a Windows ACL as "FULL CONTROL", is this parameter is set to false any - POSIX ACE entry of "rwx" will be returned as the specific Windows ACL bits representing read, write and - execute. -

Default: acl map full control = True - -

- -add group script (G) -

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

Default: add group script = - -

Example: add group script = /usr/sbin/groupadd %g - -

- -add machine script (G) -

- This is the full pathname to a script that will be run by - smbd(8) when a machine is - added to Samba's domain and a Unix account matching the machine's name appended with a "$" does not - already exist. -

This option is very similar to the add user script, and likewise uses the %u - substitution for the account name. Do not use the %m - substitution.

Default: add machine script = - -

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

- -add port command (G) -

Samba 3.0.23 introduced support for adding printer ports - remotely using the Windows "Add Standard TCP/IP Port Wizard". - This option defines an external program to be executed when - smbd receives a request to add a new Port to the system. - The script is passed two parameters:

  • port name

  • device URI

The deviceURI is in the format of socket://<hostname>[:<portnumber>] - or lpd://<hostname>/<queuename>.

Default: add port command = - -

Example: add port command = /etc/samba/scripts/addport.sh - -

- -addprinter command (G) -

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

For a Samba host this means that the printer must be - physically added to the underlying printing system. - The addprinter command - defines a script to be run which - will perform the necessary operations for adding the printer - to the print system and to add the appropriate service definition - to the smb.conf file in order that it can be - shared by smbd(8).

The addprinter command is - automatically invoked with the following parameter (in - order):

  • printer name

  • share name

  • port name

  • driver name

  • location

  • Windows 9x driver location

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

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

- The addprinter command program - can output a single line of text, - which Samba will set as the port the new printer is connected to. - If this line isn't output, Samba won't reload its printer shares. -

Default: addprinter command = - -

Example: addprinter command = /usr/bin/addprinter - -

- -add share command (G) -

- Samba 2.2.0 introduced the ability to dynamically add and delete shares via the Windows NT 4.0 Server - Manager. The add share command is used to define an external program - or script which will add a new service definition to - smb.conf. -

- In order to successfully execute the - add share command, - smbd requires that the administrator - connects using a root account (i.e. uid == 0) or has the - SeDiskOperatorPrivilege. - Scripts defined in the add share command - parameter are executed as root. -

- When executed, smbd will automatically invoke the - add share command with five parameters. -

  • configFile - the location of the global smb.conf file. -

  • shareName - the name of the new share. -

  • pathName - path to an **existing** - directory on disk. -

  • comment - comment string to associate with the new - share. -

  • max - connections - Number of maximum simultaneous connections to this - share. -

- This parameter is only used to add file shares. To add printer shares, see the addprinter command. -

Default: add share command = - -

Example: add share command = /usr/local/bin/addshare - -

- -add user script (G) -

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

- -add user to group script (G) -

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

- -administrative share (S) -

If this parameter is set to yes for - a share, then the share will be an administrative share. The Administrative - Shares are the default network shares created by all Windows NT-based - operating systems. These are shares like C$, D$ or ADMIN$. The type of these - shares is STYPE_DISKTREE_HIDDEN.

See the section below on security for more - information about this option.

Default: administrative share = no - -

- -admin users (S) -

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

- -afs share (S) -

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

- -afs username map (G) -

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

- -aio read size (S) -

If Samba has been built with asynchronous I/O support and this - integer parameter is set to non-zero value, - Samba will read from file asynchronously when size of request is bigger - than this value. Note that it happens only for non-chained and non-chaining - reads and when not using write cache.

Current implementation of asynchronous I/O in Samba 3.0 does support - only up to 10 outstanding asynchronous requests, read and write combined.

Related command: write cache size

Related command: aio write size

Default: aio read size = 0 - -

Example: aio read size = 16384 -# Use asynchronous I/O for reads bigger than 16KB - request size - -

- -aio write behind (S) -

If Samba has been built with asynchronous I/O support, - Samba will not wait until write requests are finished before returning - the result to the client for files listed in this parameter. - Instead, Samba will immediately return that the write - request has been finished successfully, no matter if the - operation will succeed or not. This might speed up clients without - aio support, but is really dangerous, because data could be lost - and files could be damaged. -

- The syntax is identical to the veto files - parameter. -

Default: aio write behind = - -

Example: aio write behind = /*.tmp/ - -

- -aio write size (S) -

If Samba has been built with asynchronous I/O support and this - integer parameter is set to non-zero value, - Samba will write to file asynchronously when size of request is bigger - than this value. Note that it happens only for non-chained and non-chaining - reads and when not using write cache.

Current implementation of asynchronous I/O in Samba 3.0 does support - only up to 10 outstanding asynchronous requests, read and write combined.

Related command: write cache size

Related command: aio read size

Default: aio write size = 0 - -

Example: aio write size = 16384 -# Use asynchronous I/O for writes bigger than 16KB - request size - -

- -algorithmic rid base (G) -

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 arbitrary-rid supporting backends. -

Default: algorithmic rid base = 1000 - -

Example: algorithmic rid base = 100000 - -

- -allocation roundup size (S) -

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

- -allow insecure wide links (G) -

- In normal operation the option wide links - which allows the server to follow symlinks outside of a share path - is automatically disabled when unix extensions - are enabled on a Samba server. This is done for security purposes - to prevent UNIX clients creating symlinks to areas of the server - file system that the administrator does not wish to export. -

- Setting allow insecure wide links to - true disables the link between these two parameters, removing - this protection and allowing a site to configure - the server to follow symlinks (by setting wide links - to "true") even when unix extensions - is turned on. -

- If is not recommended to enable this option unless you - fully understand the implications of allowing the server to - follow symbolic links created by UNIX clients. For most - normal Samba configurations this would be considered a security - hole and setting this parameter is not recommended. -

- This option was added at the request of sites who had - deliberately set Samba up in this way and needed to continue - supporting this functionality without having to patch the - Samba code. -

Default: allow insecure wide links = no - -

- -allow trusted domains (G) -

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

- -announce as (G) -

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

- -announce version (G) -

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

- -async smb echo handler (G) -

This parameter specifies whether Samba should fork the - async smb echo handler. It can be beneficial if your file - system can block syscalls for a very long time. In some - circumstances, it prolongs the timeout that Windows uses to - determine whether a connection is dead. -

Default: async smb echo handler = no - -

- -auth methods (G) -

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

- -available (S) -

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

- -bind interfaces only (G) -

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 on those interfaces. Note that you should not use this parameter for machines that - are serving PPP or other intermittent or non-broadcast network interfaces as it will not cope with - non-permanent interfaces. -

- If bind interfaces only is set and the network address - 127.0.0.1 is not added to the interfaces parameter list - smbpasswd(8) and - swat(8) may not work as - expected due to the reasons covered below. -

- To change a users SMB password, the smbpasswd by default connects to the - localhost - 127.0.0.1 address as an SMB client to issue the password change request. If - bind interfaces only is set then unless the network address - 127.0.0.1 is added to the interfaces parameter list then smbpasswd will fail to connect in it's default mode. smbpasswd can be forced to use the primary IP interface of the local host by using - its smbpasswd(8) -r remote machine parameter, with remote - machine set to the IP name of the primary interface of the local host. -

- The swat status page tries to connect with smbd and nmbd at the address - 127.0.0.1 to determine if they are running. Not adding 127.0.0.1 - will cause smbd and nmbd to always show - "not running" even if they really are. This can prevent swat - from starting/stopping/restarting smbd and nmbd. -

Default: bind interfaces only = no - -

- -blocking locks (S) -

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

- -block size (S) -

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

Default: block size = 1024 - -

Example: block size = 4096 - -

- -browsable -

This parameter is a synonym for browseable.

- -browseable (S) -

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

- -browse list (G) -

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

- -cache directory (G) -

Usually, most of the TDB files are stored in the lock directory. Since Samba 3.4.0, it is - possible to differentiate between TDB files with persistent data and - TDB files with non-persistent data using the - state directory and the - cache directory options. -

This option specifies the directory where TDB files containing - non-persistent data will be stored. -

Default: cache directory = ${prefix}/var/locks - -

Example: cache directory = /var/run/samba/locks/cache - -

- -casesignames -

This parameter is a synonym for case sensitive.

- -case sensitive (S) -

See the discussion in the section name mangling.

Default: case sensitive = auto - -

- -change notify (S) -

This parameter specifies whether Samba should reply - to a client's file change notify requests. -

You should never need to change this parameter

Default: change notify = yes - -

- -change share command (G) -

- Samba 2.2.0 introduced the ability to dynamically add and delete shares via the Windows NT 4.0 Server -Manager. The change share command is used to define an external -program or script which will modify an existing service definition in smb.conf. -

- In order to successfully execute the - change share command, - smbd requires that the administrator - connects using a root account (i.e. uid == 0) or has the - SeDiskOperatorPrivilege. - Scripts defined in the change share command - parameter are executed as root. -

- When executed, smbd will automatically invoke the - change share command with five parameters. -

  • configFile - the location - of the global smb.conf file. -

  • shareName - the name of the new - share. -

  • pathName - path to an **existing** - directory on disk. -

  • comment - comment string to associate - with the new share. -

  • max - connections - Number of maximum simultaneous connections to this - share. -

- This parameter is only used to modify existing file share 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/changeshare - -

- -check password script (G) -

The name of a program that can be used to check password - complexity. The password is sent to the program's standard input.

The program must return 0 on a good password, or any other value - if the password is bad. - In case the password is considered weak (the program does not return 0) the - user will be notified and the password change will fail.

Note: In the example directory is a sample program called crackcheck - that uses cracklib to check the password quality.

Default: check password script = Disabled - -

Example: check password script = /usr/local/sbin/crackcheck - -

- -client lanman auth (G) -

This parameter determines whether or not smbclient(8) and other samba client - tools will attempt to authenticate itself to servers using the - weaker LANMAN password hash. If disabled, only server which support NT - password hashes (e.g. Windows NT/2000, Samba, etc... but not - Windows 95/98) will be able to be connected from the Samba client.

The LANMAN encrypted response is easily broken, due to its - case-insensitive nature, and the choice of algorithm. Clients - without Windows 95/98 servers are advised to disable - this option.

Disabling this option will also disable the client plaintext auth option.

Likewise, if the client ntlmv2 - auth parameter is enabled, then only NTLMv2 logins will be - attempted.

Default: client lanman auth = no - -

- -client ldap sasl wrapping (G) -

- The client ldap sasl wrapping defines whether - ldap traffic will be signed or signed and encrypted (sealed). - Possible values are plain, sign - and seal. -

- The values sign and seal are - only available if Samba has been compiled against a modern - OpenLDAP version (2.3.x or higher). -

- This option is needed in the case of Domain Controllers enforcing - the usage of signed LDAP connections (e.g. Windows 2000 SP3 or higher). - LDAP sign and seal can be controlled with the registry key - "HKLM\System\CurrentControlSet\Services\ - NTDS\Parameters\LDAPServerIntegrity" - on the Windows server side. -

- Depending on the used KRB5 library (MIT and older Heimdal versions) - it is possible that the message "integrity only" is not supported. - In this case, sign is just an alias for - seal. -

- The default value is plain which is not irritable - to KRB5 clock skew errors. That implies synchronizing the time - with the KDC in the case of using sign or - seal. -

Default: client ldap sasl wrapping = plain - -

- -client ntlmv2 auth (G) -

This parameter determines whether or not smbclient(8) will attempt to - authenticate itself to servers using the NTLMv2 encrypted password - response.

If enabled, only an NTLMv2 and LMv2 response (both much more - secure than earlier versions) will be sent. Older servers - (including NT4 < SP4, Win9x and Samba 2.2) are not compatible with - NTLMv2 when not in an NTLMv2 supporting domain

Similarly, if enabled, NTLMv1, client lanman auth and client plaintext auth - authentication will be disabled. This also disables share-level - authentication.

If disabled, an NTLM response (and possibly a LANMAN response) - will be sent by the client, depending on the value of client lanman auth.

Note that Windows Vista and later versions already use - NTLMv2 by default, and some sites (particularly those following - 'best practice' security polices) only allow NTLMv2 responses, and - not the weaker LM or NTLM.

Default: client ntlmv2 auth = yes - -

- -client plaintext auth (G) -

Specifies whether a client should send a plaintext - password if the server does not support encrypted passwords.

Default: client plaintext auth = no - -

- -client schannel (G) -

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

- -client signing (G) -

This controls whether the client is allowed or required 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 - -

- -client use spnego principal (G) -

This parameter determines whether or not - smbclient(8) and other samba components - acting as a client will attempt to use the server-supplied - principal sometimes given in the SPNEGO exchange.

If enabled, Samba can attempt to use Kerberos to contact - servers known only by IP address. Kerberos relies on names, so - ordinarily cannot function in this situation.

If disabled, Samba will use the name used to look up the - server when asking the KDC for a ticket. This avoids situations - where a server may impersonate another, soliciting authentication - as one principal while being known on the network as another. -

Note that Windows XP SP2 and later versions already follow - this behaviour, and Windows Vista and later servers no longer - supply this 'rfc4178 hint' principal on the server side.

Default: client use spnego principal = no - -

- -client use spnego (G) -

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

- -cluster addresses (G) -

With this parameter you can add additional addresses - nmbd will register with a WINS server. These addresses are not - necessarily present on all nodes simultaneously, but they will - be registered with the WINS server so that clients can contact - any of the nodes. -

Default: cluster addresses = - -

Example: cluster addresses = 10.0.0.1 10.0.0.2 10.0.0.3 - -

- -clustering (G) -

This parameter specifies whether Samba should contact - ctdb for accessing its tdb files and use ctdb as a backend - for its messaging backend. -

Set this parameter to yes only if - you have a cluster setup with ctdb running. -

Default: clustering = no - -

- -comment (S) -

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

- -config backend (G) -

- This controls the backend for storing the configuration. - Possible values are file (the default) - and registry. - When config backend = registry - is encountered while loading smb.conf, - the configuration read so far is dropped and the global - options are read from registry instead. So this triggers a - registry only configuration. Share definitions are not read - immediately but instead registry - shares is set to yes. -

- Note: This option can not be set inside the registry - configuration itself. -

Default: config backend = file - -

Example: config backend = registry - -

- -config file (G) -

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

- -copy (S) -

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

- -create krb5 conf (G) -

- Setting this paramter to no prevents - winbind from creating custom krb5.conf files. Winbind normally does - this because the krb5 libraries are not AD-site-aware and thus would - pick any domain controller out of potentially very many. Winbind - is site-aware and makes the krb5 libraries use a local DC by - creating its own krb5.conf files. -

- Preventing winbind from doing this might become necessary if you - have to add special options into your system-krb5.conf that winbind - does not see. -

Default: create krb5 conf = yes - -

- -create mode -

This parameter is a synonym for create mask.

- -create mask (S) -

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

- -csc policy (S) -

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

- -ctdbd socket (G) -

If you set clustering=yes, - you need to tell Samba where ctdbd listens on its unix domain - socket. The default path as of ctdb 1.0 is /tmp/ctdb.socket which - you have to explicitly set for Samba in smb.conf. -

Default: ctdbd socket = - -

Example: ctdbd socket = /tmp/ctdb.socket - -

- -ctdb locktime warn threshold (G) -

- In a cluster environment using Samba and ctdb it is critical - that locks on central ctdb-hosted databases like locking.tdb - are not held for long. With the current Samba architecture - it happens that Samba takes a lock and while holding that - lock makes file system calls into the shared cluster file - system. This option makes Samba warn if it detects that it - has held locks for the specified number of milliseconds. If - this happens, smbd will emit a debug level 0 - message into its logs and potentially into syslog. The most likely - reason for such a log message is that an operation of the cluster - file system Samba exports is taking longer than expected. - The messages are meant as a debugging aid for potential - cluster problems. -

The default value of 0 disables this logging.

Default: ctdb locktime warn threshold = 0 - -

- -ctdb timeout (G) -

This parameter specifies a timeout in seconds for the - connection between Samba and ctdb. It is only valid if you - have compiled Samba with clustering and if you have - set clustering=yes. -

When something in the cluster blocks, it can happen that - we wait indefinitely long for ctdb, just adding to the - blocking condition. In a well-running cluster this should - never happen, but there are too many components in a cluster - that might have hickups. Choosing the right balance for this - value is very tricky, because on a busy cluster long service - times to transfer something across the cluster might be - valid. Setting it too short will degrade the service your - cluster presents, setting it too long might make the cluster - itself not recover from something severely broken for too - long. -

- Be aware that if you set this parameter, this needs to be in - the file smb.conf, it is not really helpful to put this into - a registry configuration (typical on a cluster), because to - access the registry contact to ctdb is requred. -

Setting ctdb timeout to n makes - any process waiting longer than n seconds for a reply by the - cluster panic. Setting it to 0 (the default) makes Samba - block forever, which is the highly recommended default. -

Default: ctdb timeout = 0 - -

- -cups connection timeout (G) -

- This parameter is only applicable if printing is set to cups. -

- If set, this option specifies the number of seconds that smbd will wait - whilst trying to contact to the CUPS server. The connection will fail - if it takes longer than this number of seconds. -

Default: cups connection timeout = 30 - -

Example: cups connection timeout = 60 - -

- -cups encrypt (G) -

- This parameter is only applicable if printing - is set to cups and if you use CUPS newer than - 1.0.x.It is used to define whether or not Samba should use encryption - when talking to the CUPS server. Possible values are - auto, yes and - no -

- When set to auto we will try to do a TLS handshake on each CUPS - connection setup. If that fails, we will fall back to unencrypted - operation. -

Default: cups encrypt = "no" - -

- -cups options (S) -

- 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. - Multiple parameters should be space-delimited name/value pairs according to - the PAPI text option ABNF specification. Collection values - ("name={a=... b=... c=...}") are stored with the curley brackets intact. -

- You should set this parameter to raw if your CUPS server - 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" - -

- -cups server (G) -

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

Optionally, a port can be specified by separating the server name - and port number with a colon. If no port was specified, - the default port for IPP (631) will be used. -

Default: cups server = "" - -

Example: cups server = mycupsserver - -

Example: cups server = mycupsserver:1631 - -

- -deadtime (G) -

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

- -debug class (G) -

- With this boolean parameter enabled, the debug class (DBGC_CLASS) - will be displayed in the debug header. -

- For more information about currently available debug classes, see - section about log level. -

Default: debug class = no - -

- -debug hires timestamp (G) -

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

- -debug pid (G) -

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

- -debug prefix timestamp (G) -

- With this option enabled, the timestamp message header is prefixed to the debug message without the - filename and function information that is included with the debug timestamp - parameter. This gives timestamps to the messages without adding an additional line. -

- Note that this parameter overrides the debug timestamp parameter. -

Default: debug prefix timestamp = no - -

- -timestamp logs -

This parameter is a synonym for debug timestamp.

- -debug timestamp (G) -

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

- -debug uid (G) -

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

- -dedicated keytab file (G) -

- Specifies the path to the kerberos keytab file when - kerberos method is set to "dedicated - keytab". -

Default: dedicated keytab file = - -

Example: dedicated keytab file = /usr/local/etc/krb5.keytab - -

- -default case (S) -

See the section on name mangling. - Also note the short preserve case parameter.

Default: default case = lower - -

- -default devmode (S) -

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

- -default -

This parameter is a synonym for default service.

- -default service (G) -

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

- -defer sharing violations (G) -

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

- -delete group script (G) -

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

- -deleteprinter command (G) -

With the introduction of MS-RPC based printer - support for Windows NT/2000 clients in Samba 2.2, it is now - possible to delete a printer at run time by issuing the - DeletePrinter() RPC call.

For a Samba host this means that the printer must be - physically deleted from the underlying printing system. The - 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 check that the associated printer no longer exists. - If the sharename is still valid, then smbd - will return an ACCESS_DENIED error to the client.

Default: deleteprinter command = - -

Example: deleteprinter command = /usr/bin/removeprinter - -

- -delete readonly (S) -

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

- -delete share command (G) -

- Samba 2.2.0 introduced the ability to dynamically add and delete shares via the Windows NT 4.0 Server - Manager. The delete share command is used to define an external - program or script which will remove an existing service definition from - smb.conf. -

In order to successfully execute the - delete share command, - smbd requires that the administrator - connects using a root account (i.e. uid == 0) or has the - SeDiskOperatorPrivilege. - Scripts defined in the delete share command - parameter are executed as root. -

- When executed, smbd will automatically invoke the - delete share command with two parameters. -

  • configFile - the location - of the global smb.conf file. -

  • shareName - the name of - the existing service. -

- This parameter is only used to remove file shares. To delete printer shares, - see the deleteprinter command. -

Default: delete share command = - -

Example: delete share command = /usr/local/bin/delshare - -

- -delete user from group script (G) -

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

- -delete user script (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 - -

- -delete veto files (S) -

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

- -dfree cache time (S) -

- The dfree cache time 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 is a new parameter introduced in Samba version 3.0.21. It specifies in seconds the time that smbd will - cache the output of a disk free query. If set to zero (the default) no caching is done. This allows a heavily - loaded server to prevent rapid spawning of dfree command scripts increasing the load. -

- By default this parameter is zero, meaning no caching will be done. -

No default

Example: dfree cache time = dfree cache time = 60 - -

- -dfree command (S) -

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

- In Samba version 3.0.21 this parameter has been changed to be a per-share parameter, and in addition the - parameter dfree cache time was added to allow the output of this script to be cached - for systems under heavy load. -

- The external program will be passed a single parameter indicating a directory in the filesystem being queried. - This will typically consist of the string ./. The script should return - two integers in ASCII. The first should be the total disk space in blocks, and the second should be the number - of available blocks. An optional third return value can give the block size in bytes. The default blocksize is - 1024 bytes. -

- Note: Your script should NOT be setuid or setgid and should be owned by (and writeable - only by) root! -

- Where the script dfree (which must be made executable) could be: -

 
-#!/bin/sh
-df $1 | tail -1 | awk '{print $(NF-4),$(NF-2)}'
-

- or perhaps (on Sys V based systems): -

 
-#!/bin/sh
-/usr/bin/df -k $1 | tail -1 | awk '{print $3" "$5}'
-

- Note that you may have to replace the command names with full path names on some systems. -

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

No default

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

- -directory mode -

This parameter is a synonym for directory mask.

- -directory mask (S) -

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

When a directory is created, the necessary permissions are - calculated according to the mapping from DOS modes to UNIX permissions, - and the resulting UNIX mode is then bit-wise 'AND'ed with this - parameter. This parameter may be thought of as a bit-wise MASK for - the UNIX modes of a directory. Any bit not set - here will be removed from the modes set on a directory when it is - created.

The default value of this parameter removes the 'group' - and 'other' write bits from the UNIX mode, allowing only the - user who owns the directory to modify it.

Following this Samba will bit-wise 'OR' the UNIX mode - created from this parameter with the value of the force directory mode parameter. - This parameter is set to 000 by default (i.e. no extra mode bits are added).

Note that this parameter does not apply to permissions - set by Windows NT/2000 ACL editors. If the administrator wishes to enforce - a mask on access control lists also, they need to set the directory security mask.

Default: directory mask = 0755 - -

Example: directory mask = 0775 - -

- -directory name cache size (S) -

- This parameter specifies the the size of the directory name cache. - It will be needed to turn this off for *BSD systems. -

Default: directory name cache size = 100 - -

- -directory security mask (S) -

This parameter controls what UNIX permission bits - will be set 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 incoming permission bits, thus resetting - any bits not in this mask. 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 are a set of bits that will always be set to zero. -

- Essentially, all bits set to zero in this mask will result in setting to zero the corresponding bits on the - file permissions regardless of the previous status of this bits on the file. -

If not set explicitly this parameter is set to 0777 - meaning a user is allowed to set all the user/group/world - permissions on a directory.

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

Default: directory security mask = 0777 - -

Example: directory security mask = 0700 - -

- -disable netbios (G) -

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.

Note

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

Default: disable netbios = no - -

- -disable spoolss (G) -

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

Default: disable spoolss = no - -

- -display charset (G) -

- Specifies the charset that samba will use to print messages to stdout and stderr. - The default value is "LOCALE", which means automatically set, depending on the - current locale. The value should generally be the same as the value of the parameter - unix charset. -

Default: display charset = "LOCALE" or "ASCII" (depending on the system) - -

Example: display charset = UTF8 - -

- -dmapi support (S) -

This parameter specifies whether Samba should use DMAPI to - determine whether a file is offline or not. This would typically - be used in conjunction with a hierarchical storage system that - automatically migrates files to tape. -

Note that Samba infers the status of a file by examining the - events that a DMAPI application has registered interest in. This - heuristic is satisfactory for a number of hierarchical storage - systems, but there may be system for which it will fail. In this - case, Samba may erroneously report files to be offline. -

This parameter is only available if a supported DMAPI - implementation was found at compilation time. It will only be used - if DMAPI is found to enabled on the system at run time. -

-

Default: dmapi support = no - -

- -dns proxy (G) -

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

- -domain logons (G) -

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

- -domain master (G) -

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

- When domain logons = Yes the default setting for this parameter is - Yes, with the result that Samba will be a PDC. If domain master = No, - Samba will function as a BDC. In general, this parameter should be set to 'No' only on a BDC. -

Default: domain master = auto - -

- -dont descend (S) -

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 charset (G) -

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

- -dos filemode (S) -

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, including an ACL permission) to modify the permissions - (including ACL) 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 may also be changed. - - Note that using the VFS modules acl_xattr or acl_tdb which store native - Windows as meta-data will automatically turn this option on for any - share for which they are loaded, as they require this option to emulate - Windows ACLs correctly. -

Default: dos filemode = no - -

- -dos filetime resolution (S) -

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

- -dos filetimes (S) -

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 emulates the DOS semantics and allows to change the - timestamp on a file if the user smbd is acting - on behalf has write permissions. - 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 - -

- -ea support (S) -

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

- -enable asu support (G) -

Hosts running the "Advanced Server for Unix (ASU)" product - require some special accomodations such as creating a builtin [ADMIN$] - share that only supports IPC connections. The has been the default - behavior in smbd for many years. However, certain Microsoft applications - such as the Print Migrator tool require that the remote server support - an [ADMIN$} file share. Disabling this parameter allows for creating - an [ADMIN$] file share in smb.conf.

Default: enable asu support = no - -

- -enable core files (G) -

This parameter specifies whether core dumps should be written - on internal exits. Normally set to yes. - You should never need to change this. -

Default: enable core files = yes - -

Example: enable core files = no - -

- -enable privileges (G) -

- This deprecated parameter controls whether or not smbd will honor privileges assigned to specific SIDs via either - net rpc rights or one of the Windows user and group manager tools. This parameter is - enabled by default. It can be disabled to prevent members of the Domain Admins group from being able to - assign privileges to users or groups which can then result in certain smbd operations running as root that - would normally run under the context of the connected user. -

- An example of how privileges can be used is to assign the right to join clients to a Samba controlled - domain without providing root access to the server via smbd. -

- Please read the extended description provided in the Samba HOWTO documentation. -

Default: enable privileges = yes - -

- -enable spoolss (G) -

Inverted synonym for disable spoolss.

Default: enable spoolss = yes - -

- -encrypt passwords (G) -

This boolean controls whether encrypted passwords - will be negotiated with the client. Note that Windows NT 4.0 SP3 and - above and also Windows 98 will by default expect encrypted passwords - unless a registry entry is changed. To use encrypted passwords in - Samba see the chapter "User Database" in the Samba HOWTO Collection. -

- MS Windows clients that expect Microsoft encrypted passwords and that - do not have plain text password support enabled will be able to - connect only to a Samba server that has encrypted password support - enabled and for which the user accounts have a valid encrypted password. - Refer to the smbpasswd command man page for information regarding the - creation of encrypted passwords for user accounts. -

- The use of plain text passwords is NOT advised as support for this feature - is no longer maintained in Microsoft Windows products. If you want to use - plain text passwords you must set this parameter to no. -

In order for encrypted passwords to work correctly - smbd(8) must either - have access to a local smbpasswd(5) file (see the smbpasswd(8) program for information on how to set up - and maintain this file), or set the security = [server|domain|ads] parameter which - causes smbd to authenticate against another - server.

Default: encrypt passwords = yes - -

- -enhanced browsing (G) -

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

- -enumports command (G) -

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

- -eventlog list (G) -

This option defines a list of log names that Samba will - report to the Microsoft EventViewer utility. The listed - eventlogs will be associated with tdb file on disk in the - $(lockdir)/eventlog. -

- The administrator must use an external process to parse the normal - Unix logs such as /var/log/messages - and write then entries to the eventlog tdb files. Refer to the - eventlogadm(8) utility for how to write eventlog entries. -

Default: eventlog list = - -

Example: eventlog list = Security Application Syslog Apache - -

- -fake directory create times (S) -

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

- -fake oplocks (S) -

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

- -follow symlinks (S) -

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

- -force create mode (S) -

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. 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 newly created files to have read and execute - permissions set for 'group' and 'other' as well as the - read/write/execute bits set for the 'user'.

Default: force create mode = 000 - -

Example: force create mode = 0755 - -

- -force directory mode (S) -

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

The example below would force all created directories to have read and execute - permissions set for 'group' and 'other' as well as the - read/write/execute bits set for the 'user'.

Default: force directory mode = 000 - -

Example: force directory mode = 0755 - -

- -force directory security mode (S) -

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

Note

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

Default: force directory security mode = 0 - -

Example: force directory security mode = 700 - -

- -group -

This parameter is a synonym for force group.

- -force group (S) -

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

- -force printername (S) -

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

- -force security mode (S) -

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

- This parameter is applied as a mask (OR'ed with) to the changed permission bits, thus forcing any bits in this - mask that the user may have modified to be on. Make sure not to mix up this parameter with security mask, which works similar like this one but uses logical AND instead of OR. -

- Essentially, one bits in this mask may be treated as a set of bits that, when modifying security on a file, - the user has always set to be on. -

- If not set explicitly this parameter is set to 0, and allows a user to modify all the user/group/world - permissions on a file, with no restrictions. -

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

Default: force security mode = 0 - -

Example: force security mode = 700 - -

- -force unknown acl user (S) -

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

- -force user (S) -

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

- -fstype (S) -

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

Default: fstype = NTFS - -

Example: fstype = Samba - -

- -get quota command (G) -

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

This option is only available you have compiled Samba with the - --with-sys-quotas option or on Linux with - --with-quotas 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 - -

- -getwd cache (G) -

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

- -guest account (G) -

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

- -public -

This parameter is a synonym for guest ok.

- -guest ok (S) -

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 parameter nullifies the benefits of setting - restrict anonymous = 2 -

See the section below on security for more information about this option. -

Default: guest ok = no - -

- -only guest -

This parameter is a synonym for guest only.

- -guest only (S) -

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

- -hide dot files (S) -

This is a boolean parameter that controls whether - files starting with a dot appear as hidden files.

Default: hide dot files = yes - -

- -hide files (S) -

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

- -hide special files (S) -

- This parameter prevents clients from seeing special files such as sockets, devices and - fifo's in directory listings. -

Default: hide special files = no - -

- -hide unreadable (S) -

This parameter prevents clients from seeing the - existance of files that cannot be read. Defaults to off.

Default: hide unreadable = no - -

- -hide unwriteable files (S) -

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

- -homedir map (G) -

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

Note

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

Default: homedir map = - -

Example: homedir map = amd.homedir - -

- -host msdfs (G) -

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

- -hostname lookups (G) -

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

- -allow hosts -

This parameter is a synonym for hosts allow.

- -hosts allow (S) -

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

Note that access still requires suitable user-level passwords.

See testparm(1) for a way of testing your host access - to see if it does what you expect.

Default: hosts allow = -# none (i.e., all hosts permitted access) - -

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

- -deny hosts -

This parameter is a synonym for hosts deny.

- -hosts deny (S) -

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

- In the event that it is necessary to deny all by default, use the keyword - ALL (or the netmask 0.0.0.0/0) and then explicitly specify - to the hosts allow = hosts allow parameter those hosts - that should be permitted access. -

Default: hosts deny = -# none (i.e., no hosts specifically excluded) - -

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

- -idmap backend (G) -

- The idmap backend provides a plugin interface for Winbind to use - varying backends to store SID/uid/gid mapping tables. -

- This option specifies the default backend that is used when no special - configuration set, but it is now deprecated in favour of the new - spelling idmap config * : backend. -

Default: idmap backend = tdb - -

- -idmap cache time (G) -

This parameter specifies the number of seconds that Winbind's - idmap interface will cache positive SID/uid/gid query results. -

Default: idmap cache time = 604800 (one week) - -

- -idmap config (G) -

- ID mapping in Samba is the mapping between Windows SIDs and Unix user - and group IDs. This is performed by Winbindd with a configurable plugin - interface. Samba's ID mapping is configured by options starting with the - idmap config prefix. - An idmap option consists of the idmap config - prefix, followed by a domain name or the asterisk character (*), - a colon, and the name of an idmap setting for the chosen domain. -

- The idmap configuration is hence divided into groups, one group - for each domain to be configured, and one group with the the - asterisk instead of a proper domain name, which speifies the - default configuration that is used to catch all domains that do - not have an explicit idmap configuration of their own. -

- There are three general options available: -

backend = backend_name

- This specifies the name of the idmap plugin to use as the - SID/uid/gid backend for this domain. The standard backends are - tdb - (idmap_tdb(8)), - tdb2 - (idmap_tdb2(8)), - ldap - (idmap_ldap(8)), - , - rid - (idmap_rid(8)), - , - hash - (idmap_hash(8)), - , - autorid - (idmap_autorid(8)), - , - ad - (idmap_ad(8)), - , - adex - (idmap_adex(8)), - , - and nss. - (idmap_nss(8)), - The corresponding manual pages contain the details, but - here is a summary. -

- The first three of these create mappings of their own using - internal unixid counters and store the mappings in a database. - These are suitable for use in the default idmap configuration. - The rid and hash backends use a pure algorithmic calculation - to determine the unixid for a SID. The autorid module is a - mixture of the tdb and rid backend. It creates ranges for - each domain encountered and then uses the rid algorithm for each - of these automatically configured domains individually. - The ad and adex - backends both use unix IDs stored in Active Directory via - the standard schema extensions. The nss backend reverses - the standard winbindd setup and gets the unixids via names - from nsswitch which can be useful in an ldap setup. -

range = low - high

- Defines the available matching uid and gid range for which the - backend is authoritative. For allocating backends, this also - defines the start and the end of the range for allocating - new unid IDs. -

- winbind uses this parameter to find the backend that is - authoritative for a unix ID to SID mapping, so it must be set - for each individually configured domain and for the default - configuration. The configured ranges must be mutually disjoint. -

read only = yes|no

- This option can be used to turn the writing backends - tdb, tdb2, and ldap into read only mode. This can be useful - e.g. in cases where a pre-filled database exists that should - not be extended automatically. -

- The following example illustrates how to configure the idmap_ad(8) backend for the CORP domain and the - idmap_tdb(8) backend for all other - domains. This configuration assumes that the admin of CORP assigns - unix ids below 1000000 via the SFU extensions, and winbind is supposed - to use the next million entries for its own mappings from trusted - domains and for local groups for example. - 

-	idmap config * : backend = tdb
-	idmap config * : range = 1000000-1999999
-
-	idmap config CORP : backend  = ad
-	idmap config CORP : range = 1000-999999
-

No default

- -winbind gid -

This parameter is a synonym for idmap gid.

- -idmap gid (G) -

- The idmap gid parameter specifies the range of group ids - for the default idmap configuration. It is now deprecated - in favour of idmap config * : range. -

See the idmap config option.

Default: idmap gid = - -

Example: idmap gid = 10000-20000 - -

- -idmap negative cache time (G) -

This parameter specifies the number of seconds that Winbind's - idmap interface will cache negative SID/uid/gid query results. -

Default: idmap negative cache time = 120 - -

- -winbind uid -

This parameter is a synonym for idmap uid.

- -idmap uid (G) -

- The idmap uid parameter specifies the range of user ids for - the default idmap configuration. It is now deprecated in favour - of idmap config * : range. -

See the idmap config option.

Default: idmap uid = - -

Example: idmap uid = 10000-20000 - -

- -include (G) -

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

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

- The parameter include = registry has - a special meaning: It does not include - a file named registry from the current working - directory, but instead reads the global configuration options - from the registry. See the section on registry-based - configuration for details. Note that this option - automatically activates registry shares. -

Default: include = - -

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

- -inherit acls (S) -

This parameter can be used to ensure that if default acls - exist on parent directories, they are always honored when creating a - new file or subdirectory in these parent directories. The default - behavior is to use the unix mode specified when creating the directory. - Enabling this option sets the unix mode to 0777, thus guaranteeing that - default directory acls are propagated. - - Note that using the VFS modules acl_xattr or acl_tdb which store native - Windows as meta-data will automatically turn this option on for any - share for which they are loaded, as they require this option to emulate - Windows ACLs correctly. -

Default: inherit acls = no - -

- -inherit owner (S) -

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

- -inherit permissions (S) -

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

- -init logon delayed hosts (G) -

- This parameter takes a list of host names, addresses or networks for - which the initial samlogon reply should be delayed (so other DCs get - preferred by XP workstations if there are any). -

- The length of the delay can be specified with the - init logon delay parameter. -

Default: init logon delayed hosts = - -

Example: init logon delayed hosts = 150.203.5. myhost.mynet.de - -

- -init logon delay (G) -

- This parameter specifies a delay in milliseconds for the hosts configured - for delayed initial samlogon with - init logon delayed hosts. -

Default: init logon delay = 100 - -

- -interfaces (G) -

This option allows you to override the default - network interfaces list that Samba will use for browsing, name - registration and other NetBIOS over TCP/IP (NBT) traffic. By default Samba will query - the kernel for the list of all active interfaces and use any - interfaces except 127.0.0.1 that are broadcast capable.

The option takes a list of interface strings. Each string - can be in any of the following forms:

  • a network interface name (such as eth0). - This may include shell-like wildcards so eth* will match - any interface starting with the substring "eth"

  • an IP address. In this case the netmask is - determined from the list of interfaces obtained from the - kernel

  • an IP/mask pair.

  • a broadcast/mask pair.

The "mask" parameters can either be a bit length (such - as 24 for a C class network) or a full netmask in dotted - decimal form.

The "IP" parameters above can either be a full dotted - decimal IP address or a hostname which will be looked up via - the OS's normal hostname resolution mechanisms.

- By default Samba enables all active interfaces that are broadcast capable - except the loopback adaptor (IP address 127.0.0.1). -

- The example below configures three network interfaces corresponding - to the eth0 device and IP addresses 192.168.2.10 and 192.168.3.10. - The netmasks of the latter two interfaces would be set to 255.255.255.0. -

Default: interfaces = - -

Example: interfaces = eth0 192.168.2.10/24 192.168.3.10/255.255.255.0 - -

- -invalid users (S) -

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 via the NSS getgrnam() interface. A name starting with - '&' is interpreted only by looking in the NIS netgroup database - (this requires NIS to be working on your system). The characters - '+' and '&' may be used at the start of the name in either order - so the value +&group means check the - UNIX group database, followed by the NIS netgroup database, and - the value &+group means check the NIS - netgroup database, followed by the UNIX group database (the - same as the '@' prefix).

The current servicename is substituted for %S. - This is useful in the [homes] section.

Default: invalid users = -# no invalid users - -

Example: invalid users = root fred admin @wheel - -

- -iprint server (G) -

- This parameter is only applicable if printing is set to iprint. -

- If set, this option overrides the ServerName option in the CUPS client.conf. This is - necessary if you have virtual samba servers that connect to different CUPS daemons. -

Default: iprint server = "" - -

Example: iprint server = MYCUPSSERVER - -

- -keepalive (G) -

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

Keepalives should, in general, not be needed if the socket - 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 - -

- -kerberos method (G) -

- Controls how kerberos tickets are verified. -

Valid options are:

  • secrets only - use only the secrets.tdb for - ticket verification (default)

  • system keytab - use only the system keytab - for ticket verification

  • dedicated keytab - use a dedicated keytab - for ticket verification

  • secrets and keytab - use the secrets.tdb - first, then the system keytab

- The major difference between "system keytab" and "dedicated - keytab" is that the latter method relies on kerberos to find the - correct keytab entry instead of filtering based on expected - principals. -

- When the kerberos method is in "dedicated keytab" mode, - dedicated keytab file must be set to - specify the location of the keytab file. -

Default: kerberos method = secrets only - -

- -kernel change notify (S) -

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

This parameter is only used when your kernel supports - change notification to user programs using the inotify interface. -

Default: kernel change notify = yes - -

- -kernel oplocks (G) -

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

- -lanman auth (G) -

This parameter determines whether or not smbd(8) will attempt to - authenticate users or permit password changes - using the LANMAN password hash. If disabled, only clients which support NT - password hashes (e.g. Windows NT/2000 clients, smbclient, but not - Windows 95/98 or the MS DOS network client) will be able to - connect to the Samba host.

The LANMAN encrypted response is easily broken, due to its - case-insensitive nature, and the choice of algorithm. Servers - without Windows 95/98/ME or MS DOS clients are advised to disable - this option.

When this parameter is set to no this - will also result in sambaLMPassword in Samba's passdb being - blanked after the next password change. As a result of that - lanman clients won't be able to authenticate, even if lanman - auth is reenabled later on. -

Unlike the encrypt - passwords option, this parameter cannot alter client - behaviour, and the LANMAN response will still be sent over the - network. See the client lanman - auth to disable this for Samba's clients (such as smbclient)

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

- -large readwrite (G) -

This parameter determines whether or not - smbd(8) supports the new 64k - streaming read and write variant SMB requests introduced with - Windows 2000. Note that due to Windows 2000 client redirector bugs - this requires Samba to be running on a 64-bit capable operating - system such as IRIX, Solaris or a Linux 2.4 kernel. Can improve - performance by 10% with Windows 2000 clients. Defaults to on. Not as - tested as some other Samba code paths.

Default: large readwrite = yes - -

- -ldap admin dn (G) -

- 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

- -ldap connection timeout (G) -

- This parameter tells the LDAP library calls which timeout in seconds - they should honor during initial connection establishments to LDAP servers. - It is very useful in failover scenarios in particular. If one or more LDAP - servers are not reachable at all, we do not have to wait until TCP - timeouts are over. This feature must be supported by your LDAP library. -

- This parameter is different from ldap timeout - which affects operations on LDAP servers using an existing connection - and not establishing an initial connection. -

Default: ldap connection timeout = 2 - -

- -ldap debug level (G) -

- This parameter controls the debug level of the LDAP library - calls. In the case of OpenLDAP, it is the same - bit-field as understood by the server and documented in the - slapd.conf(5) - manpage. - A typical useful value will be - 1 for tracing function calls. -

- The debug ouput from the LDAP libraries appears with the - prefix [LDAP] in Samba's logging output. - The level at which LDAP logging is printed is controlled by the - parameter ldap debug threshold. -

Default: ldap debug level = 0 - -

Example: ldap debug level = 1 - -

- -ldap debug threshold (G) -

- This parameter controls the Samba debug level at which - the ldap library debug output is - printed in the Samba logs. See the description of - ldap debug level for details. -

Default: ldap debug threshold = 10 - -

Example: ldap debug threshold = 5 - -

- -ldap delete dn (G) -

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

- -ldap deref (G) -

This option controls whether Samba should tell the LDAP library - to use a certain alias dereferencing method. The default is - auto, which means that the default setting of the - ldap client library will be kept. Other possible values are - never, finding, - searching and always. Grab - your LDAP manual for more information. -

Default: ldap deref = auto - -

Example: ldap deref = searching - -

- -ldap follow referral (G) -

This option controls whether to follow LDAP referrals or not when - searching for entries in the LDAP database. Possible values are - on to enable following referrals, - off to disable this, and - auto, to use the libldap default settings. - libldap's choice of following referrals or not is set in - /etc/openldap/ldap.conf with the REFERRALS parameter as documented in - ldap.conf(5).

Default: ldap follow referral = auto - -

Example: ldap follow referral = off - -

- -ldap group suffix (G) -

This parameter specifies the suffix that is - used for groups when these are added to the LDAP directory. - If this parameter is unset, the value of 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 - -

- -ldap idmap suffix (G) -

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

- -ldap machine suffix (G) -

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

- -ldap page size (G) -

- This parameter specifies the number of entries per page. -

If the LDAP server supports paged results, clients can - request subsets of search results (pages) instead of the entire list. - This parameter specifies the size of these pages. -

Default: ldap page size = 1024 - -

Example: ldap page size = 512 - -

- -ldap passwd sync (G) -

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

- -ldap replication sleep (G) -

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

- -ldapsam:editposix (G) -

- Editposix is an option that leverages ldapsam:trusted to make it simpler to manage a domain controller - eliminating the need to set up custom scripts to add and manage the posix users and groups. This option - will instead directly manipulate the ldap tree to create, remove and modify user and group entries. - This option also requires a running winbindd as it is used to allocate new uids/gids on user/group - creation. The allocation range must be therefore configured. -

- To use this option, a basic ldap tree must be provided and the ldap suffix parameters must be properly - configured. On virgin servers the default users and groups (Administrator, Guest, Domain Users, - Domain Admins, Domain Guests) can be precreated with the command net sam - provision. To run this command the ldap server must be running, Winindd must be running and - the smb.conf ldap options must be properly configured. - - The typical ldap setup used with the ldapsam:trusted = yes option - is usually sufficient to use ldapsam:editposix = yes as well. -

- An example configuration can be the following: - - 

-	encrypt passwords = true
-	passdb backend = ldapsam
-
-	ldapsam:trusted=yes
-	ldapsam:editposix=yes
-
-	ldap admin dn = cn=admin,dc=samba,dc=org
-	ldap delete dn = yes
-	ldap group suffix = ou=groups
-	ldap idmap suffix = ou=idmap
-	ldap machine suffix = ou=computers
-	ldap user suffix = ou=users
-	ldap suffix = dc=samba,dc=org
-
-	idmap backend = ldap:"ldap://localhost"
-
-	idmap uid = 5000-50000
-	idmap gid = 5000-50000
-

- - This configuration assumes a directory layout like described in the following ldif: - - 

-	dn: dc=samba,dc=org
-	objectClass: top
-	objectClass: dcObject
-	objectClass: organization
-	o: samba.org
-	dc: samba
-
-	dn: cn=admin,dc=samba,dc=org
-	objectClass: simpleSecurityObject
-	objectClass: organizationalRole
-	cn: admin
-	description: LDAP administrator
-	userPassword: secret
-
-	dn: ou=users,dc=samba,dc=org
-	objectClass: top
-	objectClass: organizationalUnit
-	ou: users
-
-	dn: ou=groups,dc=samba,dc=org
-	objectClass: top
-	objectClass: organizationalUnit
-	ou: groups
-
-	dn: ou=idmap,dc=samba,dc=org
-	objectClass: top
-	objectClass: organizationalUnit
-	ou: idmap
-
-	dn: ou=computers,dc=samba,dc=org
-	objectClass: top
-	objectClass: organizationalUnit
-	ou: computers
-

-

Default: ldapsam:editposix = no - -

- -ldapsam:trusted (G) -

- By default, Samba as a Domain Controller with an LDAP backend needs to use the Unix-style NSS subsystem to - access user and group information. Due to the way Unix stores user information in /etc/passwd and /etc/group - this inevitably leads to inefficiencies. One important question a user needs to know is the list of groups he - is member of. The plain UNIX model involves a complete enumeration of the file /etc/group and its NSS - counterparts in LDAP. UNIX has optimized functions to enumerate group membership. Sadly, other functions that - are used to deal with user and group attributes lack such optimization. -

- To make Samba scale well in large environments, the ldapsam:trusted = yes - option assumes that the complete user and group database that is relevant to Samba is stored in LDAP with the - standard posixAccount/posixGroup attributes. It further assumes that the Samba auxiliary object classes are - stored together with the POSIX data in the same LDAP object. If these assumptions are met, - ldapsam:trusted = yes can be activated and Samba can bypass the - NSS system to query user group memberships. Optimized LDAP queries can greatly speed up domain logon and - administration tasks. Depending on the size of the LDAP database a factor of 100 or more for common queries - is easily achieved. -

Default: ldapsam:trusted = no - -

- -ldap ssl ads (G) -

This option is used to define whether or not Samba should - use SSL when connecting to the ldap server using - ads methods. - Rpc methods are not affected by this parameter. Please note, that - this parameter won't have any effect if ldap ssl - is set to no. -

See smb.conf(5) - for more information on ldap ssl. -

Default: ldap ssl ads = no - -

- -ldap ssl (G) -

This option is used to define whether or not Samba should - use SSL when connecting to the ldap server - This is NOT related to - Samba's previous SSL support which was enabled by specifying the - --with-ssl option to the - configure - script.

LDAP connections should be secured where possible. This may be - done setting either this parameter to - Start_tls - or by specifying ldaps:// in - the URL argument of passdb backend.

The ldap ssl can be set to one of - two values:

  • Off = Never - use SSL when querying the directory.

  • start tls = Use - the LDAPv3 StartTLS extended operation (RFC2830) for - communicating with the directory server.

- Please note that this parameter does only affect rpc - methods. To enable the LDAPv3 StartTLS extended operation (RFC2830) for - ads, set - ldap ssl = yes - and - ldap ssl ads = yes. - See smb.conf(5) - for more information on ldap ssl ads. -

Default: ldap ssl = start tls - -

- -ldap suffix (G) -

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

- -ldap timeout (G) -

- This parameter defines the number of seconds that Samba should use as timeout for LDAP operations. -

Default: ldap timeout = 15 - -

- -ldap user suffix (G) -

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

- -level2 oplocks (S) -

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

- -lm announce (G) -

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

- -lm interval (G) -

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

- -load printers (G) -

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

- -local master (G) -

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

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

Default: local master = yes - -

- -lock dir -

This parameter is a synonym for lock directory.

- -lock directory (G) -

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

- Note: This option can not be set inside registry - configurations. -

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

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

- -locking (S) -

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

If locking = no, all lock and unlock - requests will appear to succeed and all lock queries will report - that the file in question is available for locking.

If locking = yes, real locking will be performed - by the server.

This option may be useful for read-only - filesystems which may not need locking (such as - CDROM drives), although setting this parameter of no - is not really recommended even in this case.

Be careful about disabling locking either globally or in a - specific service, as lack of locking may result in data corruption. - You should never need to set this parameter.

No default

- -lock spin count (G) -

This parameter has been made inoperative in Samba 3.0.24. - The functionality it contolled is now controlled by the parameter - lock spin time. -

Default: lock spin count = 0 - -

- -lock spin time (G) -

The time in milliseconds that smbd should - keep waiting to see if a failed lock request can - be granted. This parameter has changed in default - value from Samba 3.0.23 from 10 to 200. The associated - lock spin count parameter is - no longer used in Samba 3.0.24. You should not need - to change the value of this parameter.

Default: lock spin time = 200 - -

- -log file (G) -

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

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

No default

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

- -debuglevel -

This parameter is a synonym for log level.

- -log level (G) -

- The value of the parameter (a astring) allows the debug level (logging level) to be specified in the - smb.conf file. -

This parameter has been extended since the 2.2.x - series, now it allows to specify the debug level for multiple - debug classes. This is to give greater flexibility in the configuration - of the system. The following debug classes are currently implemented: -

  • all

  • tdb

  • printdrivers

  • lanman

  • smb

  • rpc_parse

  • rpc_srv

  • rpc_cli

  • passdb

  • sam

  • auth

  • winbind

  • vfs

  • idmap

  • quota

  • acls

  • locking

  • msdfs

  • dmapi

  • registry

Default: log level = 0 - -

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

- -logon drive (G) -

- This parameter specifies the local path to which the home directory will be - connected (see 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 = - -

Example: logon drive = h: - -

- -logon home (G) -

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

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

- from a command prompt, for example. -

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

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

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

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

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

- Disable this feature by setting logon home = "" - using the empty string. -

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

Default: logon home = \\%N\%U - -

Example: logon home = \\remote_smb_server\%U - -

- -logon path (G) -

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

Warning

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

- -logon script (G) -

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

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

- for example. -

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

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

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

Default: logon script = - -

Example: logon script = scripts\%U.bat - -

- -log writeable files on exit (G) -

- When the network connection between a CIFS client and Samba - dies, Samba has no option but to simply shut down the server - side of the network connection. If this happens, there is a - risk of data corruption because the Windows client did not - complete all write operations that the Windows application - requested. Setting this option to "yes" makes smbd log with - a level 0 message a list of all files that have been opened - for writing when the network connection died. Those are the - files that are potentially corrupted. It is meant as an aid - for the administrator to give him a list of files to do - consistency checks on. -

Default: log writeable files on exit = no - -

- -lppause command (S) -

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

This command should be a program or script which takes - a printer name and job number to pause the print job. One way - of implementing this is by using job priorities, where jobs - having a too low priority won't be sent to the printer.

If a %p is given then the printer name - is put in its place. A %j is replaced with - the job number (an integer). On HPUX (see printing=hpux - ), if the -p%p option is added - to the lpq command, the job will show up with the correct status, i.e. - if the job priority is lower than the set fence priority it will - have the PAUSED status, whereas if the priority is equal or higher it - will have the SPOOLED or PRINTING status.

Note that it is good practice to include the absolute path - in the lppause command as the PATH may not be available to the server.

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

- -lpq cache time (G) -

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

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

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

A value of 0 will disable caching completely.

Default: lpq cache time = 30 - -

Example: lpq cache time = 10 - -

- -lpq command (S) -

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

- -lpresume command (S) -

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

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

No default

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

- -lprm command (S) -

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

This command should be a program or script which takes - a printer name and job number, and deletes the print job.

If a %p is given then the printer name - is put in its place. A %j is replaced with - the job number (an integer).

Note that it is good practice to include the absolute - path in the lprm command as the PATH may not be - available to the server.

- Examples of use are: -

-lprm command = /usr/bin/lprm -P%p %j
-
-or
-
-lprm command = /usr/bin/cancel %p-%j
-

-

Default: lprm command = determined by printing parameter - -

- -machine password timeout (G) -

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

- -magic output (S) -

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

Warning

If two clients use the same magic script - in the same directory the output file content is undefined. -

Default: magic output = <magic script name>.out - -

Example: magic output = myfile.txt - -

- -magic script (S) -

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

Scripts executed in this way will be deleted upon - completion assuming that the user has the appropriate level - of privilege and the file permissions allow the deletion.

If the script generates output, output will be sent to - the file specified by the magic output - parameter (see above).

Note that some shells are unable to interpret scripts - containing CR/LF instead of CR as - the end-of-line marker. Magic scripts must be executable - as is on the host, which for some hosts and - some shells will require filtering at the DOS end.

Magic scripts are EXPERIMENTAL and - should NOT be relied upon.

Default: magic script = - -

Example: magic script = user.csh - -

- -mangled names (S) -

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

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

If mangling is used then the mangling method 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 - -

- -mangle prefix (G) -

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

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

Default: mangle prefix = 1 - -

Example: mangle prefix = 4 - -

- -mangling char (S) -

This controls what character is used as - the magic character in 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 = ^ - -

- -mangling method (G) -

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

- -map acl inherit (S) -

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

Default: map acl inherit = no - -

- -map archive (S) -

- This controls whether the DOS archive attribute - should be mapped to the UNIX owner execute bit. The DOS archive bit - is set when a file has been modified since its last backup. One - motivation for this option is 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 - -

- -map hidden (S) -

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

- Note that this requires the create mask to be set such that the world execute - bit is not masked out (i.e. it must include 001). See the parameter create mask - for details. -

No default

- -map readonly (S) -

- This controls how the DOS read only attribute should be mapped from a UNIX filesystem. -

- This parameter can take three different values, which tell smbd(8) how to display the read only attribute on files, where either - store dos attributes is set to No, or no extended attribute is - present. If store dos attributes is set to yes then this - parameter is ignored. This is a new parameter introduced in Samba version 3.0.21. -

The three settings are :

  • - Yes - The read only DOS attribute is mapped to the inverse of the user - or owner write bit in the unix permission mode set. If the owner write bit is not set, the - read only attribute is reported as being set on the file. - If the read only DOS attribute is set, Samba sets the owner, group and - others write bits to zero. Write bits set in an ACL are ignored by Samba. - If the read only DOS attribute is unset, Samba simply sets the write bit of the - owner to one. -

  • - Permissions - The read only DOS attribute is mapped to the effective permissions of - the connecting user, as evaluated by smbd(8) by reading the unix permissions and POSIX ACL (if present). - If the connecting user does not have permission to modify the file, the read only attribute - is reported as being set on the file. -

  • - No - The read only DOS attribute is unaffected by permissions, and can only be set by - the store dos attributes method. This may be useful for exporting mounted CDs. -

Default: map readonly = yes - -

- -map system (S) -

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

- Note that this requires the create mask to be set such that the group - execute bit is not masked out (i.e. it must include 010). See the parameter - create mask for details. -

Default: map system = no - -

- -map to guest (G) -

This parameter is only useful in SECURITY = - security modes other than security = share - and security = server - - i.e. user, 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 four settings are :

  • Never - Means user login - requests with an invalid password are rejected. This is the - default.

  • Bad User - Means user - logins with an invalid password are rejected, unless the username - does not exist, in which case it is treated as a guest login and - mapped into the 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 and server. 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. This parameter is not useful with - security = server as in this security mode - no information is returned about whether a user logon failed due to - a bad username or bad password, the same error is returned from a modern server - in both cases.

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

- -map untrusted to domain (G) -

- If a client connects to smbd using an untrusted domain name, such as - BOGUS\user, smbd replaces the BOGUS domain with it's SAM name before - attempting to authenticate that user. In the case where smbd is acting as - a PDC this will be DOMAIN\user. In the case where smbd is acting as a - domain member server or a standalone server this will be WORKSTATION\user. -

- In previous versions of Samba (pre 3.4), if smbd was acting as a domain - member server, the BOGUS domain name would instead be replaced by the - primary domain which smbd was a member of. In this case authentication - would be deferred off to a DC using the credentials DOMAIN\user. -

- When this parameter is set to yes smbd provides the - legacy behavior of mapping untrusted domain names to the primary domain. - When smbd is not acting as a domain member server, this parameter has no - effect. -

Default: map untrusted to domain = no - -

- -max connections (S) -

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

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

Default: max connections = 0 - -

Example: max connections = 10 - -

- -max disk size (G) -

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

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

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

A max disk size of 0 means no limit.

Default: max disk size = 0 - -

Example: max disk size = 1000 - -

- -max log size (G) -

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

A size of 0 means no limit. -

Default: max log size = 5000 - -

Example: max log size = 1000 - -

- -max mux (G) -

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

Default: max mux = 50 - -

- -max open files (G) -

This parameter limits the maximum number of - open files that one smbd(8) file - serving process may have open for a client at any one time. The - This parameter can be set very high (16404) as Samba uses - only one bit per unopened file. Setting this parameter lower than - 16404 will cause Samba to complain and set this value back to - the minimum of 16404, as Windows 7 depends on this number of - open file handles being available.

The limit of the number of open files is usually set - by the UNIX per-process file descriptor limit rather than - this parameter so you should never need to touch this parameter.

Default: max open files = 16404 - -

- -max print jobs (S) -

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

Default: max print jobs = 1000 - -

Example: max print jobs = 5000 - -

- -protocol -

This parameter is a synonym for max protocol.

- -max protocol (G) -

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

Possible values are :

  • CORE: Earliest version. No - concept of user names.

  • COREPLUS: Slight improvements on - CORE for efficiency.

  • LANMAN1: First - modern version of the protocol. Long filename - support.

  • LANMAN2: Updates to Lanman1 protocol.

  • NT1: Current up to date version of the protocol. - Used by Windows NT. Known as CIFS.

  • SMB2: Re-implementation of the SMB protocol. - Used by Windows Vista and newer. The Samba implementation of SMB2 is - currently marked experimental!

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

- -max reported print jobs (S) -

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

Default: max reported print jobs = 0 - -

Example: max reported print jobs = 1000 - -

- -max smbd processes (G) -

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

Default: max smbd processes = 0 - -

Example: max smbd processes = 1000 - -

- -max stat cache size (G) -

This parameter limits the size in memory of any - stat cache being used - to speed up case insensitive name mappings. It represents - the number of kilobyte (1024) units the stat cache can use. - A value of zero, meaning unlimited, is not advisable due to - increased memory usage. You should not need to change this - parameter. -

Default: max stat cache size = 256 - -

Example: max stat cache size = 100 - -

- -max ttl (G) -

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

Default: max ttl = 259200 - -

- -max wins ttl (G) -

This option tells smbd(8) when acting as a WINS server - (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 - -

- -max xmit (G) -

This option controls the maximum packet size - that will be negotiated by Samba. The default is 16644, which - matches the behavior of Windows 2000. A value below 2048 is likely to cause problems. - You should never need to change this parameter from its default value. -

Default: max xmit = 16644 - -

Example: max xmit = 8192 - -

- -message command (G) -

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

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

An example is: -

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

-

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

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

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

  • %s = the filename containing - the message.

  • %t = the destination that - the message was sent to (probably the server name).

  • %f = who the message - is from.

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

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

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

-

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

- If you want to silently delete it then try: -

-message command = rm %s
-

-

Default: message command = - -

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

- -min print space (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 - -

- -min protocol (G) -

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

- -min receivefile size (G) -

This option changes the behavior of smbd(8) when processing SMBwriteX calls. Any incoming -SMBwriteX call on a non-signed SMB/CIFS connection greater than this value will not be processed in the normal way but will -be passed to any underlying kernel recvfile or splice system call (if there is no such -call Samba will emulate in user space). This allows zero-copy writes directly from network -socket buffers into the filesystem buffer cache, if available. It may improve performance -but user testing is recommended. If set to zero Samba processes SMBwriteX calls in the -normal way. To enable POSIX large write support (SMB/CIFS writes up to 16Mb) this option must be -nonzero. The maximum value is 128k. Values greater than 128k will be silently set to 128k.

Note this option will have NO EFFECT if set on a SMB signed connection.

The default is zero, which diables this option.

Default: min receivefile size = 0 - -

- -min wins ttl (G) -

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

- -msdfs proxy (S) -

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

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

No default

Example: msdfs proxy = \otherserver\someshare - -

- -msdfs root (S) -

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

- -multicast dns register (G) -

If compiled with proper support for it, Samba will - announce itself with multicast DNS services like for example - provided by the Avahi daemon.

This parameter allows disabling Samba to register - itself.

Default: multicast dns register = yes - -

- -name cache timeout (G) -

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

Default: name cache timeout = 660 - -

Example: name cache timeout = 0 - -

- -name resolve order (G) -

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

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

  • - lmhosts : Lookup an IP address in the Samba lmhosts file. If the line in lmhosts has - no name type attached to the NetBIOS name (see the manpage for lmhosts for details) then - any name type matches for lookup. -

  • - host : Do a standard host name to IP address resolution, using the system - /etc/hosts , NIS, or DNS lookups. This method of name resolution is - operating system depended for instance on IRIX or Solaris this may be controlled by the /etc/nsswitch.conf file. Note that this method is used only if the NetBIOS name - type being queried is the 0x20 (server) name type or 0x1c (domain controllers). The latter case is only - useful for active directory domains and results in a DNS query for the SRV RR entry matching - _ldap._tcp.domain. -

  • wins : Query a name with - the IP address listed in the 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 wins host bcast - -

Example: name resolve order = lmhosts bcast host - -

- -ncalrpc dir (G) -

This directory will hold a series of named pipes to allow RPC over inter-process communication.

. -

This will allow Samba and other unix processes to interact over DCE/RPC without using TCP/IP. Additionally a sub-directory 'np' has restricted permissions, and allows a trusted communication channel between Samba processes

Default: ncalrpc dir = ${prefix}/var/ncalrpc - -

Example: ncalrpc dir = /var/run/samba/ncalrpc - -

- -netbios aliases (G) -

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

Default: netbios aliases = -# empty string (no additional names) - -

Example: netbios aliases = TEST TEST1 TEST2 - -

- -netbios name (G) -

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

- There is a bug in Samba-3 that breaks operation of browsing and access to shares if the netbios name - is set to the literal name PIPE. To avoid this problem, do not name your Samba-3 - server PIPE. -

Default: netbios name = -# machine DNS name - -

Example: netbios name = MYNAME - -

- -netbios scope (G) -

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

- -nis homedir (G) -

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

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

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

- -nmbd bind explicit broadcast (G) -

- This option causes nmbd(8) to explicitly bind to the - broadcast address of the local subnets. This is needed to make nmbd - work correctly in combination with the socket address option. - You should not need to unset this option. -

Default: nmbd bind explicit broadcast = yes - -

- -nt acl support (S) -

This boolean parameter controls whether smbd(8) will attempt to map - UNIX permissions into Windows NT access control lists. The UNIX - permissions considered are the the traditional UNIX owner and - group permissions, as well as POSIX ACLs set on any files or - directories. This parameter was formally a global parameter in - releases prior to 2.2.2.

Default: nt acl support = yes - -

- -ntlm auth (G) -

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

If this option, and lanman - auth are both disabled, then only NTLMv2 logins will be - permited. Not all clients support NTLMv2, and most will require - special configuration to use it.

Default: ntlm auth = yes - -

- -nt pipe support (G) -

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

Default: nt pipe support = yes - -

- -nt status support (G) -

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

You should not need to ever disable this parameter.

Default: nt status support = yes - -

- -null passwords (G) -

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

See also smbpasswd(5).

Default: null passwords = no - -

- -obey pam restrictions (G) -

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

- -only user (S) -

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

- -oplock break wait time (G) -

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

Warning

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

Default: oplock break wait time = 0 - -

- -oplock contention limit (S) -

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

Warning

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

Default: oplock contention limit = 2 - -

- -oplocks (S) -

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

- Oplocks may be selectively turned off on certain files with a share. See - the veto oplock files parameter. On some systems - oplocks are recognized by the underlying operating system. This - allows data synchronization between all access to oplocked files, - whether it be via Samba or NFS or a local UNIX process. See the - kernel oplocks parameter for details. -

Default: oplocks = yes - -

- -os2 driver map (G) -

The parameter is used to define the absolute - path to a file containing a mapping of Windows NT printer driver - names to OS/2 printer driver names. The format is:

<nt driver name> = <os2 driver name>.<device name>

For example, a valid entry using the HP LaserJet 5 - printer driver would appear as HP LaserJet 5L = LASERJET.HP - LaserJet 5L.

- The need for the file is due to the printer driver namespace problem described in - the chapter on Classical Printing in the Samba3-HOWTO book. For more - details on OS/2 clients, please refer to chapter on other clients in the Samba3-HOWTO book. -

Default: os2 driver map = - -

- -os level (G) -

- 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. This parameter is largely auto-configured in the Samba-3 - release series and it is seldom necessary to manually override the default setting. Please refer to - the chapter on Network Browsing in the Samba-3 HOWTO document for further information regarding the use - of this parameter. - Note: The maximum value for this parameter is 255. If you use higher values, counting - will start at 0! -

Default: os level = 20 - -

Example: os level = 65 - -

- -pam password change (G) -

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

- -panic action (G) -

This is a Samba developer option that allows a - system command to be called when either smbd(8) or nmbd(8) crashes. This is usually used to - draw attention to the fact that a problem occurred. -

Default: panic action = - -

Example: panic action = "/bin/sleep 90000" - -

- -paranoid server security (G) -

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

- -passdb backend (G) -

This option allows the administrator to chose which backend - will be used for storing user and possibly group information. This allows - you to swap between different storage mechanisms without recompile.

The parameter value is divided into two parts, the backend's name, and a 'location' - string that has meaning only to that particular backed. These are separated - by a : character.

Available backends can include: -

  • smbpasswd - The old plaintext passdb - backend. Some Samba features will not work if this passdb - backend is used. Takes a path to the smbpasswd file as an - optional argument. -

  • tdbsam - The TDB based password storage - backend. Takes a path to the TDB as an optional argument (defaults to passdb.tdb - in the 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. - Whether multiple servers are supported or not and the exact - syntax depends on the LDAP library you use. -

- -

- Examples of use are: -
-passdb backend = tdbsam:/etc/samba/private/passdb.tdb 
-
-or multi server LDAP URL with OpenLDAP library:
-
-passdb backend = ldapsam:"ldap://ldap-1.example.com ldap://ldap-2.example.com"
-
-or multi server LDAP URL with Netscape based LDAP library:
-
-passdb backend = ldapsam:"ldap://ldap-1.example.com ldap-2.example.com"
-

Default: passdb backend = tdbsam - -

- -passdb expand explicit (G) -

- This parameter controls whether Samba substitutes %-macros in the passdb fields if they are explicitly set. We - used to expand macros here, but this turned out to be a bug because the Windows client can expand a variable - %G_osver% in which %G would have been substituted by the user's primary group. -

Default: passdb expand explicit = no - -

- -passwd chat debug (G) -

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 - parameter is set. This parameter is off by default.

Default: passwd chat debug = no - -

- -passwd chat timeout (G) -

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

- -passwd chat (G) -

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 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 old passsword (%o) is only available when - encrypt passwords has been disabled. - The chat sequence can also contain the standard macros - \n, \r, \t and \s to give line-feed, carriage-return, tab - and space. The chat sequence string can also contain - a '*' which matches any sequence of characters. Double quotes can - be used to collect strings with spaces in them into a single - string.

If the send string in any part of the chat sequence is a full - stop ".", then no string is sent. Similarly, if the - expect string is a full stop then no string is expected.

If the 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 NEW password*" %n\n "*Reenter NEW password*" %n\n "*Password changed*" - -

- -passwd program (G) -

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

- -password level (G) -

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

This deprecated parameter defines the maximum number of characters - that may be upper case in passwords.

For example, say the password given was "FRED". If - password level is set to 1, the following combinations - would be tried if "FRED" failed:

"Fred", "fred", "fRed", "frEd","freD"

If password level was set to 2, - the following combinations would also be tried:

"FRed", "FrEd", "FreD", "fREd", "fReD", "frED", ..

And so on.

The higher value this parameter is set to the more likely - it is that a mixed case password will be matched against a single - case password. However, you should be aware that use of this - parameter reduces security and increases the time taken to - process a new connection.

A value of zero will cause only two attempts to be - made - the password as is and the password in all-lower case.

This parameter is used only when using plain-text passwords. It is - not at all used when encrypted passwords as in use (that is the default - since samba-3.0.0). Use this only when encrypt passwords = No.

Default: password level = 0 - -

Example: password level = 4 - -

- -password server (G) -

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 do all its username/password validation using a specific remote server.

If the security parameter is set to - domain or ads, then this option - should not be used, as the default '*' indicates to Samba - to determine the best DC to contact dynamically, just as all other hosts in an - AD domain do. This allows the domain to be maintained without modification to - the smb.conf file. The cryptograpic protection on the authenticated RPC calls - used to verify passwords ensures that this default is safe.

It is strongly recommended that you use the - default of '*', however if in your particular - environment you have reason to specify a particular DC list, then - the list of machines in this option must be a list of names or IP - addresses of Domain controllers for the Domain. If you use the - default of '*', or list several hosts in the password server option then smbd will try each in turn till it - finds one that responds. This is useful in case your primary - server goes down.

If the list of servers contains both names/IP's and the '*' - character, the list is treated as a list of preferred - domain controllers, but an auto lookup of all remaining DC's - will be added to the list as well. Samba will not attempt to optimize - this list by locating the closest DC.

If parameter is a name, it is looked up using the - parameter name resolve order and so may resolved - by any method and order described in that parameter.

If the security parameter is - set to server, these additional restrictions apply:

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

  • 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 the Samba server rather than from the users workstation.

  • The client must not select NTLMv2 authentication.

  • 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 (a host masqurading 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!

Default: password server = * - -

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

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

- -directory -

This parameter is a synonym for path.

- -path (S) -

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

For a printable service offering guest access, the service - should be readonly and the path should be world-writeable and - have the sticky bit set. This is not mandatory of course, but - you probably won't get the results you expect if you do - otherwise.

Any occurrences of %u in the path - will be replaced with the UNIX username that the client is using - on this connection. Any occurrences of %m - will be replaced by the NetBIOS name of the machine they are - connecting from. These replacements are very useful for setting - up pseudo home directories for users.

Note that this path will be based on root dir - if one was specified.

Default: path = - -

Example: path = /home/fred - -

- -perfcount module (G) -

This parameter specifies the perfcount backend to be used when monitoring SMB - operations. Only one perfcount module may be used, and it must implement all of the - apis contained in the smb_perfcount_handler structure defined in smb.h. -

No default

- -pid directory (G) -

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

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

Example: pid directory = pid directory = /var/run/ - -

- -posix locking (S) -

- The smbd(8) - daemon maintains an database of file locks obtained by SMB clients. The default behavior is - to map this internal database to POSIX locks. This means that file locks obtained by SMB clients are - consistent with those seen by POSIX compliant applications accessing the files via a non-SMB - method (e.g. NFS or local file access). It is very unlikely that you need to set this parameter - to "no", unless you are sharing from an NFS mount, which is not a good idea in the first place. -

Default: posix locking = yes - -

- -postexec (S) -

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

An interesting example may be to unmount server - resources:

postexec = /etc/umount /cdrom

Default: postexec = - -

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

- -preexec close (S) -

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

Default: preexec close = no - -

- -exec -

This parameter is a synonym for preexec.

- -preexec (S) -

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

An interesting example is to send the users a welcome - message every time they log in. Maybe a message of the day? Here - is an example:

- preexec = csh -c 'echo \"Welcome to %S!\" | - /usr/local/samba/bin/smbclient -M %m -I %I' & -

Of course, this could get annoying after a while :-)

- See also preexec close and postexec. -

Default: preexec = - -

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

- -prefered master -

This parameter is a synonym for preferred master.

- -preferred master (G) -

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

- If this is set to yes, on startup, nmbd will force - an election, and it will have a slight advantage in winning the election. It is recommended that this - parameter is used in conjunction with 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 - -

- -preload modules (G) -

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

Default: preload modules = - -

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

- -auto services -

This parameter is a synonym for preload.

- -preload (G) -

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

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

Default: preload = - -

Example: preload = fred lp colorlp - -

- -preserve case (S) -

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

- See the section on NAME MANGLING for a fuller discussion. -

Default: preserve case = yes - -

- -print ok -

This parameter is a synonym for printable.

- -printable (S) -

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

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

Default: printable = no - -

- -printcap cache time (G) -

This option specifies the number of seconds before the printing - subsystem is again asked for the known printers. -

Setting this parameter to 0 disables any rescanning for new - or removed printers after the initial startup. -

Default: printcap cache time = 750 - -

Example: printcap cache time = 600 - -

- -printcap -

This parameter is a synonym for printcap name.

- -printcap name (G) -

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

Note

- Under AIX the default printcap name is /etc/qconfig. Samba will - assume the file is in AIX qconfig format if the string qconfig appears in the printcap filename. -

Default: printcap name = /etc/printcap - -

Example: printcap name = /etc/myprintcap - -

- -print command (S) -

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

The print command is simply a text string. It will be used - verbatim after macro substitutions have been made:

%s, %f - the path to the spool - file name

%p - the appropriate printer - name

%J - the job - name as transmitted by the client.

%c - The number of printed pages - of the spooled job (if known).

%z - the size of the spooled - print job (in bytes)

The print command MUST contain at least - one occurrence of %s or %f - - the %p is optional. At the time - a job is submitted, if no printer name is supplied the %p - will be silently removed from the printer command.

If specified in the [global] section, the print command given - will be used for any printable service that does not have its own - print command specified.

If there is neither a specified print command for a - printable service nor a global print command, spool files will - be created but not processed and (most importantly) not removed.

Note that printing may fail on some UNIXes from the - nobody account. If this happens then create - an alternative guest account that can print and set the guest account - in the [global] section.

You can form quite complex print commands by realizing - that they are just passed to a shell. For example the following - will log a print job, print the file, then remove it. Note that - ';' is the usual separator for command in shell scripts.

print command = echo Printing %s >> - /tmp/print.log; lpr -P %p %s; rm %s

You may have to vary this command considerably depending - on how you normally print files on your system. The default for - the parameter varies depending on the setting of the printing - parameter.

Default: For printing = BSD, AIX, QNX, LPRNG - or PLP :

print command = lpr -r -P%p %s

For printing = SYSV or HPUX :

print command = lp -c -d%p %s; rm %s

For printing = SOFTQ :

print command = lp -d%p -s %s; rm %s

For printing = CUPS : If SAMBA is compiled against - libcups, then printcap = cups - uses the CUPS API to - submit jobs, etc. Otherwise it maps to the System V - commands with the -oraw option for printing, i.e. it - uses lp -c -d%p -oraw; rm %s. - With printing = cups, - and if SAMBA is compiled against libcups, any manually - set print command will be ignored.

No default

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

- -printer admin (S) -

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

- This parameter has been marked deprecated in favor - of using the SePrintOperatorPrivilege and individual - print security descriptors. It will be removed in a future release. -

Default: printer admin = - -

Example: printer admin = admin, @staff - -

- -printer -

This parameter is a synonym for printer name.

- -printer name (S) -

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

- If specified in the [global] section, the printer name given will be used for any printable service that - does not have its own printer name specified. -

- The default value of the printer name may be lp on many - systems. -

Default: printer name = none - -

Example: printer name = laserwriter - -

- -printing (S) -

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

Currently nine printing styles are supported. They are - BSD, AIX, - LPRNG, PLP, - SYSV, HPUX, - QNX, SOFTQ, - and CUPS.

To see what the defaults are for the other print - commands when using the various options use the testparm(1) program.

This option can be set on a per printer basis. Please be - aware however, that you must place any of the various printing - commands (e.g. print command, lpq command, etc...) after defining - the value for the printing option since it will - reset the printing commands to default values.

See also the discussion in the - [printers] section.

Default: printing = Depends on the operating system, see -testparm -v. - -

- -printjob username (S) -

This parameter specifies which user information will be - passed to the printing system. Usually, the username is sent, - but in some cases, e.g. the domain prefix is useful, too.

Default: printjob username = %U - -

Example: printjob username = %D\%U - -

- -print notify backchannel (S) -

Windows print clients can update print queue status by expecting - the server to open a backchannel SMB connection to them. Due to - client firewall settings this can cause considerable timeouts - and will often fail, as there is no guarantee the client is even - running an SMB server. By setting this parameter to no - the Samba print server will not try to connect back to clients - and treat corresponding requests as if the connection back to - the client failed. The default setting of yes - causes smbd to attempt this connection. -

Default: print notify backchannel = yes - -

- -private dir (G) -

This parameters defines the directory - smbd will use for storing such files as smbpasswd - and secrets.tdb. -

Default: private dir = ${prefix}/private - -

- -profile acls (S) -

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

- Note that this parameter should be set to yes on dedicated profile shares only. - On other shares, it might cause incorrect file ownerships. -

Default: profile acls = no - -

- -queuepause command (S) -

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

- -queueresume command (S) -

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

- -read list (S) -

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

- -read only (S) -

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

- -read raw (G) -

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

- -realm (G) -

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

- -registry shares (G) -

- This turns on or off support for share definitions read from - registry. Shares defined in smb.conf take - precedence over shares with the same name defined in - registry. See the section on registry-based configuration - for details. -

- Note that this parameter defaults to no, - but it is set to yes when - config backend is set - to registry. -

Default: registry shares = no - -

Example: registry shares = yes - -

- -remote announce (G) -

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

- See the chapter on Network Browsing in the Samba-HOWTO book. -

Default: remote announce = - -

- -remote browse sync (G) -

- This option allows you to setup nmbd(8) to periodically request - synchronization of browse lists with the master browser of a Samba - server that is on a remote segment. This option will allow you to - gain browse lists for multiple workgroups across routed networks. This - is done in a manner that does not work with any non-Samba servers. -

- This is useful if you want your Samba server and all local - clients to appear in a remote workgroup for which the normal browse - propagation rules don't work. The remote workgroup can be anywhere - that you can send IP packets to. -

- For example: -

-remote browse sync = 192.168.2.255 192.168.4.255
-

- the above line would cause nmbd to request the master browser on the - specified subnets or addresses to synchronize their browse lists with - the local server. -

- The IP addresses you choose would normally be the broadcast - addresses of the remote networks, but can also be the IP addresses - of known browse masters if your network config is that stable. If - a machine IP address is given Samba makes NO attempt to validate - that the remote machine is available, is listening, nor that it - is in fact the browse master on its segment. -

- The remote browse sync may be used on networks - where there is no WINS server, and may be used on disjoint networks where - each network has its own WINS server. -

Default: remote browse sync = - -

- -rename user script (G) -

- This is the full pathname to a script that will be run as root by smbd(8) under special circumstances described below. -

- When a user with admin authority or SeAddUserPrivilege rights renames a user (e.g.: from the NT4 User Manager - for Domains), this script will be run to rename the POSIX user. Two variables, %uold and - %unew, will be substituted with the old and new usernames, respectively. The script should - return 0 upon successful completion, and nonzero otherwise. -

Note

- The script has all responsibility to rename all the necessary data that is accessible in this posix method. - This can mean different requirements for different backends. The tdbsam and smbpasswd backends will take care - of the contents of their respective files, so the script is responsible only for changing the POSIX username, and - other data that may required for your circumstances, such as home directory. Please also consider whether or - not you need to rename the actual home directories themselves. The ldapsam backend will not make any changes, - because of the potential issues with renaming the LDAP naming attribute. In this case the script is - responsible for changing the attribute that samba uses (uid) for locating users, as well as any data that - needs to change for other applications using the same directory. -

Default: rename user script = no - -

- -reset on zero vc (G) -

- This boolean option controls whether an incoming session setup - should kill other connections coming from the same IP. This matches - the default Windows 2003 behaviour. - - Setting this parameter to yes becomes necessary when you have a flaky - network and windows decides to reconnect while the old connection - still has files with share modes open. These files become inaccessible - over the new connection. - - The client sends a zero VC on the new connection, and Windows 2003 - kills all other connections coming from the same IP. This way the - locked files are accessible again. - - Please be aware that enabling this option will kill connections behind - a masquerading router. - -

Default: reset on zero vc = no - -

- -restrict anonymous (G) -

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

Note

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

Default: restrict anonymous = 0 - -

- -root -

This parameter is a synonym for root directory.

- -root dir -

This parameter is a synonym for root directory.

- -root directory (G) -

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

- -root postexec (S) -

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

Default: root postexec = - -

- -root preexec close (S) -

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

Default: root preexec close = no - -

- -root preexec (S) -

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

Default: root preexec = - -

- -rpc_server (G) -

- Defines what kind of rpc server to use for a named pipe. - The rpc_server prefix must be followed by the pipe name, and a value. -

- Three possible values are currently supported: - embedded - daemon - external -

- The classic method is to run every pipe as an internal function - embedded in smbd. -

- An alternative method is to fork a daemon - early on at smbd startup time. This is supported only for selected - pipes. -

- Choosing the external option allows to run a - completely independent (3rd party) server capable of interfacing - with samba via the MS-RPC interface over named pipes. -

- Currently only the spoolss pipe can be configured in - daemon mode like this: - 

-	rpc_server:spoolss = daemon
-

-

Default: rpc_server = none - -

- -security mask (S) -

- This parameter controls what UNIX permission bits will be set 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 incoming permission bits, thus resetting - any bits not in this mask. 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, all bits set to zero in this mask will result in setting to zero the corresponding bits on the - file permissions regardless of the previous status of this bits on the file. -

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

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

Default: security mask = 0777 - -

Example: security mask = 0770 - -

- -security (G) -

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

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

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

The alternatives are - security = ads or security = domain - , which support joining Samba to a Windows domain, along with security = share and security = server, both of which are deprecated.

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

You should use security = user and - map to guest if you - want to mainly setup shares without a password (guest shares). This - is commonly used for a shared printer server.

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.

SECURITY = USER

This is the default security setting in Samba. - With user-level security a client must first "log-on" with a - valid username and password (which can be mapped using the 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.

SECURITY = DOMAIN

This mode will only work correctly if net(8) has been used to add this - machine into a Windows NT Domain. It expects the 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.

SECURITY = SHARE

Note

This option is deprecated as it is incompatible with SMB2

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.

SECURITY = SERVER

- In this depicted 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. -

Note

This mode of operation has - significant pitfalls since it is more vulnerable to - man-in-the-middle attacks and server impersonation. In particular, - this mode of operation can cause significant resource consumption 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 further authentications to the - Samba server may fail (from a single client, till it disconnects). -

Note

If the client selects NTLMv2 authentication, then this mode of operation will fail -

Note

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

Note

This option is deprecated, and may be removed in future

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.

SECURITY = ADS

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

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

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

Default: security = USER - -

Example: security = DOMAIN - -

- -send spnego principal (G) -

This parameter determines whether or not - smbd(8) will send the - server-supplied principal sometimes given in the SPNEGO - exchange.

If enabled, Samba can attempt to help clients to use - Kerberos to contact it, even when known only by IP address or a - name not registered with our KDC as a service principal name. - Kerberos relies on names, so ordinarily cannot function in this - situation.

If disabled, Samba will send the string - not_defined_in_RFC4178@please_ignore as the 'rfc4178 hint', - following the updated RFC and Windows 2008 behaviour in this area. -

Note that Windows XP SP2 and later versions already ignored - this value in all circumstances.

Default: send spnego principal = no - -

- -server schannel (G) -

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

- -server signing (G) -

This controls whether the client is allowed or required 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 - -

- -server string (G) -

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

- -set directory (S) -

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

- -set primary group script (G) -

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

- -set quota command (G) -

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

- -share:fake_fscaps (G) -

- This is needed to support some special application that makes - QFSINFO calls to check whether we set the SPARSE_FILES bit - (0x40). If this bit is not set that particular application - refuses to work against - Samba. With share:fake_fscaps = 64 - the SPARSE_FILES file system capability flag is set. Use other - decimal values to specify the bitmask you need to fake. -

Default: share:fake_fscaps = 0 - -

- -share modes (S) -

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.

This is a deprecated option from old versions of - Samba, and will be removed in the next major release. -

These open modes are not directly supported by UNIX, so - they are simulated using shared memory.

The share modes that are enabled by this option are - the standard Windows share modes. -

This option gives full share compatibility and is enabled - by default.

You should NEVER turn this parameter - off as many Windows applications will break if you do so.

Default: share modes = yes - -

- -short preserve case (S) -

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

- -show add printer wizard (G) -

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

Note

This does not prevent the same user from having - administrative privilege on an individual printer.

Default: show add printer wizard = yes - -

- -shutdown script (G) -

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

The %z %t %r %f variables are expanded as follows:

  • %z will be substituted with the - shutdown message sent to the server.

  • %t will be substituted with the - number of seconds to wait before effectively starting the - shutdown procedure.

  • %r will be substituted with the - switch -r. It means reboot after shutdown - for NT.

  • %f will be substituted with the - switch -f. It means force the shutdown - even if applications do not respond for NT.

Shutdown script example: -

-#!/bin/bash
-
-time=$2
-let time="${time} / 60"
-let time="${time} + 1"
-
-/sbin/shutdown $3 $4 +$time $1 &
-
-

- Shutdown does not return so we need to launch it in background. -

Default: shutdown script = - -

Example: shutdown script = /usr/local/samba/sbin/shutdown %m %t %r %f - -

- -smb2 max credits (G) -

This option controls the maximum number of outstanding simultaneous SMB2 operations -that Samba tells the client it will allow. This is similar to the max mux -parameter for SMB1. You should never need to set this parameter. -

The default is 8192 credits, which is the same as a Windows 2008R2 SMB2 server.

Default: smb2 max credits = 8192 - -

- -smb2 max read (G) -

This option specifies the protocol value that smbd(8) will return to a client, informing the client of the largest -size that may be returned by a single SMB2 read call. -

The maximum is 65536 bytes (64KB), which is the same as a Windows Vista SMB2 server.

Default: smb2 max read = 65536 - -

- -smb2 max trans (G) -

This option specifies the protocol value that smbd(8) will return to a client, informing the client of the largest -size of buffer that may be used in querying file meta-data via QUERY_INFO and related SMB2 calls. -

The maximum is 65536 bytes (64KB), which is the same as a Windows Vista SMB2 server.

Default: smb2 max trans = 65536 - -

- -smb2 max write (G) -

This option specifies the protocol value that smbd(8) will return to a client, informing the client of the largest -size that may be sent to the server by a single SMB2 write call. -

The maximum is 65536 bytes (64KB), which is the same as a Windows Vista SMB2 server.

Default: smb2 max write = 65536 - -

- -smb encrypt (S) -

This is a new feature introduced with Samba 3.2 and above. It is an - extension to the SMB/CIFS protocol negotiated as part of the UNIX extensions. - SMB encryption uses the GSSAPI (SSPI on Windows) ability to encrypt - and sign every request/response in a SMB protocol stream. When - enabled it provides a secure method of SMB/CIFS communication, - similar to an ssh protected session, but using SMB/CIFS authentication - to negotiate encryption and signing keys. Currently this is only - supported by Samba 3.2 smbclient, and hopefully soon Linux CIFSFS - and MacOS/X clients. Windows clients do not support this feature. -

This controls whether the remote client is allowed or required to use SMB encryption. Possible values - are auto, mandatory - and disabled. This may be set on a per-share - basis, but clients may chose to encrypt the entire session, not - just traffic to a specific share. If this is set to mandatory - then all traffic to a share must must - be encrypted once the connection has been made to the share. - The server would return "access denied" to all non-encrypted - requests on such a share. Selecting encrypted traffic reduces - throughput as smaller packet sizes must be used (no huge UNIX - style read/writes allowed) as well as the overhead of encrypting - and signing all the data. -

If SMB encryption is selected, Windows style SMB signing (see - the server signing option) is no longer necessary, - as the GSSAPI flags use select both signing and sealing of the data. -

When set to auto, SMB encryption is offered, but not enforced. - When set to mandatory, SMB encryption is required and if set - to disabled, SMB encryption can not be negotiated.

Default: smb encrypt = auto - -

- -smb passwd file (G) -

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

- An example of use is: -

-smb passwd file = /etc/samba/smbpasswd
-

-

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

- -smb ports (G) -

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

Default: smb ports = 445 139 - -

- -socket address (G) -

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

Setting this option should never be necessary on usual Samba - servers running only one nmbd.

By default Samba will accept connections on any - address.

Default: socket address = - -

Example: socket address = 192.168.2.20 - -

- -socket options (G) -

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

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

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

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

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

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

  • SO_KEEPALIVE

  • SO_REUSEADDR

  • SO_BROADCAST

  • TCP_NODELAY

  • IPTOS_LOWDELAY

  • IPTOS_THROUGHPUT

  • SO_SNDBUF *

  • SO_RCVBUF *

  • SO_SNDLOWAT *

  • SO_RCVLOWAT *

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

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

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

socket options = IPTOS_LOWDELAY

If you have a local network then you could try:

socket options = IPTOS_LOWDELAY TCP_NODELAY

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

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

Default: socket options = TCP_NODELAY - -

Example: socket options = IPTOS_LOWDELAY - -

- -stat cache (G) -

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

Default: stat cache = yes - -

- -state directory (G) -

Usually, most of the TDB files are stored in the - lock directory. Since - Samba 3.4.0, it is possible to differentiate between TDB files - with persistent data and TDB files with non-persistent data using - the state directory and the - cache directory options. -

This option specifies the directory where TDB files containing - persistent data will be stored. -

Default: state directory = ${prefix}/var/locks - -

Example: state directory = /var/run/samba/locks/state - -

- -store dos attributes (S) -

- If this parameter is set Samba attempts to first read DOS attributes (SYSTEM, HIDDEN, ARCHIVE or - READ-ONLY) from a filesystem extended attribute, before mapping DOS attributes to UNIX permission bits (such - as occurs with map hidden and map readonly). When set, DOS - attributes will be stored onto an extended attribute in the UNIX filesystem, associated with the file or - directory. For no other mapping to occur as a fall-back, the parameters map hidden, - map system, map archive and map readonly 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. - - In Samba 3.5.0 and above the "user.DOSATTRIB" extended attribute has been extended to store - the create time for a file as well as the DOS attributes. This is done in a backwards compatible - way so files created by Samba 3.5.0 and above can still have the DOS attribute read from this - extended attribute by earlier versions of Samba, but they will not be able to read the create - time stored there. Storing the create time separately from the normal filesystem meta-data - allows Samba to faithfully reproduce NTFS semantics on top of a POSIX filesystem. -

Default: store dos attributes = no - -

- -strict allocate (S) -

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

This option is really desgined for file systems that support - fast allocation of large numbers of blocks such as extent-based file systems. - On file systems that don't support extents (most notably ext3) this can - make Samba slower. When you work with large files over >100MB on file - systems without extents you may even run into problems with clients - running into timeouts.

When you have an extent based filesystem it's likely that we can make - use of unwritten extents which allows Samba to allocate even large amounts - of space very fast and you will not see any timeout problems caused by - strict allocate. With strict allocate in use you will also get much better - out of quota messages in case you use quotas. Another advantage of - activating this setting is that it will help to reduce file - fragmentation.

To give you an idea on which filesystems this setting might currently - be a good option for you: XFS, ext4, btrfs, ocfs2 on Linux and JFS2 on - AIX support unwritten extents. On Filesystems that do not support it, - preallocation is probably an expensive operation where you will see reduced - performance and risk to let clients run into timeouts when creating large - files. Examples are ext3, ZFS, HFS+ and most others, so be aware if you - activate this setting on those filesystems.

Default: strict allocate = no - -

- -strict locking (S) -

- This is an enumerated type 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 set to Auto (the default), the server performs file lock checks only on non-oplocked files. - As most Windows redirectors perform file locking checks locally on oplocked files this is a good trade off for - improved performance. -

- When strict locking is disabled, the server performs file lock checks only when the client explicitly asks for them. -

- Well-behaved clients always ask for lock checks when it is important. So in the vast majority of cases, - strict locking = Auto or - strict locking = no is acceptable. -

Default: strict locking = Auto - -

- -strict sync (S) -

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

Default: strict sync = no - -

- -svcctl list (G) -

This option defines a list of init scripts that smbd - will use for starting and stopping Unix services via the Win32 - ServiceControl API. This allows Windows administrators to - utilize the MS Management Console plug-ins to manage a - Unix server running Samba.

The administrator must create a directory - name svcctl in Samba's $(libdir) - and create symbolic links to the init scripts in - /etc/init.d/. The name of the links - must match the names given as part of the svcctl list. -

Default: svcctl list = - -

Example: svcctl list = cups postfix portmap httpd - -

- -sync always (S) -

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

Default: sync always = no - -

- -syslog only (G) -

- If this parameter is set then Samba debug messages are logged into the system - syslog only, and not to the debug log files. There still will be some - logging to log.[sn]mbd even if syslog only is enabled. -

Default: syslog only = no - -

- -syslog (G) -

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

- This parameter sets the threshold for sending messages to syslog. Only messages with debug - level less than this value will be sent to syslog. There still will be some - logging to log.[sn]mbd even if syslog only is enabled. -

Default: syslog = 1 - -

- -template homedir (G) -

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

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

- -template shell (G) -

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

No default

- -time offset (G) -

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

Note

This option is deprecated, and will be removed in the next major release

Default: time offset = 0 - -

Example: time offset = 60 - -

- -time server (G) -

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

Default: time server = no - -

- -unix charset (G) -

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

This is also the charset Samba will use when specifying arguments - to scripts that it invokes. -

Default: unix charset = UTF8 - -

Example: unix charset = ASCII - -

- -unix extensions (G) -

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

- Note if this parameter is turned on, the wide links - parameter will automatically be disabled. -

- See the parameter allow insecure wide links - if you wish to change this coupling between the two parameters. -

Default: unix extensions = yes - -

- -unix password sync (G) -

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

Default: unix password sync = no - -

- -use client driver (S) -

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 enabled - on a print share which has valid print driver installed on the Samba - server.

Default: use client driver = no - -

- -use mmap (G) -

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

Default: use mmap = yes - -

- -username level (G) -

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

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

This parameter is needed only on UNIX systems that have case - sensitive usernames.

Default: username level = 0 - -

Example: username level = 5 - -

- -username map cache time (G) -

- Mapping usernames with the username map - or username map script - features of Samba can be relatively expensive. - During login of a user, the mapping is done several times. - In particular, calling the username map script - can slow down logins if external databases have to be queried from - the script being called. -

- The parameter username map cache time - controls a mapping cache. It specifies the number of seconds a - mapping from the username map file or script is to be efficiently cached. - The default of 0 means no caching is done. -

Default: username map cache time = 0 - -

Example: username map cache time = 60 - -

- -username map script (G) -

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

- -username map (G) -

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

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

- -user -

This parameter is a synonym for username.

- -users -

This parameter is a synonym for username.

- -username (S) -

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

The deprecated 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 - -

- -usershare allow guests (G) -

This parameter controls whether user defined shares are allowed - to be accessed by non-authenticated users or not. It is the equivalent - of allowing people who can create a share the option of setting - guest ok = yes in a share - definition. Due to its security sensitive nature, the default - is set to off.

Default: usershare allow guests = no - -

- -usershare max shares (G) -

This parameter specifies the number of user defined shares - that are allowed to be created by users belonging to the group owning the - usershare directory. If set to zero (the default) user defined shares are ignored. -

Default: usershare max shares = 0 - -

- -usershare owner only (G) -

This parameter controls whether the pathname exported by - a user defined shares must be owned by the user creating the - user defined share or not. If set to True (the default) then - smbd checks that the directory path being shared is owned by - the user who owns the usershare file defining this share and - refuses to create the share if not. If set to False then no - such check is performed and any directory path may be exported - regardless of who owns it. -

Default: usershare owner only = True - -

- -usershare path (G) -

This parameter specifies the absolute path of the directory on the - filesystem used to store the user defined share definition files. - This directory must be owned by root, and have no access for - other, and be writable only by the group owner. In addition the - "sticky" bit must also be set, restricting rename and delete to - owners of a file (in the same way the /tmp directory is usually configured). - Members of the group owner of this directory are the users allowed to create - usershares. If this parameter is undefined then no user defined - shares are allowed. -

- For example, a valid usershare directory might be /usr/local/samba/lib/usershares, - set up as follows. -

- 

-	ls -ld /usr/local/samba/lib/usershares/
-	drwxrwx--T  2 root power_users 4096 2006-05-05 12:27 /usr/local/samba/lib/usershares/
-

-

- In this case, only members of the group "power_users" can create user defined shares. -

Default: usershare path = NULL - -

- -usershare prefix allow list (G) -

This parameter specifies a list of absolute pathnames - the root of which are allowed to be exported by user defined share definitions. - If the pathname to be exported doesn't start with one of the strings in this - list, the user defined share will not be allowed. This allows the Samba - administrator to restrict the directories on the system that can be - exported by user defined shares. -

- If there is a "usershare prefix deny list" and also a - "usershare prefix allow list" the deny list is processed - first, followed by the allow list, thus leading to the most - restrictive interpretation. -

Default: usershare prefix allow list = NULL - -

Example: usershare prefix allow list = /home /data /space - -

- -usershare prefix deny list (G) -

This parameter specifies a list of absolute pathnames - the root of which are NOT allowed to be exported by user defined share definitions. - If the pathname exported starts with one of the strings in this - list the user defined share will not be allowed. Any pathname not - starting with one of these strings will be allowed to be exported - as a usershare. This allows the Samba administrator to restrict the - directories on the system that can be exported by user defined shares. -

- If there is a "usershare prefix deny list" and also a - "usershare prefix allow list" the deny list is processed - first, followed by the allow list, thus leading to the most - restrictive interpretation. -

Default: usershare prefix deny list = NULL - -

Example: usershare prefix deny list = /etc /dev /private - -

- -usershare template share (G) -

User defined shares only have limited possible parameters - such as path, guest ok, etc. This parameter allows usershares to - "cloned" from an existing share. If "usershare template share" - is set to the name of an existing share, then all usershares - created have their defaults set from the parameters set on this - share. -

- The target share may be set to be invalid for real file - sharing by setting the parameter "-valid = False" on the template - share definition. This causes it not to be seen as a real exported - share but to be able to be used as a template for usershares. -

Default: usershare template share = NULL - -

Example: usershare template share = template_share - -

- -use sendfile (S) -

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

- -use spnego (G) -

This deprecated variable controls controls whether samba will try - to use Simple and Protected NEGOciation (as specified by rfc2478) with - WindowsXP and Windows2000 clients to agree upon an authentication mechanism. -

- Unless further issues are discovered with our SPNEGO - implementation, there is no reason this should ever be - disabled.

Default: use spnego = yes - -

- -utmp directory (G) -

This parameter is only available if Samba has - been configured and compiled with the option - --with-utmp. It specifies a directory pathname that is - used to store the utmp or utmpx files (depending on the UNIX system) that - record user connections to a Samba server. 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 - -

- -utmp (G) -

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

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

Default: utmp = no - -

- -valid users (S) -

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

- If this is empty (the default) then any user can login. If a username is in both this list - and the invalid users list then access is denied - for that user. -

- The current servicename is substituted for %S. - This is useful in the [homes] section. -

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

Example: valid users = greg, @pcusers - -

- --valid (S) -

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

- This option should not be - used by regular users but might be of help to developers. - Samba uses this option internally to mark shares as deleted. -

Default: -valid = yes - -

- -veto files (S) -

- This is a list of files and directories that are neither visible nor accessible. Each entry in - the list must be separated by a '/', which allows spaces to be included in the entry. '*' and '?' - can be used to specify multiple files or directories as in DOS wildcards. -

- Each entry must be a unix path, not a DOS path and must not include the - unix directory separator '/'. -

- Note that the case sensitive option is applicable in vetoing files. -

- One feature of the veto files parameter that it is important to be aware of is Samba's behaviour when - trying to delete a directory. If a directory that is to be deleted contains nothing but veto files this - deletion will fail unless you also set the delete veto files - parameter to yes. -

- Setting this parameter will affect the performance of Samba, as it will be forced to check all files - and directories for a match as they are scanned. -

- Examples of use include: -

-; Veto any files containing the word Security,
-; any ending in .tmp, and any directory containing the
-; word root.
-veto files = /*Security*/*.tmp/*root*/
-
-; Veto the Apple specific files that a NetAtalk server
-; creates.
-veto files = /.AppleDouble/.bin/.AppleDesktop/Network Trash Folder/
-

-

Default: veto files = No files or directories are vetoed. - -

- -veto oplock files (S) -

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

- -vfs object -

This parameter is a synonym for vfs objects.

- -vfs objects (S) -

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

Default: vfs objects = - -

Example: vfs objects = extd_audit recycle - -

- -volume (S) -

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

Default: volume = -# the name of the share - -

- -wide links (S) -

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

Note: Turning this parameter on when UNIX extensions are enabled - will allow UNIX clients to create symbolic links on the share that - can point to files or directories outside restricted path exported - by the share definition. This can cause access to areas outside of - the share. Due to this problem, this parameter will be automatically - disabled (with a message in the log file) if the - unix extensions option is on. -

- See the parameter allow insecure wide links - if you wish to change this coupling between the two parameters. -

Default: wide links = no - -

- -winbind cache time (G) -

This parameter specifies the number of - seconds the winbindd(8) daemon will cache - user and group information before querying a Windows NT server - again.

- This does not apply to authentication requests, these are always - evaluated in real time unless the winbind offline logon option has been enabled. -

Default: winbind cache time = 300 - -

- -winbind enum groups (G) -

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

Warning

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

Default: winbind enum groups = no - -

- -winbind enum users (G) -

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

Warning

Turning off user - enumeration may cause some programs to behave oddly. For - example, the finger program relies on having access to the - full user list when searching for matching - usernames.

Default: winbind enum users = no - -

- -winbind expand groups (G) -

This option controls the maximum depth that winbindd - will traverse when flattening nested group memberships - of Windows domain groups. This is different from the - winbind nested groups option - which implements the Windows NT4 model of local group - nesting. The "winbind expand groups" - parameter specifically applies to the membership of - domain groups.

Be aware that a high value for this parameter can - result in system slowdown as the main parent winbindd daemon - must perform the group unrolling and will be unable to answer - incoming NSS or authentication requests during this time.

Default: winbind expand groups = 1 - -

- -winbind max clients (G) -

This parameter specifies the maximum number of clients - the winbindd(8) daemon can connect with. -

Default: winbind max clients = 200 - -

- -winbind max domain connections (G) -

This parameter specifies the maximum number of simultaneous - connections that the winbindd(8) daemon should open to the - domain controller of one domain. - Setting this parameter to a value greater than 1 can improve - scalability with many simultaneous winbind requests, - some of which might be slow. -

- Note that if winbind offline logon is set to - Yes, then only one - DC connection is allowed per domain, regardless of this setting. -

Default: winbind max domain connections = 1 - -

Example: winbind max domain connections = 10 - -

- -winbind nested groups (G) -

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.

Default: winbind nested groups = yes - -

- -winbind normalize names (G) -

This parameter controls whether winbindd will replace - whitespace in user and group names with an underscore (_) character. - For example, whether the name "Space Kadet" should be - replaced with the string "space_kadet". - Frequently Unix shell scripts will have difficulty with usernames - contains whitespace due to the default field separator in the shell. - If your domain possesses names containing the underscore character, - this option may cause problems unless the name aliasing feature - is supported by your nss_info plugin. -

This feature also enables the name aliasing API which can - be used to make domain user and group names to a non-qualified - version. Please refer to the manpage for the configured - idmap and nss_info plugin for the specifics on how to configure - name aliasing for a specific configuration. Name aliasing takes - precedence (and is mutually exclusive) over the whitespace - replacement mechanism discussed previsouly. -

Default: winbind normalize names = no - -

Example: winbind normalize names = yes - -

- -winbind nss info (G) -

This parameter is designed to control how Winbind retrieves Name - Service Information to construct a user's home directory and login shell. - Currently the following settings are available: - -

  • template - - The default, using the parameters of template - shell and template homedir) -

  • <sfu | rfc2307 > - - When Samba is running in security = ads and your Active Directory - Domain Controller does support the Microsoft "Services for Unix" (SFU) - LDAP schema, winbind can retrieve the login shell and the home - directory attributes directly from your Directory Server. Note that - retrieving UID and GID from your ADS-Server requires to - use idmap config DOMAIN:backend = ad - as well. -

- -

Default: winbind nss info = template - -

Example: winbind nss info = sfu - -

- -winbind offline logon (G) -

This parameter is designed to control whether Winbind should - allow to login with the pam_winbind - module using Cached Credentials. If enabled, winbindd will store user credentials - from successful logins encrypted in a local cache. -

Default: winbind offline logon = false - -

Example: winbind offline logon = true - -

- -winbind reconnect delay (G) -

This parameter specifies the number of - seconds the winbindd(8) daemon will wait between - attempts to contact a Domain controller for a domain that is - determined to be down or not contactable.

Default: winbind reconnect delay = 30 - -

- -winbind refresh tickets (G) -

This parameter is designed to control whether Winbind should refresh Kerberos Tickets - retrieved using the pam_winbind module. - -

Default: winbind refresh tickets = false - -

Example: winbind refresh tickets = true - -

- -winbind rpc only (G) -

- Setting this parameter to yes forces - winbindd to use RPC instead of LDAP to retrieve information from Domain - Controllers. -

Default: winbind rpc only = no - -

- -winbind separator (G) -

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

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

Default: winbind separator = '\' - -

Example: winbind separator = + - -

- -winbind trusted domains only (G) -

- This parameter is designed to allow Samba servers that are members - of a Samba controlled domain to use UNIX accounts distributed 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. -

- This parameter is now deprecated in favor of the newer idmap_nss backend. - Refer to the idmap_nss(8) man page for more information. -

Default: winbind trusted domains only = no - -

- -winbind use default domain (G) -

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

This option should be avoided if possible. It can cause confusion - about responsibilities for a user or group. In many situations it is - not clear whether winbind or /etc/passwd should be seen as authoritative - for a user, likewise for groups.

Default: winbind use default domain = no - -

Example: winbind use default domain = yes - -

- -wins hook (G) -

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

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

wins_hook operation name nametype ttl IP_list

  • The first argument is the operation and is - one of "add", "delete", or - "refresh". In most cases the operation - can be ignored as the rest of the parameters - provide sufficient information. Note that - "refresh" may sometimes be called when - the name has not previously been added, in that - case it should be treated as an add.

  • The second argument is the NetBIOS name. If the - name is not a legal name then the wins hook is not called. - Legal names contain only letters, digits, hyphens, underscores - and periods.

  • The third argument is the NetBIOS name - type as a 2 digit hexadecimal number.

  • The fourth argument is the TTL (time to live) - for the name in seconds.

  • The fifth and subsequent arguments are the IP - addresses currently registered for that name. If this list is - empty then the name should be deleted.

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

No default

- -wins proxy (G) -

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

Default: wins proxy = no - -

- -wins server (G) -

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

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

If you want to work in multiple namespaces, you can - give every wins server a 'tag'. For each tag, only one - (working) server will be queried for a name. The tag should be - separated from the ip address by a colon. -

Note

You need to set up Samba to point - to a WINS server if you have multiple subnets and wish cross-subnet - browsing to work correctly.

See the chapter in the Samba3-HOWTO on Network Browsing.

Default: wins server = - -

Example: wins server = mary:192.9.200.1 fred:192.168.3.199 mary:192.168.2.61 - -# For this example when querying a certain name, 192.19.200.1 will - be asked first and if that doesn't respond 192.168.2.61. If either - of those doesn't know the name 192.168.3.199 will be queried. - -

Example: wins server = 192.9.200.1 192.168.2.61 - -

- -wins support (G) -

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

Default: wins support = no - -

- -workgroup (G) -

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

Default: workgroup = WORKGROUP - -

Example: workgroup = MYGROUP - -

- -writable -

This parameter is a synonym for writeable.

- -writeable (S) -

Inverted synonym for read only.

Default: writeable = no - -

- -write cache size (S) -

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

This cache allows Samba to batch client writes into a more - efficient write size for RAID disks (i.e. writes may be tuned to - be the RAID stripe size) and can improve performance on systems - where the disk subsystem is a bottleneck but there is free - memory for userspace programs.

The integer parameter specifies the size of this cache - (per oplocked file) in bytes.

Default: write cache size = 0 - -

Example: write cache size = 262144 -# for a 256k cache size per file - -

- -write list (S) -

- This is a list of users that are given read-write access to a service. If the - connecting user is in this list then they will be given write access, no matter - what the 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. -

- By design, this parameter will not work with the - security = share in Samba 3.0. -

Default: write list = - -

Example: write list = admin, root, @staff - -

- -write raw (G) -

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

- -wtmp directory (G) -

- This parameter is only available if Samba has been configured and compiled with the option - --with-utmp. It specifies a directory pathname that is used to store the 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 - -

WARNINGS

- Although the configuration file permits service names to contain spaces, your client software may not. - Spaces will be ignored in comparisons anyway, so it shouldn't be a problem - but be aware of the possibility. -

- On a similar note, many clients - especially DOS clients - limit service names to eight characters. - smbd(8) has no such - limitation, but attempts to connect from such clients will fail if they truncate the service names. For this - reason you should probably keep your service names down to eight characters in length. -

- Use of the [homes] and [printers] special sections make life - for an administrator easy, but the various combinations of default attributes can be tricky. Take extreme - care when designing these sections. In particular, ensure that the permissions on spool directories are - correct. -

VERSION

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

SEE ALSO

- samba(7), smbpasswd(8), swat(8), smbd(8), nmbd(8), smbclient(1), nmblookup(1), testparm(1), testprns(1).

AUTHOR

- The original Samba software and related utilities were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar to the way the Linux kernel is developed. -

- The original Samba man pages were written by Karl Auer. The man page sources were converted to YODL format (another - excellent piece of Open Source software, available at - ftp://ftp.icce.rug.nl/pub/unix/) and updated for the Samba 2.0 release by Jeremy Allison. The conversion - to DocBook for Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0 was done by - Alexander Bokovoy. -

diff --git a/docs/htmldocs/manpages/smbcacls.1.html b/docs/htmldocs/manpages/smbcacls.1.html deleted file mode 100644 index 42f3f60156..0000000000 --- a/docs/htmldocs/manpages/smbcacls.1.html +++ /dev/null @@ -1,125 +0,0 @@ -smbcacls

Name

smbcacls — Set or get ACLs on an NT file or directory names

Synopsis

smbcacls {//server/share} {/filename} [-D|--delete acls] [-M|--modify acls] [-a|--add acls] [-S|--set acls] [-C|--chown name] [-G|--chgrp name] [-I allow|romove|copy] [--numeric] [-t] [-U username] [-h] [-d]

DESCRIPTION

This tool is part of the samba(7) suite.

The smbcacls program manipulates NT Access Control - Lists (ACLs) on SMB file shares.

OPTIONS

The following options are available to the smbcacls program. - The format of ACLs is described in the section ACL FORMAT

-a|--add acls

Add the ACLs specified to the ACL list. Existing - access control entries are unchanged.

-M|--modify acls

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 -

-D|--delete acls

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.

-S|--set acls

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.

-C|--chown name

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

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

-I|--inherit allow|remove|copy

Set or unset the windows "Allow inheritable - permissions" check box using the -I - option. To set the check box pass allow. To unset the check - box pass either remove or copy. Remove will remove all - inherited acls. Copy will copy all the inherited acls. -

--numeric

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.

-t|--test-args

- Don't actually do anything, only validate the correctness of - the arguments. -

-h|--help

Print a summary of command line options. -

-d|--debuglevel=level

level is an integer -from 0 to 10. The default value if this parameter is -not specified is 0.

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.

-V|--version

Prints the program version number. -

-s|--configfile <configuration file>

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.

-l|--log-basename=logdirectory

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

-N|--no-pass

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.

If a password is specified on the command line and this -option is also defined the password on the command line will -be silently ingnored and no password will be used.

-k|--kerberos

-Try to authenticate with kerberos. Only useful in -an Active Directory environment. -

-C|--use-ccache

-Try to use the credentials cached by winbind. -

-A|--authentication-file=filename

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.

-U|--user=username[%password]

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.

ACL FORMAT

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 ALLOWED or DENIED to allow/deny 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

EXIT STATUS

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.

VERSION

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

AUTHOR

The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed.

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.

diff --git a/docs/htmldocs/manpages/smbclient.1.html b/docs/htmldocs/manpages/smbclient.1.html deleted file mode 100644 index 5b5ae85712..0000000000 --- a/docs/htmldocs/manpages/smbclient.1.html +++ /dev/null @@ -1,509 +0,0 @@ -smbclient

Name

smbclient — ftp-like client to access SMB/CIFS resources - on servers

Synopsis

smbclient [-b <buffer size>] [-d debuglevel] [-e] [-L <netbios name>] [-U username] [-I destinationIP] [-M <netbios name>] [-m maxprotocol] [-A authfile] [-N] [-C] [-g] [-i scope] [-O <socket options>] [-p port] [-R <name resolve order>] [-s <smb config file>] [-k] [-P] [-c <command>]

smbclient {servicename} [password] [-b <buffer size>] [-d debuglevel] [-e] [-D Directory] [-U username] [-W workgroup] [-M <netbios name>] [-m maxprotocol] [-A authfile] [-N] [-C] [-g] [-l log-basename] [-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]

DESCRIPTION

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.

OPTIONS

servicename

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.

password

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

-R|--name-resolve <name resolve order>

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.

-M|--message NetBIOS name

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 pipe the message through smbclient. - For example: smbclient -M FRED < mymessage.txt 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.

-p|--port port

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.

-g|--grepable

This parameter provides combined with - -L easy parseable output that allows processing - with utilities such as grep and cut. -

-m|--max-protocol protocol

This parameter sets the maximum protocol version announced by the client. -

-P|--machine-pass

- Make queries to the external server using the machine account of the local server. -

-h|--help

Print a summary of command line options. -

-I|--ip-address IP-address

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.

-E|--stderr

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.

-L|--list

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.

-b|--send-buffer buffersize

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

-e|--encrypt

This command line parameter requires the remote - server support the UNIX extensions. Request that the connection be - encrypted. This is new for Samba 3.2 and will only work with Samba - 3.2 or above servers. Negotiates SMB encryption using GSSAPI. Uses - the given credentials for the encryption negotiation (either kerberos - or NTLMv1/v2 if given domain/username/password triple. Fails the - connection if encryption cannot be negotiated. -

-d|--debuglevel=level

level is an integer -from 0 to 10. The default value if this parameter is -not specified is 1.

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.

-V|--version

Prints the program version number. -

-s|--configfile <configuration file>

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.

-l|--log-basename=logdirectory

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

-N|--no-pass

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.

If a password is specified on the command line and this -option is also defined the password on the command line will -be silently ingnored and no password will be used.

-k|--kerberos

-Try to authenticate with kerberos. Only useful in -an Active Directory environment. -

-C|--use-ccache

-Try to use the credentials cached by winbind. -

-A|--authentication-file=filename

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.

-U|--user=username[%password]

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.

-n|--netbiosname <primary NetBIOS name>

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.

-i|--scope <scope>

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.

-W|--workgroup=domain

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

-O|--socket-options socket options

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.

-T|--tar tar 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 - 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 files to be excluded from an extract or create. See - example below. Filename globbing works in one of two ways now. - See r below.

  • F - File containing a list of files and directories. - The F causes the name following the tarfile to - create to be read as a filename that contains a list of files and directories 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. -

  • 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/myshare "" -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 the files listed in the file tarlist.

smbclient //mypc/myshare "" -N -TcF - backup.tar tarlist

Create a tar file of all the files and directories in - the share.

smbclient //mypc/myshare "" -N -Tc backup.tar * -

-D|--directory initial directory

Change to initial directory before starting. Probably - only of any use with the tar -T option.

-c|--command command string

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

OPERATIONS

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.

? [command]

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.

! [shell command]

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

allinfo file

The client will request that the server return - all known information about a file or directory (including streams). -

altname file

The client will request that the server return - the "alternate" name (the 8.3 name) for a file or directory. -

archive <number>

Sets the archive level when operating on files. - 0 means ignore the archive bit, 1 means only operate on files with this bit set, - 2 means only operate on files with this bit set and reset it after operation, - 3 means operate on all files and reset it after operation. The default is 0. -

blocksize <number>

Sets the blocksize parameter for a tar operation. The default is 20. - Causes tar file to be written out in blocksize*TBLOCK (normally 512 byte) units. -

cancel jobid0 [jobid1] ... [jobidN]

The client will request that the server cancel - the printjobs identified by the given numeric print job ids. -

case_sensitive

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

cd <directory name>

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.

chmod file mode in octal

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

chown file uid gid

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

close <fileid>

Closes a file explicitly opened by the open command. Used for - internal Samba testing purposes. -

del <mask>

The client will request that the server attempt - to delete all files matching mask from the current working - directory on the server.

dir <mask>

A list of the files matching mask in the current - working directory on the server will be retrieved from the server - and displayed.

du <filename>

Does a directory listing and then prints out the current disk usage and free space on a share. -

echo <number> <data>

Does an SMBecho request to ping the server. Used for internal Samba testing purposes. -

exit

Terminate the connection with the server and exit - from the program.

get <remote file name> [local file name]

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.

getfacl <filename>

Requires the server support the UNIX extensions. Requests and prints - the POSIX ACL on a file. -

hardlink <src> <dest>

Creates a hardlink on the server using Windows CIFS semantics. -

help [command]

See the ? command above.

history

Displays the command history.

iosize <bytes>

When sending or receiving files, smbclient uses an - internal memory buffer by default of size 64512 bytes. This command - allows this size to be set to any range between 16384 (0x4000) bytes - and 16776960 (0xFFFF00) bytes. Larger sizes may mean more efficient - data transfer as smbclient will try and use the most efficient - read and write calls for the connected server. -

lcd [directory name]

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

link target linkname

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

listconnect

Show the current connections held for DFS purposes. -

lock <filenum> <r|w> <hex-start> <hex-len>

This command depends on the server supporting the CIFS - UNIX extensions and will fail if the server does not. Tries to set a POSIX - fcntl lock of the given type on the given range. Used for internal Samba testing purposes. -

logon <username> <password>

Establishes a new vuid for this session by logging on again. - Replaces the current vuid. Prints out the new vuid. Used for internal Samba testing purposes. -

lowercase

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.

ls <mask>

See the dir command above.

mask <mask>

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.

md <directory name>

See the mkdir command.

mget <mask>

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.

mkdir <directory name>

Create a new directory on the server (user access - privileges permitting) with the specified name.

more <file name>

Fetch a remote file and view it with the contents - of your PAGER environment variable. -

mput <mask>

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.

posix

Query the remote server to see if it supports the CIFS UNIX - extensions and prints out the list of capabilities supported. If so, turn - on POSIX pathname processing and large file read/writes (if available),. -

posix_encrypt <domain> <username> <password>

This command depends on the server supporting the CIFS - UNIX extensions and will fail if the server does not. Attempt to negotiate - SMB encryption on this connection. If smbclient connected with kerberos - credentials (-k) the arguments to this command are ignored and the kerberos - credentials are used to negotiate GSSAPI signing and sealing instead. See - also the -e option to smbclient to force encryption on initial connection. - This command is new with Samba 3.2. -

posix_open <filename> <octal mode>

This command depends on the server supporting the CIFS - UNIX extensions and will fail if the server does not. Opens a remote file - using the CIFS UNIX extensions and prints a fileid. Used for internal Samba - testing purposes. -

posix_mkdir <directoryname> <octal mode>

This command depends on the server supporting the CIFS - UNIX extensions and will fail if the server does not. Creates a remote directory - using the CIFS UNIX extensions with the given mode. -

posix_rmdir <directoryname>

This command depends on the server supporting the CIFS - UNIX extensions and will fail if the server does not. Deletes a remote directory - using the CIFS UNIX extensions. -

posix_unlink <filename>

This command depends on the server supporting the CIFS - UNIX extensions and will fail if the server does not. Deletes a remote file - using the CIFS UNIX extensions. -

print <file name>

Print the specified file from the local machine - through a printable service on the server.

prompt

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

put <local file name> [remote file name]

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

queue

Displays the print queue, showing the job id, - name, size and current status.

quit

See the exit command.

readlink symlinkname

This command depends on the server supporting the CIFS - UNIX extensions and will fail if the server does not. Print - the value of the symlink "symlinkname". -

rd <directory name>

See the rmdir command.

recurse

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.

rename <old filename> <new filename>

Rename files in the current working directory on the - server from old filename to - new filename.

rm <mask>

Remove all files matching mask from the current - working directory on the server.

rmdir <directory name>

Remove the specified directory (user access - privileges permitting) from the server.

setmode <filename> <perm=[+|\-]rsha>

A version of the DOS attrib command to set - file permissions. For example:

setmode myfile +r

would make myfile read only.

showconnect

Show the currently active connection held for DFS purposes. -

stat file

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

symlink target linkname

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

tar <c|x>[IXbgNa]

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

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.

tarmode <full|inc|reset|noreset>

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

unlock <filenum> <hex-start> <hex-len>

This command depends on the server supporting the CIFS - UNIX extensions and will fail if the server does not. Tries to unlock a POSIX - fcntl lock on the given range. Used for internal Samba testing purposes. -

volume

Prints the current volume name of the share. -

vuid <number>

Changes the currently used vuid in the protocol to - the given arbitrary number. Without an argument prints out the current - vuid being used. Used for internal Samba testing purposes. -

NOTES

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.

ENVIRONMENT VARIABLES

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

INSTALLATION

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.

DIAGNOSTICS

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.

VERSION

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

AUTHOR

The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed.

The original Samba man pages were written by Karl Auer. - The man page sources were converted to YODL format (another - excellent piece of Open Source software, available at - ftp://ftp.icce.rug.nl/pub/unix/) and updated for the Samba 2.0 - release by Jeremy Allison. The conversion to DocBook for - Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0 - was done by Alexander Bokovoy.

diff --git a/docs/htmldocs/manpages/smbcontrol.1.html b/docs/htmldocs/manpages/smbcontrol.1.html deleted file mode 100644 index 4a13cf0be2..0000000000 --- a/docs/htmldocs/manpages/smbcontrol.1.html +++ /dev/null @@ -1,83 +0,0 @@ -smbcontrol

Name

smbcontrol — send messages to smbd, nmbd or winbindd processes

Synopsis

smbcontrol [-i] [-s]

smbcontrol [destination] [message-type] [parameter]

DESCRIPTION

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.

OPTIONS

-h|--help

Print a summary of command line options. -

-s|--configfile <configuration file>

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.

-i

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.

destination

One of nmbd, smbd or a process ID.

The all destination causes the - message to "broadcast" to all running daemons including nmbd and - winbind. This is a change for Samba 3.3, prior to this the - parameter smbd used to do this.

The smbd destination causes the - message to be sent to the smbd daemon specified in the - smbd.pid file.

The nmbd destination causes the - message to be sent to the nmbd daemon specified in the - nmbd.pid file.

The winbindd destination causes the - message to be sent to the winbind daemon specified in the - winbindd.pid file.

If a single process ID is given, the message is sent - to only that process.

message-type

Type of message to send. See - the section MESSAGE-TYPES for details. -

parameters

any parameters required for the message-type

MESSAGE-TYPES

Available message types are:

close-share

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.

debug

Set debug level to the value specified by the - parameter. This can be sent to any of the destinations. If this - message is sent to either the smbd or winbindd daemons, the parent - process will rebroadcast the message to all child processes changing - the debug level in each one.

force-election

This message causes the nmbd daemon to - force a new browse master election.

ping

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

profile

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.

debuglevel

- Request debuglevel of a certain daemon and write it to stdout. This - can be sent to any of the destinations.

profilelevel

- Request profilelevel of a certain daemon and write it to stdout. - This can be sent to any smbd or nmbd destinations.

printnotify

- Order smbd to send a printer notify message to any Windows NT clients - connected to a printer. This message-type takes the following arguments: -

queuepause printername

Send a queue pause change notify - message to the printer specified.

queueresume printername

Send a queue resume change notify - message for the printer specified.

jobpause printername unixjobid

Send a job pause change notify - message for the printer and unix jobid - specified.

jobresume printername unixjobid

Send a job resume change notify - message for the printer and unix jobid - specified.

jobdelete printername unixjobid

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 occurred. It doesn't actually cause the - event to happen. -

This message can only be sent to smbd.

samsync

Order smbd to synchronise sam database from PDC (being BDC). Can only be sent to smbd.

Note

Not working at the moment

samrepl

Send sam replication message, with specified serial. Can only be sent to smbd. Should not be used manually.

dmalloc-mark

Set a mark for dmalloc. Can be sent to both smbd and nmbd. Only available if samba is built with dmalloc support.

dmalloc-log-changed

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

shutdown

Shut down specified daemon. Can be sent to both smbd and nmbd.

pool-usage

Print a human-readable description of all - talloc(pool) memory usage by the specified daemon/process. Available - for both smbd and nmbd.

drvupgrade

Force clients of printers using specified driver - to update their local version of the driver. Can only be - sent to smbd.

reload-config

Force daemon to reload smb.conf configuration file. Can be sent - to smbd, nmbd, or winbindd. -

idmap

Notify about changes of id mapping. Can be sent - to smbd or (not implemented yet) winbindd. -

VERSION

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

SEE ALSO

nmbd(8) and smbd(8).

AUTHOR

The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed.

The original Samba man pages were written by Karl Auer. - The man page sources were converted to YODL format (another - excellent piece of Open Source software, available at - ftp://ftp.icce.rug.nl/pub/unix/) and updated for the Samba 2.0 - release by Jeremy Allison. The conversion to DocBook for - Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for - Samba 3.0 was done by Alexander Bokovoy.

diff --git a/docs/htmldocs/manpages/smbcquotas.1.html b/docs/htmldocs/manpages/smbcquotas.1.html deleted file mode 100644 index 88dc743a42..0000000000 --- a/docs/htmldocs/manpages/smbcquotas.1.html +++ /dev/null @@ -1,88 +0,0 @@ -smbcquotas

Name

smbcquotas — Set or get QUOTAs of NTFS 5 shares

Synopsis

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]

DESCRIPTION

This tool is part of the samba(7) suite.

The smbcquotas program manipulates NT Quotas on SMB file shares.

OPTIONS

The following options are available to the smbcquotas program.

-u user

Specifies the user of whom the quotas are get or set. - By default the current user's username will be used.

-L

Lists all quota records of the share.

-F

Show the share quota status and default limits.

-S QUOTA_SET_COMMAND

This command sets/modifies quotas for a user or on the share, - depending on the QUOTA_SET_COMMAND parameter which is described later.

-n

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.

-t

- Don't actually do anything, only validate the correctness of the arguments. -

-v

- Be verbose. -

-h|--help

Print a summary of command line options. -

-d|--debuglevel=level

level is an integer -from 0 to 10. The default value if this parameter is -not specified is 0.

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.

-V|--version

Prints the program version number. -

-s|--configfile <configuration file>

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.

-l|--log-basename=logdirectory

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

-N|--no-pass

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.

If a password is specified on the command line and this -option is also defined the password on the command line will -be silently ingnored and no password will be used.

-k|--kerberos

-Try to authenticate with kerberos. Only useful in -an Active Directory environment. -

-C|--use-ccache

-Try to use the credentials cached by winbind. -

-A|--authentication-file=filename

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.

-U|--user=username[%password]

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.

QUOTA_SET_COMMAND

The format of an the QUOTA_SET_COMMAND is an operation - name followed by a set of parameters specific to that operation. -

To set user quotas for the user specified by -u or for the - current username:

- UQLIM:<username>:<softlimit>/<hardlimit> -

To set the default quotas for a share: -

- FSQLIM:<softlimit>/<hardlimit> -

- To change the share quota settings: -

- FSQFLAGS:QUOTA_ENABLED/DENY_DISK/LOG_SOFTLIMIT/LOG_HARD_LIMIT -

All limits are specified as a number of bytes.

EXIT STATUS

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.

VERSION

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

AUTHOR

The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed.

smbcquotas was written by Stefan Metzmacher.

diff --git a/docs/htmldocs/manpages/smbd.8.html b/docs/htmldocs/manpages/smbd.8.html deleted file mode 100644 index 15c7a1572f..0000000000 --- a/docs/htmldocs/manpages/smbd.8.html +++ /dev/null @@ -1,163 +0,0 @@ -smbd

Name

smbd — server to provide SMB/CIFS services to clients

Synopsis

smbd [-D] [-F] [-S] [-i] [-h] [-V] [-b] [-d <debug level>] [-l <log directory>] [-p <port number(s)>] [-P <profiling level>] [-O <socket option>] [-s <configuration file>]

DESCRIPTION

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.

OPTIONS

-D

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

-F

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

-S

If specified, this parameter causes - smbd to log to standard output rather - than a file.

-i

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. smbd also logs to standard - output, as if the -S parameter had been - given. -

-d|--debuglevel=level

level is an integer -from 0 to 10. The default value if this parameter is -not specified is 0.

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.

-V|--version

Prints the program version number. -

-s|--configfile <configuration file>

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.

-l|--log-basename=logdirectory

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

-h|--help

Print a summary of command line options. -

-b

Prints information about how - Samba was built.

-p|--port<port number(s)>

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

-P|--profiling-level<profiling level>

profiling level is a - number specifying the level of profiling data to be collected. - 0 turns off profiling, 1 turns on counter profiling only, - 2 turns on complete profiling, and 3 resets all profiling data. -

FILES

/etc/inetd.conf

If the server is to be run by the - inetd meta-daemon, this file - must contain suitable startup information for the - meta-daemon. -

/etc/rc

or 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/services

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

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

LIMITATIONS

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.

ENVIRONMENT VARIABLES

PRINTER

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

PAM INTERACTION

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) parameter. 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 valid, not disabled and is permitted to - login at this time. This also applies to encrypted logins. -

  • Session Management: When not using share - level security, users must pass PAM's session checks before access - is granted. Note however, that this is bypassed in share level security. - Note also that some older pam configuration files may need a line - added for session support. -

VERSION

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

DIAGNOSTICS

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.

TDB FILES

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

account_policy.tdb*

NT account policy settings such as pw expiration, etc...

brlock.tdb

byte range locks

browse.dat

browse lists

connections.tdb

share connections (used to enforce max connections, etc...)

gencache.tdb

generic caching db

group_mapping.tdb*

group mapping information

locking.tdb

share modes & oplocks

login_cache.tdb*

bad pw attempts

messages.tdb

Samba messaging system

netsamlogon_cache.tdb*

cache of user net_info_3 struct from net_samlogon() request (as a domain member)

ntdrivers.tdb*

installed printer drivers

ntforms.tdb*

installed printer forms

ntprinters.tdb*

installed printer information

printing/

directory containing tdb per print queue of cached lpq output

registry.tdb

Windows registry skeleton (connect via regedit.exe)

sessionid.tdb

session information (e.g. support for 'utmp = yes')

share_info.tdb*

share acls

winbindd_cache.tdb

winbindd's cache of user lists, etc...

winbindd_idmap.tdb*

winbindd's local idmap db

wins.dat*

wins database when 'wins support = yes'

SIGNALS

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.

SEE ALSO

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

AUTHOR

The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed.

The original Samba man pages were written by Karl Auer. - The man page sources were converted to YODL format (another - excellent piece of Open Source software, available at - ftp://ftp.icce.rug.nl/pub/unix/) and updated for the Samba 2.0 - release by Jeremy Allison. The conversion to DocBook for - Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for - Samba 3.0 was done by Alexander Bokovoy.

diff --git a/docs/htmldocs/manpages/smbget.1.html b/docs/htmldocs/manpages/smbget.1.html deleted file mode 100644 index 70f8a0af73..0000000000 --- a/docs/htmldocs/manpages/smbget.1.html +++ /dev/null @@ -1,26 +0,0 @@ -smbget

Name

smbget — wget-like utility for download files over SMB

Synopsis

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] [-O, --stdout] [-?, --help] [--usage] {smb://host/share/path/to/file} [smb://url2/] [...]

DESCRIPTION

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

OPTIONS

-a, --guest

Work as user guest

-r, --resume

Automatically resume aborted files

-R, --recursive

Recursively download files

-u, --username=STRING

Username to use

-p, --password=STRING

Password to use

-w, --workgroup=STRING

Workgroup to use (optional)

-n, --nonprompt

Don't ask anything (non-interactive)

-d, --debuglevel=INT

Debuglevel to use

-D, --dots

Show dots as progress indication

-P, --keep-permissions

Set same permissions on local file as are set on remote file.

-o, --outputfile

Write the file that is being downloaded to the specified file. Can not be used together with -R.

-O, --stdout

Write the file that is being downloaded to standard output.

-f, --rcfile

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 overridden by the contents of the rcfile.

-q, --quiet

Be quiet

-v, --verbose

Be verbose

-b, --blocksize

Number of bytes to download in a block. Defaults to 64000.

-?, --help

Show help message

--usage

Display brief usage message

SMB URLS

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, if name is a workgroup, all the servers in this workgroup, or if name is a server, all the shares on this server.
-

EXAMPLES

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

BUGS

Permission denied is returned in some cases where the cause of the error is unknown -(such as an illegally formatted smb:// url or trying to get a directory without -R -turned on).

VERSION

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

AUTHOR

The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed.

The smbget manpage was written by Jelmer Vernooij.

diff --git a/docs/htmldocs/manpages/smbgetrc.5.html b/docs/htmldocs/manpages/smbgetrc.5.html deleted file mode 100644 index 1e4bdf6d50..0000000000 --- a/docs/htmldocs/manpages/smbgetrc.5.html +++ /dev/null @@ -1,17 +0,0 @@ -smbgetrc

Name

smbgetrc — configuration file for smbget

Synopsis

smbgetrc

DESCRIPTION

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

OPTIONS

- The following keys can be set: -

resume on|off

- Whether aborted downloads should be automatically resumed. -

recursive on|off

Whether directories should be downloaded recursively

username name

Username to use when logging in to the remote server. Use an empty string for anonymous access. -

password pass

Password to use when logging in.

workgroup wg

Workgroup to use when logging in

nonprompt on|off

Turns off asking for username and password. Useful for scripts.

debuglevel int

(Samba) debuglevel to run at. Useful for tracking down protocol level problems.

dots on|off

Whether a single dot should be printed for each block that has been downloaded, instead of the default progress indicator.

blocksize int

Number of bytes to put in a block.

VERSION

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

SEE ALSO

smbget(1) and Samba(7). -

AUTHOR

The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed.

This manual page was written by Jelmer Vernooij

diff --git a/docs/htmldocs/manpages/smbpasswd.5.html b/docs/htmldocs/manpages/smbpasswd.5.html deleted file mode 100644 index 354c03016f..0000000000 --- a/docs/htmldocs/manpages/smbpasswd.5.html +++ /dev/null @@ -1,91 +0,0 @@ -smbpasswd

Name

smbpasswd — The Samba encrypted password file

Synopsis

smbpasswd

DESCRIPTION

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.

FILE FORMAT

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:

name

This is the user name. It must be a name that - already exists in the standard UNIX passwd file.

uid

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

Lanman Password Hash

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.

NT Password Hash

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.

Account Flags

This section contains flags that describe - the attributes of the users account. 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.

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

  • X - This means the password - does not expire.

  • 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. For further - information regarding the flags that are supported please refer to the - man page for the pdbedit command.

Last Change Time

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.

VERSION

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

SEE ALSO

smbpasswd(8), Samba(7), and - the Internet RFC1321 for details on the MD4 algorithm. -

AUTHOR

The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed.

The original Samba man pages were written by Karl Auer. - The man page sources were converted to YODL format (another - excellent piece of Open Source software, available at - ftp://ftp.icce.rug.nl/pub/unix/) and updated for the Samba 2.0 - release by Jeremy Allison. The conversion to DocBook for - Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 - for Samba 3.0 was done by Alexander Bokovoy.

diff --git a/docs/htmldocs/manpages/smbpasswd.8.html b/docs/htmldocs/manpages/smbpasswd.8.html deleted file mode 100644 index 354d5acf1c..0000000000 --- a/docs/htmldocs/manpages/smbpasswd.8.html +++ /dev/null @@ -1,171 +0,0 @@ -smbpasswd

Name

smbpasswd — change a user's SMB password

Synopsis

smbpasswd [-a] [-c <config file>] [-x] [-d] [-e] [-D debuglevel] [-n] [-r <remote machine>] [-R <name resolve order>] [-m] [-U username[%password]] [-h] [-s] [-w pass] [-W] [-i] [-L] [username]

DESCRIPTION

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.

OPTIONS

-a

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

-c

- This option can be used to specify the path and file name of the smb.conf configuration file when it - is important to use other than the default file and / or location. -

-x

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

-d

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.

-e

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

-D debuglevel

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

-n

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.

-r remote machine name

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.

-R name resolve order

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.

-m

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

-U username

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.

-h

This option prints the help string for - smbpasswd, selecting the correct one for running as root - or as an ordinary user.

-s

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

-w password

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

-W

NOTE: This option is same as "-w" - except that the password should be entered using stdin. -

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

-i

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

-L

Run in local mode.

username

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

NOTES

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.

VERSION

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

SEE ALSO

smbpasswd(5), Samba(7).

AUTHOR

The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed.

The original Samba man pages were written by Karl Auer. - The man page sources were converted to YODL format (another - excellent piece of Open Source software, available at - ftp://ftp.icce.rug.nl/pub/unix/) and updated for the Samba 2.0 - release by Jeremy Allison. The conversion to DocBook for - Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 - for Samba 3.0 was done by Alexander Bokovoy.

diff --git a/docs/htmldocs/manpages/smbspool.8.html b/docs/htmldocs/manpages/smbspool.8.html deleted file mode 100644 index 1994fec2aa..0000000000 --- a/docs/htmldocs/manpages/smbspool.8.html +++ /dev/null @@ -1,36 +0,0 @@ -smbspool

Name

smbspool — send a print file to an SMB printer

Synopsis

smbspool {job} {user} {title} {copies} {options} [filename]

DESCRIPTION

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.

OPTIONS

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

VERSION

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

SEE ALSO

smbd(8) and samba(7).

AUTHOR

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.

diff --git a/docs/htmldocs/manpages/smbstatus.1.html b/docs/htmldocs/manpages/smbstatus.1.html deleted file mode 100644 index b0a38bc0e2..0000000000 --- a/docs/htmldocs/manpages/smbstatus.1.html +++ /dev/null @@ -1,41 +0,0 @@ -smbstatus

Name

smbstatus — report on current Samba connections

Synopsis

smbstatus [-P] [-b] [-d <debug level>] [-v] [-L] [-B] [-p] [-S] [-s <configuration file>] [-u <username>]

DESCRIPTION

This tool is part of the samba(7) suite.

smbstatus is a very simple program to - list the current Samba connections.

OPTIONS

-P|--profile

If samba has been compiled with the - profiling option, print only the contents of the profiling - shared memory area.

-b|--brief

gives brief output.

-d|--debuglevel=level

level is an integer -from 0 to 10. The default value if this parameter is -not specified is 0.

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.

-V|--version

Prints the program version number. -

-s|--configfile <configuration file>

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.

-l|--log-basename=logdirectory

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

-v|--verbose

gives verbose output.

-L|--locks

causes smbstatus to only list locks.

-B|--byterange

causes smbstatus to include byte range locks. -

-p|--processes

print a list of smbd(8) processes and exit. - Useful for scripting.

-S|--shares

causes smbstatus to only list shares.

-h|--help

Print a summary of command line options. -

-u|--user=<username>

selects information relevant to username only.

VERSION

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

SEE ALSO

smbd(8) and smb.conf(5).

AUTHOR

The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed.

The original Samba man pages were written by Karl Auer. - The man page sources were converted to YODL format (another - excellent piece of Open Source software, available at - ftp://ftp.icce.rug.nl/pub/unix/) and updated for the Samba 2.0 - release by Jeremy Allison. The conversion to DocBook for - Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 - for Samba 3.0 was done by Alexander Bokovoy.

diff --git a/docs/htmldocs/manpages/smbta-util.8.html b/docs/htmldocs/manpages/smbta-util.8.html deleted file mode 100644 index 85a36c4754..0000000000 --- a/docs/htmldocs/manpages/smbta-util.8.html +++ /dev/null @@ -1,25 +0,0 @@ -smbta-util

Name

smbta-util — control encryption in VFS smb_traffic_analyzer

Synopsis

smbta-util

smbta-util [ - OPTIONS - ...]

DESCRIPTION

This tool is part of the - samba(7) suite.

smbta-util is a tool to ease the - configuration of the vfs_smb_traffic_analyzer module regarding - data encryption.

The user can generate a key, install a key (activating - encryption), or uninstall a key (deactivating encryption). - Any operation that installs a key will create a File containing - the key. This file can be used by smbta-tool on other machines - to install the same key from the file.

OPTIONS

-h

Show a short help text on the command line. -

-f - KEYFILE

Open an existing keyfile, read the key from - the file, and install the key, activating encryption. -

-g - KEYFILE

Generate a new random key, install the key, - activate encryption, and store the key into the file KEYFILE. -

-u

Uninstall the key, deactivating encryption. -

-s

Check if a key is installed. -

-c - KEYFILE

Create a KEYFILE from an installed key. -

VERSION

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

AUTHOR

The original version of smbta-util was created by Holger Hetterich. -

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.

diff --git a/docs/htmldocs/manpages/smbtar.1.html b/docs/htmldocs/manpages/smbtar.1.html deleted file mode 100644 index ff0c8259c8..0000000000 --- a/docs/htmldocs/manpages/smbtar.1.html +++ /dev/null @@ -1,39 +0,0 @@ -smbtar

Name

smbtar — shell script for backing up SMB/CIFS shares - directly to UNIX tape drives

Synopsis

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}

DESCRIPTION

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.

OPTIONS

-s server

The SMB/CIFS server that the share resides - upon.

-x service

The share name on the server to connect to. - The default is "backup".

-X

Exclude mode. Exclude filenames... from tar - create or restore.

-d directory

Change to initial directory - before restoring / backing up files.

-v

Verbose mode.

-p password

The password to use to access a share. - Default: none

-u user

The user id to connect as. Default: - UNIX login name.

-a

Reset DOS archive bit mode to - indicate file has been archived.

-t tape

Tape device. May be regular file or tape - device. Default: $TAPE environmental - variable; if not set, a file called tar.out - .

-b blocksize

Blocking factor. Defaults to 20. See - tar(1) for a fuller explanation.

-N filename

Backup only files newer than filename. Could - be used (for example) on a log file to implement incremental - backups.

-i

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.

-r

Restore. Files are restored to the share - from the tar file.

-l log level

Log (debug) level. Corresponds to the - -d flag of smbclient(1).

ENVIRONMENT VARIABLES

The $TAPE variable specifies the - default tape device to write to. May be overridden - with the -t option.

BUGS

The smbtar script has different - options from ordinary tar and from smbclient's tar command.

CAVEATS

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.

DIAGNOSTICS

See the DIAGNOSTICS section for the smbclient(1) command.

VERSION

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

SEE ALSO

smbd(8), smbclient(1), smb.conf(5).

AUTHOR

The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed.

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.

diff --git a/docs/htmldocs/manpages/smbtree.1.html b/docs/htmldocs/manpages/smbtree.1.html deleted file mode 100644 index ea9b584dc6..0000000000 --- a/docs/htmldocs/manpages/smbtree.1.html +++ /dev/null @@ -1,76 +0,0 @@ -smbtree

Name

smbtree — A text based smb network browser -

Synopsis

smbtree [-b] [-D] [-S]

DESCRIPTION

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

OPTIONS

-b|--broadcast

Query network nodes by sending requests - as broadcasts instead of querying the local master browser. -

-D|--domains

Only print a list of all - the domains known on broadcast or by the - master browser

-S|--servers

Only print a list of - all the domains and servers responding on broadcast or - known by the master browser. -

-d|--debuglevel=level

level is an integer -from 0 to 10. The default value if this parameter is -not specified is 0.

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.

-V|--version

Prints the program version number. -

-s|--configfile <configuration file>

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.

-l|--log-basename=logdirectory

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

-N|--no-pass

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.

If a password is specified on the command line and this -option is also defined the password on the command line will -be silently ingnored and no password will be used.

-k|--kerberos

-Try to authenticate with kerberos. Only useful in -an Active Directory environment. -

-C|--use-ccache

-Try to use the credentials cached by winbind. -

-A|--authentication-file=filename

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.

-U|--user=username[%password]

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.

-h|--help

Print a summary of command line options. -

VERSION

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

AUTHOR

The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed.

The smbtree man page was written by Jelmer Vernooij.

diff --git a/docs/htmldocs/manpages/swat.8.html b/docs/htmldocs/manpages/swat.8.html deleted file mode 100644 index dd43d5f9e3..0000000000 --- a/docs/htmldocs/manpages/swat.8.html +++ /dev/null @@ -1,88 +0,0 @@ -swat

Name

swat — Samba Web Administration Tool

Synopsis

swat [-s <smb config file>] [-a] [-P]

DESCRIPTION

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

OPTIONS

-s smb configuration file

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

-a

This option disables authentication and - places 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.

-P

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.

-d|--debuglevel=level

level is an integer -from 0 to 10. The default value if this parameter is -not specified is 0.

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.

-V|--version

Prints the program version number. -

-s|--configfile <configuration file>

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.

-l|--log-basename=logdirectory

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

-h|--help

Print a summary of command line options. -

INSTALLATION

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

Inetd Installation

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.

LAUNCHING

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.

FILES

/etc/inetd.conf

This file must contain suitable startup - information for the meta-daemon.

/etc/services

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

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

WARNINGS

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!

VERSION

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

SEE ALSO

inetd(5), smbd(8), smb.conf(5)

AUTHOR

The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed.

The original Samba man pages were written by Karl Auer. - The man page sources were converted to YODL format (another - excellent piece of Open Source software, available at - ftp://ftp.icce.rug.nl/pub/unix/) and updated for the Samba 2.0 - release by Jeremy Allison. The conversion to DocBook for - Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for - Samba 3.0 was done by Alexander Bokovoy.

diff --git a/docs/htmldocs/manpages/tdbbackup.8.html b/docs/htmldocs/manpages/tdbbackup.8.html deleted file mode 100644 index fce7a15982..0000000000 --- a/docs/htmldocs/manpages/tdbbackup.8.html +++ /dev/null @@ -1,36 +0,0 @@ -tdbbackup

Name

tdbbackup — tool for backing up and for validating the integrity of samba .tdb files

Synopsis

tdbbackup [-s suffix] [-v] [-h]

DESCRIPTION

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

OPTIONS

-h

- Get help information. -

-s suffix

- The -s option allows the administrator 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. -

-v

- The -v will check the database for damages (corrupt data) - which if detected causes the backup to be restored. -

COMMANDS

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

VERSION

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

AUTHOR

- The original Samba software and related utilities were created by Andrew Tridgell. - Samba is now developed by the Samba Team as an Open Source project similar to the way - the Linux kernel is developed. -

The tdbbackup man page was written by John H Terpstra.

diff --git a/docs/htmldocs/manpages/tdbdump.8.html b/docs/htmldocs/manpages/tdbdump.8.html deleted file mode 100644 index 2c5c838267..0000000000 --- a/docs/htmldocs/manpages/tdbdump.8.html +++ /dev/null @@ -1,10 +0,0 @@ -tdbdump

Name

tdbdump — tool for printing the contents of a TDB file

Synopsis

tdbdump {filename}

DESCRIPTION

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

VERSION

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

AUTHOR

- The original Samba software and related utilities were created by Andrew Tridgell. - Samba is now developed by the Samba Team as an Open Source project similar to the way - the Linux kernel is developed. -

The tdbdump man page was written by Jelmer Vernooij.

diff --git a/docs/htmldocs/manpages/tdbtool.8.html b/docs/htmldocs/manpages/tdbtool.8.html deleted file mode 100644 index f9db389bbf..0000000000 --- a/docs/htmldocs/manpages/tdbtool.8.html +++ /dev/null @@ -1,68 +0,0 @@ -tdbtool

Name

tdbtool — manipulate the contents TDB files

Synopsis

tdbtool

tdbtool - TDBFILE - [ - COMMANDS - ...]

DESCRIPTION

This tool is part of the - samba(1) suite.

tdbtool a tool for displaying and - altering the contents of Samba TDB (Trivial DataBase) files. Each - of the commands listed below can be entered interactively or - provided on the command line.

COMMANDS

create - TDBFILE

Create a new database named - TDBFILE. -

open - TDBFILE

Open an existing database named - TDBFILE. -

erase

Erase the current database. -

dump

Dump the current database as strings. -

cdump

Dump the current database as connection records. -

keys

Dump the current database keys as strings. -

hexkeys

Dump the current database keys as hex values. -

info

Print summary information about the - current database. -

insert - KEY - DATA -

Insert a record into the - current database. -

move - KEY - TDBFILE -

Move a record from the - current database into TDBFILE. -

store - KEY - DATA -

Store (replace) a record in the - current database. -

show - KEY -

Show a record by key. -

delete - KEY -

Delete a record by key. -

list -

Print the current database hash table and free list. -

free -

Print the current database and free list. -

! - COMMAND -

Execute the given system command. -

- first -

Print the first record in the current database. -

- next -

Print the next record in the current database. -

- check -

Check the integrity of the current database. -

- quit -

Exit tdbtool. -

CAVEATS

The contents of the Samba TDB files are private - to the implementation and should not be altered with - tdbtool. -

VERSION

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

AUTHOR

The original Samba software and related utilities were - created by Andrew Tridgell. Samba is now developed by the - Samba Team as an Open Source project similar to the way the - Linux kernel is developed.

diff --git a/docs/htmldocs/manpages/testparm.1.html b/docs/htmldocs/manpages/testparm.1.html deleted file mode 100644 index 699ab2df6c..0000000000 --- a/docs/htmldocs/manpages/testparm.1.html +++ /dev/null @@ -1,58 +0,0 @@ -testparm

Name

testparm — check an smb.conf configuration file for - internal correctness

Synopsis

testparm [-s] [-h] [-v] [-t <encoding>] {config filename} [hostname hostIP]

DESCRIPTION

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.

OPTIONS

-s

Without this option, testparm - will prompt for a carriage return after printing the service - names and before dumping the service definitions.

-h|--help

Print a summary of command line options. -

-V|--version

Prints the program version number. -

-v

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.

-t encoding

- Output data in specified encoding. -

--parameter-name parametername

- Dumps the named parameter. If no section-name is set the view - is limited by default to the global section. - - It is also possible to dump a parametrical option. Therefore - the option has to be separated by a colon from the - parametername. -

--section-name sectionname

- Dumps the named section. -

configfilename

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

hostname

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.

hostIP

This is the IP address of the host specified - in the previous parameter. This address must be supplied - if the hostname parameter is supplied.

FILES

smb.conf(5)

This is usually the name of the configuration - file used by smbd(8). -

DIAGNOSTICS

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.

VERSION

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

SEE ALSO

smb.conf(5), smbd(8)

AUTHOR

The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed.

The original Samba man pages were written by Karl Auer. - The man page sources were converted to YODL format (another - excellent piece of Open Source software, available at - ftp://ftp.icce.rug.nl/pub/unix/) and updated for the Samba 2.0 - release by Jeremy Allison. The conversion to DocBook for - Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 - for Samba 3.0 was done by Alexander Bokovoy.

diff --git a/docs/htmldocs/manpages/vfs_acl_tdb.8.html b/docs/htmldocs/manpages/vfs_acl_tdb.8.html deleted file mode 100644 index ba468876ff..0000000000 --- a/docs/htmldocs/manpages/vfs_acl_tdb.8.html +++ /dev/null @@ -1,21 +0,0 @@ -vfs_acl_tdb

Name

vfs_acl_tdb — Save NTFS-ACLs in a tdb file

Synopsis

vfs objects = acl_tdb

DESCRIPTION

This VFS module is part of the - samba(7) suite.

The vfs_acl_tdb VFS module stores - NTFS Access Control Lists (ACLs) in a tdb file. - This enables the full mapping of Windows ACLs on Samba - servers. -

- The ACL settings are stored in - $LOCKDIR/file_ntacls.tdb. -

This module is stackable.

OPTIONS

acl_tdb:ignore system acls = [yes|no]

- When set to yes, a best effort mapping - from/to the POSIX ACL layer will not be - done by this module. The default is no, - which means that Samba keeps setting and evaluating both the - system ACLs and the NT ACLs. This is better if you need your - system ACLs be set for local or NFS file access, too. If you only - access the data via Samba you might set this to yes to achieve - better NT ACL compatibility. -

AUTHOR

The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed.

diff --git a/docs/htmldocs/manpages/vfs_acl_xattr.8.html b/docs/htmldocs/manpages/vfs_acl_xattr.8.html deleted file mode 100644 index 778680b253..0000000000 --- a/docs/htmldocs/manpages/vfs_acl_xattr.8.html +++ /dev/null @@ -1,25 +0,0 @@ -vfs_acl_xattr

Name

vfs_acl_xattr — Save NTFS-ACLs in Extended Attributes (EAs)

Synopsis

vfs objects = acl_xattr

DESCRIPTION

This VFS module is part of the - samba(7) suite.

The vfs_acl_xattr VFS module stores - NTFS Access Control Lists (ACLs) in Extended Attributes (EAs). - This enables the full mapping of Windows ACLs on Samba - servers. -

The ACLs are stored in the Extended Attribute - security.NTACL of a file or directory. - This Attribute is not listed by - getfattr -d filename. - To show the current value, the name of the EA must be specified - (e.g. getfattr -n security.NTACL filename - ). -

This module is stackable.

OPTIONS

acl_xattr:ignore system acls = [yes|no]

- When set to yes, a best effort mapping - from/to the POSIX ACL layer will not be - done by this module. The default is no, - which means that Samba keeps setting and evaluating both the - system ACLs and the NT ACLs. This is better if you need your - system ACLs be set for local or NFS file access, too. If you only - access the data via Samba you might set this to yes to achieve - better NT ACL compatibility. -

AUTHOR

The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed.

diff --git a/docs/htmldocs/manpages/vfs_aio_fork.8.html b/docs/htmldocs/manpages/vfs_aio_fork.8.html deleted file mode 100644 index 21ebebe24e..0000000000 --- a/docs/htmldocs/manpages/vfs_aio_fork.8.html +++ /dev/null @@ -1,25 +0,0 @@ -vfs_aio_fork

Name

vfs_aio_fork — implement async I/O in Samba vfs

Synopsis

vfs objects = aio_fork

DESCRIPTION

This VFS module is part of the - samba(7) suite.

The aio_fork VFS module enables async - I/O for Samba on platforms where the system level Posix AIO - interface is insufficient. Posix AIO can suffer from severe - limitations. For example, on some Linux versions the - real-time signals that it uses are broken under heavy load. - Other systems only allow AIO when special kernel modules are - loaded or only allow a certain system-wide amount of async - requests being scheduled. Systems based on glibc (most Linux - systems) only allow a single outstanding request per file - descriptor.

To work around all these limitations, the aio_fork module - was written. It uses forked helper processes instead of the - internal Posix AIO interface to create asynchronousity for - read and write calls. It has no parameters, it will create - helper processes when async requests come in as needed. Idle - helper processes will be removed every 30 seconds. -

This module is stackable.

EXAMPLES

Straight forward use:

-        [cooldata]
-	path = /data/ice
-	vfs objects = aio_fork
-

VERSION

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

AUTHOR

The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed.

diff --git a/docs/htmldocs/manpages/vfs_aio_pthread.8.html b/docs/htmldocs/manpages/vfs_aio_pthread.8.html deleted file mode 100644 index 899ff9051d..0000000000 --- a/docs/htmldocs/manpages/vfs_aio_pthread.8.html +++ /dev/null @@ -1,42 +0,0 @@ -vfs_aio_pthread

Name

vfs_aio_pthread — implement async I/O in Samba vfs using a pthread pool

Synopsis

vfs objects = aio_pthread

DESCRIPTION

This VFS module is part of the - samba(7) suite.

The aio_pthread VFS module enables asynchronous - I/O for Samba on platforms which have the pthreads API available, - without using the Posix AIO interface. Posix AIO can suffer from severe - limitations. For example, on some Linux versions the - real-time signals that it uses are broken under heavy load. - Other systems only allow AIO when special kernel modules are - loaded or only allow a certain system-wide amount of async - requests being scheduled. Systems based on glibc (most Linux - systems) only allow a single outstanding request per file - descriptor which essentially makes Posix AIO useless on systems - using the glibc implementation.

To work around all these limitations, the aio_pthread module - was written. It uses a pthread pool instead of the - internal Posix AIO interface to allow read and write calls - to be process asynchronously. A pthread pool is created - which expands dynamically by creating new threads as work is - given to it to a maximum of 100 threads per smbd process. - To change this limit see the "aio num threads" parameter - below. New threads are not created if idle threads are - available when a new read or write request is received, - the new work is given to an existing idle thread. Threads - terminate themselves if idle for one second. -

- Note that the smb.conf parameters aio read size - and aio write size must also be set appropriately - for this module to be active. -

This module MUST be listed last in any module stack as - the Samba VFS pread/pwrite interface is not thread-safe. This - module makes direct pread and pwrite system calls and does - NOT call the Samba VFS pread and pwrite interfaces.

EXAMPLES

Straight forward use:

-        [cooldata]
-	path = /data/ice
-	aio read size = 1024
-	aio write size = 1024
-	vfs objects = aio_pthread
-

OPTIONS

aio_pthread:aio num threads = INTEGER

Limit the maximum number of threads per smbd that - will be created in the thread pool to service IO requests. -

By default this is set to 100.

VERSION

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

AUTHOR

The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed.

diff --git a/docs/htmldocs/manpages/vfs_audit.8.html b/docs/htmldocs/manpages/vfs_audit.8.html deleted file mode 100644 index c673d0cec9..0000000000 --- a/docs/htmldocs/manpages/vfs_audit.8.html +++ /dev/null @@ -1,19 +0,0 @@ -vfs_audit

Name

vfs_audit — record selected Samba VFS operations in the system log

Synopsis

vfs objects = audit

DESCRIPTION

This VFS module is part of the - samba(7) suite.

The vfs_audit VFS module records selected - client operations to the system log using - syslog(3).

The following Samba VFS operations are recorded:

connect
disconnect
opendir
mkdir
rmdir
open
close
rename
unlink
chmod
fchmod
chmod_acl
fchmod_acl

This module is stackable.

OPTIONS

audit:facility = FACILITY

Log messages to the named - syslog(3) facility. - -

audit:priority = PRIORITY

Log messages with the named - syslog(3) priority. -

EXAMPLES

Log operations on all shares using the LOCAL1 facility - and NOTICE priority:

-        [global]
-	vfs objects = audit
-	audit:facility = LOCAL1
-	audit:priority = NOTICE
-

VERSION

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

AUTHOR

The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed.

diff --git a/docs/htmldocs/manpages/vfs_cacheprime.8.html b/docs/htmldocs/manpages/vfs_cacheprime.8.html deleted file mode 100644 index 2fef4aca10..0000000000 --- a/docs/htmldocs/manpages/vfs_cacheprime.8.html +++ /dev/null @@ -1,26 +0,0 @@ -vfs_cacheprime

Name

vfs_cacheprime — prime the kernel file data cache

Synopsis

vfs objects = cacheprime

DESCRIPTION

This VFS module is part of the - samba(7) suite.

The vfs_cacheprime VFS module reads chunks - of file data near the range requested by clients in order to - make sure the data is present in the kernel file data cache at - the time when it is actually requested by clients.

The size of the disk read operations performed - by vfs_cacheprime is determined by the - cacheprime:rsize option. All disk read operations are aligned - on boundaries that are a multiple of this size. Each range of - the file data is primed at most once during the time the client - has the file open.

This module is stackable.

OPTIONS

cacheprime:rsize = BYTES

The number of bytes with which to prime - the kernel data cache.

The following suffixes may be applied to BYTES:

  • K - BYTES is a number of kilobytes

  • M - BYTES is a number of megabytes

  • G - BYTES is a number of gigabytes

EXAMPLES

For a hypothetical disk array, it is necessary to ensure - that all read operations are of size 1 megabyte (1048576 bytes), - and aligned on 1 megabyte boundaries: - 

-	[hypothetical]
-	vfs objects = cacheprime
-	cacheprime:rsize = 1M
-

CAVEATS

cacheprime is not a a substitute for - a general-purpose readahead mechanism. It is intended for use - only in very specific environments where disk operations must - be aligned and sized to known values (as much as that is possible). -

VERSION

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

AUTHOR

The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed.

diff --git a/docs/htmldocs/manpages/vfs_cap.8.html b/docs/htmldocs/manpages/vfs_cap.8.html deleted file mode 100644 index 909275069d..0000000000 --- a/docs/htmldocs/manpages/vfs_cap.8.html +++ /dev/null @@ -1,17 +0,0 @@ -vfs_cap

Name

vfs_cap — CAP encode filenames

Synopsis

vfs objects = cap

DESCRIPTION

This VFS module is part of the - samba(7) suite.

CAP (Columbia Appletalk Protocol) encoding is a - technique for representing non-ASCII filenames in ASCII. The - vfs_cap VFS module translates filenames to and - from CAP format, allowing users to name files in their native - encoding.

CAP encoding is most commonly - used in Japanese language environments.

This module is stackable.

EXAMPLES

On a system using GNU libiconv, use CAP encoding to support - users in the Shift_JIS locale:

-        [global]
-	dos charset = CP932
-	dos charset = CP932
-	vfs objects = cap
-

VERSION

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

AUTHOR

The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed.

diff --git a/docs/htmldocs/manpages/vfs_catia.8.html b/docs/htmldocs/manpages/vfs_catia.8.html deleted file mode 100644 index 77161c6651..0000000000 --- a/docs/htmldocs/manpages/vfs_catia.8.html +++ /dev/null @@ -1,14 +0,0 @@ -vfs_catia

Name

vfs_catia — translate illegal characters in Catia filenames

Synopsis

vfs objects = catia

DESCRIPTION

This VFS module is part of the - samba(7) suite.

The Catia CAD package commonly creates filenames that - use characters that are illegal in CIFS filenames. The - vfs_catia VFS module implements a fixed character - mapping so that these files can be shared with CIFS clients. -

This module is stackable.

EXAMPLES

Map Catia filenames on the [CAD] share:

-        [CAD]
-	path = /data/cad
-	vfs objects = catia
-

VERSION

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

AUTHOR

The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed.

diff --git a/docs/htmldocs/manpages/vfs_commit.8.html b/docs/htmldocs/manpages/vfs_commit.8.html deleted file mode 100644 index 23205c11ee..0000000000 --- a/docs/htmldocs/manpages/vfs_commit.8.html +++ /dev/null @@ -1,24 +0,0 @@ -vfs_commit

Name

vfs_commit — flush dirty data at specified intervals

Synopsis

vfs objects = commit

DESCRIPTION

This VFS module is part of the - samba(7) suite.

The vfs_commit VFS module keeps track of - the amount of data written to a file and synchronizes it to - disk when a specified amount accumulates. -

vfs_commit is useful in two - circumstances. First, if you have very precious data, the - impact of unexpected power loss can be minimized by a small - commit:dthresh value. Secondly, write performance can be - improved on some systems by flushing file data early and at - regular intervals.

This module is stackable.

OPTIONS

commit:dthresh = BYTES

Synchronize file data each time the specified - number of bytes has been written. -

The following suffixes may be applied to BYTES:

  • K - BYTES is a number of kilobytes

  • M - BYTES is a number of megabytes

  • G - BYTES is a number of gigabytes

EXAMPLES

Synchronize the file data on the [precious] share after - every 512 kilobytes (524288 bytes) of data is written:

-        [precious]
-	path = /data/precious
-	vfs objects = commit
-	commit:dthresh = 512K
-

CAVEATS

On some systems, the data synchronization performed by - commit may reduce performance. -

VERSION

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

AUTHOR

The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed.

diff --git a/docs/htmldocs/manpages/vfs_crossrename.8.html b/docs/htmldocs/manpages/vfs_crossrename.8.html deleted file mode 100644 index a658982541..0000000000 --- a/docs/htmldocs/manpages/vfs_crossrename.8.html +++ /dev/null @@ -1,28 +0,0 @@ -vfs_crossrename

Name

vfs_crossrename — server side rename files across filesystem boundaries

Synopsis

vfs objects = crossrename

DESCRIPTION

This VFS module is part of the - samba(7) suite.

The vfs_crossrename VFS module allows - server side rename operations even if source and target are on - different physical devices. A "move" in Explorer is usually a - rename operation if it is inside of a single share or device. - Usually such a rename operation returns - NT_STATUS_NOT_SAME_DEVICE and the client has to move the file by - manual copy and delete operations. If the rename by copy is done by the - server this can be much more efficient. vfs_crossrename tries to do - this server-side cross-device rename operation. There are however - limitations that this module currently does not solve: - -

-

This module is stackable.

OPTIONS

crossrename:sizelimit = BYTES

server-side cross-device-renames are only done - for files if the filesize is not larger than the defined - size in MiB to prevent timeouts. The default sizelimit is - 20 (MiB) -

EXAMPLES

To add server-side cross-device renames inside of a share - for all files sized up to 50MB:

-        [testshare]
-	path = /data/mounts
-	vfs objects = crossrename
-	crossrename:sizelimit = 50
-

VERSION

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

AUTHOR

The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed.

diff --git a/docs/htmldocs/manpages/vfs_default_quota.8.html b/docs/htmldocs/manpages/vfs_default_quota.8.html deleted file mode 100644 index afd491cc26..0000000000 --- a/docs/htmldocs/manpages/vfs_default_quota.8.html +++ /dev/null @@ -1,35 +0,0 @@ -vfs_default_quota

Name

vfs_default_quota — store default quota records for Windows clients

Synopsis

vfs objects = default_quota

DESCRIPTION

This VFS module is part of the - samba(7) - suite.

Many common quota implementations only store - quotas for users and groups, but do not store a default quota. The - vfs_default_quota module allows Samba to store - default quota values which can be examined using the Windows - Explorer interface. -

By default, Samba returns NO_LIMIT the default quota and - refuses to update them. vfs_default_quota maps - the default quota to the quota record of a user. By default the - root user is taken because quota limits for root are typically - not enforced.

This module is stackable.

OPTIONS

default_quota:uid = UID

UID specifies the user ID of the quota record where the - default user quota values are stored. -

default_quota:gid = GID

GID specifies the group ID of the quota record where the - default group quota values are stored. -

default_quota:uid nolimit = BOOL

If this parameter is True, then the user whose - quota record is storing the default user quota will - be reported as having a quota of NO_LIMIT. Otherwise, - the stored values will be reported. -

default_quota:gid nolimit = BOOL

If this parameter is True, then the group whose - quota record is storing the default group quota will - be reported as having a quota of NO_LIMIT. Otherwise, - the stored values will be reported. -

EXAMPLES

Store the default quota record in the quota record for - the user with ID 65535 and report that user as having no quota - limits:

-        [global]
-	vfs objects = default_quota
-	default_quota:uid = 65535
-	default_quota:uid nolimit = yes
-

VERSION

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

AUTHOR

The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed.

diff --git a/docs/htmldocs/manpages/vfs_dirsort.8.html b/docs/htmldocs/manpages/vfs_dirsort.8.html deleted file mode 100644 index 89b0b2319c..0000000000 --- a/docs/htmldocs/manpages/vfs_dirsort.8.html +++ /dev/null @@ -1,11 +0,0 @@ -vfs_dirsort

Name

vfs_dirsort — Sort directory contents

Synopsis

vfs objects = dirsort

DESCRIPTION

This VFS module is part of the - samba(7) suite.

The vfs_dirsort module sorts directory - entries alphabetically before sending them to the client.

Please be aware that adding this module might have negative - performance implications for large directories.

EXAMPLES

Sort directories for all shares:

-        [global]
-	vfs objects = dirsort
-

VERSION

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

AUTHOR

The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed.

diff --git a/docs/htmldocs/manpages/vfs_extd_audit.8.html b/docs/htmldocs/manpages/vfs_extd_audit.8.html deleted file mode 100644 index e8fb7e2d7b..0000000000 --- a/docs/htmldocs/manpages/vfs_extd_audit.8.html +++ /dev/null @@ -1,14 +0,0 @@ -vfs_extd_audit

Name

vfs_extd_audit — record selected Samba VFS operations

Synopsis

vfs objects = extd_audit

DESCRIPTION

This VFS module is part of the - samba(7) suite.

The extd_audit VFS module records selected - client operations to both the - smbd(8) log and - system log (using - syslog(3)).

Other than logging to the - smbd(8) log, - vfs_extd_audit is identical to - vfs_audit(8). -

This module is stackable.

VERSION

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

AUTHOR

The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed.

diff --git a/docs/htmldocs/manpages/vfs_fake_perms.8.html b/docs/htmldocs/manpages/vfs_fake_perms.8.html deleted file mode 100644 index a27ff092e7..0000000000 --- a/docs/htmldocs/manpages/vfs_fake_perms.8.html +++ /dev/null @@ -1,17 +0,0 @@ -vfs_fake_perms

Name

vfs_fake_perms — enable read only Roaming Profiles

Synopsis

vfs objects = fake_perms

DESCRIPTION

This VFS module is part of the - samba(7) suite.

The vfs_fake_perms VFS module was created - to allow Roaming Profile files and directories to be set (on - the Samba server under UNIX) as read only. This module will, - if installed on the Profiles share, report to the client that - the Profile files and directories are writeable. This satisfies - the client even though the files will never be overwritten as - the client logs out or shuts down. -

This module is stackable.

EXAMPLES

-        [Profiles]
-	path = /profiles
-	vfs objects = fake_perms
-

VERSION

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

AUTHOR

The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed.

diff --git a/docs/htmldocs/manpages/vfs_fileid.8.html b/docs/htmldocs/manpages/vfs_fileid.8.html deleted file mode 100644 index e06165414d..0000000000 --- a/docs/htmldocs/manpages/vfs_fileid.8.html +++ /dev/null @@ -1,32 +0,0 @@ -vfs_fileid

Name

vfs_fileid — Generates file_id structs with unique device id values for - cluster setups

Synopsis

vfs objects = fileid

DESCRIPTION

This VFS module is part of the - samba(7) - suite.

Samba uses file_id structs to uniquely identify files - for locking purpose. By default the file_id contains the device - and inode number returned by the stat() system call. - As the file_id is a unique identifier of a file, it must be the same - on all nodes in a cluster setup. This module overloads the - SMB_VFS_FILE_ID_CREATE() operation and - generates the device number based on the configured algorithm - (see the "fileid:algorithm" option). -

OPTIONS

fileid:algorithm = ALGORITHM

Available algorithms are fsname - and fsid. The default value is - fsname. -

The fsname algorithm generates - device id by hashing the kernel device name. -

The fsid algorithm generates - the device id from the f_fsid returned - from the statfs() syscall. -

fileid:mapping = ALGORITHM

This option is the legacy version of the - fileid:algorithm option, which was used in earlier - versions of fileid mapping feature in custom Samba 3.0 versions. -

EXAMPLES

Usage of the fileid module with the - fsid algorithm:

-        [global]
-	vfs objects = fileid
-	fileid:algorithm = fsid
-

VERSION

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

AUTHOR

The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed.

diff --git a/docs/htmldocs/manpages/vfs_full_audit.8.html b/docs/htmldocs/manpages/vfs_full_audit.8.html deleted file mode 100644 index 1b75409f33..0000000000 --- a/docs/htmldocs/manpages/vfs_full_audit.8.html +++ /dev/null @@ -1,45 +0,0 @@ -vfs_full_audit

Name

vfs_full_audit — record Samba VFS operations in the system log

Synopsis

vfs objects = full_audit

DESCRIPTION

This VFS module is part of the - samba(7) suite.

The vfs_full_audit VFS module records selected - client operations to the system log using - syslog(3).

vfs_full_audit is able to record the - complete set of Samba VFS operations:

aio_cancel
aio_error
aio_fsync
aio_read
aio_return
aio_suspend
aio_write
chdir
chflags
chmod
chmod_acl
chown
close
closedir
connect
disconnect
disk_free
fchmod
fchmod_acl
fchown
fget_nt_acl
fgetxattr
flistxattr
fremovexattr
fset_nt_acl
fsetxattr
fstat
fsync
ftruncate
get_nt_acl
get_quota
get_shadow_copy_data
getlock
getwd
getxattr
kernel_flock
lgetxattr
link
linux_setlease
listxattr
llistxattr
lock
lremovexattr
lseek
lsetxattr
lstat
mkdir
mknod
open
opendir
pread
pwrite
read
readdir
readlink
realpath
removexattr
rename
rewinddir
rmdir
seekdir
sendfile
set_nt_acl
set_quota
setxattr
stat
statvfs
symlink
sys_acl_add_perm
sys_acl_clear_perms
sys_acl_create_entry
sys_acl_delete_def_file
sys_acl_free_acl
sys_acl_free_qualifier
sys_acl_free_text
sys_acl_get_entry
sys_acl_get_fd
sys_acl_get_file
sys_acl_get_perm
sys_acl_get_permset
sys_acl_get_qualifier
sys_acl_get_tag_type
sys_acl_init
sys_acl_set_fd
sys_acl_set_file
sys_acl_set_permset
sys_acl_set_qualifier
sys_acl_set_tag_type
sys_acl_to_text
sys_acl_valid
telldir
unlink
utime
write

In addition to these operations, - vfs_full_audit recognizes the special operation - names "all" and "none ", which refer to all - the VFS operations and none of the VFS operations respectively. -

vfs_full_audit records operations in fixed - format consisting of fields separated by '|' characters. The - format is: 

-		smbd_audit: PREFIX|OPERATION|RESULT|FILE
-

The record fields are:

  • PREFIX - the result of the full_audit:prefix string after variable substitutions

  • OPERATION - the name of the VFS operation

  • RESULT - whether the operation succeeded or failed

  • FILE - the name of the file or directory the operation was performed on

This module is stackable.

OPTIONS

vfs_full_audit:prefix = STRING

Prepend audit messages with STRING. STRING is - processed for standard substitution variables listed in - smb.conf(5). The default - prefix is "%u|%I".

vfs_full_audit:success = LIST

LIST is a list of VFS operations that should be - recorded if they succeed. Operations are specified using - the names listed above. Operations can be unset by prefixing - the names with "!". -

vfs_full_audit:failure = LIST

LIST is a list of VFS operations that should be - recorded if they failed. Operations are specified using - the names listed above. Operations can be unset by prefixing - the names with "!". -

full_audit:facility = FACILITY

Log messages to the named - syslog(3) facility. - -

full_audit:priority = PRIORITY

Log messages with the named - syslog(3) priority. -

EXAMPLES

Log file and directory open operations on the [records] - share using the LOCAL7 facility and ALERT priority, including - the username and IP address. Logging excludes the open VFS function - on failures:

-        [records]
-	path = /data/records
-	vfs objects = full_audit
-	full_audit:prefix = %u|%I
-	full_audit:success = open opendir
-	full_audit:failure = all !open
-	full_audit:facility = LOCAL7
-	full_audit:priority = ALERT
-

VERSION

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

AUTHOR

The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed.

diff --git a/docs/htmldocs/manpages/vfs_gpfs.8.html b/docs/htmldocs/manpages/vfs_gpfs.8.html deleted file mode 100644 index f8ea7144a9..0000000000 --- a/docs/htmldocs/manpages/vfs_gpfs.8.html +++ /dev/null @@ -1,121 +0,0 @@ -vfs_gpfs

Name

vfs_gpfs — gpfs specific samba extensions like acls and prealloc

Synopsis

vfs objects = gpfs

DESCRIPTION

This VFS module is part of the - samba(7) suite.

The gpfs VFS module is the home - for all gpfs extensions that Samba requires for proper integration - with GPFS. It uses the GPL library interfaces provided by GPFS. -

Currently the gpfs vfs module provides extensions in following areas : -

  • NFSv4 ACL Interfaces with configurable options for GPFS

  • Kernel oplock support on GPFS

  • Lease support on GPFS

-

NOTE:This module follows the posix-acl behaviour - and hence allows permission stealing via chown. Samba might allow at a later - point in time, to restrict the chown via this module as such restrictions - are the responsibility of the underlying filesystem than of Samba. -

This module is stackable.

OPTIONS

gpfs:sharemodes = [ yes | no ]

- Enable/Disable cross node sharemode handling for GPFS. -

  • - yes(default) - propagate sharemodes across all GPFS nodes. -

  • - no - do not propagate sharemodes across all GPFS nodes. - This should only be used if the GPFS file system is - exclusively exported by Samba. Access by local unix application or - NFS exports could lead to corrupted files. -

gpfs:leases = [ yes | no ]

- Enable/Disable cross node leases (oplocks) for GPFS. - You should also set the oplocks and kernel oplocks - options to the same value. -

  • - yes(default) - propagate leases across all GPFS nodes. -

  • - no - do not propagate leases across all GPFS nodes. - This should only be used if the GPFS file system is - exclusively exported by Samba. Access by local unix application or - NFS exports could lead to corrupted files. -

gpfs:hsm = [ yes | no ]

- Enable/Disable announcing if this FS has HSM enabled. -

  • - no(default) - Do not announce HSM. -

  • - no - Announce HSM. -

gpfs:getrealfilename = [ yes | no ]

- Enable/Disable usage of the gpfs_get_realfilename_path() function. - This improves the casesensitive wildcard file name access. -

  • - yes(default) - use gpfs_get_realfilename_path(). -

  • - no - do not use gpfs_get_realfilename_path(). - It seems that gpfs_get_realfilename_path() doesn't work on AIX. -

gpfs:winattr = [ yes | no ]

- Enable/Disable usage of the windows attributes in GPFS. - GPFS is able to store windows file attributes e.g. HIDDEN, - READONLY, SYSTEM and others natively. That means Samba doesn't - need to map them to permission bits or extended attributes. -

  • - no(default) - do not use GPFS windows attributes. -

  • - yes - use GPFS windows attributes. -

gpfs:merge_writeappend = [ yes | no ]

- GPFS ACLs doesn't know about the 'APPEND' right. - This optionen lets Samba map the 'APPEND' right to 'WRITE'. -

  • - yes(default) - map 'APPEND' to 'WRITE'. -

  • - no - do not map 'APPEND' to 'WRITE'. -

gpfs:refuse_dacl_protected = [ yes | no ]

- As GPFS does not support the ACE4_FLAG_NO_PROPAGATE NFSv4 flag (which would be - the mapping for the DESC_DACL_PROTECTED flag), the status of this flag is - currently silently ignored by Samba. That means that if you deselect the "Allow - inheritable permissions..." checkbox in Windows' ACL dialog and then apply the - ACL, the flag will be back immediately. -

- To make sure that automatic migration with e.g. robocopy does not lead to - ACLs silently (and unintentionally) changed, you can set - gpfs:refuse_dacl_protected = yes to enable an explicit - check for this flag and if set, it will return NT_STATUS_NOT_SUPPORTED so - errors are shown up on the Windows side and the Administrator is aware of - the ACLs not being settable like intended -

  • - no(default) - ignore the DESC_DACL_PROTECTED flags. -

  • - yes - reject ACLs with DESC_DACL_PROTECTED. -

nfs4:mode = [ simple | special ]

- Enable/Disable substitution of special IDs on GPFS. This parameter - should not affect the windows users in anyway. It only ensures that Samba - sets the special IDs - OWNER@ and GROUP@ ( mappings to simple uids ) - that are relevant to GPFS. -

The following MODEs are understood by the module:

  • simple(default) - do not use special IDs in GPFS ACEs

  • special - use special IDs in GPFS ACEs.

nfs4:acedup = [dontcare|reject|ignore|merge]

- This parameter configures how Samba handles duplicate ACEs encountered in GPFS ACLs. - GPFS allows/creates duplicate ACE for different bits for same ID. -

Following is the behaviour of Samba for different values :

  • dontcare (default) - copy the ACEs as they come

  • reject - stop operation and exit with error on ACL set op

  • ignore - don't include the second matching ACE

  • merge - bitwise OR the 2 ace.flag fields and 2 ace.mask fields of the 2 duplicate ACEs into 1 ACE

nfs4:chown = [yes|no]

This parameter allows enabling or disabling the chown supported - by the underlying filesystem. This parameter should be enabled with - care as it might leave your system insecure.

Some filesystems allow chown as a) giving b) stealing. It is the latter - that is considered a risk.

Following is the behaviour of Samba for different values :

  • yes - Enable chown if as supported by the under filesystem

  • no (default) - Disable chown

gpfs:syncio = [yes|no]

This parameter makes Samba open all files with O_SYNC. - This triggers optimizations in GPFS for workloads that - heavily share files.

Following is the behaviour of Samba for different - values: -

  • yesOpen files with O_SYNC -

  • no (default)Open files as - normal Samba would do -

EXAMPLES

A GPFS mount can be exported via Samba as follows :

-        [samba_gpfs_share]
-	vfs objects = gpfs
-	path = /test/gpfs_mount
-	nfs4: mode = special
-	nfs4: acedup = merge
-

CAVEATS

- Depending on the version of gpfs, the libgpfs_gpl - library or the libgpfs library is needed at - runtime by the gpfs VFS module: - Starting with gpfs 3.2.1 PTF8, the complete libgpfs - is available as open source and libgpfs_gpl does no - longer exist. With earlier versions of gpfs, only the - libgpfs_gpl library was open source and could be - used at run time. -

- At build time, only the header file gpfs_gpl.h - is required , which is a symlink to gpfs.h in - gpfs versions newer than 3.2.1 PTF8. -

VERSION

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

AUTHOR

The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed.

The GPFS VFS module was created with contributions from - Volker Lendecke and the developers at IBM. -

This manpage was created by the IBM FSCC team

diff --git a/docs/htmldocs/manpages/vfs_netatalk.8.html b/docs/htmldocs/manpages/vfs_netatalk.8.html deleted file mode 100644 index 62079cd254..0000000000 --- a/docs/htmldocs/manpages/vfs_netatalk.8.html +++ /dev/null @@ -1,15 +0,0 @@ -vfs_netatalk

Name

vfs_netatalk — hide .AppleDouble files from CIFS clients

Synopsis

vfs objects = netatalk

DESCRIPTION

This VFS module is part of the - samba(7) suite.

The vfs_netatalk VFS module dynamically - hides .AppleDouble files, preventing spurious errors on some - CIFS clients. .AppleDouble files may be created by historic - implementations of AFP (Apple Filing Protocol) on servers.

This module is stackable.

EXAMPLES

Hide .AppleDouble files on the [data] share:

-        [data]
-	vfs objects = netatalk
-

CAVEATS

This module is largely historic and unlikely to be of use - in modern networks since current Apple systems are able to mount CIFS - shares natively. -

VERSION

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

AUTHOR

The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed.

diff --git a/docs/htmldocs/manpages/vfs_notify_fam.8.html b/docs/htmldocs/manpages/vfs_notify_fam.8.html deleted file mode 100644 index c46df2c989..0000000000 --- a/docs/htmldocs/manpages/vfs_notify_fam.8.html +++ /dev/null @@ -1,12 +0,0 @@ -vfs_notify_fam

Name

vfs_notify_fam — FAM support for file change notifications

Synopsis

vfs objects = notify_fam

DESCRIPTION

This VFS module is part of the - samba(7) suite.

The vfs_notify_fam module makes use of - the system FAM (File Alteration Monitor) daemon to implement - file change notifications for Windows clients. FAM is generally - present only on IRIX and some BSD systems.

This module is not stackable.

EXAMPLES

Support FAM notifications globally:

-        [global]
-	vfs objects = notify_fam
-

VERSION

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

AUTHOR

The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed.

diff --git a/docs/htmldocs/manpages/vfs_prealloc.8.html b/docs/htmldocs/manpages/vfs_prealloc.8.html deleted file mode 100644 index 92a60871ee..0000000000 --- a/docs/htmldocs/manpages/vfs_prealloc.8.html +++ /dev/null @@ -1,22 +0,0 @@ -vfs_prealloc

Name

vfs_prealloc — preallocate matching files to a predetermined size

Synopsis

vfs objects = prealloc

DESCRIPTION

This VFS module is part of the - samba(7) suite.

The vfs_prealloc VFS module preallocates - files to a specified size each time a new file is created. This - is useful in environments where files are of a predetermined - size will be written to a disk subsystem where extending file - allocations is expensive.

This module is stackable.

OPTIONS

prealloc:EXT = BYTES

Preallocate all files with the extension EXT to - the size specified by BYTES. -

The following suffixes may be applied to BYTES:

  • K - BYTES is a number of kilobytes

  • M - BYTES is a number of megabytes

  • G - BYTES is a number of gigabytes

EXAMPLES

A process writes TIFF files to a Samba share, and the - is known these files will almost always be around 4 megabytes - (4194304 bytes): 

-        [frames]
-	path = /data/frames
-	vfs objects = prealloc
-	prealloc:tiff = 4M
-

CAVEATS

vfs_prealloc is not supported on all - platforms and filesystems. Currently only XFS filesystems on - Linux and IRIX are supported. -

VERSION

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

AUTHOR

The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed.

diff --git a/docs/htmldocs/manpages/vfs_preopen.8.html b/docs/htmldocs/manpages/vfs_preopen.8.html deleted file mode 100644 index d455b8147e..0000000000 --- a/docs/htmldocs/manpages/vfs_preopen.8.html +++ /dev/null @@ -1,28 +0,0 @@ -vfs_preopen

Name

vfs_preopen — Hide read latencies for applications reading numbered files

Synopsis

vfs objects = preopen

DESCRIPTION

This VFS module is part of the - samba(7) suite.

This module assists applications that want to read numbered - files in sequence with very strict latency requirements. One area - where this happens in video streaming applications that want to read - one file per frame.

When you use this module, a number of helper processes is - started that speculatively open files and read a number of bytes to - prime the file system cache, so that later on when the real - application's request comes along, no disk access is necessary.

This module is stackable.

OPTIONS

preopen:names = /pattern/

- preopen:names specifies the file name pattern which should - trigger the preopen helpers to do their work. We assume that - the files are numbered incrementally. So if your file names - are numbered FRAME00000.frm FRAME00001.frm and so on you would - list them as preopen:names=/FRAME*.frm/ -

preopen:num_bytes = BYTES

- Specifies the number of bytes the helpers should speculatively - read, defaults to 1. -

preopen:helpers = NUM-PROCS

- Number of forked helper processes, defaults to 1. -

preopen:queuelen = NUM-FILES

- Number of files that should be speculatively opened. Defaults - to the 10 subsequent files. -

VERSION

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

AUTHOR

The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed.

The PREOPEN VFS module was created with contributions from - Volker Lendecke and the developers at IBM. -

diff --git a/docs/htmldocs/manpages/vfs_readahead.8.html b/docs/htmldocs/manpages/vfs_readahead.8.html deleted file mode 100644 index 96c8d73fe5..0000000000 --- a/docs/htmldocs/manpages/vfs_readahead.8.html +++ /dev/null @@ -1,25 +0,0 @@ -vfs_readahead

Name

vfs_readahead — pre-load the kernel buffer cache

Synopsis

vfs objects = readahead

DESCRIPTION

This VFS module is part of the - samba(7) suite.

This vfs_readahead VFS module detects - read requests at multiples of a given offset (hex 0x80000 by - default) and then tells the kernel via either the readahead - system call (on Linux) or the posix_fadvise system call to - pre-fetch this data into the buffer cache.

This module is useful for Windows Vista clients reading - data using the Windows Explorer program, which asynchronously - does multiple file read requests at offset boundaries of 0x80000 - bytes.

The offset multiple used is given by the readahead:offset - option, which defaults to 0x80000.

The size of the disk read operations performed - by vfs_readahead is determined by the - readahead:length option. By default this is set to the - same value as the readahead:offset option and if not - set explicitly will use the current value of - readahead:offset.

This module is stackable.

OPTIONS

The following suffixes may be applied to BYTES:

  • K - BYTES is a number of kilobytes

  • M - BYTES is a number of megabytes

  • G - BYTES is a number of gigabytes

readahead:offset = BYTES

The offset multiple that causes readahead to be - requested of the kernel buffer cache.

readahead:length = BYTES

The number of bytes requested to be - read into the kernel buffer cache on each - readahead call.

EXAMPLES

-	[hypothetical]
-	vfs objects = readahead
-

VERSION

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

AUTHOR

The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed.

diff --git a/docs/htmldocs/manpages/vfs_readonly.8.html b/docs/htmldocs/manpages/vfs_readonly.8.html deleted file mode 100644 index 8a03ddf81f..0000000000 --- a/docs/htmldocs/manpages/vfs_readonly.8.html +++ /dev/null @@ -1,24 +0,0 @@ -vfs_readonly

Name

vfs_readonly — make a Samba share read only for a specified time period

Synopsis

vfs objects = readonly

DESCRIPTION

This VFS module is part of the - samba(7) suite.

The vfs_readonly VFS module marks a share - as read only for all clients connecting within the configured - time period. Clients connecting during this time will be denied - write access to all files in the share, irrespective of their - actual access privileges.

This module is stackable.

OPTIONS

readonly:period = BEGIN, END

Only mark the share as read only if the client - connection was made between the times marked by the - BEGIN and END date specifiers. - The syntax of these date specifiers is the - same as that accepted by the -d option of GNU - date(1). -

EXAMPLES

Mark all shares read only:

-        [global]
-	vfs objects = readonly
-

Mark the [backup] share as read only during business hours:

-        [backup]
-	path = /readonly
-	vfs objects = readonly
-	readonly:period = readonly:period = "today 9:00","today 17:00"
-

VERSION

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

AUTHOR

The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed.

diff --git a/docs/htmldocs/manpages/vfs_recycle.8.html b/docs/htmldocs/manpages/vfs_recycle.8.html deleted file mode 100644 index 053c79cec3..0000000000 --- a/docs/htmldocs/manpages/vfs_recycle.8.html +++ /dev/null @@ -1,63 +0,0 @@ -vfs_recycle

Name

vfs_recycle — Samba VFS recycle bin

Synopsis

vfs objects = recycle

DESCRIPTION

This VFS module is part of the - samba(7) suite.

The vfs_recycle intercepts file deletion - requests and moves the affected files to a temporary repository - rather than deleting them immediately. This gives the same effect - as the Recycle Bin on Windows computers.

The Recycle Bin will not appear in Windows Explorer - views of the network file system (share) nor on any mapped - drive. Instead, a directory called .recycle will be automatically - created when the first file is deleted and recycle:repository is - not configured. If recycle:repository is configured, the name - of the created directory depends on recycle:repository. Users - can recover files from the recycle bin. If the recycle:keeptree - option has been specified, deleted files will be found in a path - identical with that from which the file was deleted.

This module is stackable.

OPTIONS

recycle:repository = PATH

Path of the directory where deleted files should be moved. -

If this option is not set, the default path .recycle - is used.

recycle:directory_mode = MODE

Set MODE to the octal mode the recycle repository - should be created with. The recycle repository will be - created when first file is deleted. If recycle:subdir_mode - is not set, MODE also applies to subdirectories. -

If this option is not set, the default mode - 0700 is used.

recycle:subdir_mode = MODE

Set MODE to the octal mode with which - sub directories of the recycle repository should be created. -

If this option is not set, subdirectories - will be created with the mode from recycle:directory_mode. -

recycle:keeptree = BOOL

Specifies whether the directory structure should - be preserved or whether the files in a directory that is being - deleted should be kept separately in the repository. -

recycle:versions = BOOL

If this option is True, two files with the same - name that are deleted will both be kept in the repository. - Newer deleted versions of a file will be called - "Copy #x of filename". -

recycle:touch = BOOL

Specifies whether a file's access date should be - updated when the file is moved to the repository. -

recycle:touch_mtime = BOOL

Specifies whether a file's last modified date should be - updated when the file is moved to the repository. -

recycle:minsize = BYTES

Files that are smaller than the number of bytes - specified by this parameter will not be put into the - repository. -

recycle:maxsize = BYTES

Files that are larger than the number of bytes - specified by this parameter will not be put into the - repository. -

recycle:exclude = LIST

List of files that should not be put into the - repository when deleted, but deleted in the normal way. - Wildcards such as * and ? are supported. -

recycle:exclude_dir = LIST

List of directories whose files should not be put - into the repository when deleted, but deleted in the - normal way. Wildcards such as * and ? are supported. -

recycle:noversions = LIST

Specifies a list of paths (wildcards such as * - and ? are supported) for which no versioning should - be used. Only useful when recycle:versions is enabled. -

EXAMPLES

Move files "deleted" on share to - /data/share/.recycle instead of deleting them: - 

-        [share]
-	path = /data/share
-	vfs objects = recycle
-	recycle:repository = .recycle
-	recycle:keeptree = yes
-	recycle:versions = yes
-

VERSION

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

AUTHOR

The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed.

diff --git a/docs/htmldocs/manpages/vfs_scannedonly.8.html b/docs/htmldocs/manpages/vfs_scannedonly.8.html deleted file mode 100644 index f4a72bf3be..0000000000 --- a/docs/htmldocs/manpages/vfs_scannedonly.8.html +++ /dev/null @@ -1,90 +0,0 @@ -vfs_scannedonly

Name

vfs_scannedonly — Ensures that only files that have been scanned for viruses are - visible and accessible to the end user.

Synopsis

vfs objects = scannedonly

DESCRIPTION

This VFS module is part of the - samba(8) suite.

The vfs_scannedonly VFS module ensures that - only files that have been scanned for viruses are visible and accessible - to the end user. If non-scanned files are found an anti-virus scanning - daemon is notified. The anti-virus scanning daemon is not part of the - Samba suite. -

Scannedonly comes in two parts: a samba vfs module and (one or - more) daemons. The daemon scans files. If a certain file is clean, - a second file is created with prefix .scanned:. - The Samba module simply looks if such a .scanned: - file exists, and is newer than the pertinent file. If this is the case, - the file is shown to the user. If this is not the case, the file is not - returned in a directory listing (configurable), and cannot be opened - (configurable). The Samba vfs module will notify the daemon to scan - this file. -

So what happens for the user in the default configuration. The - first time a directory is listed, it shows files as 'file is being - scanned for viruses, but after the first time all files are shown. - There is a utility scannedonly_prescan that can help you to prescan - all directories. When new files are written the daemon is notified - immediately after the file is complete. -

If a virus is found by the daemon, a file with a warning message - is created in the directory of the user, a warning is sent to the logs, - and the file is renamed to have prefix .virus:. - Files with the .virus: prefix are never shown to - the user and all access is denied. -

This module is stackable.

CONFIGURATION

vfs_scannedonly relies on a anti-virus scanning - daemon that listens on the scannedonly socket (unix domain socket or UDP - socket). -

OPTIONS

scannedonly:domain_socket = True

Whether to use a unix domain socket or not (false reverts - to use udp) -

scannedonly:socketname = /var/lib/scannedonly/scan

The location of the unix domain socket to connect to

scannedonly:portnum = 2020

The udp port number to connect to -

scannedonly:scanhost = localhost

- When using UDP the host that runs the scanning daemon (this host - needs access to the files!) -

scannedonly:show_special_files = True

- Whether sockets, devices and fifo's (all not scanned for - viruses) should be visible to the user -

scannedonly:rm_hidden_files_on_rmdir = True

- Whether files that are not visible (.scanned: - files, .failed: files and .virus: - files) should be deleted if the user tries to remove - the directory. If false, the user will get the "directory is not - empty" error. -

scannedonly:hide_nonscanned_files = True

- If false, all non-scanned files are visible in directory listings. - If such files are found in a directory listing the scanning daemon - is notified that scanning is required. Access to non-scanned files - is still denied (see scannedonly:allow_nonscanned_files). -

scannedonly:scanning_message = is being scanned for - viruses

- If non-scanned files are hidden - (if scannedonly:hide_nonscanned_files = True), a fake 0 byte file - is shown. The filename is the original filename with the message - as suffix. -

scannedonly:recheck_time_open = 50

- If a non-scanned file is opened, the vfs module will wait - recheck_tries_open times for recheck_time_open milliseconds for - the scanning daemon to create a .scanned: - file. For small files that are scanned by the daemon within the - time (tries * time) the behavior will be just like on-access - scanning. -

scannedonly:recheck_tries_open = 100

- See recheck_time_open. -

scannedonly:recheck_time_readdir = 50

- If a non-scanned file is in a directory listing the vfs module - notifies the daemon (once for all files that need scanning in - that directory), and waits recheck_tries_readdir times for - recheck_time_readdir milliseconds. Only used when - hide_nonscanned_files is false. -

scannedonly:recheck_tries_readdir = 20

- See recheck_time_readdir. -

scannedonly:allow_nonscanned_files = False

- Allow access to non-scanned files. The daemon is notified, - however, and special files such as .scanned: - files. .virus: files and - .failed: files are not listed. -

EXAMPLES

Enable anti-virus scanning:

-        [homes]
-	vfs objects = scannedonly
-	scannedonly:hide_nonscanned_files = False
-

CAVEATS

This is not true on-access scanning. However, it is very fast - for files that have been scanned already. -

VERSION

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

AUTHOR

The original Samba software and related utilities - were created by Andrew Tridgell. Scannedonly was - developed for Samba by Olivier Sessink. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed.

diff --git a/docs/htmldocs/manpages/vfs_shadow_copy.8.html b/docs/htmldocs/manpages/vfs_shadow_copy.8.html deleted file mode 100644 index 6f5c69bcca..0000000000 --- a/docs/htmldocs/manpages/vfs_shadow_copy.8.html +++ /dev/null @@ -1,32 +0,0 @@ -vfs_shadow_copy

Name

vfs_shadow_copy — Make a Samba share read only for a specified time period

Synopsis

vfs objects = shadow_copy

DESCRIPTION

This VFS module is part of the - samba(7) suite.

The vfs_shadow_copy VFS module functionality - that is similar to Microsoft Shadow Copy services. When setup properly, - this module allows Microsoft Shadow Copy clients to browse - "shadow copies" on Samba shares. -

This module is stackable.

CONFIGURATION

vfs_shadow_copy relies on a filesystem - snapshot implementation. Many common filesystems have native - support for this. -

Filesystem snapshots must be mounted on - specially named directories in order to be recognized by - vfs_shadow_copy. The snapshot mount points must - be immediate children of a the directory being shared.

The snapshot naming convention is @GMT-YYYY.MM.DD-hh.mm.ss, - where: -

  • YYYY is the 4 digit year

  • MM is the 2 digit month

  • DD is the 2 digit day

  • hh is the 2 digit hour

  • mm is the 2 digit minute

  • ss is the 2 digit second.

-

The vfs_shadow_copy snapshot naming convention can be produced with the following - date(1) command: - 

-	TZ=GMT date +@GMT-%Y.%m.%d-%H.%M.%S
-

EXAMPLES

Add shadow copy support to user home directories:

-        [homes]
-	vfs objects = shadow_copy
-

CAVEATS

This is not a backup, archival, or version control solution. -

With Samba or Windows servers, - vfs_shadow_copy is designed to be an end-user - tool only. It does not replace or enhance your backup and - archival solutions and should in no way be considered as - such. Additionally, if you need version control, implement a - version control system.

VERSION

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

AUTHOR

The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed.

diff --git a/docs/htmldocs/manpages/vfs_shadow_copy2.8.html b/docs/htmldocs/manpages/vfs_shadow_copy2.8.html deleted file mode 100644 index 41d5d9eac2..0000000000 --- a/docs/htmldocs/manpages/vfs_shadow_copy2.8.html +++ /dev/null @@ -1,68 +0,0 @@ -vfs_shadow_copy2

Name

vfs_shadow_copy2 — Expose snapshots to Windows clients as shadow copies.

Synopsis

vfs objects = shadow_copy2

DESCRIPTION

This VFS module is part of the - samba(7) suite.

The vfs_shadow_copy2 VFS module functionality - that is similar to Microsoft Shadow Copy services. When setup properly, - this module allows Microsoft Shadow Copy clients to browse - "shadow copies" on Samba shares. -

This is a 2nd implementation of a shadow copy module. This - version has the following features:

  1. You don't need to populate your shares with symlinks to the - snapshots. This can be very important when you have thousands of - shares, or use [homes].

  2. The inode number of the files is altered so it is different - from the original. This allows the 'restore' button to work - without a sharing violation.

This module is stackable.

CONFIGURATION

vfs_shadow_copy2 relies on a filesystem - snapshot implementation. Many common filesystems have native - support for this. -

Filesystem snapshots must be mounted on - specially named directories in order to be recognized by - vfs_shadow_copy2. The snapshot mount points must - be immediate children of a the directory being shared.

The snapshot naming convention is @GMT-YYYY.MM.DD-hh.mm.ss, - where: -

  • YYYY is the 4 digit year

  • MM is the 2 digit month

  • DD is the 2 digit day

  • hh is the 2 digit hour

  • mm is the 2 digit minute

  • ss is the 2 digit second.

-

The vfs_shadow_copy2 snapshot naming convention can be - produced with the following date(1) command: - 

-	TZ=GMT date +@GMT-%Y.%m.%d-%H.%M.%S
-

OPTIONS

shadow:snapdir = SNAPDIR -

Path to the directory where snapshots are kept. -

shadow:basedir = BASEDIR -

Path to the base directory that snapshots are from. -

shadow:sort = asc/desc, or not specified for unsorted (default) -

By this parameter one can specify that the shadow - copy directories should be sorted before they are sent to the - client. This can be beneficial as unix filesystems are usually - not listed alphabetically sorted. If enabled, you typically - want to specify descending order. -

shadow:localtime = yes/no -

This is an optional parameter that indicates whether the - snapshot names are in UTC/GMT or in local time. By default - UTC is expected. -

shadow:format = format specification for snapshot names -

This is an optional parameter that specifies the format - specification for the naming of snapshots. The format must - be compatible with the conversion specifications recognized - by str[fp]time. The default value is "@GMT-%Y.%m.%d-%H.%M.%S". -

shadow:fixinodes = yes/no -

If you enable shadow:fixinodes - then this module will modify the apparent inode - number of files in the snapshot directories using a hash of the - files path. This is needed for snapshot systems where the - snapshots have the same device:inode number as the original - files (such as happens with GPFS snapshots). If you don't set - this option then the 'restore' button in the shadow copy UI - will fail with a sharing violation. -

EXAMPLES

Add shadow copy support to user home directories:

-        [homes]
-	vfs objects = shadow_copy2
-	shadow:snapdir = /data/snapshots
-	shadow:basedir = /data/home
-	shadow:sort = desc
-

CAVEATS

This is not a backup, archival, or version control solution. -

With Samba or Windows servers, - vfs_shadow_copy2 is designed to be an end-user - tool only. It does not replace or enhance your backup and - archival solutions and should in no way be considered as - such. Additionally, if you need version control, implement a - version control system.

VERSION

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

AUTHOR

The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed.

diff --git a/docs/htmldocs/manpages/vfs_smb_traffic_analyzer.8.html b/docs/htmldocs/manpages/vfs_smb_traffic_analyzer.8.html deleted file mode 100644 index 0002cc6a00..0000000000 --- a/docs/htmldocs/manpages/vfs_smb_traffic_analyzer.8.html +++ /dev/null @@ -1,118 +0,0 @@ -smb_traffic_analyzer

Name

vfs_smb_traffic_analyzer — log Samba VFS read and write operations through a socket - to a helper application

Synopsis

vfs objects = smb_traffic_analyzer

DESCRIPTION

This VFS module is part of the - samba(7) suite.

The vfs_smb_traffic_analyzer VFS module logs - client file operations on a Samba server and sends this data - over a socket to a helper program (in the following the "Receiver"), - which feeds a SQL database. More - information on the helper programs can be obtained from the - homepage of the project at: - http://holger123.wordpress.com/smb-traffic-analyzer/ - Since the VFS module depends on a receiver that is doing something with - the data, it is evolving in it's development. Therefore, the module - works with different protocol versions, and the receiver has to be able - to decode the protocol that is used. The protocol version 1 was - introduced to Samba at September 25, 2008. It was a very simple - protocol, supporting only a small list of VFS operations, and had - several drawbacks. The protocol version 2 is a try to solve the - problems version 1 had while at the same time adding new features. - With the release of Samba 3.6.0, the module will run protocol version 2 - by default. -

Protocol version 1 documentation

vfs_smb_traffic_analyzer protocol version 1 is aware - of the following VFS operations:

write
pwrite
read
pread

vfs_smb_traffic_analyzer sends the following data - in a fixed format separated by a comma through either an internet or a - unix domain socket:

-	BYTES|USER|DOMAIN|READ/WRITE|SHARE|FILENAME|TIMESTAMP
-

Description of the records: - -

  • BYTES - the length in bytes of the VFS operation

  • USER - the user who initiated the operation

  • DOMAIN - the domain of the user

  • READ/WRITE - either "W" for a write operation or "R" for read

  • SHARE - the name of the share on which the VFS operation occurred

  • FILENAME - the name of the file that was used by the VFS operation

  • TIMESTAMP - a timestamp, formatted as "yyyy-mm-dd hh-mm-ss.ms" indicating when the VFS operation occurred

  • IP - The IP Address (v4 or v6) of the client machine that initiated the VFS operation.

- -

This module is stackable.

Drawbacks of protocol version 1

Several drawbacks have been seen with protocol version 1 over time.

  • - Problematic parsing - - Protocol version 1 uses hyphen and comma to seperate blocks of data. Once there is a - filename with a hyphen, you will run into problems because the receiver decodes the - data in a wrong way. -

  • - Insecure network transfer - - Protocol version 1 sends all it's data as plaintext over the network. -

  • - Limited set of supported VFS operations - - Protocol version 1 supports only four VFS operations. -

  • - No subreleases of the protocol - - Protocol version 1 is fixed on it's version, making it unable to introduce new - features or bugfixes through compatible sub-releases. -

Version 2 of the protocol

Protocol version 2 is an approach to solve the problems introduced with protcol v1. - From the users perspective, the following changes are most prominent among other enhancements: -

  • - The data from the module may be send encrypted, with a key stored in secrets.tdb. The - Receiver then has to use the same key. The module does AES block encryption over the - data to send. -

  • - The module now can identify itself against the receiver with a sub-release number, where - the receiver may run with a different sub-release number than the module. However, as - long as both run on the V2.x protocol, the receiver will not crash, even if the module - uses features only implemented in the newer subrelease. If the module uses - a new feature from a newer subrelease, and the receiver runs an older protocol, it is just - ignoring the functionality. Of course it is best to have both the receiver and the module - running the same subrelease of the protocol. -

  • - The parsing problems of protocol V1 can no longer happen, because V2 is marshalling the - data packages in a proper way. -

  • - The module now potientially has the ability to create data on every VFS function. As of - protocol V2.0, there is support for 8 VFS functions, namely write,read,pread,pwrite, - rename,chdir,mkdir and rmdir. Supporting more VFS functions is one of the targets for the - upcoming sub-releases. -

- To enable protocol V2, the protocol_version vfs option has to be used (see OPTIONS). -

OPTIONS with protocol V1 and V2.x

smb_traffic_analyzer:mode = STRING

If STRING matches to "unix_domain_socket", the module will - use a unix domain socket located at /var/tmp/stadsocket, if - STRING contains an different string or is not defined, the module will - use an internet domain socket for data transfer.

smb_traffic_analyzer:host = STRING

The module will send the data to the system named with - the hostname STRING.

smb_traffic_analyzer:port = STRING

The module will send the data using the TCP port given - in STRING. -

smb_traffic_analyzer:anonymize_prefix = STRING

The module will replace the user names with a prefix - given by STRING and a simple hash number. In version 2.x - of the protocol, the users SID will also be anonymized. -

smb_traffic_analyzer:total_anonymization = STRING

If STRING matches to 'yes', the module will replace - any user name with the string given by the option - smb_traffic_analyzer:anonymize_prefix, without generating - an additional hash number. This means that any transfer data - will be mapped to a single user, leading to a total - anonymization of user related data. In version 2.x of the - protocol, the users SID will also be anonymized.

smb_traffic_analyzer:protocol_version = STRING

If STRING matches to V1, the module will use version 1 of the - protocol. If STRING is not given, the module will use version 2 of the - protocol, which is the default. -

EXAMPLES

Running protocol V2 on share "example_share", using an internet socket.

-	[example_share]
-	path = /data/example
-	vfs_objects = smb_traffic_analyzer
-	smb_traffic_analyzer:host = examplehost
-	smb_traffic_analyzer:port = 3491
-

The module running on share "example_share", using a unix domain socket

-	[example_share]
-	path = /data/example
-	vfs objects = smb_traffic_analyzer
-	smb_traffic_analyzer:mode = unix_domain_socket
-

The module running on share "example_share", using an internet socket, - connecting to host "examplehost" on port 3491.

-	[example_share]
-	path = /data/example
-	vfs objects = smb_traffic_analyzer
-	smb_traffic_analyzer:host = examplehost
-	smb_traffic_analyzer:port = 3491
-

The module running on share "example_share", using an internet socket, - connecting to host "examplehost" on port 3491, anonymizing user names with - the prefix "User".

-	[example_share]
-	path = /data/example
-	vfs objects = smb_traffic_analyzer
-	smb_traffic_analyzer:host = examplehost
-	smb_traffic_analyzer:port = 3491
-	smb_traffic_analyzer:anonymize_prefix = User
-

VERSION

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

AUTHOR

The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed.

The original version of the VFS module and the - helper tools were created by Holger Hetterich.

diff --git a/docs/htmldocs/manpages/vfs_streams_depot.8.html b/docs/htmldocs/manpages/vfs_streams_depot.8.html deleted file mode 100644 index 1b226c3de7..0000000000 --- a/docs/htmldocs/manpages/vfs_streams_depot.8.html +++ /dev/null @@ -1,15 +0,0 @@ -vfs_streams_depot

Name

vfs_streams_depot — EXPERIMENTAL module to store alternate data streams in a - central directory. -

Synopsis

vfs objects = streams_depot

DESCRIPTION

This EXPERIMENTAL VFS module is part of the - samba(7) suite.

The vfs_streams_depot enables storing of NTFS - alternate data streams in the file system. As a normal posix file - system does not support the concept of multiple data streams per file, - the streams_depot module stores the data in files in a separate - directory.

OPTIONS

streams_depot:directory = PATH

Path of the directory where the alternate data streams - should be stored. Defaults to the sharepath/.streams.

EXAMPLES

-        [share]
-	vfs objects = streams_depot
-

AUTHOR

The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed.

diff --git a/docs/htmldocs/manpages/vfs_streams_xattr.8.html b/docs/htmldocs/manpages/vfs_streams_xattr.8.html deleted file mode 100644 index f8eb237d14..0000000000 --- a/docs/htmldocs/manpages/vfs_streams_xattr.8.html +++ /dev/null @@ -1,17 +0,0 @@ -vfs_streams_xattr

Name

vfs_streams_xattr — Store alternate data streams in posix xattrs

Synopsis

vfs objects = streams_xattr

DESCRIPTION

This VFS module is part of the - samba(7) suite.

The vfs_streams_xattr enables storing of NTFS - alternate data streams in the file system. As a normal posix file - system does not support the concept of multiple data streams per file, - the streams_xattr module stores the data in posix extended attributes - (xattrs). The name of these attributes is - user.DosStream."ADS-NAME".

The file system that is shared with this module enabled must - support xattrs.

Please note that most file systems have severe limitations on - the size of xattrs. So this module might work for applications like IE - that stores small zone information in streams but will fail for - applications that store serious amounts of data in ADSs.

EXAMPLES

-        [share]
-	vfs objects = streams_xattr
-

AUTHOR

The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed.

diff --git a/docs/htmldocs/manpages/vfs_time_audit.8.html b/docs/htmldocs/manpages/vfs_time_audit.8.html deleted file mode 100644 index f669678f0c..0000000000 --- a/docs/htmldocs/manpages/vfs_time_audit.8.html +++ /dev/null @@ -1,21 +0,0 @@ -vfs_time_audit

Name

vfs_time_audit — samba vfs module to log slow VFS operations

Synopsis

vfs objects = time_audit

DESCRIPTION

This VFS module is part of the - samba(7) suite.

The time_audit VFS module logs system calls - that take longer than the number of milliseconds defined by the variable - time_audit:audit_timeout. It will log the calls and - the time spent in it. -

It's kind of comparable with strace -T and - is helpful to reveal performance problems with the underlying file - and storage subsystems.

This module is stackable.

OPTIONS

time_audit:audit_timeout = number of milliseconds

VFS calls that take longer than the defined number of milliseconds - that should be logged. The default is 10000 (10s). -

EXAMPLES

This would log VFS calls that take longer than 3 seconds:

-        [sample_share]
-	path = /test/sample_share
-	vfs objects = time_audit
-	time_audit: audit_timeout = 3000
-

VERSION

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

AUTHOR

The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed.

The time_audit VFS module was created with contributions from - Abhidnya Chirmule. -

diff --git a/docs/htmldocs/manpages/vfs_xattr_tdb.8.html b/docs/htmldocs/manpages/vfs_xattr_tdb.8.html deleted file mode 100644 index f6233b9991..0000000000 --- a/docs/htmldocs/manpages/vfs_xattr_tdb.8.html +++ /dev/null @@ -1,12 +0,0 @@ -vfs_xattr_tdb

Name

vfs_xattr_tdb — Save Extended Attributes (EAs) in a tdb file

Synopsis

vfs objects = xattr_tdb

DESCRIPTION

This VFS module is part of the - samba(7) suite.

The vfs_xattr_tdb VFS module stores - Extended Attributes (EAs) in a tdb file. - This enables the usage of Extended Attributes on OS and - filesystems which do not support Extended Attributes - by themselves. -

This module is stackable.

OPTIONS

xattr_tdb:file = PATH

Name of the tdb file the EAs are stored in. - If this option is not set, the default filename - xattr.tdb is used.

AUTHOR

The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed.

diff --git a/docs/htmldocs/manpages/vfstest.1.html b/docs/htmldocs/manpages/vfstest.1.html deleted file mode 100644 index dd48d669ef..0000000000 --- a/docs/htmldocs/manpages/vfstest.1.html +++ /dev/null @@ -1,41 +0,0 @@ -vfstest

Name

vfstest — tool for testing samba VFS modules

Synopsis

vfstest [-d debuglevel] [-c command] [-l logdir] [-h]

DESCRIPTION

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

OPTIONS

-c|--command=command

Execute the specified (colon-separated) commands. - See below for the commands that are available. -

-h|--help

Print a summary of command line options. -

-l|--logfile=logbasename

File name for log/debug files. The extension - '.client' will be appended. The log file is never removed - by the client. -

-d|--debuglevel=level

level is an integer -from 0 to 10. The default value if this parameter is -not specified is 0.

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.

-V|--version

Prints the program version number. -

-s|--configfile <configuration file>

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.

-l|--log-basename=logdirectory

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

COMMANDS

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

VERSION

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

AUTHOR

The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed.

The vfstest man page was written by Jelmer Vernooij.

diff --git a/docs/htmldocs/manpages/wbinfo.1.html b/docs/htmldocs/manpages/wbinfo.1.html deleted file mode 100644 index 3b8bd52b00..0000000000 --- a/docs/htmldocs/manpages/wbinfo.1.html +++ /dev/null @@ -1,117 +0,0 @@ -wbinfo

Name

wbinfo — Query information from winbind daemon

Synopsis

wbinfo [-a user%password] [--all-domains] [--allocate-gid] [--allocate-uid] [-c] [--ccache-save] [--change-user-password] [-D domain] [--domain domain] [--dsgetdcname domain] [-g] [--getdcname domain] [--get-auth-user] [-G gid] [--gid-info] [--group-info] [--help|-?] [-i user] [-I ip] [-K user%password] [--lanman] [-m] [-n name] [-N netbios-name] [--ntlmv2] [--online-status] [--own-domain] [-p] [-P|--ping-dc] [-r user] [-R|--lookup-rids] [-s sid] [--separator] [--set-auth-user user%password] [-S sid] [--sid-aliases] [--sid-to-fullname] [-t] [-u] [--uid-info uid] [--usage] [--user-domgroups sid] [--user-sids sid] [-U uid] [-V] [--verbose] [-Y sid]

DESCRIPTION

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.

OPTIONS

-a|--authenticate username%password

Attempt to authenticate a user via winbindd(8). - This checks both authentication methods and reports its results. -

Note

Do not be tempted to use this - functionality for authentication in third-party - applications. Instead use ntlm_auth(1).

--allocate-gid

Get a new GID out of idmap -

--allocate-uid

Get a new UID out of idmap -

--all-domains

List all domains (trusted and - own domain). -

-c|--change-secret

Change the trust account password. May be used - in conjunction with domain in order to change - interdomain trust account passwords. -

--ccache-save username%password

Store user and password for ccache. -

--change-user-password username

Change the password of a user. The old and new password will be prompted. -

--domain name

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(8) belongs. Currently only the - -u, and -g options honor this parameter. -

-D|--domain-info domain

Show most of the info we have about the - specified domain. -

--dsgetdcname domain

Find a DC for a domain. -

--gid-info gid

Get group info from gid. -

--group-info user

Get group info for user. -

-g|--domain-groups

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

--get-auth-user

Print username and password used by winbindd(8) - during session setup to a domain controller. Username - and password can be set using --set-auth-user. - Only available for root.

--getdcname domain

Get the DC name for the specified domain. -

-G|--gid-to-sid gid

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.

-?

Print brief help overview. -

-i|--user-info user

Get user info. -

-I|--WINS-by-ip ip

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

-K|--krb5auth username%password

Attempt to authenticate a user via Kerberos. -

--lanman

Use lanman cryptography for user authentication. -

-m|--trusted-domains

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

-n|--name-to-sid name

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.

-N|--WINS-by-name name

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

--ntlmv2

Use NTLMv2 cryptography for user authentication. -

--online-status domain

Show whether domains are marked as online or - offline. An optional domain argument limits the - output to the online status of a given domain. -

--own-domain

List own domain. -

-p|--ping

Check whether winbindd(8) is still alive. - Prints out either 'succeeded' or 'failed'. -

-P|--ping-dc

Issue a no-effect command to our DC. This - checks if our secure channel connection to our domain - controller is still alive. It has much less impact than - wbinfo -t. -

-r|--user-groups username

Try to obtain the list of UNIX group ids - to which the user belongs. This only works for users - defined on a Domain Controller. -

-R|--lookup-rids rid1, rid2, rid3...

Converts RIDs to names. Uses a comma separated - list of rids. -

-s|--sid-to-name sid

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.

--separator

Get the active winbind separator. -

--set-auth-user username%password

Store username and password used by winbindd(8) 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 compatible with - Windows 2000 servers only). -

-S|--sid-to-uid sid

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.

--sid-aliases sid

Get SID aliases for a given SID. -

--sid-to-fullname sid

Converts a SID to a full username - (DOMAIN\username). -

-t|--check-secret

Verify that the workstation trust account - created when the Samba server is added to the Windows NT - domain is working. May be used in conjunction with - domain in order to verify interdomain - trust accounts.

-u|--domain-users

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

--uid-info uid

Get user info for the user connected to - user id UID.

--usage

Print brief help overview. -

--user-domgroups sid

Get user domain groups. -

--user-sids sid

Get user group SIDs for user. -

-U|--uid-to-sid uid

Try to convert a UNIX user id to a Windows NT - SID. If the uid specified does not refer to one within - the idmap range then the operation will fail.

--verbose

- Print additional information about the query results. -

-Y|--sid-to-gid sid

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.

-V|--version

Prints the program version number. -

-h|--help

Print a summary of command line options. -

EXIT STATUS

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.

VERSION

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

SEE ALSO

winbindd(8) and ntlm_auth(1)

AUTHOR

The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed.

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.

diff --git a/docs/htmldocs/manpages/winbind_krb5_locator.7.html b/docs/htmldocs/manpages/winbind_krb5_locator.7.html deleted file mode 100644 index f42f08c49d..0000000000 --- a/docs/htmldocs/manpages/winbind_krb5_locator.7.html +++ /dev/null @@ -1,43 +0,0 @@ -winbind_krb5_locator

Name

winbind_krb5_locator — A plugin for MIT and Heimdal Kerberos for detecting KDCs using Windows semantics.

DESCRIPTION

- This plugin is part of the samba(7) suite. -

- winbind_krb5_locator is a plugin that permits MIT and - Heimdal Kerberos libraries to detect Kerberos Servers (for the KDC and - kpasswd service) using the same semantics that other tools of the Samba - suite use. This include site-aware DNS service record lookups and caching - of closest dc. - The plugin uses the public locator API provided by most modern Kerberos - implementations. -

PREREQUISITES

- MIT Kerberos (at least version 1.5) or Heimdal Kerberos (at least version - 1.0) is required. -

- The plugin queries the winbindd(8) daemon which needs to be configured - and started separately. -

- The winbind_krb5_locator.so file needs to be manually - copied to the plugin directory of the system Kerberos library. - - For MIT Kerberos this is often: - /usr/lib/krb5/plugins/libkrb5/. - For Heimdal Kerberos this is often: - /usr/lib/plugin/krb5/. - - Please check your local Kerberos installation for the correct - paths. No modification in /etc/krb5.conf - is required to enable the use of this plugin. -

- After copying the locator plugin to the appropriate plugin - directory it should immediately be available for use. - Users should be able to kinit into their kerberized Windows - environment without any modification or servers - being put manually into /etc/krb5.conf. -

VERSION

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

AUTHOR

- The original Samba software and related utilities were created by Andrew - Tridgell. Samba is now developed by the Samba Team as an Open Source - project similar to the way the Linux kernel is developed. -

- The winbind_krb5_locator manpage was written by Guenther Deschner. -

diff --git a/docs/htmldocs/manpages/winbindd.8.html b/docs/htmldocs/manpages/winbindd.8.html deleted file mode 100644 index 4619069ecf..0000000000 --- a/docs/htmldocs/manpages/winbindd.8.html +++ /dev/null @@ -1,239 +0,0 @@ -winbindd

Name

winbindd — Name Service Switch daemon for resolving names - from NT servers

Synopsis

winbindd [-D] [-F] [-S] [-i] [-Y] [-d <debug level>] [-s <smb config file>] [-n]

DESCRIPTION

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 arbitrary 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 configuration the - idmap config * : range - parameter is 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 - through 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:

hosts

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

passwd

User information traditionally stored in - the passwd(5) file and used by - getpwent(3) functions.

group

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: use winbind to resolve hosts:
-# hosts:        files dns winbind
-## All other NSS enabled systems should use libnss_wins.so like this:
-hosts:          files dns wins
-
-

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
-

OPTIONS

-D

If specified, this parameter causes - the server to operate as a daemon. That is, it detaches - itself and runs in the background on the appropriate port. - This switch is assumed if winbindd is - executed on the command line of a shell. -

-F

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

-S

If specified, this parameter causes - winbindd to log to standard output rather - than a file.

-d|--debuglevel=level

level is an integer -from 0 to 10. The default value if this parameter is -not specified is 0.

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.

-V|--version

Prints the program version number. -

-s|--configfile <configuration file>

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.

-l|--log-basename=logdirectory

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

-h|--help

Print a summary of command line options. -

-i

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

-n

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

-Y

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

NAME AND ID RESOLUTION

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

CONFIGURATION

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.

EXAMPLE SETUP

- 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_unix.so \
-                  use_first_pass shadow nullok
-

-

Note

- The PAM module pam_unix has recently replaced the module pam_pwdb. - Some Linux systems use the module pam_unix2 in place of pam_unix. -

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 config * : range = 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.

NOTES

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 idmap config * : backend 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.

SIGNALS

The following signals can be used to manipulate the - winbindd daemon.

SIGHUP

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.

SIGUSR2

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.

FILES

/etc/nsswitch.conf(5)

Name service switch configuration file.

/tmp/.winbindd/pipe

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.

$LOCKDIR/winbindd_privileged/pipe

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.

/lib/libnss_winbind.so.X

Implementation of name service switch library. -

$LOCKDIR/winbindd_idmap.tdb

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

$LOCKDIR/winbindd_cache.tdb

Storage for cached user and group information. -

VERSION

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

SEE ALSO

nsswitch.conf(5), samba(7), wbinfo(1), ntlm_auth(8), smb.conf(5), pam_winbind(8)

AUTHOR

The original Samba software and related utilities - were created by Andrew Tridgell. Samba is now developed - by the Samba Team as an Open Source project similar - to the way the Linux kernel is developed.

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.

-- cgit v1.2.3