- Premium libraries were marked as subscription libraries.
That has also been fixed.
.. note::
- :ischooklib:`libdhcp_cb_cmds.so` is available only to ISC support subscribers.
- For more information on subscription options, please complete the form
- at https://www.isc.org/contact.
-
+ :ischooklib:`libdhcp_cb_cmds.so` is 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.
The schema creation scripts can be found at `dhcpdb_create.mysql <https://gitlab.isc.org/isc-projects/kea/blob/master/src/share/database/scripts/mysql/dhcpdb_create.mysql>`__ and
;
required by the particular Kea version using the :iscman:`kea-admin` tool,
as described in :ref:`kea-admin`.
-:ischooklib:`libdhcp_cb_cmds.so`, which is available to ISC's paid support
-customers, provides a complete set of commands to manage the
+:ischooklib:`libdhcp_cb_cmds.so` provides a complete set of commands to manage the
servers' configuration information within the database. This library can
be attached to both DHCPv4 and DHCPv6 server instances. While it is
possible to manage the configuration information without :ischooklib:`libdhcp_cb_cmds.so`
the server's responses; responses shorter than the BOOTP minimum
size of 300 octets are padded to this size.
-This open source library is loaded
-similarly to other hook libraries by the :iscman:`kea-dhcp4` process, and
+.. note::
+
+ :ischooklib:`libdhcp_bootp.so` is part of the open source code and is
+ available to every Kea user.
+
+.. note::
+
+ This library can only be loaded by the :iscman:`kea-dhcp4` process,
+ as there is no BOOTP protocol for IPv6.
+
+This library is loaded similarly to other hook libraries, and
it takes no parameters.
::
]
}
-
-.. note::
-
- This library can only be loaded by the :iscman:`kea-dhcp4` process,
- as there is no BOOTP protocol for IPv6.
-
.. note::
A host reservation for a BOOTP client should use the hardware address
use with a MySQL or PostgreSQL database can be found in the :ref:`dhcp4-cb`
and :ref:`dhcp6-cb` sections.
-:ischooklib:`libdhcp_cb_cmds.so` is only available to ISC customers with a paid
-support contract.
+.. note::
+
+ :ischooklib:`libdhcp_cb_cmds.so` is 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.
.. note::
- This library may only be loaded by the :iscman:`kea-dhcp4` or
+ This library can only be loaded by the :iscman:`kea-dhcp4` or
:iscman:`kea-dhcp6` process.
.. note::
will use the first backend listed in the ``config-control`` map within
the configuration of the server receiving the command.
-:ischooklib:`libdhcp_cb_cmds.so` is only available to ISC customers with a paid
-support contract.
-
-.. note::
-
- This library can only be loaded by the :iscman:`kea-dhcp4` or
- :iscman:`kea-dhcp6` process.
-
-.. note::
-
- Please read about :ref:`cb-limitations` before using the commands
- described in this section.
-
.. note::
In the current Kea release, it is only possible to configure the Kea server
implement the API to create, read, update, and delete (CRUD) the
configuration in a MySQL database. Please see :ref:`hooks-cb-cmds`
for more details.
+
+.. note::
+
+ :ischooklib:`libdhcp_mysql_cb.so` is part of the open source code and is
+ available to every Kea user, but it requires :ischooklib:`libdhcp_cb_cmds.so`
+ which is 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.
implement the API to create, read, update, and delete (CRUD) the
configuration in a PostgreSQL database. Please see :ref:`hooks-cb-cmds`
for more details.
+
+.. note::
+
+ :ischooklib:`libdhcp_pgsql_cb.so` is part of the open source code and is
+ available to every Kea user, but it requires :ischooklib:`libdhcp_cb_cmds.so`
+ which is 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.
servers. Using these commands it is possible to add, update, delete, and
list the client classes configured for a given server.
+.. note::
+
+ :ischooklib:`libdhcp_class_cmds.so` is 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.
+
.. note::
This library can only be loaded by the :iscman:`kea-dhcp4` or
:iscman:`kea-dhcp6` process.
-:ischooklib:`libdhcp_class_cmds.so` is only available to ISC customers with a
-paid support contract.
-
.. isccmd:: class-add
.. _command-class-add:
It currently supports procedural host-name generation and the ability to skip
performing DDNS updates for select clients.
-The DDNS Tuning hook library is only available to ISC customers with a paid
-support contract.
+.. note::
+
+ :ischooklib:`libdhcp_ddns_tuning.so` is available as a premium
+ hook library from ISC. Please visit https://www.isc.org/shop/ to purchase
+ the premium hook libraries, or contact us at https://www.isc.org/contact for
+ more information.
The library, which was added in Kea 2.1.5, can be loaded by the :iscman:`kea-dhcp4`
and :iscman:`kea-dhcp6` daemons by adding it to the ``hooks-libraries`` element of the
several options and fields to uniquely identify a client. Those
scenarios are addressed by the Flexible Identifiers hook application.
-The Flexible Identifier library is only available to ISC customers with a paid support
-contract.
+.. note::
+
+ :ischooklib:`libdhcp_flex_id.so` is available as a premium
+ hook library from ISC. Please visit https://www.isc.org/shop/ to purchase
+ the premium hook libraries, or contact us at https://www.isc.org/contact for
+ more information.
.. note::
before it is sent to the client. The three actions currently supported are
``add``, ``supersede``, and ``remove``.
+.. note::
+
+ :ischooklib:`libdhcp_flex_option.so` is part of the open source code and is
+ available to every Kea user.
+
The syntax used for the action expressions is the same syntax used
for client classification and the Flexible Identifier hook library;
see either :ref:`classification-using-expressions` or :ref:`hooks-flex-id`
This hook library allows the :iscman:`kea-dhcp-ddns` server to use
GSS-TSIG to sign DNS updates. For a full discussion of GSS-TSIG in Kea,
please see :ref:`gss-tsig`.
+
+.. note::
+
+ :ischooklib:`libddns_gss_tsig.so` is 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.
This hook library can be loaded on a pair of DHCPv4 or DHCPv6 servers, to
increase the reliability of the DHCP service in the event of an outage on one
-server. This library was previously only available to ISC's paid subscribers,
-but is now part of the open source Kea, available to all users.
+server.
+
+.. note::
+
+ :ischooklib:`libdhcp_ha.so` is part of the open source code and is
+ available to every Kea user. It was previously available only to ISC
+ customers with a paid support contract.
.. note::
caching, i.e. the ability to remember that there is no client
information in the database.
+.. note::
+
+ :ischooklib:`libdhcp_host_cache.so` is 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.
+
.. note::
This library can only be loaded by the :iscman:`kea-dhcp4` or
channel (JSON over UNIX sockets) and the Control Agent (JSON over a RESTful
interface).
-This library is only available to ISC customers with a paid support
-contract.
+.. note::
+
+ :ischooklib:`libdhcp_host_cmds.so` is available as a premium
+ hook library from ISC. Please visit https://www.isc.org/shop/ to purchase
+ the premium hook libraries, or contact us at https://www.isc.org/contact for
+ more information.
.. note::
provides a non-programmatic way to manage user contexts associated with
leases.
-The Lease Commands library is part of the open source code and is
-available to every Kea user.
+.. note::
+
+ :ischooklib:`libdhcp_lease_cmds.so` is part of the open source code and is
+ available to every Kea user.
.. note::
`RFC 4388 <https://tools.ietf.org/html/rfc4388>`__; and for DHCPv6
Leasequery as described in (`RFC 5007 <https://tools.ietf.org/html/rfc5007>`__).
+.. note::
+
+ :ischooklib:`libdhcp_lease_query.so` is 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.
+
.. note::
This library can only be loaded by the :iscman:`kea-dhcp4` or
(`RFC 6926 <https://tools.ietf.org/html/rfc6926>`__) using
the memfile lease backend.
-The Leasequery library is only available to ISC customers with a paid support contract.
-
.. _lease-query-dhcpv4:
DHCPv4 Leasequery
hooks that record a detailed log of assignments, renewals, releases, and other
lease events into a set of log files.
-Currently this library is only available to ISC customers with a paid support
-contract.
+.. note::
+
+ :ischooklib:`libdhcp_legal_log.so` is available as a premium
+ hook library from ISC. Please visit https://www.isc.org/shop/ to purchase
+ the premium hook libraries, or contact us at https://www.isc.org/contact for
+ more information.
.. note::
- This library may only be loaded by the :iscman:`kea-dhcp4` or :iscman:`kea-dhcp6`
+ This library can only be loaded by the :iscman:`kea-dhcp4` or :iscman:`kea-dhcp6`
process.
In many legal jurisdictions, companies - especially ISPs - must record
1. Lease limiting: allow a maximum of ``n`` leases assigned at any one time.
2. Rate limiting: allow a maximum of ``n`` packets per ``time_unit`` to receive a response.
-The Limits hook library is only available to ISC customers with a paid support contract.
+.. note::
+
+ :ischooklib:`libdhcp_limits.so` is 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.
.. _hooks-limits-configuration:
attributes. As such, the alternative looks more appealing: to extend the
DHCP server to talk to RADIUS directly. That is the goal of this library.
+.. note::
+
+ :ischooklib:`libdhcp_radius.so` is 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.
+
.. note::
This library can only be loaded by the :iscman:`kea-dhcp4` or the
request processing (when the request was accepted).
- Request filters are applied to the response.
+.. note::
+
+ :ischooklib:`libca_rbac.so` is 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.
+
.. _hooks-RBAC-config:
Role-Based Access Control Configuration
The Run Script hook library adds support for calling an external script for specific
packet-processing hook points.
+.. note::
+
+ :ischooklib:`libdhcp_run_script.so` is part of the open source code and is
+ available to every Kea user.
+
The library, which was added in Kea 1.9.5, can be loaded in a
similar way to other hook libraries by the :iscman:`kea-dhcp4` and
:iscman:`kea-dhcp6` processes.
of subnets, or all subnets. Finally, this library provides commands
for retrieving these statistics.
+.. note::
+
+ :ischooklib:`libdhcp_stat_cmds.so` is part of the open source code and is
+ available to every Kea user.
+
.. note::
This library can only be loaded by the :iscman:`kea-dhcp4` or
via either the control channel (see :ref:`ctrl-channel`) or the
Control Agent (see :ref:`kea-ctrl-agent`).
-This library may be loaded by both the :iscman:`kea-dhcp4` and :iscman:`kea-dhcp6` servers. It
-is loaded in the same way as other libraries and currently has no
+This library is loaded in the same way as other libraries and currently has no
parameters:
::
}
In a deployment with multiple Kea DHCP servers sharing a common lease
-storage, this hook library may be loaded by any or all of the servers. However,
+storage, this hook library can be loaded by any or all of the servers. However,
a server's response to a :isccmd:`stat-lease4-get` / :isccmd:`stat-lease6-get`
command will only contain data for subnets known to
that server. In other words, if a subnet does not appear in a server's
new ones, removing existing ones, and adding subnets to and removing them from
shared networks) is also provided.
-This library is only available to ISC customers with a paid support
-contract.
+.. note::
+
+ :ischooklib:`libdhcp_subnet_cmds.so` is 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.
.. note::
- To serve as a demonstration of various capabilities possible using
the hooks interface.
-This library is part of the Kea open source and is available to all users.
+.. note::
+
+ :ischooklib:`libdhcp_user_chk.so` is part of the open source code and is
+ available to every Kea user.
Once loaded, the library allows the separation of incoming requests into known
and unknown clients. For known clients, packets are processed
projects / thirdparty / kea.git / commitdiff
