mir/kea
2
0
Fork 0
mirror of https://gitlab.isc.org/isc-projects/kea synced 2025-09-02 15:05:16 +00:00
Code Issues Releases Wiki Activity

[#3001] fixed references to hooks libs in ARM

Browse Source
This commit is contained in:
Razvan Becheriu
2023-08-15 06:36:11 +03:00
parent 12880ca946
commit c4014a6ee1
6 changed files with 15 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
doc/sphinx/arm/agent.rst
View File

@@ -83,7 +83,7 @@ The following example demonstrates the basic CA configuration.
"hooks-libraries": [ "hooks-libraries": [
{ {
"library": "/opt/local/control-agent-commands.so", "library": "/opt/local/custom_hooks_example.so",
"parameters": { "parameters": {
"param1": "foo" "param1": "foo"
} }

6
doc/sphinx/arm/config-backend.rst
View File

@@ -131,11 +131,11 @@ in two independent configuration sources.
.. note:: .. note::
It is recommended that :ischooklib:`libsubnet_cmds.so` not be used to It is recommended that :ischooklib:`libdhcp_subnet_cmds.so` not be used to
manage subnets when the configuration backend is used as a source manage subnets when the configuration backend is used as a source
of information about the subnets. :ischooklib:`libsubnet_cmds.so` of information about the subnets. :ischooklib:`libdhcp_subnet_cmds.so`
modifies the local subnets configuration in the server's memory, modifies the local subnets configuration in the server's memory,
not in the database. Use :ischooklib:`libcb_cmds.so` to manage the not in the database. Use :ischooklib:`libdhcp_cb_cmds.so` to manage the
subnets information in the database instead. subnets information in the database instead.
.. note:: .. note::

2
doc/sphinx/arm/ext-netconf.rst
View File

@@ -616,7 +616,7 @@ Kea sources.
// The hook libraries list may contain more than one library. // The hook libraries list may contain more than one library.
{ {
// The only necessary parameter is the library filename. // The only necessary parameter is the library filename.
"library": "/opt/local/netconf-commands.so", "library": "/opt/local/custom_hooks_example.so",
// Some libraries may support parameters. Make sure you // Some libraries may support parameters. Make sure you
// type this section carefully, as kea-netconf does not // type this section carefully, as kea-netconf does not

2
doc/sphinx/arm/hooks-host-cache.rst
View File

@@ -41,7 +41,7 @@ any other hook library; for example, this configuration could be used:
"hooks-libraries": [ "hooks-libraries": [
{ {
"library": "/usr/local/lib/kea/hooks/libdhc_host_cache.so", "library": "/usr/local/lib/kea/hooks/libdhcp_host_cache.so",
"parameters": { "parameters": {
# Tells Kea to never cache more than 1000 hosts. # Tells Kea to never cache more than 1000 hosts.

2
doc/sphinx/arm/hooks-host-cmds.rst
View File

@@ -59,7 +59,7 @@ modify data stored in the host database, the hosts database must be specified
and it must not operate in read-only mode (for details, see the and it must not operate in read-only mode (for details, see the
``hosts-databases`` descriptions in :ref:`hosts-databases-configuration4` and ``hosts-databases`` descriptions in :ref:`hosts-databases-configuration4` and
:ref:`hosts-databases-configuration6`). If the ``hosts-databases`` are not :ref:`hosts-databases-configuration6`). If the ``hosts-databases`` are not
specified or are running in read-only mode, :ischooklib:`libhost_cmds.so` will specified or are running in read-only mode, :ischooklib:`libdhcp_host_cmds.so` will
load, but any attempts to use :isccmd:`reservation-add`, :isccmd:`reservation-del`, and load, but any attempts to use :isccmd:`reservation-add`, :isccmd:`reservation-del`, and
:isccmd:`reservation-update` to modify data in that database will fail. :isccmd:`reservation-update` to modify data in that database will fail.

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

@@ -191,10 +191,10 @@ configuration would be:
: :
"hooks-libraries": [ "hooks-libraries": [
{ {
"library": "/opt/charging.so" "library": "/opt/first_custom_hooks_example.so"
}, },
{ {
"library": "/opt/local/notification.so", "library": "/opt/local/second_custom_hooks_example.so",
"parameters": { "parameters": {
"mail": "spam@example.com", "mail": "spam@example.com",
"floor": 13, "floor": 13,
@@ -220,12 +220,12 @@ Libraries may have additional parameters that are not mandatory, in the
sense that there may be libraries that do not require them. However, for any sense that there may be libraries that do not require them. However, for any
given library there is often a requirement to specify a certain given library there is often a requirement to specify a certain
set of parameters. Please consult the documentation for each individual library for set of parameters. Please consult the documentation for each individual library for
details. In the example above, the first library (``/opt/charging.so``) has no parameters. The details. In the example above, the first library (``/opt/first_custom_hooks_example.so``)
second library (``/opt/local/notification.so``) has five parameters: specifying mail (string parameter), has no parameters. The second library (``/opt/local/second_custom_hooks_example.so``)
floor (integer parameter), debug (boolean parameter), lists has five parameters: specifying mail (string parameter), floor (integer parameter),
(list of strings), and maps (containing strings). Nested parameters can debug (boolean parameter), lists (list of strings), and maps (containing strings).
be used if the library supports it. This topic is explained in detail in Nested parameters can be used if the library supports it. This topic is explained in detail
the `Hooks Developer's Guide section of the Kea Developer's Guide in the `Hooks Developer's Guide section of the Kea Developer's Guide
<https://reports.kea.isc.org/dev_guide/df/d46/hooksdgDevelopersGuide.html>`__. <https://reports.kea.isc.org/dev_guide/df/d46/hooksdgDevelopersGuide.html>`__.
Some hooks use user context to set the parameters. See :ref:`user-context-hooks`. Some hooks use user context to set the parameters. See :ref:`user-context-hooks`.