Adding upstream version 2.2.0.upstream/2.2.0upstream

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 66 insertions, 0 deletions

diff --git a/src/share/api/lease4-get-all.json b/src/share/api/lease4-get-all.json
new file mode 100644
index 0000000..498af13
--- /dev/null
+++ b/src/share/api/lease4-get-all.json
@@ -0,0 +1,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"
+    ]
+}