summaryrefslogtreecommitdiff
path: root/docs/docbook/manpages/pdbedit.8.sgml
blob: 2457d899de027cd2b614387b85dfc710fb09ba59 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
<!ENTITY % globalentities SYSTEM '../global.ent'> %globalentities;
]>
<refentry id="pdbedit">

<refmeta>
	<refentrytitle>pdbedit</refentrytitle>
	<manvolnum>8</manvolnum>
</refmeta>


<refnamediv>
	<refname>pdbedit</refname>
	<refpurpose>manage the SAM database</refpurpose>
</refnamediv>

<refsynopsisdiv>
	<cmdsynopsis>
		<command>pdbedit</command>
		<arg choice="opt">-l</arg>	
		<arg choice="opt">-v</arg>	
		<arg choice="opt">-w</arg>	
		<arg choice="opt">-u username</arg>	
		<arg choice="opt">-f fullname</arg>	
		<arg choice="opt">-h homedir</arg>	
		<arg choice="opt">-D drive</arg>	
		<arg choice="opt">-S script</arg>
		<arg choice="opt">-p profile</arg>	
		<arg choice="opt">-a</arg>	
		<arg choice="opt">-m</arg>	
		<arg choice="opt">-x</arg>	
		<arg choice="opt">-i passdb-backend</arg>	
		<arg choice="opt">-e passdb-backend</arg>   
		<arg choice="opt">-g</arg>   
		<arg choice="opt">-b passdb-backend</arg>
		<arg choice="opt">-d debuglevel</arg>
		<arg choice="opt">-s configfile</arg>
		<arg choice="opt">-P account-policy</arg>
		<arg choice="opt">-V value</arg>
	</cmdsynopsis>
</refsynopsisdiv>

<refsect1>
	<title>DESCRIPTION</title>

	<para>This tool is part of the <ulink url="samba.7.html">
	Samba</ulink> suite.</para>

	<para>The pdbedit program is used to manage the users accounts
	stored in the sam database and can only be run by root.</para>

	<para>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).</para>

	<para>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.</para>
</refsect1>

