From: Tomek Mrugalski <tomasz@isc.org>
Date: Mon, 23 Nov 2015 17:37:57 +0000 (+0100)
Subject: [master] Merge branch 'trac3990' (User's Guide update for Decline)
X-Git-Tag: trac4204fd_base~10
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=6b0db91610420f3cce55d9f887d7c73660ece209;p=thirdparty%2Fkea.git

[master] Merge branch 'trac3990' (User's Guide update for Decline)
---

6b0db91610420f3cce55d9f887d7c73660ece209
diff --cc doc/guide/dhcp4-srv.xml
index 8d6d4a7ed5,db25f57284..e4a9c16094
--- a/doc/guide/dhcp4-srv.xml
+++ b/doc/guide/dhcp4-srv.xml
@@@ -2965,11 -3014,71 +3011,70 @@@ It is merely echoed by the serve
                given subnet.  This statistic increases every time a new lease is
                allocated (as a result of receiving a DHCPREQUEST message) and is
                decreased every time a lease is released (a DHCPRELEASE message is
 -              received). When lease expiration is implemented (planned for Kea
 -              1.0), it will also decrease when a lease is expired. The
 -              <emphasis>id</emphasis> is the subnet-id of a given subnet. This
 -              statistic is exposed for each subnet separately. This statistic is
 -              reset during reconfiguration event.</entry>
 +              received) or expires. The <emphasis>id</emphasis> is the subnet-id
 +              of a given subnet. This statistic is exposed for each subnet
 +              separately. This statistic is reset during reconfiguration event.
 +              </entry>
              </row>
+ 
+             <row>
+             <entry>declined-addresses</entry>
+             <entry>integer</entry>
+             <entry>
+               This statistic shows the number of IPv4 adresses that are
+               currently declined. This statistic counts the number of leases
+               currently unavailable. Once a lease is recovered, this
+               statistic will be decreased. Ideally, this statistic should be
+               zero. If this statistic is non-zero (or worse increasing),
+               a network administrator should investigate if there is
+               a misbehaving device in his network. This is a global statistic
+               that covers all subnets.
+             </entry>
+             </row>
+ 
+             <row>
+             <entry>subnet[id].declined-addresses</entry>
+             <entry>integer</entry>
+             <entry>
+               This statistic shows the number of IPv4 adresses that are
+               currently declined in a given subnet. This statistic counts the
+               number of leases currently unavailable. Once a lease is
+               recovered, this statistic will be decreased. Ideally, this
+               statistic should be zero. If this statistic is
+               non-zero (or worse increasing), a network administrator should
+               investigate if there is a misbehaving device in his network. The
+               <emphasis>id</emphasis> is the subnet-id of a given subnet. This
+               statistic is exposed for each subnet separately.
+             </entry>
+             </row>
+ 
+             <row>
+             <entry>reclaimed-declined-addresses</entry>
+             <entry>integer</entry>
+             <entry>
+               This statistic shows the number of IPv4 adresses that were
+               declined, but have now been recovered. Unlike
+               declined-addresses, this statistic never decreases. It can be used
+               as a long term indicator of how many actual valid Declines were
+               processed and recovered from. This is a global statistic that
+               covers all subnets.
+             </entry>
+             </row>
+ 
+             <row>
+             <entry>subnet[id].reclaimed-declined-addresses</entry>
+             <entry>integer</entry>
+             <entry>
+               This statistic shows the number of IPv4 adresses that were
+               declined, but have now been recovered. Unlike
+               declined-addresses, this statistic never decreases. It can be used
+               as a long term indicator of how many actual valid Declines were
+               processed and recovered from. The
+               <emphasis>id</emphasis> is the subnet-id of a given subnet. This
+               statistic is exposed for each subnet separately.
+             </entry>
+             </row>
+ 
          </tbody>
          </tgroup>
          </table>