Initial import
[samba] / docs / manpages / wbinfo.1
1 .\"Generated by db2man.xsl. Don't modify this, modify the source.
2 .de Sh \" Subsection
3 .br
4 .if t .Sp
5 .ne 5
6 .PP
7 \fB\\$1\fR
8 .PP
9 ..
10 .de Sp \" Vertical space (when we can't use .PP)
11 .if t .sp .5v
12 .if n .sp
13 ..
14 .de Ip \" List item
15 .br
16 .ie \\n(.$>=3 .ne \\$3
17 .el .ne 3
18 .IP "\\$1" \\$2
19 ..
20 .TH "WBINFO" 1 "" "" ""
21 .SH NAME
22 wbinfo \- Query information from winbind daemon
23 .SH "SYNOPSIS"
24 .ad l
25 .hy 0
26 .HP 7
27 \fBwbinfo\fR [\-a\ user%password] [\-c\ username] [\-C\ groupname] [\-\-domain\ domain] [\-I\ ip] [\-s\ sid] [\-u] [\-U\ uid] [\-g] [\-\-get\-auth\-user] [\-G\ gid] [\-m] [\-n\ name] [\-N\ netbios\-name] [\-o\ user:group] [\-O\ user:group] [\-p] [\-r\ user] [\-\-set\-auth\-user\ user%password] [\-\-sequence] [\-S\ sid] [\-t] [\-x\ username] [\-X\ groupname] [\-Y\ sid]
28 .ad
29 .hy
30
31 .SH "DESCRIPTION"
32
33 .PP
34 This tool is part of the \fBsamba\fR(7) suite\&.
35
36 .PP
37 The \fBwbinfo\fR program queries and returns information created and used by the \fBwinbindd\fR(8) daemon\&.
38
39 .PP
40 The \fBwinbindd\fR(8) daemon must be configured and running for the \fBwbinfo\fR program to be able to return information\&.
41
42 .SH "OPTIONS"
43
44 .TP
45 \-a username%password
46 Attempt to authenticate a user via winbindd\&. This checks both authenticaion methods and reports its results\&.
47
48 .RS
49 .Sh "Note"
50 Do not be tempted to use this functionality for authentication in third\-party applications\&. Instead use \fBntlm_auth\fR(1)\&.
51
52 .RE
53
54 .TP
55 \-c user
56 Create a local winbind user\&.
57
58 .TP
59 \-C group
60 Create a local winbindd group\&.
61
62 .TP
63 \-\-domain name
64 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 winbindd belongs\&. Currently only the\fB\-\-sequence\fR,\fB\-u\fR, and \fB\-g\fR options honor this parameter\&.
65
66 .TP
67 \-g
68 This option will list all groups available in the Windows NT domain for which the \fBsamba\fR(7) 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 \fBwinbindd\fR(8)\&.
69
70 .TP
71 \-\-get\-auth\-user
72 Print username and password used by winbindd during session setup to a domain controller\&. Username and password can be set using '\-A'\&. Only available for root\&.
73
74 .TP
75 \-G gid
76 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\&.
77
78 .TP
79 \-I ip
80 The \fI\-I\fR option queries \fBwinbindd\fR(8) to send a node status request to get the NetBIOS name associated with the IP address specified by the \fIip\fR parameter\&.
81
82 .TP
83 \-m
84 Produce a list of domains trusted by the Windows NT server \fBwinbindd\fR(8) contacts when resolving names\&. This list does not include the Windows NT domain the server is a Primary Domain Controller for\&.
85
86 .TP
87 \-n name
88 The \fI\-n\fR option queries \fBwinbindd\fR(8) 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 \fBsmb\&.conf\fR(5)\fIworkgroup \fR parameter\&.
89
90 .TP
91 \-N name
92 The \fI\-N\fR option queries \fBwinbindd\fR(8) to query the WINS server for the IP address associated with the NetBIOS name specified by the \fIname\fR parameter\&.
93
94 .TP
95 \-o user:group
96 Add a winbindd local group as a secondary group for the specified winbindd local user\&.
97
98 .TP
99 \-O user:group
100 Remove a winbindd local group as a secondary group for the specified winbindd local user\&.
101
102 .TP
103 \-p
104 Check whether winbindd is still alive\&. Prints out either 'succeeded' or 'failed'\&.
105
106 .TP
107 \-r username
108 Try to obtain the list of UNIX group ids to which the user belongs\&. This only works for users defined on a Domain Controller\&.
109
110 .TP
111 \-s sid
112 Use \fI\-s\fR to resolve a SID to a name\&. This is the inverse of the \fI\-n \fR option above\&. SIDs must be specified as ASCII strings in the traditional Microsoft format\&. For example, S\-1\-5\-21\-1455342024\-3071081365\-2475485837\-500\&.
113
114 .TP
115 \-\-set\-auth\-user username%password
116 Store 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 compatiable with Windows 2000 servers only)\&.
117
118 .TP
119 \-\-sequence
120 Show sequence numbers of all known domains
121
122 .TP
123 \-S sid
124 Convert a SID to a UNIX user id\&. If the SID does not correspond to a UNIX user mapped by \fBwinbindd\fR(8) then the operation will fail\&.
125
126 .TP
127 \-t
128 Verify that the workstation trust account created when the Samba server is added to the Windows NT domain is working\&.
129
130 .TP
131 \-u
132 This option will list all users available in the Windows NT domain for which the \fBwinbindd\fR(8) 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 \fBwinbindd\fR(8) \&.
133
134 .TP
135 \-U uid
136 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\&.
137
138 .TP
139 \-x user
140 Delete an existing local winbind user\&.
141
142 .TP
143 \-X group
144 Delete an existing local winbindd group\&.
145
146 .TP
147 \-Y sid
148 Convert a SID to a UNIX group id\&. If the SID does not correspond to a UNIX group mapped by \fBwinbindd\fR(8) then the operation will fail\&.
149
150 .TP
151 \-V
152 Prints the program version number\&.
153
154 .TP
155 \-h|\-\-help
156 Print a summary of command line options\&.
157
158 .SH "EXIT STATUS"
159
160 .PP
161 The wbinfo program returns 0 if the operation succeeded, or 1 if the operation failed\&. If the \fBwinbindd\fR(8) daemon is not working \fBwbinfo\fR will always return failure\&.
162
163 .SH "VERSION"
164
165 .PP
166 This man page is correct for version 3\&.0 of the Samba suite\&.
167
168 .SH "SEE ALSO"
169
170 .PP
171 \fBwinbindd\fR(8) and \fBntlm_auth\fR(1)
172
173 .SH "AUTHOR"
174
175 .PP
176 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\&.
177
178 .PP
179 \fBwbinfo\fR and \fBwinbindd\fR were written by Tim Potter\&.
180
181 .PP
182 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\&.
183