diff options
Diffstat (limited to 'src/share/api/reservation-get-by-address.json')
-rw-r--r-- | src/share/api/reservation-get-by-address.json | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/src/share/api/reservation-get-by-address.json b/src/share/api/reservation-get-by-address.json new file mode 100644 index 0000000..c7ee556 --- /dev/null +++ b/src/share/api/reservation-get-by-address.json @@ -0,0 +1,29 @@ +{ + "access": "read", + "avail": "2.4.0", + "brief": [ + "This command retrieves all host reservations for given ip-address and optionally a specified subnet." + ], + "cmd-comment": [ + "The host reservations can be identified by a pair of 'ip-address' and 'subnet-id'. 'subnet-id' is optional. 'operation-target' is optional; default is 'all'." + ], + "cmd-syntax": [ + "{", + " \"command\": \"reservation-get-by-address\",", + " \"arguments\": {", + " \"ip-address\": <string>,", + " \"subnet-id\": <integer>,", + " \"operation-target\": <string (memory, database, all, default)>", + " }", + "}" + ], + "hook": "host_cmds", + "name": "reservation-get-by-address", + "resp-comment": [ + "The reservation-get-by-address may return many reservations for the same ip-address. This command may be useful in case ip-reservations-unique configuration flag is set to false." + ], + "support": [ + "kea-dhcp4", + "kea-dhcp6" + ] +} |