merging some changes from SAMBA_2_2
[jra/samba/.git] / docs / htmldocs / wbinfo.1.html
1 <HTML
2 ><HEAD
3 ><TITLE
4 >wbinfo</TITLE
5 ><META
6 NAME="GENERATOR"
7 CONTENT="Modular DocBook HTML Stylesheet Version 1.57"></HEAD
8 ><BODY
9 CLASS="REFENTRY"
10 BGCOLOR="#FFFFFF"
11 TEXT="#000000"
12 LINK="#0000FF"
13 VLINK="#840084"
14 ALINK="#0000FF"
15 ><H1
16 ><A
17 NAME="WBINFO"
18 >wbinfo</A
19 ></H1
20 ><DIV
21 CLASS="REFNAMEDIV"
22 ><A
23 NAME="AEN5"
24 ></A
25 ><H2
26 >Name</H2
27 >wbinfo&nbsp;--&nbsp;Query information from winbind daemon</DIV
28 ><DIV
29 CLASS="REFSYNOPSISDIV"
30 ><A
31 NAME="AEN8"
32 ></A
33 ><H2
34 >Synopsis</H2
35 ><P
36 ><B
37 CLASS="COMMAND"
38 >wbinfo</B
39 >  [-u] [-g] [-h name] [-i ip] [-n name] [-s sid] [-U uid] [-G gid] [-S sid] [-Y sid] [-t] [-m] [-r user] [-a user%password] [-A user%password]</P
40 ></DIV
41 ><DIV
42 CLASS="REFSECT1"
43 ><A
44 NAME="AEN26"
45 ></A
46 ><H2
47 >DESCRIPTION</H2
48 ><P
49 >This tool is part of the <A
50 HREF="samba.7.html"
51 TARGET="_top"
52 >       Samba</A
53 > suite.</P
54 ><P
55 >The <B
56 CLASS="COMMAND"
57 >wbinfo</B
58 > program queries and returns information 
59         created and used by the <A
60 HREF="winbindd.8.html"
61 TARGET="_top"
62 ><B
63 CLASS="COMMAND"
64 >       winbindd(8)</B
65 ></A
66 > daemon. </P
67 ><P
68 >The <B
69 CLASS="COMMAND"
70 >winbindd(8)</B
71 > daemon must be configured 
72         and running for the <B
73 CLASS="COMMAND"
74 >wbinfo</B
75 > program to be able 
76         to return information.</P
77 ></DIV
78 ><DIV
79 CLASS="REFSECT1"
80 ><A
81 NAME="AEN37"
82 ></A
83 ><H2
84 >OPTIONS</H2
85 ><P
86 ></P
87 ><DIV
88 CLASS="VARIABLELIST"
89 ><DL
90 ><DT
91 >-u</DT
92 ><DD
93 ><P
94 >This option will list all users available 
95                 in the Windows NT domain for which the <B
96 CLASS="COMMAND"
97 >winbindd(8)
98                 </B
99 > daemon is operating in. Users in all trusted domains 
100                 will also be listed.  Note that this operation does not assign 
101                 user ids to any users that have not already been seen by 
102                 <B
103 CLASS="COMMAND"
104 >winbindd(8)</B
105 >.</P
106 ></DD
107 ><DT
108 >-g</DT
109 ><DD
110 ><P
111 >This option will list all groups available 
112                 in the Windows NT domain for which the <B
113 CLASS="COMMAND"
114 >winbindd(8)
115                 </B
116 > daemon is operating in. Groups in all trusted domains
117                 will also be listed.  Note that this operation does not assign 
118                 group ids to any groups that have not already been seen by
119                 <B
120 CLASS="COMMAND"
121 >winbindd(8)</B
122 >. </P
123 ></DD
124 ><DT
125 >-h name</DT
126 ><DD
127 ><P
128 >The <TT
129 CLASS="PARAMETER"
130 ><I
131 >-h</I
132 ></TT
133 > option 
134                 queries <B
135 CLASS="COMMAND"
136 >winbindd(8)</B
137 > to query the WINS
138                 server for the IP address associated with the NetBIOS name
139                 specified by the <TT
140 CLASS="PARAMETER"
141 ><I
142 >name</I
143 ></TT
144 > parameter.
145                 </P
146 ></DD
147 ><DT
148 >-i ip</DT
149 ><DD
150 ><P
151 >The <TT
152 CLASS="PARAMETER"
153 ><I
154 >-i</I
155 ></TT
156 > option 
157                 queries <B
158 CLASS="COMMAND"
159 >winbindd(8)</B
160 > to send a node status
161                 request to get the NetBIOS name associated with the IP address
162                 specified by the <TT
163 CLASS="PARAMETER"
164 ><I
165 >ip</I
166 ></TT
167 > parameter.
168                 </P
169 ></DD
170 ><DT
171 >-n name</DT
172 ><DD
173 ><P
174 >The <TT
175 CLASS="PARAMETER"
176 ><I
177 >-n</I
178 ></TT
179 > option 
180                 queries <B
181 CLASS="COMMAND"
182 >winbindd(8)</B
183 > for the SID           
184                 associated with the name specified. Domain names can be specified 
185                 before the user name by using the winbind separator character.  
186                 For example CWDOM1/Administrator refers to the Administrator
187                 user in the domain CWDOM1.  If no domain is specified then the 
188                 domain used is the one specified in the <TT
189 CLASS="FILENAME"
190 >smb.conf</TT
191 >
192                 <TT
193 CLASS="PARAMETER"
194 ><I
195 >workgroup</I
196 ></TT
197 > parameter. </P
198 ></DD
199 ><DT
200 >-s sid</DT
201 ><DD
202 ><P
203 >Use <TT
204 CLASS="PARAMETER"
205 ><I
206 >-s</I
207 ></TT
208 > to resolve
209                 a SID to a name.  This is the inverse of the <TT
210 CLASS="PARAMETER"
211 ><I
212 >-n
213                 </I
214 ></TT
215 > option above.  SIDs must be specified as ASCII strings 
216                 in the traditional Microsoft format. For example,
217                 S-1-5-21-1455342024-3071081365-2475485837-500. </P
218 ></DD
219 ><DT
220 >-U uid</DT
221 ><DD
222 ><P
223 >Try to convert a UNIX user id to a Windows NT 
224                 SID.  If the uid specified does not refer to one within
225                 the winbind uid range then the operation will fail. </P
226 ></DD
227 ><DT
228 >-G gid</DT
229 ><DD
230 ><P
231 >Try to convert a UNIX group id to a Windows 
232                 NT SID.  If the gid specified does not refer to one within 
233                 the winbind gid range then the operation will fail. </P
234 ></DD
235 ><DT
236 >-S sid</DT
237 ><DD
238 ><P
239 >Convert a SID to a UNIX user id.  If the SID 
240                 does not correspond to a UNIX user mapped by <B
241 CLASS="COMMAND"
242 >               winbindd(8)</B
243 > then the operation will fail. </P
244 ></DD
245 ><DT
246 >-Y sid</DT
247 ><DD
248 ><P
249 >Convert a SID to a UNIX group id.  If the SID 
250                 does not correspond to a UNIX group mapped by <B
251 CLASS="COMMAND"
252 >               winbindd(8)</B
253 > then the operation will fail. </P
254 ></DD
255 ><DT
256 >-t</DT
257 ><DD
258 ><P
259 >Verify that the workstation trust account 
260                 created when the Samba server is added to the Windows NT
261                 domain is working. </P
262 ></DD
263 ><DT
264 >-m</DT
265 ><DD
266 ><P
267 >Produce a list of domains trusted by the 
268                 Windows NT server <B
269 CLASS="COMMAND"
270 >winbindd(8)</B
271 > contacts 
272                 when resolving names.  This list does not include the Windows 
273                 NT domain the server is a Primary Domain Controller for.
274                 </P
275 ></DD
276 ><DT
277 >-r username</DT
278 ><DD
279 ><P
280 >Try to obtain the list of UNIX group ids
281                 to which the user belongs.  This only works for users
282                 defined on a Domain Controller.
283                 </P
284 ></DD
285 ><DT
286 >-a username%password</DT
287 ><DD
288 ><P
289 >Attempt to authenticate a user via winbindd. 
290                 This checks both authenticaion methods and reports its results.
291                 </P
292 ></DD
293 ><DT
294 >-A username%password</DT
295 ><DD
296 ><P
297 >Store username and password used by winbindd 
298                 during session setup to a domain controller.  This enables
299                 winbindd to operate in a Windows 2000 domain with Restrict
300                 Anonymous turned on (a.k.a. Permissions compatiable with
301                 Windows 2000 servers only).
302                 </P
303 ></DD
304 ></DL
305 ></DIV
306 ></DIV
307 ><DIV
308 CLASS="REFSECT1"
309 ><A
310 NAME="AEN119"
311 ></A
312 ><H2
313 >EXIT STATUS</H2
314 ><P
315 >The wbinfo program returns 0 if the operation 
316         succeeded, or 1 if the operation failed.  If the <B
317 CLASS="COMMAND"
318 >winbindd(8)
319         </B
320 > daemon is not working <B
321 CLASS="COMMAND"
322 >wbinfo</B
323 > will always return 
324         failure. </P
325 ></DIV
326 ><DIV
327 CLASS="REFSECT1"
328 ><A
329 NAME="AEN124"
330 ></A
331 ><H2
332 >VERSION</H2
333 ><P
334 >This man page is correct for version 2.2 of 
335         the Samba suite.</P
336 ></DIV
337 ><DIV
338 CLASS="REFSECT1"
339 ><A
340 NAME="AEN127"
341 ></A
342 ><H2
343 >SEE ALSO</H2
344 ><P
345 ><A
346 HREF="winbindd.8.html"
347 TARGET="_top"
348 ><B
349 CLASS="COMMAND"
350 >winbindd(8)</B
351 >
352         </A
353 ></P
354 ></DIV
355 ><DIV
356 CLASS="REFSECT1"
357 ><A
358 NAME="AEN132"
359 ></A
360 ><H2
361 >AUTHOR</H2
362 ><P
363 >The original Samba software and related utilities 
364         were created by Andrew Tridgell. Samba is now developed
365         by the Samba Team as an Open Source project similar 
366         to the way the Linux kernel is developed.</P
367 ><P
368 ><B
369 CLASS="COMMAND"
370 >wbinfo</B
371 > and <B
372 CLASS="COMMAND"
373 >winbindd</B
374 >
375         were written by Tim Potter.</P
376 ><P
377 >The conversion to DocBook for Samba 2.2 was done 
378         by Gerald Carter</P
379 ></DIV
380 ></BODY
381 ></HTML
382 >