source: vendor/3.5.7/docs/manpages/wbinfo.1

Last change on this file was 478, checked in by Silvan Scherrer, 15 years ago

Samba 3.5: vendor update to 3.5.4

File size: 12.6 KB
Line 
1.\" Title: wbinfo
2.\" Author: [see the "AUTHOR" section]
3.\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
4.\" Date: 06/18/2010
5.\" Manual: User Commands
6.\" Source: Samba 3.5
7.\" Language: English
8.\"
9.TH "WBINFO" "1" "06/18/2010" "Samba 3\&.5" "User Commands"
10.\" -----------------------------------------------------------------
11.\" * (re)Define some macros
12.\" -----------------------------------------------------------------
13.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
14.\" toupper - uppercase a string (locale-aware)
15.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
16.de toupper
17.tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
18\\$*
19.tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
20..
21.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
22.\" SH-xref - format a cross-reference to an SH section
23.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
24.de SH-xref
25.ie n \{\
26.\}
27.toupper \\$*
28.el \{\
29\\$*
30.\}
31..
32.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
33.\" SH - level-one heading that works better for non-TTY output
34.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
35.de1 SH
36.\" put an extra blank line of space above the head in non-TTY output
37.if t \{\
38.sp 1
39.\}
40.sp \\n[PD]u
41.nr an-level 1
42.set-an-margin
43.nr an-prevailing-indent \\n[IN]
44.fi
45.in \\n[an-margin]u
46.ti 0
47.HTML-TAG ".NH \\n[an-level]"
48.it 1 an-trap
49.nr an-no-space-flag 1
50.nr an-break-flag 1
51\." make the size of the head bigger
52.ps +3
53.ft B
54.ne (2v + 1u)
55.ie n \{\
56.\" if n (TTY output), use uppercase
57.toupper \\$*
58.\}
59.el \{\
60.nr an-break-flag 0
61.\" if not n (not TTY), use normal case (not uppercase)
62\\$1
63.in \\n[an-margin]u
64.ti 0
65.\" if not n (not TTY), put a border/line under subheading
66.sp -.6
67\l'\n(.lu'
68.\}
69..
70.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
71.\" SS - level-two heading that works better for non-TTY output
72.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
73.de1 SS
74.sp \\n[PD]u
75.nr an-level 1
76.set-an-margin
77.nr an-prevailing-indent \\n[IN]
78.fi
79.in \\n[IN]u
80.ti \\n[SN]u
81.it 1 an-trap
82.nr an-no-space-flag 1
83.nr an-break-flag 1
84.ps \\n[PS-SS]u
85\." make the size of the head bigger
86.ps +2
87.ft B
88.ne (2v + 1u)
89.if \\n[.$] \&\\$*
90..
91.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
92.\" BB/BE - put background/screen (filled box) around block of text
93.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
94.de BB
95.if t \{\
96.sp -.5
97.br
98.in +2n
99.ll -2n
100.gcolor red
101.di BX
102.\}
103..
104.de EB
105.if t \{\
106.if "\\$2"adjust-for-leading-newline" \{\
107.sp -1
108.\}
109.br
110.di
111.in
112.ll
113.gcolor
114.nr BW \\n(.lu-\\n(.i
115.nr BH \\n(dn+.5v
116.ne \\n(BHu+.5v
117.ie "\\$2"adjust-for-leading-newline" \{\
118\M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
119.\}
120.el \{\
121\M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
122.\}
123.in 0
124.sp -.5v
125.nf
126.BX
127.in
128.sp .5v
129.fi
130.\}
131..
132.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
133.\" BM/EM - put colored marker in margin next to block of text
134.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
135.de BM
136.if t \{\
137.br
138.ll -2n
139.gcolor red
140.di BX
141.\}
142..
143.de EM
144.if t \{\
145.br
146.di
147.ll
148.gcolor
149.nr BH \\n(dn
150.ne \\n(BHu
151\M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
152.in 0
153.nf
154.BX
155.in
156.fi
157.\}
158..
159.\" -----------------------------------------------------------------
160.\" * set default formatting
161.\" -----------------------------------------------------------------
162.\" disable hyphenation
163.nh
164.\" disable justification (adjust text to left margin only)
165.ad l
166.\" -----------------------------------------------------------------
167.\" * MAIN CONTENT STARTS HERE *
168.\" -----------------------------------------------------------------
169.SH "Name"
170wbinfo \- Query information from winbind daemon
171.SH "Synopsis"
172.fam C
173.HP \w'\ 'u
174\FCwbinfo\F[] [\-a\ user%password] [\-\-all\-domains] [\-\-allocate\-gid] [\-\-allocate\-uid] [\-c] [\-D\ domain] [\-\-domain\ domain] [\-g] [\-\-getdcname\ domain] [\-\-get\-auth\-user] [\-G\ gid] [\-h] [\-i\ user] [\-I\ ip] [\-K\ user%password] [\-m] [\-n\ name] [\-N\ netbios\-name] [\-\-own\-domain] [\-p] [\-r\ user] [\-\-remove\-uid\-mapping\ uid,sid] [\-\-remove\-gid\-mapping\ gid,sid] [\-s\ sid] [\-\-separator] [\-\-sequence] [\-\-set\-auth\-user\ user%password] [\-\-set\-uid\-mapping\ uid,sid] [\-\-set\-gid\-mapping\ gid,sid] [\-S\ sid] [\-t] [\-u] [\-\-uid\-info\ uid] [\-\-user\-domgroups\ sid] [\-\-user\-sids\ sid] [\-U\ uid] [\-V] [\-Y\ sid] [\-\-verbose]
175.fam
176.SH "DESCRIPTION"
177.PP
178This tool is part of the
179\fBsamba\fR(7)
180suite\&.
181.PP
182The
183\FCwbinfo\F[]
184program queries and returns information created and used by the
185\fBwinbindd\fR(8)
186daemon\&.
187.PP
188The
189\fBwinbindd\fR(8)
190daemon must be configured and running for the
191\FCwbinfo\F[]
192program to be able to return information\&.
193.SH "OPTIONS"
194.PP
195\-a|\-\-authenticate \fIusername%password\fR
196.RS 4
197Attempt to authenticate a user via
198\fBwinbindd\fR(8)\&. This checks both authentication methods and reports its results\&.
199.if n \{\
200.sp
201.\}
202.RS 4
203.BM yellow
204.it 1 an-trap
205.nr an-no-space-flag 1
206.nr an-break-flag 1
207.br
208.ps +1
209\fBNote\fR
210.ps -1
211.br
212Do not be tempted to use this functionality for authentication in third\-party applications\&. Instead use
213\fBntlm_auth\fR(1)\&.
214.sp .5v
215.EM yellow
216.RE
217.RE
218.PP
219\-\-allocate\-gid
220.RS 4
221Get a new GID out of idmap
222.RE
223.PP
224\-\-allocate\-uid
225.RS 4
226Get a new UID out of idmap
227.RE
228.PP
229\-\-all\-domains
230.RS 4
231List all domains (trusted and own domain)\&.
232.RE
233.PP
234\-c|\-\-change\-secret
235.RS 4
236Change the trust account password\&. May be used in conjunction with
237\fBdomain\fR
238in order to change interdomain trust account passwords\&.
239.RE
240.PP
241\-\-domain \fIname\fR
242.RS 4
243This parameter sets the domain on which any specified operations will performed\&. If special domain name \'\&.\' is used to represent the current domain to which
244\fBwinbindd\fR(8)
245belongs\&. Currently only the
246\fB\-\-sequence\fR,
247\fB\-u\fR, and
248\fB\-g\fR
249options honor this parameter\&.
250.RE
251.PP
252\-D|\-\-domain\-info \fIdomain\fR
253.RS 4
254Show most of the info we have about the specified domain\&.
255.RE
256.PP
257\-g|\-\-domain\-groups
258.RS 4
259This option will list all groups available in the Windows NT domain for which the
260\fBsamba\fR(7)
261daemon is operating in\&. Groups in all trusted domains will also be listed\&. Note that this operation does not assign group ids to any groups that have not already been seen by
262\fBwinbindd\fR(8)\&.
263.RE
264.PP
265\-\-get\-auth\-user
266.RS 4
267Print username and password used by
268\fBwinbindd\fR(8)
269during session setup to a domain controller\&. Username and password can be set using
270\fB\-\-set\-auth\-user\fR\&. Only available for root\&.
271.RE
272.PP
273\-\-getdcname \fIdomain\fR
274.RS 4
275Get the DC name for the specified domain\&.
276.RE
277.PP
278\-G|\-\-gid\-to\-sid \fIgid\fR
279.RS 4
280Try to convert a UNIX group id to a Windows NT SID\&. If the gid specified does not refer to one within the idmap gid range then the operation will fail\&.
281.RE
282.PP
283\-i|\-\-user\-info \fIuser\fR
284.RS 4
285Get user info\&.
286.RE
287.PP
288\-I|\-\-WINS\-by\-ip \fIip\fR
289.RS 4
290The
291\fI\-I\fR
292option queries
293\fBwinbindd\fR(8)
294to send a node status request to get the NetBIOS name associated with the IP address specified by the
295\fIip\fR
296parameter\&.
297.RE
298.PP
299\-K|\-\-krb5auth \fIusername%password\fR
300.RS 4
301Attempt to authenticate a user via Kerberos\&.
302.RE
303.PP
304\-m|\-\-trusted\-domains
305.RS 4
306Produce a list of domains trusted by the Windows NT server
307\fBwinbindd\fR(8)
308contacts when resolving names\&. This list does not include the Windows NT domain the server is a Primary Domain Controller for\&.
309.RE
310.PP
311\-n|\-\-name\-to\-sid \fIname\fR
312.RS 4
313The
314\fI\-n\fR
315option queries
316\fBwinbindd\fR(8)
317for the SID associated with the name specified\&. Domain names can be specified before the user name by using the winbind separator character\&. For example CWDOM1/Administrator refers to the Administrator user in the domain CWDOM1\&. If no domain is specified then the domain used is the one specified in the
318\fBsmb.conf\fR(5)
319\fIworkgroup \fR
320parameter\&.
321.RE
322.PP
323\-N|\-\-WINS\-by\-name \fIname\fR
324.RS 4
325The
326\fI\-N\fR
327option queries
328\fBwinbindd\fR(8)
329to query the WINS server for the IP address associated with the NetBIOS name specified by the
330\fIname\fR
331parameter\&.
332.RE
333.PP
334\-\-own\-domain
335.RS 4
336List own domain\&.
337.RE
338.PP
339\-p|\-\-ping
340.RS 4
341Check whether
342\fBwinbindd\fR(8)
343is still alive\&. Prints out either \'succeeded\' or \'failed\'\&.
344.RE
345.PP
346\-r|\-\-user\-groups \fIusername\fR
347.RS 4
348Try to obtain the list of UNIX group ids to which the user belongs\&. This only works for users defined on a Domain Controller\&.
349.RE
350.PP
351\-s|\-\-sid\-to\-name \fIsid\fR
352.RS 4
353Use
354\fI\-s\fR
355to resolve a SID to a name\&. This is the inverse of the
356\fI\-n \fR
357option above\&. SIDs must be specified as ASCII strings in the traditional Microsoft format\&. For example, S\-1\-5\-21\-1455342024\-3071081365\-2475485837\-500\&.
358.RE
359.PP
360\-\-separator
361.RS 4
362Get the active winbind separator\&.
363.RE
364.PP
365\-\-sequence
366.RS 4
367Show sequence numbers of all known domains\&.
368.RE
369.PP
370\-\-set\-auth\-user \fIusername%password\fR
371.RS 4
372Store username and password used by
373\fBwinbindd\fR(8)
374during session setup to a domain controller\&. This enables winbindd to operate in a Windows 2000 domain with Restrict Anonymous turned on (a\&.k\&.a\&. Permissions compatible with Windows 2000 servers only)\&.
375.RE
376.PP
377\-S|\-\-sid\-to\-uid \fIsid\fR
378.RS 4
379Convert a SID to a UNIX user id\&. If the SID does not correspond to a UNIX user mapped by
380\fBwinbindd\fR(8)
381then the operation will fail\&.
382.RE
383.PP
384\-t|\-\-check\-secret
385.RS 4
386Verify that the workstation trust account created when the Samba server is added to the Windows NT domain is working\&. May be used in conjunction with
387\fBdomain\fR
388in order to verify interdomain trust accounts\&.
389.RE
390.PP
391\-u|\-\-domain\-users
392.RS 4
393This option will list all users available in the Windows NT domain for which the
394\fBwinbindd\fR(8)
395daemon is operating in\&. Users in all trusted domains will also be listed\&. Note that this operation does not assign user ids to any users that have not already been seen by
396\fBwinbindd\fR(8)
397\&.
398.RE
399.PP
400\-\-uid\-info \fIuid\fR
401.RS 4
402Get user info for the user connected to user id UID\&.
403.RE
404.PP
405\-\-user\-domgroups \fIsid\fR
406.RS 4
407Get user domain groups\&.
408.RE
409.PP
410\-\-user\-sids \fIsid\fR
411.RS 4
412Get user group SIDs for user\&.
413.RE
414.PP
415\-U|\-\-uid\-to\-sid \fIuid\fR
416.RS 4
417Try to convert a UNIX user id to a Windows NT SID\&. If the uid specified does not refer to one within the idmap uid range then the operation will fail\&.
418.RE
419.PP
420\-\-verbose
421.RS 4
422Print additional information about the query results\&.
423.RE
424.PP
425\-Y|\-\-sid\-to\-gid \fIsid\fR
426.RS 4
427Convert a SID to a UNIX group id\&. If the SID does not correspond to a UNIX group mapped by
428\fBwinbindd\fR(8)
429then the operation will fail\&.
430.RE
431.PP
432\-\-remove\-uid\-mapping uid,sid
433.RS 4
434Remove an existing uid to sid mapping entry from the IDmap backend\&.
435.RE
436.PP
437\-\-remove\-gid\-mapping gid,sid
438.RS 4
439Remove an existing gid to sid mapping entry from the IDmap backend\&.
440.RE
441.PP
442\-\-set\-uid\-mapping uid,sid
443.RS 4
444Create a new or modify an existing uid to sid mapping in the IDmap backend\&.
445.RE
446.PP
447\-\-set\-gid\-mapping gid,sid
448.RS 4
449Create a new or modify an existing gid to sid mapping in the IDmap backend\&.
450.RE
451.PP
452\-V|\-\-version
453.RS 4
454Prints the program version number\&.
455.RE
456.PP
457\-h|\-\-help
458.RS 4
459Print a summary of command line options\&.
460.RE
461.SH "EXIT STATUS"
462.PP
463The wbinfo program returns 0 if the operation succeeded, or 1 if the operation failed\&. If the
464\fBwinbindd\fR(8)
465daemon is not working
466\FCwbinfo\F[]
467will always return failure\&.
468.SH "VERSION"
469.PP
470This man page is correct for version 3 of the Samba suite\&.
471.SH "SEE ALSO"
472.PP
473\fBwinbindd\fR(8)
474and
475\fBntlm_auth\fR(1)
476.SH "AUTHOR"
477.PP
478The original Samba software and related utilities were created by Andrew Tridgell\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&.
479.PP
480\FCwbinfo\F[]
481and
482\FCwinbindd\F[]
483were written by Tim Potter\&.
484.PP
485The conversion to DocBook for Samba 2\&.2 was done by Gerald Carter\&. The conversion to DocBook XML 4\&.2 for Samba 3\&.0 was done by Alexander Bokovoy\&.
Note: See TracBrowser for help on using the repository browser.