4cc0ef423f5ee8a4630cb1a0779aab22779608aa
[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] [-n name] [-s sid] [-U uid] [-G gid] [-S sid] [-Y sid] [-t] [-m] [-a user%password] [-p]</P
40 ></DIV
41 ><DIV
42 CLASS="REFSECT1"
43 ><A
44 NAME="AEN23"
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="AEN34"
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 >-n name</DT
126 ><DD
127 ><P
128 >The <TT
129 CLASS="PARAMETER"
130 ><I
131 >-n</I
132 ></TT
133 > option 
134                 queries <B
135 CLASS="COMMAND"
136 >winbindd(8)</B
137 > for the SID           
138                 associated with the name specified. Domain names can be specified 
139                 before the user name by using the winbind separator character.  
140                 For example CWDOM1/Administrator refers to the Administrator
141                 user in the domain CWDOM1.  If no domain is specified then the 
142                 domain used is the one specified in the <TT
143 CLASS="FILENAME"
144 >smb.conf</TT
145 >
146                 <TT
147 CLASS="PARAMETER"
148 ><I
149 >workgroup</I
150 ></TT
151 > parameter. </P
152 ></DD
153 ><DT
154 >-s sid</DT
155 ><DD
156 ><P
157 >Use <TT
158 CLASS="PARAMETER"
159 ><I
160 >-s</I
161 ></TT
162 > to resolve
163                 a SID to a name.  This is the inverse of the <TT
164 CLASS="PARAMETER"
165 ><I
166 >-n
167                 </I
168 ></TT
169 > option above.  SIDs must be specified as ASCII strings 
170                 in the traditional Microsoft format. For example,
171                 S-1-5-21-1455342024-3071081365-2475485837-500. </P
172 ></DD
173 ><DT
174 >-U uid</DT
175 ><DD
176 ><P
177 >Try to convert a UNIX user id to a Windows NT 
178                 SID.  If the uid specified does not refer to one within
179                 the winbind uid range then the operation will fail. </P
180 ></DD
181 ><DT
182 >-G gid</DT
183 ><DD
184 ><P
185 >Try to convert a UNIX group id to a Windows 
186                 NT SID.  If the gid specified does not refer to one within 
187                 the winbind gid range then the operation will fail. </P
188 ></DD
189 ><DT
190 >-S sid</DT
191 ><DD
192 ><P
193 >Convert a SID to a UNIX user id.  If the SID 
194                 does not correspond to a UNIX user mapped by <B
195 CLASS="COMMAND"
196 >               winbindd(8)</B
197 > then the operation will fail. </P
198 ></DD
199 ><DT
200 >-Y sid</DT
201 ><DD
202 ><P
203 >Convert a SID to a UNIX group id.  If the SID 
204                 does not correspond to a UNIX group mapped by <B
205 CLASS="COMMAND"
206 >               winbindd(8)</B
207 > then the operation will fail. </P
208 ></DD
209 ><DT
210 >-t</DT
211 ><DD
212 ><P
213 >Verify that the workstation trust account 
214                 created when the Samba server is added to the Windows NT
215                 domain is working. </P
216 ></DD
217 ><DT
218 >-m</DT
219 ><DD
220 ><P
221 >Produce a list of domains trusted by the 
222                 Windows NT server <B
223 CLASS="COMMAND"
224 >winbindd(8)</B
225 > contacts 
226                 when resolving names.  This list does not include the Windows 
227                 NT domain the server is a Primary Domain Controller for.
228                 </P
229 ></DD
230 ><DT
231 >-a username%password</DT
232 ><DD
233 ><P
234 >Attempt to authenticate a user via winbindd. 
235                 This checks both authenticaion methods and reports its results.
236                 </P
237 ></DD
238 ><DT
239 >-p</DT
240 ><DD
241 ><P
242 >Attempt a simple 'ping' check that the winbindd
243                 is indeed alive.
244                 </P
245 ></DD
246 ></DL
247 ></DIV
248 ></DIV
249 ><DIV
250 CLASS="REFSECT1"
251 ><A
252 NAME="AEN98"
253 ></A
254 ><H2
255 >EXIT STATUS</H2
256 ><P
257 >The wbinfo program returns 0 if the operation 
258         succeeded, or 1 if the operation failed.  If the <B
259 CLASS="COMMAND"
260 >winbindd(8)
261         </B
262 > daemon is not working <B
263 CLASS="COMMAND"
264 >wbinfo</B
265 > will always return 
266         failure. </P
267 ></DIV
268 ><DIV
269 CLASS="REFSECT1"
270 ><A
271 NAME="AEN103"
272 ></A
273 ><H2
274 >VERSION</H2
275 ><P
276 >This man page is correct for version 2.2 of 
277         the Samba suite.</P
278 ></DIV
279 ><DIV
280 CLASS="REFSECT1"
281 ><A
282 NAME="AEN106"
283 ></A
284 ><H2
285 >SEE ALSO</H2
286 ><P
287 ><A
288 HREF="winbindd.8.html"
289 TARGET="_top"
290 ><B
291 CLASS="COMMAND"
292 >winbindd(8)</B
293 >
294         </A
295 ></P
296 ></DIV
297 ><DIV
298 CLASS="REFSECT1"
299 ><A
300 NAME="AEN111"
301 ></A
302 ><H2
303 >AUTHOR</H2
304 ><P
305 >The original Samba software and related utilities 
306         were created by Andrew Tridgell. Samba is now developed
307         by the Samba Team as an Open Source project similar 
308         to the way the Linux kernel is developed.</P
309 ><P
310 ><B
311 CLASS="COMMAND"
312 >wbinfo</B
313 > and <B
314 CLASS="COMMAND"
315 >winbindd</B
316 >
317         were written by Tim Potter.</P
318 ><P
319 >The conversion to DocBook for Samba 2.2 was done 
320         by Gerald Carter</P
321 ></DIV
322 ></BODY
323 ></HTML
324 >