[#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 43cd91544d81f8a28ca6b395649f5d262031a40b..76344051c6f84bcef4d6729386a94a84c40a9fae 100644 (file)
--- 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\": [ <parameter name> ],
+        \"parameters\": [ <parameter name as string> ],
         \"remote\": {
             <specification of the database to connect to>
-        }
+        },
+        \"server-tags\": [ <single server tag as string> ]
     }
 }",
-    "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 <command>server-tags</command> list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of <command>null</command> 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 12a85b091c7845174dabc171b92e72a7ed874a44..0c00bdedf4919d85d825ea77405e0309a5efead4 100644 (file)
--- a/doc/api/remote-global-parameter4-get-all.json
+++ b/doc/api/remote-global-parameter4-get-all.json
@@ -9,10 +9,11 @@
     \"arguments\": {
         \"remote\": {
             <specification of the database to connect to>
-        }
+        },
+        \"server-tags\": [ <single server tag as string> ]
     }
 }",
-    "cmd-comment": "This command contains no arguments besides the optional <command>remote</command>.",
+    "cmd-comment": "The <command>server-tags</command> list is mandatory and it muct contain exactly one server tag. Specifying an empty list, a value of <command>null</command> 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 @@
             {
                 <first parameter name>: <first parameter value>,
                 \"metadata\": {
-                    \"server-tag\": <server tag>
+                    \"server-tags\": [ <server tag> ]
                 }
             },
             {
                 <second parameter name>: <second parameter value>,
                 \"metadata\": {
-                    \"server-tag\": <server tag>
+                    \"server-tags\": [ <server tag> ]
                 }
             }
         ],
         \"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 dc184d235e69fcd5ed13564d057950f0914f2256..c16be7e8f428e6f12dad12bba47674b9aee33a4d 100644 (file)
--- 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\": [ <parameter name> ],
+        \"parameters\": [ <parameter name as string> ],
         \"remote\": {
             <specification of the database to connect to>
-        }
+        },
+        \"server-tags\": [ <single server tag as string> ]
     }
 }",
-    "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 <command>server-tags</command> list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of <command>null</command> 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\": {
             <parameter name>: <parameter value>,
             \"metadata\": {
-                \"server-tag\": <server tag>
+                \"server-tags\": [ <server tag> ]
             }
         },
         \"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 5756741327f8bc0591ea19945731a445221380f9..1c172df9dbaa7f972ba268d94b3511eceadfde9e 100644 (file)
--- a/doc/api/remote-global-parameter4-set.json
+++ b/doc/api/remote-global-parameter4-set.json
@@ -13,10 +13,11 @@
         },
         \"remote\": {
             <specification of the database to connect to>
-        }
+        },
+        \"server-tags\": [ <single server tag as string> ]
     }
 }",
-    "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 <command>remote-global-parameter4-get-all</command> 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 <command>remote-global-parameter4-get-all</command> may be useful to verify the contents of the database after the update. The <command>server-tags</command> list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of <command>null</command> 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 faba037271813694e658fc32da0916eaa90df03c..601689ffd7c8143018c30e6ce4b2d8f3ff7fb454 100644 (file)
--- 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\": [ <parameter name> ],
+        \"parameters\": [ <parameter name as string> ],
         \"remote\": {
             <specification of the database to connect to>
-        }
+        },
+        \"server-tags\": [ <single server tag as string> ]
     }
 }",
-    "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 <command>server-tags</command> list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of <command>null</command> 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 667c7c8f24fd79a60e4c785f8edef03328dce115..cd27d54e1cf2b9147c5d3be7dbd13120023401b4 100644 (file)
--- 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\": {
             <specification of the database to connect to>
-        }
+        },
+        \"server-tags\": [ <single server tag as string> ]
     }
 }",
-    "cmd-comment": "This command contains no arguments besides the optional <command>remote</command>.",
+    "cmd-comment": "The <command>server-tags</command> list is mandatory and it muct contain exactly one server tag. Specifying an empty list, a value of <command>null</command> 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 @@
             {
                 <first parameter name>: <first parameter value>,
                 \"metadata\": {
-                    \"server-tag\": <server tag>
+                    \"server-tags\": [ <server tag> ]
                 }
             },
             {
                 <second parameter name>: <second parameter value>,
                 \"metadata\": {
-                    \"server-tag\": <server tag>
+                    \"server-tags\": [ <server tag> ]
                 }
             }
         ],
         \"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 fb94e973e94fe5fef08ffe9485d96ea878fd5e10..d05ffd0f69be62843ee7cd89e8acdffae8ac8664 100644 (file)
--- 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\": [ <parameter name> ],
+        \"parameters\": [ <parameter name as string> ],
         \"remote\": {
             <specification of the database to connect to>
-        }
+        },
+        \"server-tags\": [ <single server tag as string> ]
     }
 }",
-    "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 <command>server-tags</command> list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of <command>null</command> 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\": {
             <parameter name>: <parameter value>,
             \"metadata\": {
-                \"server-tag\": <server tag>
+                \"server-tags\": [ <server tag> ]
             }
         },
         \"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 2df37343394e1dd82877b40764791f5031836eec..0715245f0074055b703383955160d5d90cb5fc29 100644 (file)
--- 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\": {
             <specification of the database to connect to>
-        }
+        },
+        \"server-tags\": [ <single server tag as string> ]
     }
 }",
-    "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 <command>remote-global-parameter6-get-all</command> 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 <command>remote-global-parameter6-get-all</command> may be useful to verify the contents of the database after the update. The <command>server-tags</command> list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of <command>null</command> 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.\",