summaryrefslogtreecommitdiffstats
path: root/src/share/api/reservation-get-by-id.json
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--src/share/api/reservation-get-by-id.json29
1 files changed, 29 insertions, 0 deletions
diff --git a/src/share/api/reservation-get-by-id.json b/src/share/api/reservation-get-by-id.json
new file mode 100644
index 0000000..75e650e
--- /dev/null
+++ b/src/share/api/reservation-get-by-id.json
@@ -0,0 +1,29 @@
+{
+ "access": "read",
+ "avail": "1.9.0",
+ "brief": [
+ "This command retrieves all host reservations for a specified identifier (type and value)."
+ ],
+ "cmd-comment": [
+ "Operation-target is optional; default is 'all'."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"reservation-get-by-id\",",
+ " \"arguments\": {",
+ " \"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-get-by-id",
+ "resp-comment": [
+ "The reservation-get-by-id command may result in large responses."
+ ],
+ "support": [
+ "kea-dhcp4",
+ "kea-dhcp6"
+ ]
+}