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