From 5d068123f134e7c7f6ad2433720ba94e18d4f8b5 Mon Sep 17 00:00:00 2001
From: Gary Lockyer <gary@catalyst.net.nz>
Date: Thu, 12 Apr 2018 10:19:16 +1200
Subject: [PATCH] smb conf: Add DSDB event notification parameter

Signed-off-by: Gary Lockyer <gary@catalyst.net.nz>
Reviewed-by: Andrew Bartlett <abartlet@samba.org>
---
 .../smbdotconf/misc/dsdbeventnotification.xml | 27 +++++++++++++++++++
 .../misc/dsdbpasswordeventnotification.xml    | 27 +++++++++++++++++++
 2 files changed, 54 insertions(+)
 create mode 100644 docs-xml/smbdotconf/misc/dsdbeventnotification.xml
 create mode 100644 docs-xml/smbdotconf/misc/dsdbpasswordeventnotification.xml

diff --git a/docs-xml/smbdotconf/misc/dsdbeventnotification.xml b/docs-xml/smbdotconf/misc/dsdbeventnotification.xml
new file mode 100644
index 00000000000..6afc799e13d
--- /dev/null
+++ b/docs-xml/smbdotconf/misc/dsdbeventnotification.xml
@@ -0,0 +1,27 @@
+<samba:parameter name="dsdb event notification"
+                 context="G"
+                 type="boolean"
+                 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+	<para>When enabled, this option causes Samba (acting as an
+	Active Directory Domain Controller) to stream Samba database
+	events across the internal message bus.  Scripts built using
+	Samba's python bindings can listen to these events by
+	registering as the service
+	<filename moreinfo="none">dsdb_event</filename>.</para>
+
+	<para>This should be considered a developer option (it assists
+	in the Samba testsuite) rather than a facility for external
+	auditing, as message delivery is not guaranteed (a feature
+	that the testsuite works around).  Additionally Samba must be
+	not compiled with the --without-json-audit parameter for this
+	option to be effective.</para>
+
+	<para>The Samba database events are also logged via the normal
+	logging methods when the <smbconfoption name="log level"/> is
+	set appropriately.</para>
+
+</description>
+
+<value type="default">no</value>
+</samba:parameter>
diff --git a/docs-xml/smbdotconf/misc/dsdbpasswordeventnotification.xml b/docs-xml/smbdotconf/misc/dsdbpasswordeventnotification.xml
new file mode 100644
index 00000000000..62bf7ffc1fd
--- /dev/null
+++ b/docs-xml/smbdotconf/misc/dsdbpasswordeventnotification.xml
@@ -0,0 +1,27 @@
+<samba:parameter name="dsdb password event notification"
+                 context="G"
+                 type="boolean"
+                 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+	<para>When enabled, this option causes Samba (acting as an
+	Active Directory Domain Controller) to stream password change
+	and reset events across the internal message bus.
+	Scripts built using Samba's python bindings can listen to these
+	events by registering as the service
+	<filename moreinfo="none">password_event</filename>.</para>
+
+	<para>This should be considered a developer option (it assists
+	in the Samba testsuite) rather than a facility for external
+	auditing, as message delivery is not guaranteed (a feature
+	that the testsuite works around).  Additionally Samba must be
+	not compiled with the --without-json-audit parameter for this
+	option to be effective.</para>
+
+	<para>The password events are also logged via the normal
+	logging methods when the <smbconfoption name="log level"/> is
+	set appropriately.</para>
+
+</description>
+
+<value type="default">no</value>
+</samba:parameter>
-- 
2.47.2