summaryrefslogtreecommitdiffstats
path: root/src/share/api/remote-class6-set.json
blob: 1c2fed805919d2ed2f24e0f1f1e43a5249e52a4e (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
{
    "access": "write",
    "avail": "1.9.10",
    "brief": [
        "This command creates or replaces a DHCPv6 client class in the configuration database."
    ],
    "cmd-comment": [
        "The provided list must contain exactly one client class specification. It may contain an optional parameter \"follow-class-name\" which can specify an existing class name to indicate that the class from the command is placed right after this existing class in the hierarchy. This parameter can be omitted or set to \"null\" to indicate that the new client class should be appended at the end of the hierarchy or an updated class should remain at the current position. The ``server-tags`` list is mandatory and must contain one or more server tags as strings to explicitly associate the client class with one or more user-defined servers. It may include the special server tag \"all\" to associate the class with all servers."
    ],
    "cmd-syntax": [
        "{",
        "    \"command\": \"remote-class6-set\",",
        "    \"arguments\": {",
        "        \"client-class\": [",
        "            {",
        "                <client class specification>,",
        "                \"follow-class-name\": <existing class name>",
        "            }",
        "        ],",
        "        \"remote\": {",
        "            <specification of the database to connect to>",
        "        },",
        "        \"server-tags\": [ <first server tag>, <second server tag>, ... ]",
        "    }",
        "}"
    ],
    "hook": "cb_cmds",
    "name": "remote-class6-set",
    "resp-syntax": [
        "{",
        "    \"result\": 0,",
        "    \"text\": \"DHCPv6 shared network successfully set.\",",
        "    \"arguments\": {",
        "        \"client-classes\": [",
        "            {",
        "                \"name\": <set client class name>",
        "            }",
        "        ]",
        "    }",
        "}"
    ],
    "support": [
        "kea-dhcp6"
    ]
}