summaryrefslogtreecommitdiffstats
path: root/src/share/api/lease6-get-all.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/lease6-get-all.json
parentInitial commit. (diff)
downloadisc-kea-f5f56e1a1c4d9e9496fcb9d81131066a964ccd23.tar.xz
isc-kea-f5f56e1a1c4d9e9496fcb9d81131066a964ccd23.zip
Adding upstream version 2.4.1.upstream/2.4.1upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'src/share/api/lease6-get-all.json')
-rw-r--r--src/share/api/lease6-get-all.json71
1 files changed, 71 insertions, 0 deletions
diff --git a/src/share/api/lease6-get-all.json b/src/share/api/lease6-get-all.json
new file mode 100644
index 0000000..81a9f76
--- /dev/null
+++ b/src/share/api/lease6-get-all.json
@@ -0,0 +1,71 @@
+{
+ "access": "read",
+ "avail": "1.3.0",
+ "brief": [
+ "This command retrieves all IPv6 leases or all leases for the specified set of subnets."
+ ],
+ "cmd-comment": [
+ "The ``lease6-get-all`` command may result in very large responses. Please consider using ",
+ "``lease6-get-page`` to get them in chunks. the ``subnets`` parameter is optional. If not ",
+ "specified, leases from all subnets are returned."
+ ],
+
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"lease6-get-all\",",
+ " \"arguments\": {",
+ " \"subnets\": [ 1, 2, 3, 4 ]",
+ " }",
+ "}"
+ ],
+ "description": "See <xref linkend=\"idp59\"/>",
+ "hook": "lease_cmds",
+ "name": "lease6-get-all",
+ "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\": 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.\"",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp6"
+ ]
+}