7f2c4624a9a5b5cb012abfb58425632742be6825
[nivanova/samba-autobuild/.git] / docs / docbook / manpages / wbinfo.1.sgml
1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
2 <refentry id="wbinfo">
3
4 <refmeta>
5         <refentrytitle>wbinfo</refentrytitle>
6         <manvolnum>1</manvolnum>
7 </refmeta>
8
9
10 <refnamediv>
11         <refname>wbinfo</refname>
12         <refpurpose>Query information from winbind daemon</refpurpose>
13 </refnamediv>
14
15 <refsynopsisdiv>
16         <cmdsynopsis>
17                 <command>wbinfo</command>
18                 <arg choice="opt">-u</arg>
19                 <arg choice="opt">-g</arg>
20                 <arg choice="opt">-n name</arg>
21                 <arg choice="opt">-s sid</arg>
22                 <arg choice="opt">-U uid</arg>
23                 <arg choice="opt">-G gid</arg>
24                 <arg choice="opt">-S sid</arg>
25                 <arg choice="opt">-Y sid</arg>
26                 <arg choice="opt">-t</arg>
27                 <arg choice="opt">-m</arg>
28                 <arg choice="opt">-a user%password</arg>
29                 <arg choice="opt">-p</arg>
30         </cmdsynopsis>
31 </refsynopsisdiv>
32
33 <refsect1>
34         <title>DESCRIPTION</title>
35
36         <para>This tool is part of the <ulink url="samba.7.html">
37         Samba</ulink> suite.</para>
38         
39         <para>The <command>wbinfo</command> program queries and returns information 
40         created and used by the <ulink url="winbindd.8.html"><command>
41         winbindd(8)</command></ulink> daemon. </para>
42
43         <para>The <command>winbindd(8)</command> daemon must be configured 
44         and running for the <command>wbinfo</command> program to be able 
45         to return information.</para>
46 </refsect1>
47
48 <refsect1>
49         <title>OPTIONS</title>
50
51         <variablelist>
52                 <varlistentry>
53                 <term>-u</term>
54                 <listitem><para>This option will list all users available 
55                 in the Windows NT domain for which the <command>winbindd(8)
56                 </command> daemon is operating in. Users in all trusted domains 
57                 will also be listed.  Note that this operation does not assign 
58                 user ids to any users that have not already been seen by 
59                 <command>winbindd(8)</command>.</para></listitem>
60                 </varlistentry>
61                 
62                 <varlistentry>
63                 <term>-g</term>
64                 <listitem><para>This option will list all groups available 
65                 in the Windows NT domain for which the <command>winbindd(8)
66                 </command> daemon is operating in. Groups in all trusted domains
67                 will also be listed.  Note that this operation does not assign 
68                 group ids to any groups that have not already been seen by
69                 <command>winbindd(8)</command>. </para></listitem>
70                 </varlistentry>
71                 
72                 
73                 <varlistentry>
74                 <term>-n name</term>
75                 <listitem><para>The <parameter>-n</parameter> option 
76                 queries <command>winbindd(8)</command> for the SID              
77                 associated with the name specified. Domain names can be specified 
78                 before the user name by using the winbind separator character.  
79                 For example CWDOM1/Administrator refers to the Administrator
80                 user in the domain CWDOM1.  If no domain is specified then the 
81                 domain used is the one specified in the <filename>smb.conf</filename>
82                 <parameter>workgroup</parameter> parameter. </para></listitem>
83                 </varlistentry>
84
85
86                 <varlistentry>
87                 <term>-s sid</term>
88                 <listitem><para>Use <parameter>-s</parameter> to resolve
89                 a SID to a name.  This is the inverse of the <parameter>-n
90                 </parameter> option above.  SIDs must be specified as ASCII strings 
91                 in the traditional Microsoft format. For example,
92                 S-1-5-21-1455342024-3071081365-2475485837-500. </para></listitem>
93                 </varlistentry>
94
95
96                 <varlistentry>
97                 <term>-U uid</term>
98                 <listitem><para>Try to convert a UNIX user id to a Windows NT 
99                 SID.  If the uid specified does not refer to one within
100                 the winbind uid range then the operation will fail. </para></listitem>
101                 </varlistentry>
102
103
104                 <varlistentry>
105                 <term>-G gid</term>
106                 <listitem><para>Try to convert a UNIX group id to a Windows 
107                 NT SID.  If the gid specified does not refer to one within 
108                 the winbind gid range then the operation will fail. </para></listitem>
109                 </varlistentry>
110                 
111                 
112                 <varlistentry>
113                 <term>-S sid</term>
114                 <listitem><para>Convert a SID to a UNIX user id.  If the SID 
115                 does not correspond to a UNIX user mapped by <command>
116                 winbindd(8)</command> then the operation will fail. </para></listitem>
117                 </varlistentry>
118
119
120                 <varlistentry>
121                 <term>-Y sid</term>
122                 <listitem><para>Convert a SID to a UNIX group id.  If the SID 
123                 does not correspond to a UNIX group mapped by <command>
124                 winbindd(8)</command> then the operation will fail. </para></listitem>
125                 </varlistentry>
126
127
128
129                 <varlistentry>
130                 <term>-t</term>
131                 <listitem><para>Verify that the workstation trust account 
132                 created when the Samba server is added to the Windows NT
133                 domain is working. </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 <command>winbindd(8)</command> contacts 
141                 when resolving names.  This list does not include the Windows 
142                 NT domain the server is a Primary Domain Controller for.
143                 </para></listitem>
144                 </varlistentry>
145
146                 <varlistentry>
147                 <term>-a username%password</term>
148                 <listitem><para>Attempt to authenticate a user via winbindd. 
149                 This checks both authenticaion methods and reports its results.
150                 </para></listitem>
151                 </varlistentry>
152
153                 <varlistentry>
154                 <term>-p</term>
155                 <listitem><para>Attempt a simple 'ping' check that the winbindd
156                 is indeed alive.
157                 </para></listitem>
158                 </varlistentry>
159         </variablelist>
160 </refsect1>
161
162
163 <refsect1>
164         <title>EXIT STATUS</title>
165
166         <para>The wbinfo program returns 0 if the operation 
167         succeeded, or 1 if the operation failed.  If the <command>winbindd(8)
168         </command> daemon is not working <command>wbinfo</command> will always return 
169         failure. </para>
170 </refsect1>
171
172
173 <refsect1>
174         <title>VERSION</title>
175
176         <para>This man page is correct for version 2.2 of 
177         the Samba suite.</para>
178 </refsect1>
179
180 <refsect1>
181         <title>SEE ALSO</title>
182         <para><ulink url="winbindd.8.html"><command>winbindd(8)</command>
183         </ulink></para>
184 </refsect1>
185
186 <refsect1>
187         <title>AUTHOR</title>
188         
189         <para>The original Samba software and related utilities 
190         were created by Andrew Tridgell. Samba is now developed
191         by the Samba Team as an Open Source project similar 
192         to the way the Linux kernel is developed.</para>
193         
194         <para><command>wbinfo</command> and <command>winbindd</command>
195         were written by Tim Potter.</para>
196         
197         <para>The conversion to DocBook for Samba 2.2 was done 
198         by Gerald Carter</para>
199 </refsect1>
200
201 </refentry>