{
    "access": "read",
    "avail": "1.5.0",
    "brief": [
        "This command retrieves all IPv4 leases by page."
    ],
    "cmd-comment": [
        "The from address and the page size limit are mandatory."
    ],
    "cmd-syntax": [
        "{",
        "    \"command\": \"lease4-get-page\",",
        "    \"arguments\": {",
        "        \"limit\": <integer>,",
        "        \"from\": <IPv4 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 with specified parameters."
    ],
    "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.\"",
        "  }"
    ],
    "description": "See <xref linkend=\"command-lease4-get-page\"/>",
    "hook": "lease_cmds",
    "name": "lease4-get-page",
    "support": [
        "kea-dhcp4"
    ]
}
