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