summaryrefslogtreecommitdiffstats
path: root/src/share/api/remote-server6-del.json
diff options
context:
space:
mode:
Diffstat (limited to 'src/share/api/remote-server6-del.json')
-rw-r--r--src/share/api/remote-server6-del.json39
1 files changed, 39 insertions, 0 deletions
diff --git a/src/share/api/remote-server6-del.json b/src/share/api/remote-server6-del.json
new file mode 100644
index 0000000..5ca04c2
--- /dev/null
+++ b/src/share/api/remote-server6-del.json
@@ -0,0 +1,39 @@
+{
+ "access": "write",
+ "avail": "1.6.0",
+ "brief": [
+ "This command deletes information about a DHCPv6 server from the configuration database. Any configuration explicitly associated with the deleted server is automatically disassociated. In addition, configuration elements not shareable with other servers (e.g. global DHCP parameters) are deleted. Shareable configuration elements (e.g. subnets, shared networks) are not deleted as they may be used by other servers."
+ ],
+ "cmd-comment": [
+ "This command carries the list including exactly one map with the tag of the server to be deleted."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"remote-server6-del\",",
+ " \"arguments\": {",
+ " \"servers\": [",
+ " {",
+ " \"server-tag\": <server name>",
+ " }",
+ " ],",
+ " \"remote\": {",
+ " <specification of the database to connect to>",
+ " }",
+ " }",
+ "}"
+ ],
+ "hook": "cb_cmds",
+ "name": "remote-server6-del",
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"1 DHCPv6 server(s) deleted.\",",
+ " \"arguments\": {",
+ " \"count\": 1",
+ " }",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp6"
+ ]
+}