summaryrefslogtreecommitdiffstats
path: root/src/share/api/lease6-get-by-duid.json
diff options
context:
space:
mode:
Diffstat (limited to 'src/share/api/lease6-get-by-duid.json')
-rw-r--r--src/share/api/lease6-get-by-duid.json50
1 files changed, 50 insertions, 0 deletions
diff --git a/src/share/api/lease6-get-by-duid.json b/src/share/api/lease6-get-by-duid.json
new file mode 100644
index 0000000..0c839a5
--- /dev/null
+++ b/src/share/api/lease6-get-by-duid.json
@@ -0,0 +1,50 @@
+{
+ "access": "read",
+ "avail": "1.7.1",
+ "brief": [
+ "This command retrieves all IPv6 leases with the specified hardware address."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"lease6-get-by-duid\",",
+ " \"arguments\": {",
+ " \"duid\": \"1a:1b:1c:1d:1e:1f:20:21:22:23:24\"",
+ " }",
+ "}"
+ ],
+ "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.\"",
+ " }"
+ ],
+ "description": "See <xref linkend=\"command-lease6-get-by-duid\"/>",
+ "hook": "lease_cmds",
+ "name": "lease6-get-by-duid",
+ "support": [
+ "kea-dhcp6"
+ ]
+}