summaryrefslogtreecommitdiffstats
path: root/src/share/api/config-test.json
blob: 39aa367a099aa8fc541dcbf03b01bbd125ac5913 (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
{
    "access": "write",
    "avail": "1.2.0",
    "brief": [
        "This command instructs the server to check whether the new configuration supplied in the command's arguments can be loaded."
    ],
    "cmd-comment": [
        "In the example below, '<server>' is the configuration element name for a given server such as \"Dhcp4\" or \"Dhcp6\"."
    ],
    "cmd-syntax": [
        "{",
        "    \"command\": \"config-test\",",
        "    \"arguments\":  {",
        "        \"'<server>'\": {",
        "        }",
        "     }",
        "}"
    ],
    "description": "See <xref linkend=\"command-config-test\"/>",
    "name": "config-test",
    "resp-syntax": [
        "{ \"result\": 0, \"text\": \"Configuration seems sane.\" }",
        "",
        "or",
        "",
        "{ \"result\": 1, \"text\": \"unsupported parameter: BOGUS (<string>:16:26)\" }"
    ],
    "support": [
        "kea-dhcp4",
        "kea-dhcp6",
        "kea-dhcp-ddns",
        "kea-ctrl-agent"
    ]
}