.\" This manpage has been automatically generated by docbook2man
.\" from a DocBook document. This tool can be found at:
.\"
.\" Please send any bug reports, improvements, comments, patches,
.\" etc. to Steve Cheng .
.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
.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/ ) and updated for the Samba 2.0
release by Jeremy Allison. The conversion to DocBook for
Samba 2.2 was done by Gerald Carter