smb conf: Add DSDB event notification parameter
[metze/samba/wip.git] / docs-xml / smbdotconf / misc / dsdbeventnotification.xml
1 <samba:parameter name="dsdb event notification"
2                  context="G"
3                  type="boolean"
4                  xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
5 <description>
6         <para>When enabled, this option causes Samba (acting as an
7         Active Directory Domain Controller) to stream Samba database
8         events across the internal message bus.  Scripts built using
9         Samba's python bindings can listen to these events by
10         registering as the service
11         <filename moreinfo="none">dsdb_event</filename>.</para>
12
13         <para>This should be considered a developer option (it assists
14         in the Samba testsuite) rather than a facility for external
15         auditing, as message delivery is not guaranteed (a feature
16         that the testsuite works around).  Additionally Samba must be
17         not compiled with the --without-json-audit parameter for this
18         option to be effective.</para>
19
20         <para>The Samba database events are also logged via the normal
21         logging methods when the <smbconfoption name="log level"/> is
22         set appropriately.</para>
23
24 </description>
25
26 <value type="default">no</value>
27 </samba:parameter>