← Back to branch summary

~zulcss/samba/server-dailies-3.4

« back to all changes in this revision

Viewing changes to docs-xml/manpages-3/wbinfo.1.xml

  • Committer: Chuck Short
  • Date: 2010-09-28 20:38:39 UTC
  • Revision ID: zulcss@ubuntu.com-20100928203839-pgjulytsi9ue63x1
Initial version

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs-xml/manpages-3/wbinfo.1.xml
 
1
<?xml version="1.0" encoding="iso-8859-1"?>
 
2
<!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
 
3
<refentry id="wbinfo.1">
 
4
 
 
5
<refmeta>
 
6
        <refentrytitle>wbinfo</refentrytitle>
 
7
        <manvolnum>1</manvolnum>
 
8
        <refmiscinfo class="source">Samba</refmiscinfo>
 
9
        <refmiscinfo class="manual">User Commands</refmiscinfo>
 
10
        <refmiscinfo class="version">3.4</refmiscinfo>
 
11
</refmeta>
 
12
 
 
13
 
 
14
<refnamediv>
 
15
        <refname>wbinfo</refname>
 
16
        <refpurpose>Query information from winbind daemon</refpurpose>
 
17
</refnamediv>
 
18
 
 
19
<refsynopsisdiv>
 
20
        <cmdsynopsis>
 
21
                <command>wbinfo</command>
 
22
                <arg choice="opt">-a user%password</arg>
 
23
                <arg choice="opt">--all-domains</arg>
 
24
                <arg choice="opt">--allocate-gid</arg>
 
25
                <arg choice="opt">--allocate-uid</arg>
 
26
                <arg choice="opt">-D domain</arg>
 
27
                <arg choice="opt">--domain domain</arg>
 
28
                <arg choice="opt">-g</arg>
 
29
                <arg choice="opt">--getdcname domain</arg>
 
30
                <arg choice="opt">--get-auth-user</arg>
 
31
                <arg choice="opt">-G gid</arg>
 
32
                <arg choice="opt">-h</arg>
 
33
                <arg choice="opt">-i user</arg>
 
34
                <arg choice="opt">-I ip</arg>
 
35
                <arg choice="opt">-K user%password</arg>
 
36
                <arg choice="opt">-m</arg>
 
37
                <arg choice="opt">-n name</arg>
 
38
                <arg choice="opt">-N netbios-name</arg>
 
39
                <arg choice="opt">--own-domain</arg>
 
40
                <arg choice="opt">-p</arg>
 
41
                <arg choice="opt">-r user</arg>
 
42
                <arg choice="opt">--remove-uid-mapping uid,sid</arg>
 
43
                <arg choice="opt">--remove-gid-mapping gid,sid</arg>
 
44
                <arg choice="opt">-s sid</arg>
 
45
                <arg choice="opt">--separator</arg>
 
46
                <arg choice="opt">--sequence</arg>
 
47
                <arg choice="opt">--set-auth-user user%password</arg>
 
48
                <arg choice="opt">--set-uid-mapping uid,sid</arg>
 
49
                <arg choice="opt">--set-gid-mapping gid,sid</arg>
 
50
                <arg choice="opt">-S sid</arg>
 
51
                <arg choice="opt">-t</arg>
 
52
                <arg choice="opt">-u</arg>
 
53
                <arg choice="opt">--uid-info uid</arg>
 
54
                <arg choice="opt">--user-domgroups sid</arg>
 
55
                <arg choice="opt">--user-sids sid</arg>
 
56
                <arg choice="opt">-U uid</arg>
 
57
                <arg choice="opt">-V</arg>
 
58
                <arg choice="opt">-Y sid</arg>
 
59
                <arg choice="opt">--verbose</arg>
 
60
        </cmdsynopsis>
 
61
</refsynopsisdiv>
 
62
 
 
63
<refsect1>
 
64
        <title>DESCRIPTION</title>
 
65
 
 
66
        <para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
 
67
        <manvolnum>7</manvolnum></citerefentry> suite.</para>
 
68
 
 
69
        <para>The <command>wbinfo</command> program queries and returns information
 
70
        created and used by the <citerefentry><refentrytitle>winbindd</refentrytitle>
 
