]> git.ipfire.org Git - thirdparty/pdns.git/commitdiff
Refer to the description in dq.appliedPolicy for PolicyEvent.appliedPolicy. 10417/head
authorOtto <otto.moerbeek@open-xchange.com>
Mon, 17 May 2021 14:45:31 +0000 (16:45 +0200)
committerOtto <otto.moerbeek@open-xchange.com>
Mon, 17 May 2021 14:54:33 +0000 (16:54 +0200)
Improving consistency.

pdns/recursordist/docs/lua-scripting/dq.rst
pdns/recursordist/docs/lua-scripting/policyevent.rst

index ad7cce41c85988d6fd494f288e976b35149048e6..9c2a3eddf80016ddba1842964a15cf9cadb30262 100644 (file)
@@ -81,13 +81,13 @@ The DNSQuestion object contains at least the following fields:
     .. attribute:: DNSQuestion.appliedPolicy.policyName
 
       A string with the name of the policy.
-      Set by :ref:`policyName <rpz-policyName>` in the :func:`rpzFile` and :func:`rpzMaster` configuration items.
+      Set by :ref:`policyName <rpz-policyName>` in the :func:`rpzFile` and :func:`rpzPrimary` configuration items.
       It is advised to overwrite this when modifying the :attr:`DNSQuestion.appliedPolicy.policyKind`
 
     .. attribute:: DNSQuestion.appliedPolicy.policyType
 
-        The type of match for the policy.
+      The type of match for the policy.
+
       -  ``pdns.policytypes.None``  the empty policy type
       -  ``pdns.policytypes.QName`` a match on qname
       -  ``pdns.policytypes.ClientIP`` a match on client IP
index 4a3de04c45112055598edf9cbc7906d20a4a17f8..1ec2888c155e23a6731e8e47cc30bb713a71f0ec 100644 (file)
@@ -36,36 +36,8 @@ PolicyEvent class
 
   .. attribute:: PolicyEvent.appliedPolicy
 
-    The decision that was made by the policy engine, see :ref:`modifyingpolicydecisions`.
-
-    .. attribute:: PolicyEvent.appliedPolicy.policyName
-
-      A string with the name of the policy.
-      Set by :ref:`policyName <rpz-policyName>` in the :func:`rpzFile` and :func:`rpzMaster` configuration items.
-      It is advised to overwrite this when modifying the :attr:`PolicyEvent.appliedPolicy.policyKind`
-
-    .. attribute:: PolicyEvent.appliedPolicy.policyAction
-
-        The action taken by the engine
-
-    .. attribute:: PolicyEvent.appliedPolicy.policyCustom
-
-        The CNAME content for the ``pdns.policyactions.Custom`` response, a string
-
-    .. attribute:: PolicyEvent.appliedPolicy.policyKind
-
-      The kind of policy response, there are several policy kinds:
-
-      -  ``pdns.policykinds.Custom`` will return a NoError, CNAME answer with the value specified in :attr:`PolicyEvent.appliedPolicy.policyCustom`
-      -  ``pdns.policykinds.Drop`` will simply cause the query to be dropped
-      -  ``pdns.policykinds.NoAction`` will continue normal processing of the query
-      -  ``pdns.policykinds.NODATA`` will return a NoError response with no value in the answer section
-      -  ``pdns.policykinds.NXDOMAIN`` will return a response with a NXDomain rcode
-      -  ``pdns.policykinds.Truncate`` will return a NoError, no answer, truncated response over UDP. Normal processing will continue over TCP
-
-    .. attribute:: PolicyEvent.appliedPolicy.policyTTL
-
-        The TTL in seconds for the ``pdns.policyactions.Custom`` response
+    The decision that was made by the policy engine, see
+    :ref:`modifyingpolicydecisions` and :attr:`DNSQuestion.appliedPolicy` for the attributes of :attr:`PolicyEvent.appliedPolicy`.
 
   .. attribute:: PolicyEvent.qname