[#643,!421] Updated API docs for subnets management with tags.

diff --git a/doc/api/remote-subnet4-del-by-id.json b/doc/api/remote-subnet4-del-by-id.json
index 15c0985f8328e6c8c7038985ae49ed0a94116fbc..a28baadd3154512a7bc0f67321d088367453604a 100644 (file)
--- a/doc/api/remote-subnet4-del-by-id.json
+++ b/doc/api/remote-subnet4-del-by-id.json
@@ -17,7 +17,7 @@
         }
     }
 }",
-    "cmd-comment": "This command includes a list with exactly one id of the subnet to be deleted.",
+    "cmd-comment": "This command includes a list with exactly one id of the subnet to be deleted. The <command>server-tags</command> parameter must not be specified for this command.",
     "resp-syntax": "{
     \"result\": 0,
     \"text\": \"1 IPv4 subnet(s) deleted.\",

diff --git a/doc/api/remote-subnet4-del-by-prefix.json b/doc/api/remote-subnet4-del-by-prefix.json
index 9ba462c1c2838c83b8a139df5ad1b80ee9085afc..16fe5813335726f4dd4a39494dbb432683fce50b 100644 (file)
--- a/doc/api/remote-subnet4-del-by-prefix.json
+++ b/doc/api/remote-subnet4-del-by-prefix.json
@@ -17,7 +17,7 @@
         }
     }
 }",
-    "cmd-comment": "This command includes a list with exactly one prefix of the subnet to be deleted.",
+    "cmd-comment": "This command includes a list with exactly one prefix of the subnet to be deleted. The <command>server-tags</command> parameter must not be specified for this command.",
     "resp-syntax": "{
     \"result\": 0,
     \"text\": \"1 IPv4 subnet(s) deleted.\",

diff --git a/doc/api/remote-subnet4-get-by-id.json b/doc/api/remote-subnet4-get-by-id.json
index 4fbe9d0b24c61a952dfcef7aa0bef912619ba190..aedc0d591b4dc4a58bbb8c40171fc19d47041702 100644 (file)
--- a/doc/api/remote-subnet4-get-by-id.json
+++ b/doc/api/remote-subnet4-get-by-id.json
@@ -15,7 +15,7 @@
         }
     }
 }",
-    "cmd-comment": "This command includes a list with exactly one id of the subnet to be returned.",
+    "cmd-comment": "This command includes a list with exactly one id of the subnet to be returned. The <command>server-tags</command> parameter must not be specified for this command.",
     "resp-syntax": "{
     \"result\": 0,
     \"text\": \"IPv4 subnet found.\",
@@ -25,7 +25,7 @@
             \"subnet\": <subnet prefix>,
             \"shared-network-name\": <shared network name> | null,
             \"metadata\": {
-                \"server-tag\": <server tag>
+                \"server-tags\": [ <first server tag>, <second server tag>, ... ]
             },
             <the rest of the subnet specification here>
         } ],

diff --git a/doc/api/remote-subnet4-get-by-prefix.json b/doc/api/remote-subnet4-get-by-prefix.json
index 2790245346f2ec823484cdda0452f3e01c857e0e..bcf74f3b884b9c551c122ada6365f4cefcb512b4 100644 (file)
--- a/doc/api/remote-subnet4-get-by-prefix.json
+++ b/doc/api/remote-subnet4-get-by-prefix.json
@@ -15,7 +15,7 @@
         }
     }
 }",
-    "cmd-comment": "This command includes a list with exactly one prefix of the subnet to be returned.",
+    "cmd-comment": "This command includes a list with exactly one prefix of the subnet to be returned. The <command>server-tags</command> parameter must not be specified for this command.",
     "resp-syntax": "{
     \"result\": 0,
     \"text\": \"IPv4 subnet found.\",
@@ -26,7 +26,7 @@
                 \"subnet\": <subnet prefix>,
                 \"shared-network-name\": <shared network name> | null,
                 \"metadata\": {
-                    \"server-tag\": <server tag>
+                    \"server-tags\": [ <first server tag>, <second server tag>, ... ]
                 },
                 <the rest of the subnet specification here>
             }

