summaryrefslogtreecommitdiff
path: root/docs/docbook/manpages/smbgroupedit.8.sgml
blob: 53bc0bec610462db2293b2172e92586bd48fc614 (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
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
<refentry id="smbgroupedit">

<refmeta>
	<refentrytitle>smbgroupedit</refentrytitle>
	<manvolnum>8</manvolnum>
</refmeta>


<!-- ****************************************************
**              Name and Options                       **
**************************************************** -->
<refnamediv>
	<refname>smbgroupedit</refname>
	<refpurpose>Query/set/change UNIX - Windows NT group mapping</refpurpose>
</refnamediv>

<refsynopsisdiv>
	<cmdsynopsis>
		<command>smbroupedit</command>
		<arg choice="opt">-v [l|s]</arg>
		<arg choice="opt">-a UNIX-groupname [-d NT-groupname|-p privilege|]</arg>
	</cmdsynopsis>
</refsynopsisdiv>



<!-- ****************************************************
**                     Description                     **
**************************************************** -->
<refsect1>

<title>DESCRIPTION</title>

<para>
This program is part of the <ulink url="samba.7.html">Samba</ulink>
suite.
</para>

<para>
The  smbgroupedit  command  allows for mapping unix groups
to NT Builtin, Domain, or Local groups.  Also
allows setting privileges for that group, such as saAddUser,
etc.
</para>

</refsect1>

<refsect1>
	<title>OPTIONS</title>

	<variablelist>
		<varlistentry>
		<term>-v[l|s]</term>
		<listitem><para>This option will list all groups available
		in the Windows NT domain in which samba is operating.
		</para>

		<variablelist>
		<varlistentry>
		<term>-l</term>
		<listitem><para>give a long listing, of the format:</para>

<para><programlisting>
"NT Group Name"
    SID            :
    Unix group     :
    Group type     :
    Comment        :
    Privilege      :
</programlisting></para>

<para>For examples,</para>
<para><programlisting>
Users
    SID       : S-1-5-32-545
    Unix group: -1
    Group type: Local group
    Comment   :
    Privilege : No privilege
</programlisting></para>

		</listitem>
		</varlistentry>

		<varlistentry>
		<term>-s</term>
		<listitem><para>display a short listing of the format:</para>

<para><programlisting>
NTGroupName(SID) -> UnixGroupName
</programlisting></para>

<para>For example,</para>

<para><programlisting>
Users (S-1-5-32-545) -> -1
</programlisting></para>

		</listitem>
		</varlistentry>
		</variablelist>

		</listitem>
		</varlistentry>

	</variablelist>
</refsect1>



<!-- ****************************************************
**************************************************** -->
<refsect1>
<title>FILES</title>

<para></para>

</refsect1>



<!-- ****************************************************
**************************************************** -->
<refsect1>

<title>EXIT STATUS</title>

<para>
<command>smbgroupedit</command> returns a status of 0 if the
operation completed successfully, and a value of 1 in the event
of a failure.
</para>

</refsect1>




<!-- ****************************************************
**************************************************** -->
<refsect1>

<title>EXAMPLES</title>


<para>
To make a subset of your samba PDC users members of
the 'Domain Admins'  Global group:
</para>

<orderedlist>

	<listitem><para>create a unix group (usually in
	<filename>/etc/group</filename>), let's call it <constant>domadm</constant>.
	</para></listitem>

	<listitem><para>add to this group the users that you want to be
	domain administrators. For example if you want joe, john and mary,
	your entry in <filename>/etc/group</filename> will look like:
	</para>

	<para>domadm:x:502:joe,john,mary</para>
	</listitem>

	<listitem><para>map this domadm group to the 'domain admins' group:
	</para>
	<orderedlist>
		<listitem><para>Get the SID for the Windows NT "Domain Admins"
		group:</para>

<para><programlisting>
<prompt>root# </prompt><command>smbgroupedit -vs | grep "Domain Admins"</command>
Domain Admins (S-1-5-21-1108995562-3116817432-1375597819-512) -> -1
</programlisting></para>
</listitem>

		<listitem><para>map the unix domadm group to the Windows NT
		"Domain Admins" group, by running the command:
		</para>

<para><programlisting>
<prompt>root# </prompt><command>smbgroupedit \
-c S-1-5-21-1108995562-3116817432-1375597819-512 \
-u domadm</command>
</programlisting></para>

		<para>
		<emphasis>warning:</emphasis> don't copy and paste this sample, the
		Domain Admins SID (the S-1-5-21-...-512) is different for every PDC.
		</para>
		</listitem>
	</orderedlist>
	</listitem>
</orderedlist>

<para>
To verify that your mapping has taken effect:
</para>

<para><programlisting>
<prompt>root# </prompt><command>smbgroupedit -vs|grep "Domain Admins"</command>
Domain Admins (S-1-5-21-1108995562-3116817432-1375597819-512) -> domadm
</programlisting></para>

<para>
To give access to a certain directory on a domain member machine (an
NT/W2K or a samba server running winbind) to some users who are member
of a group on your samba PDC, flag that group as a domain group:
</para>

<para><programlisting>
<prompt>root# </prompt><command>smbgroupedit -a unixgroup -td</command>
</programlisting></para>



</refsect1>




<!-- ****************************************************
**************************************************** -->
<refsect1>

<title>VERSION</title>

<para>
This man page is correct for the 3.0alpha releases of
the Samba suite.
</para>
</refsect1>

<!-- ****************************************************
**************************************************** -->

<refsect1>
<title>SEE ALSO</title>

<para>
<ulink url="smb.conf.5.html">smb.conf(5)</ulink>
</para>

</refsect1>


<!-- ****************************************************
**************************************************** -->

<refsect1>
<title>AUTHOR</title>

<para>
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.
</para>

<para>
<command>smbgroupedit</command> was written by Jean Francois Micouleau.
The current set of manpages and documentation is maintained
by the Samba Team in the same fashion as the Samba source code.</para>
</refsect1>

</refentry>