summaryrefslogtreecommitdiffstats
path: root/src/share/api/status-get.json
blob: eea4acf3166c6646916628a336bcfe6ff5b85be5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
{
    "access": "read",
    "avail": "1.7.3",
    "brief": [
        "This command returns server's runtime information.",
        "It takes no arguments."
    ],
    "cmd-syntax": [
        "{",
        "    \"command\": \"status-get\"",
        "}"
    ],
    "description": "See <xref linkend=\"command-status-get\"/>",
    "name": "status-get",
    "resp-comment": [
        "If the libdhcp_ha (High Availability) hooks library is loaded by the DHCP server receiving this command the response also includes the HA specific status information of the server receiving the command and its partner's status."
    ],
    "resp-syntax": [
        "{",
        "    \"result\": <integer>,",
        "    \"arguments\": {",
        "        \"pid\": <integer>,",
        "        \"uptime\": <uptime in seconds>,",
        "        \"reload\": <time since reload in seconds>,",
        "        \"high-availability\": [",
        "            {",
        "                \"ha-mode\": <HA mode configured for this relationship>",
        "                \"ha-servers\": {",
        "                    \"local\": {",
        "                        \"role\": <role of this server as in the configuration file>,",
        "                        \"scopes\": <list of scope names served by this server>,",
        "                        \"state\": <HA state name of the server receiving the command>,",
        "                    },",
        "                    \"remote\": {",
        "                        \"age\": <the age of the remote status in seconds>,",
        "                        \"in-touch\": <indicates if this server communicated with remote>,",
        "                        \"last-scopes\": <list of scopes served by partner>,",
        "                        \"last-state\": <HA state name of the partner>,",
        "                        \"role\": <partner role>",
        "                    }",
        "                }",
        "            }",
        "        ],",
        "        \"multi-threading-enabled\": true,",
        "        \"thread-pool-size\": 4,",
        "        \"packet-queue-size\": 64,",
        "        \"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>",
        "        }",
        "    }",
        "}"
    ],

    "support": [
        "kea-dhcp4",
        "kea-dhcp6",
        "kea-dhcp-ddns",
        "kea-ctrl-agent"
    ]
}