summaryrefslogtreecommitdiff
path: root/docs-xml
diff options
context:
space:
mode:
authorGary Lockyer <gary@catalyst.net.nz>2018-04-12 10:19:16 +1200
committerAndrew Bartlett <abartlet@samba.org>2018-05-16 04:07:16 +0200
commit5d068123f134e7c7f6ad2433720ba94e18d4f8b5 (patch)
treed6f2b9acaa314033caca898f6fc3c2f07ecda415 /docs-xml
parent2ba55f81a9514a9e8adc6904e58d166c98aecaa7 (diff)
downloadsamba-5d068123f134e7c7f6ad2433720ba94e18d4f8b5.tar.gz
smb conf: Add DSDB event notification parameter
Signed-off-by: Gary Lockyer <gary@catalyst.net.nz> Reviewed-by: Andrew Bartlett <abartlet@samba.org>
Diffstat (limited to 'docs-xml')
-rw-r--r--docs-xml/smbdotconf/misc/dsdbeventnotification.xml27
-rw-r--r--docs-xml/smbdotconf/misc/dsdbpasswordeventnotification.xml27
2 files changed, 54 insertions, 0 deletions
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>