From: Piotrek Zadroga <piotrek@isc.org>
Date: Tue, 13 Jun 2023 20:21:46 +0000 (+0200)
Subject: [#2795] adding reservations-get api
X-Git-Tag: Kea-2.4.0~103
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=5c4c866480b1ecf09f75ab2903d3e76cb4d8ee47;p=thirdparty%2Fkea.git

[#2795] adding reservations-get api
---

diff --git a/src/share/api/api_files.mk b/src/share/api/api_files.mk
index a9ff829f8c..4c734b0afa 100644
--- a/src/share/api/api_files.mk
+++ b/src/share/api/api_files.mk
@@ -162,6 +162,7 @@ api_files += $(top_srcdir)/src/share/api/reservation-get-by-hostname.json
 api_files += $(top_srcdir)/src/share/api/reservation-get-by-id.json
 api_files += $(top_srcdir)/src/share/api/reservation-get-page.json
 api_files += $(top_srcdir)/src/share/api/reservation-get.json
+api_files += $(top_srcdir)/src/share/api/reservations-get.json
 api_files += $(top_srcdir)/src/share/api/reservation-update.json
 api_files += $(top_srcdir)/src/share/api/server-tag-get.json
 api_files += $(top_srcdir)/src/share/api/shutdown.json
diff --git a/src/share/api/reservations-get.json b/src/share/api/reservations-get.json
new file mode 100644
index 0000000000..57823bc642
--- /dev/null
+++ b/src/share/api/reservations-get.json
@@ -0,0 +1,29 @@
+{
+  "access": "read",
+  "avail": "2.3.9",
+  "brief": [
+    "This command retrieves all host reservations for a specified subnet and ip-address."
+  ],
+  "cmd-comment": [
+    "The host reservations can be identified by a pair of subnet-id, ip-address. Operation-target is optional; default is 'all'."
+  ],
+  "cmd-syntax": [
+    "{",
+    "    \"command\": \"reservation-get-all\",",
+    "    \"arguments\": {",
+    "        \"subnet-id\": <integer>,",
+    "        \"ip-address\": <string>,",
+    "        \"operation-target\": <string (primary, alternate, all, default)>",
+    "    }",
+    "}"
+  ],
+  "hook": "host_cmds",
+  "name": "reservations-get",
+  "resp-comment": [
+    "The reservations-get may return many reservations for the same ip-address. This is useful in case ip-reservations-unique configuration flag is set to false."
+  ],
+  "support": [
+    "kea-dhcp4",
+    "kea-dhcp6"
+  ]
+}