Add support for redfish StopBootOnFault
This commit is added get and set for StopBootOnFault Policy.
The StopBootOnFault is defined in ComputerSystem(boot).
It contains two values "Never" and "AnyFault".
ref:https://redfish.dmtf.org/schemas/v1/ComputerSystem.v1_15_0.json
Tested:
1.Validator passes
2.doGet method to get StopBootOnFault.
curl -k -H "X-Auth-Token: $token" -X GET
https://${bmc}/redfish/v1/Systems/system
{
"@odata.id": "/redfish/v1/Systems/system",
"@odata.type": "#ComputerSystem.v1_16_0.ComputerSystem",
...
"Boot": {
...
"StopBootOnFault": "Never"
},
...
}
3.doPatch method set the "StopBootOnFault" property
to AnyFault or Never and report error when set to other values
curl -k -H "X-Auth-Token: $token" -X PATCH -d
'{ "Boot" :{"StopBootOnFault":"AnyFault"}}'
https://${bmc}/redfish/v1/Systems/system
A few seconds later,
curl -k -H "X-Auth-Token: $token" -X GET
https://${bmc}/redfish/v1/Systems/system
{
"@odata.id": "/redfish/v1/Systems/system",
"@odata.type": "#ComputerSystem.v1_16_0.ComputerSystem",
...
"Boot": {
...
"StopBootOnFault": "AnyFault"
},
...
}
Signed-off-by: Albert Zhang <zhanghaodi@inspur.com>
Change-Id: Ib2307deb413081edcbdecba9f234fe18571821a7
Signed-off-by: Gunnar Mills <gmills@us.ibm.com>
diff --git a/redfish-core/lib/systems.hpp b/redfish-core/lib/systems.hpp
index e2e3ed4..c30002a 100644
--- a/redfish-core/lib/systems.hpp
+++ b/redfish-core/lib/systems.hpp
@@ -1408,6 +1408,43 @@
}
/**
+ * @brief Stop Boot On Fault over DBUS.
+ *
+ * @param[in] asyncResp Shared pointer for generating response message.
+ *
+ * @return None.
+ */
+inline void
+ getStopBootOnFault(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
+{
+ BMCWEB_LOG_DEBUG << "Get Stop Boot On Fault";
+
+ sdbusplus::asio::getProperty<bool>(
+ *crow::connections::systemBus, "xyz.openbmc_project.Settings",
+ "/xyz/openbmc_project/logging/settings",
+ "xyz.openbmc_project.Logging.Settings", "QuiesceOnHwError",
+ [asyncResp](const boost::system::error_code& ec, bool value) {
+ if (ec)
+ {
+ if (ec.value() != EBADR)
+ {
+ messages::internalError(asyncResp->res);
+ }
+ return;
+ }
+
+ if (value)
+ {
+ asyncResp->res.jsonValue["Boot"]["StopBootOnFault"] = "AnyFault";
+ }
+ else
+ {
+ asyncResp->res.jsonValue["Boot"]["StopBootOnFault"] = "Never";
+ }
+ });
+}
+
+/**
* @brief Get TrustedModuleRequiredToBoot property. Determines whether or not
* TPM is required for booting the host.
*
@@ -1885,6 +1922,71 @@
}
/**
+ * @brief Validate the specified stopBootOnFault is valid and return the
+ * stopBootOnFault name associated with that string
+ *
+ * @param[in] stopBootOnFaultString String representing the desired
+ * stopBootOnFault
+ *
+ * @return stopBootOnFault value or empty if incoming value is not valid
+ */
+inline std::optional<bool>
+ validstopBootOnFault(const std::string& stopBootOnFaultString)
+{
+ if (stopBootOnFaultString == "AnyFault")
+ {
+ return true;
+ }
+
+ if (stopBootOnFaultString == "Never")
+ {
+ return false;
+ }
+
+ return std::nullopt;
+}
+
+/**
+ * @brief Sets stopBootOnFault
+ *
+ * @param[in] aResp Shared pointer for generating response message.
+ * @param[in] stopBootOnFault "StopBootOnFault" from request.
+ *
+ * @return None.
+ */
+inline void setStopBootOnFault(const std::shared_ptr<bmcweb::AsyncResp>& aResp,
+ const std::string& stopBootOnFault)
+{
+ BMCWEB_LOG_DEBUG << "Set Stop Boot On Fault.";
+
+ std::optional<bool> stopBootEnabled = validstopBootOnFault(stopBootOnFault);
+ if (!stopBootEnabled)
+ {
+ BMCWEB_LOG_DEBUG << "Invalid property value for StopBootOnFault: "
+ << stopBootOnFault;
+ messages::propertyValueNotInList(aResp->res, stopBootOnFault,
+ "StopBootOnFault");
+ return;
+ }
+
+ sdbusplus::asio::setProperty(*crow::connections::systemBus,
+ "xyz.openbmc_project.Settings",
+ "/xyz/openbmc_project/logging/settings",
+ "xyz.openbmc_project.Logging.Settings",
+ "QuiesceOnHwError", *stopBootEnabled,
+ [aResp](const boost::system::error_code& ec) {
+ if (ec)
+ {
+ if (ec.value() != EBADR)
+ {
+ messages::internalError(aResp->res);
+ }
+ return;
+ }
+ });
+}
+
+/**
* @brief Sets automaticRetry (Auto Reboot)
*
* @param[in] asyncResp Shared pointer for generating response message.
@@ -3229,6 +3331,7 @@
pcie_util::getPCIeDeviceList(asyncResp, "PCIeDevices");
getHostWatchdogTimer(asyncResp);
getPowerRestorePolicy(asyncResp);
+ getStopBootOnFault(asyncResp);
getAutomaticRetryPolicy(asyncResp);
getLastResetTime(asyncResp);
#ifdef BMCWEB_ENABLE_REDFISH_PROVISIONING_FEATURE
@@ -3279,6 +3382,7 @@
std::optional<std::string> bootAutomaticRetry;
std::optional<uint32_t> bootAutomaticRetryAttempts;
std::optional<bool> bootTrustedModuleRequired;
+ std::optional<std::string> stopBootOnFault;
std::optional<bool> ipsEnable;
std::optional<uint8_t> ipsEnterUtil;
std::optional<uint64_t> ipsEnterTime;
@@ -3301,6 +3405,7 @@
"Boot/AutomaticRetryConfig", bootAutomaticRetry,
"Boot/AutomaticRetryAttempts", bootAutomaticRetryAttempts,
"Boot/TrustedModuleRequiredToBoot", bootTrustedModuleRequired,
+ "Boot/StopBootOnFault", stopBootOnFault,
"IdlePowerSaver/Enabled", ipsEnable,
"IdlePowerSaver/EnterUtilizationPercent", ipsEnterUtil,
"IdlePowerSaver/EnterDwellTimeSeconds", ipsEnterTime,
@@ -3343,6 +3448,11 @@
setTrustedModuleRequiredToBoot(asyncResp, *bootTrustedModuleRequired);
}
+ if (stopBootOnFault)
+ {
+ setStopBootOnFault(asyncResp, *stopBootOnFault);
+ }
+
if (locationIndicatorActive)
{
setLocationIndicatorActive(asyncResp, *locationIndicatorActive);