diff --git a/doc/sphinx/arm/hooks-ping-check.rst b/doc/sphinx/arm/hooks-ping-check.rst new file mode 100644 index 0000000000..0e0a1b2d75 --- /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 3ebfcca40d..36214b3993 100644 --- 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 ` | 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 ` | 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 5095cf58ba..30f7372d27 100644 --- 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',