mir/kea
2
0
Fork 0
mirror of https://gitlab.isc.org/isc-projects/kea synced 2025-08-28 20:47:48 +00:00
Code Issues Releases Wiki Activity

[#3012] Add initial ping-check ARM doc

Browse Source 
new file:   doc/sphinx/arm/hooks-ping-check.rst
modified:   doc/sphinx/arm/hooks.rst
modified:   doc/sphinx/conf.py
This commit is contained in:
Thomas Markwalder 2023-08-17 14:58:34 -04:00
parent 5f1b3e2e24
commit e2f1add8c4
3 changed files with 24 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
doc/sphinx/arm/hooks-ping-check.rst Normal file
View File

@ -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.

6
doc/sphinx/arm/hooks.rst
View File

@ -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

1
doc/sphinx/conf.py
View File

@ -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',