71
        <manvolnum>8</manvolnum></citerefentry> daemon. </para>
 
72
 
 
73
        <para>The <citerefentry><refentrytitle>winbindd</refentrytitle>
 
74
        <manvolnum>8</manvolnum></citerefentry> daemon must be configured
 
75
        and running for the <command>wbinfo</command> program to be able
 
76
        to return information.</para>
 
77
</refsect1>
 
78
 
 
79
<refsect1>
 
80
        <title>OPTIONS</title>
 
81
 
 
82
        <variablelist>
 
83
                <varlistentry>
 
84
                <term>-a|--authenticate <replaceable>username%password</replaceable></term>
 
85
                <listitem><para>Attempt to authenticate a user via <citerefentry>
 
86
                <refentrytitle>winbindd</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
 
87
                This checks both authentication methods and reports its results.
 
88
                </para><note><para>Do not be tempted to use this
 
89
                functionality for authentication in third-party
 
90
                applications.  Instead use <citerefentry><refentrytitle>ntlm_auth</refentrytitle>
 
91
        <manvolnum>1</manvolnum></citerefentry>.</para></note></listitem>
 
92
                </varlistentry>
 
93
 
 
94
                <varlistentry>
 
95
                <term>--allocate-gid</term>
 
96
                <listitem><para>Get a new GID out of idmap
 
97
                </para></listitem>
 
98
                </varlistentry>
 
99
 
 
100
                <varlistentry>
 
101
                <term>--allocate-uid</term>
 
102
                <listitem><para>Get a new UID out of idmap
 
103
                </para></listitem>
 
104
                </varlistentry>
 
105
 
 
106
                <varlistentry>
 
107
                <term>--all-domains</term>
 
108
                <listitem><para>List all domains (trusted and
 
109
                own domain).
 
110
                </para></listitem>
 
111
                </varlistentry>
 
112
 
 
113
                <varlistentry>
 
114
                <term>--domain <replaceable>name</replaceable></term>
 
115
                <listitem><para>This parameter sets the domain on which any specified
 
116
                operations will performed.  If special domain name '.' is used to represent
 
117
                the current domain to which <citerefentry><refentrytitle>winbindd</refentrytitle>
 
118
                <manvolnum>8</manvolnum></citerefentry> belongs.  Currently only the
 
119
                <option>--sequence</option>,
 
120
                <option>-u</option>, and <option>-g</option> options honor this parameter.
 
121
                </para></listitem>
 
122
                </varlistentry>
 
123
 
 
124
                <varlistentry>
 
125
                <term>-D|--domain-info <replaceable>domain</replaceable></term>
 
126
                <listitem><para>Show most of the info we have about the
 
127
                specified domain.
 
128
                </para></listitem>
 
129
                </varlistentry>
 
130
 
 
131
                <varlistentry>
 
132
                <term>-g|--domain-groups</term>
 
133
                <listitem><para>This option will list all groups available
 
134
                in the Windows NT domain for which the <citerefentry><refentrytitle>samba</refentrytitle>
 
135
                <manvolnum>7</manvolnum></citerefentry> daemon is operating in. Groups in all trusted domains
 
136
                will also be listed.  Note that this operation does not assign
 
137
                group ids to any groups that have not already been
 
138
                seen by <citerefentry><refentrytitle>winbindd</refentrytitle>
 
139
                <manvolnum>8</manvolnum></citerefentry>. </para></listitem>
 
140
                </varlistentry>
 
141
 
 
142
                <varlistentry>
 
143
                <term>--get-auth-user</term>
 
144
                <listitem><para>Print username and password used by <citerefentry>
 
145
                <refentrytitle>winbindd</refentrytitle><manvolnum>8</manvolnum></citerefentry>
 
146
                during session setup to a domain controller. Username
 
147
                and password can be set using <option>--set-auth-user</option>.
 
148
                Only available for root.</para></listitem>
 
149
                </varlistentry>
 
150
 
 
151
                <varlistentry>
 
152
                <term>--getdcname <replaceable>domain</replaceable></term>
 
153
                <listitem><para>Get the DC name for the specified domain.
 
154
                </para></listitem>
 
155
                </varlistentry>
 
