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

diff --git a/doc/api/subnet4-get.json b/doc/api/subnet4-get.json
new file mode 100644 (file)
index 0000000..79ba6f9
--- /dev/null
@@ -0,0 +1,30 @@
+{
+    "name": "subnet4-get",
+    "brief": "This command is used to retrieve detailed information about the specified subnet. This command usually follows the subnet4-list, which is used to discover available subnets with their respective subnet identifiers and prefixes.",
+    "description": "See <xref linkend=\"idp67\"/>",
+    "support": [ "kea-dhcp4", "kea-dhcp6" ],
+    "avail": "1.3.0",
+    "hook": "subnet_cmds",
+    "cmd-syntax": "{
+    \"command\": \"subnet4-get\",
+    \"arguments\": {
+        \"id\": 10
+    }
+}",
+    "resp-syntax": "{
+    \"result\": 0,
+    \"text\": \"Info about IPv4 subnet 10.0.0.0/8 (id 10) returned\",
+    \"arguments\": {
+        \"subnets\": [
+            {
+                \"subnet\": \"10.0.0.0/8\",
+                \"id\": 1,
+                \"option-data\": [
+                    ....
+                ]
+                ...
+            }
+        ]
+    }
+}",
+}
\ No newline at end of file