1<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>pdbedit</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.61.2"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="pdbedit.8"></a><div class="titlepage"><div></div><div></div></div><div class="refnamediv"><h2>Name</h2><p>pdbedit — manage the SAM database</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><tt class="command">pdbedit</tt> [-L] [-v] [-w] [-u username] [-f fullname] [-h homedir] [-D drive] [-S script] [-p profile] [-a] [-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]</p></div></div><div class="refsect1" lang="en"><h2>DESCRIPTION</h2><p>This tool is part of the <a href="Samba.7.html"><span class="citerefentry"><span class="refentrytitle">Samba</span>(7)</span></a> suite.</p><p>The pdbedit program is used to manage the users accounts 2 stored in the sam database and can only be run by root.</p><p>The pdbedit tool uses the passdb modular interface and is 3 independent from the kind of users database used (currently there 4 are smbpasswd, ldap, nis+ and tdb based and more can be added 5 without changing the tool).</p><p>There are five main ways to use pdbedit: adding a user account, 6 removing a user account, modifing a user account, listing user 7 accounts, importing users accounts.</p></div><div class="refsect1" lang="en"><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">-L</span></dt><dd><p>This option lists all the user accounts 8 present in the users database. 9 This option prints a list of user/uid pairs separated by 10 the ':' character.</p><p>Example: <b class="command">pdbedit -L</b></p><pre class="screen"> 11sorce:500:Simo Sorce 12samba:45:Test User 13</pre></dd><dt><span class="term">-v</span></dt><dd><p>This option enables the verbose listing format. 14 It causes pdbedit to list the users in the database, printing 15 out the account fields in a descriptive format.</p><p>Example: <b class="command">pdbedit -L -v</b></p><pre class="screen"> 16--------------- 17username: sorce 18user ID/Group: 500/500 19user RID/GRID: 2000/2001 20Full Name: Simo Sorce 21Home Directory: \\BERSERKER\sorce 22HomeDir Drive: H: 23Logon Script: \\BERSERKER\netlogon\sorce.bat 24Profile Path: \\BERSERKER\profile 25--------------- 26username: samba 27user ID/Group: 45/45 28user RID/GRID: 1090/1091 29Full Name: Test User 30Home Directory: \\BERSERKER\samba 31HomeDir Drive: 32Logon Script: 33Profile Path: \\BERSERKER\profile 34</pre></dd><dt><span class="term">-w</span></dt><dd><p>This option sets the "smbpasswd" listing format. 35 It will make pdbedit list the users in the database, printing 36 out the account fields in a format compatible with the 37 <tt class="filename">smbpasswd</tt> file format. (see the 38 <a href="smbpasswd.5.html"><span class="citerefentry"><span class="refentrytitle">smbpasswd</span>(5)</span></a> for details)</p><p>Example: <b class="command">pdbedit -L -w</b></p><pre class="screen"> 39sorce:500:508818B733CE64BEAAD3B435B51404EE:D2A2418EFC466A8A0F6B1DBB5C3DB80C:[UX ]:LCT-00000000: 40samba:45:0F2B255F7B67A7A9AAD3B435B51404EE:BC281CE3F53B6A5146629CD4751D3490:[UX ]:LCT-3BFA1E8D: 41</pre></dd><dt><span class="term">-u username</span></dt><dd><p>This option specifies the username to be 42 used for the operation requested (listing, adding, removing). 43 It is <span class="emphasis"><em>required</em></span> in add, remove and modify 44 operations and <span class="emphasis"><em>optional</em></span> in list 45 operations.</p></dd><dt><span class="term">-f fullname</span></dt><dd><p>This option can be used while adding or 46 modifing a user account. It will specify the user's full 47 name. </p><p>Example: <b class="command">-f "Simo Sorce"</b></p></dd><dt><span class="term">-h homedir</span></dt><dd><p>This option can be used while adding or 48 modifing a user account. It will specify the user's home 49 directory network path.</p><p>Example: <b class="command">-h "\\\\BERSERKER\\sorce"</b> 50 </p></dd><dt><span class="term">-D drive</span></dt><dd><p>This option can be used while adding or 51 modifing a user account. It will specify the windows drive 52 letter to be used to map the home directory.</p><p>Example: <b class="command">-d "H:"</b> 53 </p></dd><dt><span class="term">-S script</span></dt><dd><p>This option can be used while adding or 54 modifing a user account. It will specify the user's logon 55 script path.</p><p>Example: <b class="command">-s "\\\\BERSERKER\\netlogon\\sorce.bat"</b> 56 </p></dd><dt><span class="term">-p profile</span></dt><dd><p>This option can be used while adding or 57 modifing a user account. It will specify the user's profile 58 directory.</p><p>Example: <b class="command">-p "\\\\BERSERKER\\netlogon"</b> 59 </p></dd><dt><span class="term">-G SID|rid</span></dt><dd><p> 60 This option can be used while adding or modifying a user account. It 61 will specify the users' new primary group SID (Security Identifier) or 62 rid. </p><p>Example: <b class="command">-G S-1-5-21-2447931902-1787058256-3961074038-1201</b></p></dd><dt><span class="term">-U SID|rid</span></dt><dd><p> 63 This option can be used while adding or modifying a user account. It 64 will specify the users' new SID (Security Identifier) or 65 rid. </p><p>Example: <b class="command">-U S-1-5-21-2447931902-1787058256-3961074038-5004</b></p></dd><dt><span class="term">-c account-control</span></dt><dd><p>This option can be used while adding or modifying a user 66 account. It will specify the users' account control property. Possible flags are listed below. 67 </p><p> 68 </p><div class="itemizedlist"><ul type="disc"><li><p>N: No password required</p></li><li><p>D: Account disabled</p></li><li><p>H: Home directory required</p></li><li><p>T: Temporary duplicate of other account</p></li><li><p>U: Regular user account</p></li><li><p>M: MNS logon user account</p></li><li><p>W: Workstation Trust Account</p></li><li><p>S: Server Trust Account</p></li><li><p>L: Automatic Locking</p></li><li><p>X: Password does not expire</p></li><li><p>I: Domain Trust Account</p></li></ul></div><p> 69 </p><p>Example: <b class="command">-c "[X ]"</b></p></dd><dt><span class="term">-a</span></dt><dd><p>This option is used to add a user into the 70 database. This command needs a user name specified with 71 the -u switch. When adding a new user, pdbedit will also 72 ask for the password to be used.</p><p>Example: <b class="command">pdbedit -a -u sorce</b> 73</p><pre class="programlisting">new password: 74retype new password 75</pre><p> 76</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>pdbedit does not call the unix password syncronisation 77 script if <a class="indexterm" name="id2799847"></a>unix password sync 78 has been set. It only updates the data in the Samba 79 user database. 80 </p><p>If you wish to add a user and synchronise the password 81 that immediately, use <b class="command">smbpasswd</b>'s <tt class="option">-a</tt> option. 82 </p></div></dd><dt><span class="term">-r</span></dt><dd><p>This option is used to modify an existing user 83 in the database. This command needs a user name specified with the -u 84 switch. Other options can be specified to modify the properties of 85 the specified user. This flag is kept for backwards compatibility, but 86 it is no longer necessary to specify it. 87 </p></dd><dt><span class="term">-m</span></dt><dd><p>This option may only be used in conjunction 88 with the <i class="parameter"><tt>-a</tt></i> option. It will make 89 pdbedit to add a machine trust account instead of a user 90 account (-u username will provide the machine name).</p><p>Example: <b class="command">pdbedit -a -m -u w2k-wks</b> 91 </p></dd><dt><span class="term">-x</span></dt><dd><p>This option causes pdbedit to delete an account 92 from the database. It needs a username specified with the 93 -u switch.</p><p>Example: <b class="command">pdbedit -x -u bob</b></p></dd><dt><span class="term">-i passdb-backend</span></dt><dd><p>Use a different passdb backend to retrieve users 94 than the one specified in smb.conf. Can be used to import data into 95 your local user database.</p><p>This option will ease migration from one passdb backend to 96 another.</p><p>Example: <b class="command">pdbedit -i smbpasswd:/etc/smbpasswd.old 97 </b></p></dd><dt><span class="term">-e passdb-backend</span></dt><dd><p>Exports all currently available users to the 98 specified password database backend.</p><p>This option will ease migration from one passdb backend to 99 another and will ease backing up.</p><p>Example: <b class="command">pdbedit -e smbpasswd:/root/samba-users.backup</b></p></dd><dt><span class="term">-g</span></dt><dd><p>If you specify <i class="parameter"><tt>-g</tt></i>, 100 then <i class="parameter"><tt>-i in-backend -e out-backend</tt></i> 101 applies to the group mapping instead of the user database.</p><p>This option will ease migration from one passdb backend to 102 another and will ease backing up.</p></dd><dt><span class="term">-b passdb-backend</span></dt><dd><p>Use a different default passdb backend. </p><p>Example: <b class="command">pdbedit -b xml:/root/pdb-backup.xml -l</b></p></dd><dt><span class="term">-P account-policy</span></dt><dd><p>Display an account policy</p><p>Valid policies are: minimum password age, reset count minutes, disconnect time, 103 user must logon to change password, password history, lockout duration, min password length, 104 maximum password age and bad lockout attempt.</p><p>Example: <b class="command">pdbedit -P "bad lockout attempt"</b></p><pre class="programlisting"> 105account policy value for bad lockout attempt is 0 106</pre></dd><dt><span class="term">-C account-policy-value</span></dt><dd><p>Sets an account policy to a specified value. 107 This option may only be used in conjunction 108 with the <i class="parameter"><tt>-P</tt></i> option. 109 </p><p>Example: <b class="command">pdbedit -P "bad lockout attempt" -C 3</b></p><pre class="programlisting"> 110account policy value for bad lockout attempt was 0 111account policy value for bad lockout attempt is now 3 112</pre></dd><dt><span class="term">-h|--help</span></dt><dd><p>Print a summary of command line options. 113</p></dd><dt><span class="term">-V</span></dt><dd><p>Prints the program version number. 114</p></dd><dt><span class="term">-s <configuration file></span></dt><dd><p>The file specified contains the 115configuration details required by the server. The 116information in this file includes server-specific 117information such as what printcap file to use, as well 118as descriptions of all the services that the server is 119to provide. See <tt class="filename">smb.conf</tt> for more information. 120The default configuration file name is determined at 121compile time.</p></dd><dt><span class="term">-d|--debug=debuglevel</span></dt><dd><p><i class="replaceable"><tt>debuglevel</tt></i> is an integer 122from 0 to 10. The default value if this parameter is 123not specified is zero.</p><p>The higher this value, the more detail will be 124logged to the log files about the activities of the 125server. At level 0, only critical errors and serious 126warnings will be logged. Level 1 is a reasonable level for 127day-to-day running - it generates a small amount of 128information about operations carried out.</p><p>Levels above 1 will generate considerable 129amounts of log data, and should only be used when 130investigating a problem. Levels above 3 are designed for 131use only by developers and generate HUGE amounts of log 132data, most of which is extremely cryptic.</p><p>Note that specifying this parameter here will 133override the <a class="indexterm" name="id2800118"></a>log level parameter 134in the <tt class="filename">smb.conf</tt> file.</p></dd><dt><span class="term">-l|--logfile=logbasename</span></dt><dd><p>File name for log/debug files. The extension 135<tt class="constant">".client"</tt> will be appended. The log file is 136never removed by the client. 137</p></dd></dl></div></div><div class="refsect1" lang="en"><h2>NOTES</h2><p>This command may be used only by root.</p></div><div class="refsect1" lang="en"><h2>VERSION</h2><p>This man page is correct for version 3.0 of 138 the Samba suite.</p></div><div class="refsect1" lang="en"><h2>SEE ALSO</h2><p><a href="smbpasswd.5.html"><span class="citerefentry"><span class="refentrytitle">smbpasswd</span>(5)</span></a>, <a href="samba.7.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(7)</span></a></p></div><div class="refsect1" lang="en"><h2>AUTHOR</h2><p>The original Samba software and related utilities 139 were created by Andrew Tridgell. Samba is now developed 140 by the Samba Team as an Open Source project similar 141 to the way the Linux kernel is developed.</p><p>The pdbedit manpage was written by Simo Sorce and Jelmer Vernooij.</p></div></div></body></html> 142