summaryrefslogtreecommitdiffstats
path: root/src/share/api/subnet4-get.json
blob: 97d24cce8ae534354171c5e955ac42771485caed (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
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"
    ]
}