docs/manpages/pdbedit.8

   1 .\"Generated by db2man.xsl. Don't modify this, modify the source.
   2 .de Sh \" Subsection
   3 .br
   4 .if t .Sp
   5 .ne 5
   6 .PP
   7 \fB\\$1\fR
   8 .PP
   9 ..
  10 .de Sp \" Vertical space (when we can't use .PP)
  11 .if t .sp .5v
  12 .if n .sp
  13 ..
  14 .de Ip \" List item
  15 .br
  16 .ie \\n(.$>=3 .ne \\$3
  17 .el .ne 3
  18 .IP "\\$1" \\$2
  19 ..
  20 .TH "PDBEDIT" 8 "" "" ""
  21 .SH NAME
  22 pdbedit \- manage the SAM database
  23 .SH "SYNOPSIS"
  24
  25 .nf
  26 \fBpdbedit\fR [-l] [-v] [-w] [-u username] [-f fullname] [-h homedir] [-D drive] [-S
  27         script] [-p profile] [-a] [-m] [-x] [-i passdb-backend] [-e passdb-backend]
  28         [-g] [-b passdb-backend] [-g] [-d debuglevel] [-s configfile] [-P account-policy]
  29         [-C value]
  30 .fi
  31
  32 .SH "DESCRIPTION"
  33
  34 .PP
  35 This tool is part of the \fBSamba\fR(7) suite\&.
  36
  37 .PP
  38 The pdbedit program is used to manage the users accounts stored in the sam database and can only be run by root\&.
  39
  40 .PP
  41 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)\&.
  42
  43 .PP
  44 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\&.
  45
  46 .SH "OPTIONS"
  47
  48 .TP
  49 -l
  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 ':' character\&.
  51
  52
  53 Example: \fBpdbedit -l\fR
  54
  55
  56 .nf
  57
  58 sorce:500:Simo Sorce
  59 samba:45:Test User
  60 .fi
  61
  62
  63 .TP
  64 -v
  65 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\&.
  66
  67
  68 Example: \fBpdbedit -l -v\fR
  69
  70
  71 .nf
  72
  73 ---------------
  74 username:       sorce
  75 user ID/Group:  500/500
  76 user RID/GRID:  2000/2001
  77 Full Name:      Simo Sorce
  78 Home Directory: \\\\BERSERKER\\sorce
  79 HomeDir Drive:  H:
  80 Logon Script:   \\\\BERSERKER\\netlogon\\sorce\&.bat
  81 Profile Path:   \\\\BERSERKER\\profile
  82 ---------------
  83 username:       samba
  84 user ID/Group:  45/45
  85 user RID/GRID:  1090/1091
  86 Full Name:      Test User
  87 Home Directory: \\\\BERSERKER\\samba
  88 HomeDir Drive:
  89 Logon Script:
  90 Profile Path:   \\\\BERSERKER\\profile
  91 .fi
  92
  93
  94 .TP
  95 -w
  96 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 \fBsmbpasswd\fR(5) for details)
  97
  98
  99 Example: \fBpdbedit -l -w\fR
 100
 101
 102 sorce:500:508818B733CE64BEAAD3B435B51404EE:D2A2418EFC466A8A0F6B1DBB5C3DB80C:[UX         ]:LCT-00000000:
 103 samba:45:0F2B255F7B67A7A9AAD3B435B51404EE:BC281CE3F53B6A5146629CD4751D3490:[UX         ]:LCT-3BFA1E8D:
 104
 105 .TP
 106 -u username
 107 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\&.
 108
 109
 110 .TP
 111 -f fullname
 112 This option can be used while adding or modifing a user account\&. It will specify the user's full name\&.
 113
 114
 115 Example: \fB-f "Simo Sorce"\fR
 116
 117
 118 .TP
 119 -h homedir
 120 This option can be used while adding or modifing a user account\&. It will specify the user's home directory network path\&.
 121
 122
 123 Example: \fB-h "\\\\BERSERKER\\sorce"\fR
 124
 125
 126 .TP
 127 -D drive
 128 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\&.
 129
 130
 131 Example: \fB-d "H:"\fR
 132
 133
 134 .TP
 135 -S script
 136 This option can be used while adding or modifing a user account\&. It will specify the user's logon script path\&.
 137
 138
 139 Example: \fB-s "\\\\BERSERKER\\netlogon\\sorce.bat"\fR
 140
 141
 142 .TP
 143 -p profile
 144 This option can be used while adding or modifing a user account\&. It will specify the user's profile directory\&.
 145
 146
 147 Example: \fB-p "\\\\BERSERKER\\netlogon"\fR
 148
 149
 150 .TP
 151 -a
 152 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\&.
 153
 154
 155 Example: \fBpdbedit -a -u sorce\fR
 156 .nf
 157 new password:
 158 retype new password
 159 .fi
 160
 161
 162
 163 .TP
 164 -m
 165 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)\&.
 166
 167
 168 Example: \fBpdbedit -a -m -u w2k-wks\fR
 169
 170
 171 .TP
 172 -x
 173 This option causes pdbedit to delete an account from the database\&. It needs a username specified with the -u switch\&.
 174
 175
 176 Example: \fBpdbedit -x -u bob\fR
 177
 178
 179 .TP
 180 -i passdb-backend
 181 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\&.
 182
 183
 184 This option will ease migration from one passdb backend to another\&.
 185
 186
 187 Example: \fBpdbedit -i smbpasswd:/etc/smbpasswd.old \fR
 188
 189
 190 .TP
 191 -e passdb-backend
 192 Exports all currently available users to the specified password database backend\&.
 193
 194
 195 This option will ease migration from one passdb backend to another and will ease backing up\&.
 196
 197
 198 Example: \fBpdbedit -e smbpasswd:/root/samba-users.backup\fR
 199
 200
 201 .TP
 202 -g
 203 If you specify \fI-g\fR, then \fI-i in-backend -e out-backend\fR applies to the group mapping instead of the user database\&.
 204
 205
 206 This option will ease migration from one passdb backend to another and will ease backing up\&.
 207
 208
 209 .TP
 210 -g
 211 If you specify \fI-g\fR, then \fI-i in-backend -e out-backend\fR applies to the group mapping instead of the user database\&.
 212
 213
 214 This option will ease migration from one passdb backend to another and will ease backing up\&.
 215
 216
 217 .TP
 218 -b passdb-backend
 219 Use a different default passdb backend\&.
 220
 221
 222 Example: \fBpdbedit -b xml:/root/pdb-backup.xml -l\fR
 223
 224
 225 .TP
 226 -P account-policy
 227 Display an account policy
 228
 229
 230 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\&.
 231
 232
 233 Example: \fBpdbedit -P "bad lockout attempt"\fR
 234
 235
 236 .nf
 237
 238 account policy value for bad lockout attempt is 0
 239 .fi
 240
 241
 242 .TP
 243 -C account-policy-value
 244 Sets an account policy to a specified value\&. This option may only be used in conjunction with the \fI-P\fR option\&.
 245
 246
 247 Example: \fBpdbedit -P "bad lockout attempt" -C 3\fR
 248
 249
 250 .nf
 251
 252 account policy value for bad lockout attempt was 0
 253 account policy value for bad lockout attempt is now 3
 254 .fi
 255
 256
 257 .TP
 258 -h|--help
 259 Print a summary of command line options\&.
 260
 261
 262 .TP
 263 -V
 264 Prints the version number for \fBsmbd\fR\&.
 265
 266
 267 .TP
 268 -s <configuration file>
 269 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 \fI smb\&.conf(5)\fR for more information\&. The default configuration file name is determined at compile time\&.
 270
 271
 272 .TP
 273 -d|--debug=debuglevel
 274 \fIdebuglevel\fR is an integer from 0 to 10\&. The default value if this parameter is not specified is zero\&.
 275
 276
 277 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\&.
 278
 279
 280 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\&.
 281
 282
 283 Note that specifying this parameter here will override the log level parameter in the \fIsmb\&.conf(5)\fR file\&.
 284
 285
 286 .TP
 287 -l|--logfile=logbasename
 288 File name for log/debug files\&. The extension \fB"\&.client"\fR will be appended\&. The log file is never removed by the client\&.
 289
 290
 291 .SH "NOTES"
 292
 293 .PP
 294 This command may be used only by root\&.
 295
 296 .SH "VERSION"
 297
 298 .PP
 299 This man page is correct for version 2\&.2 of the Samba suite\&.
 300
 301 .SH "SEE ALSO"
 302
 303 .PP
 304 \fBsmbpasswd\fR(5), \fBsamba\fR(7)
 305
 306 .SH "AUTHOR"
 307
 308 .PP
 309 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\&.
 310
 311 .PP
 312 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\&. The conversion to DocBook XML 4\&.2 for Samba 3\&.0 was done by Alexander Bokovoy\&.
 313