summaryrefslogtreecommitdiffstats
path: root/src/share/api/remote-subnet4-del-by-id.json
blob: 4ccf7f8662ab7e9aa90a132a4a79f64c6de0b4dd (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
{
    "access": "write",
    "avail": "1.6.0",
    "brief": [
        "This command deletes an IPv4 subnet by ID from the configuration database."
    ],
    "cmd-comment": [
        "This command includes a list with exactly one ID of the subnet to be deleted. The ``server-tags`` parameter must not be specified for this command."
    ],
    "cmd-syntax": [
        "{",
        "    \"command\": \"remote-subnet4-del-by-id\",",
        "    \"arguments\": {",
        "        \"subnets\": [",
        "            {",
        "                \"id\": <subnet identifier>",
        "            }",
        "        ],",
        "        \"remote\": {",
        "            <specification of the database to connect to>",
        "        }",
        "    }",
        "}"
    ],
    "hook": "cb_cmds",
    "name": "remote-subnet4-del-by-id",
    "resp-syntax": [
        "{",
        "    \"result\": 0,",
        "    \"text\": \"1 IPv4 subnet(s) deleted.\",",
        "    \"arguments\": {",
        "        \"count\": 1",
        "    }",
        "}"
    ],
    "support": [
        "kea-dhcp4"
    ]
}