summaryrefslogtreecommitdiffstats
path: root/src/share/api/subnet4-get.json
diff options
context:
space:
mode:
Diffstat (limited to 'src/share/api/subnet4-get.json')
-rw-r--r--src/share/api/subnet4-get.json39
1 files changed, 39 insertions, 0 deletions
diff --git a/src/share/api/subnet4-get.json b/src/share/api/subnet4-get.json
new file mode 100644
index 0000000..97d24cc
--- /dev/null
+++ b/src/share/api/subnet4-get.json
@@ -0,0 +1,39 @@
+{
+ "access": "read",
+ "avail": "1.3.0",
+ "brief": [
+ "This command retrieves detailed information about the specified subnet. This command usually follows ``subnet4-list``, which discovers available subnets with their respective subnet identifiers and prefixes."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"subnet4-get\",",
+ " \"arguments\": {",
+ " \"id\": 10",
+ " }",
+ "}"
+ ],
+ "description": "See <xref linkend=\"idp67\"/>",
+ "hook": "subnet_cmds",
+ "name": "subnet4-get",
+ "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\": [{",
+ " ...",
+ " }],",
+ " ...",
+ " }",
+ " ]",
+ " }",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp4"
+ ]
+}