summaryrefslogtreecommitdiffstats
path: root/src/share/api/class-del.json
blob: 38c481865956c4a125b11b8f05608a9ca35c07b5 (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
{
    "access": "write",
    "avail": "1.5.0",
    "brief": [
        "This command removes a client class from the server configuration."
    ],
    "cmd-syntax": [
        "{",
        "    \"command\": \"class-del\",",
        "    \"arguments\": {",
        "        \"name\": <name of the class>",
        "    }",
        "}"
    ],
    "description": "See <xref linkend=\"command-class-del\"/>",
    "hook": "class_cmds",
    "name": "class-del",
    "resp-comment": [
        "The command returns a result of 3 (empty) if the client class does not exist. If the client class exists, the returned result is 0 if the deletion was successful; the result is 1 if the deletion is unsuccessful."
    ],
    "resp-syntax": [
        "{",
        "    \"result\": 0,",
        "    \"text\": \"Class '<class-name>' deleted.\"",
        "}"
    ],
    "support": [
        "kea-dhcp4",
        "kea-dhcp6"
    ]
}