source: branches/samba-3.5.x/docs-xml/manpages-3/wbinfo.1.xml@ 736

Last change on this file since 736 was 599, checked in by Herwig Bauernfeind, 14 years ago

Samba 3.5: Update trunk to 3.5.9

File size: 18.0 KB
Line 
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.5</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">-c</arg>
27 <arg choide="opt">--ccache-save</arg>
28 <arg choide="opt">--change-user-password</arg>
29 <arg choice="opt">-D domain</arg>
30 <arg choice="opt">--domain domain</arg>
31 <arg choide="opt">--dsgetdcname domain</arg>
32 <arg choice="opt">-g</arg>
33 <arg choice="opt">--getdcname domain</arg>
34 <arg choice="opt">--get-auth-user</arg>
35 <arg choice="opt">-G gid</arg>
36 <arg choide="opt">--gid-info</arg>
37 <arg choide="opt">--group-info</arg>
38 <arg choice="opt">--help|-?</arg>
39 <arg choice="opt">-i user</arg>
40 <arg choice="opt">-I ip</arg>
41 <arg choice="opt">-K user%password</arg>
42 <arg choide="opt">--lanman</arg>
43 <arg choice="opt">-m</arg>
44 <arg choice="opt">-n name</arg>
45 <arg choice="opt">-N netbios-name</arg>
46 <arg choide="opt">--ntlmv2</arg>
47 <arg choide="opt">--online-status</arg>
48 <arg choice="opt">--own-domain</arg>
49 <arg choice="opt">-p</arg>
50 <arg choice="opt">-P|--ping-dc</arg>
51 <arg choice="opt">-r user</arg>
52 <arg choide="opt">-R|--lookup-rids</arg>
53 <arg choice="opt">--remove-uid-mapping uid,sid</arg>
54 <arg choice="opt">--remove-gid-mapping gid,sid</arg>
55 <arg choice="opt">-s sid</arg>
56 <arg choice="opt">--separator</arg>
57 <arg choice="opt">--sequence</arg>
58 <arg choice="opt">--set-auth-user user%password</arg>
59 <arg choice="opt">--set-uid-mapping uid,sid</arg>
60 <arg choice="opt">--set-gid-mapping gid,sid</arg>
61 <arg choice="opt">-S sid</arg>
62 <arg choide="opt">--sid-aliases</arg>
63 <arg choide="opt">--sid-to-fullname</arg>
64 <arg choice="opt">-t</arg>
65 <arg choice="opt">-u</arg>
66 <arg choice="opt">--uid-info uid</arg>
67 <arg choide="opt">--usage</arg>
68 <arg choice="opt">--user-domgroups sid</arg>
69 <arg choice="opt">--user-sids sid</arg>
70 <arg choice="opt">-U uid</arg>
71 <arg choice="opt">-V</arg>
72 <arg choice="opt">--verbose</arg>
73 <arg choice="opt">-Y sid</arg>
74
75 </cmdsynopsis>
76</refsynopsisdiv>
77
78<refsect1>
79 <title>DESCRIPTION</title>
80
81 <para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
82 <manvolnum>7</manvolnum></citerefentry> suite.</para>
83
84 <para>The <command>wbinfo</command> program queries and returns information
85 created and used by the <citerefentry><refentrytitle>winbindd</refentrytitle>
86 <manvolnum>8</manvolnum></citerefentry> daemon. </para>
87
88 <para>The <citerefentry><refentrytitle>winbindd</refentrytitle>
89 <manvolnum>8</manvolnum></citerefentry> daemon must be configured
90 and running for the <command>wbinfo</command> program to be able
91 to return information.</para>
92</refsect1>
93
94<refsect1>
95 <title>OPTIONS</title>
96
97 <variablelist>
98 <varlistentry>
99 <term>-a|--authenticate <replaceable>username%password</replaceable></term>
100 <listitem><para>Attempt to authenticate a user via <citerefentry>
101 <refentrytitle>winbindd</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
102 This checks both authentication methods and reports its results.
103 </para><note><para>Do not be tempted to use this
104 functionality for authentication in third-party
105 applications. Instead use <citerefentry><refentrytitle>ntlm_auth</refentrytitle>
106 <manvolnum>1</manvolnum></citerefentry>.</para></note></listitem>
107 </varlistentry>
108
109 <varlistentry>
110 <term>--allocate-gid</term>
111 <listitem><para>Get a new GID out of idmap
112 </para></listitem>
113 </varlistentry>
114
115 <varlistentry>
116 <term>--allocate-uid</term>
117 <listitem><para>Get a new UID out of idmap
118 </para></listitem>
119 </varlistentry>
120
121 <varlistentry>
122 <term>--all-domains</term>
123 <listitem><para>List all domains (trusted and
124 own domain).
125 </para></listitem>
126 </varlistentry>
127
128 <varlistentry>
129 <term>-c|--change-secret</term>
130 <listitem><para>Change the trust account password. May be used
131 in conjunction with <option>domain</option> in order to change
132 interdomain trust account passwords.
133 </para></listitem>
134 </varlistentry>
135
136 <varlistentry>
137 <term>--ccache-save <replaceable>username%password</replaceable></term>
138 <listitem><para>Store user and password for ccache.
139 </para></listitem>
140 </varlistentry>
141
142 <varlistentry>
143 <term>--change-user-password <replaceable>username</replaceable></term>
144 <listitem><para>Change the password of a user. The old and new password will be prompted.
145 </para></listitem>
146 </varlistentry>
147
148 <varlistentry>
149 <term>--domain <replaceable>name</replaceable></term>
150 <listitem><para>This parameter sets the domain on which any specified
151 operations will performed. If special domain name '.' is used to represent
152 the current domain to which <citerefentry><refentrytitle>winbindd</refentrytitle>
153 <manvolnum>8</manvolnum></citerefentry> belongs. Currently only the
154 <option>--sequence</option>,
155 <option>-u</option>, and <option>-g</option> options honor this parameter.
156 </para></listitem>
157 </varlistentry>
158
159 <varlistentry>
160 <term>-D|--domain-info <replaceable>domain</replaceable></term>
161 <listitem><para>Show most of the info we have about the
162 specified domain.
163 </para></listitem>
164 </varlistentry>
165
166 <varlistentry>
167 <term>--dsgetdcname <replaceable>domain</replaceable></term>
168 <listitem><para>Find a DC for a domain.
169 </para></listitem>
170 </varlistentry>
171
172 <varlistentry>
173 <term>--gid-info <replaceable>gid</replaceable></term>
174 <listitem><para>Get group info from gid.
175 </para></listitem>
176 </varlistentry>
177
178 <varlistentry>
179 <term>--group-info <replaceable>user</replaceable></term>
180 <listitem><para>Get group info for user.
181 </para></listitem>
182 </varlistentry>
183
184 <varlistentry>
185 <term>-g|--domain-groups</term>
186 <listitem><para>This option will list all groups available
187 in the Windows NT domain for which the <citerefentry><refentrytitle>samba</refentrytitle>
188 <manvolnum>7</manvolnum></citerefentry> daemon is operating in. Groups in all trusted domains
189 will also be listed. Note that this operation does not assign
190 group ids to any groups that have not already been
191 seen by <citerefentry><refentrytitle>winbindd</refentrytitle>
192 <manvolnum>8</manvolnum></citerefentry>. </para></listitem>
193 </varlistentry>
194
195 <varlistentry>
196 <term>--get-auth-user</term>
197 <listitem><para>Print username and password used by <citerefentry>
198 <refentrytitle>winbindd</refentrytitle><manvolnum>8</manvolnum></citerefentry>
199 during session setup to a domain controller. Username
200 and password can be set using <option>--set-auth-user</option>.
201 Only available for root.</para></listitem>
202 </varlistentry>
203
204 <varlistentry>
205 <term>--getdcname <replaceable>domain</replaceable></term>
206 <listitem><para>Get the DC name for the specified domain.
207 </para></listitem>
208 </varlistentry>
209
210 <varlistentry>
211 <term>-G|--gid-to-sid <replaceable>gid</replaceable></term>
212 <listitem><para>Try to convert a UNIX group id to a Windows
213 NT SID. If the gid specified does not refer to one within
214 the idmap gid range then the operation will fail. </para></listitem>
215 </varlistentry>
216
217 <varlistentry>
218 <term>-?</term>
219 <listitem><para>Print brief help overview.
220 </para></listitem>
221 </varlistentry>
222
223 <varlistentry>
224 <term>-i|--user-info <replaceable>user</replaceable></term>
225 <listitem><para>Get user info.
226 </para></listitem>
227 </varlistentry>
228
229 <varlistentry>
230 <term>-I|--WINS-by-ip <replaceable>ip</replaceable></term>
231 <listitem><para>The <parameter>-I</parameter> option
232 queries <citerefentry><refentrytitle>winbindd</refentrytitle>
233 <manvolnum>8</manvolnum></citerefentry> to send a node status
234 request to get the NetBIOS name associated with the IP address
235 specified by the <parameter>ip</parameter> parameter.
236 </para></listitem>
237 </varlistentry>
238
239 <varlistentry>
240 <term>-K|--krb5auth <replaceable>username%password</replaceable></term>
241 <listitem><para>Attempt to authenticate a user via Kerberos.
242 </para></listitem>
243 </varlistentry>
244
245 <varlistentry>
246 <term>--lanman</term>
247 <listitem><para>Use lanman cryptography for user authentication.
248 </para></listitem>
249 </varlistentry>
250
251 <varlistentry>
252 <term>-m|--trusted-domains</term>
253 <listitem><para>Produce a list of domains trusted by the
254 Windows NT server <citerefentry><refentrytitle>winbindd</refentrytitle>
255 <manvolnum>8</manvolnum></citerefentry> contacts
256 when resolving names. This list does not include the Windows
257 NT domain the server is a Primary Domain Controller for.
258 </para></listitem>
259 </varlistentry>
260
261 <varlistentry>
262 <term>-n|--name-to-sid <replaceable>name</replaceable></term>
263 <listitem><para>The <parameter>-n</parameter> option
264 queries <citerefentry><refentrytitle>winbindd</refentrytitle>
265 <manvolnum>8</manvolnum></citerefentry> for the SID
266 associated with the name specified. Domain names can be specified
267 before the user name by using the winbind separator character.
268 For example CWDOM1/Administrator refers to the Administrator
269 user in the domain CWDOM1. If no domain is specified then the
270 domain used is the one specified in the <citerefentry><refentrytitle>smb.conf</refentrytitle>
271 <manvolnum>5</manvolnum></citerefentry> <parameter>workgroup
272 </parameter> parameter. </para></listitem>
273 </varlistentry>
274
275 <varlistentry>
276 <term>-N|--WINS-by-name <replaceable>name</replaceable></term>
277 <listitem><para>The <parameter>-N</parameter> option
278 queries <citerefentry><refentrytitle>winbindd</refentrytitle>
279 <manvolnum>8</manvolnum></citerefentry> to query the WINS
280 server for the IP address associated with the NetBIOS name
281 specified by the <parameter>name</parameter> parameter.
282 </para></listitem>
283 </varlistentry>
284
285 <varlistentry>
286 <term>--ntlmv2</term>
287 <listitem><para>Use NTLMv2 cryptography for user authentication.
288 </para></listitem>
289 </varlistentry>
290
291 <varlistentry>
292 <term>--online-status <replaceable>domain</replaceable></term>
293 <listitem><para>Show whether domains are marked as online or
294 offline. An optional domain argument limits the
295 output to the online status of a given domain.
296 </para></listitem>
297 </varlistentry>
298
299 <varlistentry>
300 <term>--own-domain</term>
301 <listitem><para>List own domain.
302 </para></listitem>
303 </varlistentry>
304
305 <varlistentry>
306 <term>-p|--ping</term>
307 <listitem><para>Check whether <citerefentry><refentrytitle>winbindd</refentrytitle>
308 <manvolnum>8</manvolnum></citerefentry> is still alive.
309 Prints out either 'succeeded' or 'failed'.
310 </para></listitem>
311 </varlistentry>
312
313 <varlistentry>
314 <term>-r|--user-groups <replaceable>username</replaceable></term>
315 <listitem><para>Try to obtain the list of UNIX group ids
316 to which the user belongs. This only works for users
317 defined on a Domain Controller.
318 </para></listitem>
319 </varlistentry>
320
321 <varlistentry>
322 <term>-R|--lookup-rids <replaceable>rid1, rid2, rid3...</replaceable></term>
323 <listitem><para>Converts RIDs to names. Uses a comma separated
324 list of rids.
325 </para></listitem>
326 </varlistentry>
327
328 <varlistentry>
329 <term>-s|--sid-to-name <replaceable>sid</replaceable></term>
330 <listitem><para>Use <parameter>-s</parameter> to resolve
331 a SID to a name. This is the inverse of the <parameter>-n
332 </parameter> option above. SIDs must be specified as ASCII strings
333 in the traditional Microsoft format. For example,
334 S-1-5-21-1455342024-3071081365-2475485837-500. </para></listitem>
335 </varlistentry>
336
337 <varlistentry>
338 <term>--separator</term>
339 <listitem><para>Get the active winbind separator.
340 </para></listitem>
341
342 </varlistentry>
343 <varlistentry>
344 <term>--sequence</term>
345 <listitem><para>Show sequence numbers of all known domains.
346 </para></listitem>
347 </varlistentry>
348
349 <varlistentry>
350 <term>--set-auth-user <replaceable>username%password</replaceable></term>
351 <listitem><para>Store username and password used by <citerefentry>
352 <refentrytitle>winbindd</refentrytitle><manvolnum>8</manvolnum>
353 </citerefentry> during session setup to a domain controller. This enables
354 winbindd to operate in a Windows 2000 domain with Restrict
355 Anonymous turned on (a.k.a. Permissions compatible with
356 Windows 2000 servers only).
357 </para></listitem>
358 </varlistentry>
359
360 <varlistentry>
361 <term>-S|--sid-to-uid <replaceable>sid</replaceable></term>
362 <listitem><para>Convert a SID to a UNIX user id. If the SID
363 does not correspond to a UNIX user mapped by <citerefentry>
364 <refentrytitle>winbindd</refentrytitle><manvolnum>8</manvolnum>
365 </citerefentry> then the operation will fail. </para></listitem>
366 </varlistentry>
367
368 <varlistentry>
369 <term>--sid-aliases <replaceable>sid</replaceable></term>
370 <listitem><para>Get SID aliases for a given SID.
371 </para></listitem>
372 </varlistentry>
373
374 <varlistentry>
375 <term>--sid-to-fullname <replaceable>sid</replaceable></term>
376 <listitem><para>Converts a SID to a full username
377 (DOMAIN\username).
378 </para></listitem>
379 </varlistentry>
380
381 <varlistentry>
382 <term>-t|--check-secret</term>
383 <listitem><para>Verify that the workstation trust account
384 created when the Samba server is added to the Windows NT
385 domain is working. May be used in conjunction with
386 <option>domain</option> in order to verify interdomain
387 trust accounts.</para></listitem>
388 </varlistentry>
389
390 <varlistentry>
391 <term>-u|--domain-users</term>
392 <listitem><para>This option will list all users available
393 in the Windows NT domain for which the <citerefentry><refentrytitle>winbindd</refentrytitle>
394 <manvolnum>8</manvolnum></citerefentry> daemon is operating in. Users in all trusted domains
395 will also be listed. Note that this operation does not assign
396 user ids to any users that have not already been seen by <citerefentry>
397 <refentrytitle>winbindd</refentrytitle><manvolnum>8</manvolnum></citerefentry>
398 .</para></listitem>
399 </varlistentry>
400
401 <varlistentry>
402 <term>--uid-info <replaceable>uid</replaceable></term>
403 <listitem><para>Get user info for the user connected to
404 user id UID.</para></listitem>
405 </varlistentry>
406
407 <varlistentry>
408 <term>--usage</term>
409 <listitem><para>Print brief help overview.
410 </para></listitem>
411 </varlistentry>
412
413 <varlistentry>
414 <term>--user-domgroups <replaceable>sid</replaceable></term>
415 <listitem><para>Get user domain groups.
416 </para></listitem>
417 </varlistentry>
418
419 <varlistentry>
420 <term>--user-sids <replaceable>sid</replaceable></term>
421 <listitem><para>Get user group SIDs for user.
422 </para></listitem>
423 </varlistentry>
424
425 <varlistentry>
426 <term>-U|--uid-to-sid <replaceable>uid</replaceable></term>
427 <listitem><para>Try to convert a UNIX user id to a Windows NT
428 SID. If the uid specified does not refer to one within
429 the idmap uid range then the operation will fail. </para></listitem>
430 </varlistentry>
431
432 <varlistentry>
433 <term>--verbose</term>
434 <listitem><para>
435 Print additional information about the query results.
436 </para></listitem>
437 </varlistentry>
438
439 <varlistentry>
440 <term>-Y|--sid-to-gid <replaceable>sid</replaceable></term>
441 <listitem><para>Convert a SID to a UNIX group id. If the SID
442 does not correspond to a UNIX group mapped by <citerefentry>
443 <refentrytitle>winbindd</refentrytitle><manvolnum>8</manvolnum></citerefentry> then
444 the operation will fail. </para></listitem>
445 </varlistentry>
446
447 <varlistentry>
448 <term>--remove-uid-mapping uid,sid</term>
449 <listitem><para>Remove an existing uid to sid mapping
450 entry from the IDmap backend.</para></listitem>
451 </varlistentry>
452
453 <varlistentry>
454 <term>--remove-gid-mapping gid,sid</term>
455 <listitem><para>Remove an existing gid to sid
456 mapping entry from the IDmap backend.</para></listitem>
457 </varlistentry>
458
459 <varlistentry>
460 <term>--set-uid-mapping uid,sid</term>
461 <listitem><para>Create a new or modify an existing uid to sid
462 mapping in the IDmap backend.</para></listitem>
463 </varlistentry>
464
465 <varlistentry>
466 <term>--set-gid-mapping gid,sid</term>
467 <listitem><para>Create a new or modify an existing gid to sid
468 mapping in the IDmap backend.</para></listitem>
469 </varlistentry>
470
471 &stdarg.version;
472 &stdarg.help;
473
474 </variablelist>
475</refsect1>
476
477
478<refsect1>
479 <title>EXIT STATUS</title>
480
481 <para>The wbinfo program returns 0 if the operation
482 succeeded, or 1 if the operation failed. If the <citerefentry>
483 <refentrytitle>winbindd</refentrytitle><manvolnum>8</manvolnum>
484 </citerefentry> daemon is not working <command>wbinfo</command> will always return
485 failure. </para>
486</refsect1>
487
488
489<refsect1>
490 <title>VERSION</title>
491
492 <para>This man page is correct for version 3 of
493 the Samba suite.</para>
494</refsect1>
495
496<refsect1>
497 <title>SEE ALSO</title>
498 <para><citerefentry><refentrytitle>winbindd</refentrytitle>
499 <manvolnum>8</manvolnum></citerefentry> and <citerefentry><refentrytitle>ntlm_auth</refentrytitle>
500 <manvolnum>1</manvolnum></citerefentry></para>
501</refsect1>
502
503<refsect1>
504 <title>AUTHOR</title>
505
506 <para>The original Samba software and related utilities
507 were created by Andrew Tridgell. Samba is now developed
508 by the Samba Team as an Open Source project similar
509 to the way the Linux kernel is developed.</para>
510
511 <para><command>wbinfo</command> and <command>winbindd</command>
512 were written by Tim Potter.</para>
513
514 <para>The conversion to DocBook for Samba 2.2 was done
515 by Gerald Carter. The conversion to DocBook XML 4.2 for Samba
516 3.0 was done by Alexander Bokovoy.</para>
517</refsect1>
518
519</refentry>
Note: See TracBrowser for help on using the repository browser.