summaryrefslogtreecommitdiffstats
path: root/src/share/api/remote-global-parameter4-get.json
diff options
context:
space:
mode:
Diffstat (limited to 'src/share/api/remote-global-parameter4-get.json')
-rw-r--r--src/share/api/remote-global-parameter4-get.json45
1 files changed, 45 insertions, 0 deletions
diff --git a/src/share/api/remote-global-parameter4-get.json b/src/share/api/remote-global-parameter4-get.json
new file mode 100644
index 0000000..1d7f09b
--- /dev/null
+++ b/src/share/api/remote-global-parameter4-get.json
@@ -0,0 +1,45 @@
+{
+ "access": "read",
+ "avail": "1.6.0",
+ "brief": [
+ "This command fetches the selected global parameter for the server from the specified database."
+ ],
+ "cmd-comment": [
+ "This command carries a list including exactly one name of the parameter to be fetched. 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 fetches the global parameter value shared by all servers."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"remote-global-parameter4-get\",",
+ " \"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-get",
+ "resp-comment": [
+ "The returned response contains a map with a global parameter name/value pair. The value may be a JSON string, integer, real, or boolean. The metadata is included and provides database-specific information associated with the returned object. If the \"all\" server tag is specified, the command attempts to fetch the global parameter value associated with all servers. If the explicit server tag is specified, the command fetches the value associated with the given server. If the server-specific value does not exist, the ``remote-global-parameter4-get`` command fetches the value associated with all servers."
+ ],
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"DHCPv4 global parameter found.\",",
+ " \"arguments\": {",
+ " \"parameters\": {",
+ " <parameter name>: <parameter value>,",
+ " \"metadata\": {",
+ " \"server-tags\": [ <server tag> ]",
+ " }",
+ " },",
+ " \"count\": 1",
+ " }",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp4"
+ ]
+}