docs/manpages-3/wbinfo.1.xml

   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">
   4
   5 <refmeta>
   6         <refentrytitle>wbinfo</refentrytitle>
   7         <manvolnum>1</manvolnum>
   8 </refmeta>
   9
  10
  11 <refnamediv>
  12         <refname>wbinfo</refname>
  13         <refpurpose>Query information from winbind daemon</refpurpose>
  14 </refnamediv>
  15
  16 <refsynopsisdiv>
  17         <cmdsynopsis>
  18                 <command>wbinfo</command>
  19                 <arg choice="opt">-a user%password</arg>
  20                 <arg choice="opt">-c username</arg>
  21                 <arg choice="opt">-C groupname</arg>
  22                 <arg choice="opt">--domain domain</arg>
  23                 <arg choice="opt">-I ip</arg>
  24                 <arg choice="opt">-s sid</arg>
  25                 <arg choice="opt">-u</arg>
  26                 <arg choice="opt">-U uid</arg>
  27                 <arg choice="opt">-g</arg>
  28                 <arg choice="opt">--get-auth-user</arg>
  29                 <arg choice="opt">-G gid</arg>
  30                 <arg choice="opt">-m</arg>
  31                 <arg choice="opt">-n name</arg>
  32                 <arg choice="opt">-N netbios-name</arg>
  33                 <arg choice="opt">-o user:group</arg>
  34                 <arg choice="opt">-O user:group</arg>
  35                 <arg choice="opt">-p</arg>
  36                 <arg choice="opt">-r user</arg>
  37                 <arg choice="opt">--set-auth-user user%password</arg>
  38                 <arg choice="opt">--sequence</arg>
  39                 <arg choice="opt">-S sid</arg>
  40                 <arg choice="opt">-t</arg>
  41                 <arg choice="opt">-x username</arg>
  42                 <arg choice="opt">-X groupname</arg>
  43                 <arg choice="opt">-Y sid</arg>
  44         </cmdsynopsis>
  45 </refsynopsisdiv>
  46
  47 <refsect1>
  48         <title>DESCRIPTION</title>
  49
  50         <para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
  51         <manvolnum>7</manvolnum></citerefentry> suite.</para>
  52
  53         <para>The <command>wbinfo</command> program queries and returns information
  54         created and used by the <citerefentry><refentrytitle>winbindd</refentrytitle>
  55         <manvolnum>8</manvolnum></citerefentry> daemon. </para>
  56
  57         <para>The <citerefentry><refentrytitle>winbindd</refentrytitle>
  58         <manvolnum>8</manvolnum></citerefentry> daemon must be configured
  59         and running for the <command>wbinfo</command> program to be able
  60         to return information.</para>
  61 </refsect1>
  62
  63 <refsect1>
  64         <title>OPTIONS</title>
  65
  66         <variablelist>
  67                 <varlistentry>
  68                 <term>-a username%password</term>
  69                 <listitem><para>Attempt to authenticate a user via winbindd.
  70                 This checks both authenticaion methods and reports its results.
  71                 </para><note><para>Do not be tempted to use this
  72                 functionality for authentication in third-party
  73                 applications.  Instead use <citerefentry><refentrytitle>ntlm_auth</refentrytitle>
  74         <manvolnum>1</manvolnum></citerefentry>.</para></note></listitem>
  75                 </varlistentry>
  76
  77                 <varlistentry>
  78                 <term>-c user</term>
  79                 <listitem><para>Create a local winbind user.
  80                 </para></listitem>
  81                 </varlistentry>
  82
  83                 <varlistentry>
  84                 <term>-C group</term>
  85                 <listitem><para>Create a local winbindd group.
  86                 </para></listitem>
  87                 </varlistentry>
  88
  89                 <varlistentry>
  90                 <term>--domain name</term>
  91                 <listitem><para>This parameter sets the domain on which any specified
  92                 operations will performed.  If special domain name '.' is used to represent
  93                 the current domain to which winbindd belongs.  Currently only the
  94                 <option>--sequence</option>,
  95                 <option>-u</option>, and <option>-g</option> options honor this parameter.
  96                 </para></listitem>
  97                 </varlistentry>
  98
  99                 <varlistentry>
 100                 <term>-g</term>
 101                 <listitem><para>This option will list all groups available
 102                 in the Windows NT domain for which the <citerefentry><refentrytitle>samba</refentrytitle>
 103                 <manvolnum>7</manvolnum></citerefentry> daemon is operating in. Groups in all trusted domains
 104                 will also be listed.  Note that this operation does not assign
 105                 group ids to any groups that have not already been
 106                 seen by <citerefentry><refentrytitle>winbindd</refentrytitle>
 107                 <manvolnum>8</manvolnum></citerefentry>. </para></listitem>
 108                 </varlistentry>
 109
 110                 <varlistentry>
 111                 <term>--get-auth-user</term>
 112                 <listitem><para>Print username and password used by winbindd
 113                 during session setup to a domain controller. Username
 114                 and password can be set using '-A'. Only available for
 115                 root.</para></listitem>
 116                 </varlistentry>
 117
 118                 <varlistentry>
 119                 <term>-G gid</term>
 120                 <listitem><para>Try to convert a UNIX group id to a Windows
 121                 NT SID.  If the gid specified does not refer to one within
 122                 the idmap gid range then the operation will fail. </para></listitem>
 123                 </varlistentry>
 124
 125                 <varlistentry>
 126                 <term>-I ip</term>
 127                 <listitem><para>The <parameter>-I</parameter> option
 128                 queries <citerefentry><refentrytitle>winbindd</refentrytitle>
 129                 <manvolnum>8</manvolnum></citerefentry> to send a node status
 130                 request to get the NetBIOS name associated with the IP address
 131                 specified by the <parameter>ip</parameter> parameter.
 132                 </para></listitem>
 133                 </varlistentry>
 134
 135
 136                 <varlistentry>
 137                 <term>-m</term>
 138                 <listitem><para>Produce a list of domains trusted by the
 139                 Windows NT server <citerefentry><refentrytitle>winbindd</refentrytitle>
 140                 <manvolnum>8</manvolnum></citerefentry> contacts
 141                 when resolving names.  This list does not include the Windows
 142                 NT domain the server is a Primary Domain Controller for.
 143                 </para></listitem>
 144                 </varlistentry>
 145
 146                 <varlistentry>
 147                 <term>-n name</term>
 148                 <listitem><para>The <parameter>-n</parameter> option
 149                 queries <citerefentry><refentrytitle>winbindd</refentrytitle>
 150                 <manvolnum>8</manvolnum></citerefentry> for the SID
 151                 associated with the name specified. Domain names can be specified
 152                 before the user name by using the winbind separator character.
 153                 For example CWDOM1/Administrator refers to the Administrator
 154                 user in the domain CWDOM1.  If no domain is specified then the
 155                 domain used is the one specified in the <citerefentry><refentrytitle>smb.conf</refentrytitle>
 156                 <manvolnum>5</manvolnum></citerefentry> <parameter>workgroup
 157                 </parameter> parameter. </para></listitem>
 158                 </varlistentry>
 159
 160                 <varlistentry>
 161                 <term>-N name</term>
 162                 <listitem><para>The <parameter>-N</parameter> option
 163                 queries <citerefentry><refentrytitle>winbindd</refentrytitle>
 164                 <manvolnum>8</manvolnum></citerefentry> to query the WINS
 165                 server for the IP address associated with the NetBIOS name
 166                 specified by the <parameter>name</parameter> parameter.
 167                 </para></listitem>
 168                 </varlistentry>
 169
 170                 <varlistentry>
 171                 <term>-o user:group</term>
 172                 <listitem><para>Add a winbindd local group as a secondary group
 173                 for the specified winbindd local user.
 174                 </para></listitem>
 175                 </varlistentry>
 176
 177                 <varlistentry>
 178                 <term>-O user:group</term>
 179                 <listitem><para>Remove a winbindd local group as a secondary group
 180                 for the specified winbindd local user.
 181                 </para></listitem>
 182                 </varlistentry>
 183
 184                 <varlistentry>
 185                 <term>-p</term>
 186                 <listitem><para>Check whether winbindd is still alive.
 187                 Prints out either 'succeeded' or 'failed'.
 188                 </para></listitem>
 189                 </varlistentry>
 190
 191                 <varlistentry>
 192                 <term>-r username</term>
 193                 <listitem><para>Try to obtain the list of UNIX group ids
 194                 to which the user belongs.  This only works for users
 195                 defined on a Domain Controller.
 196                 </para></listitem>
 197                 </varlistentry>
 198
 199                 <varlistentry>
 200                 <term>-s sid</term>
 201                 <listitem><para>Use <parameter>-s</parameter> to resolve
 202                 a SID to a name.  This is the inverse of the <parameter>-n
 203                 </parameter> option above.  SIDs must be specified as ASCII strings
 204                 in the traditional Microsoft format. For example,
 205                 S-1-5-21-1455342024-3071081365-2475485837-500. </para></listitem>
 206                 </varlistentry>
 207
 208                 <varlistentry>
 209                 <term>--set-auth-user username%password</term>
 210                 <listitem><para>Store username and password used by winbindd
 211                 during session setup to a domain controller.  This enables
 212                 winbindd to operate in a Windows 2000 domain with Restrict
 213                 Anonymous turned on (a.k.a. Permissions compatiable with
 214                 Windows 2000 servers only).
 215                 </para></listitem>
 216                 </varlistentry>
 217
 218                 <varlistentry>
 219                 <term>--sequence</term>
 220                 <listitem><para>Show sequence numbers of
 221                 all known domains</para></listitem>
 222                 </varlistentry>
 223
 224                 <varlistentry>
 225                 <term>-S sid</term>
 226                 <listitem><para>Convert a SID to a UNIX user id.  If the SID
 227                 does not correspond to a UNIX user mapped by <citerefentry>
 228                 <refentrytitle>winbindd</refentrytitle><manvolnum>8</manvolnum>
 229                 </citerefentry> then the operation will fail. </para></listitem>
 230                 </varlistentry>
 231
 232                 <varlistentry>
 233                 <term>-t</term>
 234                 <listitem><para>Verify that the workstation trust account
 235                 created when the Samba server is added to the Windows NT
 236                 domain is working. </para></listitem>
 237                 </varlistentry>
 238
 239                 <varlistentry>
 240                 <term>-u</term>
 241                 <listitem><para>This option will list all users available
 242                 in the Windows NT domain for which the <citerefentry><refentrytitle>winbindd</refentrytitle>
 243                 <manvolnum>8</manvolnum></citerefentry> daemon is operating in. Users in all trusted domains
 244                 will also be listed.  Note that this operation does not assign
 245                 user ids to any users that have not already been seen by <citerefentry>
 246                 <refentrytitle>winbindd</refentrytitle><manvolnum>8</manvolnum></citerefentry>
 247                 .</para></listitem>
 248                 </varlistentry>
 249
 250                 <varlistentry>
 251                 <term>-U uid</term>
 252                 <listitem><para>Try to convert a UNIX user id to a Windows NT
 253                 SID.  If the uid specified does not refer to one within
 254                 the idmap uid range then the operation will fail. </para></listitem>
 255                 </varlistentry>
 256
 257                 <varlistentry>
 258                 <term>-x user</term>
 259                 <listitem><para>Delete an existing local winbind user.
 260                 </para></listitem>
 261                 </varlistentry>
 262
 263                 <varlistentry>
 264                 <term>-X group</term>
 265                 <listitem><para>Delete an existing local winbindd group.
 266                 </para></listitem>
 267                 </varlistentry>
 268
 269                 <varlistentry>
 270                 <term>-Y sid</term>
 271                 <listitem><para>Convert a SID to a UNIX group id.  If the SID
 272                 does not correspond to a UNIX group mapped by <citerefentry>
 273                 <refentrytitle>winbindd</refentrytitle><manvolnum>8</manvolnum></citerefentry> then
 274                 the operation will fail. </para></listitem>
 275                 </varlistentry>
 276
 277
 278                 &stdarg.version;
 279                 &stdarg.help;
 280
 281         </variablelist>
 282 </refsect1>
 283
 284
 285 <refsect1>
 286         <title>EXIT STATUS</title>
 287
 288         <para>The wbinfo program returns 0 if the operation
 289         succeeded, or 1 if the operation failed.  If the <citerefentry>
 290         <refentrytitle>winbindd</refentrytitle><manvolnum>8</manvolnum>
 291         </citerefentry> daemon is not working <command>wbinfo</command> will always return
 292         failure. </para>
 293 </refsect1>
 294
 295
 296 <refsect1>
 297         <title>VERSION</title>
 298
 299         <para>This man page is correct for version 3.0 of
 300         the Samba suite.</para>
 301 </refsect1>
 302
 303 <refsect1>
 304         <title>SEE ALSO</title>
 305         <para><citerefentry><refentrytitle>winbindd</refentrytitle>
 306         <manvolnum>8</manvolnum></citerefentry> and <citerefentry><refentrytitle>ntlm_auth</refentrytitle>
 307         <manvolnum>1</manvolnum></citerefentry></para>
 308 </refsect1>
 309
 310 <refsect1>
 311         <title>AUTHOR</title>
 312
 313         <para>The original Samba software and related utilities
 314         were created by Andrew Tridgell. Samba is now developed
 315         by the Samba Team as an Open Source project similar
 316         to the way the Linux kernel is developed.</para>
 317
 318         <para><command>wbinfo</command> and <command>winbindd</command>
 319         were written by Tim Potter.</para>
 320
 321         <para>The conversion to DocBook for Samba 2.2 was done
 322         by Gerald Carter. The conversion to DocBook XML 4.2 for Samba
 323         3.0 was done by Alexander Bokovoy.</para>
 324 </refsect1>
 325
 326 </refentry>