summaryrefslogtreecommitdiffstats
path: root/src/share/api/reservation-del.json
diff options
context:
space:
mode:
Diffstat (limited to 'src/share/api/reservation-del.json')
-rw-r--r--src/share/api/reservation-del.json28
1 files changed, 28 insertions, 0 deletions
diff --git a/src/share/api/reservation-del.json b/src/share/api/reservation-del.json
new file mode 100644
index 0000000..5f840c7
--- /dev/null
+++ b/src/share/api/reservation-del.json
@@ -0,0 +1,28 @@
+{
+ "access": "write",
+ "avail": "1.2.0",
+ "brief": [
+ "This command deletes an existing host reservation."
+ ],
+ "cmd-comment": [
+ "The host reservation can be identified by either the (subnet-id, ip-address) pair or a triplet of (subnet-id, identifier-type, identifier). Operation-target is optional; default is 'alternate'."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"reservation-del\",",
+ " \"arguments\": {",
+ " \"subnet-id\": <integer>,",
+ " \"ip-address\": <string>,",
+ " \"identifier-type\": <one of 'hw-address', 'duid', 'circuit-id', 'client-id' and 'flex-id'>,",
+ " \"identifier\": <string>,",
+ " \"operation-target\": <string (memory, database, all, default)>",
+ " }",
+ "}"
+ ],
+ "hook": "host_cmds",
+ "name": "reservation-del",
+ "support": [
+ "kea-dhcp4",
+ "kea-dhcp6"
+ ]
+}