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