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

diff --git a/doc/api/lease4-del.json b/doc/api/lease4-del.json
new file mode 100644 (file)
index 0000000..b58ab7e
--- /dev/null
@@ -0,0 +1,15 @@
+{
+    "name": "lease4-del",
+    "brief": "lease4-del can be used to delete a lease from the lease database.",
+    "description": "See <xref linkend=\"lease4-del\"/>",
+    "support": [ "kea-dhcp4", "kea-dhcp6" ],
+    "avail": "1.3.0",
+    "hook": "lease_cmds",
+    "cmd-syntax": "{
+    \"command\": \"lease4-del\",
+    \"arguments\": {
+        \"ip-address\": \"192.0.2.202\"
+    }
+}",
+    "cmd-comment": "leaseX-del returns a result that indicates a outcome of the operation. It has one of the following values: 0 (success), 1 (error) or 3 (empty). The empty result means that a query has been completed properly, but the object (a lease in this case) has not been found.",
+}
\ No newline at end of file