diff --git a/doc/api/remote-subnet4-list.json b/doc/api/remote-subnet4-list.json
index 92ea88e7f06065e3476d64b27b39d2d64caca732..2cd4bac10296442ee7e0923c11a49d9cd379d18a 100644 (file)
--- a/doc/api/remote-subnet4-list.json
+++ b/doc/api/remote-subnet4-list.json
@@ -9,10 +9,11 @@
     \"arguments\": {
         \"remote\": {
             <specification of the database to connect to>
-        }
+        },
+        \"server-tags\": [ <first server tag>, <second server tag>, ... ]
     }
 }",
-    "cmd-comment": "This command includes no arguments besides the optional <command>remote</command> map.",
+    "cmd-comment": "The <command>server-tags</command> list is required for this command. This list must not be empty. It may either contain one or multiple server tags as strings or a single <command>null</command> value.",
     "resp-syntax": "{
     \"result\": 0,
     \"text\": \"2 IPv4 subnets found.\",
@@ -23,7 +24,7 @@
                 \"subnet\": <first subnet prefix>,
                 \"shared-network-name\": <shared network name> | null,
                 \"metadata\": {
-                    \"server-tag\": <server tag>
+                    \"server-tags\": [ <first server tag>, <second server tag>, ... ]
                 }
             },
             {
@@ -31,12 +32,12 @@
                 \"subnet\": <second subnet prefix>,
                 \"shared-network-name\": <shared network name> | null,
                 \"metadata\": {
-                    \"server-tag\": <server tag>
+                    \"server-tags\": [ <first server tag>, ... ]
                 }
             }
         ],
         \"count\": 2
     }
 }",
-    "resp-comment": "The returned response contains a list of maps. Each map contains a subnet identifier, prefix and shared network name to which the subnet belongs. If the subnet does not belong to a shared netork the name is null. The metadata includes database specific information associated with the subnets. The returned list does not contain full subnet definitions. Use <command>remote-subnet4-get</command> to fetch the full information about the selected subnets."
+    "resp-comment": "The returned response contains a list of maps. Each map contains a subnet identifier, prefix and shared network name to which the subnet belongs. If the subnet does not belong to a shared netork the name is null. The metadata includes database specific information associated with the subnets. The returned list does not contain full subnet definitions. Use <command>remote-subnet4-get</command> to fetch the full information about the selected subnets. If the command includes explicit server tags as strings (including the special server tag \"all\"), the list contains all subnets which are associated with any of the specified tags. A subnet is returned even if it is associated with multiple servers and only one of the specified tags matches. If the command includes the <command>null</command> value in the <command>server-tags</command> list, the response contains all subnets which are assigned to no servers (unassigned)."
 }

diff --git a/doc/api/remote-subnet4-set.json b/doc/api/remote-subnet4-set.json
index b4b409ce77765612be2472b10e856fa8ae125540..072f74f32cc53e11ec0daffc60fb16535e42ea73 100644 (file)
--- a/doc/api/remote-subnet4-set.json
+++ b/doc/api/remote-subnet4-set.json
@@ -17,10 +17,11 @@
         ],
         \"remote\": {
             <specification of the database to connect to>
-        }
+        },
+        \"server-tags\": [ <first server tag>, <second server tag>, ... ]
     }
 }",
-    "cmd-comment": "The provided list must contain exactly one subnet specification. The <command>shared-network-name</command> parameter is required for these commands. It associates the subnet with the shared network by its name. If the subnet must not belong to any shared network (global subnet), the <command>null</command> value must be specified for the shared network name.",
+    "cmd-comment": "The provided list must contain exactly one subnet specification. The <command>shared-network-name</command> parameter is required for these commands. It associates the subnet with the shared network by its name. If the subnet must not belong to any shared network (global subnet), the <command>null</command> value must be specified for the shared network name. The <command>server-tags</command> list is mandatory and it must contain one or more server tags as strings to explicitly associate the subnet with one or more user defined servers. It may include the special server tag \"all\" to associate the subnet with all servers.",
     "resp-syntax": "{
     \"result\": 0,
     \"text\": \"IPv4 subnet successfully set.\",

