]> git.ipfire.org Git - thirdparty/kea.git/commitdiff
Add new file
authorSuzanne Goldlust <sgoldlust@isc.org>
Wed, 3 Oct 2018 22:02:47 +0000 (18:02 -0400)
committerTomek Mrugalski <tomasz@isc.org>
Tue, 29 Oct 2019 17:57:13 +0000 (18:57 +0100)
doc/api/lease6-get-all.json [new file with mode: 0644]

diff --git a/doc/api/lease6-get-all.json b/doc/api/lease6-get-all.json
new file mode 100644 (file)
index 0000000..006a1cd
--- /dev/null
@@ -0,0 +1,53 @@
+{
+    "name": "lease6-get-all",
+    "brief": "lease6-get-all is used to retrieve all IPv6 leases or all leases for the specified set of subnets.",
+    "description": "See <xref linkend=\"lease6-get-all\"/>",
+    "support": [ "kea-dhcp4", "kea-dhcp6" ],
+    "avail": "1.3.0",
+    "hook": "lease_cmds",
+    "cmd-syntax": "{
+    \"command\": \"lease6-get-all\",
+    \"arguments\": {
+        \"subnets\": [ 1, 2, 3, 4 ]
+    }
+}",
+    "resp-syntax": "{
+    \"arguments\": {
+        \"leases\": [
+            {
+                \"cltt\": 12345678,
+                \"duid\": \"42:42:42:42:42:42:42:42\",
+                \"fqdn-fwd\": false,
+                \"fqdn-rev\": true,
+                \"hostname\": \"myhost.example.com.\",
+                \"hw-address\": \"08:08:08:08:08:08\",
+                \"iaid\": 1,
+                \"ip-address\": \"2001:db8:2::1\",
+                \"preferred-lft\": 500,
+                \"state\": 0,
+                \"subnet-id\": 44,
+                \"type\": \"IA_NA\",
+                \"valid-lft\": 3600
+            },
+            {
+                \"cltt\": 12345678,
+                \"duid\": \"21:21:21:21:21:21:21:21\",
+                \"fqdn-fwd\": false,
+                \"fqdn-rev\": true,
+                \"hostname\": \"\",
+                \"iaid\": 1,
+                \"ip-address\": \"2001:db8:0:0:2::\",
+                \"preferred-lft\": 500,
+                \"prefix-len\": 80,
+                \"state\": 0,
+                \"subnet-id\": 44,
+                \"type\": \"IA_PD\",
+                \"valid-lft\": 3600
+            }
+        ]
+    },
+    \"result\": 0,
+    \"text\": \"2 IPv6 lease(s) found.\"
+}",
+    "resp-comment": "The lease6-get-all command may result in very large responses."
+}
\ No newline at end of file