diff options
Diffstat (limited to 'src/share/api/remote-server4-set.json')
| -rw-r--r-- | src/share/api/remote-server4-set.json | 45 |
1 files changed, 45 insertions, 0 deletions
diff --git a/src/share/api/remote-server4-set.json b/src/share/api/remote-server4-set.json new file mode 100644 index 0000000..b63e389 --- /dev/null +++ b/src/share/api/remote-server4-set.json @@ -0,0 +1,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" + ] +} |