diff --git a/doc/api/remote-subnet6-del-by-id.json b/doc/api/remote-subnet6-del-by-id.json
index 194552b66f798f4cef2c8cae8fcf2ad10ecc53cd..7f9e487217bafad9e4dcda65b99cc2621c30cb19 100644 (file)
--- a/doc/api/remote-subnet6-del-by-id.json
+++ b/doc/api/remote-subnet6-del-by-id.json
@@ -17,7 +17,7 @@
         }
     }
 }",
-    "cmd-comment": "This command includes a list with exactly one id of the subnet to be deleted.",
+    "cmd-comment": "This command includes a list with exactly one id of the subnet to be deleted. The <command>server-tags</command> parameter must not be specified for this command.",
     "resp-syntax": "{
     \"result\": 0,
     \"text\": \"1 IPv6 subnet(s) deleted.\",

diff --git a/doc/api/remote-subnet6-del-by-prefix.json b/doc/api/remote-subnet6-del-by-prefix.json
index 0909b7bbfeb2edd157b76b31d4b13e28c38280bf..fbad1cf7f45e14b4a509ebb29c1d326d4d14cf0a 100644 (file)
--- a/doc/api/remote-subnet6-del-by-prefix.json
+++ b/doc/api/remote-subnet6-del-by-prefix.json
@@ -17,7 +17,7 @@
         }
     }
 }",
-    "cmd-comment": "This command includes a list with exactly one prefix of the subnet to be deleted.",
+    "cmd-comment": "This command includes a list with exactly one prefix of the subnet to be deleted. The <command>server-tags</command> parameter must not be specified for this command.",
     "resp-syntax": "{
     \"result\": 0,
     \"text\": \"1 IPv6 subnet(s) deleted.\",

diff --git a/doc/api/remote-subnet6-get-by-id.json b/doc/api/remote-subnet6-get-by-id.json
index b260eec7fc093f886a788e4afe2334533e9f938a..1e439d1317bc0f7d45c9a2c584eb665309eaaf86 100644 (file)
--- a/doc/api/remote-subnet6-get-by-id.json
+++ b/doc/api/remote-subnet6-get-by-id.json
@@ -17,7 +17,7 @@
         }
     }
 }",
-    "cmd-comment": "This command includes a list with exactly one id of the subnet to be returned.",
+    "cmd-comment": "This command includes a list with exactly one id of the subnet to be returned. The <command>server-tags</command> parameter must not be specified for this command.",
     "resp-syntax": "{
     \"result\": 0,
     \"text\": \"IPv6 subnet found.\",
@@ -28,7 +28,7 @@
                 \"subnet\": <subnet prefix>,
                 \"shared-network-name\": <shared network name> | null,
                 \"metadata\": {
-                    \"server-tag\": <server tag>
+                    \"server-tags\": [ <first server tag>, <second server tag>, ... ]
                 },
                 <the rest of the subnet specification here>
             }

diff --git a/doc/api/remote-subnet6-get-by-prefix.json b/doc/api/remote-subnet6-get-by-prefix.json
index 86dbfcb3fe6b151bf25fdcc878e62e7f5a2e2b83..e4f7eb18e2f67753fce1469b258c78e09ac3eb55 100644 (file)
--- a/doc/api/remote-subnet6-get-by-prefix.json
+++ b/doc/api/remote-subnet6-get-by-prefix.json
@@ -17,7 +17,7 @@
         }
     }
 }",
-    "cmd-comment": "This command includes a list with exactly one prefix of the subnet to be returned.",
+    "cmd-comment": "This command includes a list with exactly one prefix of the subnet to be returned. The <command>server-tags</command> parameter must not be specified for this command.",
     "resp-syntax": "{
     \"result\": 0,
     \"text\": \"IPv6 subnet found.\",
@@ -27,7 +27,7 @@
             \"subnet\": <subnet prefix>,
             \"shared-network-name\": <shared network name> | null,
             \"metadata\": {
-                \"server-tag\": <server tag>
+                \"server-tags\": [ <first server tag>, <second server tag>, ... ]
             },
             <the rest of the subnet specification here>
         } ],

diff --git a/doc/api/remote-subnet6-list.json b/doc/api/remote-subnet6-list.json
index ea279512987d0dcc5934b85cfcf49f58df4dfb96..c68cb48d49bd5f83be72943f334eaf06ab3c69bc 100644 (file)
--- a/doc/api/remote-subnet6-list.json
+++ b/doc/api/remote-subnet6-list.json
@@ -9,10 +9,11 @@
     \"arguments\": {
         \"remote\": {
             <specification of the database to connect to>
