summaryrefslogtreecommitdiffstats
path: root/src/share/api/lease4-get-all.json
blob: 498af13684da62ba95982c8cb277bb98d4ab1d81 (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
{
    "access": "read",
    "avail": "1.4.0",
    "brief": [
        "This command retrieves all IPv4 leases or all leases for the specified set of subnets."
    ],
    "cmd-comment": [
        "The ``lease4-get-all`` command may result in very large responses. Please consider using ",
        "``lease4-get-page`` to get them in chunks. The ``subnets`` parameter is optional. If not ",
        "specified, leases from all subnets are returned."
    ],
    "cmd-syntax": [
        "{",
        "    \"command\": \"lease4-get-all\",",
        "    \"arguments\": {",
        "        \"subnets\": [ 1, 2, 3, ... ]",
        "    }",
        "}"
    ],
    "description": "See <xref linkend=\"idp59\"/>",
    "hook": "lease_cmds",
    "name": "lease4-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\": [",
        "        {",
        "          \"client-id\": \"01:00:0c:01:02:03:04\",",
        "          \"cltt\": 1600432232,",
        "          \"fqdn-fwd\": false,",
        "          \"fqdn-rev\": false,",
        "          \"hostname\": \"\",",
        "          \"hw-address\": \"00:0c:01:02:03:04\",",
        "          \"ip-address\": \"192.168.1.150\",",
        "          \"state\": 0,",
        "          \"subnet-id\": 1,",
        "          \"valid-lft\": 4000",
        "        },",
        "        {",
        "          \"client-id\": \"01:00:0c:01:02:03:05\",",
        "          \"cltt\": 1600432234,",
        "          \"fqdn-fwd\": false,",
        "          \"fqdn-rev\": false,",
        "          \"hostname\": \"\",",
        "          \"hw-address\": \"00:0c:01:02:03:05\",",
        "          \"ip-address\": \"192.168.1.151\",",
        "          \"state\": 0,",
        "          \"subnet-id\": 1,",
        "          \"valid-lft\": 4000",
        "        }",
        "      ]",
        "    },",
        "    \"result\": 0,",
        "    \"text\": \"2 IPv4 lease(s) found.\"",
        "  }",
        "]"
    ],
    "support": [
        "kea-dhcp4"
    ]
}