summaryrefslogtreecommitdiffstats
path: root/src/share/api/lease6-get-by-hostname.json
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-05-04 11:36:04 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-05-04 11:36:04 +0000
commit040eee1aa49b49df4698d83a05af57c220127fd1 (patch)
treef635435954e6ccde5eee9893889e24f30ca68346 /src/share/api/lease6-get-by-hostname.json
parentInitial commit. (diff)
downloadisc-kea-040eee1aa49b49df4698d83a05af57c220127fd1.tar.xz
isc-kea-040eee1aa49b49df4698d83a05af57c220127fd1.zip
Adding upstream version 2.2.0.upstream/2.2.0upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'src/share/api/lease6-get-by-hostname.json')
-rw-r--r--src/share/api/lease6-get-by-hostname.json52
1 files changed, 52 insertions, 0 deletions
diff --git a/src/share/api/lease6-get-by-hostname.json b/src/share/api/lease6-get-by-hostname.json
new file mode 100644
index 0000000..d92af19
--- /dev/null
+++ b/src/share/api/lease6-get-by-hostname.json
@@ -0,0 +1,52 @@
+{
+ "access": "read",
+ "avail": "1.7.1",
+ "brief": [
+ "This command retrieves all IPv6 leases with the specified hostname."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"lease6-get-by-hostname\",",
+ " \"arguments\": {",
+ " \"hostname\": \"myhost.example.com.\"",
+ " }",
+ "}"
+ ],
+ "description": "See <xref linkend=\"command-lease6-get-by-hostname\"/>",
+ "hook": "lease_cmds",
+ "name": "lease6-get-by-hostname",
+ "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 with specified parameter."
+ ],
+ "resp-syntax": [
+ "[",
+ " {",
+ " \"arguments\": {",
+ " \"leases\": [",
+ " {",
+ " \"cltt\": 1600439560,",
+ " \"duid\": \"00:01:00:01:26:f7:81:88:00:0c:01:02:03:04\",",
+ " \"fqdn-fwd\": false,",
+ " \"fqdn-rev\": false,",
+ " \"hostname\": \"foobar.example.org\",",
+ " \"hw-address\": \"00:0c:01:02:03:04\",",
+ " \"iaid\": 1,",
+ " \"ip-address\": \"2001:db8:1::\",",
+ " \"preferred-lft\": 3000,",
+ " \"state\": 0,",
+ " \"subnet-id\": 1,",
+ " \"type\": \"IA_NA\",",
+ " \"valid-lft\": 4000",
+ " }",
+ " ]",
+ " },",
+ " \"result\": 0,",
+ " \"text\": \"1 IPv6 lease(s) found.\"",
+ " }",
+ "]"
+ ],
+ "support": [
+ "kea-dhcp6"
+ ]
+}