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         [-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 -G SID|rid
 152 This option can be used while adding or modifying a user account\&. It will specify the users' new primary group SID (Security Identifier) or rid\&.
 153
 154
 155 Example: \fB-G S-1-5-21-2447931902-1787058256-3961074038-1201\fR
 156
 157
 158 .TP
 159 -U SID|rid
 160 This option can be used while adding or modifying a user account\&. It will specify the users' new SID (Security Identifier) or rid\&.
 161
 162
 163 Example: \fB-U S-1-5-21-2447931902-1787058256-3961074038-5004\fR
 164
 165
 166 .TP
 167 -c account-control
 168 This option can be used while adding or modifying a user account\&. It will specify the users' account control property\&. Possible flags that can be set are: N, D, H, L, X\&.
 169
 170
 171 Example: \fB-c "[X ]"\fR
 172
 173
 174 .TP
 175 -a
 176 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\&.
 177
 178
 179 Example: \fBpdbedit -a -u sorce\fR
 180 .nf
 181 new password:
 182 retype new password
 183 .fi
 184
 185
 186
 187 .TP
 188 -r
 189 This option is used to modify an existing user in the database\&. This command needs a user name specified with the -u switch\&. Other options can be specified to modify the properties of the specified user\&. This flag is kept for backwards compatibility, but it is no longer necessary to specify it\&.
 190
 191
 192 .TP
 193 -m
 194 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)\&.
 195
 196
 197 Example: \fBpdbedit -a -m -u w2k-wks\fR
 198
 199
 200 .TP
 201 -x
 202 This option causes pdbedit to delete an account from the database\&. It needs a username specified with the -u switch\&.
 203
 204
 205 Example: \fBpdbedit -x -u bob\fR
 206
 207
 208 .TP
 209 -i passdb-backend
 210 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\&.
 211
 212
 213 This option will ease migration from one passdb backend to another\&.
 214
 215
 216 Example: \fBpdbedit -i smbpasswd:/etc/smbpasswd.old \fR
 217
 218
 219 .TP
 220 -e passdb-backend
 221 Exports all currently available users to the specified password database backend\&.
 222
 223
 224 This option will ease migration from one passdb backend to another and will ease backing up\&.
 225
 226
 227 Example: \fBpdbedit -e smbpasswd:/root/samba-users.backup\fR
 228
 229
 230 .TP
 231 -g
 232 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\&.
 233
 234
 235 This option will ease migration from one passdb backend to another and will ease backing up\&.
 236
 237
 238 .TP
 239 -b passdb-backend
 240 Use a different default passdb backend\&.
 241
 242
 243 Example: \fBpdbedit -b xml:/root/pdb-backup.xml -l\fR
 244
 245
 246 .TP
 247 -P account-policy
 248 Display an account policy
 249
 250
 251 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\&.
 252
 253
 254 Example: \fBpdbedit -P "bad lockout attempt"\fR
 255
 256
 257 .nf
 258
 259 account policy value for bad lockout attempt is 0
 260 .fi
 261
 262
 263 .TP
 264 -C account-policy-value
 265 Sets an account policy to a specified value\&. This option may only be used in conjunction with the \fI-P\fR option\&.
 266
 267
 268 Example: \fBpdbedit -P "bad lockout attempt" -C 3\fR
 269
 270
 271 .nf
 272
 273 account policy value for bad lockout attempt was 0
 274 account policy value for bad lockout attempt is now 3
 275 .fi
 276
 277
 278 .TP
 279 -h|--help
 280 Print a summary of command line options\&.
 281
 282
 283 .TP
 284 -V
 285 Prints the version number for \fBsmbd\fR\&.
 286
 287
 288 .TP
 289 -s <configuration file>
 290 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\&.
 291
 292
 293 .TP
 294 -d|--debug=debuglevel
 295 \fIdebuglevel\fR is an integer from 0 to 10\&. The default value if this parameter is not specified is zero\&.
 296
 297
 298 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\&.
 299
 300
 301 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\&.
 302
 303
 304 Note that specifying this parameter here will override the log level parameter in the \fIsmb\&.conf(5)\fR file\&.
 305
 306
 307 .TP
 308 -l|--logfile=logbasename
 309 File name for log/debug files\&. The extension \fB"\&.client"\fR will be appended\&. The log file is never removed by the client\&.
 310
 311
 312 .SH "NOTES"
 313
 314 .PP
 315 This command may be used only by root\&.
 316
 317 .SH "VERSION"
 318
 319 .PP
 320 This man page is correct for version 3\&.0 of the Samba suite\&.
 321
 322 .SH "SEE ALSO"
 323
 324 .PP
 325 \fBsmbpasswd\fR(5), \fBsamba\fR(7)
 326
 327 .SH "AUTHOR"
 328
 329 .PP
 330 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\&.
 331