summaryrefslogtreecommitdiffstats
path: root/src/share/api/class-list.json
blob: 17544c89b2036d70ea12c091c6fa5f0438343c76 (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
{
    "access": "read",
    "avail": "1.5.0",
    "brief": [
        "This command retrieves a list of all client classes from the server configuration."
    ],
    "cmd-comment": [
        "This command includes no arguments."
    ],
    "cmd-syntax": [
        "{",
        "    \"command\": \"class-list\"",
        "}"
    ],
    "description": "See <xref linkend=\"command-class-list\"/>",
    "hook": "class_cmds",
    "name": "class-list",
    "resp-comment": [
        "The returned list of classes merely contains their names.",
        "In order to retrieve full information about one of these",
        "classes, use :ref:`command-class-get`.",
        "The returned result is 3 (empty) if no classes are found.",
        "If the command is processed successfully and the list of",
        "client classes is not empty, the result of 0 is returned.",
        "If there is an error while processing the command, the",
        "result of 1 is returned."
    ],
    "resp-syntax": [
        "{",
        "    \"result\": 0,",
        "    \"text\": \"'<number of>' classes found\",",
        "    \"arguments\": {",
        "        \"client-classes\": [",
        "            {",
        "                \"name\": <first class name>",
        "            },",
        "            {",
        "                \"name\": <second class name>",
        "            }",
        "        ]",
        "    }",
        "}"
    ],
    "support": [
        "kea-dhcp4",
        "kea-dhcp6"
    ]
}