From: Razvan Becheriu <razvan@isc.org>
Date: Wed, 19 Aug 2020 09:35:46 +0000 (+0300)
Subject: [#757] added documentation for optional DDNS "shutdown" command parameter "type"
X-Git-Tag: Kea-1.8.0~29
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=e063199a444750e65114e6082192bc979b307c77;p=thirdparty%2Fkea.git

[#757] added documentation for optional DDNS "shutdown" command parameter "type"
---

diff --git a/doc/sphinx/arm/ctrl-channel.rst b/doc/sphinx/arm/ctrl-channel.rst
index 5a0faaf385..d4ef0d0cd6 100644
--- a/doc/sphinx/arm/ctrl-channel.rst
+++ b/doc/sphinx/arm/ctrl-channel.rst
@@ -520,6 +520,29 @@ been initiated.  The optional parameter, "exit-value", specifies the
 numeric value with which the server process will exit to the system.
 The default value is zero.
 
+The DDNS deamon supports an extra parameter "type" which controls
+the way the DDNS process cleans up on exit. The supported shutdown types are:
+
+ -  "normal" - Stops the queue manager and finishes all current transactions
+    before exiting. This is the default.
+
+ -  "drain_first" - Stops the queue manager but continues processing requests
+    from the queue until it is empty.
+
+ -  "now" - Exits immediately.
+
+An example command may look like this:
+
+::
+
+   {
+       "command": "shutdown"
+       "arguments": {
+           "exit-value": 3,
+           "type": "drain_first"
+       }
+   }
+
 .. _command-dhcp-disable:
 
 The dhcp-disable Command
diff --git a/doc/sphinx/arm/ddns.rst b/doc/sphinx/arm/ddns.rst
index e63badf53d..36c93dcf60 100644
--- a/doc/sphinx/arm/ddns.rst
+++ b/doc/sphinx/arm/ddns.rst
@@ -298,6 +298,30 @@ The D2 server supports the following operational commands:
 -  status-get
 -  version-get
 
+The ``shutdown`` command supports extra ``type`` argument which controls the
+way the D2 server cleans up on exit.
+The supported shutdown types are:
+
+-  ``normal`` - Stops the queue manager and finishes all current transactions
+   before exiting. This is the default.
+
+-  ``drain_first`` - Stops the queue manager but continues processing requests
+   from the queue until it is empty.
+
+-  ``now`` - Exits immediately.
+
+An example command may look like this:
+
+::
+
+   {
+       "command": "shutdown"
+       "arguments": {
+           "exit-value": 3,
+           "type": "drain_first"
+       }
+   }
+
 .. _d2-tsig-key-list-config:
 
 TSIG Key List