summaryrefslogtreecommitdiffstats
path: root/src/share/api/remote-class4-get-all.json
blob: 639fc369cfb4320788ce6c4d6d8f03a5eb6ccba9 (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.9.10",
    "brief": [
        "This command fetches all DHCPv4 client classes for specified servers from the configuration database."
    ],
    "cmd-comment": [
        "The ``server-tags`` list is required for this command, and must not be empty."
    ],
    "cmd-syntax": [
        "{",
        "    \"command\": \"remote-class4-get-all\",",
        "    \"arguments\": {",
        "        \"remote\": {",
        "            <specification of the database to connect to>",
        "        },",
        "        \"server-tags\": [ <first server tag>, <second server tag>, ... ]",
        "    }",
        "}"
    ],
    "hook": "cb_cmds",
    "name": "remote-class4-get-all",
    "resp-comment": [
        "The returned response contains a list of maps. Each map contains a client class name and the metadata, which provides database-specific information associated with the client class."
    ],
    "resp-syntax": [
        "{",
        "    \"result\": 0,",
        "    \"text\": \"2 DHCPv4 client class(es) found.\",",
        "    \"arguments\": {",
        "        \"client-classes\": [",
        "            {",
        "                <first client class specification>,",
        "                \"metadata\": {",
        "                    \"server-tags\": [ <first server tag>, <second server tag>, ... ]",
        "                }",
        "            },",
        "            {",
        "                <second client class specification>,",
        "                \"metadata\": {",
        "                    \"server-tags\": [ <first server tag>, ... ]",
        "                }",
        "            }",
        "        ],",
        "        \"count\": 2",
        "    }",
        "}"
    ],
    "support": [
        "kea-dhcp4"
    ]
}