summaryrefslogtreecommitdiffstats
path: root/src/share/api/cache-insert.json
blob: d0cc594626ea3ffcf149f46acdab4640dca8f2e8 (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
{
    "access": "write",
    "avail": "1.4.0",
    "brief": [
        "This command inserts a host into the cache."
    ],
    "cmd-syntax": [
        "{",
        "    \"command\": \"cache-insert\",",
        "    \"arguments\": {",
        "        \"hw-address\": \"01:02:03:04:05:06\",",
        "        \"subnet-id4\": 4,",
        "        \"subnet-id6\": 0,",
        "        \"ip-address\": \"192.0.2.100\",",
        "        \"hostname\": \"somehost.example.org\",",
        "        \"client-classes4\": [ ],",
        "        \"client-classes6\": [ ],",
        "        \"option-data4\": [ ],",
        "        \"option-data6\": [ ],",
        "        \"next-server\": \"192.0.0.2\",",
        "        \"server-hostname\": \"server-hostname.example.org\",",
        "        \"boot-file-name\": \"bootfile.efi\",",
        "        \"host-id\": 0",
        "    }",
        "}",
        "",
        "Another example that adds IPv6 host reservation to cache is:",
        "{",
        "    \"command\": \"cache-insert\",",
        "    \"arguments\": {",
        "        \"hw-address\": \"01:02:03:04:05:06\",",
        "        \"subnet-id4\": 0,",
        "        \"subnet-id6\": 6,",
        "        \"ip-addresses\": [ \"2001:db8::cafe:babe\" ],",
        "        \"prefixes\": [ \"2001:db8:dead:beef::/64\" ],",
        "        \"hostname\": \"\",",
        "        \"client-classes4\": [ ],",
        "        \"client-classes6\": [ ],",
        "        \"option-data4\": [ ],",
        "        \"option-data6\": [ ],",
        "        \"next-server\": \"0.0.0.0\",",
        "        \"server-hostname\": \"\",",
        "        \"boot-file-name\": \"\",",
        "        \"host-id\": 0",
        "    }",
        "}"
    ],
    "description": "See <xref linkend=\"host-reservation-v4\"/>",
    "hook": "host_cache",
    "name": "cache-insert",
    "support": [
        "kea-dhcp4",
        "kea-dhcp6"
    ]
}