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