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