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