summaryrefslogtreecommitdiffstats
path: root/src/share/api/remote-global-parameter4-del.json
blob: 3c1564a08dbf69df5759fba8045776d34ce8c6b0 (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
{
    "access": "write",
    "avail": "1.6.0",
    "brief": [
        "This command deletes a global DHCPv4 parameter from the configuration database. The server uses the value specified in the configuration file, or a default value if the parameter is not specified, after deleting the parameter from the database."
    ],
    "cmd-comment": [
        "This command carries the list including exactly one name of the parameter to be deleted. The ``server-tags`` list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of ``null``, or multiple server tags will result in an error."
    ],
    "cmd-syntax": [
        "{",
        "    \"command\": \"remote-global-parameter4-del\",",
        "    \"arguments\": {",
        "        \"parameters\": [ <parameter name as string> ],",
        "        \"remote\": {",
        "            <specification of the database to connect to>",
        "        },",
        "        \"server-tags\": [ <single server tag as string> ]",
        "    }",
        "}"
    ],
    "hook": "cb_cmds",
    "name": "remote-global-parameter4-del",
    "resp-syntax": [
        "{",
        "    \"result\": 0,",
        "    \"text\": \"DHCPv4 global parameter(s) deleted.\",",
        "    \"arguments\": {",
        "        \"count\": 1",
        "    }",
        "}"
    ],
    "support": [
        "kea-dhcp4"
    ]
}