summaryrefslogtreecommitdiffstats
path: root/src/share/api/remote-global-parameter4-del.json
diff options
context:
space:
mode:
Diffstat (limited to 'src/share/api/remote-global-parameter4-del.json')
-rw-r--r--src/share/api/remote-global-parameter4-del.json36
1 files changed, 36 insertions, 0 deletions
diff --git a/src/share/api/remote-global-parameter4-del.json b/src/share/api/remote-global-parameter4-del.json
new file mode 100644
index 0000000..3c1564a
--- /dev/null
+++ b/src/share/api/remote-global-parameter4-del.json
@@ -0,0 +1,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"
+ ]
+}