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

[#3773] updated documentation about delta-add commands

Browse Source
This commit is contained in:
Razvan Becheriu
2025-03-27 09:24:31 +02:00
parent 83f7a592a8
commit 4a31117f56
1 changed files with 21 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
doc/sphinx/arm/hooks-subnet-cmds.rst
View File

@@ -620,6 +620,11 @@ that static host reservations cannot be specified within
:isccmd:`subnet4-delta-add`. The commands described in :ref:`hooks-host-cmds` should :isccmd:`subnet4-delta-add`. The commands described in :ref:`hooks-host-cmds` should
be used to update, remove, and modify static reservations. be used to update, remove, and modify static reservations.
The command uses keys to identify the respective object. The keys can not be updated.
Objects must first be deleted in order to add other objects with conflicting keys.
The address pools are identified by the 'pool' parameter, the options are identified
by the 'name' or 'code', and 'space' parameters.
:: ::
{ {
@@ -677,8 +682,8 @@ The response to this command has the following structure:
The command updates subnet "10.20.30.0/24" with id 123 by changing the valid The command updates subnet "10.20.30.0/24" with id 123 by changing the valid
lifetime, adding or changing the subnet level option 3 ("routers"), by adding lifetime, adding or changing the subnet level option 3 ("routers"), by adding
or changing the pool "10.20.30.1-10.20.30.10" and by adding or changing the pool or changing parameters of the pool "10.20.30.1-10.20.30.10" and by adding or
level option 4 ("time-servers"). changing the pool level option 4 ("time-servers").
.. isccmd:: subnet6-delta-add .. isccmd:: subnet6-delta-add
.. _command-subnet6-delta-add: .. _command-subnet6-delta-add:
@@ -698,6 +703,12 @@ that static host reservations cannot be specified within
:isccmd:`subnet6-delta-add`. The commands described in :ref:`hooks-host-cmds` should :isccmd:`subnet6-delta-add`. The commands described in :ref:`hooks-host-cmds` should
be used to update, remove, and modify static reservations. be used to update, remove, and modify static reservations.
The command uses keys to identify the respective object. The keys can not be updated.
Objects must first be deleted in order to add other objects with conflicting keys.
The address pools are identified by the 'pool' parameter, the prefix pools are identified
by the 'prefix', 'prefix-len' and 'delegated-len' parameters, the options are identified
by the 'name' or 'code', and 'space' parameters.
:: ::
{ {
@@ -772,10 +783,10 @@ The response to this command has the following structure:
The command updates subnet "2001:db8:1::/64" with id 243 by changing the valid The command updates subnet "2001:db8:1::/64" with id 243 by changing the valid
lifetime, adding or changing the subnet level option 23 ("dns-servers"), by lifetime, adding or changing the subnet level option 23 ("dns-servers"), by
adding or changing the pool "2001:db8:1::1-2001:db8:1::10", by adding or adding or changing parameters of the pool "2001:db8:1::1-2001:db8:1::10", by
changing the pool level option 31 ("sntp-servers"), by adding or changing the adding or changing the pool level option 31 ("sntp-servers"), by adding or
pd-pool "2001:db8:2::" with prefix-len 48 and by adding or changing the pd-pool changing parameters of the pd-pool "2001:db8:2::" with prefix-len 48 and by adding
level option 22 ("sip-server-addr"). or changing the pd-pool level option 22 ("sip-server-addr").
.. isccmd:: subnet4-delta-del .. isccmd:: subnet4-delta-del
.. _command-subnet4-delta-del: .. _command-subnet4-delta-del:
@@ -798,7 +809,7 @@ be used to update, remove, and modify static reservations.
The command is flexible and can delete the part of the subnet by either The command is flexible and can delete the part of the subnet by either
specifying the entire object that needs to be deleted, or just the keys specifying the entire object that needs to be deleted, or just the keys
identifying the respective object. The address pools are identified by the identifying the respective object. The address pools are identified by the
'pool' parameter, the options are identified by the 'name' or 'code' and 'pool' parameter, the options are identified by the 'name' or 'code', and
'space' parameters. The 'space' parameter can be omitted if the option belongs 'space' parameters. The 'space' parameter can be omitted if the option belongs
to the default 'dhcp4' space. to the default 'dhcp4' space.
@@ -875,9 +886,9 @@ be used to update, remove, and modify static reservations.
The command is flexible and can delete the part of the subnet by either The command is flexible and can delete the part of the subnet by either
specifying the entire object that needs to be deleted, or just the keys specifying the entire object that needs to be deleted, or just the keys
identifying the respective object. The address pools are identified by the identifying the respective object. The address pools are identified by the
'pool' parameter, the prefix pools are identified by the "prefix", "prefix-len" 'pool' parameter, the prefix pools are identified by the 'prefix', 'prefix-len'
and "delegated-len" parameters, the options are identified by the 'name' or and 'delegated-len' parameters, the options are identified by the 'name' or
'code' and 'space' parameters. The 'space' parameter can be omitted if the 'code', and 'space' parameters. The 'space' parameter can be omitted if the
option belongs to the default 'dhcp6' space. option belongs to the default 'dhcp6' space.
.. code-block:: json .. code-block:: json