diff options
| author | Andrei Pavel <andrei@isc.org> | 2024-01-18 13:44:30 +0100 |
|---|---|---|
| committer | Andrei Pavel <andrei@isc.org> | 2024-01-25 09:14:03 +0100 |
| commit | fe4fdcc8d9623d449cf168284adb3132db5d2245 (patch) | |
| tree | f349593664e0626cda7f11eb5bc694e1789799e4 | |
| parent | [#3119] use range based for loop or BOOST_FOREACH (diff) | |
| download | kea-fe4fdcc8d9623d449cf168284adb3132db5d2245.tar.xz kea-fe4fdcc8d9623d449cf168284adb3132db5d2245.zip | |
[#3123] add documentation for the peer-updates flag in radius
| -rw-r--r-- | doc/sphinx/arm/ext-radius.rst | 12 | ||||
| -rw-r--r-- | doc/sphinx/arm/hooks-ha.rst | 2 |
2 files changed, 12 insertions, 2 deletions
diff --git a/doc/sphinx/arm/ext-radius.rst b/doc/sphinx/arm/ext-radius.rst index b595a5f4c6..028bfb2e8e 100644 --- a/doc/sphinx/arm/ext-radius.rst +++ b/doc/sphinx/arm/ext-radius.rst @@ -181,7 +181,7 @@ Two services are supported: - ``accounting`` - the accounting service. -Configuration of services is divided into two parts: +At the service level, three sections can be configured: - Servers that define RADIUS services that the library is expected to contact. Each server may have the following items specified: @@ -218,6 +218,16 @@ Configuration of services is divided into two parts: It specifies an evaluation expression on the DHCP query packet. Currently this is restricted to the access service. + Attributes are supported only for the access service. + +- The ``peer-updates`` boolean flag controls whether lease updates coming from + an active High-Availability (HA) partner should result in an accounting + request. This may be desirable to remove duplicates if HA partners are + configured to send request to the same RADIUS server. The flag is enabled by + default and only supported by the accounting service. The lease + synchronization process at the startup of an HA node does not trigger a RADIUS + accounting request, regardless of the value of this flag. + For example, to specify a single access server available on localhost that uses ``"xyz123"`` as a secret, and tell Kea to send three additional attributes (``User-Password``, ``Connect-Info``, and ``Configuration-Token``), diff --git a/doc/sphinx/arm/hooks-ha.rst b/doc/sphinx/arm/hooks-ha.rst index 983a39f370..9acfffe137 100644 --- a/doc/sphinx/arm/hooks-ha.rst +++ b/doc/sphinx/arm/hooks-ha.rst @@ -2422,7 +2422,7 @@ The optional ``server-name`` parameter specifies a name of one of the partners b to the HA relationship this command pertains to. This parameter can be omitted if the server receiving this command has only one HA relationship in the configuration. -The `origin` is used to select the HA service for which the receiving server should +The ``origin`` parameter is used to select the HA service for which the receiving server should enable the DHCP service when it receives this notification. This is the same origin the sending server used previously to disable the DHCP service before synchronization. |