summaryrefslogtreecommitdiffstats
path: root/src/share/api/remote-option4-global-set.json
blob: 32c1611cb5e15825a1e27b280e09f89b7dde8587 (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.6.0",
    "brief": [
        "This command creates or replaces a DHCPv4 global option in the configuration database."
    ],
    "cmd-comment": [
        "The provided list must contain exactly one option specification. The ``server-tags`` list is mandatory and must contain exactly one server tag. Specifying an empty list, a value of ``null``, or multiple server tags will result in an error. The server tag \"all\" is allowed; it associates the specified option with all servers."
    ],
    "cmd-syntax": [
        "{",
        "    \"command\": \"remote-option4-global-set\",",
        "    \"arguments\": {",
        "        \"options\": [",
        "            {",
        "                <global option specification>",
        "            }",
        "        ],",
        "        \"remote\": {",
        "            <specification of the database to connect to>",
        "        },",
        "        \"server-tags\": [ <single server tag as string> ]",
        "    }",
        "}"
    ],
    "hook": "cb_cmds",
    "name": "remote-option4-global-set",
    "resp-syntax": [
        "{",
        "    \"result\": 0,",
        "    \"text\": \"DHCPv4 option set.\",",
        "    \"arguments\": {",
        "        \"options\": [",
        "            {",
        "                \"code\": <option code>,",
        "                \"space\": <option space>",
        "            }",
        "        ]",
        "    }",
        "}"
    ],
    "support": [
        "kea-dhcp4"
    ]
}