{
    "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\": {",
        "        \"dhcp-state\": {",
        "            \"disabled-by-db-connection\": [],",
        "            \"disabled-by-local-command\": [],",
        "            \"disabled-by-remote-command\": [],",
        "            \"disabled-by-user\": false,",
        "            \"globally-disabled\": false",
        "        },",
        "        \"extended-info-tables\": <whether relay information is held in lease tables>,",
        "        \"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>,",
        "                        \"server-name\": <name of the local server>,",
        "                        \"state\": <HA state name of the server receiving the command>,",
        "                        \"system-time\": <system time in format '%Y-%m-%d %H:%M:%S' on UTC timezone>",
        "                    },",
        "                    \"remote\": {",
        "                        \"age\": <the age of the remote status in seconds>,",
        "                        \"analyzed-packets\": <number of packets sent to the partner server since communication was interrupted>,",
        "                        \"clock-skew\": <difference in seconds between local and partner server times>,",
        "                        \"communication-interrupted\": <whether communication did not happen for more than max-response-delay milliseconds>,",
        "                        \"connecting-clients\": <number of different clients getting a lease from partner>,",
        "                        \"in-touch\": <indicates if this server communicated with partner>,",
        "                        \"last-scopes\": <list of scopes served by partner>,",
        "                        \"last-state\": <HA state name of the partner>,",
        "                        \"role\": <partner role>,",
        "                        \"server-name\": <name of the partner server>,",
        "                        \"system-time\": <system time in format '%Y-%m-%d %H:%M:%S' on UTC timezone>,",
        "                        \"unacked-clients\": <number of unacked clients>,",
        "                        \"unacked-clients-left\": <how many more clients have to be unacked before partner-down state>",
        "                    }",
        "                }",
        "            }",
        "        ],",
        "        \"multi-threading-enabled\": true,",
        "        \"packet-queue-size\": 64,",
        "        \"packet-queue-statistics\": [ 1.2, 2.3, 3.4 ],",
        "        \"pid\": <integer>,",
        "        \"reload\": <time since reload in seconds>,",
        "        \"sockets\": {",
        "            \"errors\": <list of errors received during the last attempt to open all sockets; only appears when status is failed or retrying>,",
        "            \"status\": <ready, retrying, or failed>",
        "        },",
        "        \"thread-pool-size\": 4,",
        "        \"uptime\": <uptime in seconds>",
        "    }",
        "}"
    ],

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