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

diff --git a/doc/api/network6-add.json b/doc/api/network6-add.json
new file mode 100644 (file)
index 0000000..d3804f4
--- /dev/null
@@ -0,0 +1,47 @@
+{
+     "name": "network6-add",
+    "brief": "The network6-add command is used to add a new shared network.",
+    "description": "See <xref linkend=\"idp75\"/>",
+    "support": [ "kea-dhcp4", "kea-dhcp6" ],
+    "avail": "1.3.0",
+    "hook": "subnet_cmds",
+    "cmd-syntax": "{
+    \"command\": \"network4-add\",
+    \"arguments\": {
+        \"shared-networks\": [ {
+            \"name\": \"floor13\",
+            \"subnet4\": [
+            {
+                \"id\": 100,
+                \"pools\": [ { \"pool\": \"192.0.2.2-192.0.2.99\" } ],
+                \"subnet\": \"192.0.2.0/24\",
+                \"option-data\": [
+                    {
+                        \"name\": \"routers\",
+                        \"data\": \"192.0.2.1\"
+                    }
+                ]
+            },
+            {
+                \"id\": 101,
+                \"pools\": [ { \"pool\": \"192.0.3.2-192.0.3.99\" } ],
+                \"subnet\": \"192.0.3.0/24\",
+                \"option-data\": [
+                    {
+                        \"name\": \"routers\",
+                        \"data\": \"192.0.3.1\"
+                    }
+                ]
+            } ]
+        } ]
+    }
+}",
+    "cmd-comment": "The network6-add uses the same syntax for both the query and the response. However, there are some parameters that are IPv4-only (e.g. match-client-id) and some are IPv6-only (e.g. interface-id).",
+    "resp-syntax": "{
+    \"arguments\": {
+        \"shared-networks\": [ { \"name\": \"floor13\" } ]
+    },
+    \"result\": 0,
+    \"text\": \"A new IPv4 shared network \'floor13\' added\"
+}",
+}
\ No newline at end of file