summaryrefslogtreecommitdiffstats
path: root/src/share/api/config-set.json
blob: 60b4d991e46a93a4983815dc04dd99c11d88e6d4 (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
{
    "access": "write",
    "avail": "1.2.0",
    "brief": [
        "This command instructs the server to replace its current configuration with the new configuration supplied in the command's arguments."
    ],
    "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-set\",",
        "    \"arguments\":  {",
        "        \"'<server>'\": {",
        "        }",
        "     }",
        "}"
    ],
    "description": "See <xref linkend=\"command-config-set\"/>",
    "name": "config-set",
    "resp-syntax": [
        "{",
        "    \"arguments\": {",
        "        \"hash\": \"8B5F5822E93178B65CE658304C37EA511BDE7D29F792AA5E88012FC741F2BE32\"",
        "    },",
        "    \"result\": 0,",
        "    \"text\": \"Configuration successful.\"",
        "}",
        "",
        "or",
        "",
        "{ \"result\": 1, \"text\": \"unsupported parameter: BOGUS (<string>:16:26)\" }"
    ],
    "resp-comment": [
        "Starting with Kea 2.4.0, the successful response from a DHCPv4, DHCPv6, or DHCP-DDNS daemons",
        "also contain a SHA-256 digest of the newly set configuration. The digest can be used to easily",
        "determine if a configuration has been modified or not, possibly with the use of config-hash-get."
    ],
    "support": [
        "kea-dhcp4",
        "kea-dhcp6",
        "kea-dhcp-ddns",
        "kea-ctrl-agent"
    ]
}