[#1258] Adjusted status-get description in ARM

Removed references to passive-backup mode, removed references to 1.7.x
versions of Kea etc.

diff --git a/doc/sphinx/arm/ctrl-channel.rst b/doc/sphinx/arm/ctrl-channel.rst
index 7b0a4e21b7319514ca4bbc3e171a27da67d2bb94..5af275f3af7afa7f53916181b29b980d4cffb14e 100644 (file)
--- a/doc/sphinx/arm/ctrl-channel.rst
+++ b/doc/sphinx/arm/ctrl-channel.rst
@@ -551,7 +551,7 @@ The ``status-get`` command returns server's runtime information:
 
  - reload: number of seconds since the last configuration (re)load.
 
- - ha-servers: HA specific status information about the DHCP servers
+ - high-availability: HA specific status information about the DHCP servers
    configured to use HA hooks library:
 
      * local: for the local server the state, the role (primary,
@@ -561,7 +561,7 @@ The ``status-get`` command returns server's runtime information:
      * remote: for the remote server the last known state, served
        HA scopes and the role of the server in HA relationship.
 
-The ``ha-servers`` information is only returned when the command is
+The ``high-availability`` information is only returned when the command is
 sent to the DHCP servers being in the HA setup. This parameter is
 never returned when the ``status-get`` command is sent to the
 Control Agent or DDNS deamon.

diff --git a/doc/sphinx/arm/hooks-ha.rst b/doc/sphinx/arm/hooks-ha.rst
index d3102f5bef3705855c74b3317a37b0f0f7f9ea02..6b9fd2e46e19ebfef1084731cc13869f228ca8e7 100644 (file)
--- a/doc/sphinx/arm/hooks-ha.rst
+++ b/doc/sphinx/arm/hooks-ha.rst
@@ -1277,15 +1277,6 @@ returned list will comprise more elements, each describing the status of
 a different relationship in which the server participates. Currently, it
 is only one status.
 
-.. note::
-
-   In Kea 1.7.8 an incompatible change was introduced to the syntax of the
-   ``status-get`` response. Previously, the HA status for a single relationship
-   was returned within the ``arguments`` map. As of Kea 1.7.8, the returned status
-   is enclosed in the list as described above. Any existing code relying on the
-   previous syntax must be updated to work with the new Kea versions.
-
-
 The ``ha-servers`` map contains two structures: ``local`` and ``remote``. The former
 contains the status information of the server which received the command. The
 latter contains the status information known to the local server about the
@@ -1319,11 +1310,10 @@ responding to this traffic. More about the failover procedure can be found
 in :ref:`ha-load-balancing-config`.
 
 The ``connecting-clients``, ``unacked-clients``, ``unacked-clients-left``
-and ``analyzed-packets`` parameters have been introduced together with the
-``communication-interrupted`` parameter in the Kea 1.7.8 release and they
-convey useful information about the state of the DHCP traffic monitoring
-in the communication interrupted state. If the server leaves the
-communication interrupted state these parameters are all reset to 0.
+and ``analyzed-packets`` together with the ``communication-interrupted``
+parameter convey useful information about the state of the DHCP traffic
+monitoring in the communication interrupted state. If the server leaves the
+communication interrupted state these parameters are reset to 0.
 
 These parameters have the following meaning in the communication interrupted
 state:
@@ -1353,13 +1343,6 @@ Monitoring these values helps to predict when the local server will
 enter the partner-down state or why the server hasn't yet entered this
 state.
 
-The last parameter introduced in the Kea 1.7.8 release was the ``ha-mode``.
-It returns the HA mode of operation selected using the ``mode`` parameter
-in the configuration file. It can hold one of the following values:
-``load-balancing``, ``hot-standby`` or ``passive-backup``.
-
-The ``status-get`` response has the format described above only in the
-``load-balancing`` and ``hot-standby`` modes. In the ``passive-backup``
-mode the ``remote`` map is not included in the response because in this
-mode there is only one active server (local). The response comprises no
-information about the status of the backup servers.
+Finally, the ``ha-mode`` parameter returns the HA mode of operation selected
+using the ``mode`` parameter in the configuration file. It can hold
+one of the following values: ``load-balancing``, ``hot-standby``.