summaryrefslogtreecommitdiffstats
path: root/src/share/api/lease4-del.json
diff options
context:
space:
mode:
Diffstat (limited to 'src/share/api/lease4-del.json')
-rw-r--r--src/share/api/lease4-del.json24
1 files changed, 24 insertions, 0 deletions
diff --git a/src/share/api/lease4-del.json b/src/share/api/lease4-del.json
new file mode 100644
index 0000000..49719b2
--- /dev/null
+++ b/src/share/api/lease4-del.json
@@ -0,0 +1,24 @@
+{
+ "access": "write",
+ "avail": "1.3.0",
+ "brief": [
+ "This command deletes a lease from the lease database."
+ ],
+ "cmd-comment": [
+ "The lease to be deleted can be specified either by IP address or by identifier-type and identifier value. The currently supported identifiers are \"hw-address\" and \"client-id\"."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"lease4-del\",",
+ " \"arguments\": {",
+ " \"ip-address\": \"192.0.2.202\"",
+ " }",
+ "}"
+ ],
+ "description": "See <xref linkend=\"command-lease4-del\"/>",
+ "hook": "lease_cmds",
+ "name": "lease4-del",
+ "support": [
+ "kea-dhcp4"
+ ]
+}