source: vendor/current/docs/manpages/pdbedit.8@ 988

Last change on this file since 988 was 988, checked in by Silvan Scherrer, 9 years ago

Samba Server: update vendor to version 4.4.3

File size: 13.5 KB
Line 
1'\" t
2.\" Title: pdbedit
3.\" Author: [see the "AUTHOR" section]
4.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
5.\" Date: 05/02/2016
6.\" Manual: System Administration tools
7.\" Source: Samba 4.4
8.\" Language: English
9.\"
10.TH "PDBEDIT" "8" "05/02/2016" "Samba 4\&.4" "System Administration tools"
11.\" -----------------------------------------------------------------
12.\" * Define some portability stuff
13.\" -----------------------------------------------------------------
14.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15.\" http://bugs.debian.org/507673
16.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18.ie \n(.g .ds Aq \(aq
19.el .ds Aq '
20.\" -----------------------------------------------------------------
21.\" * set default formatting
22.\" -----------------------------------------------------------------
23.\" disable hyphenation
24.nh
25.\" disable justification (adjust text to left margin only)
26.ad l
27.\" -----------------------------------------------------------------
28.\" * MAIN CONTENT STARTS HERE *
29.\" -----------------------------------------------------------------
30.SH "NAME"
31pdbedit \- manage the SAM database (Database of Samba Users)
32.SH "SYNOPSIS"
33.HP \w'\ 'u
34pdbedit [\-a] [\-b\ passdb\-backend] [\-c\ account\-control] [\-C\ value] [\-d\ debuglevel] [\-D\ drive] [\-e\ passdb\-backend] [\-f\ fullname] [\-\-force\-initialized\-passwords] [\-g] [\-h\ homedir] [\-i\ passdb\-backend] [\-I\ domain] [\-K] [\-L] [\-m] [\-M\ SID|RID] [\-N\ description] [\-P\ account\-policy] [\-p\ profile] [\-\-policies\-reset] [\-r] [\-s\ configfile] [\-S\ script] [\-\-set\-nt\-hash] [\-t] [\-\-time\-format] [\-u\ username] [\-U\ SID|RID] [\-v] [\-V] [\-w] [\-x] [\-y] [\-z] [\-Z]
35.SH "DESCRIPTION"
36.PP
37This tool is part of the
38\fBsamba\fR(7)
39suite\&.
40.PP
41The pdbedit program is used to manage the users accounts stored in the sam database and can only be run by root\&.
42.PP
43The 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)\&.
44.PP
45There are five main ways to use pdbedit: adding a user account, removing a user account, modifying a user account, listing user accounts, importing users accounts\&.
46.SH "OPTIONS"
47.PP
48\-L|\-\-list
49.RS 4
50This option lists all the user accounts present in the users database\&. This option prints a list of user/uid pairs separated by the \*(Aq:\*(Aq character\&.
51.sp
52Example:
53pdbedit \-L
54.sp
55.if n \{\
56.RS 4
57.\}
58.nf
59sorce:500:Simo Sorce
60samba:45:Test User
61.fi
62.if n \{\
63.RE
64.\}
65.RE
66.PP
67\-v|\-\-verbose
68.RS 4
69This 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\&. Used together with \-w also shows passwords hashes\&.
70.sp
71Example:
72pdbedit \-L \-v
73.sp
74.if n \{\
75.RS 4
76.\}
77.nf
78\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
79username: sorce
80user ID/Group: 500/500
81user RID/GRID: 2000/2001
82Full Name: Simo Sorce
83Home Directory: \e\eBERSERKER\esorce
84HomeDir Drive: H:
85Logon Script: \e\eBERSERKER\enetlogon\esorce\&.bat
86Profile Path: \e\eBERSERKER\eprofile
87\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
88username: samba
89user ID/Group: 45/45
90user RID/GRID: 1090/1091
91Full Name: Test User
92Home Directory: \e\eBERSERKER\esamba
93HomeDir Drive:
94Logon Script:
95Profile Path: \e\eBERSERKER\eprofile
96.fi
97.if n \{\
98.RE
99.\}
100.RE
101.PP
102\-w|\-\-smbpasswd\-style
103.RS 4
104This 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
105smbpasswd
106file format\&. (see the
107\fBsmbpasswd\fR(5)
108for details)\&. Instead used together with (\-v) displays the passwords hashes in verbose output\&.
109.sp
110Example:
111pdbedit \-L \-w
112.sp
113.if n \{\
114.RS 4
115.\}
116.nf
117sorce:500:508818B733CE64BEAAD3B435B51404EE:
118 D2A2418EFC466A8A0F6B1DBB5C3DB80C:
119 [UX ]:LCT\-00000000:
120samba:45:0F2B255F7B67A7A9AAD3B435B51404EE:
121 BC281CE3F53B6A5146629CD4751D3490:
122 [UX ]:LCT\-3BFA1E8D:
123.fi
124.if n \{\
125.RE
126.\}
127.RE
128.PP
129\-u|\-\-user username
130.RS 4
131This option specifies the username to be used for the operation requested (listing, adding, removing)\&. It is
132\fIrequired\fR
133in add, remove and modify operations and
134\fIoptional\fR
135in list operations\&.
136.RE