[#3826] Implemented lease6-get-by-hw-address command.

Author: Razvan Becheriu

doc/sphinx/api-files.txt

@@ -61,6 +61,7 @@ src/share/api/lease6-del.json
 src/share/api/lease6-get.json
 src/share/api/lease6-get-all.json
 src/share/api/lease6-get-by-duid.json
+src/share/api/lease6-get-by-hw-address.json
 src/share/api/lease6-get-by-hostname.json
 src/share/api/lease6-get-page.json
 src/share/api/lease6-resend-ddns.json

doc/sphinx/arm/hooks-lease-cmds.rst

@@ -71,6 +71,9 @@ This library provides the following commands:
 -  :isccmd:`lease4-get-by-hw-address` - returns all IPv4 leases with the specified
    hardware address.
 
+-  :isccmd:`lease6-get-by-hw-address` - returns all IPv6 leases with the specified
+   hardware address.
+
 -  :isccmd:`lease4-get-by-client-id` - returns all IPv4 leases with the specified
    ``client-id``.
 
@@ -751,6 +754,9 @@ leases were found.
 .. isccmd:: lease4-get-by-hw-address
 .. _command-lease4-get-by-hw-address:
 
+.. isccmd:: lease6-get-by-hw-address
+.. _command-lease6-get-by-hw-address:
+
 .. isccmd:: lease4-get-by-client-id
 .. _command-lease4-get-by-client-id:
 

src/hooks/dhcp/lease_cmds/lease_cmds.cc

@@ -194,7 +194,7 @@ class LeaseCmdsImpl : private CmdsImpl {
     int
     leaseGetPageHandler(hooks::CalloutHandle& handle);
 
-    /// @brief lease4-get-by-hw-address command handler
+    /// @brief lease4-get-by-hw-address, lease6-get-by-hw-address command handler
     ///
     /// Provides the implementation for @ref isc::lease_cmds::LeaseCmds::leaseGetByHwAddressHandler
     ///
@@ -1576,8 +1576,10 @@ LeaseCmdsImpl::leaseGetPageHandler(CalloutHandle& handle) {
 
 int
 LeaseCmdsImpl::leaseGetByHwAddressHandler(CalloutHandle& handle) {
+    bool v4 = true;
     try {
         extractCommand(handle);
+        v4 = (cmd_name_ == "lease4-get-by-hw-address");
 
         // arguments must always be present
         if (!cmd_args_ || (cmd_args_->getType() != Element::map)) {
@@ -1597,16 +1599,28 @@ LeaseCmdsImpl::leaseGetByHwAddressHandler(CalloutHandle& handle) {
 
         HWAddr hwaddr = HWAddr::fromText(hw_address->stringValue());
 
-        Lease4Collection leases =
-            LeaseMgrFactory::instance().getLease4(hwaddr);
         ElementPtr leases_json = Element::createList();
-        for (auto const& lease : leases) {
-            ElementPtr lease_json = lease->toElement();
-            leases_json->add(lease_json);
+
+        if (v4) {
+            Lease4Collection leases =
+                LeaseMgrFactory::instance().getLease4(hwaddr);
+            for (auto const& lease : leases) {
+                ElementPtr lease_json = lease->toElement();
+                leases_json->add(lease_json);
+            }
+        } else {
+            Lease6Collection leases =
+                LeaseMgrFactory::instance().getLease6(hwaddr);
+            for (auto const& lease : leases) {
+                ElementPtr lease_json = lease->toElement();
+                leases_json->add(lease_json);
+            }
         }
 
         std::ostringstream s;
-        s << leases_json->size() << " IPv4 lease(s) found.";
+        s << leases_json->size()
+          << " IPv" << (v4 ? "4" : "6")
+          << " lease(s) found.";
         ElementPtr args = Element::createMap();
         args->set("leases", leases_json);
         ConstElementPtr response =

src/hooks/dhcp/lease_cmds/lease_cmds.dox

@@ -64,7 +64,7 @@ For details see documentation and code of the following handlers:
 - @ref isc::lease_cmds::LeaseCmdsImpl::leaseGetHandler (lease4-get, lease6-get)
 - @ref isc::lease_cmds::LeaseCmdsImpl::leaseGetAllHandler(lease4-get-all, lease6-get-all)
 - @ref isc::lease_cmds::LeaseCmdsImpl::leaseGetPageHandler(lease4-get-page, lease6-get-page)
-- @ref isc::lease_cmds::LeaseCmdsImpl::leaseGetByHwAddressHandler(lease4-get-by-hw-address)
+- @ref isc::lease_cmds::LeaseCmdsImpl::leaseGetByHwAddressHandler(lease4-get-by-hw-address, lease6-get-by-hw-address)
 - @ref isc::lease_cmds::LeaseCmdsImpl::leaseGetByClientIdHandler(lease4-get-by-client-id)
 - @ref isc::lease_cmds::LeaseCmdsImpl::leaseGetByDuidHandler(lease6-get-by-duid)
 - @ref isc::lease_cmds::LeaseCmdsImpl::leaseGetByHostnameHandler(lease4-get-by-hostname, lease6-get-by-hostname)

src/hooks/dhcp/lease_cmds/lease_cmds.h

@@ -262,12 +262,12 @@ class LeaseCmds {
     int
     leaseGetPageHandler(hooks::CalloutHandle& handle);
 
-    /// @brief lease4-get-by-hw-address command handler
+    /// @brief lease4-get-by-hw-address, lease6-get-by-hw-address command handler
     ///
-    /// This command attempts to retrieve all IPv4 leases with a particular
+    /// This command attempts to retrieve all IPv4 or IPv6 leases with a particular
     /// hardware address.
     ///
-    /// Example command:
+    /// Example command for IPv4:
     /// {
     ///     "command": "lease4-get-by-hw-address",
     ///     "arguments": {

src/hooks/dhcp/lease_cmds/lease_cmds_callouts.cc

@@ -147,6 +147,17 @@ int lease4_get_by_hw_address(CalloutHandle& handle) {
     return (lease_cmds.leaseGetByHwAddressHandler(handle));
 }
 
+/// @brief This is a command callout for 'lease6-get-by-hw-address' command.
+///
+/// @param handle Callout handle used to retrieve a command and
+/// provide a response.
+/// @return 0 if this callout has been invoked successfully,
+/// 1 if an error occurs, 3 if no leases are returned.
+int lease6_get_by_hw_address(CalloutHandle& handle) {
+    LeaseCmds lease_cmds;
+    return (lease_cmds.leaseGetByHwAddressHandler(handle));
+}
+
 /// @brief This is a command callout for 'lease4-get-by-client-id' command.
 ///
 /// @param handle Callout handle used to retrieve a command and
@@ -332,6 +343,8 @@ int load(LibraryHandle& handle) {
     handle.registerCommandCallout("lease6-get-page", lease6_get_page);
     handle.registerCommandCallout("lease4-get-by-hw-address",
                                   lease4_get_by_hw_address);
+    handle.registerCommandCallout("lease6-get-by-hw-address",
+                                  lease6_get_by_hw_address);
     handle.registerCommandCallout("lease4-get-by-client-id",
                                   lease4_get_by_client_id);
     handle.registerCommandCallout("lease6-get-by-duid", lease6_get_by_duid);