summaryrefslogtreecommitdiffstats
path: root/src/share/api/reservation-del.json
blob: 5f840c7fee708d9e38f6d94a3568cc8fd186da06 (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
{
    "access": "write",
    "avail": "1.2.0",
    "brief": [
        "This command deletes an existing host reservation."
    ],
    "cmd-comment": [
        "The host reservation can be identified by either the (subnet-id, ip-address) pair or a triplet of (subnet-id, identifier-type, identifier). Operation-target is optional; default is 'alternate'."
    ],
    "cmd-syntax": [
        "{",
        "    \"command\": \"reservation-del\",",
        "    \"arguments\": {",
        "        \"subnet-id\": <integer>,",
        "        \"ip-address\": <string>,",
        "        \"identifier-type\": <one of 'hw-address', 'duid', 'circuit-id', 'client-id' and 'flex-id'>,",
        "        \"identifier\": <string>,",
        "        \"operation-target\": <string (memory, database, all, default)>",
        "    }",
        "}"
    ],
    "hook": "host_cmds",
    "name": "reservation-del",
    "support": [
        "kea-dhcp4",
        "kea-dhcp6"
    ]
}