summaryrefslogtreecommitdiffstats
path: root/src/share/api/remote-global-parameter4-set.json
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--src/share/api/remote-global-parameter4-set.json43
1 files changed, 43 insertions, 0 deletions
diff --git a/src/share/api/remote-global-parameter4-set.json b/src/share/api/remote-global-parameter4-set.json
new file mode 100644
index 0000000..d09af68
--- /dev/null
+++ b/src/share/api/remote-global-parameter4-set.json
@@ -0,0 +1,43 @@
+{
+ "access": "write",
+ "avail": "1.6.0",
+ "brief": [
+ "This command creates or updates one or more global parameters in the configuration database."
+ ],
+ "cmd-comment": [
+ "This command carries multiple global parameters with their values. Care should be taken when specifying more than one parameter; in some cases, only a subset of the parameters may be successfully stored in the database and other parameters may fail to be stored. In such cases the ``remote-global-parameter4-get-all`` command may be useful to verify the contents of the database after the update. 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. The server tag \"all\" is allowed; it associates the specified parameters with all servers."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"remote-global-parameter4-set\",",
+ " \"arguments\": {",
+ " \"parameters\": {",
+ " <first parameter name>: <first parameter value>,",
+ " <second parameter name>: <second parameter value>",
+ " },",
+ " \"remote\": {",
+ " <specification of the database to connect to>",
+ " },",
+ " \"server-tags\": [ <single server tag as string> ]",
+ " }",
+ "}"
+ ],
+ "hook": "cb_cmds",
+ "name": "remote-global-parameter4-set",
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"DHCPv4 global parameter(s) successfully set.\",",
+ " \"arguments\": {",
+ " \"parameters\": {",
+ " <first parameter name>: <first parameter value>,",
+ " <second parameter name>: <second parameter value>",
+ " },",
+ " \"count\": 2",
+ " }",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp4"
+ ]
+}