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

[#3426] updated docs about extended-info4/6-upgrade commands

Browse Source
This commit is contained in:
Wlodzimierz Wencel
2024-05-24 10:24:07 +00:00
parent ed6a007cb7
commit d34bcdcc15
1 changed files with 12 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -613,6 +613,12 @@ backends, leases created prior to the server being configured for bulk lease
query do not contain the new data required. In order to populate this data, query do not contain the new data required. In order to populate this data,
it is necessary to run these API commands: it is necessary to run these API commands:
.. note::
Existing leases must have been created by Kea with ``store-extended-info``
enabled, in order for the new data from extended info to be extracted
and stored.
.. isccmd:: extended-info4-upgrade .. isccmd:: extended-info4-upgrade
.. _command-extended-info4-upgrade: .. _command-extended-info4-upgrade:
@@ -651,7 +657,8 @@ and includes either the count of leases updated or the nature of the failure:
This ``extended-info6-upgrade`` command must be called when: This ``extended-info6-upgrade`` command must be called when:
- the database schema was upgraded from a previous version. - the database schema was upgraded from 2.4.1 or older version.
``extended-info4-upgrade`` can be used when upgrading from 2.3.8 or older version.
- Bulk Leasequery was not enabled; tables are maintained only when v6 BLQ is - Bulk Leasequery was not enabled; tables are maintained only when v6 BLQ is
enabled. enabled.
@@ -668,7 +675,7 @@ For large numbers of leases, this command may take some time to complete.
.. note:: .. note::
Existing leases must have been created by Kea with ``store-extended-info`` Both the ``extended-info4-upgrade`` and ``extended-info6-upgrade`` commands
enabled, in order for the new data from extended info to be extracted are intended for one-time use after upgrading to a version of Kea that fully
and stored. supports Bulk Leasequery in database backends. These commands are not meant
for regular use and will be removed in future Kea versions.