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.0</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">--lookup-sids</arg>
  49                 <arg choice="opt">-m</arg>
  50                 <arg choice="opt">-n name</arg>
  51                 <arg choice="opt">-N netbios-name</arg>
  52                 <arg choice="opt">--ntlmv2</arg>
  53                 <arg choice="opt">--online-status</arg>
  54                 <arg choice="opt">--own-domain</arg>
  55                 <arg choice="opt">-p</arg>
  56                 <arg choice="opt">-P|--ping-dc</arg>
  57                 <arg choice="opt">-r user</arg>
  58                 <arg choice="opt">-R|--lookup-rids</arg>
  59                 <arg choice="opt">-s sid</arg>
  60                 <arg choice="opt">--separator</arg>
  61                 <arg choice="opt">--set-auth-user user%password</arg>
  62                 <arg choice="opt">-S sid</arg>
  63                 <arg choice="opt">--sid-aliases sid</arg>
  64                 <arg choice="opt">--sid-to-fullname sid</arg>
  65                 <arg choice="opt">-t</arg>
  66                 <arg choice="opt">-u</arg>
  67                 <arg choice="opt">--uid-info uid</arg>
  68                 <arg choice="opt">--usage</arg>
  69                 <arg choice="opt">--user-domgroups sid</arg>
  70                 <arg choice="opt">--user-sidinfo sid</arg>
  71                 <arg choice="opt">--user-sids sid</arg>
  72                 <arg choice="opt">-U uid</arg>
  73                 <arg choice="opt">-V</arg>
  74                 <arg choice="opt">--verbose</arg>
  75                 <arg choice="opt">-Y sid</arg>
  76
  77         </cmdsynopsis>
  78 </refsynopsisdiv>
  79
  80 <refsect1>
  81         <title>DESCRIPTION</title>
  82
  83         <para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
  84         <manvolnum>7</manvolnum></citerefentry> suite.</para>
  85
  86         <para>The <command>wbinfo</command> program queries and returns information
  87         created and used by the <citerefentry><refentrytitle>winbindd</refentrytitle>
  88         <manvolnum>8</manvolnum></citerefentry> daemon. </para>
  89
  90         <para>The <citerefentry><refentrytitle>winbindd</refentrytitle>
  91         <manvolnum>8</manvolnum></citerefentry> daemon must be configured
  92         and running for the <command>wbinfo</command> program to be able
  93         to return information.</para>
  94 </refsect1>
  95
  96 <refsect1>
  97         <title>OPTIONS</title>
  98
  99         <variablelist>
 100                 <varlistentry>
 101                 <term>-a|--authenticate <replaceable>username%password</replaceable></term>
 102                 <listitem><para>Attempt to authenticate a user via <citerefentry>
 103                 <refentrytitle>winbindd</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
 104                 This checks both authentication methods and reports its results.
 105                 </para><note><para>Do not be tempted to use this
 106                 functionality for authentication in third-party
 107                 applications.  Instead use <citerefentry><refentrytitle>ntlm_auth</refentrytitle>
 108         <manvolnum>1</manvolnum></citerefentry>.</para></note></listitem>
 109                 </varlistentry>
 110
 111                 <varlistentry>
 112                 <term>--allocate-gid</term>
 113                 <listitem><para>Get a new GID out of idmap
 114                 </para></listitem>
 115                 </varlistentry>
 116
 117                 <varlistentry>
 118                 <term>--allocate-uid</term>
 119                 <listitem><para>Get a new UID out of idmap
 120                 </para></listitem>
 121                 </varlistentry>
 122
 123                 <varlistentry>
 124                 <term>--all-domains</term>
 125                 <listitem><para>List all domains (trusted and
 126                 own domain).
 127                 </para></listitem>
 128                 </varlistentry>
 129
 130                 <varlistentry>
 131                 <term>-c|--change-secret</term>
 132                 <listitem><para>Change the trust account password. May be used
 133                 in conjunction with <option>domain</option> in order to change
 134                 interdomain trust account passwords.
 135                 </para></listitem>
 136                 </varlistentry>
 137
 138                 <varlistentry>
 139                 <term>--ccache-save <replaceable>username%password</replaceable></term>
 140                 <listitem><para>Store user and password for ccache.
 141                 </para></listitem>
 142                 </varlistentry>
 143
 144                 <varlistentry>
 145                 <term>--change-user-password <replaceable>username</replaceable></term>
 146                 <listitem><para>Change the password of a user. The old and new password will be prompted.
 147                 </para></listitem>
 148                 </varlistentry>
 149
 150                 <varlistentry>
 151                 <term>--dc-info <replaceable>domain</replaceable></term>
 152                 <listitem><para>Displays information about the current domain controller for a domain.
 153                 </para></listitem>
 154                 </varlistentry>
 155
 156                 <varlistentry>
 157                 <term>--domain <replaceable>name</replaceable></term>
 158                 <listitem><para>This parameter sets the domain on which any specified
 159                 operations will performed.  If special domain name '.' is used to represent
 160                 the current domain to which <citerefentry><refentrytitle>winbindd</refentrytitle>
 161                 <manvolnum>8</manvolnum></citerefentry> belongs.  Currently only the
 162                 <option>-u</option>, and <option>-g</option> options honor this parameter.
 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                 will also be listed.  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>--lookup-sids <replaceable>SID1,SID2...</replaceable></term>
 285                 <listitem><para>Looks up SIDs. SIDs must be specified as ASCII strings in the traditional Microsoft
 286                                 format. For example, S-1-5-21-1455342024-3071081365-2475485837-500.
 287                 </para></listitem>
 288                 </varlistentry>
 289
 290                 <varlistentry>
 291                 <term>-m|--trusted-domains</term>
 292                 <listitem><para>Produce a list of domains trusted by the
 293                 Windows NT server <citerefentry><refentrytitle>winbindd</refentrytitle>
 294                 <manvolnum>8</manvolnum></citerefentry> contacts
 295                 when resolving names.  This list does not include the Windows
 296                 NT domain the server is a Primary Domain Controller for.
 297                 </para></listitem>
 298                 </varlistentry>
 299
 300                 <varlistentry>
 301                 <term>-n|--name-to-sid <replaceable>name</replaceable></term>
 302                 <listitem><para>The <parameter>-n</parameter> option
 303                 queries <citerefentry><refentrytitle>winbindd</refentrytitle>
 304                 <manvolnum>8</manvolnum></citerefentry> for the SID
 305                 associated with the name specified. Domain names can be specified
 306                 before the user name by using the winbind separator character.
 307                 For example CWDOM1/Administrator refers to the Administrator
 308                 user in the domain CWDOM1.  If no domain is specified then the
 309                 domain used is the one specified in the <citerefentry><refentrytitle>smb.conf</refentrytitle>
 310                 <manvolnum>5</manvolnum></citerefentry> <parameter>workgroup
 311                 </parameter> parameter. </para></listitem>
 312                 </varlistentry>
 313
 314                 <varlistentry>
 315                 <term>-N|--WINS-by-name <replaceable>name</replaceable></term>
 316                 <listitem><para>The <parameter>-N</parameter> option
 317                 queries <citerefentry><refentrytitle>winbindd</refentrytitle>
 318                 <manvolnum>8</manvolnum></citerefentry> to query the WINS
 319                 server for the IP address associated with the NetBIOS name
 320                 specified by the <parameter>name</parameter> parameter.
 321                 </para></listitem>
 322                 </varlistentry>
 323
 324                 <varlistentry>
 325                 <term>--ntlmv2</term>
 326                 <listitem><para>Use NTLMv2 cryptography for user authentication.
 327                 </para></listitem>
 328                 </varlistentry>
 329
 330                 <varlistentry>
 331                 <term>--online-status <replaceable>domain</replaceable></term>
 332                 <listitem><para>Show whether domains are marked as online or
 333                                 offline. An optional domain argument limits the
 334                                 output to the online status of a given domain.
 335                 </para></listitem>
 336                 </varlistentry>
 337
 338                 <varlistentry>
 339                 <term>--own-domain</term>
 340                 <listitem><para>List own domain.
 341                 </para></listitem>
 342                 </varlistentry>
 343
 344                 <varlistentry>
 345                 <term>-p|--ping</term>
 346                 <listitem><para>Check whether <citerefentry><refentrytitle>winbindd</refentrytitle>
 347                 <manvolnum>8</manvolnum></citerefentry> is still alive.
 348                 Prints out either 'succeeded' or 'failed'.
 349                 </para></listitem>
 350                 </varlistentry>
 351
 352                 <varlistentry>
 353                 <term>-P|--ping-dc</term>
 354                 <listitem><para>Issue a no-effect command to our DC. This
 355                     checks if our secure channel connection to our domain
 356                     controller is still alive. It has much less impact than
 357                     wbinfo -t.
 358                 </para></listitem>
 359                 </varlistentry>
 360
 361                 <varlistentry>
 362                 <term>-r|--user-groups <replaceable>username</replaceable></term>
 363                 <listitem><para>Try to obtain the list of UNIX group ids
 364                 to which the user belongs.  This only works for users
 365                 defined on a Domain Controller.
 366                 </para></listitem>
 367                 </varlistentry>
 368
 369                 <varlistentry>
 370                 <term>-R|--lookup-rids <replaceable>rid1, rid2, rid3...</replaceable></term>
 371                 <listitem><para>Converts RIDs to names. Uses a comma separated
 372                                 list of rids.
 373                 </para></listitem>
 374                 </varlistentry>
 375
 376                 <varlistentry>
 377                 <term>-s|--sid-to-name <replaceable>sid</replaceable></term>
 378                 <listitem><para>Use <parameter>-s</parameter> to resolve
 379                 a SID to a name.  This is the inverse of the <parameter>-n
 380                 </parameter> option above.  SIDs must be specified as ASCII strings
 381                 in the traditional Microsoft format. For example,
 382                 S-1-5-21-1455342024-3071081365-2475485837-500. </para></listitem>
 383                 </varlistentry>
 384
 385                 <varlistentry>
 386                 <term>--separator</term>
 387                 <listitem><para>Get the active winbind separator.
 388                 </para></listitem>
 389                 </varlistentry>
 390
 391                 <varlistentry>
 392                 <term>--set-auth-user <replaceable>username%password</replaceable></term>
 393                 <listitem><para>Store username and password used by <citerefentry>
 394                 <refentrytitle>winbindd</refentrytitle><manvolnum>8</manvolnum>
 395                 </citerefentry> during session setup to a domain controller.  This enables
 396                 winbindd to operate in a Windows 2000 domain with Restrict
 397                 Anonymous turned on (a.k.a. Permissions compatible with
 398                 Windows 2000 servers only).
 399                 </para></listitem>
 400                 </varlistentry>
 401
 402                 <varlistentry>
 403                 <term>-S|--sid-to-uid <replaceable>sid</replaceable></term>
 404                 <listitem><para>Convert a SID to a UNIX user id.  If the SID
 405                 does not correspond to a UNIX user mapped by <citerefentry>
 406                 <refentrytitle>winbindd</refentrytitle><manvolnum>8</manvolnum>
 407                 </citerefentry> then the operation will fail. </para></listitem>
 408                 </varlistentry>
 409
 410                 <varlistentry>
 411                 <term>--sid-aliases <replaceable>sid</replaceable></term>
 412                 <listitem><para>Get SID aliases for a given SID.
 413                 </para></listitem>
 414                 </varlistentry>
 415
 416                 <varlistentry>
 417                 <term>--sid-to-fullname <replaceable>sid</replaceable></term>
 418                 <listitem><para>Converts a SID to a full username
 419                                 (DOMAIN\username).
 420                 </para></listitem>
 421                 </varlistentry>
 422
 423                 <varlistentry>
 424                 <term>-t|--check-secret</term>
 425                 <listitem><para>Verify that the workstation trust account
 426                 created when the Samba server is added to the Windows NT
 427                 domain is working. May be used in conjunction with
 428                 <option>domain</option> in order to verify interdomain
 429                 trust accounts.</para></listitem>
 430                 </varlistentry>
 431
 432                 <varlistentry>
 433                 <term>-u|--domain-users</term>
 434                 <listitem><para>This option will list all users available
 435                 in the Windows NT domain for which the <citerefentry><refentrytitle>winbindd</refentrytitle>
 436                 <manvolnum>8</manvolnum></citerefentry> daemon is operating in. Users in all trusted domains
 437                 will also be listed.  Note that this operation does not assign
 438                 user ids to any users that have not already been seen by <citerefentry>
 439                 <refentrytitle>winbindd</refentrytitle><manvolnum>8</manvolnum></citerefentry>
 440                 .</para></listitem>
 441                 </varlistentry>
 442
 443                 <varlistentry>
 444                 <term>--uid-info <replaceable>uid</replaceable></term>
 445                 <listitem><para>Get user info for the user connected to
 446                 user id UID.</para></listitem>
 447                 </varlistentry>
 448
 449                 <varlistentry>
 450                 <term>--usage</term>
 451                 <listitem><para>Print brief help overview.
 452                 </para></listitem>
 453                 </varlistentry>
 454
 455                 <varlistentry>
 456                 <term>--user-domgroups <replaceable>sid</replaceable></term>
 457                 <listitem><para>Get user domain groups.
 458                 </para></listitem>
 459                 </varlistentry>
 460
 461                 <varlistentry>
 462                 <term>--user-sidinfo <replaceable>sid</replaceable></term>
 463                 <listitem><para>Get user info by sid.
 464                 </para></listitem>
 465                 </varlistentry>
 466
 467
 468                 <varlistentry>
 469                 <term>--user-sids <replaceable>sid</replaceable></term>
 470                 <listitem><para>Get user group SIDs for user.
 471                 </para></listitem>
 472                 </varlistentry>
 473
 474                 <varlistentry>
 475                 <term>-U|--uid-to-sid <replaceable>uid</replaceable></term>
 476                 <listitem><para>Try to convert a UNIX user id to a Windows NT
 477                 SID.  If the uid specified does not refer to one within
 478                 the idmap range then the operation will fail. </para></listitem>
 479                 </varlistentry>
 480
 481                 <varlistentry>
 482                 <term>--verbose</term>
 483                 <listitem><para>
 484                 Print additional information about the query results.
 485                 </para></listitem>
 486                 </varlistentry>
 487
 488                 <varlistentry>
 489                 <term>-Y|--sid-to-gid <replaceable>sid</replaceable></term>
 490                 <listitem><para>Convert a SID to a UNIX group id.  If the SID
 491                 does not correspond to a UNIX group mapped by <citerefentry>
 492                 <refentrytitle>winbindd</refentrytitle><manvolnum>8</manvolnum></citerefentry> then
 493                 the operation will fail. </para></listitem>
 494                 </varlistentry>
 495
 496                 &stdarg.version;
 497                 &stdarg.help;
 498
 499         </variablelist>
 500 </refsect1>
 501
 502
 503 <refsect1>
 504         <title>EXIT STATUS</title>
 505
 506         <para>The wbinfo program returns 0 if the operation
 507         succeeded, or 1 if the operation failed.  If the <citerefentry>
 508         <refentrytitle>winbindd</refentrytitle><manvolnum>8</manvolnum>
 509         </citerefentry> daemon is not working <command>wbinfo</command> will always return
 510         failure. </para>
 511 </refsect1>
 512
 513
 514 <refsect1>
 515         <title>VERSION</title>
 516
 517         <para>This man page is correct for version 3 of
 518         the Samba suite.</para>
 519 </refsect1>
 520
 521 <refsect1>
 522         <title>SEE ALSO</title>
 523         <para><citerefentry><refentrytitle>winbindd</refentrytitle>
 524         <manvolnum>8</manvolnum></citerefentry> and <citerefentry><refentrytitle>ntlm_auth</refentrytitle>
 525         <manvolnum>1</manvolnum></citerefentry></para>
 526 </refsect1>
 527
 528 <refsect1>
 529         <title>AUTHOR</title>
 530
 531         <para>The original Samba software and related utilities
 532         were created by Andrew Tridgell. Samba is now developed
 533         by the Samba Team as an Open Source project similar
 534         to the way the Linux kernel is developed.</para>
 535
 536         <para><command>wbinfo</command> and <command>winbindd</command>
 537         were written by Tim Potter.</para>
 538
 539         <para>The conversion to DocBook for Samba 2.2 was done
 540         by Gerald Carter. The conversion to DocBook XML 4.2 for Samba
 541         3.0 was done by Alexander Bokovoy.</para>
 542 </refsect1>
 543
 544 </refentry>