docs-xml/manpages-3/wbinfo.1.xml

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