summaryrefslogtreecommitdiffstats
path: root/src/share/api/remote-option-def4-del.json
diff options
context:
space:
mode:
Diffstat (limited to 'src/share/api/remote-option-def4-del.json')
-rw-r--r--src/share/api/remote-option-def4-del.json39
1 files changed, 39 insertions, 0 deletions
diff --git a/src/share/api/remote-option-def4-del.json b/src/share/api/remote-option-def4-del.json
new file mode 100644
index 0000000..9c8efca
--- /dev/null
+++ b/src/share/api/remote-option-def4-del.json
@@ -0,0 +1,39 @@
+{
+ "access": "write",
+ "avail": "1.6.0",
+ "brief": [
+ "This command deletes a DHCPv4 option definition from the configuration database."
+ ],
+ "cmd-comment": [
+ "This command includes a list with exactly one option definition specification, comprising an option name and code. The ``server-tags`` list is mandatory and 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-option-def4-del\",",
+ " \"arguments\": {",
+ " \"option-defs\": [ {",
+ " \"code\": <option code>,",
+ " \"space\": <option space>",
+ " } ],",
+ " \"remote\": {",
+ " <specification of the database to connect to>",
+ " },",
+ " \"server-tags\": [ <single server tag as string> ]",
+ " }",
+ "}"
+ ],
+ "hook": "cb_cmds",
+ "name": "remote-option-def4-del",
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"1 DHCPv4 option definition(s) deleted.\",",
+ " \"arguments\": {",
+ " \"count\": 1",
+ " }",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp4"
+ ]
+}