docs-xml/manpages/samba-dcerpcd.8.xml

   1 <?xml version="1.0" encoding="iso-8859-1"?>
   2 <!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
   3 <refentry id="samba-dcerpcd.8">
   4
   5 <refmeta>
   6         <refentrytitle>samba-dcerpcd</refentrytitle>
   7         <manvolnum>8</manvolnum>
   8         <refmiscinfo class="source">Samba</refmiscinfo>
   9         <refmiscinfo class="manual">System Administration tools</refmiscinfo>
  10         <refmiscinfo class="version">&doc.version;</refmiscinfo>
  11 </refmeta>
  12
  13
  14 <refnamediv>
  15         <refname>samba-dcerpcd</refname>
  16         <refpurpose>This is one of Samba's DCERPC server processes
  17         that can listen on sockets where RPC services are offered and
  18         is the parent process of the DCERPC services it
  19         invokes. Unless separately invoked it is started on demand
  20         from <command>smbd</command> or <command>winbind</command> and
  21         serves DCERPC only over named pipes (np) as a helper
  22         process. This will be the standard setup for most
  23         installations (standalone/member server/AD server) unless they
  24         modify their startup scripts. Note in when Samba is configured
  25         as an Active Directory Domain controller the
  26         <command>samba</command> process that invokes
  27         <command>smbd</command> will still provide its normal DCERPC
  28         services, not <command>samba-dcerpcd</command>. When
  29         separately invoked by system startup scripts or a daemon,
  30         the global smb.conf option <smbconfoption name="rpc start on
  31         demand helpers">false</smbconfoption> MUST be set to allow
  32         <command>samba-dcerpcd</command> to start standalone.
  33         </refpurpose>
  34 </refnamediv>
  35
  36 <refsynopsisdiv>
  37         <cmdsynopsis>
  38                 <command>samba-dcerpcd</command>
  39                 <arg choice="opt">-D|--daemon</arg>
  40                 <arg choice="opt">-i|--interactive</arg>
  41                 <arg choice="opt">-F|--foreground</arg>
  42                 <arg choice="opt">--no-process-group</arg>
  43                 <arg choice="opt">-d &lt;debug level&gt;</arg>
  44                 <arg choice="opt">--debug-stdout</arg>
  45                 <arg choice="opt">--configfile=&lt;configuration file&gt;</arg>
  46                 <arg choice="opt">--option=&lt;name&gt;=&lt;value&gt;</arg>
  47                 <arg choice="opt">--leak-report</arg>
  48                 <arg choice="opt">--leak-report-full</arg>
  49                 <arg choice="opt">-V|--version</arg>
  50                 <arg choice="opt">--libexec-rpcds</arg>
  51                 <arg choice="opt">--np-helper</arg>
  52                 <arg choice="opt">--ready-signal-fd=&lt;fd&gt;</arg>
  53                 <arg choice="opt">&lt;SERVICE_1&gt;</arg>
  54                 <arg choice="opt">&lt;SERVICE_2&gt;</arg>
  55                 <arg choice="opt">&lt;...&gt;</arg>
  56         </cmdsynopsis>
  57 </refsynopsisdiv>
  58
  59 <refsect1>
  60         <title>DESCRIPTION</title>
  61
  62         <para>This tool is part of the
  63         <citerefentry><refentrytitle>samba</refentrytitle>
  64         <manvolnum>7</manvolnum></citerefentry> suite.</para>
  65
  66         <para>
  67           samba-dcerpcd can be used in two ways. In the normal case
  68           without startup script modification and the global smb.conf
  69           option <smbconfoption name="rpc start on demand
  70           helpers">true</smbconfoption> is set (the default setting),
  71           it is invoked on demand from <command>smbd</command> or
  72           <command>winbind</command> with a command line
  73           containing --np-helper to serve DCERPC over named pipes
  74           (np). It can also be used in a standalone mode where it is
  75           started separately from <command>smbd</command> or
  76           <command>winbind</command> via system startup scripts. If
  77           invoked as a standalone daemon or started from system
  78           startup scripts the global smb.conf option <smbconfoption
  79           name="rpc start on demand helpers">false</smbconfoption>
  80           MUST be set to false. If the global smb.conf option
  81           <smbconfoption name="rpc start on demand
  82           helpers">true</smbconfoption> is set to true or left as
  83           default, <command>samba-dcerpcd</command> will fail to start
  84           and log an error message.
  85         </para>
  86         <para>
  87           Note that when Samba is run in the Active Directory Domain
  88           Controller mode the <command>samba</command> AD code will
  89           still provide its normal DCERPC services whilst allowing
  90           samba-dcerpcd to provide services like SRVSVC in the same
  91           way that <command>smbd</command> used to in this
  92           configuration.
  93         </para>
  94         <para>
  95           The standalone mode can also be useful for use outside of
  96           the Samba framework, for example, use with the Linux kernel
  97           SMB2 server ksmbd or possibly other SMB2 server
  98           implementations. In this mode it behaves like inetd and
  99           listens on sockets on behalf of RPC server implementations.
 100         </para>
 101         <para>
 102           When a client connects, <command>samba-dcerpcd</command>
 103           will start the relevant RPC service binary on demand and
 104           hand over the connection to that service. When an RPC
 105           service has been idle for a while,
 106           <command>samba-dcerpcd</command> will ask it to shut down
 107           again.
 108         </para>
 109
 110 </refsect1>
 111
 112 <refsect1>
 113         <title>OPTIONS</title>
 114
 115         <variablelist>
 116                 <varlistentry>
 117                 <term>-D|--daemon</term>
 118                 <listitem><para>If specified, this parameter causes
 119                 the server to operate as a daemon. That is, it
 120                 detaches itself and runs in the background, fielding
 121                 requests on the appropriate port. Operating the server
 122                 as a daemon is useful for running
 123                 <command>samba-dcerpcd</command> outside of the Samba
 124                 framework. However, it can also be used in this way
 125                 within Samba for member servers if configured to start
 126                 up via system startup scripts.  This switch is assumed
 127                 if <command>samba-dcerpcd</command> is executed on the
 128                 command line of a shell.  </para></listitem>
 129                 </varlistentry>
 130
 131                 <varlistentry>
 132                 <term>-i|--interactive</term>
 133                 <listitem><para>If this parameter is specified it
 134                 causes the server to run "interactively", not as a
 135                 daemon, even if the server is executed on the command
 136                 line of a shell. Setting this parameter negates the
 137                 implicit daemon mode when run from the command
 138                 line. <command>samba-dcerpcd</command> will only
 139                 accept one connection and terminate. It will also log
 140                 to standard output, as if the <command>-S</command>
 141                 parameter had been given.
 142                 </para></listitem>
 143                 </varlistentry>
 144
 145                 <varlistentry>
 146                 <term>-F|--foreground</term>
 147                 <listitem><para>If specified, this parameter causes
 148                 the main <command>samba-dcerpcd</command> process to
 149                 not daemonize, i.e. double-fork and disassociate with
 150                 the terminal.  Child processes are still spawned as
 151                 normal to service each connection request, but the
 152                 main process does not exit. This operation mode is
 153                 suitable for running <command>samba-dcerpcd</command>
 154                 under process supervisors such as
 155                 <command>supervise</command> and
 156                 <command>svscan</command> from Daniel J. Bernstein's
 157                 <command>daemontools</command> package, or the AIX
 158                 process monitor.  </para></listitem>
 159                 </varlistentry>
 160
 161                 <varlistentry>
 162                 <term>--no-process-group</term>
 163                 <listitem><para>Do not create a new process group for
 164                 samba-dcerpcd.
 165                 </para></listitem>
 166                 </varlistentry>
 167
 168                 <varlistentry>
 169                 <term>--libexec-rpcds</term>
 170                 <listitem><para>Offer RPC services for all daemons in
 171                 Samba's LIBEXECDIR, all programs starting with
 172                 &quot;rpcd_&quot; are assumed to offer RPC
 173                 services. If you don't use the
 174                 <command>--libexec-rpcds</command> option, you can
 175                 explicitly list all RPC service helpers explicitly on
 176                 the command line.</para></listitem>
 177                 </varlistentry>
 178
 179                 <varlistentry>
 180                 <term>--np-helper</term>
 181                 <listitem><para>Run <command>samba-dcerpcd</command>
 182                 on demand opening named pipe sockets as helpers for
 183                 <command>smbd</command> or <command>winbind</command>.
 184                 In order to run in this mode, the global smb.conf
 185                 option <smbconfoption name="rpc start on demand
 186                 helpers">true</smbconfoption> must be set to true
 187                 (this is the default setting).  </para></listitem>
 188                 </varlistentry>
 189
 190                 <varlistentry>
 191                 <term>--ready-signal-fd=&lt;fd&gt;</term>
 192                 <listitem><para>Report service readiness via this fd
 193                 to <command>smbd</command> or <command>winbind</command>.
 194                 Only for internal use.
 195                 </para></listitem>
 196                 </varlistentry>
 197         </variablelist>
 198 </refsect1>
 199
 200 <refsect1>
 201         <title>AUTHOR</title>
 202
 203         <para>
 204           The original Samba software and related utilities were
 205           created by Andrew Tridgell. Samba is now developed by the
 206           Samba Team as an Open Source project similar to the way the
 207           Linux kernel is developed.
 208         </para>
 209 </refsect1>
 210
 211 </refentry>