trying to get HEAD building again. If you want the code
[tprouty/samba.git] / 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
25 .nf
26 \fBwbinfo\fR [-u] [-g] [-N netbios-name] [-I ip] [-n name] [-s sid] [-U uid] [-G gid]
27        [-S sid] [-Y sid] [-t] [-m] [--sequence] [-r user] [-a user%password]
28        [--set-auth-user user%password] [--get-auth-user] [-p]
29 .fi
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 -u
46 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) \&.
47
48
49 .TP
50 -g
51 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)\&.
52
53
54 .TP
55 -N name
56 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\&.
57
58
59 .TP
60 -I ip
61 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\&.
62
63
64 .TP
65 -n name
66 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\&.
67
68
69 .TP
70 -s sid
71 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\&.
72
73
74 .TP
75 -U uid
76 Try to convert a UNIX user id to a Windows NT SID\&. If the uid specified does not refer to one within the winbind uid range then the operation will fail\&.
77
78
79 .TP
80 -G gid
81 Try to convert a UNIX group id to a Windows NT SID\&. If the gid specified does not refer to one within the winbind gid range then the operation will fail\&.
82
83
84 .TP
85 -S sid
86 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\&.
87
88
89 .TP
90 -Y sid
91 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\&.
92
93
94 .TP
95 -t
96 Verify that the workstation trust account created when the Samba server is added to the Windows NT domain is working\&.
97
98
99 .TP
100 -m
101 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\&.
102
103
104 .TP
105 --sequence
106 Show sequence numbers of all known domains
107
108
109 .TP
110 -r username
111 Try to obtain the list of UNIX group ids to which the user belongs\&. This only works for users defined on a Domain Controller\&.
112
113
114 .TP
115 -a username%password
116 Attempt to authenticate a user via winbindd\&. This checks both authenticaion methods and reports its results\&.
117
118
119 .TP
120 --set-auth-user username%password
121 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)\&.
122
123
124 .TP
125 --get-auth-user
126 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\&.
127
128
129 .TP
130 -p
131 Check whether winbindd is still alive\&. Prints out either 'succeeded' or 'failed'\&.
132
133
134 .TP
135 -V
136 Prints the version number for \fBsmbd\fR\&.
137
138
139 .TP
140 -h|--help
141 Print a summary of command line options\&.
142
143
144 .SH "EXIT STATUS"
145
146 .PP
147 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\&.
148
149 .SH "VERSION"
150
151 .PP
152 This man page is correct for version 3\&.0 of the Samba suite\&.
153
154 .SH "SEE ALSO"
155
156 .PP
157 \fBwinbindd\fR(8)
158
159 .SH "AUTHOR"
160
161 .PP
162 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\&.
163
164 .PP
165 \fBwbinfo\fR and \fBwinbindd\fR were written by Tim Potter\&.
166
167 .PP
168 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\&.
169