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

diff --git a/doc/api/network4-get.json b/doc/api/network4-get.json
new file mode 100644 (file)
index 0000000..caecb1a
--- /dev/null
@@ -0,0 +1,47 @@
+{
+    "name": "network4-get",
+    "brief": "The network4-get command is used to retrieve detailed information about shared networks, including subnets currently being part of a given network.",
+    "description": "See <xref linkend=\"idp74\"/>",
+    "support": [ "kea-dhcp4", "kea-dhcp6" ],
+    "avail": "1.3.0",
+    "hook": "subnet_cmds",
+    "cmd-syntax": "{
+    \"command\": \"network4-get\",
+    \"arguments\": {
+        \"name\": \"floor13\"
+    }
+}",
+    "resp-syntax": "{
+    \"result\": 0,
+    \"text\": \"Info about IPv4 shared network \'floor13\' returned\",
+    \"arguments\": {
+        \"shared-networks\": [
+        {
+            \"match-client-id\": true,
+            \"name\": \"floor13\",
+            \"option-data\": [ ],
+            \"rebind-timer\": 90,
+            \"relay\": {
+                \"ip-address\": \"0.0.0.0\"
+            },
+            \"renew-timer\": 60,
+            \"reservation-mode\": \"all\",
+            \"subnet4\": [
+                {
+                    \"subnet\": \"192.0.2.0/24\",
+                    \"id\": 5,
+                    // many other subnet specific details here
+                },
+                {
+                    \"id\": 6,
+                    \"subnet\": \"192.0.3.0/31\",
+                    // many other subnet specific details here
+                }
+            ],
+            \"valid-lifetime\": 120
+        }
+        ]
+    }
+}",
+    "resp-comment": "Note that the actual response contains many additional fields that are omitted here for clarity."
+}
\ No newline at end of file