commit 6449f7d646426f094565d257d757426ecf37850b
author Sunitha Harish <sunithaharish04@gmail.com> Mon Feb 24 03:10:00 2020 -0600
committer Sunitha Harish <sunithaharish04@gmail.com> Fri May 01 09:49:04 2020 +0000
tree bb94fcf795a98309a8d6d7cb5acbc31ad092d06f
parent 402b5717ba59dbee0195d11ec9162ee88dc1baa6

Set the Hypervisor Host Name

This commit implements the PATCH command to set the
Power hypervisor Virtual Management Interface's HostName

Tested By:

1. Configure the HostName:
   PATCH -d '{"HostName" : "hypervisor"}'
   https://${bmc}/redfish/v1/Systems/hypervisor/EthernetInterfaces/<id>

2. GET https://${bmc}/redfish/v1/Systems/hypervisor/EthernetInterfaces/<id>

Signed-off-by: Sunitha Harish <sunithaharish04@gmail.com>
Change-Id: I61269398046c3cf3fbfeca6bf14b95742119f53b

redfish-core/lib/hypervisor_ethernet.hpp

diff --git a/redfish-core/lib/hypervisor_ethernet.hpp b/redfish-core/lib/hypervisor_ethernet.hpp
index 58896d4..6287f3c 100644
--- a/redfish-core/lib/hypervisor_ethernet.hpp
+++ b/redfish-core/lib/hypervisor_ethernet.hpp
@@ -234,12 +234,12 @@
                     {
                         if (propertyPair.first == "HostName")
                         {
-                            const std::string *hostname =
+                            const std::string *hostName =
                                 sdbusplus::message::variant_ns::get_if<
                                     std::string>(&propertyPair.second);
-                            if (hostname != nullptr)
+                            if (hostName != nullptr)
                             {
-                                ethData.hostname = *hostname;
+                                ethData.hostname = *hostName;
                             }
                         }
                         else if (propertyPair.first == "DefaultGateway")
@@ -469,10 +469,7 @@
         jsonResponse["InterfaceEnabled"] = true;
         jsonResponse["MACAddress"] = ethData.mac_address;
 
-        if (!ethData.hostname.empty())
-        {
-            jsonResponse["HostName"] = ethData.hostname;
-        }
+        jsonResponse["HostName"] = ethData.hostname;
 
         nlohmann::json &ipv4Array = jsonResponse["IPv4Addresses"];
         nlohmann::json &ipv4StaticArray = jsonResponse["IPv4StaticAddresses"];
@@ -599,6 +596,45 @@
         }
     }
 
+    bool isHostnameValid(const std::string &hostName)
+    {
+        // As per RFC 1123
+        // Allow up to 255 characters
+        if (hostName.length() > 255)
+        {
+            return false;
+        }
+        // Validate the regex
+        const std::regex pattern(
+            "^[a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9]$");
+
+        return std::regex_match(hostName, pattern);
+    }
+
+    void handleHostnamePatch(const std::string &hostName,
+                             const std::shared_ptr<AsyncResp> asyncResp)
+    {
+        if (!isHostnameValid(hostName))
+        {
+            messages::propertyValueFormatError(asyncResp->res, hostName,
+                                               "HostName");
+            return;
+        }
+
+        asyncResp->res.jsonValue["HostName"] = hostName;
+        crow::connections::systemBus->async_method_call(
+            [asyncResp](const boost::system::error_code ec) {
+                if (ec)
+                {
+                    messages::internalError(asyncResp->res);
+                }
+            },
+            "xyz.openbmc_project.Settings", "/xyz/openbmc_project/network/vmi",
+            "org.freedesktop.DBus.Properties", "Set",
+            "xyz.openbmc_project.Network.SystemConfiguration", "HostName",
+            std::variant<std::string>(hostName));
+    }
+
     /**
      * Functions triggers appropriate requests on DBus
      */
@@ -645,10 +681,11 @@
         }
 
         const std::string &ifaceId = params[0];
+        std::optional<std::string> hostName;
         std::optional<nlohmann::json> ipv4StaticAddresses;
 
-        if (!json_util::readJson(req, res, "IPv4StaticAddresses",
-                                 ipv4StaticAddresses))
+        if (!json_util::readJson(req, res, "HostName", hostName,
+                                 "IPv4StaticAddresses", ipv4StaticAddresses))
         {
             return;
         }
@@ -660,8 +697,12 @@
                                             asyncResp);
         }
 
-        // TODO : Task will be created for monitoring the hypervisor interface
-        // Hypervisor will notify once the IP is applied to the hypervisor.
+        if (hostName)
+        {
+            handleHostnamePatch(*hostName, asyncResp);
+        }
+        // TODO : Task will be created for monitoring the Hypervisor interface
+        // Hypervisor will notify once the IP is applied to the Hypervisor.
         // The status will be sent over to the client.
         res.result(boost::beast::http::status::accepted);
     }