Changeset 134 for branches/samba-3.0/docs/manpages/smbpasswd.8
- Timestamp:
- May 23, 2008, 6:56:41 AM (17 years ago)
- File:
-
- 1 edited
-
branches/samba-3.0/docs/manpages/smbpasswd.8 (modified) (3 diffs)
Legend:
- Unmodified
- Added
- Removed
-
branches/samba-3.0/docs/manpages/smbpasswd.8
r44 r134 1 .\"Generated by db2man.xsl. Don't modify this, modify the source. 2 .de Sh \" Subsection 3 .br 4 .if t .Sp 5 .ne 5 6 .PP 7 \fB\\$1\fR 8 .PP 9 .. 10 .de Sp \" Vertical space (when we can't use .PP) 11 .if t .sp .5v 12 .if n .sp 13 .. 14 .de Ip \" List item 15 .br 16 .ie \\n(.$>=3 .ne \\$3 17 .el .ne 3 18 .IP "\\$1" \\$2 19 .. 20 .TH "SMBPASSWD" 8 "" "" "" 1 .\" Title: smbpasswd 2 .\" Author: 3 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/> 4 .\" Date: 05/21/2008 5 .\" Manual: System Administration tools 6 .\" Source: Samba 3.0 7 .\" 8 .TH "SMBPASSWD" "8" "05/21/2008" "Samba 3\.0" "System Administration tools" 9 .\" disable hyphenation 10 .nh 11 .\" disable justification (adjust text to left margin only) 12 .ad l 21 13 .SH "NAME" 22 14 smbpasswd - change a user's SMB password 23 15 .SH "SYNOPSIS" 24 16 .HP 1 25 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]17 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] 26 18 .SH "DESCRIPTION" 27 19 .PP 28 20 This tool is part of the 29 21 \fBsamba\fR(7) 30 suite .22 suite\. 31 23 .PP 32 24 The smbpasswd program has several different functions, depending on whether it is run by the 33 \f Broot\fR34 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.35 .PP 36 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 the25 \fIroot\fR 26 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\. 27 .PP 28 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 37 29 passwd(1) 38 program works .30 program works\. 39 31 smbpasswd 40 32 differs from how the passwd program works however in that it is not 41 \f Bsetuid root\fR42 but works in a client -server mode and communicates with a locally running43 \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 the33 \fIsetuid root\fR 34 but works in a client\-server mode and communicates with a locally running 35 \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 44 36 \fBsmbpasswd\fR(5) 45 file .46 .PP 47 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.48 .PP 49 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) and50 \fI -U\fR51 options below .52 .PP 53 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,37 file\. 38 .PP 39 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\. 40 .PP 41 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 42 \fI\-U\fR 43 options below\. 44 .PP 45 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, 54 46 smbpasswd 55 accesses the local smbpasswd file directly, thus enabling changes to be made even if smbd is not running .47 accesses the local smbpasswd file directly, thus enabling changes to be made even if smbd is not running\. 56 48 .SH "OPTIONS" 57 49 .PP 58 -a59 .RS 3n60 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 (usually61 \fI/etc/passwd\fR), else the request to add the user will fail .62 .sp 63 This option is only available when running smbpasswd as root .64 .RE 65 .PP 66 -c67 .RS 3n50 \-a 51 .RS 4 52 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 53 \fI/etc/passwd\fR), else the request to add the user will fail\. 54 .sp 55 This option is only available when running smbpasswd as root\. 56 .RE 57 .PP 58 \-c 59 .RS 4 68 60 This option can be used to specify the path and file name of the 69 \fIsmb .conf\fR70 configuration file when it is important to use other than the default file and / or location .71 .RE 72 .PP 73 -x74 .RS 3n75 This option specifies that the username following should be deleted from the local smbpasswd file .76 .sp 77 This option is only available when running smbpasswd as root .78 .RE 79 .PP 80 -d81 .RS 3n61 \fIsmb\.conf\fR 62 configuration file when it is important to use other than the default file and / or location\. 63 .RE 64 .PP 65 \-x 66 .RS 4 67 This option specifies that the username following should be deleted from the local smbpasswd file\. 68 .sp 69 This option is only available when running smbpasswd as root\. 70 .RE 71 .PP 72 \-d 73 .RS 4 82 74 This option specifies that the username following should be 83 75 \fBdisabled\fR 84 in the local smbpasswd file . This is done by writing a85 \fB 'D'\fR86 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.87 .sp 88 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. See76 in the local smbpasswd file\. This is done by writing a 77 \fB\'D\'\fR 78 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\. 79 .sp 80 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 89 81 \fBsmbpasswd\fR(5) 90 for details on the 'old' and new password file formats.91 .sp 92 This option is only available when running smbpasswd as root .93 .RE 94 .PP 95 -e96 .RS 3n82 for details on the \'old\' and new password file formats\. 83 .sp 84 This option is only available when running smbpasswd as root\. 85 .RE 86 .PP 87 \-e 88 .RS 4 97 89 This option specifies that the username following should be 98 90 \fBenabled\fR 99 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.100 .sp 101 If the smbpasswd file is in the 'old' format, then91 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\. 92 .sp 93 If the smbpasswd file is in the \'old\' format, then 102 94 smbpasswd 103 will FAIL to enable the account . See95 will FAIL to enable the account\. See 104 96 \fBsmbpasswd\fR(5) 105 for details on the 'old' and new password file formats.106 .sp 107 This option is only available when running smbpasswd as root .108 .RE 109 .PP 110 -D debuglevel111 .RS 3n97 for details on the \'old\' and new password file formats\. 98 .sp 99 This option is only available when running smbpasswd as root\. 100 .RE 101 .PP 102 \-D debuglevel 103 .RS 4 112 104 \fIdebuglevel\fR 113 is an integer from 0 to 10 . The default value if this parameter is not specified is zero.114 .sp 115 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.116 .sp 117 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.118 .RE 119 .PP 120 -n121 .RS 3n122 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.105 is an integer from 0 to 10\. The default value if this parameter is not specified is zero\. 106 .sp 107 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\. 108 .sp 109 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\. 110 .RE 111 .PP 112 \-n 113 .RS 4 114 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\. 123 115 .sp 124 116 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 125 \fIsmb .conf\fR117 \fIsmb\.conf\fR 126 118 file : 127 119 .sp 128 120 null passwords = yes 129 121 .sp 130 This option is only available when running smbpasswd as root .131 .RE 132 .PP 133 -r remote machine name134 .RS 3n135 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. The122 This option is only available when running smbpasswd as root\. 123 .RE 124 .PP 125 \-r remote machine name 126 .RS 4 127 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 136 128 \fIremote machine name\fR 137 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 138 \fI-R name resolve order\fR 139 parameter for details on changing this resolving mechanism. 140 .sp 141 The username whose password is changed is that of the current UNIX logged on user. See the 142 \fI-U username\fR 143 parameter for details on changing the password for a different username. 144 .sp 145 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). 146 .sp 147 \fBNote\fR 148 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. 149 .RE 150 .PP 151 -R name resolve order 152 .RS 3n 153 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. 154 .sp 155 The options are :"lmhosts", "host", "wins" and "bcast". They cause names to be resolved as follows: 156 .RS 3n 157 .TP 3n 158 \(bu 159 \fBlmhosts\fR: 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 129 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 130 \fI\-R name resolve order\fR 131 parameter for details on changing this resolving mechanism\. 132 .sp 133 The username whose password is changed is that of the current UNIX logged on user\. See the 134 \fI\-U username\fR 135 parameter for details on changing the password for a different username\. 136 .sp 137 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)\. 138 .sp 139 \fINote\fR 140 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\. 141 .RE 142 .PP 143 \-R name resolve order 144 .RS 4 145 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\. 146 .sp 147 The options are :"lmhosts", "host", "wins" and "bcast"\. They cause names to be resolved as follows: 148 .sp 149 .RS 4 150 .ie n \{\ 151 \h'-04'\(bu\h'+03'\c 152 .\} 153 .el \{\ 154 .sp -1 155 .IP \(bu 2.3 156 .\} 157 \fBlmhosts\fR: 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 160 158 \fBlmhosts\fR(5) 161 for details) then any name type matches for lookup. 162 .TP 3n 163 \(bu 159 for details) then any name type matches for lookup\. 160 .RE 161 .sp 162 .RS 4 163 .ie n \{\ 164 \h'-04'\(bu\h'+03'\c 165 .\} 166 .el \{\ 167 .sp -1 168 .IP \(bu 2.3 169 .\} 164 170 \fBhost\fR: Do a standard host name to IP address resolution, using the system 165 \fI/etc/hosts \fR, 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 166 \fI/etc/nsswitch.conf\fR 167 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. 168 .TP 3n 169 \(bu 171 \fI/etc/hosts \fR, 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 172 \fI/etc/nsswitch\.conf\fR 173 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\. 174 .RE 175 .sp 176 .RS 4 177 .ie n \{\ 178 \h'-04'\(bu\h'+03'\c 179 .\} 180 .el \{\ 181 .sp -1 182 .IP \(bu 2.3 183 .\} 170 184 \fBwins\fR: Query a name with the IP address listed in the 171 185 \fIwins server\fR 172 parameter. If no WINS server has been specified this method will be ignored. 173 .TP 3n 174 \(bu 186 parameter\. If no WINS server has been specified this method will be ignored\. 187 .RE 188 .sp 189 .RS 4 190 .ie n \{\ 191 \h'-04'\(bu\h'+03'\c 192 .\} 193 .el \{\ 194 .sp -1 195 .IP \(bu 2.3 196 .\} 175 197 \fBbcast\fR: Do a broadcast on each of the known local interfaces listed in the 176 198 \fIinterfaces\fR 177 parameter . This is the least reliable of the name resolution methods as it depends on the target host being on a locally connected subnet.178 . RE179 . IP "" 3n199 parameter\. This is the least reliable of the name resolution methods as it depends on the target host being on a locally connected subnet\. 200 .sp 201 .RE 180 202 The default order is 181 203 lmhosts, host, wins, bcast 182 204 and without this parameter or any entry in the 183 205 \fBsmb.conf\fR(5) 184 file the name resolution methods will be attempted in this order .185 .RE 186 .PP 187 -m188 .RS 3n189 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.190 .sp 191 This option is only available when running smbpasswd as root .192 .RE 193 .PP 194 -U username195 .RS 3n206 file the name resolution methods will be attempted in this order\. 207 .RE 208 .PP 209 \-m 210 .RS 4 211 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\. 212 .sp 213 This option is only available when running smbpasswd as root\. 214 .RE 215 .PP 216 \-U username 217 .RS 4 196 218 This option may only be used in conjunction with the 197 \fI -r\fR198 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.199 .RE 200 .PP 201 -h202 .RS 3n219 \fI\-r\fR 220 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\. 221 .RE 222 .PP 223 \-h 224 .RS 4 203 225 This option prints the help string for 204 smbpasswd, selecting the correct one for running as root or as an ordinary user .205 .RE 206 .PP 207 -s208 .RS 3n209 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 from226 smbpasswd, selecting the correct one for running as root or as an ordinary user\. 227 .RE 228 .PP 229 \-s 230 .RS 4 231 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 210 232 \fI/dev/tty\fR 211 233 (like the 212 234 passwd(1) 213 program does) . This option is to aid people writing scripts to drive smbpasswd214 .RE 215 .PP 216 -w password217 .RS 3n218 This parameter is only available if Samba has been compiled with LDAP support . The219 \fI -w\fR235 program does)\. This option is to aid people writing scripts to drive smbpasswd 236 .RE 237 .PP 238 \-w password 239 .RS 4 240 This parameter is only available if Samba has been compiled with LDAP support\. The 241 \fI\-w\fR 220 242 switch is used to specify the password to be used with the 221 ldap admin dn. Note that the password is stored in the222 \fIsecrets .tdb\fR223 and is keyed off of the admin 's DN. This means that if the value of243 \fIldap admin dn\fR\. Note that the password is stored in the 244 \fIsecrets\.tdb\fR 245 and is keyed off of the admin\'s DN\. This means that if the value of 224 246 \fIldap admin dn\fR 225 ever changes, the password will need to be manually updated as well .226 .RE 227 .PP 228 -W229 .RS 3n247 ever changes, the password will need to be manually updated as well\. 248 .RE 249 .PP 250 \-W 251 .RS 4 230 252 NOTE: 231 This option is same as " -w" except that the password should be entered using stdin.232 .sp 233 This parameter is only available if Samba has been compiled with LDAP support . The234 \fI -W\fR253 This option is same as "\-w" except that the password should be entered using stdin\. 254 .sp 255 This parameter is only available if Samba has been compiled with LDAP support\. The 256 \fI\-W\fR 235 257 switch is used to specify the password to be used with the 236 ldap admin dn. Note that the password is stored in the237 \fIsecrets .tdb\fR238 and is keyed off of the admin 's DN. This means that if the value of258 \fIldap admin dn\fR\. Note that the password is stored in the 259 \fIsecrets\.tdb\fR 260 and is keyed off of the admin\'s DN\. This means that if the value of 239 261 \fIldap admin dn\fR 240 ever changes, the password will need to be manually updated as well .241 .RE 242 .PP 243 -i244 .RS 3n245 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.246 .sp 247 This option is only available when running smbpasswd as root .248 .RE 249 .PP 250 -L251 .RS 3n252 Run in local mode .262 ever changes, the password will need to be manually updated as well\. 263 .RE 264 .PP 265 \-i 266 .RS 4 267 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\. 268 .sp 269 This option is only available when running smbpasswd as root\. 270 .RE 271 .PP 272 \-L 273 .RS 4 274 Run in local mode\. 253 275 .RE 254 276 .PP 255 277 username 256 .RS 3n278 .RS 4 257 279 This specifies the username for all of the 258 \f Broot only\fR259 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.280 \fIroot only\fR 281 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\. 260 282 .RE 261 283 .SH "NOTES" … … 263 285 Since 264 286 smbpasswd 265 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 the287 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 266 288 smbd 267 289 running on the local machine by specifying either … … 271 293 entry in the 272 294 \fBsmb.conf\fR(5) 273 file and neglecting to allow "localhost" access to the smbd .274 .PP 275 In addition, the smbpasswd command is only useful if Samba has been set up to use encrypted passwords .295 file and neglecting to allow "localhost" access to the smbd\. 296 .PP 297 In addition, the smbpasswd command is only useful if Samba has been set up to use encrypted passwords\. 276 298 .SH "VERSION" 277 299 .PP 278 This man page is correct for version 3 .0 of the Samba suite.300 This man page is correct for version 3\.0 of the Samba suite\. 279 301 .SH "SEE ALSO" 280 302 .PP 281 303 \fBsmbpasswd\fR(5), 282 \fBSamba\fR(7) .304 \fBSamba\fR(7)\. 283 305 .SH "AUTHOR" 284 306 .PP 285 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. 286 .PP 287 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 288 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. 289 307 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\. 308 .PP 309 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 310 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\.
Note:
See TracChangeset
for help on using the changeset viewer.
