doc: Reflect the latest changes to the rpc_server option.
[Samba/gbeck.git] / docs-xml / smbdotconf / misc / rpcserver.xml
blob698466883593ac7c7508ddf4701334a8723ca465
1 <samba:parameter name="rpc_server"
2                  context="G"
3                  type="string"
4                  advanced="1" print="1"
5                  xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
6 <description>
7         <para>
8                 With this option you can define if a rpc service should be
9                 running internal/embedded in smbd or should be redirected to an
10                 external daemon like Samba4, the endpoint mapper daemon, the
11                 spoolss daemon or the new LSA service daemon. The rpc_server
12                 prefix must be followed by the pipe name, and a value.
13         </para>
15         <para>
16                 This option can be set for each available rpc service in Samba.
17                 The following list shows all available pipe names services you
18                 can modify with this options.
19         </para>
21         <itemizedlist>
22                 <listitem><para>epmapper     - Endpoint Mapper</para></listitem>
23                 <listitem><para>winreg       - Remote Registry Service</para></listitem>
24                 <listitem><para>srvsvc       - Remote Server Services</para></listitem>
25                 <listitem><para>lsarpc       - Local Security Authority</para></listitem>
26                 <listitem><para>samr         - Security Account Management</para></listitem>
27                 <listitem><para>netlogon     - Netlogon Remote Protocol</para></listitem>
28                 <listitem><para>netdfs       - Settings for Distributed File System</para></listitem>
29                 <listitem><para>dssetup      - Active Directory Setup</para></listitem>
30                 <listitem><para>wkssvc       - Workstation Services</para></listitem>
31                 <listitem><para>spoolss      - Network Printing Spooler</para></listitem>
32                 <listitem><para>svcctl       - Service Control</para></listitem>
33                 <listitem><para>ntsvcs       - Plug and Play Services</para></listitem>
34                 <listitem><para>eventlog     - Event Logger</para></listitem>
35                 <listitem><para>initshutdown - Init Shutdown Service</para></listitem>
36         </itemizedlist>
38         <para>
39                 Three possible values currently supported are:
40                 <command moreinfo="none">embedded</command>
41                 <command moreinfo="none">external</command>
42                 <command moreinfo="none">disabled</command>
43         </para>
45         <para>
46                 The classic method is to run every pipe as an internal function
47                 <emphasis>embedded</emphasis> in smbd. The defaults may vary
48                 depending on the service.
49         </para>
51         <para>
52                 Choosing the <emphasis>external</emphasis> option allows to run
53                 separate daemon or even a completely independent (3rd party)
54                 server capable of interfacing with samba via the MS-RPC
55                 interface over named pipes.
56         </para>
58         <para>
59                 Currently in Samba3 we support thre daemons, spoolssd, epmd and
60                 lsasd. These daemons can be enabled using the
61                 <emphasis>rpc_daemon</emphasis> option. For spoolssd you have
62                 to to enable the deamon and proxy the named pipe with:
63                 Currently in Samba3 we support thre daemons, spoolssd, epmd and
64                 lsasd. These daemons can be enabled using the
65                 <emphasis>rpc_daemon</emphasis> option.
66         </para>
68         <para>
69                 Examples:
70                 <programlisting>
71                         rpc_daemon:lsasd = fork
72                         rpc_server:lsarpc = external
73                         rpc_server:samr = external
74                         rpc_server:netlogon = external
76                         rpc_server:spoolss = external
77                         rpc_server:epmapper = disabled
78                 </programlisting>
79         </para>
81         <para>
82                 There is one special option which allows you to enable rpc
83                 services to listen for ncacn_ip_tcp connections too. Currently
84                 this is only used for testing and doesn't scale!
86                 <programlisting>
87                         rpc_server:tcpip = yes
88                 </programlisting>
89         </para>
91 </description>
93 <value type="default">embedded</value>
94 </samba:parameter>