[#3012] Add initial ping-check ARM doc

new file:   doc/sphinx/arm/hooks-ping-check.rst
modified:   doc/sphinx/arm/hooks.rst
modified:   doc/sphinx/conf.py

diff --git a/doc/sphinx/arm/hooks-ping-check.rst b/doc/sphinx/arm/hooks-ping-check.rst
new file mode 100644 (file)
index 0000000..0e0a1b2
--- /dev/null
+++ b/doc/sphinx/arm/hooks-ping-check.rst
@@ -0,0 +1,17 @@
+.. ischooklib:: libdhcp_ping_check.so
+.. _hooks-ping-check:
+
+``libdhcp_ping_check.so``: Ping Check
+=====================================
+
+This hook library is under development and currently provides no functionality.
+Once complete it will provide :iscman:`kea-dhcp4` with the ability to carry out ping
+checks of candiate addresses prior to offering them in leases to clients.
+
+.. note::
+
+    libdhcp_ping_check.so will be available only to ISC customers with a paid support
+    contract. For more information on subscription options, please complete the form
+    at https://www.isc.org/contact.
+
+

diff --git a/doc/sphinx/arm/hooks.rst b/doc/sphinx/arm/hooks.rst
index 3ebfcca40db3fd832a8de5eb357d7b1bf224c0c8..36214b3993f5c55a43f86b68c6560aa3f754a64f 100644 (file)
--- a/doc/sphinx/arm/hooks.rst
+++ b/doc/sphinx/arm/hooks.rst
@@ -525,6 +525,11 @@ loaded by the correct process per the table below.
    |                                                           |              | which packets receive a response. The limit can be applied   |
    |                                                           |              | per-client class or per-subnet.                              |
    +-----------------------------------------------------------+--------------+--------------------------------------------------------------+
+   | :ref:`Ping Check <hooks-ping-check>`                      | ISC support  | With this hook library, :iscman:`kea-dhcp4` server can       |
+   |                                                           | customers    | perform ping checks of candidate lease addresses before      |
+   |                                                           |              | offering them to clients.                                    |
+   |                                                           |              | This library is under development and not yet functional.    |
+   +-----------------------------------------------------------+--------------+--------------------------------------------------------------+
    | :ref:`MySQL Configuration Backend <hooks-cb-mysql>`       | Kea open     | This hook library is an implementation of the Kea            |
    |                                                           | source       | Configuration Backend for MySQL. It uses a MySQL database as |
    |                                                           |              | a repository for the Kea configuration information. Kea      |
@@ -609,6 +614,7 @@ sections.
 .. include:: hooks-lease-query.rst
 .. include:: hooks-legal-log.rst
 .. include:: hooks-limits.rst
+.. include:: hooks-ping-check.rst
 .. include:: hooks-cb-mysql.rst
 .. include:: hooks-cb-pgsql.rst
 .. include:: hooks-radius.rst

diff --git a/doc/sphinx/conf.py b/doc/sphinx/conf.py
index 5095cf58ba9073e7f84b6f5890784e6b0325d210..30f7372d27e33ba49a3432fdad261297a83a92bf 100644 (file)
--- a/doc/sphinx/conf.py
+++ b/doc/sphinx/conf.py
@@ -95,6 +95,7 @@ exclude_patterns = [
     'arm/hooks-lease-cmds.rst',
     'arm/hooks-lease-query.rst',
     'arm/hooks-limits.rst',
+    'arm/hooks-ping-check.rst',
     'arm/hooks-radius.rst',
     'arm/hooks-rbac.rst',
     'arm/hooks-run-script.rst',