summaryrefslogtreecommitdiffstats
path: root/src/share/api/remote-server4-set.json
blob: b63e38930a3a97e69488b8626990754de3822680 (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 information about the DHCPv4 server in the database."
    ],
    "cmd-comment": [
        "The provided list must contain exactly one server specification. The ``server-tag`` must be unique across all servers within the configuration database. The ``description`` is the arbitrary text describing the server, its location within the network, etc."
    ],
    "cmd-syntax": [
        "{",
        "    \"command\": \"remote-server4-set\",",
        "    \"arguments\": {",
        "        \"servers\": [",
        "            {",
        "                \"server-tag\": <server tag>,",
        "                \"description\": <server description>",
        "            }",
        "        ],",
        "        \"remote\": {",
        "            <specification of the database to connect to>",
        "        }",
        "    }",
        "}"
    ],
    "hook": "cb_cmds",
    "name": "remote-server4-set",
    "resp-syntax": [
        "{",
        "    \"result\": 0,",
        "    \"text\": \"DHCPv4 server successfully set.\",",
        "    \"arguments\": {",
        "        \"servers\": [",
        "            {",
        "                \"server-tag\": <server tag>,",
        "                \"description\": <server description>",
        "            }",
        "        ]",
        "    }",
        "}"
    ],
    "support": [
        "kea-dhcp4"
    ]
}