[#2125] Updated examples and doc

diff --git a/doc/examples/ddns/gss-tsig.json b/doc/examples/ddns/gss-tsig.json
index 78273408f15a9f8cd45c907b7609c74c8106786f..b3abccd96b1ce3740fe6637e76121f0c81d9f8c9 100644 (file)
--- a/doc/examples/ddns/gss-tsig.json
+++ b/doc/examples/ddns/gss-tsig.json
@@ -72,6 +72,7 @@
             "credentials-cache": "FILE:/etc/ccache", // toplevel only
             "tkey-lifetime": 3600,
             "tkey-protocol": "TCP",
+            "fallback": false,
 
             // The list of GSS-TSIG capable servers
             "servers": [
@@ -86,7 +87,9 @@
                     "server-principal": "DNS/server1.example.org@EXAMPLE.ORG",
                     "client-principal": "DHCP/admin1.example.org@EXAMPLE.ORG",
                     "tkey-lifetime": 86400, // 24h
-                    "tkey-protocol": "TCP"
+                    "tkey-protocol": "TCP",
+                    "fallback": true // if no key is available fallback to the
+                                     // standard behavior (vs skip this server)
                 },
                 {
                     // The second server (it has most of the parameters missing

diff --git a/doc/sphinx/arm/ext-gss-tsig.rst b/doc/sphinx/arm/ext-gss-tsig.rst
index 412213e09679c99f5e3a12389df7adce4a7c5258..106a6a7fd08ae556c529b84a0e8309e7bee8b0f1 100644 (file)
--- a/doc/sphinx/arm/ext-gss-tsig.rst
+++ b/doc/sphinx/arm/ext-gss-tsig.rst
@@ -464,7 +464,8 @@ An excerpt from D2 server is provided below. More examples are available in the
 
 .. code-block:: javascript
    :linenos:
-   :emphasize-lines: 57-99
+   :emphasize-lines: 57-100
+
 
     {
     "DhcpDdns": {
@@ -538,6 +539,7 @@ An excerpt from D2 server is provided below. More examples are available in the
                 "credentials-cache": "FILE:/etc/ccache", // toplevel only
                 "tkey-lifetime": 3600,
                 "tkey-protocol": "TCP",
+                "fallback": false,
 
                 // The list of GSS-TSIG capable servers
                 "servers": [
@@ -552,7 +554,9 @@ An excerpt from D2 server is provided below. More examples are available in the
                         "server-principal": "DNS/server1.example.org@EXAMPLE.ORG",
                         "client-principal": "DHCP/admin1.example.org@EXAMPLE.ORG",
                         "tkey-lifetime": 86400, // 24h
-                        "tkey-protocol": "TCP"
+                        "tkey-protocol": "TCP",
+                        "fallback": true // if no key is available fallback to the
+                                         // standard behavior (vs skip this server)
                     },
                     {
                         // The second server (it has most of the parameters missing
@@ -623,6 +627,13 @@ The parameters have the following meaning:
 - ``tkey-lifetime`` determines the lifetime of GSS-TSIG keys in the
   TKEY protocol, expressed in seconds. Default value is 3600 (one hour).
 
+- ``fallback`` governs the behavior when GSS-TSIG should be used (a
+  matching DNS server is configured) but a GSS-TSIG key is available.
+  If configured to false (the default) this server is skipped, if
+  configured to true the DNS server is ignored and the DNS update
+  is sent with the configured DHCP-DDNS protection e.g. TSIG key or
+  unsecure.
+
 - ``user-context`` is an optional parameter (see :ref:`user-context`
   for a general description of user contexts in Kea).
 
@@ -667,6 +678,11 @@ The server map parameters are:
   takes precedence. Default and supported values are the same as for
   the global level parameter.
 
+- ``fallback`` governs the behavior when GSS-TSIG should be used (a
+  matching DNS server is configured) but a GSS-TSIG key is available.
+  The fallback parameter per server takes precedence. Default and
+  supported values are the same as for the global level parameter.
+
 - ``user-context`` is an optional parameter (see :ref:`user-context`
   for a general description of user contexts in Kea).