summaryrefslogtreecommitdiffstats
path: root/src/share/api/network6-get.json
blob: f648d8353aa6a8bb2855ed2891bc44a560b314fb (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
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
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,",
        "                    \"<other\": \"properties>\"",
        "                },",
        "                {",
        "                    \"subnet\": \"2003:db8:2::/71\",",
        "                    \"id\": 6,",
        "                    \"<other\": \"properties>\"",
        "                }",
        "            ],",
        "            \"valid-lifetime\": 120",
        "        }",
        "        ]",
        "    }",
        "}"
    ],
    "support": [
        "kea-dhcp6"
    ]
}