]> git.ipfire.org Git - thirdparty/kea.git/commitdiff
Add new file
authorSuzanne Goldlust <sgoldlust@isc.org>
Wed, 3 Oct 2018 20:17:10 +0000 (16:17 -0400)
committerTomek Mrugalski <tomasz@isc.org>
Tue, 29 Oct 2019 17:57:13 +0000 (18:57 +0100)
doc/api/lease4-get.json [new file with mode: 0644]

diff --git a/doc/api/lease4-get.json b/doc/api/lease4-get.json
new file mode 100644 (file)
index 0000000..a5b0892
--- /dev/null
@@ -0,0 +1,31 @@
+{
+    "name": "lease4-get",
+    "brief": "lease4-get can be used to query the lease database and retrieve existing leases.",
+    "description": "See <xref linkend=\"lease4-get\"/>",
+    "support": [ "kea-dhcp4", "kea-dhcp6" ],
+    "avail": "1.3.0",
+    "hook": "lease_cmds",
+    "cmd-syntax": "{
+    \"command\": \"lease4-get\",
+    \"arguments\": {
+        \"ip-address\": \"192.0.2.1\"
+    }
+}",
+    "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.\"
+}",
+    "resp-comment": "lease4-get returns a result that indicates a result of the operation and lease details, if found. It has one of the following values: 0 (success), 1 (error) or 2 (empty)."
+}
\ No newline at end of file