summaryrefslogtreecommitdiffstats
path: root/src/share/api/network6-get.json
diff options
context:
space:
mode:
Diffstat (limited to 'src/share/api/network6-get.json')
-rw-r--r--src/share/api/network6-get.json57
1 files changed, 57 insertions, 0 deletions
diff --git a/src/share/api/network6-get.json b/src/share/api/network6-get.json
new file mode 100644
index 0000000..f919618
--- /dev/null
+++ b/src/share/api/network6-get.json
@@ -0,0 +1,57 @@
+{
+ "access": "read",
+ "avail": "1.3.0",
+ "brief": [
+ "This command retrieves detailed information about shared networks, including subnets that are currently part of a given network."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"network4-get\",",
+ " \"arguments\": {",
+ " \"name\": \"floor13\"",
+ " }",
+ "}"
+ ],
+ "description": "See <xref linkend=\"idp74\"/>",
+ "hook": "subnet_cmds",
+ "name": "network6-get",
+ "resp-comment": [
+ "Note that the actual response contains many additional fields that are omitted here for clarity."
+ ],
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"Info about IPv6 shared network 'floor13' returned\",",
+ " \"arguments\": {",
+ " \"shared-networks\": [",
+ " {",
+ " \"match-client-id\": true,",
+ " \"name\": \"floor13\",",
+ " \"option-data\": [ ],",
+ " \"rebind-timer\": 90,",
+ " \"relay\": {",
+ " \"ip-address\": \"::\"",
+ " },",
+ " \"renew-timer\": 60,",
+ " \"subnet6\": [",
+ " {",
+ " \"subnet\": \"2003:db8:1::/64\",",
+ " \"id\": 5,",
+ " <many other subnet specific details here>",
+ " },",
+ " {",
+ " \"subnet\": \"2003:db8:2::/71\",",
+ " \"id\": 6,",
+ " <many other subnet specific details here>",
+ " }",
+ " ],",
+ " \"valid-lifetime\": 120",
+ " }",
+ " ]",
+ " }",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp6"
+ ]
+}