]> git.ipfire.org Git - thirdparty/pdns.git/commitdiff
dnsdist: fix documentation nits and add completion documentation for showServers... 7191/head
authorCharles-Henri Bruyand <charles-henri.bruyand@open-xchange.com>
Wed, 14 Nov 2018 14:51:54 +0000 (15:51 +0100)
committerCharles-Henri Bruyand <charles-henri.bruyand@open-xchange.com>
Wed, 14 Nov 2018 14:51:54 +0000 (15:51 +0100)
pdns/dnsdist-console.cc
pdns/dnsdistdist/docs/guides/serverselection.rst
pdns/dnsdistdist/docs/reference/config.rst

index 10f1e91918409e441642974c3757e3e8ab7809f0..654520cdc4cf7e34e3ee718510de13151e0fc44a 100644 (file)
@@ -464,7 +464,7 @@ const std::vector<ConsoleKeyword> g_consoleKeywords{
   { "showRules", true, "[{showUUIDs=false, truncateRuleWidth=-1}]", "show all defined rules, optionally with their UUIDs and optionally truncated to a given width" },
   { "showSelfAnsweredResponseRules", true, "[{showUUIDs=false, truncateRuleWidth=-1}]", "show all defined self-answered response rules, optionally with their UUIDs and optionally truncated to a given width" },
   { "showServerPolicy", true, "", "show name of currently operational server selection policy" },
-  { "showServers", true, "", "output all servers" },
+  { "showServers", true, "[{showUUIDs=false}]", "output all servers, optionally with their UUIDs" },
   { "showTCPStats", true, "", "show some statistics regarding TCP" },
   { "showTLSContexts", true, "", "list all the available TLS contexts" },
   { "showVersion", true, "", "show the current version" },
index c8cde68b575b170207d1c6c5ca08865136dadadf..191b934d6983d066c3e509230477086b3fd6ac6c 100644 (file)
@@ -48,7 +48,7 @@ The current hash algorithm is based on the qname of the query.
 
 ``chashed`` is a consistent hashing distribution policy. Identical questions with identical hashes will be distributed to the same servers. But unlike the ``whashed`` policy, this distribution will keep consistent over time. Adding or removing servers will only remap a small part of the queries.
 
-You can also set the hash perturbation value, see :func:`setWHashedPertubation`. To achieve consistent distribution over :program:`dnsdist` restarts, you will also need to explicitly set the backend's UUIDs with the ``id`` option of :func:`newServer`. You can get the current UUIDs of your backends by calling :func:`showServers`.
+You can also set the hash perturbation value, see :func:`setWHashedPertubation`. To achieve consistent distribution over :program:`dnsdist` restarts, you will also need to explicitly set the backend's UUIDs with the ``id`` option of :func:`newServer`. You can get the current UUIDs of your backends by calling :func:`showServers` with the ``showUUIDs=true`` option.
 
 ``roundrobin``
 ~~~~~~~~~~~~~~
index 103d45e182519074ea454e5b48ea99d31c923e8d..b7faaa515a5c412a42dba13592b4b23ed2336e97 100644 (file)
@@ -321,7 +321,7 @@ Servers
 
     newServer({
       address="IP:PORT",     -- IP and PORT of the backend server (mandatory)
-      id=STRING              -- Use a pre-defined UUID instead of a random one
+      id=STRING,             -- Use a pre-defined UUID instead of a random one
       qps=NUM,               -- Limit the number of queries per second to NUM, when using the `firstAvailable` policy
       order=NUM,             -- The order of this server, used by the `leastOustanding` and `firstAvailable` policies
       weight=NUM,            -- The weight of this server, used by the `wrandom`, `whashed` and `chashed` policies, default: 1