{#1548] Documented new ddns4/6_update hook points

src/bin/dhcp4/dhcp4_hooks.dox
src/bin/dhcp6/dhcp6_hooks.dox

2 files changed, 68 insertions, 0 deletions

diff --git a/src/bin/dhcp4/dhcp4_hooks.dox b/src/bin/dhcp4/dhcp4_hooks.dox
index 5d9774e98a..120cfb7bc3 100644
--- a/src/bin/dhcp4/dhcp4_hooks.dox
+++ b/src/bin/dhcp4/dhcp4_hooks.dox
@@ -250,6 +250,40 @@ called before "subnet4_select".
    marked this lease as unavailable. If the client restarts its configuration,
    it will get the same (not declined) lease as a result.
 
+@subsection dhcpv4HooksDdns4Update ddns4_update
+
+ - @b Arguments:
+   - name: @b query4, type: isc::dhcp::Pkt4Ptr, direction: <b>in</b>
+   - name: @b response4, type: isc::dhcp::Pkt4Ptr, direction: <b>in</b>
+   - name: @b subnet4, type: isc::dhcp::Subnet4Ptr, direction: <b>in</b>
+   - name: @b hostname, type: std::string, direction: <b>in/out</b>
+   - name: @b fwd_update, type: bool, direction: <b>in/out</b>
+   - name: @b rev_update, type: bool, direction: <b>in/out</b>
+   - name: @b ddns_params, type: isc::dhcp::DdnsParamsPtr, direction: <b>in</b>
+
+ - @b Description: this callout is executed after the server has selected
+   a lease and has formed a host name to associate with the lease and/or use
+   as the basis for the FQDN for DNS updates (if enabled), but before the
+   lease has been committed or any NameChangeRequests have been generated to
+   send to <b>kea-dhcp-ddns</b>.  Thus it provides an opportunity to alter the
+   host name as well as whether or not forward and/or reverse updates are
+   enabled.
+
+   Upon entry into the callout, the arguments <b>hostname</b>,<b>fwd_udpate</b>,
+   and <b>rev_udpate</b> have been set by the server based on the client packet,
+   and various configuration values (e.g host reservations, DDNS behaviorial
+   parameters, etc).  Upon return from the callout, any changes to these
+   values will be applied as follows:
+   - If <b>hostname</b> has changed it will be used to update the
+   outbound host name (option 12) if it exists, the output FQDN option
+   (option 81) if it exists, and used as the FQDN sent in DNS updates
+   - Forward DNS update(s) will be done if <b>fwd_udpate</b> is true (and
+  <b>kea-dhcp-ddns</b> connectivity is enabled)
+   - Reverse DNS update(s) will be done if <b>rev_udpate</b> is true (and
+  <b>kea-dhcp-ddns</b> connectivity is enabled)
+
+ - <b>Next step status</b>: Not applicable, its value will be ignored.
+
 @subsection dhcpv4Leases4Committed leases4_committed
 
  - @b Arguments:
diff --git a/src/bin/dhcp6/dhcp6_hooks.dox b/src/bin/dhcp6/dhcp6_hooks.dox
index f921370bea..3984ce8fb0 100644
--- a/src/bin/dhcp6/dhcp6_hooks.dox
+++ b/src/bin/dhcp6/dhcp6_hooks.dox
@@ -301,6 +301,40 @@ called before "subnet6_select".
    remain in the database until it expires. However, the server will send out
    the response back to the client as if it did.
 
+@subsection dhcpv6HooksDdns6Update ddns6_update
+
+ - @b Arguments:
+   - name: @b query6, type: isc::dhcp::Pkt6Ptr, direction: <b>in</b>
+   - name: @b response6, type: isc::dhcp::Pkt6Ptr, direction: <b>in</b>
+   - name: @b subnet6, type: isc::dhcp::Subnet6Ptr, direction: <b>in</b>
+   - name: @b hostname, type: std::string, direction: <b>in/out</b>
+   - name: @b fwd_update, type: bool, direction: <b>in/out</b>
+   - name: @b rev_update, type: bool, direction: <b>in/out</b>
+   - name: @b ddns_params, type: isc::dhcp::DdnsParamsPtr, direction: <b>in</b>
+
+ - @b Description: this callout is executed after the server has selected
+   a lease and has formed a host name to associate with the lease and/or use
+   as the basis for the FQDN for DNS updates (if enabled), but before the
+   lease has been committed or any NameChangeRequests have been generated to
+   send to <b>kea-dhcp-ddns</b>.  Thus it provides an opportunity to alter the
+   host name as well as whether or not forward and/or reverse updates are
+   enabled.
+
+   Upon entry into the callout, the arguments <b>hostname</b>,<b>fwd_udpate</b>,
+   and <b>rev_udpate</b> have been set by the server based on the client packet,
+   and various configuration values (e.g host reservations, DDNS behaviorial
+   parameters, etc).  Upon return from the callout, any changes to these
+   values will be applied as follows:
+   - If <b>hostname</b> has changed it will be used to update the outbound FQDN
+   option (option 39) if it exists, and used as the FQDN sent
+   in DNS updates
+   - Forward DNS update(s) will be done if <b>fwd_udpate</b> is true (and
+  <b>kea-dhcp-ddns</b> connectivity is enabled)
+   - Reverse DNS update(s) will be done if <b>rev_udpate</b> is true (and
+  <b>kea-dhcp-ddns</b> connectivity is enabled)
+
+ - <b>Next step status</b>: Not applicable, its value will be ignored.
+
 @subsection dhcpv6Leases6Committed leases6_committed
 
  - @b Arguments: