summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTomek Mrugalski <tomek@isc.org>2024-05-22 12:48:27 +0200
committerTomek Mrugalski <tomek@isc.org>2024-05-23 15:44:25 +0200
commit9e45480322e971f15846cac17e043cd3f072675a (patch)
treec51a958062fdc7b806e741c9d80e18a8e42d537b
parent[#3340] Error message corrected (diff)
downloadkea-9e45480322e971f15846cac17e043cd3f072675a.tar.xz
kea-9e45480322e971f15846cac17e043cd3f072675a.zip
[#3340] ARM for lease6-del updated
-rw-r--r--doc/sphinx/arm/hooks-lease-cmds.rst18
1 files changed, 16 insertions, 2 deletions
diff --git a/doc/sphinx/arm/hooks-lease-cmds.rst b/doc/sphinx/arm/hooks-lease-cmds.rst
index 8c7b444ba0..4a0bafb016 100644
--- a/doc/sphinx/arm/hooks-lease-cmds.rst
+++ b/doc/sphinx/arm/hooks-lease-cmds.rst
@@ -472,7 +472,7 @@ for an IPv6 lease is:
::
{
- "command": "lease4-get",
+ "command": "lease6-get",
"arguments": {
"identifier-type": "duid",
"identifier": "08:08:08:08:08:08",
@@ -816,7 +816,7 @@ a pair of values: the type and the actual identifier. The currently
supported identifiers are ``"hw-address"`` (IPv4 only), ``"client-id"`` (IPv4
only), and ``"duid"`` (IPv6 only).
-An example command for deleting a lease by address is:
+An example command for deleting an IPv4 lease by address is:
::
@@ -840,6 +840,20 @@ An example IPv4 lease deletion by ``"hw-address"`` is:
}
}
+The IPv6 address leases are deleted the same way, but using :isccmd:`lease6-del`. The
+prefix IPv6 leases are also deleted using :isccmd:`lease6-del`, but with some extra
+steps. The prefix should be referenced by its address and prefix length should be ignored.
+For example, to delete 2001:db8:1::/48, the following command can be used:
+
+::
+ {
+ "command": "lease6-del",
+ "arguments": {
+ "ip-address": "2001:db8:1::",
+ "type": "IA_PD",
+ "subnet-id": 1
+ }
+ }
Another parameter called ``update-ddns``, when ``true``, instructs the server to
queue a request to :iscman:`kea-dhcp-ddns` to remove DNS entries after the lease is