156
 
 
157
                <varlistentry>
 
158
                <term>-G|--gid-to-sid <replaceable>gid</replaceable></term>
 
159
                <listitem><para>Try to convert a UNIX group id to a Windows
 
160
                NT SID.  If the gid specified does not refer to one within
 
161
                the idmap gid range then the operation will fail. </para></listitem>
 
162
                </varlistentry>
 
163
 
 
164
                <varlistentry>
 
165
                <term>-i|--user-info <replaceable>user</replaceable></term>
 
166
                <listitem><para>Get user info.
 
167
                </para></listitem>
 
168
                </varlistentry>
 
169
 
 
170
                <varlistentry>
 
171
                <term>-I|--WINS-by-ip <replaceable>ip</replaceable></term>
 
172
                <listitem><para>The <parameter>-I</parameter> option
 
173
                queries <citerefentry><refentrytitle>winbindd</refentrytitle>
 
174
                <manvolnum>8</manvolnum></citerefentry> to send a node status
 
175
                request to get the NetBIOS name associated with the IP address
 
176
                specified by the <parameter>ip</parameter> parameter.
 
177
                </para></listitem>
 
178
                </varlistentry>
 
179
 
 
180
                <varlistentry>
 
181
                <term>-K|--krb5auth <replaceable>username%password</replaceable></term>
 
182
                <listitem><para>Attempt to authenticate a user via Kerberos.
 
183
                </para></listitem>
 
184
                </varlistentry>
 
185
 
 
186
                <varlistentry>
 
187
                <term>-m|--trusted-domains</term>
 
188
                <listitem><para>Produce a list of domains trusted by the
 
189
                Windows NT server <citerefentry><refentrytitle>winbindd</refentrytitle>
 
190
                <manvolnum>8</manvolnum></citerefentry> contacts
 
191
                when resolving names.  This list does not include the Windows
 
192
                NT domain the server is a Primary Domain Controller for.
 
193
                </para></listitem>
 
194
                </varlistentry>
 
195
 
 
196
                <varlistentry>
 
197
                <term>-n|--name-to-sid <replaceable>name</replaceable></term>
 
198
                <listitem><para>The <parameter>-n</parameter> option
 
199
                queries <citerefentry><refentrytitle>winbindd</refentrytitle>
 
200
                <manvolnum>8</manvolnum></citerefentry> for the SID
 
201
                associated with the name specified. Domain names can be specified
 
202
                before the user name by using the winbind separator character.
 
203
                For example CWDOM1/Administrator refers to the Administrator
 
204
                user in the domain CWDOM1.  If no domain is specified then the
 
205
                domain used is the one specified in the <citerefentry><refentrytitle>smb.conf</refentrytitle>
 
206
                <manvolnum>5</manvolnum></citerefentry> <parameter>workgroup
 
207
                </parameter> parameter. </para></listitem>
 
208
                </varlistentry>
 
209
 
 
210
                <varlistentry>
 
211
                <term>-N|--WINS-by-name <replaceable>name</replaceable></term>
 
212
                <listitem><para>The <parameter>-N</parameter> option
 
213
                queries <citerefentry><refentrytitle>winbindd</refentrytitle>
 
214
                <manvolnum>8</manvolnum></citerefentry> to query the WINS
 
215
                server for the IP address associated with the NetBIOS name
 
216
                specified by the <parameter>name</parameter> parameter.
 
217
                </para></listitem>
 
218
                </varlistentry>
 
219
 
 
220
                <varlistentry>
 
221
                <term>--own-domain</term>
 
222
                <listitem><para>List own domain.
 
223
                </para></listitem>
 
224
                </varlistentry>
 
225
 
 
226
                <varlistentry>
 
227
                <term>-p|--ping</term>
 
228
                <listitem><para>Check whether <citerefentry><refentrytitle>winbindd</refentrytitle>
 
229
                <manvolnum>8</manvolnum></citerefentry> is still alive.
 
230
                Prints out either 'succeeded' or 'failed'.
 
231
                </para></listitem>
 
232
                </varlistentry>
 
233
 
 
234
                <varlistentry>
 
235
                <term>-r|--user-groups <replaceable>username</replaceable></term>
 
