User Commands TESTPARM(1)
NAME
testparm - check an smb.conf configuration file for internal
correctness
SYNOPSIS
testparm [-s] [-h] [-v] [-L ] [-t ]
{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(1M)
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
Prints the program version number.
-L servername
Sets the value of the %L macro to servername. This is
useful for testing include files specified with the %L
macro.
-v
If this option is specified, testparm will also output
all options that were not used in smb.conf(4) and are
thus set to their defaults.
Samba 3.0 Last change: 01/19/2009 1
User Commands TESTPARM(1)
-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. Therfore
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(4) 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(4) 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(4)
This is usually the name of the configuration file used
by smbd(1M).
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.0 of the Samba suite.
SEE ALSO
smb.conf(4), smbd(1M)
AUTHOR
The original Samba software and related utilities were
created by Andrew Tridgell. Samba is now developed by the
Samba 3.0 Last change: 01/19/2009 2
User Commands TESTPARM(1)
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.
ATRIBUTES
See attributes(5) for descriptions of the following
attributes:
ATRIBUTE TYPE ATRIBUTE VALUE
Availability SUNWsmbar, SUNWsmbau
Interface Stability External
NOTES
Source for Samba is available on http:/opensolaris.org.
Samba(7) delivers the set of four SMF(5) services as can be
seen from the following example:
$ svcs samba wins winbind swat
STATE STIME FMRI
disabled Apr21 svc:/network/samba:default
disabled Apr21 svc:/network/winbind:default
disabled Apr21 svc:/network/wins:default
disabled Apr21 svc:/network/swat:default
where the services are:
"samba"
runs the smbd daemon managing the CIFS sessions
"wins"
runs the nmbd daemon enabling the browsing (WINS)
"winbind"
runs the winbindd daemon making the domain idmap
"swat"
Samba Web Administration Tool is a service providing
access to browser-based Samba administration interface
and on-line documentation. The service runs on software
loopback network interface on port 901/tcp, i.e. opening
Samba 3.0 Last change: 01/19/2009 3
User Commands TESTPARM(1)
"http:/localhost:901/" in browser will access the SWAT
service on local machine.
Please note: SWAT uses HTP Basic Authentication scheme
where user name and passwords are sent over the network in
clear text. In the SWAT case the user name is root.
Transferring such sensitive data is advisable only on the
software loopback network interface or over secure networks.
Samba 3.0 Last change: 01/19/2009 4
|