-        }
+        },
+        \"server-tags\": [ <first server tag>, <second server tag>, ... ]
     }
 }",
-    "cmd-comment": "This command includes no arguments besides the optional <command>remote</command> map.",
+    "cmd-comment": "The <command>server-tags</command> list is required for this command. This list must not be empty. It may either contain one or multiple server tags as strings or a single <command>null</command> value.",
     "resp-syntax": "{
     \"result\": 0,
     \"text\": \"2 IPv6 subnets found.\",
@@ -23,7 +24,7 @@
                 \"subnet\": <first subnet prefix>,
                 \"shared-network-name\": <shared network name> | null,
                 \"metadata\": {
-                    \"server-tag\": <server tag>
+                    \"server-tags\": [ <first server tag>, <second server tag>, ... ]
                 }
             },
             {
@@ -31,12 +32,12 @@
                 \"subnet\": <second subnet prefix>,
                 \"shared-network-name\": <shared network name> | null,
                 \"metadata\": {
-                    \"server-tag\": <server tag>
+                    \"server-tags\": [ <first server tag>, ... ]
                 }
             }
         ],
         \"count\": 2
     }
 }",
-    "resp-comment": "The returned response contains a list of maps. Each map contains a subnet identifier, prefix and shared network name to which the subnet belongs. If the subnet does not belong to a shared netork the name is null. The metadata includes database specific information associated with the subnets. The returned list does not contain full subnet definitions. Use <command>remote-subnet6-get</command> to fetch the full information about the selected subnets."
+    "resp-comment": "The returned response contains a list of maps. Each map contains a subnet identifier, prefix and shared network name to which the subnet belongs. If the subnet does not belong to a shared netork the name is null. The metadata includes database specific information associated with the subnets. The returned list does not contain full subnet definitions. Use <command>remote-subnet6-get</command> to fetch the full information about the selected subnets. If the command includes explicit server tags as strings (including the special server tag \"all\"), the list contains all subnets which are associated with any of the specified tags. A subnet is returned even if it is associated with multiple servers and only one of the specified tags matches. If the command includes the <command>null</command> value in the <command>server-tags</command> list, the response contains all subnets which are assigned to no servers (unassigned)."
 }

diff --git a/doc/api/remote-subnet6-set.json b/doc/api/remote-subnet6-set.json
index f0545b95b89b26f5b9c1da07c692f1047ce34a0a..819fa4fa923371e7eac4f07783c4db1d84d6a173 100644 (file)
--- a/doc/api/remote-subnet6-set.json
+++ b/doc/api/remote-subnet6-set.json
@@ -1,6 +1,6 @@
 {
     "name": "remote-subnet6-set",
-    "brief": "This command is used to create or replace an IPv4 subnet the configuration database.",
+    "brief": "This command is used to create or replace an IPv6 subnet the configuration database.",
     "support": [ "kea-dhcp6" ],
     "avail": "1.6.0",
     "hook": "cb_cmds",
@@ -17,10 +17,11 @@
         ],
         \"remote\": {
             <specification of the database to connect to>
-        }
+        },
+        \"server-tags\": [ <first server tag>, <second server tag>, ... ]
     }
 }",
-    "cmd-comment": "The provided list must contain exactly one subnet specification. The <command>shared-network-name</command> parameter is required for these commands. It associates the subnet with the shared network by its name. If the subnet must not belong to any shared network (global subnet), the <command>null</command> value must be specified for the shared network name.",
+    "cmd-comment": "The provided list must contain exactly one subnet specification. The <command>shared-network-name</command> parameter is required for these commands. It associates the subnet with the shared network by its name. If the subnet must not belong to any shared network (global subnet), the <command>null</command> value must be specified for the shared network name. The <command>server-tags</command> list is mandatory and it must contain one or more server tags as strings to explicitly associate the subnet with one or more user defined servers. It may include the special server tag \"all\" to associate the subnet with all servers.",
     "resp-syntax": "{
     \"result\": 0,
     \"text\": \"IPv6 subnet successfully set.\",