summaryrefslogtreecommitdiffstats
path: root/src/share/api/remote-option4-pool-set.json
blob: 6567141bdd605acf4f022dafca1a1b0b4d071048 (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
46
47
48
49
{
    "access": "write",
    "avail": "1.6.0",
    "brief": [
        "This command creates or replaces a DHCPv4 option in an address pool in the configuration database."
    ],
    "cmd-comment": [
        "This command includes two lists with exactly address pool specification and exactly one option specification. Specifying an empty list, a value of ``null``, or a server tag will result in an error."
    ],
    "cmd-syntax": [
        "{",
        "    \"command\": \"remote-option4-pool-set\",",
        "    \"arguments\": {",
        "        \"pools\": [",
        "            {",
        "                \"pool\": <pool range or prefix>",
        "            }",
        "        ],",
        "        \"options\": [",
        "            {",
        "                <address pool option specification>",
        "            }",
        "        ],",
        "        \"remote\": {",
        "            <specification of the database to connect to>",
        "        }",
        "    }",
        "}"
    ],
    "hook": "cb_cmds",
    "name": "remote-option4-pool-set",
    "resp-syntax": [
        "{",
        "    \"result\": 0,",
        "    \"text\": \"DHCPv4 option successfully set.\",",
        "    \"arguments\": {",
        "        \"options\": [",
        "            {",
        "                \"code\": <option code>,",
        "                \"space\": <option space>",
        "            }",
        "        ]",
        "    }",
        "}"
    ],
    "support": [
        "kea-dhcp4"
    ]
}