docs: Document DCEPRC binding string for rpcclient
[amitay/samba.git] / docs-xml / manpages / rpcclient.1.xml
index 7193a906e29ee68345b5e666cb1dc5647a166cb5..93983ad8388ab02f4a2df70ff0126b527ac18dc3 100644 (file)
@@ -7,7 +7,7 @@
        <manvolnum>1</manvolnum>
        <refmiscinfo class="source">Samba</refmiscinfo>
        <refmiscinfo class="manual">User Commands</refmiscinfo>
-       <refmiscinfo class="version">4.1</refmiscinfo>
+       <refmiscinfo class="version">&doc.version;</refmiscinfo>
 </refmeta>
 
 
                <arg choice="opt">-A authfile</arg>
                <arg choice="opt">-c &lt;command string&gt;</arg>
                <arg choice="opt">-d debuglevel</arg>
-               <arg choice="opt">-h</arg>
                <arg choice="opt">-l logdir</arg>
                <arg choice="opt">-N</arg>
                <arg choice="opt">-s &lt;smb config file&gt;</arg>
                <arg choice="opt">-U username[%password]</arg>
                <arg choice="opt">-W workgroup</arg>
                <arg choice="opt">-I destinationIP</arg>
-               <arg choice="req">server</arg>
+               <arg choice="req">BINDING-STRING|HOST</arg>
        </cmdsynopsis>
 </refsynopsisdiv>
 
 
        <variablelist>
                <varlistentry>
-               <term>server</term>
-               <listitem><para>NetBIOS name of Server to which to connect. 
-               The server can be  any SMB/CIFS server.  The name is 
-               resolved using the <smbconfoption name="name resolve order"/> line from <citerefentry><refentrytitle>smb.conf</refentrytitle>
-       <manvolnum>5</manvolnum></citerefentry>.</para></listitem>
-       </varlistentry>
+               <term>BINDING-STRING|HOST</term>
+               <listitem>
+                       <para>When connecting to a dcerpc service you need to
+                       specify a binding string.</para>
+
+                       <para>The format is:</para>
+
+                       <para>TRANSPORT:host[options]</para>
+
+                       <para>where TRANSPORT is either ncacn_np (named pipes) for SMB or
+                       ncacn_ip_tcp for DCERPC over TCP/IP.</para>
+
+                       <para>"host" is an IP or hostname or netbios name. If the binding
+                       string identifies the server side of an endpoint, "host" may be
+                       an empty string. See below for more details.</para>
+
+                       <para>"options" can include a SMB pipe name if using the ncacn_np
+                       transport or a TCP port number if using the ncacn_ip_tcp transport,
+                       otherwise they will be auto-determined.</para>
+
+                       <para>Examples:</para>
+
+                       <itemizedlist>
+                       <listitem><para><parameter moreinfo="none">ncacn_ip_tcp:samba.example.com[1024]</parameter></para></listitem>
+                       <listitem><para><parameter moreinfo="none">ncacn_ip_tcp:samba.example.com[sign,seal,krb5]</parameter></para></listitem>
+                       <listitem><para><parameter moreinfo="none">ncacn_ip_tcp:samba.example.com[sign,spnego]</parameter></para></listitem>
+                       <listitem><para><parameter moreinfo="none">ncacn_np:samba.example.com</parameter></para></listitem>
+                       <listitem><para><parameter moreinfo="none">ncacn_np:samba.example.com[samr]</parameter></para></listitem>
+                       <listitem><para><parameter moreinfo="none">ncacn_np:samba.example.com[samr,sign,print]</parameter></para></listitem>
+                       <listitem><para><parameter moreinfo="none">ncalrpc:/path/to/unix/socket</parameter></para></listitem>
+                       <listitem><para><parameter moreinfo="none">//SAMBA</parameter></para></listitem>
+                       </itemizedlist>
+
+                       <para>The supported transports are:</para>
+
+                       <itemizedlist>
+                       <listitem><para><parameter moreinfo="none">ncacn_np</parameter> - Connect using named pipes</para></listitem>
+                       <listitem><para><parameter moreinfo="none">ncacn_ip_tcp</parameter> - Connect over TCP/IP</para></listitem>
+                       <listitem><para><parameter moreinfo="none">ncalrpc</parameter> - Connect over local RPC (unix sockets)</para></listitem>
+                       </itemizedlist>
+
+                       <para>The supported options are:</para>
+
+                       <itemizedlist>
+                       <listitem><para><parameter moreinfo="none">sign</parameter> - Use RPC integrety autentication level</para></listitem>
+                       <listitem><para><parameter moreinfo="none">seal</parameter> - Enable RPC privacy (encryption) autentication level</para></listitem>
+                       <listitem><para><parameter moreinfo="none">connect</parameter> - Use RPC connect level authentication (auth, but no sign or seal)</para></listitem>
+                       <listitem><para><parameter moreinfo="none">packet</parameter> - Use RPC packet authentication level</para></listitem>
+
+                       <listitem><para><parameter moreinfo="none">spnego</parameter> - Use SPNEGO instead of NTLMSSP authentication</para></listitem>
+                       <listitem><para><parameter moreinfo="none">ntlm</parameter> - Use plain NTLM instead of SPNEGO or NTLMSSP</para></listitem>
+                       <listitem><para><parameter moreinfo="none">krb5</parameter> - Use Kerberos instead of NTLMSSP authentication</para></listitem>
+                       <listitem><para><parameter moreinfo="none">schannel</parameter> - Create a schannel connection</para></listitem>
+
+                       <listitem><para><parameter moreinfo="none">smb1</parameter> - Use SMB1 for named pipes</para></listitem>
+                       <listitem><para><parameter moreinfo="none">smb2</parameter> - Use SMB2/3 for named pipes</para></listitem>
+
+                       <listitem><para><parameter moreinfo="none">validate</parameter> - Enable the NDR validator</para></listitem>
+                       <listitem><para><parameter moreinfo="none">print</parameter> - Enable debug output of packets</para></listitem>
+                       <listitem><para><parameter moreinfo="none">padcheck</parameter> - Check reply data for non-zero pad bytes</para></listitem>
+                       <listitem><para><parameter moreinfo="none">bigendian</parameter> - Use big endian for RPC</para></listitem>
+                       <listitem><para><parameter moreinfo="none">ndr64</parameter> - Use NDR64 for RPC</para></listitem>
+                       </itemizedlist>
+
+               </listitem>
+               </varlistentry>
 
 
                <varlistentry>
                &popt.common.samba;
                &popt.common.credentials;               
                &popt.common.connection;
