This commit was manufactured by cvs2svn to create branch 'SAMBA_3_0'.
[tprouty/samba.git] / docs / manpages / wbinfo.1
1 .\" This manpage has been automatically generated by docbook2man 
2 .\" from a DocBook document.  This tool can be found at:
3 .\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> 
4 .\" Please send any bug reports, improvements, comments, patches, 
5 .\" etc. to Steve Cheng <steve@ggi-project.org>.
6 .TH "WBINFO" "1" "04 March 2003" "" ""
7 .SH NAME
8 wbinfo \- Query information from winbind daemon
9 .SH SYNOPSIS
10
11 \fBwbinfo\fR [ \fB-u\fR ] [ \fB-g\fR ] [ \fB-i ip\fR ] [ \fB-N netbios-name\fR ] [ \fB-n name\fR ] [ \fB-s sid\fR ] [ \fB-U uid\fR ] [ \fB-G gid\fR ] [ \fB-S sid\fR ] [ \fB-Y sid\fR ] [ \fB-t\fR ] [ \fB-m\fR ] [ \fB-r user\fR ] [ \fB-a user%password\fR ] [ \fB-A user%password\fR ] [ \fB-p\fR ]
12
13 .SH "DESCRIPTION"
14 .PP
15 This tool is part of the  Samba suite.
16 .PP
17 The \fBwbinfo\fR program queries and returns information 
18 created and used by the \fB winbindd(8)\fR daemon. 
19 .PP
20 The \fBwinbindd(8)\fR daemon must be configured 
21 and running for the \fBwbinfo\fR program to be able 
22 to return information.
23 .SH "OPTIONS"
24 .TP
25 \fB-u\fR
26 This option will list all users available 
27 in the Windows NT domain for which the \fBwinbindd(8)
28 \fR daemon is operating in. Users in all trusted domains 
29 will also be listed.  Note that this operation does not assign 
30 user ids to any users that have not already been seen by 
31 \fBwinbindd(8)\fR.
32 .TP
33 \fB-g\fR
34 This option will list all groups available 
35 in the Windows NT domain for which the \fBwinbindd(8)
36 \fR daemon is operating in. Groups in all trusted domains
37 will also be listed.  Note that this operation does not assign 
38 group ids to any groups that have not already been seen by
39 \fBwinbindd(8)\fR. 
40 .TP
41 \fB-N name\fR
42 The \fI-N\fR option 
43 queries \fBwinbindd(8)\fR to query the WINS
44 server for the IP address associated with the NetBIOS name
45 specified by the \fIname\fR parameter.
46 .TP
47 \fB-I ip\fR
48 The \fI-I\fR option 
49 queries \fBwinbindd(8)\fR to send a node status
50 request to get the NetBIOS name associated with the IP address
51 specified by the \fIip\fR parameter.
52 .TP
53 \fB-n name\fR
54 The \fI-n\fR option 
55 queries \fBwinbindd(8)\fR for the SID   
56 associated with the name specified. Domain names can be specified 
57 before the user name by using the winbind separator character.  
58 For example CWDOM1/Administrator refers to the Administrator
59 user in the domain CWDOM1.  If no domain is specified then the 
60 domain used is the one specified in the \fIsmb.conf\fR
61 \fIworkgroup\fR parameter. 
62 .TP
63 \fB-s sid\fR
64 Use \fI-s\fR to resolve
65 a SID to a name.  This is the inverse of the \fI-n
66 \fR option above.  SIDs must be specified as ASCII strings 
67 in the traditional Microsoft format. For example,
68 S-1-5-21-1455342024-3071081365-2475485837-500. 
69 .TP
70 \fB-U uid\fR
71 Try to convert a UNIX user id to a Windows NT 
72 SID.  If the uid specified does not refer to one within
73 the winbind uid range then the operation will fail. 
74 .TP
75 \fB-G gid\fR
76 Try to convert a UNIX group id to a Windows 
77 NT SID.  If the gid specified does not refer to one within 
78 the winbind gid range then the operation will fail. 
79 .TP
80 \fB-S sid\fR
81 Convert a SID to a UNIX user id.  If the SID 
82 does not correspond to a UNIX user mapped by \fB  winbindd(8)\fR then the operation will fail. 
83 .TP
84 \fB-Y sid\fR
85 Convert a SID to a UNIX group id.  If the SID 
86 does not correspond to a UNIX group mapped by \fB  winbindd(8)\fR then the operation will fail. 
87 .TP
88 \fB-t\fR
89 Verify that the workstation trust account 
90 created when the Samba server is added to the Windows NT
91 domain is working. 
92 .TP
93 \fB-m\fR
94 Produce a list of domains trusted by the 
95 Windows NT server \fBwinbindd(8)\fR contacts 
96 when resolving names.  This list does not include the Windows 
97 NT domain the server is a Primary Domain Controller for.
98 .TP
99 \fB-r username\fR
100 Try to obtain the list of UNIX group ids
101 to which the user belongs.  This only works for users
102 defined on a Domain Controller.
103 .TP
104 \fB-a username%password\fR
105 Attempt to authenticate a user via winbindd. 
106 This checks both authenticaion methods and reports its results.
107 .TP
108 \fB-A username%password\fR
109 Store username and password used by winbindd 
110 during session setup to a domain controller.  This enables
111 winbindd to operate in a Windows 2000 domain with Restrict
112 Anonymous turned on (a.k.a. Permissions compatiable with
113 Windows 2000 servers only).
114 .SH "EXIT STATUS"
115 .PP
116 The wbinfo program returns 0 if the operation 
117 succeeded, or 1 if the operation failed.  If the \fBwinbindd(8)
118 \fR daemon is not working \fBwbinfo\fR will always return 
119 failure. 
120 .SH "VERSION"
121 .PP
122 This man page is correct for version 3.0 of 
123 the Samba suite.
124 .SH "SEE ALSO"
125 .PP
126 \fBwinbindd(8)\fR
127
128 .SH "AUTHOR"
129 .PP
130 The original Samba software and related utilities 
131 were created by Andrew Tridgell. Samba is now developed
132 by the Samba Team as an Open Source project similar 
133 to the way the Linux kernel is developed.
134 .PP
135 \fBwbinfo\fR and \fBwinbindd\fR
136 were written by Tim Potter.
137 .PP
138 The conversion to DocBook for Samba 2.2 was done 
139 by Gerald Carter