summaryrefslogtreecommitdiffstats
path: root/src/share/api/class-update.json
blob: c3b8284f9a820ece30501a44c677e9e5305956c1 (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
{
    "access": "write",
    "avail": "1.5.0",
    "brief": [
        "This command updates an existing client class in the server configuration."
    ],
    "cmd-comment": [
        "The ``next-server``, ``server-hostname``, and ``boot-file-name`` are DHCPv4-specific. Only one client class can be updated with a single command. "
    ],
    "cmd-syntax": [
        "{",
        "    \"command\": \"class-update\",",
        "    \"arguments\": {",
        "        \"client-classes\": [ {",
        "           \"name\": <name of the class>,",
        "           \"test\": <test expression to be evaluated on incoming packets>,",
        "           \"option-data\": [ <option values here> ],",
        "           \"option-def\": [ <option definitions here> ],",
        "           \"next-server\": <ipv4 address>,",
        "           \"server-hostname\": <string>,",
        "           \"boot-file-name\": <name of the boot file>",
        "        } ]",
        "    }",
        "}"
    ],
    "description": "See <xref linkend=\"command-class-update\"/>",
    "hook": "class_cmds",
    "name": "class-update",
    "resp-comment": [
        "The command returns the result of 3 (empty) if the client class does not exist. If the client class exists, the returned result is 0 if the update was successful, or 1 if the update is unsuccessful."
    ],
    "resp-syntax": [
        "{",
        "    \"result\": 0,",
        "    \"text\": \"Class '<class-name>' updated.\"",
        "}"
    ],
    "support": [
        "kea-dhcp4",
        "kea-dhcp6"
    ]
}