]> git.ipfire.org Git - thirdparty/kea.git/commitdiff
[#1041] Added more HA doc
authorFrancis Dupont <fdupont@isc.org>
Wed, 11 Dec 2019 19:35:36 +0000 (20:35 +0100)
committerMarcin Siodelski <marcin@isc.org>
Fri, 13 Dec 2019 16:01:00 +0000 (17:01 +0100)
doc/sphinx/arm/ctrl-channel.rst

index 8e121ced116838865958419fc95c6d215d917abc..3e19949f0785ef27bb7e5a69ce3c040ad664b773 100644 (file)
@@ -551,7 +551,21 @@ The ``status-get`` command returns server runtime information:
 
  - reload: number of seconds since the last configuration (re)load.
 
- - ha-servers: HA hook information when the hook was loaded.
+ - ha-servers: HA hook information when the hook was loaded:
+
+     * local: for the local server the state, the role (primary,
+       secondary, ...) and scopes (i.e. what the server is actually
+       processing).
+
+     * remote: for the remote server the perceived state and the role
+       (scopes should be available in a future release)
+
+.. note::
+
+   The HA local server does not know the real state of the HA remote
+   server (so the perceived state vs the state). The command (or the
+   ``ha-heartbeat``) should be sent to the remote server as explained
+   in HA :ref:`ha-server-states`.
 
 .. _command-server-tag-get: