Adding upstream version 2.4.1.upstream/2.4.1upstream

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

1 files changed, 44 insertions, 0 deletions

diff --git a/src/share/api/lease4-get.json b/src/share/api/lease4-get.json
new file mode 100644
index 0000000..3b76a10
--- /dev/null
+++ b/src/share/api/lease4-get.json
@@ -0,0 +1,44 @@
+{
+    "access": "read",
+    "avail": "1.3.0",
+    "brief": [
+        "This command queries the lease database and retrieves existing leases."
+    ],
+    "cmd-syntax": [
+        "{",
+        "    \"command\": \"lease4-get\",",
+        "    \"arguments\": {",
+        "        \"ip-address\": \"192.0.2.1\"",
+        "    }",
+        "}"
+    ],
+    "description": "See <xref linkend=\"idp58\"/>",
+    "hook": "lease_cmds",
+    "name": "lease4-get",
+    "resp-comment": [
+        "lease4-get returns a result that indicates the outcome of the operation and lease details,",
+        "if found. It has one of the following values: 0 (success), 1 (error), or 3 (empty). ",
+        "Result 3 is returned if no leases are found with specified IP address."
+    ],
+    "resp-syntax": [
+        "{",
+        "  \"arguments\": {",
+        "    \"client-id\": \"42:42:42:42:42:42:42:42\",",
+        "    \"cltt\": 12345678,",
+        "    \"fqdn-fwd\": false,",
+        "    \"fqdn-rev\": true,",
+        "    \"hostname\": \"myhost.example.com.\",",
+        "    \"hw-address\": \"08:08:08:08:08:08\",",
+        "    \"ip-address\": \"192.0.2.1\",",
+        "    \"state\": 0,",
+        "    \"subnet-id\": 44,",
+        "    \"valid-lft\": 3600",
+        "  },",
+        "  \"result\": 0,",
+        "  \"text\": \"IPv4 lease found.\"",
+        "}"
+    ],
+    "support": [
+        "kea-dhcp4"
+    ]
+}