summaryrefslogtreecommitdiffstats
path: root/src/share/api/lease4-get-by-hw-address.json
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-13 12:15:43 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-13 12:15:43 +0000
commitf5f56e1a1c4d9e9496fcb9d81131066a964ccd23 (patch)
tree49e44c6f87febed37efb953ab5485aa49f6481a7 /src/share/api/lease4-get-by-hw-address.json
parentInitial commit. (diff)
downloadisc-kea-upstream.tar.xz
isc-kea-upstream.zip
Adding upstream version 2.4.1.upstream/2.4.1upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to '')
-rw-r--r--src/share/api/lease4-get-by-hw-address.json48
1 files changed, 48 insertions, 0 deletions
diff --git a/src/share/api/lease4-get-by-hw-address.json b/src/share/api/lease4-get-by-hw-address.json
new file mode 100644
index 0000000..ce6408f
--- /dev/null
+++ b/src/share/api/lease4-get-by-hw-address.json
@@ -0,0 +1,48 @@
+{
+ "access": "read",
+ "avail": "1.7.1",
+ "brief": [
+ "This command retrieves all IPv4 leases with the specified hardware address."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"lease4-get-by-hw-address\",",
+ " \"arguments\": {",
+ " \"hw-address\": \"00:0c:01:02:03:04\"",
+ " }",
+ "}"
+ ],
+ "description": "See <xref linkend=\"command-lease4-get-by-hw-address\"/>",
+ "hook": "lease_cmds",
+ "name": "lease4-get-by-hw-address",
+ "resp-comment": [
+ "Result 0 is returned when at least one lease is found, 1 when parameters are malformed or missing,",
+ "3 is returned if no leases are found."
+ ],
+ "resp-syntax": [
+ " {",
+ " \"arguments\": {",
+ " \"leases\": [",
+ " {",
+ " \"client-id\": \"01:00:0c:01:02:03:04\",",
+ " \"cltt\": 1600432232,",
+ " \"fqdn-fwd\": false,",
+ " \"fqdn-rev\": false,",
+ " \"hostname\": \"myhost.example.com.\",",
+ " \"hw-address\": \"00:0c:01:02:03:04\",",
+ " \"ip-address\": \"192.168.1.150\",",
+ " \"state\": 0,",
+ " \"subnet-id\": 1,",
+ " \"valid-lft\": 4000",
+ " }",
+ " ]",
+ " },",
+ " \"result\": 0,",
+ " \"text\": \"1 IPv4 lease(s) found.\"",
+ " }"
+ ],
+
+ "support": [
+ "kea-dhcp4"
+ ]
+}