source: branches/samba-3.3.x/docs/manpages/wbinfo.1@ 368

Last change on this file since 368 was 368, checked in by Herwig Bauernfeind, 16 years ago

Update Samba 3.3 to 3.3.10 (docs)

File size: 8.8 KB
Line 
1'\" t
2.\" Title: wbinfo
3.\" Author: [see the "AUTHOR" section]
4.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
5.\" Date: 01/14/2010
6.\" Manual: User Commands
7.\" Source: Samba 3.3
8.\" Language: English
9.\"
10.TH "WBINFO" "1" "01/14/2010" "Samba 3\&.3" "User Commands"
11.\" -----------------------------------------------------------------
12.\" * set default formatting
13.\" -----------------------------------------------------------------
14.\" disable hyphenation
15.nh
16.\" disable justification (adjust text to left margin only)
17.ad l
18.\" -----------------------------------------------------------------
19.\" * MAIN CONTENT STARTS HERE *
20.\" -----------------------------------------------------------------
21.SH "NAME"
22wbinfo \- Query information from winbind daemon
23.SH "SYNOPSIS"
24.HP \w'\ 'u
25wbinfo [\-a\ user%password] [\-\-all\-domains] [\-\-allocate\-gid] [\-\-allocate\-uid] [\-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]
26.SH "DESCRIPTION"
27.PP
28This tool is part of the
29\fBsamba\fR(7)
30suite\&.
31.PP
32The
33wbinfo
34program queries and returns information created and used by the
35\fBwinbindd\fR(8)
36daemon\&.
37.PP
38The
39\fBwinbindd\fR(8)
40daemon must be configured and running for the
41wbinfo
42program to be able to return information\&.
43.SH "OPTIONS"
44.PP
45\-a|\-\-authenticate username%password
46.RS 4
47Attempt to authenticate a user via winbindd\&. This checks both authenticaion methods and reports its results\&.
48.if n \{\
49.sp
50.\}
51.RS 4
52.it 1 an-trap
53.nr an-no-space-flag 1
54.nr an-break-flag 1
55.br
56.ps +1
57\fBNote\fR
58.ps -1
59.br
60Do not be tempted to use this functionality for authentication in third\-party applications\&. Instead use
61\fBntlm_auth\fR(1)\&.
62.sp .5v
63.RE
64.RE
65.PP
66\-\-allocate\-gid
67.RS 4
68Get a new GID out of idmap
69.RE
70.PP
71\-\-allocate\-uid
72.RS 4
73Get a new UID out of idmap
74.RE
75.PP
76\-\-all\-domains
77.RS 4
78List all domains (trusted and own domain)\&.
79.RE
80.PP
81\-\-domain name
82.RS 4
83This parameter sets the domain on which any specified operations will performed\&. If special domain name \'\&.\' is used to represent the current domain to which winbindd belongs\&. Currently only the
84\fB\-\-sequence\fR,
85\fB\-u\fR, and
86\fB\-g\fR
87options honor this parameter\&.
88.RE
89.PP
90\-D|\-\-domain\-info domain
91.RS 4
92Show most of the info we have about the domain\&.
93.RE
94.PP
95\-g|\-\-domain\-groups
96.RS 4
97This option will list all groups available in the Windows NT domain for which the
98\fBsamba\fR(7)
99daemon 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
100\fBwinbindd\fR(8)\&.
101.RE
102.PP
103\-\-get\-auth\-user
104.RS 4
105Print username and password used by winbindd during session setup to a domain controller\&. Username and password can be set using
106\fB\-\-set\-auth\-user\fR\&. Only available for root\&.
107.RE
108.PP
109\-\-getdcname domain
110.RS 4
111Get the DC name for the specified domain\&.
112.RE
113.PP
114\-G|\-\-gid\-to\-sid gid
115.RS 4
116Try 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\&.
117.RE
118.PP
119\-i|\-\-user\-info user
120.RS 4
121Get user info\&.
122.RE
123.PP
124\-I|\-\-WINS\-by\-ip ip
125.RS 4
126The
127\fI\-I\fR
128option queries
129\fBwinbindd\fR(8)
130to send a node status request to get the NetBIOS name associated with the IP address specified by the
131\fIip\fR
132parameter\&.
133.RE
134.PP
135\-K|\-\-krb5auth username%password
136.RS 4
137Attempt to authenticate a user via Kerberos\&.
138.RE
139.PP
140\-m|\-\-trusted\-domains
141.RS 4
142Produce a list of domains trusted by the Windows NT server
143\fBwinbindd\fR(8)
144contacts when resolving names\&. This list does not include the Windows NT domain the server is a Primary Domain Controller for\&.
145.RE
146.PP
147\-n|\-\-name\-to\-sid name
148.RS 4
149The
150\fI\-n\fR
151option queries
152\fBwinbindd\fR(8)
153for 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
154\fBsmb.conf\fR(5)
155\fIworkgroup \fR
156parameter\&.
157.RE
158.PP
159\-N|\-\-WINS\-by\-name name
160.RS 4
161The
162\fI\-N\fR
163option queries
164\fBwinbindd\fR(8)
165to query the WINS server for the IP address associated with the NetBIOS name specified by the
166\fIname\fR
167parameter\&.
168.RE
169.PP
170\-\-own\-domain
171.RS 4
172List own domain\&.
173.RE
174.PP
175\-p|\-\-ping
176.RS 4
177Check whether winbindd is still alive\&. Prints out either \'succeeded\' or \'failed\'\&.
178.RE
179.PP
180\-r|\-\-user\-groups username
181.RS 4
182Try to obtain the list of UNIX group ids to which the user belongs\&. This only works for users defined on a Domain Controller\&.
183.RE
184.PP
185\-s|\-\-sid\-to\-name sid
186.RS 4
187Use
188\fI\-s\fR
189to resolve a SID to a name\&. This is the inverse of the
190\fI\-n \fR
191option above\&. SIDs must be specified as ASCII strings in the traditional Microsoft format\&. For example, S\-1\-5\-21\-1455342024\-3071081365\-2475485837\-500\&.
192.RE
193.PP
194\-\-separator
195.RS 4
196Get the active winbind separator\&.
197.RE
198.PP
199\-\-sequence
200.RS 4
201Show sequence numbers of all known domains
202.RE
203.PP
204\-\-set\-auth\-user username%password
205.RS 4
206Store username and password used by winbindd during 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)\&.
207.RE
208.PP
209\-S|\-\-sid\-to\-uid sid
210.RS 4
211Convert a SID to a UNIX user id\&. If the SID does not correspond to a UNIX user mapped by
212\fBwinbindd\fR(8)
213then the operation will fail\&.
214.RE
215.PP
216\-t|\-\-check\-secret
217.RS 4
218Verify that the workstation trust account created when the Samba server is added to the Windows NT domain is working\&.
219.RE
220.PP
221\-u|\-\-domain\-users
222.RS 4
223This option will list all users available in the Windows NT domain for which the
224\fBwinbindd\fR(8)
225daemon 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
226\fBwinbindd\fR(8)
227\&.
228.RE
229.PP
230\-\-uid\-info UID
231.RS 4
232Get user info for the user conencted to user id UID\&.
233.RE
234.PP
235\-\-user\-domgroups SID
236.RS 4
237Get user domain groups\&.
238.RE
239.PP
240\-\-user\-sids SID
241.RS 4
242Get user group SIDs for user\&.
243.RE
244.PP
245\-U|\-\-uid\-to\-sid uid
246.RS 4
247Try 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\&.
248.RE
249.PP
250\-\-verbose
251.RS 4
252Print additional information about the query results\&.
253.RE
254.PP
255\-Y|\-\-sid\-to\-gid sid
256.RS 4
257Convert a SID to a UNIX group id\&. If the SID does not correspond to a UNIX group mapped by
258\fBwinbindd\fR(8)
259then the operation will fail\&.
260.RE
261.PP
262\-\-remove\-uid\-mapping uid,sid
263.RS 4
264Remove an existing uid to sid mapping entry from the IDmap backend\&.
265.RE
266.PP
267\-\-remove\-gid\-mapping gid,sid
268.RS 4
269Remove an existing gid to sid mapping entry from the IDmap backend\&.
270.RE
271.PP
272\-\-set\-uid\-mapping uid,sid
273.RS 4
274Create a new or modify an existing uid to sid mapping in the IDmap backend\&.
275.RE
276.PP
277\-\-set\-gid\-mapping gid,sid
278.RS 4
279Create a new or modify an existing gid to sid mapping in the IDmap backend\&.
280.RE
281.PP
282\-V|\-\-version
283.RS 4
284Prints the program version number\&.
285.RE
286.PP
287\-h|\-\-help
288.RS 4
289Print a summary of command line options\&.
290.RE
291.SH "EXIT STATUS"
292.PP
293The wbinfo program returns 0 if the operation succeeded, or 1 if the operation failed\&. If the
294\fBwinbindd\fR(8)
295daemon is not working
296wbinfo
297will always return failure\&.
298.SH "VERSION"
299.PP
300This man page is correct for version 3 of the Samba suite\&.
301.SH "SEE ALSO"
302.PP
303\fBwinbindd\fR(8)
304and
305\fBntlm_auth\fR(1)
306.SH "AUTHOR"
307.PP
308The 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\&.
309.PP
310wbinfo
311and
312winbindd
313were written by Tim Potter\&.
314.PP
315The 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.