docs: Further discourage the use of the "event notification" options
authorAndrew Bartlett <abartlet@samba.org>
Thu, 15 Apr 2021 02:45:07 +0000 (14:45 +1200)
committerAndrew Bartlett <abartlet@samba.org>
Wed, 21 Apr 2021 09:15:35 +0000 (09:15 +0000)
BUG: https://bugzilla.samba.org/show_bug.cgi?id=14689

Signed-off-by: Andrew Bartlett <abartlet@samba.org>
Reviewed-by: Andreas Schneider <asn@samba.org>
docs-xml/smbdotconf/logon/autheventnotification.xml
docs-xml/smbdotconf/misc/dsdbeventnotification.xml
docs-xml/smbdotconf/misc/dsdbgroupchangenotification.xml
docs-xml/smbdotconf/misc/dsdbpasswordeventnotification.xml

index 1ae2dbfb61af4ed11b0a2a95d1f735db2e4182c3..87ccf02a8f4139e39060f136da09f8a8b1263325 100644 (file)
        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>This is <emphasis>not</emphasis> needed for the audit
+       logging described in <smbconfoption name="log level"/>.</para>
+
+       <para>Instead, this should instead 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).</para>
 
        <para>The authentication events are also logged via the normal
        logging methods when the <smbconfoption name="log level"/> is
-       set appropriately.</para>
+       set appropriately, say to
+       <command moreinfo="none">auth_json_audit:3</command>.</para>
+
 </description>
 
 <value type="default">no</value>
index 7df46e1d68ca1c3d27a4f7bf95fb69af6a5e9264..279ac3d29ef707d54ca11d152a9cf9f903e28624 100644 (file)
        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).</para>
+       <para>This is <emphasis>not</emphasis> needed for the audit
+       logging described in <smbconfoption name="log level"/>.</para>
+
+       <para>Instead, this should instead 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).</para>
 
        <para>The Samba database events are also logged via the normal
        logging methods when the <smbconfoption name="log level"/> is
-       set appropriately.</para>
+       set appropriately, say to
+       <command moreinfo="none">dsdb_json_audit:5</command>.</para>
 
 </description>
 
index 6354979538bdf43ec14f134fd930173ec54ec6f2..3972e72b60f343e8c8fc15d81d686ea057a1a43e 100644 (file)
        registering as the service
        <filename moreinfo="none">dsdb_group_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).</para>
+       <para>This is <emphasis>not</emphasis> needed for the audit
+       logging described in <smbconfoption name="log level"/>.</para>
 
-       <para>The group events are also logged via the normal
+       <para>Instead, this should instead 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).</para>
+
+       <para>The Samba database events are also logged via the normal
        logging methods when the <smbconfoption name="log level"/> is
-       set appropriately.</para>
+       set appropriately, say to
+       <command moreinfo="none">dsdb_group_json_audit:5</command>.</para>
 
 </description>
 
index 984321b98fc4505541a658895a95c73892f37470..cd2cc98ff42e95ab4468ccf10909e1035d7d0b75 100644 (file)
        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).</para>
+       <para>This is <emphasis>not</emphasis> needed for the audit
+       logging described in <smbconfoption name="log level"/>.</para>
 
-       <para>The password events are also logged via the normal
+       <para>Instead, this should instead 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).</para>
+
+       <para>The Samba database events are also logged via the normal
        logging methods when the <smbconfoption name="log level"/> is
-       set appropriately.</para>
+       set appropriately, say to
+       <command moreinfo="none">dsdb_password_json_audit:5</command>.</para>
 
 </description>