]> git.ipfire.org Git - thirdparty/kea.git/commitdiff
[#2434] document socket status in status-get
authorAndrei Pavel <andrei@isc.org>
Thu, 21 Jul 2022 10:09:12 +0000 (13:09 +0300)
committerAndrei Pavel <andrei@isc.org>
Fri, 22 Jul 2022 11:36:31 +0000 (14:36 +0300)
doc/sphinx/arm/hooks-ha.rst
src/share/api/status-get.json

index ca5947836f2c3445cffd9c53c343cb8d7e319b9a..80f66f23189c6081691e7e545fe2c09d94f22c1c 100644 (file)
@@ -2081,7 +2081,7 @@ available.
 The following is an example response to the ``status-get`` command, including
 the HA status of two ``load-balancing`` servers:
 
-::
+.. code-block:: json
 
    {
        "result": 0,
@@ -2117,7 +2117,10 @@ the HA status of two ``load-balancing`` servers:
            "multi-threading-enabled": true,
            "thread-pool-size": 4,
            "packet-queue-size": 64,
-           "packet-queue-statistics": [ 0.2, 0.1, 0.1 ]
+           "packet-queue-statistics": [ 0.2, 0.1, 0.1 ],
+           "sockets": {
+               "status": "ready"
+           }
        }
    }
 
index e574841abea11284652e74ef2684841a9d170799..eea4acf3166c6646916628a336bcfe6ff5b85be5 100644 (file)
         "        \"multi-threading-enabled\": true,",
         "        \"thread-pool-size\": 4,",
         "        \"packet-queue-size\": 64,",
-        "        \"packet-queue-statistics\": [ 1.2, 2.3, 3.4 ]",
+        "        \"packet-queue-statistics\": [ 1.2, 2.3, 3.4 ],",
+        "        \"sockets\": {",
+        "            \"errors\": [",
+        "                <error received during the last attempt to open all sockets>",
+        "            ]",
+        "            \"status\": <ready, retrying, or failed>",
+        "        }",
         "    }",
         "}"
     ],