summaryrefslogtreecommitdiffstats
path: root/src/share/api/reservation-add.json
blob: 6e9259e8bf006f525312881b7b45940ff8b04079 (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
{
    "access": "write",
    "avail": "1.2.0",
    "brief": [
        "This command adds a new host reservation. The reservation may include IPv4 addresses, IPv6 addresses, IPv6 prefixes, various identifiers, a class the client will be assigned to, DHCPv4 and DHCPv6 options, and more."
    ],
    "cmd-comment": [
        "Note that boot-file-name, circuit-id, client-id, ip-address, next-server, and server-hostname are IPv4-specific. ip-addresses, and prefixes are IPv6-specific. Operation-target is optional; default is 'alternate'."
    ],
    "cmd-syntax": [
        "{",
        "    \"command\": \"reservation-add\",",
        "    \"arguments\": {",
        "        \"reservation\": {",
        "            \"boot-file-name\": <string>,",
        "            \"client-id\": <string>,",
        "            \"circuit-id\": <string>,",
        "            \"duid\": <string>,",
        "            \"flex-id\": <string>,",
        "            \"ip-address\": <string (IPv4 address)>,",
        "            \"ip-addresses\": [ <comma-separated strings> ],",
        "            \"hw-address\": <string>,",
        "            \"hostname\": <string>,",
        "            \"next-server\": <string (IPv4 address)>,",
        "            \"option-data\": [ <comma-separated structures defining options> ],",
        "            \"prefixes\": [ <comma-separated IPv6 prefixes> ],",
        "            \"client-classes\": [ <comma-separated strings> ],",
        "            \"server-hostname\": <string>,",
        "            \"subnet-id\": <integer>,",
        "            \"user-context\": <any valid JSON>",
        "        },",
        "        \"operation-target\": <string (memory, database, all, default)>",
        "    }",
        "}"
    ],
    "description": "See <xref linkend=\"cmd-reservation-add\"/>",
    "hook": "host_cmds",
    "name": "reservation-add",
    "resp-syntax": [
        "",
        "{",
        "    \"result\": <integer>,",
        "    \"text\": <string>",
        "}"
    ],
    "support": [
        "kea-dhcp4",
        "kea-dhcp6"
    ]
}