Changeset 39 for trunk/samba/docs/manpages/pdbedit.8
- Timestamp:
- May 27, 2007, 12:26:26 AM (18 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/samba/docs/manpages/pdbedit.8
r1 r39 19 19 .. 20 20 .TH "PDBEDIT" 8 "" "" "" 21 .SH NAME22 pdbedit \- manage the SAM database (Database of Samba Users)21 .SH "NAME" 22 pdbedit - manage the SAM database (Database of Samba Users) 23 23 .SH "SYNOPSIS" 24 .ad l25 .hy 026 24 .HP 8 27 \fBpdbedit\fR [\-L] [\-v] [\-w] [\-u\ username] [\-f\ fullname] [\-h\ homedir] [\-D\ drive] [\-S\ script] [\-p\ profile] [\-a] [\-t,\ \-\-password\-from\-stdin] [\-m] [\-r] [\-x] [\-i\ passdb\-backend] [\-e\ passdb\-backend] [\-b\ passdb\-backend] [\-g] [\-d\ debuglevel] [\-s\ configfile] [\-P\ account\-policy] [\-C\ value] [\-c\ account\-control] [\-y] 28 .ad 29 .hy 30 25 \fBpdbedit\fR [-L] [-v] [-w] [-u username] [-f fullname] [-h homedir] [-D drive] [-S script] [-p profile] [-a] [-t, --password-from-stdin] [-m] [-r] [-x] [-i passdb-backend] [-e passdb-backend] [-b passdb-backend] [-g] [-d debuglevel] [-s configfile] [-P account-policy] [-C value] [-c account-control] [-y] 31 26 .SH "DESCRIPTION" 32 33 .PP 34 This tool is part of the \fBsamba\fR(7) suite\&. 35 36 .PP 37 The pdbedit program is used to manage the users accounts stored in the sam database and can only be run by root\&. 38 39 .PP 40 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)\&. 41 42 .PP 43 There are five main ways to use pdbedit: adding a user account, removing a user account, modifing a user account, listing user accounts, importing users accounts\&. 44 27 .PP 28 This tool is part of the 29 \fBsamba\fR(7) 30 suite. 31 .PP 32 The pdbedit program is used to manage the users accounts stored in the sam database and can only be run by root. 33 .PP 34 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). 35 .PP 36 There are five main ways to use pdbedit: adding a user account, removing a user account, modifing a user account, listing user accounts, importing users accounts. 45 37 .SH "OPTIONS" 46 47 .TP 48 \-L 49 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\&. 50 51 Example: \fBpdbedit \-L\fR 52 53 38 .PP 39 -L 40 .RS 3n 41 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. 42 .sp 43 Example: 44 \fBpdbedit -L\fR 45 .sp 46 47 .sp 54 48 55 49 .nf … … 60 54 .fi 61 55 62 63 .TP 64 \-v 65 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\&. 66 67 Example: \fBpdbedit \-L \-v\fR 68 69 70 71 .nf 72 73 \-\-\-\-\-\-\-\-\-\-\-\-\-\-\- 56 .RE 57 .PP 58 -v 59 .RS 3n 60 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. 61 .sp 62 Example: 63 \fBpdbedit -L -v\fR 64 .sp 65 66 .sp 67 68 .nf 69 70 --------------- 74 71 username: sorce 75 72 user ID/Group: 500/500 76 73 user RID/GRID: 2000/2001 77 74 Full Name: Simo Sorce 78 Home Directory: \\ \\BERSERKER\\sorce75 Home Directory: \\BERSERKER\sorce 79 76 HomeDir Drive: H: 80 Logon Script: \\ \\BERSERKER\\netlogon\\sorce\&.bat81 Profile Path: \\ \\BERSERKER\\profile82 \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-77 Logon Script: \\BERSERKER\netlogon\sorce.bat 78 Profile Path: \\BERSERKER\profile 79 --------------- 83 80 username: samba 84 81 user ID/Group: 45/45 85 82 user RID/GRID: 1090/1091 86 83 Full Name: Test User 87 Home Directory: \\ \\BERSERKER\\samba84 Home Directory: \\BERSERKER\samba 88 85 HomeDir Drive: 89 86 Logon Script: 90 Profile Path: \\\\BERSERKER\\profile 91 92 .fi 93 94 95 .TP 96 \-w 97 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\fIsmbpasswd\fR file format\&. (see the\fBsmbpasswd\fR(5) for details) 98 99 Example: \fBpdbedit \-L \-w\fR 87 Profile Path: \\BERSERKER\profile 88 89 .fi 90 91 .RE 92 .PP 93 -w 94 .RS 3n 95 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 96 \fIsmbpasswd\fR 97 file format. (see the 98 \fBsmbpasswd\fR(5) 99 for details) 100 .sp 101 Example: 102 \fBpdbedit -L -w\fR 100 103 101 104 .nf … … 103 106 sorce:500:508818B733CE64BEAAD3B435B51404EE: 104 107 D2A2418EFC466A8A0F6B1DBB5C3DB80C: 105 [UX ]:LCT \-00000000:108 [UX ]:LCT-00000000: 106 109 samba:45:0F2B255F7B67A7A9AAD3B435B51404EE: 107 110 BC281CE3F53B6A5146629CD4751D3490: 108 [UX ]:LCT\-3BFA1E8D: 109 110 .fi 111 112 .TP 113 \-u username 114 This option specifies the username to be used for the operation requested (listing, adding, removing)\&. It is \fBrequired\fR in add, remove and modify operations and \fBoptional\fR in list operations\&. 115 116 .TP 117 \-f fullname 118 This option can be used while adding or modifing a user account\&. It will specify the user's full name\&. 119 120 Example: \fB\-f "Simo Sorce"\fR 121 122 .TP 123 \-h homedir 124 This option can be used while adding or modifing a user account\&. It will specify the user's home directory network path\&. 125 126 Example: \fB\-h "\\\\\\\\BERSERKER\\\\sorce"\fR 127 128 .TP 129 \-D drive 130 This option can be used while adding or modifing a user account\&. It will specify the windows drive letter to be used to map the home directory\&. 131 132 Example: \fB\-D "H:"\fR 133 134 .TP 135 \-S script 136 This option can be used while adding or modifing a user account\&. It will specify the user's logon script path\&. 137 138 Example: \fB\-S "\\\\\\\\BERSERKER\\\\netlogon\\\\sorce\&.bat"\fR 139 140 .TP 141 \-p profile 142 This option can be used while adding or modifing a user account\&. It will specify the user's profile directory\&. 143 144 Example: \fB\-p "\\\\\\\\BERSERKER\\\\netlogon"\fR 145 146 .TP 147 \-G SID|rid 148 This option can be used while adding or modifying a user account\&. It will specify the users' new primary group SID (Security Identifier) or rid\&. 149 150 Example: \fB\-G S\-1\-5\-21\-2447931902\-1787058256\-3961074038\-1201\fR 151 152 .TP 153 \-U SID|rid 154 This option can be used while adding or modifying a user account\&. It will specify the users' new SID (Security Identifier) or rid\&. 155 156 Example: \fB\-U S\-1\-5\-21\-2447931902\-1787058256\-3961074038\-5004\fR 157 158 .TP 159 \-c account\-control 160 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\&. 161 162 163 164 .RS 165 .TP 3 166 \(bu 111 [UX ]:LCT-3BFA1E8D: 112 113 .fi 114 .RE 115 .PP 116 -u username 117 .RS 3n 118 This option specifies the username to be used for the operation requested (listing, adding, removing). It is 119 \fBrequired\fR 120 in add, remove and modify operations and 121 \fBoptional\fR 122 in list operations. 123 .RE 124 .PP 125 -f fullname 126 .RS 3n 127 This option can be used while adding or modifing a user account. It will specify the user's full name. 128 .sp 129 Example: 130 \fB-f "Simo Sorce"\fR 131 .RE 132 .PP 133 -h homedir 134 .RS 3n 135 This option can be used while adding or modifing a user account. It will specify the user's home directory network path. 136 .sp 137 Example: 138 \fB-h "\\\\BERSERKER\\sorce"\fR 139 .RE 140 .PP 141 -D drive 142 .RS 3n 143 This option can be used while adding or modifing a user account. It will specify the windows drive letter to be used to map the home directory. 144 .sp 145 Example: 146 \fB-D "H:"\fR 147 .RE 148 .PP 149 -S script 150 .RS 3n 151 This option can be used while adding or modifing a user account. It will specify the user's logon script path. 152 .sp 153 Example: 154 \fB-S "\\\\BERSERKER\\netlogon\\sorce.bat"\fR 155 .RE 156 .PP 157 -p profile 158 .RS 3n 159 This option can be used while adding or modifing a user account. It will specify the user's profile directory. 160 .sp 161 Example: 162 \fB-p "\\\\BERSERKER\\netlogon"\fR 163 .RE 164 .PP 165 -G SID|rid 166 .RS 3n 167 This option can be used while adding or modifying a user account. It will specify the users' new primary group SID (Security Identifier) or rid. 168 .sp 169 Example: 170 \fB-G S-1-5-21-2447931902-1787058256-3961074038-1201\fR 171 .RE 172 .PP 173 -U SID|rid 174 .RS 3n 175 This option can be used while adding or modifying a user account. It will specify the users' new SID (Security Identifier) or rid. 176 .sp 177 Example: 178 \fB-U S-1-5-21-2447931902-1787058256-3961074038-5004\fR 179 .RE 180 .PP 181 -c account-control 182 .RS 3n 183 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. 184 .sp 185 186 .RS 3n 187 .TP 3n 188 • 167 189 N: No password required 168 .TP 169 \(bu 190 .TP 3n 191 • 170 192 D: Account disabled 171 .TP 172 \(bu 193 .TP 3n 194 • 173 195 H: Home directory required 174 .TP 175 \(bu 196 .TP 3n 197 • 176 198 T: Temporary duplicate of other account 177 .TP 178 \(bu 199 .TP 3n 200 • 179 201 U: Regular user account 180 .TP 181 \(bu 202 .TP 3n 203 • 182 204 M: MNS logon user account 183 .TP 184 \(bu 205 .TP 3n 206 • 185 207 W: Workstation Trust Account 186 .TP 187 \(bu 208 .TP 3n 209 • 188 210 S: Server Trust Account 189 .TP 190 \(bu 211 .TP 3n 212 • 191 213 L: Automatic Locking 192 .TP 193 \(bu 214 .TP 3n 215 • 194 216 X: Password does not expire 195 .TP 196 \(bu 217 .TP 3n 218 • 197 219 I: Domain Trust Account 198 .LP 199 .RE 200 .IP 201 202 203 Example: \fB\-c "[X ]"\fR 204 205 .TP 206 \-a 207 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\&. 208 209 Example: \fBpdbedit \-a \-u sorce\fR 220 .RE 221 .IP "" 3n 222 223 .sp 224 Example: 225 \fB-c "[X ]"\fR 226 .RE 227 .PP 228 -a 229 .RS 3n 230 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. 231 .sp 232 Example: 233 \fBpdbedit -a -u sorce\fR 234 235 .sp 210 236 211 237 .nf … … 214 240 215 241 .fi 216 217 218 .RS 219 .Sh "Note" 220 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\&. 221 222 If you wish to add a user and synchronise the password that immediately, use \fBsmbpasswd\fR's \fB\-a\fR option\&. 223 224 .RE 225 226 .TP 227 \-t, \-\-password\-from\-stdin 228 This option causes pdbedit to read the password from standard input, rather than from /dev/tty (like the\fBpasswd(1)\fR program does)\&. The password has to be submitted twice and terminated by a newline each\&. 229 230 .TP 231 \-r 232 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\&. 233 234 .TP 235 \-m 236 This option may only be used in conjunction with the \fI\-a\fR option\&. It will make pdbedit to add a machine trust account instead of a user account (\-u username will provide the machine name)\&. 237 238 Example: \fBpdbedit \-a \-m \-u w2k\-wks\fR 239 240 .TP 241 \-x 242 This option causes pdbedit to delete an account from the database\&. It needs a username specified with the \-u switch\&. 243 244 Example: \fBpdbedit \-x \-u bob\fR 245 246 .TP 247 \-i passdb\-backend 248 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\&. 249 250 This option will ease migration from one passdb backend to another\&. 251 252 Example: \fBpdbedit \-i smbpasswd:/etc/smbpasswd\&.old \fR 253 254 .TP 255 \-e passdb\-backend 256 Exports all currently available users to the specified password database backend\&. 257 258 This option will ease migration from one passdb backend to another and will ease backing up\&. 259 260 Example: \fBpdbedit \-e smbpasswd:/root/samba\-users\&.backup\fR 261 262 .TP 263 \-g 264 If you specify \fI\-g\fR, then \fI\-i in\-backend \-e out\-backend\fR applies to the group mapping instead of the user database\&. 265 266 This option will ease migration from one passdb backend to another and will ease backing up\&. 267 268 .TP 269 \-b passdb\-backend 270 Use a different default passdb backend\&. 271 272 Example: \fBpdbedit \-b xml:/root/pdb\-backup\&.xml \-l\fR 273 274 .TP 275 \-P account\-policy 242 243 .sp 244 .it 1 an-trap 245 .nr an-no-space-flag 1 246 .nr an-break-flag 1 247 .br 248 \fBNote\fR 249 pdbedit does not call the unix password syncronisation script if 250 unix password sync has been set. It only updates the data in the Samba user database. 251 .sp 252 If you wish to add a user and synchronise the password that immediately, use 253 \fBsmbpasswd\fR's 254 \fB-a\fR 255 option. 256 .RE 257 .PP 258 -t, --password-from-stdin 259 .RS 3n 260 This option causes pdbedit to read the password from standard input, rather than from /dev/tty (like the 261 \fBpasswd(1)\fR 262 program does). The password has to be submitted twice and terminated by a newline each. 263 .RE 264 .PP 265 -r 266 .RS 3n 267 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. 268 .RE 269 .PP 270 -m 271 .RS 3n 272 This option may only be used in conjunction with the 273 \fI-a\fR 274 option. It will make pdbedit to add a machine trust account instead of a user account (-u username will provide the machine name). 275 .sp 276 Example: 277 \fBpdbedit -a -m -u w2k-wks\fR 278 .RE 279 .PP 280 -x 281 .RS 3n 282 This option causes pdbedit to delete an account from the database. It needs a username specified with the -u switch. 283 .sp 284 Example: 285 \fBpdbedit -x -u bob\fR 286 .RE 287 .PP 288 -i passdb-backend 289 .RS 3n 290 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. 291 .sp 292 This option will ease migration from one passdb backend to another. 293 .sp 294 Example: 295 \fBpdbedit -i smbpasswd:/etc/smbpasswd.old \fR 296 .RE 297 .PP 298 -e passdb-backend 299 .RS 3n 300 Exports all currently available users to the specified password database backend. 301 .sp 302 This option will ease migration from one passdb backend to another and will ease backing up. 303 .sp 304 Example: 305 \fBpdbedit -e smbpasswd:/root/samba-users.backup\fR 306 .RE 307 .PP 308 -g 309 .RS 3n 310 If you specify 311 \fI-g\fR, then 312 \fI-i in-backend -e out-backend\fR 313 applies to the group mapping instead of the user database. 314 .sp 315 This option will ease migration from one passdb backend to another and will ease backing up. 316 .RE 317 .PP 318 -b passdb-backend 319 .RS 3n 320 Use a different default passdb backend. 321 .sp 322 Example: 323 \fBpdbedit -b xml:/root/pdb-backup.xml -l\fR 324 .RE 325 .PP 326 -P account-policy 327 .RS 3n 276 328 Display an account policy 277 278 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\&. 279 280 Example: \fBpdbedit \-P "bad lockout attempt"\fR 281 282 329 .sp 330 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. 331 .sp 332 Example: 333 \fBpdbedit -P "bad lockout attempt"\fR 334 .sp 335 336 .sp 283 337 284 338 .nf … … 288 342 .fi 289 343 290 291 .TP 292 \-C account\-policy\-value 293 Sets an account policy to a specified value\&. This option may only be used in conjunction with the \fI\-P\fR option\&. 294 295 Example: \fBpdbedit \-P "bad lockout attempt" \-C 3\fR 296 297 344 .RE 345 .PP 346 -C account-policy-value 347 .RS 3n 348 Sets an account policy to a specified value. This option may only be used in conjunction with the 349 \fI-P\fR 350 option. 351 .sp 352 Example: 353 \fBpdbedit -P "bad lockout attempt" -C 3\fR 354 .sp 355 356 .sp 298 357 299 358 .nf … … 304 363 .fi 305 364 306 307 .TP 308 \-y 309 If you specify \fI\-y\fR, then \fI\-i in\-backend \-e out\-backend\fR applies to the account policies instead of the user database\&. 310 311 This option will allow to migrate account policies from their default tdb\-store into a passdb backend, e\&.g\&. an LDAP directory server\&. 312 313 Example: \fBpdbedit \-y \-i tdbsam: \-e ldapsam:ldap://my\&.ldap\&.host\fR 314 315 .TP 316 \-h|\-\-help 317 Print a summary of command line options\&. 318 319 .TP 320 \-V 321 Prints the program version number\&. 322 323 .TP 324 \-s <configuration file> 325 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 \fIsmb\&.conf\fR for more information\&. The default configuration file name is determined at compile time\&. 326 327 .TP 328 \-d|\-\-debuglevel=level 329 \fIlevel\fR is an integer from 0 to 10\&. The default value if this parameter is not specified is zero\&. 330 331 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\&. 332 333 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\&. 334 335 Note that specifying this parameter here will override the parameter in the \fIsmb\&.conf\fR file\&. 336 337 .TP 338 \-l|\-\-logfile=logdirectory 339 Base directory name for log/debug files\&. The extension \fB"\&.progname"\fR will be appended (e\&.g\&. log\&.smbclient, log\&.smbd, etc\&.\&.\&.)\&. The log file is never removed by the client\&. 340 365 .RE 366 .PP 367 -y 368 .RS 3n 369 If you specify 370 \fI-y\fR, then 371 \fI-i in-backend -e out-backend\fR 372 applies to the account policies instead of the user database. 373 .sp 374 This option will allow to migrate account policies from their default tdb-store into a passdb backend, e.g. an LDAP directory server. 375 .sp 376 Example: 377 \fBpdbedit -y -i tdbsam: -e ldapsam:ldap://my.ldap.host\fR 378 .RE 379 .PP 380 -h|--help 381 .RS 3n 382 Print a summary of command line options. 383 .RE 384 .PP 385 -V 386 .RS 3n 387 Prints the program version number. 388 .RE 389 .PP 390 -s <configuration file> 391 .RS 3n 392 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 393 \fIsmb.conf\fR 394 for more information. The default configuration file name is determined at compile time. 395 .RE 396 .PP 397 -d|--debuglevel=level 398 .RS 3n 399 \fIlevel\fR 400 is an integer from 0 to 10. The default value if this parameter is not specified is zero. 401 .sp 402 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. 403 .sp 404 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. 405 .sp 406 Note that specifying this parameter here will override the 407 408 parameter in the 409 \fIsmb.conf\fR 410 file. 411 .RE 412 .PP 413 -l|--logfile=logdirectory 414 .RS 3n 415 Base directory name for log/debug files. The extension 416 \fB".progname"\fR 417 will be appended (e.g. log.smbclient, log.smbd, etc...). The log file is never removed by the client. 418 .RE 341 419 .SH "NOTES" 342 343 .PP 344 This command may be used only by root\&. 345 420 .PP 421 This command may be used only by root. 346 422 .SH "VERSION" 347 348 .PP 349 This man page is correct for version 3\&.0 of the Samba suite\&. 350 423 .PP 424 This man page is correct for version 3.0 of the Samba suite. 351 425 .SH "SEE ALSO" 352 353 .PP 354 \fBsmbpasswd\fR(5), \fBsamba\fR(7) 355 426 .PP 427 \fBsmbpasswd\fR(5), 428 \fBsamba\fR(7) 356 429 .SH "AUTHOR" 357 358 .PP 359 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\&. 360 361 .PP 362 The pdbedit manpage was written by Simo Sorce and Jelmer Vernooij\&. 363 430 .PP 431 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. 432 .PP 433 The pdbedit manpage was written by Simo Sorce and Jelmer Vernooij. 434
Note:
See TracChangeset
for help on using the changeset viewer.