summaryrefslogtreecommitdiff
path: root/docs-xml/smbdotconf/logon/autheventnotification.xml
diff options
context:
space:
mode:
Diffstat (limited to 'docs-xml/smbdotconf/logon/autheventnotification.xml')
-rw-r--r--docs-xml/smbdotconf/logon/autheventnotification.xml26
1 files changed, 26 insertions, 0 deletions
diff --git a/docs-xml/smbdotconf/logon/autheventnotification.xml b/docs-xml/smbdotconf/logon/autheventnotification.xml
new file mode 100644
index 00000000000..1ae2dbfb61a
--- /dev/null
+++ b/docs-xml/smbdotconf/logon/autheventnotification.xml
@@ -0,0 +1,26 @@
+<samba:parameter name="auth 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 authentication
+ 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">auth_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
+ compiled with the jansson support for this option to be
+ effective.</para>
+
+ <para>The authentication 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>