blob: afef19845143b23d0e4defb6c3f393cdf8f55ba0 [file] [log] [blame]
Ed Tanous40e9b922024-09-10 13:50:16 -07001// SPDX-License-Identifier: Apache-2.0
2// SPDX-FileCopyrightText: Copyright OpenBMC Authors
3// SPDX-FileCopyrightText: Copyright 2018 Intel Corporation
Rapkiewicz, Pawele37f8452018-03-09 13:49:50 +01004#pragma once
5
Ed Tanousd7857202025-01-28 15:32:26 -08006#include "bmcweb_config.h"
7
Ed Tanous3ccb3ad2023-01-13 17:40:03 -08008#include "app.hpp"
Ed Tanousd7857202025-01-28 15:32:26 -08009#include "async_resp.hpp"
10#include "dbus_singleton.hpp"
George Liu7a1dbc42022-12-07 16:03:22 +080011#include "dbus_utility.hpp"
Ed Tanousd7857202025-01-28 15:32:26 -080012#include "error_messages.hpp"
Ed Tanous539d8c62024-06-19 14:38:27 -070013#include "generated/enums/action_info.hpp"
14#include "generated/enums/chassis.hpp"
15#include "generated/enums/resource.hpp"
Ed Tanousd7857202025-01-28 15:32:26 -080016#include "http_request.hpp"
James Feist1c8fba92019-12-20 15:12:07 -080017#include "led.hpp"
Ed Tanousd7857202025-01-28 15:32:26 -080018#include "logging.hpp"
Ed Tanous3ccb3ad2023-01-13 17:40:03 -080019#include "query.hpp"
20#include "registries/privilege_registry.hpp"
Myung Baef7e62c12025-09-07 14:02:08 -050021#include "utils/asset_utils.hpp"
Myung Bae3f95a272024-03-13 07:32:02 -070022#include "utils/chassis_utils.hpp"
Ed Tanous3ccb3ad2023-01-13 17:40:03 -080023#include "utils/collection.hpp"
24#include "utils/dbus_utils.hpp"
Nan Zhoucf7eba02022-07-21 23:53:20 +000025#include "utils/json_utils.hpp"
Ed Tanous1abe55e2018-09-05 08:30:59 -070026
Ed Tanousd7857202025-01-28 15:32:26 -080027#include <asm-generic/errno.h>
28
29#include <boost/beast/http/field.hpp>
30#include <boost/beast/http/verb.hpp>
George Liue99073f2022-12-09 11:06:16 +080031#include <boost/system/error_code.hpp>
Ed Tanousef4c65b2023-04-24 15:28:50 -070032#include <boost/url/format.hpp>
Ed Tanousd7857202025-01-28 15:32:26 -080033#include <boost/url/url.hpp>
34#include <nlohmann/json.hpp>
Ed Tanousd7857202025-01-28 15:32:26 -080035#include <sdbusplus/message/native_types.hpp>
Krzysztof Grobelny86d89ed2022-08-29 14:49:20 +020036#include <sdbusplus/unpack_properties.hpp>
Gunnar Mills1214b7e2020-06-04 10:11:30 -050037
Ed Tanousd7857202025-01-28 15:32:26 -080038#include <algorithm>
George Liu7a1dbc42022-12-07 16:03:22 +080039#include <array>
Ed Tanousd7857202025-01-28 15:32:26 -080040#include <format>
41#include <functional>
Joseph-Jonathan Salzano2952f642024-11-19 12:00:06 -070042#include <memory>
Ed Tanousd7857202025-01-28 15:32:26 -080043#include <optional>
Ed Tanous3544d2a2023-08-06 18:12:20 -070044#include <ranges>
Ed Tanousd7857202025-01-28 15:32:26 -080045#include <string>
George Liu7a1dbc42022-12-07 16:03:22 +080046#include <string_view>
Ed Tanousd7857202025-01-28 15:32:26 -080047#include <utility>
48#include <vector>
George Liu7a1dbc42022-12-07 16:03:22 +080049
Ed Tanous1abe55e2018-09-05 08:30:59 -070050namespace redfish
51{
Rapkiewicz, Pawele37f8452018-03-09 13:49:50 +010052
Patrick Williams504af5a2025-02-03 14:29:03 -050053inline chassis::ChassisType translateChassisTypeToRedfish(
54 const std::string_view& chassisType)
Joseph-Jonathan Salzano2952f642024-11-19 12:00:06 -070055{
56 if (chassisType ==
57 "xyz.openbmc_project.Inventory.Item.Chassis.ChassisType.Blade")
58 {
59 return chassis::ChassisType::Blade;
60 }
61 if (chassisType ==
62 "xyz.openbmc_project.Inventory.Item.Chassis.ChassisType.Component")
63 {
64 return chassis::ChassisType::Component;
65 }
66 if (chassisType ==
67 "xyz.openbmc_project.Inventory.Item.Chassis.ChassisType.Enclosure")
68 {
69 return chassis::ChassisType::Enclosure;
70 }
71 if (chassisType ==
72 "xyz.openbmc_project.Inventory.Item.Chassis.ChassisType.Module")
73 {
74 return chassis::ChassisType::Module;
75 }
76 if (chassisType ==
77 "xyz.openbmc_project.Inventory.Item.Chassis.ChassisType.RackMount")
78 {
79 return chassis::ChassisType::RackMount;
80 }
81 if (chassisType ==
82 "xyz.openbmc_project.Inventory.Item.Chassis.ChassisType.StandAlone")
83 {
84 return chassis::ChassisType::StandAlone;
85 }
86 if (chassisType ==
87 "xyz.openbmc_project.Inventory.Item.Chassis.ChassisType.StorageEnclosure")
88 {
89 return chassis::ChassisType::StorageEnclosure;
90 }
91 if (chassisType ==
92 "xyz.openbmc_project.Inventory.Item.Chassis.ChassisType.Zone")
93 {
94 return chassis::ChassisType::Zone;
95 }
96 return chassis::ChassisType::Invalid;
97}
98
Rapkiewicz, Pawele37f8452018-03-09 13:49:50 +010099/**
Willy Tu5e577bc2022-07-26 00:41:55 +0000100 * @brief Retrieves resources over dbus to link to the chassis
101 *
102 * @param[in] asyncResp - Shared pointer for completing asynchronous
103 * calls
104 * @param[in] path - Chassis dbus path to look for the storage.
105 *
106 * Calls the Association endpoints on the path + "/storage" and add the link of
107 * json["Links"]["Storage@odata.count"] =
108 * {"@odata.id", "/redfish/v1/Storage/" + resourceId}
109 *
110 * @return None.
111 */
112inline void getStorageLink(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
113 const sdbusplus::message::object_path& path)
114{
Ed Tanousdeae6a72024-11-11 21:58:57 -0800115 dbus::utility::getProperty<std::vector<std::string>>(
116 "xyz.openbmc_project.ObjectMapper", (path / "storage").str,
117 "xyz.openbmc_project.Association", "endpoints",
Willy Tud4b054c2023-06-12 15:18:45 -0700118 [asyncResp](const boost::system::error_code& ec,
Willy Tu5e577bc2022-07-26 00:41:55 +0000119 const std::vector<std::string>& storageList) {
Patrick Williamsbd79bce2024-08-16 15:22:20 -0400120 if (ec)
Willy Tu5e577bc2022-07-26 00:41:55 +0000121 {
Patrick Williamsbd79bce2024-08-16 15:22:20 -0400122 BMCWEB_LOG_DEBUG("getStorageLink got DBUS response error");
123 return;
Willy Tu5e577bc2022-07-26 00:41:55 +0000124 }
125
Patrick Williamsbd79bce2024-08-16 15:22:20 -0400126 nlohmann::json::array_t storages;
127 for (const std::string& storagePath : storageList)
128 {
129 std::string id =
130 sdbusplus::message::object_path(storagePath).filename();
131 if (id.empty())
132 {
133 continue;
134 }
135
136 nlohmann::json::object_t storage;
137 storage["@odata.id"] =
138 boost::urls::format("/redfish/v1/Systems/{}/Storage/{}",
139 BMCWEB_REDFISH_SYSTEM_URI_NAME, id);
140 storages.emplace_back(std::move(storage));
141 }
142 asyncResp->res.jsonValue["Links"]["Storage@odata.count"] =
143 storages.size();
144 asyncResp->res.jsonValue["Links"]["Storage"] = std::move(storages);
145 });
Willy Tu5e577bc2022-07-26 00:41:55 +0000146}
147
148/**
Gunnar Millsbeeca0a2019-02-14 16:30:45 -0600149 * @brief Retrieves chassis state properties over dbus
150 *
Ed Tanousac106bf2023-06-07 09:24:59 -0700151 * @param[in] asyncResp - Shared pointer for completing asynchronous calls.
Gunnar Millsbeeca0a2019-02-14 16:30:45 -0600152 *
153 * @return None.
154 */
Ed Tanousac106bf2023-06-07 09:24:59 -0700155inline void getChassisState(std::shared_ptr<bmcweb::AsyncResp> asyncResp)
Gunnar Millsbeeca0a2019-02-14 16:30:45 -0600156{
Ed Tanousdeae6a72024-11-11 21:58:57 -0800157 dbus::utility::getProperty<std::string>(
158 "xyz.openbmc_project.State.Chassis",
Jonathan Doman1e1e5982021-06-11 09:36:17 -0700159 "/xyz/openbmc_project/state/chassis0",
160 "xyz.openbmc_project.State.Chassis", "CurrentPowerState",
Ed Tanousac106bf2023-06-07 09:24:59 -0700161 [asyncResp{std::move(asyncResp)}](const boost::system::error_code& ec,
162 const std::string& chassisState) {
Patrick Williamsbd79bce2024-08-16 15:22:20 -0400163 if (ec)
Gunnar Millsbeeca0a2019-02-14 16:30:45 -0600164 {
Patrick Williamsbd79bce2024-08-16 15:22:20 -0400165 if (ec == boost::system::errc::host_unreachable)
166 {
167 // Service not available, no error, just don't return
168 // chassis state info
169 BMCWEB_LOG_DEBUG("Service not available {}", ec);
170 return;
171 }
172 BMCWEB_LOG_DEBUG("DBUS response error {}", ec);
173 messages::internalError(asyncResp->res);
Gunnar Millsbeeca0a2019-02-14 16:30:45 -0600174 return;
175 }
176
Patrick Williamsbd79bce2024-08-16 15:22:20 -0400177 BMCWEB_LOG_DEBUG("Chassis state: {}", chassisState);
178 // Verify Chassis State
179 if (chassisState ==
180 "xyz.openbmc_project.State.Chassis.PowerState.On")
181 {
182 asyncResp->res.jsonValue["PowerState"] =
183 resource::PowerState::On;
184 asyncResp->res.jsonValue["Status"]["State"] =
185 resource::State::Enabled;
186 }
187 else if (chassisState ==
188 "xyz.openbmc_project.State.Chassis.PowerState.Off")
189 {
190 asyncResp->res.jsonValue["PowerState"] =
191 resource::PowerState::Off;
192 asyncResp->res.jsonValue["Status"]["State"] =
193 resource::State::StandbyOffline;
194 }
195 });
Gunnar Millsbeeca0a2019-02-14 16:30:45 -0600196}
197
Qiang XUc1819422019-02-27 13:51:32 +0800198/**
199 * Retrieves physical security properties over dbus
200 */
Chau Ly7164bc62023-10-15 14:55:30 +0000201inline void handlePhysicalSecurityGetSubTree(
202 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
203 const boost::system::error_code& ec,
204 const dbus::utility::MapperGetSubTreeResponse& subtree)
Qiang XUc1819422019-02-27 13:51:32 +0800205{
Chau Ly7164bc62023-10-15 14:55:30 +0000206 if (ec)
207 {
208 // do not add err msg in redfish response, because this is not
209 // mandatory property
210 BMCWEB_LOG_INFO("DBUS error: no matched iface {}", ec);
211 return;
212 }
213 // Iterate over all retrieved ObjectPaths.
214 for (const auto& object : subtree)
215 {
216 if (!object.second.empty())
Ed Tanous002d39b2022-05-31 08:59:27 -0700217 {
Ed Tanous89144a32024-04-08 17:27:04 -0700218 const auto& service = object.second.front();
Chau Ly7164bc62023-10-15 14:55:30 +0000219
220 BMCWEB_LOG_DEBUG("Get intrusion status by service ");
221
Ed Tanousdeae6a72024-11-11 21:58:57 -0800222 dbus::utility::getProperty<std::string>(
223 service.first, object.first,
Chau Ly7164bc62023-10-15 14:55:30 +0000224 "xyz.openbmc_project.Chassis.Intrusion", "Status",
225 [asyncResp](const boost::system::error_code& ec1,
226 const std::string& value) {
Patrick Williamsbd79bce2024-08-16 15:22:20 -0400227 if (ec1)
228 {
229 // do not add err msg in redfish response, because this
230 // is not
231 // mandatory property
232 BMCWEB_LOG_ERROR("DBUS response error {}", ec1);
233 return;
234 }
235 asyncResp->res.jsonValue["PhysicalSecurity"]
236 ["IntrusionSensorNumber"] = 1;
237 asyncResp->res
238 .jsonValue["PhysicalSecurity"]["IntrusionSensor"] =
239 value;
240 });
Chau Ly7164bc62023-10-15 14:55:30 +0000241
Ed Tanous002d39b2022-05-31 08:59:27 -0700242 return;
243 }
Chau Ly7164bc62023-10-15 14:55:30 +0000244 }
Qiang XUc1819422019-02-27 13:51:32 +0800245}
246
Nan Zhoucf7eba02022-07-21 23:53:20 +0000247inline void handleChassisCollectionGet(
248 App& app, const crow::Request& req,
249 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
250{
251 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
252 {
253 return;
254 }
255 asyncResp->res.jsonValue["@odata.type"] =
256 "#ChassisCollection.ChassisCollection";
257 asyncResp->res.jsonValue["@odata.id"] = "/redfish/v1/Chassis";
258 asyncResp->res.jsonValue["Name"] = "Chassis Collection";
259
260 collection_util::getCollectionMembers(
Myung Bae3f95a272024-03-13 07:32:02 -0700261 asyncResp, boost::urls::url("/redfish/v1/Chassis"), chassisInterfaces,
Lakshmi Yadlapati36b5f1e2023-09-26 23:53:28 -0500262 "/xyz/openbmc_project/inventory");
Nan Zhoucf7eba02022-07-21 23:53:20 +0000263}
264
Jie Yanga5617492021-06-29 12:59:14 -0700265inline void getChassisContainedBy(
266 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
267 const std::string& chassisId, const boost::system::error_code& ec,
Myung Bae28ee5632024-05-24 13:10:04 -0500268 const dbus::utility::MapperGetSubTreePathsResponse& upstreamChassisPaths)
Jie Yanga5617492021-06-29 12:59:14 -0700269{
270 if (ec)
271 {
272 if (ec.value() != EBADR)
273 {
Ed Tanous62598e32023-07-17 17:06:25 -0700274 BMCWEB_LOG_ERROR("DBUS response error {}", ec);
Jie Yanga5617492021-06-29 12:59:14 -0700275 messages::internalError(asyncResp->res);
276 }
277 return;
278 }
279 if (upstreamChassisPaths.empty())
280 {
281 return;
282 }
283 if (upstreamChassisPaths.size() > 1)
284 {
Ed Tanous8ece0e42024-01-02 13:16:50 -0800285 BMCWEB_LOG_ERROR("{} is contained by multiple chassis", chassisId);
Jie Yanga5617492021-06-29 12:59:14 -0700286 messages::internalError(asyncResp->res);
287 return;
288 }
289
290 sdbusplus::message::object_path upstreamChassisPath(
291 upstreamChassisPaths[0]);
292 std::string upstreamChassis = upstreamChassisPath.filename();
293 if (upstreamChassis.empty())
294 {
Ed Tanous62598e32023-07-17 17:06:25 -0700295 BMCWEB_LOG_WARNING("Malformed upstream Chassis path {} on {}",
296 upstreamChassisPath.str, chassisId);
Jie Yanga5617492021-06-29 12:59:14 -0700297 return;
298 }
299
300 asyncResp->res.jsonValue["Links"]["ContainedBy"]["@odata.id"] =
301 boost::urls::format("/redfish/v1/Chassis/{}", upstreamChassis);
302}
303
304inline void getChassisContains(
305 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
306 const std::string& chassisId, const boost::system::error_code& ec,
Myung Bae28ee5632024-05-24 13:10:04 -0500307 const dbus::utility::MapperGetSubTreePathsResponse& downstreamChassisPaths)
Jie Yanga5617492021-06-29 12:59:14 -0700308{
309 if (ec)
310 {
311 if (ec.value() != EBADR)
312 {
Ed Tanous62598e32023-07-17 17:06:25 -0700313 BMCWEB_LOG_ERROR("DBUS response error {}", ec);
Jie Yanga5617492021-06-29 12:59:14 -0700314 messages::internalError(asyncResp->res);
315 }
316 return;
317 }
318 if (downstreamChassisPaths.empty())
319 {
320 return;
321 }
322 nlohmann::json& jValue = asyncResp->res.jsonValue["Links"]["Contains"];
323 if (!jValue.is_array())
324 {
325 // Create the array if it was empty
326 jValue = nlohmann::json::array();
327 }
328 for (const auto& p : downstreamChassisPaths)
329 {
330 sdbusplus::message::object_path downstreamChassisPath(p);
331 std::string downstreamChassis = downstreamChassisPath.filename();
332 if (downstreamChassis.empty())
333 {
Ed Tanous62598e32023-07-17 17:06:25 -0700334 BMCWEB_LOG_WARNING("Malformed downstream Chassis path {} on {}",
335 downstreamChassisPath.str, chassisId);
Jie Yanga5617492021-06-29 12:59:14 -0700336 continue;
337 }
338 nlohmann::json link;
Patrick Williamsbd79bce2024-08-16 15:22:20 -0400339 link["@odata.id"] =
340 boost::urls::format("/redfish/v1/Chassis/{}", downstreamChassis);
Jie Yanga5617492021-06-29 12:59:14 -0700341 jValue.push_back(std::move(link));
342 }
343 asyncResp->res.jsonValue["Links"]["Contains@odata.count"] = jValue.size();
344}
345
Patrick Williamsbd79bce2024-08-16 15:22:20 -0400346inline void getChassisConnectivity(
347 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
348 const std::string& chassisId, const std::string& chassisPath)
Jie Yanga5617492021-06-29 12:59:14 -0700349{
Ed Tanous62598e32023-07-17 17:06:25 -0700350 BMCWEB_LOG_DEBUG("Get chassis connectivity");
Jie Yanga5617492021-06-29 12:59:14 -0700351
Myung Bae28ee5632024-05-24 13:10:04 -0500352 dbus::utility::getAssociatedSubTreePaths(
Jie Yanga5617492021-06-29 12:59:14 -0700353 chassisPath + "/contained_by",
Myung Bae28ee5632024-05-24 13:10:04 -0500354 sdbusplus::message::object_path("/xyz/openbmc_project/inventory"), 0,
Myung Bae3f95a272024-03-13 07:32:02 -0700355 chassisInterfaces,
Jie Yanga5617492021-06-29 12:59:14 -0700356 std::bind_front(getChassisContainedBy, asyncResp, chassisId));
357
Myung Bae28ee5632024-05-24 13:10:04 -0500358 dbus::utility::getAssociatedSubTreePaths(
Jie Yanga5617492021-06-29 12:59:14 -0700359 chassisPath + "/containing",
Myung Bae28ee5632024-05-24 13:10:04 -0500360 sdbusplus::message::object_path("/xyz/openbmc_project/inventory"), 0,
Myung Bae3f95a272024-03-13 07:32:02 -0700361 chassisInterfaces,
362 std::bind_front(getChassisContains, asyncResp, chassisId));
Jie Yanga5617492021-06-29 12:59:14 -0700363}
364
Rapkiewicz, Pawele37f8452018-03-09 13:49:50 +0100365/**
Rapkiewicz, Pawele37f8452018-03-09 13:49:50 +0100366 * ChassisCollection derived class for delivering Chassis Collection Schema
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700367 * Functions triggers appropriate requests on DBus
Rapkiewicz, Pawele37f8452018-03-09 13:49:50 +0100368 */
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700369inline void requestRoutesChassisCollection(App& app)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700370{
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700371 BMCWEB_ROUTE(app, "/redfish/v1/Chassis/")
Ed Tanoused398212021-06-09 17:05:54 -0700372 .privileges(redfish::privileges::getChassisCollection)
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700373 .methods(boost::beast::http::verb::get)(
Nan Zhoucf7eba02022-07-21 23:53:20 +0000374 std::bind_front(handleChassisCollectionGet, std::ref(app)));
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700375}
Rapkiewicz, Pawele37f8452018-03-09 13:49:50 +0100376
Patrick Williamsbd79bce2024-08-16 15:22:20 -0400377inline void getChassisLocationCode(
378 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
379 const std::string& connectionName, const std::string& path)
Willy Tu308f70c2021-09-28 20:24:52 -0700380{
Ed Tanousdeae6a72024-11-11 21:58:57 -0800381 dbus::utility::getProperty<std::string>(
382 connectionName, path,
Jonathan Doman1e1e5982021-06-11 09:36:17 -0700383 "xyz.openbmc_project.Inventory.Decorator.LocationCode", "LocationCode",
Ed Tanous5e7e2dc2023-02-16 10:37:01 -0800384 [asyncResp](const boost::system::error_code& ec,
Jonathan Doman1e1e5982021-06-11 09:36:17 -0700385 const std::string& property) {
Patrick Williamsbd79bce2024-08-16 15:22:20 -0400386 if (ec)
387 {
388 BMCWEB_LOG_ERROR("DBUS response error for Location");
389 messages::internalError(asyncResp->res);
390 return;
391 }
Willy Tu308f70c2021-09-28 20:24:52 -0700392
Patrick Williamsbd79bce2024-08-16 15:22:20 -0400393 asyncResp->res
394 .jsonValue["Location"]["PartLocation"]["ServiceLabel"] =
395 property;
396 });
Willy Tu308f70c2021-09-28 20:24:52 -0700397}
398
399inline void getChassisUUID(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
400 const std::string& connectionName,
401 const std::string& path)
402{
Ed Tanousdeae6a72024-11-11 21:58:57 -0800403 dbus::utility::getProperty<std::string>(
404 connectionName, path, "xyz.openbmc_project.Common.UUID", "UUID",
Ed Tanous5e7e2dc2023-02-16 10:37:01 -0800405 [asyncResp](const boost::system::error_code& ec,
Jonathan Doman1e1e5982021-06-11 09:36:17 -0700406 const std::string& chassisUUID) {
Patrick Williamsbd79bce2024-08-16 15:22:20 -0400407 if (ec)
408 {
409 BMCWEB_LOG_ERROR("DBUS response error for UUID");
410 messages::internalError(asyncResp->res);
411 return;
412 }
413 asyncResp->res.jsonValue["UUID"] = chassisUUID;
414 });
Willy Tu308f70c2021-09-28 20:24:52 -0700415}
416
Chau Ly7164bc62023-10-15 14:55:30 +0000417inline void handleDecoratorAssetProperties(
418 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
419 const std::string& chassisId, const std::string& path,
420 const dbus::utility::DBusPropertiesMap& propertiesList)
421{
Myung Baef7e62c12025-09-07 14:02:08 -0500422 asset_utils::extractAssetInfo(asyncResp, ""_json_pointer, propertiesList,
423 true);
Chau Ly7164bc62023-10-15 14:55:30 +0000424
425 asyncResp->res.jsonValue["Name"] = chassisId;
426 asyncResp->res.jsonValue["Id"] = chassisId;
Ed Tanous25b54db2024-04-17 15:40:31 -0700427
428 if constexpr (BMCWEB_REDFISH_ALLOW_DEPRECATED_POWER_THERMAL)
429 {
430 asyncResp->res.jsonValue["Thermal"]["@odata.id"] =
431 boost::urls::format("/redfish/v1/Chassis/{}/Thermal", chassisId);
432 // Power object
433 asyncResp->res.jsonValue["Power"]["@odata.id"] =
434 boost::urls::format("/redfish/v1/Chassis/{}/Power", chassisId);
435 }
436
437 if constexpr (BMCWEB_REDFISH_NEW_POWERSUBSYSTEM_THERMALSUBSYSTEM)
438 {
439 asyncResp->res.jsonValue["ThermalSubsystem"]["@odata.id"] =
440 boost::urls::format("/redfish/v1/Chassis/{}/ThermalSubsystem",
441 chassisId);
442 asyncResp->res.jsonValue["PowerSubsystem"]["@odata.id"] =
443 boost::urls::format("/redfish/v1/Chassis/{}/PowerSubsystem",
444 chassisId);
445 asyncResp->res.jsonValue["EnvironmentMetrics"]["@odata.id"] =
446 boost::urls::format("/redfish/v1/Chassis/{}/EnvironmentMetrics",
447 chassisId);
448 }
Chau Ly7164bc62023-10-15 14:55:30 +0000449 // SensorCollection
450 asyncResp->res.jsonValue["Sensors"]["@odata.id"] =
451 boost::urls::format("/redfish/v1/Chassis/{}/Sensors", chassisId);
Ed Tanous539d8c62024-06-19 14:38:27 -0700452 asyncResp->res.jsonValue["Status"]["State"] = resource::State::Enabled;
Chau Ly7164bc62023-10-15 14:55:30 +0000453
454 nlohmann::json::array_t computerSystems;
455 nlohmann::json::object_t system;
Patrick Williamsbd79bce2024-08-16 15:22:20 -0400456 system["@odata.id"] =
457 std::format("/redfish/v1/Systems/{}", BMCWEB_REDFISH_SYSTEM_URI_NAME);
Chau Ly7164bc62023-10-15 14:55:30 +0000458 computerSystems.emplace_back(std::move(system));
459 asyncResp->res.jsonValue["Links"]["ComputerSystems"] =
460 std::move(computerSystems);
461
462 nlohmann::json::array_t managedBy;
463 nlohmann::json::object_t manager;
Ed Tanous253f11b2024-05-16 09:38:31 -0700464 manager["@odata.id"] = boost::urls::format("/redfish/v1/Managers/{}",
465 BMCWEB_REDFISH_MANAGER_URI_NAME);
Chau Ly7164bc62023-10-15 14:55:30 +0000466 managedBy.emplace_back(std::move(manager));
467 asyncResp->res.jsonValue["Links"]["ManagedBy"] = std::move(managedBy);
468 getChassisState(asyncResp);
469 getStorageLink(asyncResp, path);
470}
471
Joseph-Jonathan Salzano2952f642024-11-19 12:00:06 -0700472inline void handleChassisProperties(
473 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
474 const dbus::utility::DBusPropertiesMap& propertiesList)
475{
476 const std::string* type = nullptr;
477
478 const bool success = sdbusplus::unpackPropertiesNoThrow(
479 dbus_utils::UnpackErrorPrinter(), propertiesList, "Type", type);
480
481 if (!success)
482 {
483 messages::internalError(asyncResp->res);
484 return;
485 }
486
Gunnar Mills19ea2862024-12-10 09:02:03 -0600487 // Chassis Type is a required property in Redfish
488 // If there is an error or some enum we don't support just sit it to Rack
489 // Mount
490 asyncResp->res.jsonValue["ChassisType"] = chassis::ChassisType::RackMount;
491
Joseph-Jonathan Salzano2952f642024-11-19 12:00:06 -0700492 if (type != nullptr)
493 {
494 auto chassisType = translateChassisTypeToRedfish(*type);
495 if (chassisType != chassis::ChassisType::Invalid)
496 {
497 asyncResp->res.jsonValue["ChassisType"] = chassisType;
498 }
499 }
Joseph-Jonathan Salzano2952f642024-11-19 12:00:06 -0700500}
501
Chau Ly7164bc62023-10-15 14:55:30 +0000502inline void handleChassisGetSubTree(
503 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
504 const std::string& chassisId, const boost::system::error_code& ec,
505 const dbus::utility::MapperGetSubTreeResponse& subtree)
506{
507 if (ec)
508 {
509 BMCWEB_LOG_ERROR("DBUS response error {}", ec);
510 messages::internalError(asyncResp->res);
511 return;
512 }
513 // Iterate over all retrieved ObjectPaths.
514 for (const std::pair<
515 std::string,
516 std::vector<std::pair<std::string, std::vector<std::string>>>>&
517 object : subtree)
518 {
519 const std::string& path = object.first;
520 const std::vector<std::pair<std::string, std::vector<std::string>>>&
521 connectionNames = object.second;
522
523 sdbusplus::message::object_path objPath(path);
524 if (objPath.filename() != chassisId)
525 {
526 continue;
527 }
528
529 getChassisConnectivity(asyncResp, chassisId, path);
530
Chau Ly7164bc62023-10-15 14:55:30 +0000531 if (connectionNames.empty())
532 {
533 BMCWEB_LOG_ERROR("Got 0 Connection names");
534 continue;
535 }
536
537 asyncResp->res.jsonValue["@odata.type"] = "#Chassis.v1_22_0.Chassis";
538 asyncResp->res.jsonValue["@odata.id"] =
539 boost::urls::format("/redfish/v1/Chassis/{}", chassisId);
540 asyncResp->res.jsonValue["Name"] = "Chassis Collection";
Chau Ly7164bc62023-10-15 14:55:30 +0000541 asyncResp->res.jsonValue["Actions"]["#Chassis.Reset"]["target"] =
542 boost::urls::format("/redfish/v1/Chassis/{}/Actions/Chassis.Reset",
543 chassisId);
544 asyncResp->res
545 .jsonValue["Actions"]["#Chassis.Reset"]["@Redfish.ActionInfo"] =
546 boost::urls::format("/redfish/v1/Chassis/{}/ResetActionInfo",
547 chassisId);
Chau Ly7164bc62023-10-15 14:55:30 +0000548 dbus::utility::getAssociationEndPoints(
549 path + "/drive",
550 [asyncResp, chassisId](const boost::system::error_code& ec3,
551 const dbus::utility::MapperEndPoints& resp) {
Patrick Williamsbd79bce2024-08-16 15:22:20 -0400552 if (ec3 || resp.empty())
553 {
554 return; // no drives = no failures
555 }
Chau Ly7164bc62023-10-15 14:55:30 +0000556
Patrick Williamsbd79bce2024-08-16 15:22:20 -0400557 nlohmann::json reference;
558 reference["@odata.id"] = boost::urls::format(
559 "/redfish/v1/Chassis/{}/Drives", chassisId);
560 asyncResp->res.jsonValue["Drives"] = std::move(reference);
561 });
Chau Ly7164bc62023-10-15 14:55:30 +0000562
563 const std::string& connectionName = connectionNames[0].first;
564
565 const std::vector<std::string>& interfaces2 = connectionNames[0].second;
George Liue5ae9c12021-11-16 10:31:23 +0800566 const std::array<const char*, 3> hasIndicatorLed = {
567 "xyz.openbmc_project.Inventory.Item.Chassis",
Chau Ly7164bc62023-10-15 14:55:30 +0000568 "xyz.openbmc_project.Inventory.Item.Panel",
569 "xyz.openbmc_project.Inventory.Item.Board.Motherboard"};
570
571 const std::string assetTagInterface =
572 "xyz.openbmc_project.Inventory.Decorator.AssetTag";
573 const std::string replaceableInterface =
574 "xyz.openbmc_project.Inventory.Decorator.Replaceable";
Carson Labradob4d593f2024-02-16 22:34:32 +0000575 const std::string revisionInterface =
576 "xyz.openbmc_project.Inventory.Decorator.Revision";
Chau Ly7164bc62023-10-15 14:55:30 +0000577 for (const auto& interface : interfaces2)
578 {
579 if (interface == assetTagInterface)
580 {
Ed Tanousdeae6a72024-11-11 21:58:57 -0800581 dbus::utility::getProperty<std::string>(
582 connectionName, path, assetTagInterface, "AssetTag",
Chau Ly7164bc62023-10-15 14:55:30 +0000583 [asyncResp, chassisId](const boost::system::error_code& ec2,
584 const std::string& property) {
Patrick Williamsbd79bce2024-08-16 15:22:20 -0400585 if (ec2)
586 {
587 BMCWEB_LOG_ERROR(
588 "DBus response error for AssetTag: {}", ec2);
589 messages::internalError(asyncResp->res);
590 return;
591 }
592 asyncResp->res.jsonValue["AssetTag"] = property;
593 });
Chau Ly7164bc62023-10-15 14:55:30 +0000594 }
595 else if (interface == replaceableInterface)
596 {
Ed Tanousdeae6a72024-11-11 21:58:57 -0800597 dbus::utility::getProperty<bool>(
598 connectionName, path, replaceableInterface, "HotPluggable",
Chau Ly7164bc62023-10-15 14:55:30 +0000599 [asyncResp, chassisId](const boost::system::error_code& ec2,
600 const bool property) {
Patrick Williamsbd79bce2024-08-16 15:22:20 -0400601 if (ec2)
602 {
603 BMCWEB_LOG_ERROR(
604 "DBus response error for HotPluggable: {}",
605 ec2);
606 messages::internalError(asyncResp->res);
607 return;
608 }
609 asyncResp->res.jsonValue["HotPluggable"] = property;
610 });
Chau Ly7164bc62023-10-15 14:55:30 +0000611 }
Carson Labradob4d593f2024-02-16 22:34:32 +0000612 else if (interface == revisionInterface)
613 {
Ed Tanousdeae6a72024-11-11 21:58:57 -0800614 dbus::utility::getProperty<std::string>(
615 connectionName, path, revisionInterface, "Version",
Carson Labradob4d593f2024-02-16 22:34:32 +0000616 [asyncResp, chassisId](const boost::system::error_code& ec2,
617 const std::string& property) {
Patrick Williamsbd79bce2024-08-16 15:22:20 -0400618 if (ec2)
619 {
620 BMCWEB_LOG_ERROR(
621 "DBus response error for Version: {}", ec2);
622 messages::internalError(asyncResp->res);
623 return;
624 }
625 asyncResp->res.jsonValue["Version"] = property;
626 });
Carson Labradob4d593f2024-02-16 22:34:32 +0000627 }
Chau Ly7164bc62023-10-15 14:55:30 +0000628 }
629
630 for (const char* interface : hasIndicatorLed)
631 {
632 if (std::ranges::find(interfaces2, interface) != interfaces2.end())
633 {
Janet Adkinsf664fd82025-07-23 14:01:43 -0500634 if constexpr (BMCWEB_REDFISH_ALLOW_DEPRECATED_INDICATORLED)
635 {
636 getIndicatorLedState(asyncResp);
637 }
Janet Adkinsde8e5142025-04-17 10:30:43 -0500638 getLocationIndicatorActive(asyncResp, objPath);
Chau Ly7164bc62023-10-15 14:55:30 +0000639 break;
640 }
641 }
642
Ed Tanousdeae6a72024-11-11 21:58:57 -0800643 dbus::utility::getAllProperties(
Chau Ly7164bc62023-10-15 14:55:30 +0000644 *crow::connections::systemBus, connectionName, path,
645 "xyz.openbmc_project.Inventory.Decorator.Asset",
646 [asyncResp, chassisId,
647 path](const boost::system::error_code&,
648 const dbus::utility::DBusPropertiesMap& propertiesList) {
Patrick Williamsbd79bce2024-08-16 15:22:20 -0400649 handleDecoratorAssetProperties(asyncResp, chassisId, path,
650 propertiesList);
651 });
Chau Ly7164bc62023-10-15 14:55:30 +0000652
Ed Tanous46f780f2025-02-09 09:35:23 -0800653 dbus::utility::getAllProperties(
Joseph-Jonathan Salzano2952f642024-11-19 12:00:06 -0700654 *crow::connections::systemBus, connectionName, path,
655 "xyz.openbmc_project.Inventory.Item.Chassis",
656 [asyncResp](
657 const boost::system::error_code&,
658 const dbus::utility::DBusPropertiesMap& propertiesList) {
659 handleChassisProperties(asyncResp, propertiesList);
660 });
661
Chau Ly7164bc62023-10-15 14:55:30 +0000662 for (const auto& interface : interfaces2)
663 {
664 if (interface == "xyz.openbmc_project.Common.UUID")
665 {
666 getChassisUUID(asyncResp, connectionName, path);
667 }
668 else if (interface ==
669 "xyz.openbmc_project.Inventory.Decorator.LocationCode")
670 {
671 getChassisLocationCode(asyncResp, connectionName, path);
672 }
673 }
674
675 return;
676 }
677
678 // Couldn't find an object with that name. return an error
679 messages::resourceNotFound(asyncResp->res, "Chassis", chassisId);
680}
681
Patrick Williams504af5a2025-02-03 14:29:03 -0500682inline void handleChassisGet(
683 App& app, const crow::Request& req,
684 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
685 const std::string& chassisId)
Nan Zhoucf7eba02022-07-21 23:53:20 +0000686{
687 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
688 {
689 return;
690 }
Nan Zhoucf7eba02022-07-21 23:53:20 +0000691
George Liue99073f2022-12-09 11:06:16 +0800692 dbus::utility::getSubTree(
Myung Bae3f95a272024-03-13 07:32:02 -0700693 "/xyz/openbmc_project/inventory", 0, chassisInterfaces,
Chau Ly7164bc62023-10-15 14:55:30 +0000694 std::bind_front(handleChassisGetSubTree, asyncResp, chassisId));
Nan Zhoucf7eba02022-07-21 23:53:20 +0000695
Chau Ly7164bc62023-10-15 14:55:30 +0000696 constexpr std::array<std::string_view, 1> interfaces2 = {
697 "xyz.openbmc_project.Chassis.Intrusion"};
Nan Zhoucf7eba02022-07-21 23:53:20 +0000698
Chau Ly7164bc62023-10-15 14:55:30 +0000699 dbus::utility::getSubTree(
700 "/xyz/openbmc_project", 0, interfaces2,
701 std::bind_front(handlePhysicalSecurityGetSubTree, asyncResp));
Nan Zhoucf7eba02022-07-21 23:53:20 +0000702}
703
Patrick Williams504af5a2025-02-03 14:29:03 -0500704inline void handleChassisPatch(
705 App& app, const crow::Request& req,
706 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
707 const std::string& param)
Nan Zhoucf7eba02022-07-21 23:53:20 +0000708{
709 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
710 {
711 return;
712 }
713 std::optional<bool> locationIndicatorActive;
714 std::optional<std::string> indicatorLed;
715
716 if (param.empty())
717 {
718 return;
719 }
720
Patrick Williams504af5a2025-02-03 14:29:03 -0500721 if (!json_util::readJsonPatch( //
722 req, asyncResp->res, //
723 "IndicatorLED", indicatorLed, //
Myung Baeafc474a2024-10-09 00:53:29 -0700724 "LocationIndicatorActive", locationIndicatorActive //
725 ))
Nan Zhoucf7eba02022-07-21 23:53:20 +0000726 {
727 return;
728 }
729
Nan Zhoucf7eba02022-07-21 23:53:20 +0000730 if (!locationIndicatorActive && !indicatorLed)
731 {
732 return; // delete this when we support more patch properties
733 }
734 if (indicatorLed)
735 {
Janet Adkinsf664fd82025-07-23 14:01:43 -0500736 if constexpr (BMCWEB_REDFISH_ALLOW_DEPRECATED_INDICATORLED)
737 {
738 asyncResp->res.addHeader(
739 boost::beast::http::field::warning,
740 "299 - \"IndicatorLED is deprecated. Use LocationIndicatorActive instead.\"");
741 }
742 else
743 {
744 messages::propertyUnknown(asyncResp->res, "IndicatorLED");
745 return;
746 }
Nan Zhoucf7eba02022-07-21 23:53:20 +0000747 }
748
Nan Zhoucf7eba02022-07-21 23:53:20 +0000749 const std::string& chassisId = param;
750
George Liue99073f2022-12-09 11:06:16 +0800751 dbus::utility::getSubTree(
Myung Bae3f95a272024-03-13 07:32:02 -0700752 "/xyz/openbmc_project/inventory", 0, chassisInterfaces,
Nan Zhoucf7eba02022-07-21 23:53:20 +0000753 [asyncResp, chassisId, locationIndicatorActive,
Ed Tanous5e7e2dc2023-02-16 10:37:01 -0800754 indicatorLed](const boost::system::error_code& ec,
Nan Zhoucf7eba02022-07-21 23:53:20 +0000755 const dbus::utility::MapperGetSubTreeResponse& subtree) {
Patrick Williamsbd79bce2024-08-16 15:22:20 -0400756 if (ec)
Nan Zhoucf7eba02022-07-21 23:53:20 +0000757 {
Patrick Williamsbd79bce2024-08-16 15:22:20 -0400758 BMCWEB_LOG_ERROR("DBUS response error {}", ec);
759 messages::internalError(asyncResp->res);
760 return;
Nan Zhoucf7eba02022-07-21 23:53:20 +0000761 }
762
Patrick Williamsbd79bce2024-08-16 15:22:20 -0400763 // Iterate over all retrieved ObjectPaths.
764 for (const std::pair<std::string,
765 std::vector<std::pair<
766 std::string, std::vector<std::string>>>>&
767 object : subtree)
Nan Zhoucf7eba02022-07-21 23:53:20 +0000768 {
Patrick Williamsbd79bce2024-08-16 15:22:20 -0400769 const std::string& path = object.first;
770 const std::vector<
771 std::pair<std::string, std::vector<std::string>>>&
772 connectionNames = object.second;
773
774 sdbusplus::message::object_path objPath(path);
775 if (objPath.filename() != chassisId)
776 {
777 continue;
778 }
779
780 if (connectionNames.empty())
781 {
782 BMCWEB_LOG_ERROR("Got 0 Connection names");
783 continue;
784 }
785
786 const std::vector<std::string>& interfaces3 =
787 connectionNames[0].second;
788
789 const std::array<const char*, 3> hasIndicatorLed = {
790 "xyz.openbmc_project.Inventory.Item.Chassis",
791 "xyz.openbmc_project.Inventory.Item.Panel",
792 "xyz.openbmc_project.Inventory.Item.Board.Motherboard"};
793 bool indicatorChassis = false;
794 for (const char* interface : hasIndicatorLed)
795 {
796 if (std::ranges::find(interfaces3, interface) !=
797 interfaces3.end())
798 {
799 indicatorChassis = true;
800 break;
801 }
802 }
803 if (locationIndicatorActive)
804 {
805 if (indicatorChassis)
806 {
Janet Adkinsde8e5142025-04-17 10:30:43 -0500807 setLocationIndicatorActive(asyncResp, path,
808 *locationIndicatorActive);
Patrick Williamsbd79bce2024-08-16 15:22:20 -0400809 }
810 else
811 {
812 messages::propertyUnknown(asyncResp->res,
813 "LocationIndicatorActive");
814 }
815 }
Janet Adkinsf664fd82025-07-23 14:01:43 -0500816 if constexpr (BMCWEB_REDFISH_ALLOW_DEPRECATED_INDICATORLED)
Patrick Williamsbd79bce2024-08-16 15:22:20 -0400817 {
Janet Adkinsf664fd82025-07-23 14:01:43 -0500818 if (indicatorLed)
Patrick Williamsbd79bce2024-08-16 15:22:20 -0400819 {
Janet Adkinsf664fd82025-07-23 14:01:43 -0500820 if (indicatorChassis)
821 {
822 setIndicatorLedState(asyncResp, *indicatorLed);
823 }
824 else
825 {
826 messages::propertyUnknown(asyncResp->res,
827 "IndicatorLED");
828 }
Patrick Williamsbd79bce2024-08-16 15:22:20 -0400829 }
830 }
831 return;
Nan Zhoucf7eba02022-07-21 23:53:20 +0000832 }
833
Patrick Williamsbd79bce2024-08-16 15:22:20 -0400834 messages::resourceNotFound(asyncResp->res, "Chassis", chassisId);
835 });
Nan Zhoucf7eba02022-07-21 23:53:20 +0000836}
837
Rapkiewicz, Pawele37f8452018-03-09 13:49:50 +0100838/**
839 * Chassis override class for delivering Chassis Schema
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700840 * Functions triggers appropriate requests on DBus
Rapkiewicz, Pawele37f8452018-03-09 13:49:50 +0100841 */
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700842inline void requestRoutesChassis(App& app)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700843{
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700844 BMCWEB_ROUTE(app, "/redfish/v1/Chassis/<str>/")
Ed Tanoused398212021-06-09 17:05:54 -0700845 .privileges(redfish::privileges::getChassis)
Ed Tanous002d39b2022-05-31 08:59:27 -0700846 .methods(boost::beast::http::verb::get)(
Nan Zhoucf7eba02022-07-21 23:53:20 +0000847 std::bind_front(handleChassisGet, std::ref(app)));
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700848
849 BMCWEB_ROUTE(app, "/redfish/v1/Chassis/<str>/")
Ed Tanoused398212021-06-09 17:05:54 -0700850 .privileges(redfish::privileges::patchChassis)
Ed Tanous002d39b2022-05-31 08:59:27 -0700851 .methods(boost::beast::http::verb::patch)(
Nan Zhoucf7eba02022-07-21 23:53:20 +0000852 std::bind_front(handleChassisPatch, std::ref(app)));
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700853}
P.K. Leedd99e042020-06-17 19:43:16 +0800854
Patrick Williams504af5a2025-02-03 14:29:03 -0500855inline void doChassisPowerCycle(
856 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
P.K. Leedd99e042020-06-17 19:43:16 +0800857{
George Liu7a1dbc42022-12-07 16:03:22 +0800858 constexpr std::array<std::string_view, 1> interfaces = {
Vijay Khemkac3b3c922020-09-22 23:00:12 -0700859 "xyz.openbmc_project.State.Chassis"};
860
861 // Use mapper to get subtree paths.
George Liu7a1dbc42022-12-07 16:03:22 +0800862 dbus::utility::getSubTreePaths(
863 "/", 0, interfaces,
Ed Tanousb9d36b42022-02-26 21:42:46 -0800864 [asyncResp](
George Liu7a1dbc42022-12-07 16:03:22 +0800865 const boost::system::error_code& ec,
Ed Tanousb9d36b42022-02-26 21:42:46 -0800866 const dbus::utility::MapperGetSubTreePathsResponse& chassisList) {
Patrick Williamsbd79bce2024-08-16 15:22:20 -0400867 if (ec)
868 {
869 BMCWEB_LOG_ERROR("[mapper] Bad D-Bus request error: {}", ec);
870 messages::internalError(asyncResp->res);
871 return;
872 }
Ed Tanous002d39b2022-05-31 08:59:27 -0700873
Patrick Williamsbd79bce2024-08-16 15:22:20 -0400874 const char* processName = "xyz.openbmc_project.State.Chassis";
875 const char* interfaceName = "xyz.openbmc_project.State.Chassis";
876 const char* destProperty = "RequestedPowerTransition";
877 const std::string propertyValue =
878 "xyz.openbmc_project.State.Chassis.Transition.PowerCycle";
879 std::string objectPath =
880 "/xyz/openbmc_project/state/chassis_system0";
Ed Tanous002d39b2022-05-31 08:59:27 -0700881
Patrick Williamsbd79bce2024-08-16 15:22:20 -0400882 /* Look for system reset chassis path */
883 if ((std::ranges::find(chassisList, objectPath)) ==
884 chassisList.end())
885 {
886 /* We prefer to reset the full chassis_system, but if it doesn't
887 * exist on some platforms, fall back to a host-only power reset
888 */
889 objectPath = "/xyz/openbmc_project/state/chassis0";
890 }
Ed Tanous002d39b2022-05-31 08:59:27 -0700891
Patrick Williamsbd79bce2024-08-16 15:22:20 -0400892 setDbusProperty(asyncResp, "ResetType", processName, objectPath,
893 interfaceName, destProperty, propertyValue);
894 });
P.K. Leedd99e042020-06-17 19:43:16 +0800895}
896
Nan Zhoucf7eba02022-07-21 23:53:20 +0000897inline void handleChassisResetActionInfoPost(
898 App& app, const crow::Request& req,
899 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
900 const std::string& /*chassisId*/)
901{
902 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
903 {
904 return;
905 }
Ed Tanous62598e32023-07-17 17:06:25 -0700906 BMCWEB_LOG_DEBUG("Post Chassis Reset.");
Nan Zhoucf7eba02022-07-21 23:53:20 +0000907
908 std::string resetType;
909
910 if (!json_util::readJsonAction(req, asyncResp->res, "ResetType", resetType))
911 {
912 return;
913 }
914
915 if (resetType != "PowerCycle")
916 {
Ed Tanous62598e32023-07-17 17:06:25 -0700917 BMCWEB_LOG_DEBUG("Invalid property value for ResetType: {}", resetType);
Nan Zhoucf7eba02022-07-21 23:53:20 +0000918 messages::actionParameterNotSupported(asyncResp->res, resetType,
919 "ResetType");
920
921 return;
922 }
923 doChassisPowerCycle(asyncResp);
924}
925
P.K. Leedd99e042020-06-17 19:43:16 +0800926/**
927 * ChassisResetAction class supports the POST method for the Reset
928 * action.
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700929 * Function handles POST method request.
930 * Analyzes POST body before sending Reset request data to D-Bus.
P.K. Leedd99e042020-06-17 19:43:16 +0800931 */
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700932
933inline void requestRoutesChassisResetAction(App& app)
P.K. Leedd99e042020-06-17 19:43:16 +0800934{
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700935 BMCWEB_ROUTE(app, "/redfish/v1/Chassis/<str>/Actions/Chassis.Reset/")
Ed Tanoused398212021-06-09 17:05:54 -0700936 .privileges(redfish::privileges::postChassis)
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700937 .methods(boost::beast::http::verb::post)(
Nan Zhoucf7eba02022-07-21 23:53:20 +0000938 std::bind_front(handleChassisResetActionInfoPost, std::ref(app)));
939}
P.K. Leedd99e042020-06-17 19:43:16 +0800940
Nan Zhoucf7eba02022-07-21 23:53:20 +0000941inline void handleChassisResetActionInfoGet(
942 App& app, const crow::Request& req,
943 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
944 const std::string& chassisId)
945{
946 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
947 {
948 return;
949 }
950 asyncResp->res.jsonValue["@odata.type"] = "#ActionInfo.v1_1_2.ActionInfo";
Ed Tanousef4c65b2023-04-24 15:28:50 -0700951 asyncResp->res.jsonValue["@odata.id"] = boost::urls::format(
952 "/redfish/v1/Chassis/{}/ResetActionInfo", chassisId);
Nan Zhoucf7eba02022-07-21 23:53:20 +0000953 asyncResp->res.jsonValue["Name"] = "Reset Action Info";
P.K. Leedd99e042020-06-17 19:43:16 +0800954
Nan Zhoucf7eba02022-07-21 23:53:20 +0000955 asyncResp->res.jsonValue["Id"] = "ResetActionInfo";
956 nlohmann::json::array_t parameters;
957 nlohmann::json::object_t parameter;
958 parameter["Name"] = "ResetType";
959 parameter["Required"] = true;
Ed Tanous539d8c62024-06-19 14:38:27 -0700960 parameter["DataType"] = action_info::ParameterTypes::String;
Nan Zhoucf7eba02022-07-21 23:53:20 +0000961 nlohmann::json::array_t allowed;
Patrick Williamsad539542023-05-12 10:10:08 -0500962 allowed.emplace_back("PowerCycle");
Nan Zhoucf7eba02022-07-21 23:53:20 +0000963 parameter["AllowableValues"] = std::move(allowed);
Patrick Williamsad539542023-05-12 10:10:08 -0500964 parameters.emplace_back(std::move(parameter));
P.K. Leedd99e042020-06-17 19:43:16 +0800965
Nan Zhoucf7eba02022-07-21 23:53:20 +0000966 asyncResp->res.jsonValue["Parameters"] = std::move(parameters);
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700967}
AppaRao Puli1cb1a9e2020-07-17 23:38:57 +0530968
969/**
970 * ChassisResetActionInfo derived class for delivering Chassis
971 * ResetType AllowableValues using ResetInfo schema.
972 */
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700973inline void requestRoutesChassisResetActionInfo(App& app)
AppaRao Puli1cb1a9e2020-07-17 23:38:57 +0530974{
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700975 BMCWEB_ROUTE(app, "/redfish/v1/Chassis/<str>/ResetActionInfo/")
Ed Tanoused398212021-06-09 17:05:54 -0700976 .privileges(redfish::privileges::getActionInfo)
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700977 .methods(boost::beast::http::verb::get)(
Nan Zhoucf7eba02022-07-21 23:53:20 +0000978 std::bind_front(handleChassisResetActionInfoGet, std::ref(app)));
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700979}
AppaRao Puli1cb1a9e2020-07-17 23:38:57 +0530980
Ed Tanous1abe55e2018-09-05 08:30:59 -0700981} // namespace redfish