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">3.2</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">-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">-s sid</arg>
43 <arg choice="opt">--separator</arg>
44 <arg choice="opt">--sequence</arg>
45 <arg choice="opt">--set-auth-user user%password</arg>
46 <arg choice="opt">-S sid</arg>
47 <arg choice="opt">-t</arg>
48 <arg choice="opt">-u</arg>
49 <arg choice="opt">--uid-info uid</arg>
50 <arg choice="opt">--user-domgroups sid</arg>
51 <arg choice="opt">--user-sids sid</arg>
52 <arg choice="opt">-U uid</arg>
53 <arg choice="opt">-V</arg>
54 <arg choice="opt">-Y sid</arg>
55 <arg choice="opt">--verbose</arg>
60 <title>DESCRIPTION</title>
62 <para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
63 <manvolnum>7</manvolnum></citerefentry> suite.</para>
65 <para>The <command>wbinfo</command> program queries and returns information
66 created and used by the <citerefentry><refentrytitle>winbindd</refentrytitle>
67 <manvolnum>8</manvolnum></citerefentry> daemon. </para>
69 <para>The <citerefentry><refentrytitle>winbindd</refentrytitle>
70 <manvolnum>8</manvolnum></citerefentry> daemon must be configured
71 and running for the <command>wbinfo</command> program to be able
72 to return information.</para>
76 <title>OPTIONS</title>
80 <term>-a|--authenticate <replaceable>username%password</replaceable></term>
81 <listitem><para>Attempt to authenticate a user via <citerefentry>
82 <refentrytitle>winbindd</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
83 This checks both authentication methods and reports its results.
84 </para><note><para>Do not be tempted to use this
85 functionality for authentication in third-party
86 applications. Instead use <citerefentry><refentrytitle>ntlm_auth</refentrytitle>
87 <manvolnum>1</manvolnum></citerefentry>.</para></note></listitem>
91 <term>--allocate-gid</term>
92 <listitem><para>Get a new GID out of idmap
97 <term>--allocate-uid</term>
98 <listitem><para>Get a new UID out of idmap
103 <term>--all-domains</term>
104 <listitem><para>List all domains (trusted and
110 <term>--domain <replaceable>name</replaceable></term>
111 <listitem><para>This parameter sets the domain on which any specified
112 operations will performed. If special domain name '.' is used to represent
113 the current domain to which <citerefentry><refentrytitle>winbindd</refentrytitle>
114 <manvolnum>8</manvolnum></citerefentry> belongs. Currently only the
115 <option>--sequence</option>,
116 <option>-u</option>, and <option>-g</option> options honor this parameter.
121 <term>-D|--domain-info <replaceable>domain</replaceable></term>
122 <listitem><para>Show most of the info we have about the
128 <term>-g|--domain-groups</term>
129 <listitem><para>This option will list all groups available
130 in the Windows NT domain for which the <citerefentry><refentrytitle>samba</refentrytitle>
131 <manvolnum>7</manvolnum></citerefentry> daemon is operating in. Groups in all trusted domains
132 will also be listed. Note that this operation does not assign
133 group ids to any groups that have not already been
134 seen by <citerefentry><refentrytitle>winbindd</refentrytitle>
135 <manvolnum>8</manvolnum></citerefentry>. </para></listitem>
139 <term>--get-auth-user</term>
140 <listitem><para>Print username and password used by <citerefentry>
141 <refentrytitle>winbindd</refentrytitle><manvolnum>8</manvolnum></citerefentry>
142 during session setup to a domain controller. Username
143 and password can be set using <option>--set-auth-user</option>.
144 Only available for root.</para></listitem>
148 <term>--getdcname <replaceable>domain</replaceable></term>
149 <listitem><para>Get the DC name for the specified domain.
154 <term>-G|--gid-to-sid <replaceable>gid</replaceable></term>
155 <listitem><para>Try to convert a UNIX group id to a Windows
156 NT SID. If the gid specified does not refer to one within
157 the idmap gid range then the operation will fail. </para></listitem>
161 <term>-i|--user-info <replaceable>user</replaceable></term>
162 <listitem><para>Get user info.
167 <term>-I|--WINS-by-ip <replaceable>ip</replaceable></term>
168 <listitem><para>The <parameter>-I</parameter> option
169 queries <citerefentry><refentrytitle>winbindd</refentrytitle>
170 <manvolnum>8</manvolnum></citerefentry> to send a node status
171 request to get the NetBIOS name associated with the IP address
172 specified by the <parameter>ip</parameter> parameter.
177 <term>-K|--krb5auth <replaceable>username%password</replaceable></term>
178 <listitem><para>Attempt to authenticate a user via Kerberos.
183 <term>-m|--trusted-domains</term>
184 <listitem><para>Produce a list of domains trusted by the
185 Windows NT server <citerefentry><refentrytitle>winbindd</refentrytitle>
186 <manvolnum>8</manvolnum></citerefentry> contacts
187 when resolving names. This list does not include the Windows
188 NT domain the server is a Primary Domain Controller for.
193 <term>-n|--name-to-sid <replaceable>name</replaceable></term>
194 <listitem><para>The <parameter>-n</parameter> option
195 queries <citerefentry><refentrytitle>winbindd</refentrytitle>
196 <manvolnum>8</manvolnum></citerefentry> for the SID
197 associated with the name specified. Domain names can be specified
198 before the user name by using the winbind separator character.
199 For example CWDOM1/Administrator refers to the Administrator
200 user in the domain CWDOM1. If no domain is specified then the
201 domain used is the one specified in the <citerefentry><refentrytitle>smb.conf</refentrytitle>
202 <manvolnum>5</manvolnum></citerefentry> <parameter>workgroup
203 </parameter> parameter. </para></listitem>
207 <term>-N|--WINS-by-name <replaceable>name</replaceable></term>
208 <listitem><para>The <parameter>-N</parameter> option
209 queries <citerefentry><refentrytitle>winbindd</refentrytitle>
210 <manvolnum>8</manvolnum></citerefentry> to query the WINS
211 server for the IP address associated with the NetBIOS name
212 specified by the <parameter>name</parameter> parameter.
217 <term>--own-domain</term>
218 <listitem><para>List own domain.
223 <term>-p|--ping</term>
224 <listitem><para>Check whether <citerefentry><refentrytitle>winbindd</refentrytitle>
225 <manvolnum>8</manvolnum></citerefentry> is still alive.
226 Prints out either 'succeeded' or 'failed'.
231 <term>-r|--user-groups <replaceable>username</replaceable></term>
232 <listitem><para>Try to obtain the list of UNIX group ids
233 to which the user belongs. This only works for users
234 defined on a Domain Controller.
239 <term>-s|--sid-to-name <replaceable>sid</replaceable></term>
240 <listitem><para>Use <parameter>-s</parameter> to resolve
241 a SID to a name. This is the inverse of the <parameter>-n
242 </parameter> option above. SIDs must be specified as ASCII strings
243 in the traditional Microsoft format. For example,
244 S-1-5-21-1455342024-3071081365-2475485837-500. </para></listitem>
248 <term>--separator</term>
249 <listitem><para>Get the active winbind separator.
254 <term>--sequence</term>
255 <listitem><para>Show sequence numbers of all known domains.
260 <term>--set-auth-user <replaceable>username%password</replaceable></term>
261 <listitem><para>Store username and password used by <citerefentry>
262 <refentrytitle>winbindd</refentrytitle><manvolnum>8</manvolnum>
263 </citerefentry> during session setup to a domain controller. This enables
264 winbindd to operate in a Windows 2000 domain with Restrict
265 Anonymous turned on (a.k.a. Permissions compatible with
266 Windows 2000 servers only).
271 <term>-S|--sid-to-uid <replaceable>sid</replaceable></term>
272 <listitem><para>Convert a SID to a UNIX user id. If the SID
273 does not correspond to a UNIX user mapped by <citerefentry>
274 <refentrytitle>winbindd</refentrytitle><manvolnum>8</manvolnum>
275 </citerefentry> then the operation will fail. </para></listitem>
279 <term>-t|--check-secret</term>
280 <listitem><para>Verify that the workstation trust account
281 created when the Samba server is added to the Windows NT
282 domain is working. </para></listitem>
286 <term>-u|--domain-users</term>
287 <listitem><para>This option will list all users available
288 in the Windows NT domain for which the <citerefentry><refentrytitle>winbindd</refentrytitle>
289 <manvolnum>8</manvolnum></citerefentry> daemon is operating in. Users in all trusted domains
290 will also be listed. Note that this operation does not assign
291 user ids to any users that have not already been seen by <citerefentry>
292 <refentrytitle>winbindd</refentrytitle><manvolnum>8</manvolnum></citerefentry>
297 <term>--uid-info <replaceable>uid</replaceable></term>
298 <listitem><para>Get user info for the user connected to
299 user id UID.</para></listitem>
303 <term>--user-domgroups <replaceable>sid</replaceable></term>
304 <listitem><para>Get user domain groups.
309 <term>--user-sids <replaceable>sid</replaceable></term>
310 <listitem><para>Get user group SIDs for user.
315 <term>-U|--uid-to-sid <replaceable>uid</replaceable></term>
316 <listitem><para>Try to convert a UNIX user id to a Windows NT
317 SID. If the uid specified does not refer to one within
318 the idmap uid range then the operation will fail. </para></listitem>
322 <term>--verbose</term>
324 Print additional information about the query results.
329 <term>-Y|--sid-to-gid <replaceable>sid</replaceable></term>
330 <listitem><para>Convert a SID to a UNIX group id. If the SID
331 does not correspond to a UNIX group mapped by <citerefentry>
332 <refentrytitle>winbindd</refentrytitle><manvolnum>8</manvolnum></citerefentry> then
333 the operation will fail. </para></listitem>
345 <title>EXIT STATUS</title>
347 <para>The wbinfo program returns 0 if the operation
348 succeeded, or 1 if the operation failed. If the <citerefentry>
349 <refentrytitle>winbindd</refentrytitle><manvolnum>8</manvolnum>
350 </citerefentry> daemon is not working <command>wbinfo</command> will always return
356 <title>VERSION</title>
358 <para>This man page is correct for version 3 of
359 the Samba suite.</para>
363 <title>SEE ALSO</title>
364 <para><citerefentry><refentrytitle>winbindd</refentrytitle>
365 <manvolnum>8</manvolnum></citerefentry> and <citerefentry><refentrytitle>ntlm_auth</refentrytitle>
366 <manvolnum>1</manvolnum></citerefentry></para>
370 <title>AUTHOR</title>
372 <para>The original Samba software and related utilities
373 were created by Andrew Tridgell. Samba is now developed
374 by the Samba Team as an Open Source project similar
375 to the way the Linux kernel is developed.</para>
377 <para><command>wbinfo</command> and <command>winbindd</command>
378 were written by Tim Potter.</para>
380 <para>The conversion to DocBook for Samba 2.2 was done
381 by Gerald Carter. The conversion to DocBook XML 4.2 for Samba
382 3.0 was done by Alexander Bokovoy.</para>