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">
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">4.0</refmiscinfo>
15 <refname>wbinfo</refname>
16 <refpurpose>Query information from winbind daemon</refpurpose>
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 choice="opt">--ccache-save</arg>
28 <arg choice="opt">--change-user-password</arg>
29 <arg choice="opt">-D domain</arg>
30 <arg choice="opt">--dc-info domain</arg>
31 <arg choice="opt">--domain domain</arg>
32 <arg choice="opt">--dsgetdcname domain</arg>
33 <arg choice="opt">-g</arg>
34 <arg choice="opt">--getdcname domain</arg>
35 <arg choice="opt">--get-auth-user</arg>
36 <arg choice="opt">-G gid</arg>
37 <arg choice="opt">--gid-info gid</arg>
38 <arg choice="opt">--group-info group</arg>
39 <arg choice="opt">--help|-?</arg>
40 <arg choice="opt">-i user</arg>
41 <arg choice="opt">-I ip</arg>
42 <arg choice="opt">-K user%password</arg>
43 <arg choice="opt">--krb5ccname cctype</arg>
44 <arg choice="opt">--lanman</arg>
45 <arg choice="opt">--logoff</arg>
46 <arg choice="opt">--logoff-uid uid</arg>
47 <arg choice="opt">--logoff-user username</arg>
48 <arg choice="opt">--lookup-sids</arg>
49 <arg choice="opt">-m</arg>
50 <arg choice="opt">-n name</arg>
51 <arg choice="opt">-N netbios-name</arg>
52 <arg choice="opt">--ntlmv2</arg>
53 <arg choice="opt">--online-status</arg>
54 <arg choice="opt">--own-domain</arg>
55 <arg choice="opt">-p</arg>
56 <arg choice="opt">-P|--ping-dc</arg>
57 <arg choice="opt">--pam-logon user%password</arg>
58 <arg choice="opt">-r user</arg>
59 <arg choice="opt">-R|--lookup-rids</arg>
60 <arg choice="opt">--remove-gid-mapping gid,sid</arg>
61 <arg choice="opt">--remove-uid-mapping uid,sid</arg>
62 <arg choice="opt">-s sid</arg>
63 <arg choice="opt">--separator</arg>
64 <arg choice="opt">--sequence</arg>
65 <arg choice="opt">--set-auth-user user%password</arg>
66 <arg choice="opt">--set-gid-mapping gid,sid</arg>
67 <arg choice="opt">--set-uid-mapping uid,sid</arg>
68 <arg choice="opt">-S sid</arg>
69 <arg choice="opt">--sid-aliases sid</arg>
70 <arg choice="opt">--sid-to-fullname sid</arg>
71 <arg choice="opt">--sids-to-unix-ids sidlist</arg>
72 <arg choice="opt">-t</arg>
73 <arg choice="opt">-u</arg>
74 <arg choice="opt">--uid-info uid</arg>
75 <arg choice="opt">--usage</arg>
76 <arg choice="opt">--user-domgroups sid</arg>
77 <arg choice="opt">--user-sidinfo sid</arg>
78 <arg choice="opt">--user-sids sid</arg>
79 <arg choice="opt">-U uid</arg>
80 <arg choice="opt">-V</arg>
81 <arg choice="opt">--verbose</arg>
82 <arg choice="opt">-Y sid</arg>
88 <title>DESCRIPTION</title>
90 <para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
91 <manvolnum>7</manvolnum></citerefentry> suite.</para>
93 <para>The <command>wbinfo</command> program queries and returns information
94 created and used by the <citerefentry><refentrytitle>winbindd</refentrytitle>
95 <manvolnum>8</manvolnum></citerefentry> daemon. </para>
97 <para>The <citerefentry><refentrytitle>winbindd</refentrytitle>
98 <manvolnum>8</manvolnum></citerefentry> daemon must be configured
99 and running for the <command>wbinfo</command> program to be able
100 to return information.</para>
104 <title>OPTIONS</title>
108 <term>-a|--authenticate <replaceable>username%password</replaceable></term>
109 <listitem><para>Attempt to authenticate a user via <citerefentry>
110 <refentrytitle>winbindd</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
111 This checks both authentication methods and reports its results.
112 </para><note><para>Do not be tempted to use this
113 functionality for authentication in third-party
114 applications. Instead use <citerefentry><refentrytitle>ntlm_auth</refentrytitle>
115 <manvolnum>1</manvolnum></citerefentry>.</para></note></listitem>
119 <term>--allocate-gid</term>
120 <listitem><para>Get a new GID out of idmap
125 <term>--allocate-uid</term>
126 <listitem><para>Get a new UID out of idmap
131 <term>--all-domains</term>
132 <listitem><para>List all domains (trusted and
138 <term>-c|--change-secret</term>
139 <listitem><para>Change the trust account password. May be used
140 in conjunction with <option>domain</option> in order to change
141 interdomain trust account passwords.
146 <term>--ccache-save <replaceable>username%password</replaceable></term>
147 <listitem><para>Store user and password for ccache.
152 <term>--change-user-password <replaceable>username</replaceable></term>
153 <listitem><para>Change the password of a user. The old and new password will be prompted.
158 <term>--dc-info <replaceable>domain</replaceable></term>
159 <listitem><para>Displays information about the current domain controller for a domain.
164 <term>--domain <replaceable>name</replaceable></term>
165 <listitem><para>This parameter sets the domain on which any specified
166 operations will performed. If special domain name '.' is used to represent
167 the current domain to which <citerefentry><refentrytitle>winbindd</refentrytitle>
168 <manvolnum>8</manvolnum></citerefentry> belongs. Currently only the
169 <option>-u</option>, and <option>-g</option> options honor this parameter.
174 <term>-D|--domain-info <replaceable>domain</replaceable></term>
175 <listitem><para>Show most of the info we have about the
181 <term>--dsgetdcname <replaceable>domain</replaceable></term>
182 <listitem><para>Find a DC for a domain.
187 <term>--gid-info <replaceable>gid</replaceable></term>
188 <listitem><para>Get group info from gid.
193 <term>--group-info <replaceable>group</replaceable></term>
194 <listitem><para>Get group info from group name.
199 <term>-g|--domain-groups</term>
200 <listitem><para>This option will list all groups available
201 in the Windows NT domain for which the <citerefentry><refentrytitle>samba</refentrytitle>
202 <manvolnum>7</manvolnum></citerefentry> daemon is operating in. Groups in all trusted domains
203 will also be listed. Note that this operation does not assign
204 group ids to any groups that have not already been
205 seen by <citerefentry><refentrytitle>winbindd</refentrytitle>
206 <manvolnum>8</manvolnum></citerefentry>. </para></listitem>
210 <term>--get-auth-user</term>
211 <listitem><para>Print username and password used by <citerefentry>
212 <refentrytitle>winbindd</refentrytitle><manvolnum>8</manvolnum></citerefentry>
213 during session setup to a domain controller. Username
214 and password can be set using <option>--set-auth-user</option>.
215 Only available for root.</para></listitem>
219 <term>--getdcname <replaceable>domain</replaceable></term>
220 <listitem><para>Get the DC name for the specified domain.
225 <term>-G|--gid-to-sid <replaceable>gid</replaceable></term>
226 <listitem><para>Try to convert a UNIX group id to a Windows
227 NT SID. If the gid specified does not refer to one within
228 the idmap gid range then the operation will fail. </para></listitem>
233 <listitem><para>Print brief help overview.
238 <term>-i|--user-info <replaceable>user</replaceable></term>
239 <listitem><para>Get user info.
244 <term>-I|--WINS-by-ip <replaceable>ip</replaceable></term>
245 <listitem><para>The <parameter>-I</parameter> option
246 queries <citerefentry><refentrytitle>winbindd</refentrytitle>
247 <manvolnum>8</manvolnum></citerefentry> to send a node status
248 request to get the NetBIOS name associated with the IP address
249 specified by the <parameter>ip</parameter> parameter.
254 <term>-K|--krb5auth <replaceable>username%password</replaceable></term>
255 <listitem><para>Attempt to authenticate a user via Kerberos.
260 <term>--krb5ccname <replaceable>KRB5CCNAME</replaceable></term>
261 <listitem><para>Allows to request a sepcific kerberos credential
262 cache type used for authentication.
267 <term>--lanman</term>
268 <listitem><para>Use lanman cryptography for user authentication.
273 <term>--logoff</term>
274 <listitem><para>Logoff a user.
279 <term>--logoff-uid <replaceable>UID</replaceable></term>
280 <listitem><para>Define user uid used during logoff request.
285 <term>--logoff-user <replaceable>USERNAME</replaceable></term>
286 <listitem><para>Define username used during logoff request.
291 <term>--lookup-sids <replaceable>SID1,SID2...</replaceable></term>
292 <listitem><para>Looks up SIDs. SIDs must be specified as ASCII strings in the traditional Microsoft
293 format. For example, S-1-5-21-1455342024-3071081365-2475485837-500.
298 <term>-m|--trusted-domains</term>
299 <listitem><para>Produce a list of domains trusted by the
300 Windows NT server <citerefentry><refentrytitle>winbindd</refentrytitle>
301 <manvolnum>8</manvolnum></citerefentry> contacts
302 when resolving names. This list does not include the Windows
303 NT domain the server is a Primary Domain Controller for.
308 <term>-n|--name-to-sid <replaceable>name</replaceable></term>
309 <listitem><para>The <parameter>-n</parameter> option
310 queries <citerefentry><refentrytitle>winbindd</refentrytitle>
311 <manvolnum>8</manvolnum></citerefentry> for the SID
312 associated with the name specified. Domain names can be specified
313 before the user name by using the winbind separator character.
314 For example CWDOM1/Administrator refers to the Administrator
315 user in the domain CWDOM1. If no domain is specified then the
316 domain used is the one specified in the <citerefentry><refentrytitle>smb.conf</refentrytitle>
317 <manvolnum>5</manvolnum></citerefentry> <parameter>workgroup
318 </parameter> parameter. </para></listitem>
322 <term>-N|--WINS-by-name <replaceable>name</replaceable></term>
323 <listitem><para>The <parameter>-N</parameter> option
324 queries <citerefentry><refentrytitle>winbindd</refentrytitle>
325 <manvolnum>8</manvolnum></citerefentry> to query the WINS
326 server for the IP address associated with the NetBIOS name
327 specified by the <parameter>name</parameter> parameter.
332 <term>--ntlmv2</term>
333 <listitem><para>Use NTLMv2 cryptography for user authentication.
338 <term>--online-status <replaceable>domain</replaceable></term>
339 <listitem><para>Show whether domains are marked as online or
340 offline. An optional domain argument limits the
341 output to the online status of a given domain.
346 <term>--own-domain</term>
347 <listitem><para>List own domain.
352 <term>--pam-logon <replaceable>username%password</replaceable></term>
353 <listitem><para>Attempt to authenticate a user in the same way
354 pam_winbind would do.
359 <term>-p|--ping</term>
360 <listitem><para>Check whether <citerefentry><refentrytitle>winbindd</refentrytitle>
361 <manvolnum>8</manvolnum></citerefentry> is still alive.
362 Prints out either 'succeeded' or 'failed'.
367 <term>-P|--ping-dc</term>
368 <listitem><para>Issue a no-effect command to our DC. This
369 checks if our secure channel connection to our domain
370 controller is still alive. It has much less impact than
376 <term>-r|--user-groups <replaceable>username</replaceable></term>
377 <listitem><para>Try to obtain the list of UNIX group ids
378 to which the user belongs. This only works for users
379 defined on a Domain Controller.
384 <term>-R|--lookup-rids <replaceable>rid1, rid2, rid3...</replaceable></term>
385 <listitem><para>Converts RIDs to names. Uses a comma separated
391 <term>--remove-gid-mapping <replaceable>GID,SID</replaceable></term>
392 <listitem><para>Removes an existing GID to SID mapping from the database.
397 <term>--remove-uid-mapping <replaceable>UID,SID</replaceable></term>
398 <listitem><para>Removes an existing UID to SID mapping from the database.
403 <term>-s|--sid-to-name <replaceable>sid</replaceable></term>
404 <listitem><para>Use <parameter>-s</parameter> to resolve
405 a SID to a name. This is the inverse of the <parameter>-n
406 </parameter> option above. SIDs must be specified as ASCII strings
407 in the traditional Microsoft format. For example,
408 S-1-5-21-1455342024-3071081365-2475485837-500. </para></listitem>
412 <term>--separator</term>
413 <listitem><para>Get the active winbind separator.
418 <term>--sequence</term>
419 <listitem><para>This command has been deprecated. Please use
420 the --online-status option instead.
425 <term>--set-auth-user <replaceable>username%password</replaceable></term>
426 <listitem><para>Store username and password used by <citerefentry>
427 <refentrytitle>winbindd</refentrytitle><manvolnum>8</manvolnum>
428 </citerefentry> during session setup to a domain controller. This enables
429 winbindd to operate in a Windows 2000 domain with Restrict
430 Anonymous turned on (a.k.a. Permissions compatible with
431 Windows 2000 servers only).
436 <term>--set-gid-mapping <replaceable>GID,SID</replaceable></term>
437 <listitem><para>Create a GID to SID mapping in the database.
442 <term>--set-uid-mapping <replaceable>UID,SID</replaceable></term>
443 <listitem><para>Create a UID to SID mapping in the database.
448 <term>-S|--sid-to-uid <replaceable>sid</replaceable></term>
449 <listitem><para>Convert a SID to a UNIX user id. If the SID
450 does not correspond to a UNIX user mapped by <citerefentry>
451 <refentrytitle>winbindd</refentrytitle><manvolnum>8</manvolnum>
452 </citerefentry> then the operation will fail. </para></listitem>
456 <term>--sid-aliases <replaceable>sid</replaceable></term>
457 <listitem><para>Get SID aliases for a given SID.
462 <term>--sid-to-fullname <replaceable>sid</replaceable></term>
463 <listitem><para>Converts a SID to a full username
469 <term>--sids-to-unix-ids <replaceable>sid1,sid2,sid3...</replaceable></term>
470 <listitem><para>Resolve SIDs to Unix IDs.
471 SIDs must be specified as ASCII strings
472 in the traditional Microsoft format. For example,
473 S-1-5-21-1455342024-3071081365-2475485837-500. </para></listitem>
477 <term>-t|--check-secret</term>
478 <listitem><para>Verify that the workstation trust account
479 created when the Samba server is added to the Windows NT
480 domain is working. May be used in conjunction with
481 <option>domain</option> in order to verify interdomain
482 trust accounts.</para></listitem>
486 <term>-u|--domain-users</term>
487 <listitem><para>This option will list all users available
488 in the Windows NT domain for which the <citerefentry><refentrytitle>winbindd</refentrytitle>
489 <manvolnum>8</manvolnum></citerefentry> daemon is operating in. Users in all trusted domains
490 will also be listed. Note that this operation does not assign
491 user ids to any users that have not already been seen by <citerefentry>
492 <refentrytitle>winbindd</refentrytitle><manvolnum>8</manvolnum></citerefentry>
497 <term>--uid-info <replaceable>uid</replaceable></term>
498 <listitem><para>Get user info for the user connected to
499 user id UID.</para></listitem>
504 <listitem><para>Print brief help overview.
509 <term>--user-domgroups <replaceable>sid</replaceable></term>
510 <listitem><para>Get user domain groups.
515 <term>--user-sidinfo <replaceable>sid</replaceable></term>
516 <listitem><para>Get user info by sid.
522 <term>--user-sids <replaceable>sid</replaceable></term>
523 <listitem><para>Get user group SIDs for user.
528 <term>-U|--uid-to-sid <replaceable>uid</replaceable></term>
529 <listitem><para>Try to convert a UNIX user id to a Windows NT
530 SID. If the uid specified does not refer to one within
531 the idmap range then the operation will fail. </para></listitem>
535 <term>--verbose</term>
537 Print additional information about the query results.
542 <term>-Y|--sid-to-gid <replaceable>sid</replaceable></term>
543 <listitem><para>Convert a SID to a UNIX group id. If the SID
544 does not correspond to a UNIX group mapped by <citerefentry>
545 <refentrytitle>winbindd</refentrytitle><manvolnum>8</manvolnum></citerefentry> then
546 the operation will fail. </para></listitem>
557 <title>EXIT STATUS</title>
559 <para>The wbinfo program returns 0 if the operation
560 succeeded, or 1 if the operation failed. If the <citerefentry>
561 <refentrytitle>winbindd</refentrytitle><manvolnum>8</manvolnum>
562 </citerefentry> daemon is not working <command>wbinfo</command> will always return
568 <title>VERSION</title>
570 <para>This man page is correct for version 3 of
571 the Samba suite.</para>
575 <title>SEE ALSO</title>
576 <para><citerefentry><refentrytitle>winbindd</refentrytitle>
577 <manvolnum>8</manvolnum></citerefentry> and <citerefentry><refentrytitle>ntlm_auth</refentrytitle>
578 <manvolnum>1</manvolnum></citerefentry></para>
582 <title>AUTHOR</title>
584 <para>The original Samba software and related utilities
585 were created by Andrew Tridgell. Samba is now developed
586 by the Samba Team as an Open Source project similar
587 to the way the Linux kernel is developed.</para>
589 <para><command>wbinfo</command> and <command>winbindd</command>
590 were written by Tim Potter.</para>
592 <para>The conversion to DocBook for Samba 2.2 was done
593 by Gerald Carter. The conversion to DocBook XML 4.2 for Samba
594 3.0 was done by Alexander Bokovoy.</para>