summaryrefslogtreecommitdiffstats
path: root/src/share/api/reservation-get-by-id.json
blob: 75e650e1a6608a0107aa177099f6ef7fbd888769 (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
{
    "access": "read",
    "avail": "1.9.0",
    "brief": [
        "This command retrieves all host reservations for a specified identifier (type and value)."
    ],
    "cmd-comment": [
        "Operation-target is optional; default is 'all'."
    ],
    "cmd-syntax": [
        "{",
        "    \"command\": \"reservation-get-by-id\",",
        "    \"arguments\": {",
        "        \"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-get-by-id",
    "resp-comment": [
        "The reservation-get-by-id command may result in large responses."
    ],
    "support": [
        "kea-dhcp4",
        "kea-dhcp6"
    ]
}