source: vendor/3.6.0/docs-xml/manpages-3/wbinfo.1.xml

Last change on this file was 740, checked in by Silvan Scherrer, 13 years ago

Samba Server: update vendor to 3.6.0

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