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">-u</arg>
  24                 <arg choice="opt">-g</arg>
  25                 <arg choice="opt">-N netbios-name</arg>
  26                 <arg choice="opt">-I ip</arg>
  27                 <arg choice="opt">-n name</arg>
  28                 <arg choice="opt">-s sid</arg>
  29                 <arg choice="opt">-U uid</arg>
  30                 <arg choice="opt">-G gid</arg>
  31                 <arg choice="opt">-S sid</arg>
  32                 <arg choice="opt">-Y sid</arg>
  33                 <arg choice="opt">-t</arg>
  34                 <arg choice="opt">-m</arg>
  35                 <arg choice="opt">--sequence</arg>
  36                 <arg choice="opt">-r user</arg>
  37                 <arg choice="opt">-a user%password</arg>
  38                 <arg choice="opt">--set-auth-user user%password</arg>
  39                 <arg choice="opt">--get-auth-user</arg>
  40                 <arg choice="opt">-p</arg>
  41         </cmdsynopsis>
  42 </refsynopsisdiv>
  43
  44 <refsect1>
  45         <title>DESCRIPTION</title>
  46
  47         <para>This tool is part of the <citerefentry><refentrytitle>Samba</refentrytitle>
  48         <manvolnum>7</manvolnum></citerefentry> suite.</para>
  49
  50         <para>The <command>wbinfo</command> program queries and returns information
  51         created and used by the <citerefentry><refentrytitle>winbindd</refentrytitle>
  52         <manvolnum>8</manvolnum></citerefentry> daemon. </para>
  53
  54         <para>The <citerefentry><refentrytitle>winbindd</refentrytitle>
  55         <manvolnum>8</manvolnum></citerefentry> daemon must be configured
  56         and running for the <command>wbinfo</command> program to be able
  57         to return information.</para>
  58 </refsect1>
  59
  60 <refsect1>
  61         <title>OPTIONS</title>
  62
  63         <variablelist>
  64                 <varlistentry>
  65                 <term>-u</term>
  66                 <listitem><para>This option will list all users available
  67                 in the Windows NT domain for which the <citerefentry><refentrytitle>winbindd</refentrytitle>
  68                 <manvolnum>8</manvolnum></citerefentry> daemon is operating in. Users in all trusted domains
  69                 will also be listed.  Note that this operation does not assign
  70                 user ids to any users that have not already been seen by <citerefentry>
  71                 <refentrytitle>winbindd</refentrytitle><manvolnum>8</manvolnum></citerefentry>
  72                 .</para></listitem>
  73                 </varlistentry>
  74
  75                 <varlistentry>
  76                 <term>-g</term>
  77                 <listitem><para>This option will list all groups available
  78                 in the Windows NT domain for which the <citerefentry><refentrytitle>Samba</refentrytitle>
  79                 <manvolnum>7</manvolnum></citerefentry> daemon is operating in. Groups in all trusted domains
  80                 will also be listed.  Note that this operation does not assign
  81                 group ids to any groups that have not already been
  82                 seen by <citerefentry><refentrytitle>winbindd</refentrytitle>
  83                 <manvolnum>8</manvolnum></citerefentry>. </para></listitem>
  84                 </varlistentry>
  85
  86                 <varlistentry>
  87                 <term>-N name</term>
  88                 <listitem><para>The <parameter>-N</parameter> option
  89                 queries <citerefentry><refentrytitle>winbindd</refentrytitle>
  90                 <manvolnum>8</manvolnum></citerefentry> to query the WINS
  91                 server for the IP address associated with the NetBIOS name
  92                 specified by the <parameter>name</parameter> parameter.
  93                 </para></listitem>
  94                 </varlistentry>
  95
  96
  97                 <varlistentry>
  98                 <term>-I ip</term>
  99                 <listitem><para>The <parameter>-I</parameter> option
 100                 queries <citerefentry><refentrytitle>winbindd</refentrytitle>
 101                 <manvolnum>8</manvolnum></citerefentry> to send a node status
 102                 request to get the NetBIOS name associated with the IP address
 103                 specified by the <parameter>ip</parameter> parameter.
 104                 </para></listitem>
 105                 </varlistentry>
 106
 107
 108                 <varlistentry>
 109                 <term>-n name</term>
 110                 <listitem><para>The <parameter>-n</parameter> option
 111                 queries <citerefentry><refentrytitle>winbindd</refentrytitle>
 112                 <manvolnum>8</manvolnum></citerefentry> for the SID
 113                 associated with the name specified. Domain names can be specified
 114                 before the user name by using the winbind separator character.
 115                 For example CWDOM1/Administrator refers to the Administrator
 116                 user in the domain CWDOM1.  If no domain is specified then the
 117                 domain used is the one specified in the <citerefentry><refentrytitle>smb.conf</refentrytitle>
 118                 <manvolnum>5</manvolnum></citerefentry> <parameter>workgroup
 119                 </parameter> parameter. </para></listitem>
 120                 </varlistentry>
 121
 122
 123                 <varlistentry>
 124                 <term>-s sid</term>
 125                 <listitem><para>Use <parameter>-s</parameter> to resolve
 126                 a SID to a name.  This is the inverse of the <parameter>-n
 127                 </parameter> option above.  SIDs must be specified as ASCII strings
 128                 in the traditional Microsoft format. For example,
 129                 S-1-5-21-1455342024-3071081365-2475485837-500. </para></listitem>
 130                 </varlistentry>
 131
 132
 133                 <varlistentry>
 134                 <term>-U uid</term>
 135                 <listitem><para>Try to convert a UNIX user id to a Windows NT
 136                 SID.  If the uid specified does not refer to one within
 137                 the winbind uid range then the operation will fail. </para></listitem>
 138                 </varlistentry>
 139
 140
 141                 <varlistentry>
 142                 <term>-G gid</term>
 143                 <listitem><para>Try to convert a UNIX group id to a Windows
 144                 NT SID.  If the gid specified does not refer to one within
 145                 the winbind gid range then the operation will fail. </para></listitem>
 146                 </varlistentry>
 147
 148
 149                 <varlistentry>
 150                 <term>-S sid</term>
 151                 <listitem><para>Convert a SID to a UNIX user id.  If the SID
 152                 does not correspond to a UNIX user mapped by <citerefentry>
 153                 <refentrytitle>winbindd</refentrytitle><manvolnum>8</manvolnum>
 154                 </citerefentry> then the operation will fail. </para></listitem>
 155                 </varlistentry>
 156
 157
 158                 <varlistentry>
 159                 <term>-Y sid</term>
 160                 <listitem><para>Convert a SID to a UNIX group id.  If the SID
 161                 does not correspond to a UNIX group mapped by <citerefentry>
 162                 <refentrytitle>winbindd</refentrytitle><manvolnum>8</manvolnum></citerefentry> then
 163                 the operation will fail. </para></listitem>
 164                 </varlistentry>
 165
 166
 167
 168                 <varlistentry>
 169                 <term>-t</term>
 170                 <listitem><para>Verify that the workstation trust account
 171                 created when the Samba server is added to the Windows NT
 172                 domain is working. </para></listitem>
 173                 </varlistentry>
 174
 175
 176                 <varlistentry>
 177                 <term>-m</term>
 178                 <listitem><para>Produce a list of domains trusted by the
 179                 Windows NT server <citerefentry><refentrytitle>winbindd</refentrytitle>
 180                 <manvolnum>8</manvolnum></citerefentry> contacts
 181                 when resolving names.  This list does not include the Windows
 182                 NT domain the server is a Primary Domain Controller for.
 183                 </para></listitem>
 184                 </varlistentry>
 185
 186                 <varlistentry>
 187                 <term>--sequence</term>
 188                 <listitem><para>Show sequence numbers of
 189                 all known domains</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
 201                 <varlistentry>
 202                 <term>-a username%password</term>
 203                 <listitem><para>Attempt to authenticate a user via winbindd.
 204                 This checks both authenticaion methods and reports its results.
 205                 </para></listitem>
 206                 </varlistentry>
 207
 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>--get-auth-user</term>
 221                 <listitem><para>Print username and password used by winbindd
 222                 during session setup to a domain controller. Username
 223                 and password can be set using '-A'. Only available for
 224                 root.</para></listitem>
 225                 </varlistentry>
 226
 227                 <varlistentry>
 228                 <term>-p</term>
 229                 <listitem><para>Check whether winbindd is still alive.
 230                 Prints out either 'succeeded' or 'failed'.
 231                 </para></listitem>
 232                 </varlistentry>
 233
 234                 &stdarg.version;
 235                 &stdarg.help;
 236
 237         </variablelist>
 238 </refsect1>
 239
 240
 241 <refsect1>
 242         <title>EXIT STATUS</title>
 243
 244         <para>The wbinfo program returns 0 if the operation
 245         succeeded, or 1 if the operation failed.  If the <citerefentry>
 246         <refentrytitle>winbindd</refentrytitle><manvolnum>8</manvolnum>
 247         </citerefentry> daemon is not working <command>wbinfo</command> will always return
 248         failure. </para>
 249 </refsect1>
 250
 251
 252 <refsect1>
 253         <title>VERSION</title>
 254
 255         <para>This man page is correct for version 3.0 of
 256         the Samba suite.</para>
 257 </refsect1>
 258
 259 <refsect1>
 260         <title>SEE ALSO</title>
 261         <para><citerefentry><refentrytitle>winbindd</refentrytitle>
 262         <manvolnum>8</manvolnum></citerefentry></para>
 263 </refsect1>
 264
 265 <refsect1>
 266         <title>AUTHOR</title>
 267
 268         <para>The original Samba software and related utilities
 269         were created by Andrew Tridgell. Samba is now developed
 270         by the Samba Team as an Open Source project similar
 271         to the way the Linux kernel is developed.</para>
 272
 273         <para><command>wbinfo</command> and <command>winbindd</command>
 274         were written by Tim Potter.</para>
 275
 276         <para>The conversion to DocBook for Samba 2.2 was done
 277         by Gerald Carter. The conversion to DocBook XML 4.2 for Samba
 278         3.0 was done by Alexander Bokovoy.</para>
 279 </refsect1>
 280
 281 </refentry>