summaryrefslogtreecommitdiffstats
path: root/src/share/api/reservation-get.json
blob: 9b721e8166ccd41241efb59fb61365522f3c945f (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": "read",
    "avail": "1.2.0",
    "brief": [
        "This command retrieves 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 'all'."
    ],
    "cmd-syntax": [
        "{",
        "    \"command\": \"reservation-get\",",
        "    \"arguments\": {",
        "        \"subnet-id\": <integer>,",
        "        \"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",
    "resp-comment": [
        "The arguments object appears only if a host is found. Many fields in the arguments object appear only if a specific field is set."
    ],
    "resp-syntax": [
        "{",
        "    \"result\": <integer>,",
        "    \"text\": <string>,",
        "    \"arguments\": {",
        "        \"boot-file-name\": <string>,",
        "        \"comment\": <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>",
        "    }",
        "}"
    ],
    "support": [
        "kea-dhcp4",
        "kea-dhcp6"
    ]
}