syncing files from 3.0 into HEAD again
[Samba/bb.git] / docs / htmldocs / wbinfo.1.html
blobf5f5af0a27bf228bcb636eb8f86f6016fbe6de6c
1 <html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>wbinfo</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.60.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="wbinfo.1"></a><div class="titlepage"><div></div><div></div></div><div class="refnamediv"><h2>Name</h2><p>wbinfo &#8212; Query information from winbind daemon</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><tt class="command">wbinfo</tt> [-a user%password] [-c username] [-C groupname] [--domain domain] [-I ip] [-s sid] [-u] [-U uid] [-g] [--get-auth-user] [-G gid] [-m] [-n name] [-N netbios-name] [-o user:group] [-O user:group] [-p] [-r user] [--set-auth-user user%password] [--sequence] [-S sid] [-t] [-x username] [-X groupname] [-Y sid]</p></div></div><div class="refsect1" lang="en"><h2>DESCRIPTION</h2><p>This tool is part of the <a href="Samba.7.html"><span class="citerefentry"><span class="refentrytitle">Samba</span>(7)</span></a> suite.</p><p>The <b class="command">wbinfo</b> program queries and returns information
2 created and used by the <a href="winbindd.8.html"><span class="citerefentry"><span class="refentrytitle">winbindd</span>(8)</span></a> daemon. </p><p>The <a href="winbindd.8.html"><span class="citerefentry"><span class="refentrytitle">winbindd</span>(8)</span></a> daemon must be configured
3 and running for the <b class="command">wbinfo</b> program to be able
4 to return information.</p></div><div class="refsect1" lang="en"><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">-a username%password</span></dt><dd><p>Attempt to authenticate a user via winbindd.
5 This checks both authenticaion methods and reports its results.
6 </p></dd><dt><span class="term">-c user</span></dt><dd><p>Create a local winbind user.
7 </p></dd><dt><span class="term">-C group</span></dt><dd><p>Create a local winbindd group.
8 </p></dd><dt><span class="term">--domain name</span></dt><dd><p>This parameter sets the domain on which any specified
9 operations will performed. If special domain name '.' is used to represent
10 the current domain to which winbindd belongs. Currently only the
11 <tt class="option">--sequence</tt>,
12 <tt class="option">-u</tt>, and <tt class="option">-g</tt> options honor this parameter.
13 </p></dd><dt><span class="term">-g</span></dt><dd><p>This option will list all groups available
14 in the Windows NT domain for which the <a href="Samba.7.html"><span class="citerefentry"><span class="refentrytitle">Samba</span>(7)</span></a> daemon is operating in. Groups in all trusted domains
15 will also be listed. Note that this operation does not assign
16 group ids to any groups that have not already been
17 seen by <a href="winbindd.8.html"><span class="citerefentry"><span class="refentrytitle">winbindd</span>(8)</span></a>. </p></dd><dt><span class="term">--get-auth-user</span></dt><dd><p>Print username and password used by winbindd
18 during session setup to a domain controller. Username
19 and password can be set using '-A'. Only available for
20 root.</p></dd><dt><span class="term">-G gid</span></dt><dd><p>Try to convert a UNIX group id to a Windows
21 NT SID. If the gid specified does not refer to one within
22 the idmap gid range then the operation will fail. </p></dd><dt><span class="term">-I ip</span></dt><dd><p>The <i class="parameter"><tt>-I</tt></i> option
23 queries <a href="winbindd.8.html"><span class="citerefentry"><span class="refentrytitle">winbindd</span>(8)</span></a> to send a node status
24 request to get the NetBIOS name associated with the IP address
25 specified by the <i class="parameter"><tt>ip</tt></i> parameter.
26 </p></dd><dt><span class="term">-m</span></dt><dd><p>Produce a list of domains trusted by the
27 Windows NT server <a href="winbindd.8.html"><span class="citerefentry"><span class="refentrytitle">winbindd</span>(8)</span></a> contacts
28 when resolving names. This list does not include the Windows
29 NT domain the server is a Primary Domain Controller for.
30 </p></dd><dt><span class="term">-n name</span></dt><dd><p>The <i class="parameter"><tt>-n</tt></i> option
31 queries <a href="winbindd.8.html"><span class="citerefentry"><span class="refentrytitle">winbindd</span>(8)</span></a> for the SID
32 associated with the name specified. Domain names can be specified
33 before the user name by using the winbind separator character.
34 For example CWDOM1/Administrator refers to the Administrator
35 user in the domain CWDOM1. If no domain is specified then the
36 domain used is the one specified in the <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a> <i class="parameter"><tt>workgroup
37 </tt></i> parameter. </p></dd><dt><span class="term">-N name</span></dt><dd><p>The <i class="parameter"><tt>-N</tt></i> option
38 queries <a href="winbindd.8.html"><span class="citerefentry"><span class="refentrytitle">winbindd</span>(8)</span></a> to query the WINS
39 server for the IP address associated with the NetBIOS name
40 specified by the <i class="parameter"><tt>name</tt></i> parameter.
41 </p></dd><dt><span class="term">-o user:group</span></dt><dd><p>Add a winbindd local group as a secondary group
42 for the specified winbindd local user.
43 </p></dd><dt><span class="term">-O user:group</span></dt><dd><p>Remove a winbindd local group as a secondary group
44 for the specified winbindd local user.
45 </p></dd><dt><span class="term">-p</span></dt><dd><p>Check whether winbindd is still alive.
46 Prints out either 'succeeded' or 'failed'.
47 </p></dd><dt><span class="term">-r username</span></dt><dd><p>Try to obtain the list of UNIX group ids
48 to which the user belongs. This only works for users
49 defined on a Domain Controller.
50 </p></dd><dt><span class="term">-s sid</span></dt><dd><p>Use <i class="parameter"><tt>-s</tt></i> to resolve
51 a SID to a name. This is the inverse of the <i class="parameter"><tt>-n
52 </tt></i> option above. SIDs must be specified as ASCII strings
53 in the traditional Microsoft format. For example,
54 S-1-5-21-1455342024-3071081365-2475485837-500. </p></dd><dt><span class="term">--set-auth-user username%password</span></dt><dd><p>Store username and password used by winbindd
55 during session setup to a domain controller. This enables
56 winbindd to operate in a Windows 2000 domain with Restrict
57 Anonymous turned on (a.k.a. Permissions compatiable with
58 Windows 2000 servers only).
59 </p></dd><dt><span class="term">--sequence</span></dt><dd><p>Show sequence numbers of
60 all known domains</p></dd><dt><span class="term">-S sid</span></dt><dd><p>Convert a SID to a UNIX user id. If the SID
61 does not correspond to a UNIX user mapped by <a href="winbindd.8.html"><span class="citerefentry"><span class="refentrytitle">winbindd</span>(8)</span></a> then the operation will fail. </p></dd><dt><span class="term">-t</span></dt><dd><p>Verify that the workstation trust account
62 created when the Samba server is added to the Windows NT
63 domain is working. </p></dd><dt><span class="term">-u</span></dt><dd><p>This option will list all users available
64 in the Windows NT domain for which the <a href="winbindd.8.html"><span class="citerefentry"><span class="refentrytitle">winbindd</span>(8)</span></a> daemon is operating in. Users in all trusted domains
65 will also be listed. Note that this operation does not assign
66 user ids to any users that have not already been seen by <a href="winbindd.8.html"><span class="citerefentry"><span class="refentrytitle">winbindd</span>(8)</span></a>
67 .</p></dd><dt><span class="term">-U uid</span></dt><dd><p>Try to convert a UNIX user id to a Windows NT
68 SID. If the uid specified does not refer to one within
69 the idmap uid range then the operation will fail. </p></dd><dt><span class="term">-x user</span></dt><dd><p>Delete an existing local winbind user.
70 </p></dd><dt><span class="term">-X group</span></dt><dd><p>Delete an existing local winbindd group.
71 </p></dd><dt><span class="term">-Y sid</span></dt><dd><p>Convert a SID to a UNIX group id. If the SID
72 does not correspond to a UNIX group mapped by <a href="winbindd.8.html"><span class="citerefentry"><span class="refentrytitle">winbindd</span>(8)</span></a> then
73 the operation will fail. </p></dd><dt><span class="term">-V</span></dt><dd><p>Prints the version number for
74 <b class="command">smbd</b>.</p></dd><dt><span class="term">-h|--help</span></dt><dd><p>Print a summary of command line options.
75 </p></dd></dl></div></div><div class="refsect1" lang="en"><h2>EXIT STATUS</h2><p>The wbinfo program returns 0 if the operation
76 succeeded, or 1 if the operation failed. If the <a href="winbindd.8.html"><span class="citerefentry"><span class="refentrytitle">winbindd</span>(8)</span></a> daemon is not working <b class="command">wbinfo</b> will always return
77 failure. </p></div><div class="refsect1" lang="en"><h2>VERSION</h2><p>This man page is correct for version 3.0 of
78 the Samba suite.</p></div><div class="refsect1" lang="en"><h2>SEE ALSO</h2><p><a href="winbindd.8.html"><span class="citerefentry"><span class="refentrytitle">winbindd</span>(8)</span></a></p></div><div class="refsect1" lang="en"><h2>AUTHOR</h2><p>The original Samba software and related utilities
79 were created by Andrew Tridgell. Samba is now developed
80 by the Samba Team as an Open Source project similar
81 to the way the Linux kernel is developed.</p><p><b class="command">wbinfo</b> and <b class="command">winbindd</b>
82 were written by Tim Potter.</p><p>The conversion to DocBook for Samba 2.2 was done
83 by Gerald Carter. The conversion to DocBook XML 4.2 for Samba
84 3.0 was done by Alexander Bokovoy.</p></div></div></body></html>