docs/docbook/manpages/wbinfo.1.xml

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