← Back to branch summary

~zulcss/samba/server-dailies-3.4

« back to all changes in this revision

Viewing changes to docs/manpages/wbinfo.1

  • Committer: Chuck Short
  • Date: 2010-09-28 20:38:39 UTC
  • Revision ID: zulcss@ubuntu.com-20100928203839-pgjulytsi9ue63x1
Initial version

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/manpages/wbinfo.1
 
1
.\"     Title: wbinfo
 
2
.\"    Author: [see the "AUTHOR" section]
 
3
.\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
 
4
.\"      Date: 05/10/2010
 
5
.\"    Manual: User Commands
 
6
.\"    Source: Samba 3.4
 
7
.\"  Language: English
 
8
.\"
 
9
.TH "WBINFO" "1" "05/10/2010" "Samba 3\&.4" "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"
 
170
wbinfo \- 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] [\-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
 
178
This tool is part of the
 
179
\fBsamba\fR(7)
 
180
suite\&.
 
181
.PP
 
182
The
 
183
\FCwbinfo\F[]
 
184
program queries and returns information created and used by the
 
185
\fBwinbindd\fR(8)
 
186
daemon\&.
 
187
.PP
 
188
The
 
189
\fBwinbindd\fR(8)
 
190
daemon must be configured and running for the
 
191
\FCwbinfo\F[]
 
192
program to be able to return information\&.
 
193
.SH "OPTIONS"
 
194
.PP
 
195
\-a|\-\-authenticate \fIusername%password\fR
 
196
.RS 4
 
197
Attempt 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
 
212
Do 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
 
221
Get a new GID out of idmap
 
222
.RE
 
223
.PP
 
224
\-\-allocate\-uid
 
225
.RS 4
 
226
Get a new UID out of idmap
 
227
.RE
 
228
.PP
 
229
\-\-all\-domains
 
230
.RS 4
 
231
List all domains (trusted and own domain)\&.
 
232
.RE
 
233
.PP
 
234
\-\-domain \fIname\fR
 
235
.RS 4
 
236
This parameter sets the domain on which any specified operations will performed\&. If special domain name \'\&.\' is used to represent the current domain to which
 
237
\fBwinbindd\fR(8)
 
238
belongs\&. Currently only the
 
239
\fB\-\-sequence\fR,
 
240
\fB\-u\fR, and
 
241
\fB\-g\fR
 
242
options honor this parameter\&.
 
243
.RE
 
244
.PP
 
245
\-D|\-\-domain\-info \fIdomain\fR
 
246
.RS 4
 
247
Show most of the info we have about the specified domain\&.
 
248
.RE
 
249
.PP
 
250
\-g|\-\-domain\-groups
 
251
.RS 4
 
252
This option will list all groups available in the Windows NT domain for which the
 
253
\fBsamba\fR(7)
 
254
daemon 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
 
255
\fBwinbindd\fR(8)\&.
 
256
.RE
 
257
.PP
 
258
\-\-get\-auth\-user
 
259
.RS 4
 
260
Print username and password used by
 
261
\fBwinbindd\fR(8)
 
262
during session setup to a domain controller\&. Username and password can be set using
 
263
\fB\-\-set\-auth\-user\fR\&. Only available for root\&.
 
264
.RE
 
265
.PP
 
266
\-\-getdcname \fIdomain\fR
 
267
.RS 4
 
268
Get the DC name for the specified domain\&.
 
269
.RE
 
270
.PP
 
271
\-G|\-\-gid\-to\-sid \fIgid\fR
 
272
.RS 4
 
273
Try 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\&.
 
274
.RE
 
275
.PP
 
276
\-i|\-\-user\-info \fIuser\fR
 
277
.RS 4
 
278
Get user info\&.
 
279
.RE
 
280
.PP
 
281
\-I|\-\-WINS\-by\-ip \fIip\fR
 
282
.RS 4
 
283
The
 
284
\fI\-I\fR
 
285
option queries
 
286
\fBwinbindd\fR(8)
 
287
to send a node status request to get the NetBIOS name associated with the IP address specified by the
 
288
\fIip\fR
 
289
parameter\&.
 
290
.RE
 
291
.PP
 
292
\-K|\-\-krb5auth \fIusername%password\fR
 
293
.RS 4
 
294
Attempt to authenticate a user via Kerberos\&.
 
295
.RE
 
296
.PP
 
297
\-m|\-\-trusted\-domains
 
298
.RS 4
 
299
Produce a list of domains trusted by the Windows NT server
 
300
\fBwinbindd\fR(8)
 
301
contacts when resolving names\&. This list does not include the Windows NT domain the server is a Primary Domain Controller for\&.
 
302
.RE
 
303
.PP
 
304
\-n|\-\-name\-to\-sid \fIname\fR
 
305
.RS 4
 
306
The
 
307
\fI\-n\fR
 
308
option queries
 
309
\fBwinbindd\fR(8)
 
310
for 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
 
311
\fBsmb.conf\fR(5)
 
312
\fIworkgroup \fR
 
313
parameter\&.
 
314
.RE
 
315
.PP
 
316
\-N|\-\-WINS\-by\-name \fIname\fR
 
317
.RS 4
 
318
The
 
319
\fI\-N\fR
 
320
option queries
 
321
\fBwinbindd\fR(8)
 
322
to query the WINS server for the IP address associated with the NetBIOS name specified by the
 
323
\fIname\fR
 
324
parameter\&.
 
325
.RE
 
326
.PP
 
327
\-\-own\-domain
 
328
.RS 4
 
329
List own domain\&.
 
330
.RE
 
331
.PP
 
332
\-p|\-\-ping
 
333
.RS 4
 
334
Check whether
 
335
\fBwinbindd\fR(8)
 
336
is still alive\&. Prints out either \'succeeded\' or \'failed\'\&.
 
337
.RE
 
338
.PP
 
339
\-r|\-\-user\-groups \fIusername\fR
 
340
.RS 4
 
341
Try to obtain the list of UNIX group ids to which the user belongs\&. This only works for users defined on a Domain Controller\&.
 
342
.RE
 
343
.PP
 
344
\-s|\-\-sid\-to\-name \fIsid\fR
 
345
.RS 4
 
346
Use
 
347
\fI\-s\fR
 
348
to resolve a SID to a name\&. This is the inverse of the
 
349
\fI\-n \fR
 
350
option above\&. SIDs must be specified as ASCII strings in the traditional Microsoft format\&. For example, S\-1\-5\-21\-1455342024\-3071081365\-2475485837\-500\&.
 
351
.RE
 
352
.PP
 
353
\-\-separator
 
354
.RS 4
 
355
Get the active winbind separator\&.
 
356
.RE
 
357
.PP
 
358
\-\-sequence
 
359
.RS 4
 
360
Show sequence numbers of all known domains\&.
 
361
.RE
 
362
.PP
 
363
\-\-set\-auth\-user \fIusername%password\fR
 
364
.RS 4
 
365
Store username and password used by
 
366
\fBwinbindd\fR(8)
 
367
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)\&.
 
