]> git.ipfire.org Git - thirdparty/kea.git/commitdiff
Add new file
authorSuzanne Goldlust <sgoldlust@isc.org>
Thu, 4 Oct 2018 21:32:06 +0000 (17:32 -0400)
committerTomek Mrugalski <tomasz@isc.org>
Tue, 29 Oct 2019 17:57:13 +0000 (18:57 +0100)
doc/api/subnet4-list.json [new file with mode: 0644]

diff --git a/doc/api/subnet4-list.json b/doc/api/subnet4-list.json
new file mode 100644 (file)
index 0000000..9166a3a
--- /dev/null
@@ -0,0 +1,27 @@
+{
+    "name": "subnet4-list",
+    "brief": "This command is used to list all currently configured subnets. The subnets are returned in a brief form, i.e. a subnet identifier and subnet prefix is included for each subnet.",
+    "description": "See <xref linkend=\"idp65\"/>",
+    "support": [ "kea-dhcp4", "kea-dhcp6" ],
+    "avail": "1.3.0",
+    "hook": "subnet_cmds",
+    "cmd-syntax": "{
+    \"command\": \"subnet4-list\"
+}",
+    "resp-syntax": "{
+    \"result\": 0,
+    \"text\": \"2 IPv4 subnets found\",
+    \"arguments\": {
+    \"subnets\": [
+        {
+            \"id\": 10,
+            \"subnet\": \"10.0.0.0/8\"
+        },
+        {
+            \"id\": 100,
+            \"subnet\": \"192.0.2.0/24\"
+        }
+    ]
+}",
+    "resp-comment": "If no IPv4 subnets are found, an error code is returned along with the error description."
+}
\ No newline at end of file