commit | de8e51449a09e132d2b19fc6ebddc53dff067d63 | [log] [tgz] |
---|---|---|
author | Janet Adkins <janeta@us.ibm.com> | Thu Apr 17 10:30:43 2025 -0500 |
committer | Gunnar Mills <gunnar@gmills.xyz> | Tue Jul 22 00:31:23 2025 +0000 |
tree | c714ad49e5cdb2b80ba3b3717a0a628ca330bdc5 | |
parent | d49d847c910d9b3ec71213cda4025228ee3866c1 [diff] |
Chassis: Update LocationIndicatorActive property Modify get/set of LocationIndicatorActive property for Chassis to use identifying association instead of hard-coding D-Bus path to led group.[1] History: Almost 5 years ago IBM added support for this property to the Chassis.[2] That original implementation assumed 1 chassis and just looked at the enclosure_identify_blink and enclosure_identify like the existing IndicatorLED property did. IBM renamed these functions getSystemLocationIndicatorActive and setSystemLocationIndicatorActive.[3] These functions are also used by the system resource. The interest from other companies has mostly been around IndicatorLED (old deprecated LED property).[4] Today, LEDs have the association documented above and used elsewhere like PowerSupplies, Fans, etc. Switching to this association: 1) follows the design 2) allows multiple chassis support 3) doesn't assume your system led is your chassis led. In the future: 1) system should also move to this association design 2) IndicatorLED should be deprecated - it has been 5 years This could be put behind a compile flag but this function is broken with the assumption the system/chassis are the same led. Let's just move to the new design. IBM drove all these changes in and although other companies have shown interest around LEDs in Redfish, there hasn't been much in OpenBMC, so let's just fix. [1] https://gerrit.openbmc.org/c/openbmc/phosphor-dbus-interfaces/+/58299 [2] https://gerrit.openbmc.org/c/openbmc/bmcweb/+/36886 [3] https://gerrit.openbmc.org/c/openbmc/bmcweb/+/57765 [4] https://gerrit.openbmc.org/c/openbmc/bmcweb/+/40969 Tested: - Redfish Service Validator passes - Confirm able to set and get LED 1. Get for Chassis ``` curl -k -H "X-Auth-Token: $token" -X GET https://${bmc}/redfish/v1/Chassis/chassis { "@odata.id": "/redfish/v1/Chassis/chassis", "@odata.type": "#Chassis.v1_22_0.Chassis", ... "LocationIndicatorActive": false, ... } ``` 2. Set for Chassis ``` curl -k -H "X-Auth-Token: $token" H "Content-Type: application/json" -X PATCH -d '{"LocationIndicatorActive":true}' https://${bmc}/redfish/v1/Chassis/chassis curl -k -H "X-Auth-Token: $token" -X GET https://${bmc}/redfish/v1/Chassis/chassis { "@odata.id": "/redfish/v1/Chassis/chassis", "@odata.type": "#Chassis.v1_22_0.Chassis", ... "LocationIndicatorActive": true, ... } ``` Change-Id: I78d07f82a8bbf91adb84e53178d3344ba95c9a14 Signed-off-by: Janet Adkins <janeta@us.ibm.com>
This component attempts to be a "do everything" embedded webserver for OpenBMC.
The webserver implements a few distinct interfaces:
bmcweb at a protocol level supports http and https. TLS is supported through OpenSSL. Http1 and http2 are supported using ALPN registration for TLS connections and h2c upgrade header for http connections.
Bmcweb supports multiple authentication protocols:
Each of these types of authentication is able to be enabled or disabled both via runtime policy changes (through the relevant Redfish APIs) or via configure time options. All authentication mechanisms supporting username/password are routed to libpam, to allow for customization in authentication implementations.
All authorization in bmcweb is determined at routing time, and per route, and conform to the Redfish PrivilegeRegistry.
*Note: Non-Redfish functions are mapped to the closest equivalent Redfish privilege level.
bmcweb is configured per the meson build files. Available options are documented in meson_options.txt
meson setup builddir ninja -C builddir
If any of the dependencies are not found on the host system during configuration, meson will automatically download them via its wrap dependencies mentioned in bmcweb/subprojects
.
bmcweb relies on some on-system data for storage of persistent data that is internal to the process. Details on the exact data stored and when it is read/written can seen from the persistent_data
namespace.
When SSL support is enabled and a usable certificate is not found, bmcweb will generate a self-signed a certificate before launching the server. Please see the bmcweb source code for details on the parameters this certificate is built with.
bmcweb supports various forms of http compression, including zstd and gzip. Client headers are observed to determine whether compressed payloads are supported.
bmcweb is capable of aggregating resources from satellite BMCs. Refer to AGGREGATION.md for more information on how to enable and use this feature.