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

[#2757] Revamped ARM on new command

Browse Source 
modified:
    doc/sphinx/arm/hooks-lease-query.rst
This commit is contained in:
Thomas Markwalder
2023-05-23 09:47:47 -04:00
parent fa2b7d5318
commit 80a289f949
1 changed files with 47 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

53
doc/sphinx/arm/hooks-lease-query.rst
View File

@@ -446,15 +446,56 @@ defined in RFC 6607.
The new query types are only supported with the memfile lease backend.
.. _updating-existing-leases:
Updating existing leases in SQL lease backends
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Bulk Lease Query required additions to the lease data stored. With SQL lease
backends, leases created prior to the server being configured for Bulk Lease
Query will not contain the new data required. In order to populate this data
it is necessary to run an API command:
.. _command-extended-info4-upgrade:
The ``extended-info4-upgrade`` Command
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
For DHCPv4 lease data, the command is:
With SQL lease database backends the relay and remote IDs are in new columns
so to make old leases (old means from an older Kea version) visible to
the hook library the lease database must be upgraded. This is the function
of the ``extended-info4-upgrade`` command.
::
{
"command": "extended-info4-upgrade"
}
For DHCPv6 lease data, the command is (TO BE IMPLEMENTED):
::
{
"command": "extended-info6-upgrade"
}
In either case the response will indicate whether it succeeded or failed
and include either the count of leases updated or the nature of the failure:
::
{
"result": 0,
"text": "Upgraded 1000 leases"
}
The command's operation is governed by ``extended-info-checks`` parameter
under the sanity-checks element. Please see :ref:`sanity-checks4` or
:ref:`sanity-checks6`.
For large numbers of leases this command may take some time to complete.
.. note::
Existing leases must have been created by Kea with ``store-extended-info``
enabled in order for the new data to be extracted and stored.
.. _bulk-lease-query-dhcpv6: