summaryrefslogtreecommitdiffstats
path: root/src/share/api/reservation-get-page.json
blob: 6be2b52ff1ea4ce19a54b836a257c3d5fe1dc847 (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
{
    "access": "read",
    "avail": "1.6.0",
    "brief": [
        "This command retrieves all host reservations or host reservations for a specified subnet by page."
    ],
    "cmd-comment": [
        "The page size limit is mandatory. The subnet-id is optional since version 1.9.0. The source-index and from host-id are optional and default to 0. Values to use to load the next page are returned in responses in a next map."
    ],
    "cmd-syntax": [
        "{",
        "    \"command\": \"reservation-get-page\",",
        "    \"arguments\": {",
        "        \"subnet-id\": <integer>,",
        "        \"limit\": <integer>,",
        "        \"source-index\": <integer>,",
        "        \"from\": <integer>",
        "    }",
        "}"
    ],
    "hook": "host_cmds",
    "name": "reservation-get-page",
    "support": [
        "kea-dhcp4",
        "kea-dhcp6"
    ]
}