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