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