Add support for LogService.ClearLog to Crashdump
Tested:
Used Postman to send the LogService.ClearLog action on Crashdump
and verified that the existing logs were cleared and the next new
log started at ID 0.
Passed the Redfish Service Validator.
Change-Id: I9b895b3d2e1865add42e4c35c77f55c8832385da
Signed-off-by: Jason M. Bills <jason.m.bills@linux.intel.com>
diff --git a/redfish-core/include/redfish.hpp b/redfish-core/include/redfish.hpp
index d537e9a..2a6dce7 100644
--- a/redfish-core/include/redfish.hpp
+++ b/redfish-core/include/redfish.hpp
@@ -106,6 +106,7 @@
nodes.emplace_back(std::make_unique<CrashdumpEntryCollection>(app));
nodes.emplace_back(std::make_unique<CrashdumpEntry>(app));
nodes.emplace_back(std::make_unique<CrashdumpFile>(app));
+ nodes.emplace_back(std::make_unique<CrashdumpClear>(app));
nodes.emplace_back(std::make_unique<OnDemandCrashdump>(app));
#ifdef BMCWEB_ENABLE_REDFISH_RAW_PECI
nodes.emplace_back(std::make_unique<SendRawPECI>(app));
diff --git a/redfish-core/lib/log_services.hpp b/redfish-core/lib/log_services.hpp
index 5248fb3..643be9b 100644
--- a/redfish-core/lib/log_services.hpp
+++ b/redfish-core/lib/log_services.hpp
@@ -33,13 +33,15 @@
namespace redfish
{
-constexpr char const *CrashdumpObject = "com.intel.crashdump";
-constexpr char const *CrashdumpPath = "/com/intel/crashdump";
-constexpr char const *CrashdumpOnDemandPath = "/com/intel/crashdump/OnDemand";
-constexpr char const *CrashdumpInterface = "com.intel.crashdump";
-constexpr char const *CrashdumpOnDemandInterface =
+constexpr char const *crashdumpObject = "com.intel.crashdump";
+constexpr char const *crashdumpPath = "/com/intel/crashdump";
+constexpr char const *crashdumpOnDemandPath = "/com/intel/crashdump/OnDemand";
+constexpr char const *crashdumpInterface = "com.intel.crashdump";
+constexpr char const *deleteAllInterface =
+ "xyz.openbmc_project.Collection.DeleteAll";
+constexpr char const *crashdumpOnDemandInterface =
"com.intel.crashdump.OnDemand";
-constexpr char const *CrashdumpRawPECIInterface =
+constexpr char const *crashdumpRawPECIInterface =
"com.intel.crashdump.SendRawPeci";
namespace message_registries
@@ -1505,6 +1507,9 @@
{"@odata.id",
"/redfish/v1/Systems/system/LogServices/Crashdump/Entries"}};
asyncResp->res.jsonValue["Actions"] = {
+ {"#LogService.ClearLog",
+ {{"target", "/redfish/v1/Systems/system/LogServices/Crashdump/"
+ "Actions/LogService.ClearLog"}}},
{"Oem",
{{"#Crashdump.OnDemand",
{{"target", "/redfish/v1/Systems/system/LogServices/Crashdump/"
@@ -1519,6 +1524,42 @@
}
};
+class CrashdumpClear : public Node
+{
+ public:
+ CrashdumpClear(CrowApp &app) :
+ Node(app, "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/"
+ "LogService.ClearLog/")
+ {
+ entityPrivileges = {
+ {boost::beast::http::verb::get, {{"Login"}}},
+ {boost::beast::http::verb::head, {{"Login"}}},
+ {boost::beast::http::verb::patch, {{"ConfigureComponents"}}},
+ {boost::beast::http::verb::put, {{"ConfigureComponents"}}},
+ {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}},
+ {boost::beast::http::verb::post, {{"ConfigureComponents"}}}};
+ }
+
+ private:
+ void doPost(crow::Response &res, const crow::Request &req,
+ const std::vector<std::string> ¶ms) override
+ {
+ std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
+
+ crow::connections::systemBus->async_method_call(
+ [asyncResp](const boost::system::error_code ec,
+ const std::string &resp) {
+ if (ec)
+ {
+ messages::internalError(asyncResp->res);
+ return;
+ }
+ messages::success(asyncResp->res);
+ },
+ crashdumpObject, crashdumpPath, deleteAllInterface, "DeleteAll");
+ }
+};
+
std::string getLogCreatedTime(const std::string &crashdump)
{
nlohmann::json crashdumpJson =
@@ -1612,9 +1653,9 @@
{"Created", std::move(logTime)}};
};
crow::connections::systemBus->async_method_call(
- std::move(getStoredLogCallback), CrashdumpObject,
- CrashdumpPath + std::string("/") + logID,
- "org.freedesktop.DBus.Properties", "Get", CrashdumpInterface, "Log");
+ std::move(getStoredLogCallback), crashdumpObject,
+ crashdumpPath + std::string("/") + logID,
+ "org.freedesktop.DBus.Properties", "Get", crashdumpInterface, "Log");
}
class CrashdumpEntryCollection : public Node
@@ -1674,7 +1715,7 @@
for (const std::string &objpath : resp)
{
// Ignore the on-demand log
- if (objpath.compare(CrashdumpOnDemandPath) == 0)
+ if (objpath.compare(crashdumpOnDemandPath) == 0)
{
continue;
}
@@ -1705,7 +1746,7 @@
"xyz.openbmc_project.ObjectMapper",
"/xyz/openbmc_project/object_mapper",
"xyz.openbmc_project.ObjectMapper", "GetSubTreePaths", "", 0,
- std::array<const char *, 1>{CrashdumpInterface});
+ std::array<const char *, 1>{crashdumpInterface});
}
};
@@ -1800,9 +1841,9 @@
asyncResp->res.body() = *log;
};
crow::connections::systemBus->async_method_call(
- std::move(getStoredLogCallback), CrashdumpObject,
- CrashdumpPath + std::string("/") + logID,
- "org.freedesktop.DBus.Properties", "Get", CrashdumpInterface,
+ std::move(getStoredLogCallback), crashdumpObject,
+ crashdumpPath + std::string("/") + logID,
+ "org.freedesktop.DBus.Properties", "Get", crashdumpInterface,
"Log");
}
};
@@ -1871,7 +1912,7 @@
interfacesAdded;
m.read(objPath, interfacesAdded);
const std::string *log = std::get_if<std::string>(
- &interfacesAdded[CrashdumpInterface]["Log"]);
+ &interfacesAdded[crashdumpInterface]["Log"]);
if (log == nullptr)
{
messages::internalError(asyncResp->res);
@@ -1908,7 +1949,7 @@
*crow::connections::systemBus,
sdbusplus::bus::match::rules::interfacesAdded() +
sdbusplus::bus::match::rules::argNpath(0,
- CrashdumpOnDemandPath),
+ crashdumpOnDemandPath),
std::move(onDemandLogMatcherCallback));
auto generateonDemandLogCallback =
@@ -1932,8 +1973,8 @@
}
};
crow::connections::systemBus->async_method_call(
- std::move(generateonDemandLogCallback), CrashdumpObject,
- CrashdumpPath, CrashdumpOnDemandInterface, "GenerateOnDemandLog");
+ std::move(generateonDemandLogCallback), crashdumpObject,
+ crashdumpPath, crashdumpOnDemandInterface, "GenerateOnDemandLog");
}
};
@@ -1985,8 +2026,8 @@
};
// Call the SendRawPECI command with the provided data
crow::connections::systemBus->async_method_call(
- std::move(sendRawPECICallback), CrashdumpObject, CrashdumpPath,
- CrashdumpRawPECIInterface, "SendRawPeci", clientAddress, readLength,
+ std::move(sendRawPECICallback), crashdumpObject, crashdumpPath,
+ crashdumpRawPECIInterface, "SendRawPeci", clientAddress, readLength,
peciCommand);
}
};