summaryrefslogtreecommitdiffstats
path: root/src/share/api/lease6-get-page.json
blob: dc9606bf121371bdc20030e124938875aaf3ab01 (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
56
57
58
59
60
61
62
63
64
65
66
67
68
{
    "access": "read",
    "avail": "1.5.0",
    "brief": [
        "This command retrieves all IPv6 leases by page."
    ],
    "cmd-comment": [
        "The from address and the page size limit are mandatory."
    ],
    "cmd-syntax": [
        "{",
        "    \"command\": \"lease6-get-page\",",
        "    \"arguments\": {",
        "        \"limit\": <integer>,",
        "        \"from\": <IPv6 address or 'start'>",
        "    }",
        "}"
    ],
    "resp-comment": [
        "Result 0 is returned when at least one lease is found, 1 when parameters are malformed or missing,",
        "3 is returned if no leases are found."
    ],
    "resp-syntax": [
        "  {",
        "    \"arguments\": {",
        "      \"leases\": [",
        "        {",
        "          \"cltt\": 1600439560,",
        "          \"duid\": \"00:01:00:01:26:f7:81:88:00:0c:01:02:03:04\",",
        "          \"fqdn-fwd\": false,",
        "          \"fqdn-rev\": false,",
        "          \"hostname\": \"foo.example.org\",",
        "          \"hw-address\": \"00:0c:01:02:03:04\",",
        "          \"iaid\": 1,",
        "          \"ip-address\": \"2001:db8:1::1\",",
        "          \"preferred-lft\": 3000,",
        "          \"state\": 0,",
        "          \"subnet-id\": 1,",
        "          \"type\": \"IA_NA\",",
        "          \"valid-lft\": 4000",
        "        },",
        "        {",
        "          \"cltt\": 1600439570,",
        "          \"duid\": \"00:01:00:01:26:f7:81:88:00:0c:01:02:03:05\",",
        "          \"fqdn-fwd\": false,",
        "          \"fqdn-rev\": false,",
        "          \"hostname\": \"bar.example.org\",",
        "          \"hw-address\": \"00:0c:01:02:03:05\",",
        "          \"iaid\": 1,",
        "          \"ip-address\": \"2001:db8:1::2\",",
        "          \"preferred-lft\": 3000,",
        "          \"state\": 0,",
        "          \"subnet-id\": 1,",
        "          \"type\": \"IA_NA\",",
        "          \"valid-lft\": 4000",
        "        }",
        "      ]",
        "    },",
        "    \"result\": 0,",
        "    \"text\": \"1 IPv6 lease(s) found.\"",
        "}"
    ],
    "hook": "lease_cmds",
    "name": "lease6-get-page",
    "support": [
        "kea-dhcp6"
    ]
}