236
                <listitem><para>Try to obtain the list of UNIX group ids
 
237
                to which the user belongs.  This only works for users
 
238
                defined on a Domain Controller.
 
239
                </para></listitem>
 
240
                </varlistentry>
 
241
 
 
242
                <varlistentry>
 
243
                <term>-s|--sid-to-name <replaceable>sid</replaceable></term>
 
244
                <listitem><para>Use <parameter>-s</parameter> to resolve
 
245
                a SID to a name.  This is the inverse of the <parameter>-n
 
246
                </parameter> option above.  SIDs must be specified as ASCII strings
 
247
                in the traditional Microsoft format. For example,
 
248
                S-1-5-21-1455342024-3071081365-2475485837-500. </para></listitem>
 
249
                </varlistentry>
 
250
 
 
251
                <varlistentry>
 
252
                <term>--separator</term>
 
253
                <listitem><para>Get the active winbind separator.
 
254
                </para></listitem>
 
255
 
 
256
                </varlistentry>
 
257
                <varlistentry>
 
258
                <term>--sequence</term>
 
259
                <listitem><para>Show sequence numbers of all known domains.
 
260
                </para></listitem>
 
261
                </varlistentry>
 
262
 
 
263
                <varlistentry>
 
264
                <term>--set-auth-user <replaceable>username%password</replaceable></term>
 
265
                <listitem><para>Store username and password used by <citerefentry>
 
266
                <refentrytitle>winbindd</refentrytitle><manvolnum>8</manvolnum>
 
267
                </citerefentry> during session setup to a domain controller.  This enables
 
268
                winbindd to operate in a Windows 2000 domain with Restrict
 
269
                Anonymous turned on (a.k.a. Permissions compatible with
 
270
                Windows 2000 servers only).
 
271
                </para></listitem>
 
272
                </varlistentry>
 
273
 
 
274
                <varlistentry>
 
275
                <term>-S|--sid-to-uid <replaceable>sid</replaceable></term>
 
276
                <listitem><para>Convert a SID to a UNIX user id.  If the SID
 
277
                does not correspond to a UNIX user mapped by <citerefentry>
 
278
                <refentrytitle>winbindd</refentrytitle><manvolnum>8</manvolnum>
 
279
                </citerefentry> then the operation will fail. </para></listitem>
 
280
                </varlistentry>
 
281
 
 
282
                <varlistentry>
 
283
                <term>-t|--check-secret</term>
 
284
                <listitem><para>Verify that the workstation trust account
 
285
                created when the Samba server is added to the Windows NT
 
286
                domain is working. </para></listitem>
 
287
                </varlistentry>
 
288
 
 
289
                <varlistentry>
 
290
                <term>-u|--domain-users</term>
 
291
                <listitem><para>This option will list all users available
 
292
                in the Windows NT domain for which the <citerefentry><refentrytitle>winbindd</refentrytitle>
 
293
                <manvolnum>8</manvolnum></citerefentry> daemon is operating in. Users in all trusted domains
 
294
                will also be listed.  Note that this operation does not assign
 
295
                user ids to any users that have not already been seen by <citerefentry>
 
296
                <refentrytitle>winbindd</refentrytitle><manvolnum>8</manvolnum></citerefentry>
 
297
                .</para></listitem>
 
298
                </varlistentry>
 
299
 
 
300
                <varlistentry>
 
301
                <term>--uid-info <replaceable>uid</replaceable></term>
 
302
                <listitem><para>Get user info for the user connected to
 
303
                user id UID.</para></listitem>
 
304
                </varlistentry>
 
305
 
 
306
                <varlistentry>
 
307
                <term>--user-domgroups <replaceable>sid</replaceable></term>
 
308
                <listitem><para>Get user domain groups.
 
309
                </para></listitem>
 
310
                </varlistentry>
 
311
 
 
312
                <varlistentry>
 
313
                <term>--user-sids <replaceable>sid</replaceable></term>
 
314
                <listitem><para>Get user group SIDs for user.
 
315
                </para></listitem>
 
316
                </varlistentry>
 
317
 
 
318
                <varlistentry>
 
319
                <term>-U|--uid-to-sid <replaceable>uid</replaceable></term>
 
