From: Tomek Mrugalski <tomasz@isc.org>
Date: Fri, 5 Jan 2018 15:08:52 +0000 (+0100)
Subject: [5441] subnets-action documented for networkX-del commands.
X-Git-Tag: kea5574_base~2^2
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=2bf3caf7cb80d7f23ec5912db6f94b2bdb4374ff;p=thirdparty%2Fkea.git

[5441] subnets-action documented for networkX-del commands.
---

diff --git a/doc/guide/hooks.xml b/doc/guide/hooks.xml
index be499490f7..d30a4de9e3 100644
--- a/doc/guide/hooks.xml
+++ b/doc/guide/hooks.xml
@@ -2472,11 +2472,8 @@ applies to subnets within the network.
     <section>
         <title>network4-del, network6-del commands</title>
         <para>
-          These commands are used to delete existing shared networks. Each
-          subnet within the network being removed will be demoted to a plain
-          subnet. If you want to completely remove the subnets, please use
-          <command>subnet4-del</command> or <command>subnet6-del</command>
-          commands. Both commands take exactly one parameter 'name' that
+          These commands are used to delete existing shared
+          networks. Both commands take exactly one parameter 'name' that
           specifies the name of the network to be removed. An example invocation
           of <command>network4-del</command> command looks as follows:
 <screen>
@@ -2494,7 +2491,7 @@ the following:
     "arguments": {
         "shared-networks": [
             {
-                "name": "floor1"
+                "name": "floor13"
             }
         ]
     },
@@ -2505,6 +2502,30 @@ The <command>network6-del</command> command uses exactly the same syntax for
 both the command and the response.
         </para>
 
+        <para>If there are any subnets belonging to the shared network
+        being deleted, they will be demoted to a plain subnet. There
+        is an optional parameter called
+        <command>subnets-action</command> that, if specified, takes
+        one of two possible values: <command>keep</command> (which is
+        the default) and <command>delete</command>. It controls
+        whether the subnets be demoted to plain subnets or removed. An
+        example usage in network6-del command that deletes the shared
+        network and all subnets in it could looks like as follows:
+<screen>
+{
+    "command": "network4-del",
+    "arguments": {
+        "name": "floor13",
+        "subnets-action": "delete"
+    }
+}
+</screen>
+        </para>
+
+        <para>Alternatively, if you want to completely remove the
+        subnets, you may use <command>subnet4-del</command> or
+        <command>subnet6-del</command> commands.</para>
+
     </section>
     <section>
         <title>network4-subnet-add, network6-subnet-add commands</title>