commit | ae16a89913b06505551738bc0d33e3a1c188c12b | [log] [tgz] |
---|---|---|
author | Myung Bae <myungbae@us.ibm.com> | Tue Aug 20 07:59:08 2024 -0700 |
committer | Myung Bae <myungbae@us.ibm.com> | Fri Sep 12 15:16:01 2025 +0000 |
tree | 19706408381b1c08285eeb8f437daf753c6a74e9 | |
parent | 7842c99f138b209a19c2d24387406060a4be47f4 [diff] |
Add Port Status information for Fabric Port This commit is to add status and health information to Fabric Port like other Redfish resources which implement State/Health and map them to Present/Functional respectfully. State / Health of the Port is useful information for inventory on a GUI/Debug/etc If the `xyz.openbmc_project.Inventory.Item` interface does not exist, the state status property is set to default "Enabled". If the `xyz.openbmc_project.State.Decorator.OperationalStatus` interface does not exist, the health status property is set to default "OK". Tested: - Redfish Validator passed - Check status from GET Port output ``` % curl -k -X GET https://${bmc}:18080/redfish/v1/Systems/system/FabricAdapters/disk_backplane0/Ports/dp0_connector4 { "@odata.id": "/redfish/v1/Systems/system/FabricAdapters/disk_backplane0/Ports/dp0_connector4", "@odata.type": "#Port.v1_7_0.Port", "Id": "dp0_connector4", "Location": { "PartLocation": { "ServiceLabel": "U78DA.ND0.WZS003T-P1-T4" } }, "Name": "dp0_connector4", "Status": { "Health": "OK", "State": "Enabled" } } ``` Change-Id: Ibb625f2ef1378f77c9520426d2687e305b4f8be5 Signed-off-by: Myung Bae <myungbae@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.