320
                <listitem><para>Try to convert a UNIX user id to a Windows NT
 
321
                SID.  If the uid specified does not refer to one within
 
322
                the idmap uid range then the operation will fail. </para></listitem>
 
323
                </varlistentry>
 
324
 
 
325
                <varlistentry>
 
326
                <term>--verbose</term>
 
327
                <listitem><para>
 
328
                Print additional information about the query results.
 
329
                </para></listitem>
 
330
                </varlistentry>
 
331
 
 
332
                <varlistentry>
 
333
                <term>-Y|--sid-to-gid <replaceable>sid</replaceable></term>
 
334
                <listitem><para>Convert a SID to a UNIX group id.  If the SID
 
335
                does not correspond to a UNIX group mapped by <citerefentry>
 
336
                <refentrytitle>winbindd</refentrytitle><manvolnum>8</manvolnum></citerefentry> then
 
337
                the operation will fail. </para></listitem>
 
338
                </varlistentry>
 
339
 
 
340
                <varlistentry>
 
341
                <term>--remove-uid-mapping uid,sid</term>
 
342
                <listitem><para>Remove an existing uid to sid mapping
 
343
                entry from the IDmap backend.</para></listitem>
 
344
                </varlistentry>
 
345
 
 
346
                <varlistentry>
 
347
                <term>--remove-gid-mapping gid,sid</term>
 
348
                <listitem><para>Remove an existing gid to sid
 
349
                mapping entry from the IDmap backend.</para></listitem>
 
350
                </varlistentry>
 
351
 
 
352
                <varlistentry>
 
353
                <term>--set-uid-mapping uid,sid</term>
 
354
                <listitem><para>Create a new or modify an existing uid to sid
 
355
                mapping in the IDmap backend.</para></listitem>
 
356
                </varlistentry>
 
357
 
 
358
                <varlistentry>
 
359
                <term>--set-gid-mapping gid,sid</term>
 
360
                <listitem><para>Create a new or modify an existing gid to sid
 
361
                mapping in the IDmap backend.</para></listitem>
 
362
                </varlistentry>
 
363
 
 
364
                &stdarg.version;
 
365
                &stdarg.help;
 
366
 
 
367
        </variablelist>
 
368
</refsect1>
 
369
 
 
370
 
 
371
<refsect1>
 
372
        <title>EXIT STATUS</title>
 
373
 
 
374
        <para>The wbinfo program returns 0 if the operation
 
375
        succeeded, or 1 if the operation failed.  If the <citerefentry>
 
376
        <refentrytitle>winbindd</refentrytitle><manvolnum>8</manvolnum>
 
377
        </citerefentry> daemon is not working <command>wbinfo</command> will always return
 
378
        failure. </para>
 
379
</refsect1>
 
380
 
 
381
 
 
382
<refsect1>
 
383
        <title>VERSION</title>
 
384
 
 
385
        <para>This man page is correct for version 3 of
 
386
        the Samba suite.</para>
 
387
</refsect1>
 
388
 
 
389
<refsect1>
 
390
        <title>SEE ALSO</title>
 
391
        <para><citerefentry><refentrytitle>winbindd</refentrytitle>
 
392
        <manvolnum>8</manvolnum></citerefentry> and <citerefentry><refentrytitle>ntlm_auth</refentrytitle>
 
393
        <manvolnum>1</manvolnum></citerefentry></para>
 
394
</refsect1>
 
395
 
 
396
<refsect1>
 
397
        <title>AUTHOR</title>
 
398
 
 
399
        <para>The original Samba software and related utilities
 
400
        were created by Andrew Tridgell. Samba is now developed
 
401
        by the Samba Team as an Open Source project similar
 
402
        to the way the Linux kernel is developed.</para>
 
403
 
 
404
        <para><command>wbinfo</command> and <command>winbindd</command>
 
405
        were written by Tim Potter.</para>
 
406
 
 
407
        <para>The conversion to DocBook for Samba 2.2 was done
 
408
        by Gerald Carter. The conversion to DocBook XML 4.2 for Samba
 
409
        3.0 was done by Alexander Bokovoy.</para>
 
410
</refsect1>
 
411
 
 
412
</refentry>