<refsect1>
	<title>OPTIONS</title>
	<variablelist>
		<varlistentry>
		<term>-l</term>
		<listitem><para>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.</para>

		<para>Example: <command>pdbedit -l</command></para>
		<para><programlisting>
		sorce:500:Simo Sorce
		samba:45:Test User
		</programlisting></para>
		</listitem>
		</varlistentry>
		
		
		
		<varlistentry>
		<term>-v</term>
		<listitem><para>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.</para>

		<para>Example: <command>pdbedit -l -v</command></para>
		<para><programlisting>
		---------------
		username:       sorce
		user ID/Group:  500/500
		user RID/GRID:  2000/2001
		Full Name:      Simo Sorce
		Home Directory: \\BERSERKER\sorce
		HomeDir Drive:  H:
		Logon Script:   \\BERSERKER\netlogon\sorce.bat
		Profile Path:   \\BERSERKER\profile
		---------------
		username:       samba
		user ID/Group:  45/45
		user RID/GRID:  1090/1091
		Full Name:      Test User
		Home Directory: \\BERSERKER\samba
		HomeDir Drive:  
		Logon Script:   
		Profile Path:   \\BERSERKER\profile
		</programlisting></para>
		</listitem>
		</varlistentry>
		
		
		
		<varlistentry>
		<term>-w</term>
		<listitem><para>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
		<filename>smbpasswd</filename> file format. (see the <ulink
		url="smbpasswd.5.html"><filename>smbpasswd(5)</filename></ulink> for details)</para>

		<para>Example: <command>pdbedit -l -w</command></para>
		<para><programlisting>
		sorce:500:508818B733CE64BEAAD3B435B51404EE:D2A2418EFC466A8A0F6B1DBB5C3DB80C:[UX         ]:LCT-00000000:
		samba:45:0F2B255F7B67A7A9AAD3B435B51404EE:BC281CE3F53B6A5146629CD4751D3490:[UX         ]:LCT-3BFA1E8D:
		</programlisting></para>
		</listitem>
		</varlistentry>
		
		
		<varlistentry>
		<term>-u username</term>
		<listitem><para>This option specifies the username to be
		used for the operation requested (listing, adding, removing).
		It is <emphasis>required</emphasis> in add, remove and modify
		operations and <emphasis>optional</emphasis> in list
		operations.</para>
		</listitem>
		</varlistentry>
		


		<varlistentry>
		<term>-f fullname</term>
		<listitem><para>This option can be used while adding or
		modifing a user account. It will specify the user's full
		name. </para>

		<para>Example: <command>-f "Simo Sorce"</command></para>
		</listitem>
		</varlistentry>
		
		
		
		<varlistentry>
		<term>-h homedir</term>
		<listitem><para>This option can be used while adding or
		modifing a user account. It will specify the user's home
		directory network path.</para>

		<para>Example: <command>-h "\\\\BERSERKER\\sorce"</command>
		</para>
		</listitem>
		</varlistentry>
		
		
		<varlistentry>
		<term>-D drive</term>
		<listitem><para>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.</para>

		<para>Example: <command>-d "H:"</command>
		</para>
		</listitem>
		</varlistentry>
		
		
		<varlistentry>
		<term>-S script</term>
		<listitem><para>This option can be used while adding or
		modifing a user account. It will specify the user's logon
		script path.</para>

		<para>Example: <command>-s "\\\\BERSERKER\\netlogon\\sorce.bat"</command>
		</para>
		</listitem>
		</varlistentry>
		
		
		<varlistentry>
		<term>-p profile</term>
		<listitem><para>This option can be used while adding or
		modifing a user account. It will specify the user's profile
		directory.</para>

		<para>Example: <command>-p "\\\\BERSERKER\\netlogon"</command>
		</para>
		</listitem>
		</varlistentry>
		
		
		<varlistentry>
		<term>-a</term>
		<listitem><para>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.</para>

		<para>Example: <command>pdbedit -a -u sorce</command>
		<programlisting>new password:
		retype new password</programlisting>
                </para>
		</listitem>
		</varlistentry>
		
		
		
		<varlistentry>
		<term>-m</term>
		<listitem><para>This option may only be used in conjunction 
		with the <parameter>-a</parameter> option. It will make
		pdbedit to add a machine trust account instead of a user
		account (-u username will provide the machine name).</para>

		<para>Example: <command>pdbedit -a -m -u w2k-wks</command>
		</para>
		</listitem>
		</varlistentry>
		
		
		<varlistentry>
		<term>-x</term>
		<listitem><para>This option causes pdbedit to delete an account
		from the database. It needs a username specified with the
		-u switch.</para>

		<para>Example: <command>pdbedit -x -u bob</command></para>
		</listitem>
		</varlistentry>
		

		<varlistentry>
		<term>-i passdb-backend</term>
		<listitem><para>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.</para>

		<para>This option will ease migration from one passdb backend to
		another.</para>

		<para>Example: <command>pdbedit -i smbpasswd:/etc/smbpasswd.old
                </command></para>
		</listitem>
		</varlistentry>

		<varlistentry>
		<term>-e passdb-backend</term>
		<listitem><para>Exports all currently available users to the
		specified password database backend.</para>

		<para>This option will ease migration from one passdb backend to
		another and will ease backing up.</para>
		
		<para>Example: <command>pdbedit -e smbpasswd:/root/samba-users.backup</command></para>
		</listitem>
		</varlistentry>

		<varlistentry>
		<term>-g</term>
		<listitem><para>If you specify <parameter>-g</parameter>,
		then <parameter>-i in-backend -e out-backend</parameter>
		applies to the group mapping instead of the user database.

		<para>This option will ease migration from one passdb backend to
		another and will ease backing up.</para>
		
		</listitem>
		</varlistentry>

		<varlistentry>
		<term>-b passdb-backend</term>
		<listitem><para>Use a different default passdb backend. </para>

		<para>Example: <command>pdbedit -b xml:/root/pdb-backup.xml -l</command></para>
		</listitem>
		</varlistentry>

		<varlistentry>
		<term>-P account-policy</term>
		<listitem><para>Display an account policy</para>
		<para>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.</para>

		<para>Example: <command>pdbedit -P "bad lockout attempt"</command></para>
		<para><programlisting>
		account policy value for bad lockout attempt is 0
		</programlisting></para>

		</listitem>
		</varlistentry>

		<varlistentry>
		<term>-V account-policy-value</term>
		<listitem><para>Sets an account policy to a specified value. 
		This option may only be used in conjunction
		with the <parameter>-P</parameter> option.
		</para>

		<para>Example: <command>pdbedit -P "bad lockout attempt" -V 3</command></para>
		<para><programlisting>
		account policy value for bad lockout attempt was 0
		account policy value for bad lockout attempt is now 3
		</programlisting></para>
		</listitem>
		</varlistentry>
		
		&stdarg.debuglevel;
		&stdarg.help;
		&stdarg.configfile;

	</variablelist>
</refsect1>


<refsect1>
	<title>NOTES</title>
	
	<para>This command may be used only by root.</para>
</refsect1>


<refsect1>
	<title>VERSION</title>

	<para>This man page is correct for version 2.2 of 
	the Samba suite.</para>
</refsect1>

<refsect1>
	<title>SEE ALSO</title>
	<para><ulink url="smbpasswd.8.html">smbpasswd(8)</ulink>, 
	<ulink url="samba.7.html">samba(7)</ulink>
	</para>
</refsect1>

<refsect1>
	<title>AUTHOR</title>
	
	<para>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.</para>
	
	<para>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
	<ulink url="ftp://ftp.icce.rug.nl/pub/unix/">
	ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0 
	release by Jeremy Allison.  The conversion to DocBook for 
	Samba 2.2 was done by Gerald Carter</para>
</refsect1>

</refentry>