source: branches/samba-3.2.x/docs/manpages/smbpasswd.8@ 202

.\"     Title: smbpasswd
.\"    Author: 
.\" Generator: DocBook XSL Stylesheets v1.73.1 <http://docbook.sf.net/>
.\"      Date: 08/27/2008
.\"    Manual: System Administration tools
.\"    Source: Samba 3.2
.\"
.TH "SMBPASSWD" "8" "08/27/2008" "Samba 3\.2" "System Administration tools"
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
smbpasswd - change a user's SMB password
.SH "SYNOPSIS"
.HP 1
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]
.SH "DESCRIPTION"
.PP
This tool is part of the
\fBsamba\fR(7)
suite\.
.PP
The smbpasswd program has several different functions, depending on whether it is run by the
\fIroot\fR
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\.
.PP
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
\fIsetuid root\fR
but works in a client\-server mode and communicates with a locally running
\fBsmbd\fR(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
\fBsmbpasswd\fR(5)
file\.
.PP
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\.
.PP
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 (\fI\-r\fR) and
\fI\-U\fR
options below\.
.PP
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\.
.SH "OPTIONS"
.PP
\-a
.RS 4
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
\fI/etc/passwd\fR), else the request to add the user will fail\.
.sp
This option is only available when running smbpasswd as root\.
.RE
.PP
\-c
.RS 4
This option can be used to specify the path and file name of the
\fIsmb\.conf\fR
configuration file when it is important to use other than the default file and / or location\.
.RE
.PP
\-x
.RS 4
This option specifies that the username following should be deleted from the local smbpasswd file\.
.sp
This option is only available when running smbpasswd as root\.
.RE
.PP
\-d
.RS 4
This option specifies that the username following should be
\fBdisabled\fR
in the local smbpasswd file\. This is done by writing a
\fB\'D\'\fR
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\.
.sp
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
\fBsmbpasswd\fR(5)
for details on the \'old\' and new password file formats\.
.sp
This option is only available when running smbpasswd as root\.
.RE
.PP
\-e
.RS 4
This option specifies that the username following should be
\fBenabled\fR
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\.
.sp
If the smbpasswd file is in the \'old\' format, then
smbpasswd
will FAIL to enable the account\. See
\fBsmbpasswd\fR(5)
for details on the \'old\' and new password file formats\.
.sp
This option is only available when running smbpasswd as root\.
.RE
.PP
\-D debuglevel
.RS 4
\fIdebuglevel\fR
is an integer from 0 to 10\. The default value if this parameter is not specified is zero\.
.sp
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\.
.sp
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\.
.RE
.PP
\-n
.RS 4