summaryrefslogtreecommitdiffstats
path: root/docs/manpages/pdbedit.8
blob: 278bc2727a4d6f55c046e3efafd18b585025ea68 (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
.\" This manpage has been automatically generated by docbook2man 
.\" from a DocBook document.  This tool can be found at:
.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> 
.\" Please send any bug reports, improvements, comments, patches, 
.\" etc. to Steve Cheng <steve@ggi-project.org>.
.TH "PDBEDIT" "8" "26 November 2002" "" ""
.SH NAME
pdbedit \- manage the SAM database
.SH SYNOPSIS

\fBpdbedit\fR [ \fB-l\fR ] [ \fB-v\fR ] [ \fB-w\fR ] [ \fB-u username\fR ] [ \fB-f fullname\fR ] [ \fB-h homedir\fR ] [ \fB-D drive\fR ] [ \fB-S script\fR ] [ \fB-p profile\fR ] [ \fB-a\fR ] [ \fB-m\fR ] [ \fB-x\fR ] [ \fB-i passdb-backend\fR ] [ \fB-e passdb-backend\fR ] [ \fB-b passdb-backend\fR ] [ \fB-d debuglevel\fR ] [ \fB-s configfile\fR ] [ \fB-P account-policy\fR ] [ \fB-V value\fR ]

.SH "DESCRIPTION"
.PP
This tool is part of the  Samba suite.
.PP
The pdbedit program is used to manage the users accounts
stored in the sam database and can only be run by root.
.PP
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).
.PP
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.
.SH "OPTIONS"
.TP
\fB-l\fR
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.

Example: \fBpdbedit -l\fR


.nf
		sorce:500:Simo Sorce
		samba:45:Test User
		
.fi
.TP
\fB-v\fR
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.

Example: \fBpdbedit -l -v\fR


.nf
		---------------
		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
		
.fi
.TP
\fB-w\fR
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 \fIsmbpasswd(5)\fR for details)

Example: \fBpdbedit -l -w\fR


.nf
		sorce:500:508818B733CE64BEAAD3B435B51404EE:D2A2418EFC466A8A0F6B1DBB5C3DB80C:[UX         ]:LCT-00000000:
		samba:45:0F2B255F7B67A7A9AAD3B435B51404EE:BC281CE3F53B6A5146629CD4751D3490:[UX         ]:LCT-3BFA1E8D:
		
.fi
.TP
\fB-u username\fR
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.
.TP
\fB-f fullname\fR
This option can be used while adding or
modifing a user account. It will specify the user's full
name. 

Example: \fB-f "Simo Sorce"\fR
.TP
\fB-h homedir\fR
This option can be used while adding or
modifing a user account. It will specify the user's home
directory network path.

Example: \fB-h "\\\\\\\\BERSERKER\\\\sorce"\fR
.TP
\fB-D drive\fR
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.

Example: \fB-d "H:"\fR
.TP
\fB-S script\fR
This option can be used while adding or
modifing a user account. It will specify the user's logon
script path.

Example: \fB-s "\\\\\\\\BERSERKER\\\\netlogon\\\\sorce.bat"\fR
.TP
\fB-p profile\fR
This option can be used while adding or
modifing a user account. It will specify the user's profile
directory.

Example: \fB-p "\\\\\\\\BERSERKER\\\\netlogon"\fR
.TP
\fB-a\fR
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.

Example: \fBpdbedit -a -u sorce\fR

.nf
new password:
		retype new password
.fi
.TP
\fB-m\fR
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).

Example: \fBpdbedit -a -m -u w2k-wks\fR
.TP
\fB-x\fR
This option causes pdbedit to delete an account
from the database. It needs a username specified with the
-u switch.

Example: \fBpdbedit -x -u bob\fR
.TP
\fB-i passdb-backend\fR
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.

This option will ease migration from one passdb backend to
another.

Example: \fBpdbedit -i smbpasswd:/etc/smbpasswd.old
\fR
.TP
\fB-e passdb-backend\fR
Exports all currently available users to the
specified password database backend.

This option will ease migration from one passdb backend to
another and will ease backing up.

Example: \fBpdbedit -e smbpasswd:/root/samba-users.backup\fR
.TP
\fB-b passdb-backend\fR
Use a different default passdb backend. 

Example: \fBpdbedit -b xml:/root/pdb-backup.xml -l\fR
.TP
\fB-P account-policy\fR
Display an account policy

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.

Example: \fBpdbedit -P "bad lockout attempt"\fR


.nf
		account policy value for bad lockout attempt is 0
		
.fi
.TP
\fB-V account-policy-value\fR
Sets an account policy to a specified value. 
This option may only be used in conjunction
with the \fI-P\fR option.

Example: \fBpdbedit -P "bad lockout attempt" -V 3\fR


.nf
		account policy value for bad lockout attempt was 0
		account policy value for bad lockout attempt is now 3
		
.fi
.TP
\fB-d|--debug=debuglevel\fR
\fIdebuglevel\fR is an integer 
from 0 to 10.  The default value if this parameter is 
not specified is zero.

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.

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.

Note that specifying this parameter here will 
override the log
level file.
.TP
\fB-h|--help\fR
Print a summary of command line options.
.TP
\fB-s <configuration file>\fR
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(5)\fR for more information.
The default configuration file name is determined at 
compile time.
.SH "NOTES"
.PP
This command may be used only by root.
.SH "VERSION"
.PP
This man page is correct for version 2.2 of 
the Samba suite.
.SH "SEE ALSO"
.PP
smbpasswd(8) 
samba(7)
.SH "AUTHOR"
.PP
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.
.PP
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
ftp://ftp.icce.rug.nl/pub/unix/ <URL: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