-               &stdarg.help;
+               &popt.autohelp;
        </variablelist>
 </refsect1>
 
 
        <variablelist>
                <varlistentry><term>srvinfo</term><listitem><para>Server query info</para></listitem></varlistentry>
-               
                <varlistentry><term>netshareenum</term><listitem><para>Enumerate shares</para></listitem></varlistentry>
-
+               <varlistentry><term>netshareenumall</term><listitem><para>Enumerate all shares</para></listitem></varlistentry>
+               <varlistentry><term>netsharegetinfo</term><listitem><para>Get Share Info</para></listitem></varlistentry>
+               <varlistentry><term>netsharesetinfo</term><listitem><para>Set Share Info</para></listitem></varlistentry>
+               <varlistentry><term>netsharesetdfsflags</term><listitem><para>Set DFS flags</para></listitem></varlistentry>
                <varlistentry><term>netfileenum</term><listitem><para>Enumerate open files</para></listitem></varlistentry>
-               
                <varlistentry><term>netremotetod</term><listitem><para>Fetch remote time of day</para></listitem></varlistentry>
-               
+               <varlistentry><term>netnamevalidate</term><listitem><para>Validate sharename</para></listitem></varlistentry>
+               <varlistentry><term>netfilegetsec</term><listitem><para>Get File security</para></listitem></varlistentry>
+               <varlistentry><term>netsessdel</term><listitem><para>Delete Session</para></listitem></varlistentry>
+               <varlistentry><term>netsessenum</term><listitem><para>Enumerate Sessions</para></listitem></varlistentry>
+               <varlistentry><term>netdiskenum</term><listitem><para>Enumerate Disks</para></listitem></varlistentry>
+               <varlistentry><term>netconnenum</term><listitem><para>Enumerate Connections</para></listitem></varlistentry>
+               <varlistentry><term>netshareadd</term><listitem><para>Add share</para></listitem></varlistentry>
+               <varlistentry><term>netsharedel</term><listitem><para>Delete share</para></listitem></varlistentry>
        </variablelist>
 
        </refsect2>
@@ -527,7 +594,7 @@ Comma Separated list of Files
 <refsect1>
        <title>VERSION</title>
 
-       <para>This man page is correct for version 3 of the Samba 
+       <para>This man page is part of version &doc.version; of the Samba
        suite.</para>
 </refsect1>