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