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