samba-mirror/docs/docbook/manpages/wbinfo.1.sgml

<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
<refentry id="wbinfo">

<refmeta>
	<refentrytitle>wbinfo</refentrytitle>
	<manvolnum>1</manvolnum>
</refmeta>


<refnamediv>
	<refname>wbinfo</refname>
	<refpurpose>Query information from winbind daemon</refpurpose>
</refnamediv>

<refsynopsisdiv>
	<cmdsynopsis>
		<command>nmblookup</command>
		<arg choice="opt">-u</arg>
		<arg choice="opt">-g</arg>
		<arg choice="opt">-n name</arg>
		<arg choice="opt">-s sid</arg>
		<arg choice="opt">-U uid</arg>
		<arg choice="opt">-G gid</arg>
		<arg choice="opt">-S sid</arg>
		<arg choice="opt">-Y sid</arg>
		<arg choice="opt">-t</arg>
		<arg choice="opt">-m</arg>
	</cmdsynopsis>
</refsynopsisdiv>

<refsect1>
	<title>DESCRIPTION</title>

	<para>This tool is part of the <ulink url="samba.7.html">
	Samba</ulink> suite.</para>
	
	<para>The <command>wbinfo</command> program queries and returns information 
	created and used by the <ulink url="winbindd.8.html"><command>
	winbindd(8)</command></ulink> daemon. </para>

	<para>The <command>winbindd(8)</command> daemon must be configured 
	and running for the <command>wbinfo</command> program to be able 
	to return information.</para>
</refsect1>

<refsect1>
	<title>OPTIONS</title>

	<variablelist>
		<varlistentry>
		<term>-u</term>
		<listitem><para>This option will list all users available 
		in the Windows NT domain for which the <command>winbindd(8)
		</command> 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 
		<command>winbindd(8)</command>.</para></listitem>
		</varlistentry>
		
		<varlistentry>
		<term>-g</term>
		<listitem><para>This option will list all groups available 
		in the Windows NT domain for which the <command>winbindd(8)
		</command> 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
		<command>winbindd(8)</command>. </para></listitem>
		</varlistentry>
		
		
		<varlistentry>
		<term>-n name</term>
		<listitem><para>The <parameter>-n</parameter> option 
		queries <command>winbindd(8)</command> 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 <filename>smb.conf</filename>
		<parameter>workgroup</parameter> parameter. </para></listitem>
		</varlistentry>


		<varlistentry>
		<term>-s sid</term>
		<listitem><para>Use <parameter>-s</parameter> to resolve
		a SID to a name.  This is the inverse of the <parameter>-n
		</parameter> option above.  SIDs must be specified as ASCII strings 
		in the traditional Microsoft format. For example,
		S-1-5-21-1455342024-3071081365-2475485837-500. </para></listitem>
		</varlistentry>


		<varlistentry>
		<term>-U uid</term>
		<listitem><para>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. </para></listitem>
		</varlistentry>


		<varlistentry>
		<term>-G gid</term>
		<listitem><para>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. </para></listitem>
		</varlistentry>
		
		
		<varlistentry>
		<term>-S sid</term>
		<listitem><para>Convert a SID to a UNIX user id.  If the SID 
		does not correspond to a UNIX user mapped by <command>
		winbindd(8)</command> then the operation will fail. </para></listitem>
		</varlistentry>


		<varlistentry>
		<term>-Y sid</term>
		<listitem><para>Convert a SID to a UNIX group id.  If the SID 
		does not correspond to a UNIX group mapped by <command>
		winbindd(8)</command> then the operation will fail. </para></listitem>
		</varlistentry>



		<varlistentry>
		<term>-t</term>
		<listitem><para>Verify that the workstation trust account 
		created when the Samba server is added to the Windows NT
		domain is working. </para></listitem>
		</varlistentry>


		<varlistentry>
		<term>-m</term>
		<listitem><para>Produce a list of domains trusted by the 
		Windows NT server <command>winbindd(8)</command> contacts 
		when resolving names.  This list does not include the Windows 
		NT domain the server is a Primary Domain Controller for.
		</para></listitem>
		</varlistentry>
	</variablelist>
</refsect1>


<refsect1>
	<title>EXIT STATUS</title>

	<para>The wbinfo program returns 0 if the operation 
	succeeded, or 1 if the operation failed.  If the <command>winbindd(8)
	</command> daemon is not working wbinfo will always return 
	failure. </para>
</refsect1>


<refsect1>
	<title>VERSION</title>

	<para>This man page is correct for version 2.2 of 
	the Samba suite.  winbindd is however not available in
	stable release of Samba as of yet.</para>
</refsect1>

<refsect1>
	<title>SEE ALSO</title>
	<para><ulink url="winbindd.8.html"><command>winbindd(8)</command>
	</ulink></para>
</refsect1>

<refsect1>
	<title>AUTHOR</title>
	
	<para>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.</para>
	
	<para><command>wbinfo</command> and <command>winbindd</command>
	were written by TIm Potter.</para>
	
	<para>The conversion to DocBook for Samba 2.2 was done 
	by Gerald Carter</para>
</refsect1>

</refentry>