summaryrefslogtreecommitdiffstats
path: root/src/share/api/lease6-get-all.json
blob: 81a9f76d5490a7872d0e99181a81bc2d71d42657 (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
69
70
71
{
    "access": "read",
    "avail": "1.3.0",
    "brief": [
        "This command retrieves all IPv6 leases or all leases for the specified set of subnets."
    ],
    "cmd-comment": [
        "The ``lease6-get-all`` command may result in very large responses. Please consider using ",
        "``lease6-get-page`` to get them in chunks. the ``subnets`` parameter is optional. If not ",
        "specified, leases from all subnets are returned."
    ],

    "cmd-syntax": [
        "{",
        "    \"command\": \"lease6-get-all\",",
        "    \"arguments\": {",
        "        \"subnets\": [ 1, 2, 3, 4 ]",
        "    }",
        "}"
    ],
    "description": "See <xref linkend=\"idp59\"/>",
    "hook": "lease_cmds",
    "name": "lease6-get-all",
    "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 with specified parameter."
    ],
    "resp-syntax": [
        "{",
        "    \"arguments\": {",
        "        \"leases\": [",
        "            {",
        "                \"cltt\": 12345678,",
        "                \"duid\": \"42:42:42:42:42:42:42:42\",",
        "                \"fqdn-fwd\": false,",
        "                \"fqdn-rev\": true,",
        "                \"hostname\": \"myhost.example.com.\",",
        "                \"hw-address\": \"08:08:08:08:08:08\",",
        "                \"iaid\": 1,",
        "                \"ip-address\": \"2001:db8:2::1\",",
        "                \"preferred-lft\": 500,",
        "                \"state\": 0,",
        "                \"subnet-id\": 44,",
        "                \"type\": \"IA_NA\",",
        "                \"valid-lft\": 3600",
        "            },",
        "            {",
        "                \"cltt\": 12345678,",
        "                \"duid\": \"21:21:21:21:21:21:21:21\",",
        "                \"fqdn-fwd\": false,",
        "                \"fqdn-rev\": true,",
        "                \"hostname\": \"\",",
        "                \"iaid\": 1,",
        "                \"ip-address\": \"2001:db8:0:0:2::\",",
        "                \"preferred-lft\": 500,",
        "                \"prefix-len\": 80,",
        "                \"state\": 0,",
        "                \"subnet-id\": 44,",
        "                \"type\": \"IA_PD\",",
        "                \"valid-lft\": 3600",
        "            }",
        "        ]",
        "    },",
        "    \"result\": 0,",
        "    \"text\": \"2 IPv6 lease(s) found.\"",
        "}"
    ],
    "support": [
        "kea-dhcp6"
    ]
}