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">&doc.version;</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">--ntlmv1</arg>
53 <arg choice="opt">--ntlmv2</arg>
54 <arg choice="opt">--online-status</arg>
55 <arg choice="opt">--own-domain</arg>
56 <arg choice="opt">-p</arg>
57 <arg choice="opt">-P|--ping-dc</arg>
58 <arg choice="opt">--pam-logon user%password</arg>
59 <arg choice="opt">-r user</arg>
60 <arg choice="opt">-R|--lookup-rids</arg>
61 <arg choice="opt">--remove-gid-mapping gid,sid</arg>
62 <arg choice="opt">--remove-uid-mapping uid,sid</arg>
63 <arg choice="opt">-s sid</arg>
64 <arg choice="opt">--separator</arg>
65 <arg choice="opt">--sequence</arg>
66 <arg choice="opt">--set-auth-user user%password</arg>
67 <arg choice="opt">--set-gid-mapping gid,sid</arg>
68 <arg choice="opt">--set-uid-mapping uid,sid</arg>
69 <arg choice="opt">-S sid</arg>
70 <arg choice="opt">--sid-aliases sid</arg>
71 <arg choice="opt">--sid-to-fullname sid</arg>
72 <arg choice="opt">--sids-to-unix-ids sidlist</arg>
73 <arg choice="opt">-t</arg>
74 <arg choice="opt">-u</arg>
75 <arg choice="opt">--uid-info uid</arg>
76 <arg choice="opt">--usage</arg>
77 <arg choice="opt">--user-domgroups sid</arg>
78 <arg choice="opt">--user-sidinfo sid</arg>
79 <arg choice="opt">--user-sids sid</arg>
80 <arg choice="opt">-U uid</arg>
81 <arg choice="opt">-V</arg>
82 <arg choice="opt">--verbose</arg>
83 <arg choice="opt">-Y sid</arg>
89 <title>DESCRIPTION</title>
91 <para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
92 <manvolnum>7</manvolnum></citerefentry> suite.</para>
94 <para>The <command>wbinfo</command> program queries and returns information
95 created and used by the <citerefentry><refentrytitle>winbindd</refentrytitle>
96 <manvolnum>8</manvolnum></citerefentry> daemon. </para>
98 <para>The <citerefentry><refentrytitle>winbindd</refentrytitle>
99 <manvolnum>8</manvolnum></citerefentry> daemon must be configured
100 and running for the <command>wbinfo</command> program to be able
101 to return information.</para>
105 <title>OPTIONS</title>
109 <term>-a|--authenticate <replaceable>username%password</replaceable></term>
110 <listitem><para>Attempt to authenticate a user via <citerefentry>
111 <refentrytitle>winbindd</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
112 This checks both authentication methods and reports its results.
113 </para><note><para>Do not be tempted to use this
114 functionality for authentication in third-party
115 applications. Instead use <citerefentry><refentrytitle>ntlm_auth</refentrytitle>
116 <manvolnum>1</manvolnum></citerefentry>.</para></note></listitem>
120 <term>--allocate-gid</term>
121 <listitem><para>Get a new GID out of idmap
126 <term>--allocate-uid</term>
127 <listitem><para>Get a new UID out of idmap
132 <term>--all-domains</term>
133 <listitem><para>List all domains (trusted and
139 <term>-c|--change-secret</term>
140 <listitem><para>Change the trust account password. May be used
141 in conjunction with <option>domain</option> in order to change
142 interdomain trust account passwords.
147 <term>--ccache-save <replaceable>username%password</replaceable></term>
148 <listitem><para>Store user and password for ccache.
153 <term>--change-user-password <replaceable>username</replaceable></term>
154 <listitem><para>Change the password of a user. The old and new password will be prompted.
159 <term>--dc-info <replaceable>domain</replaceable></term>
160 <listitem><para>Displays information about the current domain controller for a domain.
165 <term>--domain <replaceable>name</replaceable></term>
166 <listitem><para>This parameter sets the domain on which any specified
167 operations will performed. If special domain name '.' is used to represent
168 the current domain to which <citerefentry><refentrytitle>winbindd</refentrytitle>
169 <manvolnum>8</manvolnum></citerefentry> belongs. A '*' as the domain name
170 means to enumerate over all domains (NOTE: This can take a long time and use
176 <term>-D|--domain-info <replaceable>domain</replaceable></term>
177 <listitem><para>Show most of the info we have about the
183 <term>--dsgetdcname <replaceable>domain</replaceable></term>
184 <listitem><para>Find a DC for a domain.
189 <term>--gid-info <replaceable>gid</replaceable></term>
190 <listitem><para>Get group info from gid.
195 <term>--group-info <replaceable>group</replaceable></term>
196 <listitem><para>Get group info from group name.
201 <term>-g|--domain-groups</term>
202 <listitem><para>This option will list all groups available
203 in the Windows NT domain for which the <citerefentry><refentrytitle>samba</refentrytitle>
204 <manvolnum>7</manvolnum></citerefentry> daemon is operating in. Groups in all trusted domains
205 can be listed with the --domain='*' option. Note that this operation does not assign
206 group ids to any groups that have not already been
207 seen by <citerefentry><refentrytitle>winbindd</refentrytitle>
208 <manvolnum>8</manvolnum></citerefentry>. </para></listitem>
212 <term>--get-auth-user</term>
213 <listitem><para>Print username and password used by <citerefentry>
214 <refentrytitle>winbindd</refentrytitle><manvolnum>8</manvolnum></citerefentry>
215 during session setup to a domain controller. Username
216 and password can be set using <option>--set-auth-user</option>.
217 Only available for root.</para></listitem>
221 <term>--getdcname <replaceable>domain</replaceable></term>
222 <listitem><para>Get the DC name for the specified domain.
227 <term>-G|--gid-to-sid <replaceable>gid</replaceable></term>
228 <listitem><para>Try to convert a UNIX group id to a Windows
229 NT SID. If the gid specified does not refer to one within
230 the idmap gid range then the operation will fail. </para></listitem>
235 <listitem><para>Print brief help overview.
240 <term>-i|--user-info <replaceable>user</replaceable></term>
241 <listitem><para>Get user info.
246 <term>-I|--WINS-by-ip <replaceable>ip</replaceable></term>
247 <listitem><para>The <parameter>-I</parameter> option
248 queries <citerefentry><refentrytitle>winbindd</refentrytitle>
249 <manvolnum>8</manvolnum></citerefentry> to send a node status
250 request to get the NetBIOS name associated with the IP address
251 specified by the <parameter>ip</parameter> parameter.
256 <term>-K|--krb5auth <replaceable>username%password</replaceable></term>
257 <listitem><para>Attempt to authenticate a user via Kerberos.
262 <term>--krb5ccname <replaceable>KRB5CCNAME</replaceable></term>
263 <listitem><para>Allows one to request a sepcific kerberos credential
264 cache type used for authentication.
269 <term>--lanman</term>
270 <listitem><para>Use lanman cryptography for user authentication.
275 <term>--logoff</term>
276 <listitem><para>Logoff a user.
281 <term>--logoff-uid <replaceable>UID</replaceable></term>
282 <listitem><para>Define user uid used during logoff request.
287 <term>--logoff-user <replaceable>USERNAME</replaceable></term>
288 <listitem><para>Define username used during logoff request.
293 <term>--lookup-sids <replaceable>SID1,SID2...</replaceable></term>
294 <listitem><para>Looks up SIDs. SIDs must be specified as ASCII strings in the traditional Microsoft
295 format. For example, S-1-5-21-1455342024-3071081365-2475485837-500.
300 <term>-m|--trusted-domains</term>
301 <listitem><para>Produce a list of domains trusted by the
302 Windows NT server <citerefentry><refentrytitle>winbindd</refentrytitle>
303 <manvolnum>8</manvolnum></citerefentry> contacts
304 when resolving names. This list does not include the Windows
305 NT domain the server is a Primary Domain Controller for.
310 <term>-n|--name-to-sid <replaceable>name</replaceable></term>
311 <listitem><para>The <parameter>-n</parameter> option
312 queries <citerefentry><refentrytitle>winbindd</refentrytitle>
313 <manvolnum>8</manvolnum></citerefentry> for the SID
314 associated with the name specified. Domain names can be specified
315 before the user name by using the winbind separator character.
316 For example CWDOM1/Administrator refers to the Administrator
317 user in the domain CWDOM1. If no domain is specified then the
318 domain used is the one specified in the <citerefentry><refentrytitle>smb.conf</refentrytitle>
319 <manvolnum>5</manvolnum></citerefentry> <parameter>workgroup
320 </parameter> parameter. </para></listitem>
324 <term>-N|--WINS-by-name <replaceable>name</replaceable></term>
325 <listitem><para>The <parameter>-N</parameter> option
326 queries <citerefentry><refentrytitle>winbindd</refentrytitle>
327 <manvolnum>8</manvolnum></citerefentry> to query the WINS
328 server for the IP address associated with the NetBIOS name
329 specified by the <parameter>name</parameter> parameter.
334 <term>--ntlmv1</term>
335 <listitem><para>Use NTLMv1 cryptography for user authentication.
340 <term>--ntlmv2</term>
341 <listitem><para>Use NTLMv2 cryptography for user
342 authentication. NTLMv2 is the default method, this
343 option is only maintained for compatibility.
348 <term>--online-status <replaceable>domain</replaceable></term>
349 <listitem><para>Show whether domains are marked as online or
350 offline. An optional domain argument limits the
351 output to the online status of a given domain.
356 <term>--own-domain</term>
357 <listitem><para>List own domain.
362 <term>--pam-logon <replaceable>username%password</replaceable></term>
363 <listitem><para>Attempt to authenticate a user in the same way
364 pam_winbind would do.
369 <term>-p|--ping</term>
370 <listitem><para>Check whether <citerefentry><refentrytitle>winbindd</refentrytitle>
371 <manvolnum>8</manvolnum></citerefentry> is still alive.
372 Prints out either 'succeeded' or 'failed'.
377 <term>-P|--ping-dc</term>
378 <listitem><para>Issue a no-effect command to our DC. This
379 checks if our secure channel connection to our domain
380 controller is still alive. It has much less impact than
386 <term>-r|--user-groups <replaceable>username</replaceable></term>
389 Try to obtain the list of UNIX group ids to which the
390 user belongs. This only works for users defined on a
394 <para>There are two scenaries:</para>
398 User authenticated: When the user has been
399 authenticated, the access token for the user is
400 cached. The correct group memberships are then
401 returned from the cached user token (which can
408 User *NOT* authenticated: The information is
409 queries from the domain controller using the
410 machine account credentials which have limited
411 permissions. The result is normally incomplete
412 and can be also incorrect.
419 <term>-R|--lookup-rids <replaceable>rid1, rid2, rid3...</replaceable></term>
420 <listitem><para>Converts RIDs to names. Uses a comma separated
426 <term>--remove-gid-mapping <replaceable>GID,SID</replaceable></term>
427 <listitem><para>Removes an existing GID to SID mapping from the database.
432 <term>--remove-uid-mapping <replaceable>UID,SID</replaceable></term>
433 <listitem><para>Removes an existing UID to SID mapping from the database.
438 <term>-s|--sid-to-name <replaceable>sid</replaceable></term>
439 <listitem><para>Use <parameter>-s</parameter> to resolve
440 a SID to a name. This is the inverse of the <parameter>-n
441 </parameter> option above. SIDs must be specified as ASCII strings
442 in the traditional Microsoft format. For example,
443 S-1-5-21-1455342024-3071081365-2475485837-500. </para></listitem>
447 <term>--separator</term>
448 <listitem><para>Get the active winbind separator.
453 <term>--sequence</term>
454 <listitem><para>This command has been deprecated. Please use
455 the --online-status option instead.
460 <term>--set-auth-user <replaceable>username%password</replaceable></term>
461 <listitem><para>Store username and password used by <citerefentry>
462 <refentrytitle>winbindd</refentrytitle><manvolnum>8</manvolnum>
463 </citerefentry> during session setup to a domain controller. This enables
464 winbindd to operate in a Windows 2000 domain with Restrict
465 Anonymous turned on (a.k.a. Permissions compatible with
466 Windows 2000 servers only).
471 <term>--set-gid-mapping <replaceable>GID,SID</replaceable></term>
472 <listitem><para>Create a GID to SID mapping in the database.
477 <term>--set-uid-mapping <replaceable>UID,SID</replaceable></term>
478 <listitem><para>Create a UID to SID mapping in the database.
483 <term>-S|--sid-to-uid <replaceable>sid</replaceable></term>
484 <listitem><para>Convert a SID to a UNIX user id. If the SID
485 does not correspond to a UNIX user mapped by <citerefentry>
486 <refentrytitle>winbindd</refentrytitle><manvolnum>8</manvolnum>
487 </citerefentry> then the operation will fail. </para></listitem>
491 <term>--sid-aliases <replaceable>sid</replaceable></term>
492 <listitem><para>Get SID aliases for a given SID.
497 <term>--sid-to-fullname <replaceable>sid</replaceable></term>
498 <listitem><para>Converts a SID to a full username
504 <term>--sids-to-unix-ids <replaceable>sid1,sid2,sid3...</replaceable></term>
505 <listitem><para>Resolve SIDs to Unix IDs.
506 SIDs must be specified as ASCII strings
507 in the traditional Microsoft format. For example,
508 S-1-5-21-1455342024-3071081365-2475485837-500. </para></listitem>
512 <term>-t|--check-secret</term>
513 <listitem><para>Verify that the workstation trust account
514 created when the Samba server is added to the Windows NT
515 domain is working. May be used in conjunction with
516 <option>domain</option> in order to verify interdomain
517 trust accounts.</para></listitem>
521 <term>-u|--domain-users</term>
522 <listitem><para>This option will list all users available
523 in the Windows NT domain for which the <citerefentry><refentrytitle>winbindd</refentrytitle>
524 <manvolnum>8</manvolnum></citerefentry> daemon is operating in. Users in all trusted domains
525 can be listed with the --domain='*' option. Note that this operation does not assign
526 user ids to any users that have not already been seen by <citerefentry>
527 <refentrytitle>winbindd</refentrytitle><manvolnum>8</manvolnum></citerefentry>
532 <term>--uid-info <replaceable>uid</replaceable></term>
533 <listitem><para>Get user info for the user connected to
534 user id UID.</para></listitem>
539 <listitem><para>Print brief help overview.
544 <term>--user-domgroups <replaceable>sid</replaceable></term>
545 <listitem><para>Get user domain groups.
550 <term>--user-sidinfo <replaceable>sid</replaceable></term>
551 <listitem><para>Get user info by sid.
557 <term>--user-sids <replaceable>sid</replaceable></term>
558 <listitem><para>Get user group SIDs for user.
563 <term>-U|--uid-to-sid <replaceable>uid</replaceable></term>
564 <listitem><para>Try to convert a UNIX user id to a Windows NT
565 SID. If the uid specified does not refer to one within
566 the idmap range then the operation will fail. </para></listitem>
570 <term>--verbose</term>
572 Print additional information about the query results.
577 <term>-Y|--sid-to-gid <replaceable>sid</replaceable></term>
578 <listitem><para>Convert a SID to a UNIX group id. If the SID
579 does not correspond to a UNIX group mapped by <citerefentry>
580 <refentrytitle>winbindd</refentrytitle><manvolnum>8</manvolnum></citerefentry> then
581 the operation will fail. </para></listitem>
592 <title>EXIT STATUS</title>
594 <para>The wbinfo program returns 0 if the operation
595 succeeded, or 1 if the operation failed. If the <citerefentry>
596 <refentrytitle>winbindd</refentrytitle><manvolnum>8</manvolnum>
597 </citerefentry> daemon is not working <command>wbinfo</command> will always return
603 <title>VERSION</title>
605 <para>This man page is part of version &doc.version; of
606 the Samba suite.</para>
610 <title>SEE ALSO</title>
611 <para><citerefentry><refentrytitle>winbindd</refentrytitle>
612 <manvolnum>8</manvolnum></citerefentry> and <citerefentry><refentrytitle>ntlm_auth</refentrytitle>
613 <manvolnum>1</manvolnum></citerefentry></para>
617 <title>AUTHOR</title>
619 <para>The original Samba software and related utilities
620 were created by Andrew Tridgell. Samba is now developed
621 by the Samba Team as an Open Source project similar
622 to the way the Linux kernel is developed.</para>
624 <para><command>wbinfo</command> and <command>winbindd</command>
625 were written by Tim Potter.</para>
627 <para>The conversion to DocBook for Samba 2.2 was done
628 by Gerald Carter. The conversion to DocBook XML 4.2 for Samba
629 3.0 was done by Alexander Bokovoy.</para>