368
.RE
 
369
.PP
 
370
\-S|\-\-sid\-to\-uid \fIsid\fR
 
371
.RS 4
 
372
Convert a SID to a UNIX user id\&. If the SID does not correspond to a UNIX user mapped by
 
373
\fBwinbindd\fR(8)
 
374
then the operation will fail\&.
 
375
.RE
 
376
.PP
 
377
\-t|\-\-check\-secret
 
378
.RS 4
 
379
Verify that the workstation trust account created when the Samba server is added to the Windows NT domain is working\&.
 
380
.RE
 
381
.PP
 
382
\-u|\-\-domain\-users
 
383
.RS 4
 
384
This option will list all users available in the Windows NT domain for which the
 
385
\fBwinbindd\fR(8)
 
386
daemon 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
 
387
\fBwinbindd\fR(8)
 
388
\&.
 
389
.RE
 
390
.PP
 
391
\-\-uid\-info \fIuid\fR
 
392
.RS 4
 
393
Get user info for the user connected to user id UID\&.
 
394
.RE
 
395
.PP
 
396
\-\-user\-domgroups \fIsid\fR
 
397
.RS 4
 
398
Get user domain groups\&.
 
399
.RE
 
400
.PP
 
401
\-\-user\-sids \fIsid\fR
 
402
.RS 4
 
403
Get user group SIDs for user\&.
 
404
.RE
 
405
.PP
 
406
\-U|\-\-uid\-to\-sid \fIuid\fR
 
407
.RS 4
 
408
Try 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\&.
 
409
.RE
 
410
.PP
 
411
\-\-verbose
 
412
.RS 4
 
413
Print additional information about the query results\&.
 
414
.RE
 
415
.PP
 
416
\-Y|\-\-sid\-to\-gid \fIsid\fR
 
417
.RS 4
 
418
Convert a SID to a UNIX group id\&. If the SID does not correspond to a UNIX group mapped by
 
419
\fBwinbindd\fR(8)
 
420
then the operation will fail\&.
 
421
.RE
 
422
.PP
 
423
\-\-remove\-uid\-mapping uid,sid
 
424
.RS 4
 
425
Remove an existing uid to sid mapping entry from the IDmap backend\&.
 
426
.RE
 
427
.PP
 
428
\-\-remove\-gid\-mapping gid,sid
 
429
.RS 4
 
430
Remove an existing gid to sid mapping entry from the IDmap backend\&.
 
431
.RE
 
432
.PP
 
433
\-\-set\-uid\-mapping uid,sid
 
434
.RS 4
 
435
Create a new or modify an existing uid to sid mapping in the IDmap backend\&.
 
436
.RE
 
437
.PP
 
438
\-\-set\-gid\-mapping gid,sid
 
439
.RS 4
 
440
Create a new or modify an existing gid to sid mapping in the IDmap backend\&.
 
441
.RE
 
442
.PP
 
443
\-V|\-\-version
 
444
.RS 4
 
445
Prints the program version number\&.
 
446
.RE
 
447
.PP
 
448
\-h|\-\-help
 
449
.RS 4
 
450
Print a summary of command line options\&.
 
451
.RE
 
452
.SH "EXIT STATUS"
 
453
.PP
 
454
The wbinfo program returns 0 if the operation succeeded, or 1 if the operation failed\&. If the
 
455
\fBwinbindd\fR(8)
 
456
daemon is not working
 
457
\FCwbinfo\F[]
 
458
will always return failure\&.
 
459
.SH "VERSION"
 
460
.PP
 
461
This man page is correct for version 3 of the Samba suite\&.
 
462
.SH "SEE ALSO"
 
463
.PP
 
464
\fBwinbindd\fR(8)
 
465
and
 
466
\fBntlm_auth\fR(1)
 
467
.SH "AUTHOR"
 
468
.PP
 
469
The 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\&.
 
470
.PP
 
471
\FCwbinfo\F[]
 
472
and
 
473
\FCwinbindd\F[]
 
474
were written by Tim Potter\&.
 
475
.PP
 
476
The 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\&.