docs/docbook/manpages/wbinfo.1.sgml

   1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
   2 <refentry id="wbinfo">
   3
   4 <refmeta>
   5         <refentrytitle>wbinfo</refentrytitle>
   6         <manvolnum>1</manvolnum>
   7 </refmeta>
   8
   9
  10 <refnamediv>
  11         <refname>wbinfo</refname>
  12         <refpurpose>Query information from winbind daemon</refpurpose>
  13 </refnamediv>
  14
  15 <refsynopsisdiv>
  16         <cmdsynopsis>
  17                 <command>wbinfo</command>
  18                 <arg choice="opt">-u</arg>
  19                 <arg choice="opt">-g</arg>
  20                 <arg choice="opt">-h name</arg>
  21                 <arg choice="opt">-i ip</arg>
  22                 <arg choice="opt">-n name</arg>
  23                 <arg choice="opt">-s sid</arg>
  24                 <arg choice="opt">-U uid</arg>
  25                 <arg choice="opt">-G gid</arg>
  26                 <arg choice="opt">-S sid</arg>
  27                 <arg choice="opt">-Y sid</arg>
  28                 <arg choice="opt">-t</arg>
  29                 <arg choice="opt">-m</arg>
  30                 <arg choice="opt">-r user</arg>
  31                 <arg choice="opt">-a user%password</arg>
  32                 <arg choice="opt">-A user%password</arg>
  33         </cmdsynopsis>
  34 </refsynopsisdiv>
  35
  36 <refsect1>
  37         <title>DESCRIPTION</title>
  38
  39         <para>This tool is part of the <ulink url="samba.7.html">
  40         Samba</ulink> suite.</para>
  41
  42         <para>The <command>wbinfo</command> program queries and returns information
  43         created and used by the <ulink url="winbindd.8.html"><command>
  44         winbindd(8)</command></ulink> daemon. </para>
  45
  46         <para>The <command>winbindd(8)</command> daemon must be configured
  47         and running for the <command>wbinfo</command> program to be able
  48         to return information.</para>
  49 </refsect1>
  50
  51 <refsect1>
  52         <title>OPTIONS</title>
  53
  54         <variablelist>
  55                 <varlistentry>
  56                 <term>-u</term>
  57                 <listitem><para>This option will list all users available
  58                 in the Windows NT domain for which the <command>winbindd(8)
  59                 </command> daemon is operating in. Users in all trusted domains
  60                 will also be listed.  Note that this operation does not assign
  61                 user ids to any users that have not already been seen by
  62                 <command>winbindd(8)</command>.</para></listitem>
  63                 </varlistentry>
  64
  65                 <varlistentry>
  66                 <term>-g</term>
  67                 <listitem><para>This option will list all groups available
  68                 in the Windows NT domain for which the <command>winbindd(8)
  69                 </command> daemon is operating in. Groups in all trusted domains
  70                 will also be listed.  Note that this operation does not assign
  71                 group ids to any groups that have not already been seen by
  72                 <command>winbindd(8)</command>. </para></listitem>
  73                 </varlistentry>
  74
  75
  76                 <varlistentry>
  77                 <term>-h name</term>
  78                 <listitem><para>The <parameter>-h</parameter> option
  79                 queries <command>winbindd(8)</command> to query the WINS
  80                 server for the IP address associated with the NetBIOS name
  81                 specified by the <parameter>name</parameter> parameter.
  82                 </para></listitem>
  83                 </varlistentry>
  84
  85
  86                 <varlistentry>
  87                 <term>-i ip</term>
  88                 <listitem><para>The <parameter>-i</parameter> option
  89                 queries <command>winbindd(8)</command> to send a node status
  90                 request to get the NetBIOS name associated with the IP address
  91                 specified by the <parameter>ip</parameter> parameter.
  92                 </para></listitem>
  93                 </varlistentry>
  94
  95
  96                 <varlistentry>
  97                 <term>-n name</term>
  98                 <listitem><para>The <parameter>-n</parameter> option
  99                 queries <command>winbindd(8)</command> for the SID
 100                 associated with the name specified. Domain names can be specified
 101                 before the user name by using the winbind separator character.
 102                 For example CWDOM1/Administrator refers to the Administrator
 103                 user in the domain CWDOM1.  If no domain is specified then the
 104                 domain used is the one specified in the <filename>smb.conf</filename>
 105                 <parameter>workgroup</parameter> parameter. </para></listitem>
 106                 </varlistentry>
 107
 108
 109                 <varlistentry>
 110                 <term>-s sid</term>
 111                 <listitem><para>Use <parameter>-s</parameter> to resolve
 112                 a SID to a name.  This is the inverse of the <parameter>-n
 113                 </parameter> option above.  SIDs must be specified as ASCII strings
 114                 in the traditional Microsoft format. For example,
 115                 S-1-5-21-1455342024-3071081365-2475485837-500. </para></listitem>
 116                 </varlistentry>
 117
 118
 119                 <varlistentry>
 120                 <term>-U uid</term>
 121                 <listitem><para>Try to convert a UNIX user id to a Windows NT
 122                 SID.  If the uid specified does not refer to one within
 123                 the winbind uid range then the operation will fail. </para></listitem>
 124                 </varlistentry>
 125
 126
 127                 <varlistentry>
 128                 <term>-G gid</term>
 129                 <listitem><para>Try to convert a UNIX group id to a Windows
 130                 NT SID.  If the gid specified does not refer to one within
 131                 the winbind gid range then the operation will fail. </para></listitem>
 132                 </varlistentry>
 133
 134
 135                 <varlistentry>
 136                 <term>-S sid</term>
 137                 <listitem><para>Convert a SID to a UNIX user id.  If the SID
 138                 does not correspond to a UNIX user mapped by <command>
 139                 winbindd(8)</command> then the operation will fail. </para></listitem>
 140                 </varlistentry>
 141
 142
 143                 <varlistentry>
 144                 <term>-Y sid</term>
 145                 <listitem><para>Convert a SID to a UNIX group id.  If the SID
 146                 does not correspond to a UNIX group mapped by <command>
 147                 winbindd(8)</command> then the operation will fail. </para></listitem>
 148                 </varlistentry>
 149
 150
 151
 152                 <varlistentry>
 153                 <term>-t</term>
 154                 <listitem><para>Verify that the workstation trust account
 155                 created when the Samba server is added to the Windows NT
 156                 domain is working. </para></listitem>
 157                 </varlistentry>
 158
 159
 160                 <varlistentry>
 161                 <term>-m</term>
 162                 <listitem><para>Produce a list of domains trusted by the
 163                 Windows NT server <command>winbindd(8)</command> contacts
 164                 when resolving names.  This list does not include the Windows
 165                 NT domain the server is a Primary Domain Controller for.
 166                 </para></listitem>
 167                 </varlistentry>
 168
 169
 170                 <varlistentry>
 171                 <term>-r username</term>
 172                 <listitem><para>Try to obtain the list of UNIX group ids
 173                 to which the user belongs.  This only works for users
 174                 defined on a Domain Controller.
 175                 </para></listitem>
 176                 </varlistentry>
 177
 178
 179                 <varlistentry>
 180                 <term>-a username%password</term>
 181                 <listitem><para>Attempt to authenticate a user via winbindd.
 182                 This checks both authenticaion methods and reports its results.
 183                 </para></listitem>
 184                 </varlistentry>
 185
 186
 187                 <varlistentry>
 188                 <term>-A username%password</term>
 189                 <listitem><para>Store username and password used by winbindd
 190                 during session setup to a domain controller.  This enables
 191                 winbindd to operate in a Windows 2000 domain with Restrict
 192                 Anonymous turned on (a.k.a. Permissions compatiable with
 193                 Windows 2000 servers only).
 194                 </para></listitem>
 195                 </varlistentry>
 196         </variablelist>
 197 </refsect1>
 198
 199
 200 <refsect1>
 201         <title>EXIT STATUS</title>
 202
 203         <para>The wbinfo program returns 0 if the operation
 204         succeeded, or 1 if the operation failed.  If the <command>winbindd(8)
 205         </command> daemon is not working <command>wbinfo</command> will always return
 206         failure. </para>
 207 </refsect1>
 208
 209
 210 <refsect1>
 211         <title>VERSION</title>
 212
 213         <para>This man page is correct for version 2.2 of
 214         the Samba suite.</para>
 215 </refsect1>
 216
 217 <refsect1>
 218         <title>SEE ALSO</title>
 219         <para><ulink url="winbindd.8.html"><command>winbindd(8)</command>
 220         </ulink></para>
 221 </refsect1>
 222
 223 <refsect1>
 224         <title>AUTHOR</title>
 225
 226         <para>The original Samba software and related utilities
 227         were created by Andrew Tridgell. Samba is now developed
 228         by the Samba Team as an Open Source project similar
 229         to the way the Linux kernel is developed.</para>
 230
 231         <para><command>wbinfo</command> and <command>winbindd</command>
 232         were written by Tim Potter.</para>
 233
 234         <para>The conversion to DocBook for Samba 2.2 was done
 235         by Gerald Carter</para>
 236 </refsect1>
 237
 238 </refentry>