commit 0eebcefbc0cacc5c4e431ceec80df7fe37b6f56c
author Jishnu CM <jishnunambiarcm@duck.com> Tue Apr 23 23:54:24 2024 -0500
committer Jishnu C M <jishnunambiarcm@duck.com> Mon Aug 26 16:41:57 2024 +0000
tree 3b8888a7654e7d29b4eef93e9bcdbf1ea10e3ac2
parent 7a16ddc8e036eabcbe7e0c8087ceee7a4cb1d2d8

NetworkProtocol: Support NetworkSuppliedServers

This commit re-introduces changes proposed earlier to support
NetworkSuppliedServers property in bmcweb.
https://gerrit.openbmc.org/c/openbmc/bmcweb/+/52671

It helps to differentiate between the static and DHCP assigned
NTP servers. Networkd and Dbus has added support for StaticNTPServers to
save the static configuration.

Tested by:
 1. PATCH /redfish/v1/Managers/bmc/NetworkProtocol -d
    '{"NTP":{"NTPServers": [<ip>]}}'
    Verify that this adds the NTPs server to the NetworkProtocol
 2. Enable DHCP to fetch NTP servers list from the DHCP server. Verify
    that they are listed when GET on NetworkProtocol as below
    "NTP": {
        "NTPServers": [
        <static ntp server ip>
      ],
      "NetworkSuppliedServers": [
        <dynamic ntp server ip>
      ],
      "ProtocolEnabled": true
    },
 3. Redfish validator run

Change-Id: I22591ad6d49245bf74ef24dd68a51f015f6a8b07
Signed-off-by: Jishnu CM <jishnunambiarcm@duck.com>

redfish-core/lib/network_protocol.hpp

diff --git a/redfish-core/lib/network_protocol.hpp b/redfish-core/lib/network_protocol.hpp
index 4fd606a..d070413 100644
--- a/redfish-core/lib/network_protocol.hpp
+++ b/redfish-core/lib/network_protocol.hpp
@@ -33,6 +33,7 @@
 #include <optional>
 #include <string_view>
 #include <variant>
+#include <vector>
 
 namespace redfish
 {
@@ -53,7 +54,8 @@
 
 inline void extractNTPServersAndDomainNamesData(
     const dbus::utility::ManagedObjectType& dbusData,
-    std::vector<std::string>& ntpData, std::vector<std::string>& dnData)
+    std::vector<std::string>& ntpData, std::vector<std::string>& dynamicNtpData,
+    std::vector<std::string>& dnData)
 {
     for (const auto& obj : dbusData)
     {
@@ -78,6 +80,16 @@
                                        ntpServers->end());
                     }
                 }
+                else if (propertyPair.first == "NTPServers")
+                {
+                    const std::vector<std::string>* dynamicNtpServers =
+                        std::get_if<std::vector<std::string>>(
+                            &propertyPair.second);
+                    if (dynamicNtpServers != nullptr)
+                    {
+                        dynamicNtpData = *dynamicNtpServers;
+                    }
+                }
                 else if (propertyPair.first == "DomainName")
                 {
                     const std::vector<std::string>* domainNames =
@@ -106,18 +118,19 @@
             const boost::system::error_code& ec,
             const dbus::utility::ManagedObjectType& dbusData) {
             std::vector<std::string> ntpServers;
+            std::vector<std::string> dynamicNtpServers;
             std::vector<std::string> domainNames;
 
             if (ec)
             {
-                callback(false, ntpServers, domainNames);
+                callback(false, ntpServers, dynamicNtpServers, domainNames);
                 return;
             }
 
             extractNTPServersAndDomainNamesData(dbusData, ntpServers,
-                                                domainNames);
+                                                dynamicNtpServers, domainNames);
 
-            callback(true, ntpServers, domainNames);
+            callback(true, ntpServers, dynamicNtpServers, domainNames);
         });
 }
 
@@ -166,7 +179,7 @@
         boost::beast::http::field::link,
         "</redfish/v1/JsonSchemas/ManagerNetworkProtocol/NetworkProtocol.json>; rel=describedby");
     asyncResp->res.jsonValue["@odata.type"] =
-        "#ManagerNetworkProtocol.v1_5_0.ManagerNetworkProtocol";
+        "#ManagerNetworkProtocol.v1_9_0.ManagerNetworkProtocol";
     asyncResp->res.jsonValue["@odata.id"] =
         boost::urls::format("/redfish/v1/Managers/{}/NetworkProtocol",
                             BMCWEB_REDFISH_MANAGER_URI_NAME);
@@ -204,6 +217,7 @@
     getEthernetIfaceData([hostName, asyncResp](
                              const bool& success,
                              const std::vector<std::string>& ntpServers,
+                             const std::vector<std::string>& dynamicNtpServers,
                              const std::vector<std::string>& domainNames) {
         if (!success)
         {
@@ -212,6 +226,8 @@
             return;
         }
         asyncResp->res.jsonValue["NTP"]["NTPServers"] = ntpServers;
+        asyncResp->res.jsonValue["NTP"]["NetworkSuppliedServers"] =
+            dynamicNtpServers;
         if (!hostName.empty())
         {
             std::string fqdn = hostName;
@@ -520,6 +536,7 @@
         getEthernetIfaceData(
             [asyncResp, ntpServerObjects](
                 const bool success, std::vector<std::string>& currentNtpServers,
+                const std::vector<std::string>& /*dynamicNtpServers*/,
                 const std::vector<std::string>& /*domainNames*/) {
                 if (!success)
                 {