summaryrefslogtreecommitdiffstats
path: root/src/share/api/remote-network4-list.json
blob: db10c684d8cf3d2dc372301257c5fe445dc7e4e7 (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
{
    "access": "read",
    "avail": "1.6.0",
    "brief": [
        "This command fetches a list of all IPv4 shared networks from the configuration database."
    ],
    "cmd-comment": [
        "The ``server-tags`` list is required for this command, and must not be empty. It may either contain one or multiple server tags as strings, or a single ``null`` value."
    ],
    "cmd-syntax": [
        "{",
        "    \"command\": \"remote-network4-list\",",
        "    \"arguments\": {",
        "        \"remote\": {",
        "            <specification of the database to connect to>",
        "        },",
        "        \"server-tags\": [ <first server tag>, <second server tag>, ... ]",
        "    }",
        "}"
    ],
    "hook": "cb_cmds",
    "name": "remote-network4-list",
    "resp-comment": [
        "The returned response contains the list of maps. Each map contains the shared network name and the metadata, which provides database-specific information associated with the shared network. The returned list does not contain full definitions of the shared networks; use ``remote-network4-get`` to fetch the full information about the selected shared networks. If the command includes explicit server tags as strings (including the special server tag \"all\"), the list contains all shared networks which are associated with any of the specified tags. A network is returned even if it is associated with multiple servers and only one of the specified tags matches. If the command includes the ``null`` value in the ``server-tags`` list, the response contains all shared networks which are assigned to no servers (unassigned)."
    ],
    "resp-syntax": [
        "{",
        "    \"result\": 0,",
        "    \"text\": \"2 IPv4 shared network(s) found.\",",
        "    \"arguments\": {",
        "        \"shared-networks\": [",
        "            {",
        "                \"name\": <first shared network name>,",
        "                \"metadata\": {",
        "                    \"server-tags\": [ <first server tag>, <second server tag>, ... ]",
        "                }",
        "            },",
        "            {",
        "                \"name\": <second shared network name>,",
        "                \"metadata\": {",
        "                    \"server-tags\": [ <first server tag>, ... ]",
        "                }",
        "            }",
        "        ],",
        "        \"count\": 2",
        "    }",
        "}"
    ],
    "support": [
        "kea-dhcp4"
    ]
}