Debian Codegraph @

upstream/mageia-cauldron/man8/pdbedit.8

raw
1 '\" t
2 .\" Title: pdbedit
3 .\" Author: [see the "AUTHOR" section]
4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
5 .\" Date: 05/28/2026
6 .\" Manual: System Administration tools
7 .\" Source: Samba 4.23.8
8 .\" Language: English
9 .\"
10 .TH "PDBEDIT" "8" "05/28/2026" "Samba 4\&.23\&.8" "System Administration tools"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
30 .SH "NAME"
31 pdbedit \- manage the SAM database (Database of Samba Users)
32 .SH "SYNOPSIS"
33 .HP \w'\ 'u
34 pdbedit [\-L|\-\-list] [\-v|\-\-verbose] [\-w|\-\-smbpasswd\-style] [\-u|\-\-user=USER] [\-N|\-\-account\-desc=STRING] [\-f|\-\-fullname=STRING] [\-h|\-\-homedir=STRING] [\-D|\-\-drive=STRING] [\-S|\-\-script=STRING] [\-p|\-\-profile=STRING] [\-I|\-\-domain=STRING] [\-U|\-\-user\ SID=STRING] [\-M|\-\-machine\ SID=STRING] [\-a|\-\-create] [\-r|\-\-modify] [\-m|\-\-machine] [\-x|\-\-delete] [\-b|\-\-backend=STRING] [\-i|\-\-import=STRING] [\-e|\-\-export=STRING] [\-g|\-\-group] [\-y|\-\-policies] [\-\-policies\-reset] [\-P|\-\-account\-policy=STRING] [\-C|\-\-value=LONG] [\-c|\-\-account\-control=STRING] [\-\-force\-initialized\-passwords] [\-z|\-\-bad\-password\-count\-reset] [\-Z|\-\-logon\-hours\-reset] [\-\-time\-format=STRING] [\-t|\-\-password\-from\-stdin] [\-K|\-\-kickoff\-time=STRING] [\-\-set\-nt\-hash=STRING] [\-?|\-\-help] [\-\-usage] [\-d|\-\-debuglevel=DEBUGLEVEL] [\-\-debug\-stdout] [\-\-configfile=CONFIGFILE] [\-\-option=name=value] [\-l|\-\-log\-basename=LOGFILEBASE] [\-\-leak\-report] [\-\-leak\-report\-full]
35 .SH "DESCRIPTION"
36 .PP
37 This tool is part of the
38 \fBsamba\fR(7)
39 suite\&.
40 .PP
41 The pdbedit program is used to manage the users accounts stored in the sam database and can only be run by root\&.
42 .PP
43 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)\&.
44 .PP
45 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\&.
46 .SH "OPTIONS"
47 .PP
48 \-L|\-\-list
49 .RS 4
50 This option lists all the user accounts present in the users database\&. This option prints a list of user/uid pairs separated by the \*(Aq:\*(Aq character\&.
51 .sp
52 Example:
53 pdbedit \-L
54 .sp
55 .if n \{\
56 .RS 4
57 .\}
58 .nf
59 sorce:500:Simo Sorce
60 samba:45:Test User
61 .fi
62 .if n \{\
63 .RE
64 .\}
65 .RE
66 .PP
67 \-v|\-\-verbose
68 .RS 4
69 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\&. Used together with \-w also shows passwords hashes\&.
70 .sp
71 Example:
72 pdbedit \-L \-v
73 .sp
74 .if n \{\
75 .RS 4
76 .\}
77 .nf
78 \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
79 username: sorce
80 user ID/Group: 500/500
81 user RID/GRID: 2000/2001
82 Full Name: Simo Sorce
83 Home Directory: \e\eBERSERKER\esorce
84 HomeDir Drive: H:
85 Logon Script: \e\eBERSERKER\enetlogon\esorce\&.bat
86 Profile Path: \e\eBERSERKER\eprofile
87 \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
88 username: samba
89 user ID/Group: 45/45
90 user RID/GRID: 1090/1091
91 Full Name: Test User
92 Home Directory: \e\eBERSERKER\esamba
93 HomeDir Drive:
94 Logon Script:
95 Profile Path: \e\eBERSERKER\eprofile
96 .fi
97 .if n \{\
98 .RE
99 .\}
100 .RE
101 .PP
102 \-w|\-\-smbpasswd\-style
103 .RS 4
104 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
105 smbpasswd
106 file format\&. (see the
107 \fBsmbpasswd\fR(5)
108 for details)\&. Instead used together with (\-v) displays the passwords hashes in verbose output\&.
109 .sp
110 Example:
111 pdbedit \-L \-w
112 .sp
113 .if n \{\
114 .RS 4
115 .\}
116 .nf
117 sorce:500:508818B733CE64BEAAD3B435B51404EE:
118 D2A2418EFC466A8A0F6B1DBB5C3DB80C:
119 [UX ]:LCT\-00000000:
120 samba:45:0F2B255F7B67A7A9AAD3B435B51404EE:
121 BC281CE3F53B6A5146629CD4751D3490:
122 [UX ]:LCT\-3BFA1E8D:
123 .fi
124 .if n \{\
125 .RE
126 .\}
127 .RE
128 .PP
129 \-u|\-\-user username
130 .RS 4
131 This option specifies the username to be used for the operation requested (listing, adding, removing)\&. It is
132 \fIrequired\fR
133 in add, remove and modify operations and
134 \fIoptional\fR
135 in list operations\&.
136 .RE
137 .PP
138 \-f|\-\-fullname fullname
139 .RS 4
140 This option can be used while adding or modifying a user account\&. It will specify the user\*(Aqs full name\&.
141 .sp
142 Example:
143 \-f "Simo Sorce"
144 .RE
145 .PP
146 \-h|\-\-homedir homedir
147 .RS 4
148 This option can be used while adding or modifying a user account\&. It will specify the user\*(Aqs home directory network path\&.
149 .sp
150 Example:
151 \-h "\e\e\e\eBERSERKER\e\esorce"
152 .RE
153 .PP
154 \-D|\-\-drive drive
155 .RS 4
156 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\&.
157 .sp
158 Example:
159 \-D "H:"
160 .RE
161 .PP
162 \-S|\-\-script script
163 .RS 4
164 This option can be used while adding or modifying a user account\&. It will specify the user\*(Aqs logon script path\&.
165 .sp
166 Example:
167 \-S "\e\e\e\eBERSERKER\e\enetlogon\e\esorce\&.bat"
168 .RE
169 .PP
170 \-\-set\-nt\-hash
171 .RS 4
172 This option can be used while modifying a user account\&. It will set the user\*(Aqs password using the nt\-hash value given as hexadecimal string\&. Useful to synchronize passwords\&.
173 .sp
174 Example:
175 \-\-set\-nt\-hash 8846F7EAEE8FB117AD06BDD830B7586C
176 .RE
177 .PP
178 \-p|\-\-profile profile
179 .RS 4
180 This option can be used while adding or modifying a user account\&. It will specify the user\*(Aqs profile directory\&.
181 .sp
182 Example:
183 \-p "\e\e\e\eBERSERKER\e\enetlogon"
184 .RE
185 .PP
186 \-M|\*(Aq\-\-machine SID\*(Aq SID|rid
187 .RS 4
188 This option can be used while adding or modifying a machine account\&. It will specify the machines\*(Aq new primary group SID (Security Identifier) or rid\&.
189 .sp
190 Example:
191 \-M S\-1\-5\-21\-2447931902\-1787058256\-3961074038\-1201
192 .RE
193 .PP
194 \-U|\*(Aq\-\-user SID\*(Aq SID|rid
195 .RS 4
196 This option can be used while adding or modifying a user account\&. It will specify the users\*(Aq new SID (Security Identifier) or rid\&.
197 .sp
198 Example:
199 \-U S\-1\-5\-21\-2447931902\-1787058256\-3961074038\-5004
200 .sp
201 Example:
202 \*(Aq\-\-user SID\*(Aq S\-1\-5\-21\-2447931902\-1787058256\-3961074038\-5004
203 .sp
204 Example:
205 \-U 5004
206 .sp
207 Example:
208 \*(Aq\-\-user SID\*(Aq 5004
209 .RE
210 .PP
211 \-c|\-\-account\-control account\-control
212 .RS 4
213 This option can be used while adding or modifying a user account\&. It will specify the users\*(Aq account control property\&. Possible flags are listed below\&.
214 .sp
215 .RS
216 .sp
217 .RS 4
218 .ie n \{\
219 \h'-04'\(bu\h'+03'\c
220 .\}
221 .el \{\
222 .sp -1
223 .IP \(bu 2.3
224 .\}
225 N: No password required
226 .RE
227 .sp
228 .RS 4
229 .ie n \{\
230 \h'-04'\(bu\h'+03'\c
231 .\}
232 .el \{\
233 .sp -1
234 .IP \(bu 2.3
235 .\}
236 D: Account disabled
237 .RE
238 .sp
239 .RS 4
240 .ie n \{\
241 \h'-04'\(bu\h'+03'\c
242 .\}
243 .el \{\
244 .sp -1
245 .IP \(bu 2.3
246 .\}
247 H: Home directory required
248 .RE
249 .sp
250 .RS 4
251 .ie n \{\
252 \h'-04'\(bu\h'+03'\c
253 .\}
254 .el \{\
255 .sp -1
256 .IP \(bu 2.3
257 .\}
258 T: Temporary duplicate of other account
259 .RE
260 .sp
261 .RS 4
262 .ie n \{\
263 \h'-04'\(bu\h'+03'\c
264 .\}
265 .el \{\
266 .sp -1
267 .IP \(bu 2.3
268 .\}
269 U: Regular user account
270 .RE
271 .sp
272 .RS 4
273 .ie n \{\
274 \h'-04'\(bu\h'+03'\c
275 .\}
276 .el \{\
277 .sp -1
278 .IP \(bu 2.3
279 .\}
280 M: MNS logon user account
281 .RE
282 .sp
283 .RS 4
284 .ie n \{\
285 \h'-04'\(bu\h'+03'\c
286 .\}
287 .el \{\
288 .sp -1
289 .IP \(bu 2.3
290 .\}
291 W: Workstation Trust Account
292 .RE
293 .sp
294 .RS 4
295 .ie n \{\
296 \h'-04'\(bu\h'+03'\c
297 .\}
298 .el \{\
299 .sp -1
300 .IP \(bu 2.3
301 .\}
302 S: Server Trust Account
303 .RE
304 .sp
305 .RS 4
306 .ie n \{\
307 \h'-04'\(bu\h'+03'\c
308 .\}
309 .el \{\
310 .sp -1
311 .IP \(bu 2.3
312 .\}
313 L: Automatic Locking
314 .RE
315 .sp
316 .RS 4
317 .ie n \{\
318 \h'-04'\(bu\h'+03'\c
319 .\}
320 .el \{\
321 .sp -1
322 .IP \(bu 2.3
323 .\}
324 X: Password does not expire
325 .RE
326 .sp
327 .RS 4
328 .ie n \{\
329 \h'-04'\(bu\h'+03'\c
330 .\}
331 .el \{\
332 .sp -1
333 .IP \(bu 2.3
334 .\}
335 I: Domain Trust Account
336 .RE
337 .sp
338 .RE
339 .sp
340 Example:
341 \-c "[X ]"
342 .RE
343 .PP
344 \-K|\-\-kickoff\-time
345 .RS 4
346 This option is used to modify the kickoff time for a certain user\&. Use "never" as argument to set the kickoff time to unlimited\&.
347 .sp
348 Example:
349 pdbedit \-K never user
350 .RE
351 .PP
352 \-a|\-\-create
353 .RS 4
354 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\&.
355 .sp
356 Example:
357 pdbedit \-a \-u sorce
358 .sp
359 .if n \{\
360 .RS 4
361 .\}
362 .nf
363 new password:
364 retype new password
365 .fi
366 .if n \{\
367 .RE
368 .\}
369 .sp
370 .if n \{\
371 .sp
372 .\}
373 .RS 4
374 .it 1 an-trap
375 .nr an-no-space-flag 1
376 .nr an-break-flag 1
377 .br
378 .ps +1
379 \fBNote\fR
380 .ps -1
381 .br
382 pdbedit does not call the unix password synchronization script if
383 \m[blue]\fBunix password sync\fR\m[]
384 has been set\&. It only updates the data in the Samba user database\&.
385 .sp
386 If you wish to add a user and synchronise the password that immediately, use
387 smbpasswd\*(Aqs
388 \fB\-a\fR
389 option\&.
390 .sp .5v
391 .RE
392 .RE
393 .PP
394 \-t|\-\-password\-from\-stdin
395 .RS 4
396 This option causes pdbedit to read the password from standard input, rather than from /dev/tty (like the
397 passwd(1)
398 program does)\&. The password has to be submitted twice and terminated by a newline each\&.
399 .RE
400 .PP
401 \-r|\-\-modify
402 .RS 4
403 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\&.
404 .RE
405 .PP
406 \-m|\-\-machine
407 .RS 4
408 This option may only be used in conjunction with the
409 \fI\-a\fR
410 option\&. It will make pdbedit to add a machine trust account instead of a user account (\-u username will provide the machine name)\&.
411 .sp
412 Example:
413 pdbedit \-a \-m \-u w2k\-wks
414 .RE
415 .PP
416 \-x|\-\-delete
417 .RS 4
418 This option causes pdbedit to delete an account from the database\&. It needs a username specified with the \-u switch\&.
419 .sp
420 Example:
421 pdbedit \-x \-u bob
422 .RE
423 .PP
424 \-i|\-\-import passdb\-backend
425 .RS 4
426 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\&.
427 .sp
428 This option will ease migration from one passdb backend to another\&.
429 .sp
430 Example:
431 pdbedit \-i smbpasswd:/etc/smbpasswd\&.old
432 .RE
433 .PP
434 \-e|\-\-export passdb\-backend
435 .RS 4
436 Exports all currently available users to the specified password database backend\&.
437 .sp
438 This option will ease migration from one passdb backend to another and will ease backing up\&.
439 .sp
440 Example:
441 pdbedit \-e smbpasswd:/root/samba\-users\&.backup
442 .RE
443 .PP
444 \-g|\-\-group
445 .RS 4
446 If you specify
447 \fI\-g\fR, then
448 \fI\-i in\-backend \-e out\-backend\fR
449 applies to the group mapping instead of the user database\&.
450 .sp
451 This option will ease migration from one passdb backend to another and will ease backing up\&.
452 .RE
453 .PP
454 \-b|\-\-backend passdb\-backend
455 .RS 4
456 Use a different default passdb backend\&.
457 .sp
458 Example:
459 pdbedit \-b xml:/root/pdb\-backup\&.xml \-l
460 .RE
461 .PP
462 \-P|\-\-account\-policy account\-policy
463 .RS 4
464 Display an account policy
465 .sp
466 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\&.
467 .sp
468 Example:
469 pdbedit \-P "bad lockout attempt"
470 .sp
471 .if n \{\
472 .RS 4
473 .\}
474 .nf
475 account policy value for bad lockout attempt is 0
476 .fi
477 .if n \{\
478 .RE
479 .\}
480 .RE
481 .PP
482 \-C|\-\-value account\-policy\-value
483 .RS 4
484 Sets an account policy to a specified value\&. This option may only be used in conjunction with the
485 \fI\-P\fR
486 option\&.
487 .sp
488 Example:
489 pdbedit \-P "bad lockout attempt" \-C 3
490 .sp
491 .if n \{\
492 .RS 4
493 .\}
494 .nf
495 account policy value for bad lockout attempt was 0
496 account policy value for bad lockout attempt is now 3
497 .fi
498 .if n \{\
499 .RE
500 .\}
501 .RE
502 .PP
503 \-y|\-\-policies
504 .RS 4
505 If you specify
506 \fI\-y\fR, then
507 \fI\-i in\-backend \-e out\-backend\fR
508 applies to the account policies instead of the user database\&.
509 .sp
510 This option will allow one to migrate account policies from their default tdb\-store into a passdb backend, e\&.g\&. an LDAP directory server\&.
511 .sp
512 Example:
513 pdbedit \-y \-i tdbsam: \-e ldapsam:ldap://my\&.ldap\&.host
514 .RE
515 .PP
516 \-\-force\-initialized\-passwords
517 .RS 4
518 This option forces all users to change their password upon next login\&.
519 .RE
520 .PP
521 \-N|\-\-account\-desc description
522 .RS 4
523 This option can be used while adding or modifying a user account\&. It will specify the user\*(Aqs description field\&.
524 .sp
525 Example:
526 \-N "test description"
527 .RE
528 .PP
529 \-Z|\-\-logon\-hours\-reset
530 .RS 4
531 This option can be used while adding or modifying a user account\&. It will reset the user\*(Aqs allowed logon hours\&. A user may login at any time afterwards\&.
532 .sp
533 Example:
534 \-Z
535 .RE
536 .PP
537 \-z|\-\-bad\-password\-count\-reset
538 .RS 4
539 This option can be used while adding or modifying a user account\&. It will reset the stored bad login counter from a specified user\&.
540 .sp
541 Example:
542 \-z
543 .RE
544 .PP
545 \-\-policies\-reset
546 .RS 4
547 This option can be used to reset the general password policies stored for a domain to their default values\&.
548 .sp
549 Example:
550 \-\-policies\-reset
551 .RE
552 .PP
553 \-I|\-\-domain
554 .RS 4
555 This option can be used while adding or modifying a user account\&. It will specify the user\*(Aqs domain field\&.
556 .sp
557 Example:
558 \-I "MYDOMAIN"
559 .RE
560 .PP
561 \-\-time\-format
562 .RS 4
563 This option is currently not being used\&.
564 .RE
565 .PP
566 \-?|\-\-help
567 .RS 4
568 Print a summary of command line options\&.
569 .RE
570 .PP
571 \-\-usage
572 .RS 4
573 Display brief usage message\&.
574 .RE
575 .PP
576 \-d|\-\-debuglevel=level
577 .RS 4
578 \fIlevel\fR
579 is an integer from 0 to 10\&. The default value if this parameter is not specified is 1 for client applications\&.
580 .sp
581 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\&.
582 .sp
583 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\&.
584 .sp
585 Note that specifying this parameter here will override the
586 \m[blue]\fBlog level\fR\m[]
587 parameter in the
588 /etc/samba/smb\&.conf
589 file\&.
590 .RE
591 .PP
592 \-\-debug\-stdout
593 .RS 4
594 This will redirect debug output to STDOUT\&. By default all clients are logging to STDERR\&.
595 .RE
596 .PP
597 \-\-configfile=<configuration file>
598 .RS 4
599 The file specified contains the configuration details required by the client\&. The information in this file can be general for client and server or only provide client specific like options such as
600 \m[blue]\fBclient smb encrypt\fR\m[]\&. See
601 /etc/samba/smb\&.conf
602 for more information\&. The default configuration file name is determined at compile time\&.
603 .RE
604 .PP
605 \-\-option=<name>=<value>
606 .RS 4
607 Set the
608 \fBsmb.conf\fR(5)
609 option "<name>" to value "<value>" from the command line\&. This overrides compiled\-in defaults and options read from the configuration file\&. If a name or a value includes a space, wrap whole \-\-option=name=value into quotes\&.
610 .RE
611 .PP
612 \-l|\-\-log\-basename=logdirectory
613 .RS 4
614 Base directory name for log/debug files\&. The extension
615 \fB"\&.progname"\fR
616 will be appended (e\&.g\&. log\&.smbclient, log\&.smbd, etc\&.\&.\&.)\&. The log file is never removed by the client\&.
617 .RE
618 .PP
619 \-\-leak\-report
620 .RS 4
621 Enable talloc leak reporting on exit\&.
622 .RE
623 .PP
624 \-\-leak\-report\-full
625 .RS 4
626 Enable full talloc leak reporting on exit\&.
627 .RE
628 .PP
629 \-V|\-\-version
630 .RS 4
631 Prints the program version number\&.
632 .RE
633 .SH "NOTES"
634 .PP
635 This command may be used only by root\&.
636 .SH "VERSION"
637 .PP
638 This man page is part of version 4\&.23\&.8 of the Samba suite\&.
639 .SH "SEE ALSO"
640 .PP
641 \fBsmbpasswd\fR(5),
642 \fBsamba\fR(7)
643 .SH "AUTHOR"
644 .PP
645 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\&.
646 .PP
647 The pdbedit manpage was written by Simo Sorce and Jelmer Vernooij\&.