From: Marcin Siodelski Date: Mon, 15 Jul 2019 16:26:31 +0000 (+0200) Subject: [#643,!421] Updated API docs for global parameters setting. X-Git-Tag: Kea-1.6.0-beta2~30 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=0e70fff335a1d42770a9743c298345d80ad81b63;p=thirdparty%2Fkea.git [#643,!421] Updated API docs for global parameters setting. --- diff --git a/doc/api/remote-global-parameter4-del.json b/doc/api/remote-global-parameter4-del.json index 43cd91544d..76344051c6 100644 --- a/doc/api/remote-global-parameter4-del.json +++ b/doc/api/remote-global-parameter4-del.json @@ -7,13 +7,14 @@ "cmd-syntax": "{ \"command\": \"remote-global-parameter4-del\", \"arguments\": { - \"parameters\": [ ], + \"parameters\": [ ], \"remote\": { - } + }, + \"server-tags\": [ ] } }", - "cmd-comment": "This command carries the list including exactly one name of the parameter to be deleted.", + "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." "resp-syntax": "{ \"result\": 0, \"text\": \"DHCPv4 global parameter(s) deleted.\", diff --git a/doc/api/remote-global-parameter4-get-all.json b/doc/api/remote-global-parameter4-get-all.json index 12a85b091c..0c00bdedf4 100644 --- a/doc/api/remote-global-parameter4-get-all.json +++ b/doc/api/remote-global-parameter4-get-all.json @@ -9,10 +9,11 @@ \"arguments\": { \"remote\": { - } + }, + \"server-tags\": [ ] } }", - "cmd-comment": "This command contains no arguments besides the optional remote.", + "cmd-comment": "The server-tags list is mandatory and it muct contain exactly one server tag. Specifying an empty list, a value of null or multiple server tags will result in an error. The special server tag \"all\" is allowed to fetch the global parameters shared by all servers.", "resp-syntax": "{ \"result\": 0, \"text\": \"DHCPv4 global parameters found.\", @@ -21,18 +22,18 @@ { : , \"metadata\": { - \"server-tag\": + \"server-tags\": [ ] } }, { : , \"metadata\": { - \"server-tag\": + \"server-tags\": [ ] } } ], \"count\": 2 } }", - "resp-comment": "The returned response contains a list of maps. Each map contains a global parameter name/value pair. The value may be a JSON string, integer, real or boolean. The metadata is appended to each parameter and it provides database specific information associated with the returned objects." + "resp-comment": "The returned response contains a list of maps. Each map contains a global parameter name/value pair. The value may be a JSON string, integer, real or boolean. The metadata is appended to each parameter and it provides database specific information associated with the returned objects. If the server tag \"all\" is included in the command, the response contains the global parameters shared between all servers. It excludes server specific global parameters. If an explicit server tag is included in the command, the response contains all global parameters directly associated with the given server and the global parameters associated with all servers when server specific values are not present." } diff --git a/doc/api/remote-global-parameter4-get.json b/doc/api/remote-global-parameter4-get.json index dc184d235e..c16be7e8f4 100644 --- a/doc/api/remote-global-parameter4-get.json +++ b/doc/api/remote-global-parameter4-get.json @@ -7,13 +7,14 @@ "cmd-syntax": "{ \"command\": \"remote-global-parameter4-get\", \"arguments\": { - \"parameters\": [ ], + \"parameters\": [ ], \"remote\": { - } + }, + \"server-tags\": [ ] } }", - "cmd-comment": "This command carries a list including exactly one name of the parameter to be fetched.", + "cmd-comment": "This command carries a list including exactly one name of the parameter to be fetched. 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. The server tag \"all\" is allowed to fetch the global parameter value shared by all servers.", "resp-syntax": "{ \"result\": 0, \"text\": \"DHCPv4 global parameter found.\", @@ -21,11 +22,11 @@ \"parameters\": { : , \"metadata\": { - \"server-tag\": + \"server-tags\": [ ] } }, \"count\": 1 } }", - "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 it provides database specific information associated with the returned object." + "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 it provides database specific information associated with the returned object. If the \"all\" server tag was specified, the command attempts to fetch the global parameter value associated with all servers. If the explicit server tag is specified, the command will fetch the value associated with the given server. If the server specific value doesn't exist, it will try to fetch the value associated with all servers." } diff --git a/doc/api/remote-global-parameter4-set.json b/doc/api/remote-global-parameter4-set.json index 5756741327..1c172df9db 100644 --- a/doc/api/remote-global-parameter4-set.json +++ b/doc/api/remote-global-parameter4-set.json @@ -13,10 +13,11 @@ }, \"remote\": { - } + }, + \"server-tags\": [ ] } }", - "cmd-comment": "This command carries multiple global parameters with their values. Care should be taken when specifying more than one parameter because 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 may be useful to verify the contents of the database after the update.", + "cmd-comment": "This command carries multiple global parameters with their values. Care should be taken when specifying more than one parameter because 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 may be useful to verify the contents of the database after the update. 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. The server tag \"all\" is allowed and it associates the specified parameters with all servers.", "resp-syntax": "{ \"result\": 0, \"text\": \"DHCPv4 global parameter(s) successfully set.\", diff --git a/doc/api/remote-global-parameter6-del.json b/doc/api/remote-global-parameter6-del.json index faba037271..601689ffd7 100644 --- a/doc/api/remote-global-parameter6-del.json +++ b/doc/api/remote-global-parameter6-del.json @@ -7,17 +7,19 @@ "cmd-syntax": "{ \"command\": \"remote-global-parameter6-del\", \"arguments\": { - \"parameters\": [ ], + \"parameters\": [ ], \"remote\": { - } + }, + \"server-tags\": [ ] } }", - "cmd-comment": "This command carries the list including exactly one name of the parameter to be deleted.", + "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." "resp-syntax": "{ \"result\": 0, \"text\": \"DHCPv6 global parameter(s) deleted.\", \"arguments\": { \"count\": 1 - }" + } +}" } diff --git a/doc/api/remote-global-parameter6-get-all.json b/doc/api/remote-global-parameter6-get-all.json index 667c7c8f24..cd27d54e1c 100644 --- a/doc/api/remote-global-parameter6-get-all.json +++ b/doc/api/remote-global-parameter6-get-all.json @@ -5,14 +5,15 @@ "avail": "1.6.0", "hook": "cb_cmds", "cmd-syntax": "{ - \"command\": \"remote-global-parameter6-get-all\" + \"command\": \"remote-global-parameter6-get-all\", \"arguments\": { \"remote\": { - } + }, + \"server-tags\": [ ] } }", - "cmd-comment": "This command contains no arguments besides the optional remote.", + "cmd-comment": "The server-tags list is mandatory and it muct contain exactly one server tag. Specifying an empty list, a value of null or multiple server tags will result in an error. The special server tag \"all\" is allowed to fetch the global parameters shared by all servers.", "resp-syntax": "{ \"result\": 0, \"text\": \"DHCPv6 global parameters found.\", @@ -21,18 +22,18 @@ { : , \"metadata\": { - \"server-tag\": + \"server-tags\": [ ] } }, { : , \"metadata\": { - \"server-tag\": + \"server-tags\": [ ] } } ], \"count\": 2 } }", - "resp-comment": "The returned response contains a list of maps. Each map contains a global parameter name/value pair. The value may be a JSON string, integer, real or boolean. The metadata is appended to each parameter and it provides database specific information associated with the returned objects." + "resp-comment": "The returned response contains a list of maps. Each map contains a global parameter name/value pair. The value may be a JSON string, integer, real or boolean. The metadata is appended to each parameter and it provides database specific information associated with the returned objects. If the server tag \"all\" is included in the command, the response contains the global parameters shared between all servers. It excludes server specific global parameters. If an explicit server tag is included in the command, the response contains all global parameters directly associated with the given server and the global parameters associated with all servers when server specific values are not present." } diff --git a/doc/api/remote-global-parameter6-get.json b/doc/api/remote-global-parameter6-get.json index fb94e973e9..d05ffd0f69 100644 --- a/doc/api/remote-global-parameter6-get.json +++ b/doc/api/remote-global-parameter6-get.json @@ -5,15 +5,16 @@ "avail": "1.6.0", "hook": "cb_cmds", "cmd-syntax": "{ - \"command\": \"remote-global-parameter6-get\" + \"command\": \"remote-global-parameter6-get\", \"arguments\": { - \"parameters\": [ ], + \"parameters\": [ ], \"remote\": { - } + }, + \"server-tags\": [ ] } }", - "cmd-comment": "This command carries a list including exactly one name of the parameter to be fetched.", + "cmd-comment": "This command carries a list including exactly one name of the parameter to be fetched. 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. The server tag \"all\" is allowed to fetch the global parameter value shared by all servers.", "resp-syntax": "{ \"result\": 0, \"text\": \"DHCPv6 global parameter found.\", @@ -21,11 +22,11 @@ \"parameters\": { : , \"metadata\": { - \"server-tag\": + \"server-tags\": [ ] } }, \"count\": 1 } }", - "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 it provides database specific information associated with the returned object." + "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 it provides database specific information associated with the returned object. If the \"all\" server tag was specified, the command attempts to fetch the global parameter value associated with all servers. If the explicit server tag is specified, the command will fetch the value associated with the given server. If the server specific value doesn't exist, it will try to fetch the value associated with all servers." } diff --git a/doc/api/remote-global-parameter6-set.json b/doc/api/remote-global-parameter6-set.json index 2df3734339..0715245f00 100644 --- a/doc/api/remote-global-parameter6-set.json +++ b/doc/api/remote-global-parameter6-set.json @@ -1,6 +1,6 @@ { "name": "remote-global-parameter6-set", - "brief": "This command is used to create or update one more global DHCP parameters in the configuration database.", + "brief": "This command is used to create or update one more global parameters in the configuration database.", "support": [ "kea-dhcp6" ], "avail": "1.6.0", "hook": "cb_cmds", @@ -13,10 +13,11 @@ }, \"remote\": { - } + }, + \"server-tags\": [ ] } }", - "cmd-comment": "This command carries multiple global parameters with their values. Care should be taken when specifying more than one parameter because 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-parameter6-get-all may be useful to verify the contents of the database after the update.", + "cmd-comment": "This command carries multiple global parameters with their values. Care should be taken when specifying more than one parameter because 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-parameter6-get-all may be useful to verify the contents of the database after the update. 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. The server tag \"all\" is allowed and it associates the specified parameters with all servers.", "resp-syntax": "{ \"result\": 0, \"text\": \"DHCPv6 global parameter(s) successfully set.\",