diff options
Diffstat (limited to 'meta-openbmc-mods/meta-common/recipes-phosphor/interfaces/bmcweb')
7 files changed, 1536 insertions, 3 deletions
diff --git a/meta-openbmc-mods/meta-common/recipes-phosphor/interfaces/bmcweb/0032-Remove-chassis-from-the-odata-id-of-the-PSU.patch b/meta-openbmc-mods/meta-common/recipes-phosphor/interfaces/bmcweb/0032-Remove-chassis-from-the-odata-id-of-the-PSU.patch new file mode 100644 index 000000000..9951a83c0 --- /dev/null +++ b/meta-openbmc-mods/meta-common/recipes-phosphor/interfaces/bmcweb/0032-Remove-chassis-from-the-odata-id-of-the-PSU.patch @@ -0,0 +1,49 @@ +From dd4a6807841555ccc23aa2ac8b2c876101408563 Mon Sep 17 00:00:00 2001 +From: Anjaliintel-21 <anjali.ray@intel.com> +Date: Thu, 3 Mar 2022 19:42:05 +0000 +Subject: [PATCH] Remove chassis from the odata.id of the PSU + +As the Redfish validator was failing for the PSU because odata.id +of the PSU was showing a chassis device URI and the GET operation on +that URI was giving error. +So, to resolve this problem we removed chassis URI from the PSU's json +response. + +Tested: + +*** /redfish/v1/Managers/bmc#/Oem/OpenBmc/Fan/FanZones/PSU +No parent found with which to test @odata.id of ReferenceableMember +Type (#OemManager.FanZone), GET SUCCESS (time: 1.212592) +PASS +Elapsed time: 0:01:06 +Counter({'metadataNamespaces': 2335, 'pass': 2, 'passGet': 1, +'skipOptional': 1, 'warningPresent': 1, 'serviceNamespaces': 1}) +Validation has succeeded. + +Signed-off-by: Anjaliintel-21 <anjali.ray@intel.com> +--- + redfish-core/lib/managers.hpp | 8 ++++++-- + 1 file changed, 6 insertions(+), 2 deletions(-) + +diff --git a/redfish-core/lib/managers.hpp b/redfish-core/lib/managers.hpp +index 7b0e14c..9ed87ef 100644 +--- a/redfish-core/lib/managers.hpp ++++ b/redfish-core/lib/managers.hpp +@@ -371,8 +371,12 @@ inline void + chassis = "#IllegalValue"; + } + nlohmann::json& zone = zones[name]; +- zone["Chassis"] = { +- {"@odata.id", "/redfish/v1/Chassis/" + chassis}}; ++ if (name != "PSU") ++ { ++ zone["Chassis"] = { ++ {"@odata.id", ++ "/redfish/v1/Chassis/" + chassis}}; ++ } + zone["@odata.id"] = + "/redfish/v1/Managers/bmc#/Oem/OpenBmc/Fan/FanZones/" + + name; +-- +2.17.1 + diff --git a/meta-openbmc-mods/meta-common/recipes-phosphor/interfaces/bmcweb/0033-Add-message-registry-entry-for-Memhot-event.patch b/meta-openbmc-mods/meta-common/recipes-phosphor/interfaces/bmcweb/0033-Add-message-registry-entry-for-Memhot-event.patch new file mode 100644 index 000000000..ddf239e99 --- /dev/null +++ b/meta-openbmc-mods/meta-common/recipes-phosphor/interfaces/bmcweb/0033-Add-message-registry-entry-for-Memhot-event.patch @@ -0,0 +1,80 @@ +From 31661f341a32e07967f5e3279b79771823275395 Mon Sep 17 00:00:00 2001 +From: Hardik Panchal <hardikx.panchal@intel.com> +Date: Thu, 24 Mar 2022 12:29:48 +0000 +Subject: [PATCH] Add message registry entry for Memhot event + +Add "ComponentOverTemperature" event message entry in RedFish for +Memhot monitor to log based on the MEMHOT pins. + +Tested: +1. Redfish validator - passed for this new addition +2. Verified in Redfish, ComponentOverTemperature event logged properly. +GET: +https:/<BMC-IP>/redfish/v1/Systems/system/LogServices/EventLog/Entries +{ + "@odata.id": "/redfish/v1/Systems/system/LogServices/EventLog/ + Entries/1648143395", + "@odata.type": "#LogEntry.v1_8_0.LogEntry", + "Created": "2022-03-24T17:36:35+00:00", + "EntryType": "Event", + "Id": "1648143395", + "Message": "CPU 1 memory over temperature and being throttled.", + "MessageArgs": [ + "CPU 1 memory" + ], + "MessageId": "OpenBMC.0.1.ComponentOverTemperature", + "Name": "System Event Log Entry", + "Severity": "Critical" +} + +Signed-off-by: Hardik Panchal <hardikx.panchal@intel.com> +--- + .../registries/openbmc_message_registry.hpp | 18 ++++++++++++++---- + 1 file changed, 14 insertions(+), 4 deletions(-) + +diff --git a/redfish-core/include/registries/openbmc_message_registry.hpp b/redfish-core/include/registries/openbmc_message_registry.hpp +index 0b409cf..a181080 100644 +--- a/redfish-core/include/registries/openbmc_message_registry.hpp ++++ b/redfish-core/include/registries/openbmc_message_registry.hpp +@@ -19,17 +19,17 @@ + namespace redfish::message_registries::openbmc + { + const Header header = { +- "Copyright 2018 OpenBMC. All rights reserved.", ++ "Copyright 2022 OpenBMC. All rights reserved.", + "#MessageRegistry.v1_4_0.MessageRegistry", +- "OpenBMC.0.3.0", ++ "OpenBMC.0.3.1", + "OpenBMC Message Registry", + "en", + "This registry defines the base messages for OpenBMC.", + "OpenBMC", +- "0.3.0", ++ "0.3.1", + "OpenBMC", + }; +-constexpr std::array<MessageEntry, 199> registry = { ++constexpr std::array<MessageEntry, 200> registry = { + MessageEntry{ + "ADDDCCorrectable", + { +@@ -340,6 +340,16 @@ constexpr std::array<MessageEntry, 199> registry = { + {}, + "None.", + }}, ++ MessageEntry{"ComponentOverTemperature", ++ { ++ "Indicates that the specified component is over temperature.", ++ "%1 over temperature and being throttled.", ++ "Critical", ++ "Critical", ++ 1, ++ {"string"}, ++ "None.", ++ }}, + MessageEntry{"CPLDFirmwarePanicReason", + { + "Indicates the reason for CPLD firmware panic.", +-- +2.17.1 + diff --git a/meta-openbmc-mods/meta-common/recipes-phosphor/interfaces/bmcweb/0034-Update-odata.type-version-of-redfish-v1-AccountService.patch b/meta-openbmc-mods/meta-common/recipes-phosphor/interfaces/bmcweb/0034-Update-odata.type-version-of-redfish-v1-AccountService.patch new file mode 100644 index 000000000..3269b5ca0 --- /dev/null +++ b/meta-openbmc-mods/meta-common/recipes-phosphor/interfaces/bmcweb/0034-Update-odata.type-version-of-redfish-v1-AccountService.patch @@ -0,0 +1,47 @@ +From 9f159168ab5b1e0e73f4af8dd4536e77b440ad0b Mon Sep 17 00:00:00 2001 +From: Anjaliintel-21 <anjali.ray@intel.com> +Date: Mon, 28 Mar 2022 09:43:03 +0000 +Subject: [PATCH] Update odata.type version of /redfish/v1/AccountService/ + +Redfish validator was failing and throwing below error: +*** /redfish/v1/AccountService +AccountService.v1_10_0.ExternalAccountProvider:OAuth2Service : +Could not get details on this property (argument of type 'NoneType' is not iterable) +Type (#AccountService.v1_5_0.AccountService), GET SUCCESS (time: 1.283549) +complex @odata.id: Expected @odata.id to match URI link +/redfish/v1/AccountService#/Oem/OpenBMC +FAIL... + +As AccountService_v1.xml version was v1.10.0 and the odata.type was +"AccountService.v1_5_0.AccountService" which was mismatch. +So I updated odata.type to AccountService.v1_10_0.AccountService". + +Tested: + +*** /redfish/v1/AccountService + Type (#AccountService.v1_10_0.AccountService), GET SUCCESS (time: 1.286845) +complex @odata.id: Expected @odata.id to match URI link +/redfish/v1/AccountService#/Oem/OpenBMC + PASS + +Signed-off-by: Anjaliintel-21 <anjali.ray@intel.com> +--- + redfish-core/lib/account_service.hpp | 2 +- + 1 file changed, 1 insertion(+), 1 deletion(-) + +diff --git a/redfish-core/lib/account_service.hpp b/redfish-core/lib/account_service.hpp +index 55ce6ae..b1950f7 100644 +--- a/redfish-core/lib/account_service.hpp ++++ b/redfish-core/lib/account_service.hpp +@@ -1280,7 +1280,7 @@ inline void requestAccountServiceRoutes(App& app) + asyncResp->res.jsonValue = { + {"@odata.id", "/redfish/v1/AccountService"}, + {"@odata.type", "#AccountService." +- "v1_5_0.AccountService"}, ++ "v1_10_0.AccountService"}, + {"Id", "AccountService"}, + {"Name", "Account Service"}, + {"Description", "Account Service"}, +-- +2.17.1 + diff --git a/meta-openbmc-mods/meta-common/recipes-phosphor/interfaces/bmcweb/0035-Add-MemoryMetrics-schema-file.patch b/meta-openbmc-mods/meta-common/recipes-phosphor/interfaces/bmcweb/0035-Add-MemoryMetrics-schema-file.patch new file mode 100644 index 000000000..0097fd93a --- /dev/null +++ b/meta-openbmc-mods/meta-common/recipes-phosphor/interfaces/bmcweb/0035-Add-MemoryMetrics-schema-file.patch @@ -0,0 +1,1048 @@ +From ac0154a247412c5891fb61a95fea15a5fd170053 Mon Sep 17 00:00:00 2001 +From: Anjaliintel-21 <anjali.ray@intel.com> +Date: Mon, 4 Apr 2022 20:54:29 +0000 +Subject: [PATCH] Add MemoryMetrics schema file + +As reference URI for MemoryMetrics was missing, +which was causing redfish validator to fail. +So, added reference URI for MemoryMetrics in the +index.xml file and also added "MemoryMetrics" in +update_schemas.py file. + +Tested: + +*** /redfish/v1/Systems/system/Memory/dimm0/MemoryMetrics +Type (#MemoryMetrics.v1_4_1.MemoryMetrics), GET SUCCESS (time: 1.315905) +PASS +Elapsed time: 0:03:35 +Counter({'metadataNamespaces': 2337, 'skipOptional': 9, 'pass': 2, 'passGet': 1, 'serviceNamespaces': 1}) +Validation has succeeded. + +Signed-off-by: Anjaliintel-21 <anjali.ray@intel.com> +--- + scripts/update_schemas.py | 1 + + static/redfish/v1/$metadata/index.xml | 28 ++ + .../MemoryMetrics/MemoryMetrics.json | 473 ++++++++++++++++++ + .../v1/JsonSchemas/MemoryMetrics/index.json | 21 + + static/redfish/v1/JsonSchemas/index.json | 5 +- + static/redfish/v1/schema/MemoryMetrics_v1.xml | 424 ++++++++++++++++ + 6 files changed, 951 insertions(+), 1 deletion(-) + create mode 100644 static/redfish/v1/JsonSchemas/MemoryMetrics/MemoryMetrics.json + create mode 100644 static/redfish/v1/JsonSchemas/MemoryMetrics/index.json + create mode 100644 static/redfish/v1/schema/MemoryMetrics_v1.xml + +diff --git a/scripts/update_schemas.py b/scripts/update_schemas.py +index 3f0f57c..a233291 100755 +--- a/scripts/update_schemas.py ++++ b/scripts/update_schemas.py +@@ -48,6 +48,7 @@ include_list = [ + 'ManagerNetworkProtocol', + 'Memory', + 'MemoryCollection', ++ 'MemoryMetrics', + 'Message', + 'MessageRegistry', + 'MessageRegistryCollection', +diff --git a/static/redfish/v1/$metadata/index.xml b/static/redfish/v1/$metadata/index.xml +index 9b080f3..d7b9e08 100644 +--- a/static/redfish/v1/$metadata/index.xml ++++ b/static/redfish/v1/$metadata/index.xml +@@ -1340,6 +1340,34 @@ + <edmx:Reference Uri="/redfish/v1/schema/MemoryCollection_v1.xml"> + <edmx:Include Namespace="MemoryCollection"/> + </edmx:Reference> ++ <edmx:Reference Uri="/redfish/v1/schema/MemoryMetrics_v1.xml"> ++ <edmx:Include Namespace="MemoryMetrics"/> ++ <edmx:Include Namespace="MemoryMetrics.v1_0_0"/> ++ <edmx:Include Namespace="MemoryMetrics.v1_0_1"/> ++ <edmx:Include Namespace="MemoryMetrics.v1_0_2"/> ++ <edmx:Include Namespace="MemoryMetrics.v1_0_3"/> ++ <edmx:Include Namespace="MemoryMetrics.v1_0_4"/> ++ <edmx:Include Namespace="MemoryMetrics.v1_0_5"/> ++ <edmx:Include Namespace="MemoryMetrics.v1_0_6"/> ++ <edmx:Include Namespace="MemoryMetrics.v1_0_7"/> ++ <edmx:Include Namespace="MemoryMetrics.v1_0_8"/> ++ <edmx:Include Namespace="MemoryMetrics.v1_1_0"/> ++ <edmx:Include Namespace="MemoryMetrics.v1_1_1"/> ++ <edmx:Include Namespace="MemoryMetrics.v1_1_2"/> ++ <edmx:Include Namespace="MemoryMetrics.v1_1_3"/> ++ <edmx:Include Namespace="MemoryMetrics.v1_1_4"/> ++ <edmx:Include Namespace="MemoryMetrics.v1_1_5"/> ++ <edmx:Include Namespace="MemoryMetrics.v1_1_6"/> ++ <edmx:Include Namespace="MemoryMetrics.v1_1_7"/> ++ <edmx:Include Namespace="MemoryMetrics.v1_1_8"/> ++ <edmx:Include Namespace="MemoryMetrics.v1_2_0"/> ++ <edmx:Include Namespace="MemoryMetrics.v1_2_1"/> ++ <edmx:Include Namespace="MemoryMetrics.v1_2_2"/> ++ <edmx:Include Namespace="MemoryMetrics.v1_3_0"/> ++ <edmx:Include Namespace="MemoryMetrics.v1_3_1"/> ++ <edmx:Include Namespace="MemoryMetrics.v1_4_0"/> ++ <edmx:Include Namespace="MemoryMetrics.v1_4_1"/> ++ </edmx:Reference> + <edmx:Reference Uri="/redfish/v1/schema/Message_v1.xml"> + <edmx:Include Namespace="Message"/> + <edmx:Include Namespace="Message.v1_0_0"/> +diff --git a/static/redfish/v1/JsonSchemas/MemoryMetrics/MemoryMetrics.json b/static/redfish/v1/JsonSchemas/MemoryMetrics/MemoryMetrics.json +new file mode 100644 +index 0000000..a841f07 +--- /dev/null ++++ b/static/redfish/v1/JsonSchemas/MemoryMetrics/MemoryMetrics.json +@@ -0,0 +1,473 @@ ++{ ++ "$id": "http://redfish.dmtf.org/schemas/v1/MemoryMetrics.v1_4_1.json", ++ "$ref": "#/definitions/MemoryMetrics", ++ "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json", ++ "copyright": "Copyright 2014-2020 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright", ++ "definitions": { ++ "Actions": { ++ "additionalProperties": false, ++ "description": "The available actions for this resource.", ++ "longDescription": "This type shall contain the available actions for this resource.", ++ "patternProperties": { ++ "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { ++ "description": "This property shall specify a valid odata or Redfish property.", ++ "type": [ ++ "array", ++ "boolean", ++ "integer", ++ "number", ++ "null", ++ "object", ++ "string" ++ ] ++ } ++ }, ++ "properties": { ++ "#MemoryMetrics.ClearCurrentPeriod": { ++ "$ref": "#/definitions/ClearCurrentPeriod" ++ }, ++ "Oem": { ++ "$ref": "#/definitions/OemActions", ++ "description": "The available OEM-specific actions for this resource.", ++ "longDescription": "This property shall contain the available OEM-specific actions for this resource." ++ } ++ }, ++ "type": "object" ++ }, ++ "AlarmTrips": { ++ "additionalProperties": false, ++ "description": "The alarm trip information about the memory. These alarms are reset when the system resets. Note that if they are re-discovered they can be reasserted.", ++ "longDescription": "This type shall contain properties that describe the types of alarms that have been raised by the memory. These alarms shall be reset when the system resets. Note that if they are re-discovered they can be reasserted.", ++ "patternProperties": { ++ "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { ++ "description": "This property shall specify a valid odata or Redfish property.", ++ "type": [ ++ "array", ++ "boolean", ++ "integer", ++ "number", ++ "null", ++ "object", ++ "string" ++ ] ++ } ++ }, ++ "properties": { ++ "AddressParityError": { ++ "description": "An indication of whether an address parity error was detected that a retry could not correct.", ++ "longDescription": "This property shall indicate whether an address parity error was detected that a retry could not correct.", ++ "readonly": true, ++ "type": [ ++ "boolean", ++ "null" ++ ] ++ }, ++ "CorrectableECCError": { ++ "description": "An indication of whether the correctable error threshold crossing alarm trip was detected.", ++ "longDescription": "This property shall indicate whether the correctable error threshold crossing alarm trip was detected.", ++ "readonly": true, ++ "type": [ ++ "boolean", ++ "null" ++ ] ++ }, ++ "SpareBlock": { ++ "description": "An indication of whether the spare block capacity crossing alarm trip was detected.", ++ "longDescription": "This property shall indicate whether the spare block capacity crossing alarm trip was detected.", ++ "readonly": true, ++ "type": [ ++ "boolean", ++ "null" ++ ] ++ }, ++ "Temperature": { ++ "description": "An indication of whether a temperature threshold alarm trip was detected.", ++ "longDescription": "This property shall indicates whether a temperature threshold alarm trip was detected.", ++ "readonly": true, ++ "type": [ ++ "boolean", ++ "null" ++ ] ++ }, ++ "UncorrectableECCError": { ++ "description": "An indication of whether the uncorrectable error threshold alarm trip was detected.", ++ "longDescription": "This property shall indicate whether the uncorrectable error threshold alarm trip was detected.", ++ "readonly": true, ++ "type": [ ++ "boolean", ++ "null" ++ ] ++ } ++ }, ++ "type": "object" ++ }, ++ "ClearCurrentPeriod": { ++ "additionalProperties": false, ++ "description": "This action sets the CurrentPeriod property's values to 0.", ++ "longDescription": "This action shall set the CurrentPeriod property's values to 0.", ++ "parameters": {}, ++ "patternProperties": { ++ "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { ++ "description": "This property shall specify a valid odata or Redfish property.", ++ "type": [ ++ "array", ++ "boolean", ++ "integer", ++ "number", ++ "null", ++ "object", ++ "string" ++ ] ++ } ++ }, ++ "properties": { ++ "target": { ++ "description": "Link to invoke action", ++ "format": "uri-reference", ++ "type": "string" ++ }, ++ "title": { ++ "description": "Friendly action name", ++ "type": "string" ++ } ++ }, ++ "type": "object" ++ }, ++ "CurrentPeriod": { ++ "additionalProperties": false, ++ "description": "The memory metrics since the last system reset or ClearCurrentPeriod action.", ++ "longDescription": "This type shall describe the memory metrics since last system reset or ClearCurrentPeriod action.", ++ "patternProperties": { ++ "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { ++ "description": "This property shall specify a valid odata or Redfish property.", ++ "type": [ ++ "array", ++ "boolean", ++ "integer", ++ "number", ++ "null", ++ "object", ++ "string" ++ ] ++ } ++ }, ++ "properties": { ++ "BlocksRead": { ++ "description": "The number of blocks read since reset.", ++ "longDescription": "This property shall contain the number of blocks read since reset. When this resource is subordinate to the MemorySummary object, this property shall be the sum of BlocksRead over all memory.", ++ "readonly": true, ++ "type": [ ++ "integer", ++ "null" ++ ] ++ }, ++ "BlocksWritten": { ++ "description": "The number of blocks written since reset.", ++ "longDescription": "This property shall contain the number of blocks written since reset. When this resource is subordinate to the MemorySummary object, this property shall be the sum of BlocksWritten over all memory.", ++ "readonly": true, ++ "type": [ ++ "integer", ++ "null" ++ ] ++ }, ++ "CorrectableECCErrorCount": { ++ "description": "The number of the correctable errors since reset.", ++ "longDescription": "This property shall contain the number of correctable errors since reset. When this resource is subordinate to the MemorySummary object, this property shall be the sum of CorrectableECCErrorCount over all memory.", ++ "readonly": true, ++ "type": [ ++ "integer", ++ "null" ++ ], ++ "versionAdded": "v1_4_0" ++ }, ++ "UncorrectableECCErrorCount": { ++ "description": "The number of the uncorrectable errors since reset.", ++ "longDescription": "This property shall contain the number of uncorrectable errors since reset. When this resource is subordinate to the MemorySummary object, this property shall be the sum of UncorrectableECCErrorCount over all memory.", ++ "readonly": true, ++ "type": [ ++ "integer", ++ "null" ++ ], ++ "versionAdded": "v1_4_0" ++ } ++ }, ++ "type": "object" ++ }, ++ "HealthData": { ++ "additionalProperties": false, ++ "description": "The health information of the memory.", ++ "longDescription": "This type shall contain properties that describe the HealthData metrics for this resource.", ++ "patternProperties": { ++ "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { ++ "description": "This property shall specify a valid odata or Redfish property.", ++ "type": [ ++ "array", ++ "boolean", ++ "integer", ++ "number", ++ "null", ++ "object", ++ "string" ++ ] ++ } ++ }, ++ "properties": { ++ "AlarmTrips": { ++ "$ref": "#/definitions/AlarmTrips", ++ "description": "Alarm trip information about the memory.", ++ "longDescription": "This object shall contain properties describe the types of alarms that have been raised by the memory. When this resource is subordinate to the MemorySummary object, this property shall indicate whether an alarm of a given type have been raised by any area of memory." ++ }, ++ "DataLossDetected": { ++ "description": "An indication of whether data loss was detected.", ++ "longDescription": "This property shall indicate whether data loss was detected. When this resource is subordinate to the MemorySummary object, this property shall indicate whether any data loss was detected in any area of memory.", ++ "readonly": true, ++ "type": [ ++ "boolean", ++ "null" ++ ] ++ }, ++ "LastShutdownSuccess": { ++ "description": "An indication of whether the last shutdown succeeded.", ++ "longDescription": "This property shall indicate whether the last shutdown succeeded.", ++ "readonly": true, ++ "type": [ ++ "boolean", ++ "null" ++ ] ++ }, ++ "PerformanceDegraded": { ++ "description": "An indication of whether performance has degraded.", ++ "longDescription": "This property shall indicate whether performance has degraded. When this resource is subordinate to the MemorySummary object, this property shall indicate whether degraded performance mode status is detected in any area of memory.", ++ "readonly": true, ++ "type": [ ++ "boolean", ++ "null" ++ ] ++ }, ++ "PredictedMediaLifeLeftPercent": { ++ "description": "The percentage of reads and writes that are predicted to still be available for the media.", ++ "longDescription": "This property shall contain an indicator of the percentage of life remaining in the media.", ++ "readonly": true, ++ "type": [ ++ "number", ++ "null" ++ ], ++ "units": "%", ++ "versionAdded": "v1_1_0" ++ }, ++ "RemainingSpareBlockPercentage": { ++ "description": "The remaining spare blocks, as a percentage.", ++ "longDescription": "This property shall contain the remaining spare blocks as a percentage. When this resource is subordinate to the MemorySummary object, this property shall be the RemainingSpareBlockPercentage over all memory.", ++ "readonly": true, ++ "type": [ ++ "number", ++ "null" ++ ], ++ "units": "%" ++ } ++ }, ++ "type": "object" ++ }, ++ "LifeTime": { ++ "additionalProperties": false, ++ "description": "The memory metrics for the lifetime of the memory.", ++ "longDescription": "This type shall describe the memory metrics since manufacturing.", ++ "patternProperties": { ++ "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { ++ "description": "This property shall specify a valid odata or Redfish property.", ++ "type": [ ++ "array", ++ "boolean", ++ "integer", ++ "number", ++ "null", ++ "object", ++ "string" ++ ] ++ } ++ }, ++ "properties": { ++ "BlocksRead": { ++ "description": "The number of blocks read for the lifetime of the memory.", ++ "longDescription": "This property shall contain the number of blocks read for the lifetime of the memory. When this resource is subordinate to the MemorySummary object, this property shall be the sum of BlocksRead over all memory.", ++ "readonly": true, ++ "type": [ ++ "integer", ++ "null" ++ ] ++ }, ++ "BlocksWritten": { ++ "description": "The number of blocks written for the lifetime of the memory.", ++ "longDescription": "This property shall contain the number of blocks written for the lifetime of the memory. When this resource is subordinate to the MemorySummary object, this property shall be the sum of BlocksWritten over all memory.", ++ "readonly": true, ++ "type": [ ++ "integer", ++ "null" ++ ] ++ }, ++ "CorrectableECCErrorCount": { ++ "description": "The number of the correctable errors for the lifetime of the memory.", ++ "longDescription": "This property shall contain the number of the correctable errors for the lifetime of the memory. When this resource is subordinate to the MemorySummary object, this property shall be the sum of CorrectableECCErrorCount over all memory.", ++ "readonly": true, ++ "type": [ ++ "integer", ++ "null" ++ ], ++ "versionAdded": "v1_4_0" ++ }, ++ "UncorrectableECCErrorCount": { ++ "description": "The number of the uncorrectable errors for the lifetime of the memory.", ++ "longDescription": "This property shall contain the number of the uncorrectable errors for the lifetime of the memory. When this resource is subordinate to the MemorySummary object, this property shall be the sum of UncorrectableECCErrorCount over all memory.", ++ "readonly": true, ++ "type": [ ++ "integer", ++ "null" ++ ], ++ "versionAdded": "v1_4_0" ++ } ++ }, ++ "type": "object" ++ }, ++ "MemoryMetrics": { ++ "additionalProperties": false, ++ "description": "The usage and health statistics for a memory device or system memory summary.", ++ "longDescription": "The MemoryMetrics schema shall contain the memory metrics for a memory device or system memory summary in a Redfish implementation.", ++ "patternProperties": { ++ "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { ++ "description": "This property shall specify a valid odata or Redfish property.", ++ "type": [ ++ "array", ++ "boolean", ++ "integer", ++ "number", ++ "null", ++ "object", ++ "string" ++ ] ++ } ++ }, ++ "properties": { ++ "@odata.context": { ++ "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" ++ }, ++ "@odata.etag": { ++ "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" ++ }, ++ "@odata.id": { ++ "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id" ++ }, ++ "@odata.type": { ++ "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type" ++ }, ++ "Actions": { ++ "$ref": "#/definitions/Actions", ++ "description": "The available actions for this resource.", ++ "longDescription": "This property shall contain the available actions for this resource." ++ }, ++ "BandwidthPercent": { ++ "description": "The memory bandwidth utilization as a percentage.", ++ "longDescription": "This property shall contain memory bandwidth utilization as a percentage. When this resource is subordinate to the MemorySummary object, this property shall be the memory bandwidth utilization over all memory as a percentage.", ++ "minimum": 0, ++ "readonly": true, ++ "type": [ ++ "number", ++ "null" ++ ], ++ "units": "%", ++ "versionAdded": "v1_2_0" ++ }, ++ "BlockSizeBytes": { ++ "description": "The block size, in bytes.", ++ "longDescription": "This property shall contain the block size, in bytes, of all structure elements. When this resource is subordinate to the MemorySummary object, this property is not applicable.", ++ "readonly": true, ++ "type": [ ++ "integer", ++ "null" ++ ], ++ "units": "By" ++ }, ++ "CurrentPeriod": { ++ "$ref": "#/definitions/CurrentPeriod", ++ "description": "The memory metrics since the last reset or ClearCurrentPeriod action.", ++ "longDescription": "This property shall contain properties that describe the memory metrics for the current period." ++ }, ++ "Description": { ++ "anyOf": [ ++ { ++ "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description" ++ }, ++ { ++ "type": "null" ++ } ++ ], ++ "readonly": true ++ }, ++ "HealthData": { ++ "$ref": "#/definitions/HealthData", ++ "description": "The health information of the memory.", ++ "longDescription": "This property shall contain properties that describe the health data memory metrics for the memory." ++ }, ++ "Id": { ++ "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id", ++ "readonly": true ++ }, ++ "LifeTime": { ++ "$ref": "#/definitions/LifeTime", ++ "description": "The memory metrics for the lifetime of the memory.", ++ "longDescription": "This property shall contain properties that describe the memory metrics for the lifetime of the memory." ++ }, ++ "Name": { ++ "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name", ++ "readonly": true ++ }, ++ "Oem": { ++ "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem", ++ "description": "The OEM extension property.", ++ "longDescription": "This property shall contain the OEM extensions. All values for properties that this object contains shall conform to the Redfish Specification-described requirements." ++ }, ++ "OperatingSpeedMHz": { ++ "description": "Operating speed of memory in MHz or MT/s as appropriate.", ++ "longDescription": "This property shall contain the operating speed of memory in MHz or MT/s (mega-transfers per second) as reported by the memory device. Memory devices that operate at their bus speed shall report the operating speed in MHz (bus speed), while memory devices that transfer data faster than their bus speed, such as DDR memory, shall report the operating speed in MT/s (mega-transfers/second). The reported value shall match the conventionally reported values for the technology used by the memory device.", ++ "readonly": true, ++ "type": [ ++ "integer", ++ "null" ++ ], ++ "units": "MHz", ++ "versionAdded": "v1_3_0" ++ } ++ }, ++ "required": [ ++ "@odata.id", ++ "@odata.type", ++ "Id", ++ "Name" ++ ], ++ "type": "object" ++ }, ++ "OemActions": { ++ "additionalProperties": true, ++ "description": "The available OEM-specific actions for this resource.", ++ "longDescription": "This type shall contain the available OEM-specific actions for this resource.", ++ "patternProperties": { ++ "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { ++ "description": "This property shall specify a valid odata or Redfish property.", ++ "type": [ ++ "array", ++ "boolean", ++ "integer", ++ "number", ++ "null", ++ "object", ++ "string" ++ ] ++ } ++ }, ++ "properties": {}, ++ "type": "object" ++ } ++ }, ++ "owningEntity": "DMTF", ++ "release": "2020.3", ++ "title": "#MemoryMetrics.v1_4_1.MemoryMetrics" ++} +\ No newline at end of file +diff --git a/static/redfish/v1/JsonSchemas/MemoryMetrics/index.json b/static/redfish/v1/JsonSchemas/MemoryMetrics/index.json +new file mode 100644 +index 0000000..e506f59 +--- /dev/null ++++ b/static/redfish/v1/JsonSchemas/MemoryMetrics/index.json +@@ -0,0 +1,21 @@ ++{ ++ "@odata.context": "/redfish/v1/$metadata#JsonSchemaFile.JsonSchemaFile", ++ "@odata.id": "/redfish/v1/JsonSchemas/MemoryMetrics", ++ "@odata.type": "#JsonSchemaFile.v1_0_2.JsonSchemaFile", ++ "Name": "MemoryMetrics Schema File", ++ "Schema": "#MemoryMetrics.MemoryMetrics", ++ "Description": "MemoryMetrics Schema File Location", ++ "Id": "MemoryMetrics", ++ "Languages": [ ++ "en" ++ ], ++ "Languages@odata.count": 1, ++ "Location": [ ++ { ++ "Language": "en", ++ "PublicationUri": "http://redfish.dmtf.org/schemas/v1/MemoryMetrics.json", ++ "Uri": "/redfish/v1/JsonSchemas/MemoryMetrics/MemoryMetrics.json" ++ } ++ ], ++ "Location@odata.count": 1 ++} +\ No newline at end of file +diff --git a/static/redfish/v1/JsonSchemas/index.json b/static/redfish/v1/JsonSchemas/index.json +index 8811f26..fd5abbf 100644 +--- a/static/redfish/v1/JsonSchemas/index.json ++++ b/static/redfish/v1/JsonSchemas/index.json +@@ -4,7 +4,7 @@ + "@odata.type": "#JsonSchemaFileCollection.JsonSchemaFileCollection", + "Name": "JsonSchemaFile Collection", + "Description": "Collection of JsonSchemaFiles", +- "Members@odata.count": 58, ++ "Members@odata.count": 59, + "Members": [ + { + "@odata.id": "/redfish/v1/JsonSchemas/AccountService" +@@ -75,6 +75,9 @@ + { + "@odata.id": "/redfish/v1/JsonSchemas/Memory" + }, ++ { ++ "@odata.id": "/redfish/v1/JsonSchemas/MemoryMetrics" ++ }, + { + "@odata.id": "/redfish/v1/JsonSchemas/Message" + }, +diff --git a/static/redfish/v1/schema/MemoryMetrics_v1.xml b/static/redfish/v1/schema/MemoryMetrics_v1.xml +new file mode 100644 +index 0000000..bfeae79 +--- /dev/null ++++ b/static/redfish/v1/schema/MemoryMetrics_v1.xml +@@ -0,0 +1,424 @@ ++<?xml version="1.0" encoding="UTF-8"?> ++<!----> ++<!--################################################################################ --> ++<!--# Redfish Schema: MemoryMetrics v1.4.1 --> ++<!--# --> ++<!--# For a detailed change log, see the README file contained in the DSP8010 bundle, --> ++<!--# available at http://www.dmtf.org/standards/redfish --> ++<!--# Copyright 2014-2021 DMTF. --> ++<!--# For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright --> ++<!--################################################################################ --> ++<!----> ++<edmx:Edmx xmlns:edmx="http://docs.oasis-open.org/odata/ns/edmx" Version="4.0"> ++ ++ <edmx:Reference Uri="http://docs.oasis-open.org/odata/odata/v4.0/errata03/csd01/complete/vocabularies/Org.OData.Core.V1.xml"> ++ <edmx:Include Namespace="Org.OData.Core.V1" Alias="OData"/> ++ </edmx:Reference> ++ <edmx:Reference Uri="http://docs.oasis-open.org/odata/odata/v4.0/errata03/csd01/complete/vocabularies/Org.OData.Capabilities.V1.xml"> ++ <edmx:Include Namespace="Org.OData.Capabilities.V1" Alias="Capabilities"/> ++ </edmx:Reference> ++ <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Resource_v1.xml"> ++ <edmx:Include Namespace="Resource.v1_0_0"/> ++ </edmx:Reference> ++ <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/RedfishExtensions_v1.xml"> ++ <edmx:Include Namespace="RedfishExtensions.v1_0_0" Alias="Redfish"/> ++ <edmx:Include Namespace="Validation.v1_0_0" Alias="Validation"/> ++ </edmx:Reference> ++ <edmx:Reference Uri="http://docs.oasis-open.org/odata/odata/v4.0/errata03/csd01/complete/vocabularies/Org.OData.Measures.V1.xml"> ++ <edmx:Include Namespace="Org.OData.Measures.V1" Alias="Measures"/> ++ </edmx:Reference> ++ ++ <edmx:DataServices> ++ ++ <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MemoryMetrics"> ++ <Annotation Term="Redfish.OwningEntity" String="DMTF"/> ++ ++ <EntityType Name="MemoryMetrics" BaseType="Resource.v1_0_0.Resource" Abstract="true"> ++ <Annotation Term="OData.Description" String="The usage and health statistics for a memory device or system memory summary."/> ++ <Annotation Term="OData.LongDescription" String="The MemoryMetrics schema shall contain the memory metrics for a memory device or system memory summary in a Redfish implementation."/> ++ <Annotation Term="OData.AdditionalProperties" Bool="false"/> ++ <Annotation Term="Capabilities.InsertRestrictions"> ++ <Record> ++ <PropertyValue Property="Insertable" Bool="false"/> ++ </Record> ++ </Annotation> ++ <Annotation Term="Capabilities.UpdateRestrictions"> ++ <Record> ++ <PropertyValue Property="Updatable" Bool="false"/> ++ </Record> ++ </Annotation> ++ <Annotation Term="Capabilities.DeleteRestrictions"> ++ <Record> ++ <PropertyValue Property="Deletable" Bool="false"/> ++ </Record> ++ </Annotation> ++ <Annotation Term="Redfish.Uris"> ++ <Collection> ++ <String>/redfish/v1/Systems/{ComputerSystemId}/MemorySummary/MemoryMetrics</String> ++ <String>/redfish/v1/Systems/{ComputerSystemId}/Memory/{MemoryId}/MemoryMetrics</String> ++ <String>/redfish/v1/Systems/{ComputerSystemId}/Processors/{ProcessorId}/MemorySummary/MemoryMetrics</String> ++ <String>/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Memory/{MemoryId}/MemoryMetrics</String> ++ <String>/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Processors/{ProcessorId}/MemorySummary/MemoryMetrics</String> ++ <String>/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Memory/{MemoryId}/MemoryMetrics</String> ++ <String>/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/MemorySummary/MemoryMetrics</String> ++ <String>/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Processors/{ProcessorId}/MemorySummary/MemoryMetrics</String> ++ <String>/redfish/v1/ResourceBlocks/{ResourceBlockId}/Memory/{MemoryId}/MemoryMetrics</String> ++ <String>/redfish/v1/ResourceBlocks/{ResourceBlockId}/Processors/{ProcessorId}/MemorySummary/MemoryMetrics</String> ++ <String>/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Memory/{MemoryId}/MemoryMetrics</String> ++ <String>/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/MemorySummary/MemoryMetrics</String> ++ <String>/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Processors/{ProcessorId}/MemorySummary/MemoryMetrics</String> ++ </Collection> ++ </Annotation> ++ </EntityType> ++ ++ <Action Name="ClearCurrentPeriod" IsBound="true"> ++ <Parameter Name="MemoryMetrics" Type="MemoryMetrics.v1_0_0.Actions"/> ++ <Annotation Term="OData.Description" String="This action sets the CurrentPeriod property's values to 0."/> ++ <Annotation Term="OData.LongDescription" String="This action shall set the CurrentPeriod property's values to 0."/> ++ </Action> ++ ++ </Schema> ++ ++ <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MemoryMetrics.v1_0_0"> ++ <Annotation Term="Redfish.OwningEntity" String="DMTF"/> ++ <Annotation Term="Redfish.Release" String="2016.1"/> ++ ++ <EntityType Name="MemoryMetrics" BaseType="MemoryMetrics.MemoryMetrics"> ++ <Property Name="BlockSizeBytes" Type="Edm.Int64"> ++ <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> ++ <Annotation Term="OData.Description" String="The block size, in bytes."/> ++ <Annotation Term="OData.LongDescription" String="This property shall contain the block size, in bytes, of all structure elements. When this resource is subordinate to the MemorySummary object, this property is not applicable."/> ++ <Annotation Term="Measures.Unit" String="By"/> ++ </Property> ++ <Property Name="CurrentPeriod" Type="MemoryMetrics.v1_0_0.CurrentPeriod" Nullable="false"> ++ <Annotation Term="OData.Description" String="The memory metrics since the last reset or ClearCurrentPeriod action."/> ++ <Annotation Term="OData.LongDescription" String="This property shall contain properties that describe the memory metrics for the current period."/> ++ </Property> ++ <Property Name="LifeTime" Type="MemoryMetrics.v1_0_0.LifeTime" Nullable="false"> ++ <Annotation Term="OData.Description" String="The memory metrics for the lifetime of the memory."/> ++ <Annotation Term="OData.LongDescription" String="This property shall contain properties that describe the memory metrics for the lifetime of the memory."/> ++ </Property> ++ <Property Name="HealthData" Type="MemoryMetrics.v1_0_0.HealthData" Nullable="false"> ++ <Annotation Term="OData.Description" String="The health information of the memory."/> ++ <Annotation Term="OData.LongDescription" String="This property shall contain properties that describe the health data memory metrics for the memory."/> ++ </Property> ++ <Property Name="Actions" Type="MemoryMetrics.v1_0_0.Actions" Nullable="false"> ++ <Annotation Term="OData.Description" String="The available actions for this resource."/> ++ <Annotation Term="OData.LongDescription" String="This property shall contain the available actions for this resource."/> ++ </Property> ++ </EntityType> ++ ++ <ComplexType Name="CurrentPeriod"> ++ <Annotation Term="OData.AdditionalProperties" Bool="false"/> ++ <Annotation Term="OData.Description" String="The memory metrics since the last system reset or ClearCurrentPeriod action."/> ++ <Annotation Term="OData.LongDescription" String="This type shall describe the memory metrics since last system reset or ClearCurrentPeriod action."/> ++ <Property Name="BlocksRead" Type="Edm.Int64"> ++ <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> ++ <Annotation Term="OData.Description" String="The number of blocks read since reset."/> ++ <Annotation Term="OData.LongDescription" String="This property shall contain the number of blocks read since reset. When this resource is subordinate to the MemorySummary object, this property shall be the sum of BlocksRead over all memory."/> ++ </Property> ++ <Property Name="BlocksWritten" Type="Edm.Int64"> ++ <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> ++ <Annotation Term="OData.Description" String="The number of blocks written since reset."/> ++ <Annotation Term="OData.LongDescription" String="This property shall contain the number of blocks written since reset. When this resource is subordinate to the MemorySummary object, this property shall be the sum of BlocksWritten over all memory."/> ++ </Property> ++ </ComplexType> ++ ++ <ComplexType Name="LifeTime"> ++ <Annotation Term="OData.AdditionalProperties" Bool="false"/> ++ <Annotation Term="OData.Description" String="The memory metrics for the lifetime of the memory."/> ++ <Annotation Term="OData.LongDescription" String="This type shall describe the memory metrics since manufacturing."/> ++ <Property Name="BlocksRead" Type="Edm.Int64"> ++ <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> ++ <Annotation Term="OData.Description" String="The number of blocks read for the lifetime of the memory."/> ++ <Annotation Term="OData.LongDescription" String="This property shall contain the number of blocks read for the lifetime of the memory. When this resource is subordinate to the MemorySummary object, this property shall be the sum of BlocksRead over all memory."/> ++ </Property> ++ <Property Name="BlocksWritten" Type="Edm.Int64"> ++ <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> ++ <Annotation Term="OData.Description" String="The number of blocks written for the lifetime of the memory."/> ++ <Annotation Term="OData.LongDescription" String="This property shall contain the number of blocks written for the lifetime of the memory. When this resource is subordinate to the MemorySummary object, this property shall be the sum of BlocksWritten over all memory."/> ++ </Property> ++ </ComplexType> ++ ++ <ComplexType Name="HealthData"> ++ <Annotation Term="OData.AdditionalProperties" Bool="false"/> ++ <Annotation Term="OData.Description" String="The health information of the memory."/> ++ <Annotation Term="OData.LongDescription" String="This type shall contain properties that describe the HealthData metrics for this resource."/> ++ <Property Name="RemainingSpareBlockPercentage" Type="Edm.Decimal"> ++ <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> ++ <Annotation Term="OData.Description" String="The remaining spare blocks, as a percentage."/> ++ <Annotation Term="OData.LongDescription" String="This property shall contain the remaining spare blocks as a percentage. When this resource is subordinate to the MemorySummary object, this property shall be the RemainingSpareBlockPercentage over all memory."/> ++ <Annotation Term="Measures.Unit" String="%"/> ++ </Property> ++ <Property Name="LastShutdownSuccess" Type="Edm.Boolean"> ++ <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> ++ <Annotation Term="OData.Description" String="An indication of whether the last shutdown succeeded."/> ++ <Annotation Term="OData.LongDescription" String="This property shall indicate whether the last shutdown succeeded."/> ++ </Property> ++ <Property Name="DataLossDetected" Type="Edm.Boolean"> ++ <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> ++ <Annotation Term="OData.Description" String="An indication of whether data loss was detected."/> ++ <Annotation Term="OData.LongDescription" String="This property shall indicate whether data loss was detected. When this resource is subordinate to the MemorySummary object, this property shall indicate whether any data loss was detected in any area of memory."/> ++ </Property> ++ <Property Name="PerformanceDegraded" Type="Edm.Boolean"> ++ <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> ++ <Annotation Term="OData.Description" String="An indication of whether performance has degraded."/> ++ <Annotation Term="OData.LongDescription" String="This property shall indicate whether performance has degraded. When this resource is subordinate to the MemorySummary object, this property shall indicate whether degraded performance mode status is detected in any area of memory."/> ++ </Property> ++ <Property Name="AlarmTrips" Type="MemoryMetrics.v1_0_0.AlarmTrips" Nullable="false"> ++ <Annotation Term="OData.Description" String="Alarm trip information about the memory."/> ++ <Annotation Term="OData.LongDescription" String="This object shall contain properties describe the types of alarms that have been raised by the memory. When this resource is subordinate to the MemorySummary object, this property shall indicate whether an alarm of a given type have been raised by any area of memory."/> ++ </Property> ++ </ComplexType> ++ ++ <ComplexType Name="AlarmTrips"> ++ <Annotation Term="OData.AdditionalProperties" Bool="false"/> ++ <Annotation Term="OData.Description" String="The alarm trip information about the memory. These alarms are reset when the system resets. Note that if they are re-discovered they can be reasserted."/> ++ <Annotation Term="OData.LongDescription" String="This type shall contain properties that describe the types of alarms that have been raised by the memory. These alarms shall be reset when the system resets. Note that if they are re-discovered they can be reasserted."/> ++ <Property Name="Temperature" Type="Edm.Boolean"> ++ <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> ++ <Annotation Term="OData.Description" String="An indication of whether a temperature threshold alarm trip was detected."/> ++ <Annotation Term="OData.LongDescription" String="This property shall indicates whether a temperature threshold alarm trip was detected."/> ++ </Property> ++ <Property Name="SpareBlock" Type="Edm.Boolean"> ++ <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> ++ <Annotation Term="OData.Description" String="An indication of whether the spare block capacity crossing alarm trip was detected."/> ++ <Annotation Term="OData.LongDescription" String="This property shall indicate whether the spare block capacity crossing alarm trip was detected."/> ++ </Property> ++ <Property Name="UncorrectableECCError" Type="Edm.Boolean"> ++ <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> ++ <Annotation Term="OData.Description" String="An indication of whether the uncorrectable error threshold alarm trip was detected."/> ++ <Annotation Term="OData.LongDescription" String="This property shall indicate whether the uncorrectable error threshold alarm trip was detected."/> ++ </Property> ++ <Property Name="CorrectableECCError" Type="Edm.Boolean"> ++ <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> ++ <Annotation Term="OData.Description" String="An indication of whether the correctable error threshold crossing alarm trip was detected."/> ++ <Annotation Term="OData.LongDescription" String="This property shall indicate whether the correctable error threshold crossing alarm trip was detected."/> ++ </Property> ++ <Property Name="AddressParityError" Type="Edm.Boolean"> ++ <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> ++ <Annotation Term="OData.Description" String="An indication of whether an address parity error was detected that a retry could not correct."/> ++ <Annotation Term="OData.LongDescription" String="This property shall indicate whether an address parity error was detected that a retry could not correct."/> ++ </Property> ++ </ComplexType> ++ ++ <ComplexType Name="Actions"> ++ <Annotation Term="OData.AdditionalProperties" Bool="false"/> ++ <Annotation Term="OData.Description" String="The available actions for this resource."/> ++ <Annotation Term="OData.LongDescription" String="This type shall contain the available actions for this resource."/> ++ <Property Name="Oem" Type="MemoryMetrics.v1_0_0.OemActions" Nullable="false"> ++ <Annotation Term="OData.Description" String="The available OEM-specific actions for this resource."/> ++ <Annotation Term="OData.LongDescription" String="This property shall contain the available OEM-specific actions for this resource."/> ++ </Property> ++ </ComplexType> ++ ++ <ComplexType Name="OemActions"> ++ <Annotation Term="OData.AdditionalProperties" Bool="true"/> ++ <Annotation Term="OData.Description" String="The available OEM-specific actions for this resource."/> ++ <Annotation Term="OData.LongDescription" String="This type shall contain the available OEM-specific actions for this resource."/> ++ </ComplexType> ++ ++ </Schema> ++ ++ <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MemoryMetrics.v1_0_1"> ++ <Annotation Term="Redfish.OwningEntity" String="DMTF"/> ++ <Annotation Term="OData.Description" String="This version was created to show that annotations in previous namespaces were updated."/> ++ <EntityType Name="MemoryMetrics" BaseType="MemoryMetrics.v1_0_0.MemoryMetrics"/> ++ </Schema> ++ ++ <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MemoryMetrics.v1_0_2"> ++ <Annotation Term="Redfish.OwningEntity" String="DMTF"/> ++ <Annotation Term="OData.Description" String="This version was created to show BlocksWritten in CurrentPeriod and LifeTime ComplexTypes, and to update annotations in earlier versions of namespaces."/> ++ <EntityType Name="MemoryMetrics" BaseType="MemoryMetrics.v1_0_1.MemoryMetrics"/> ++ </Schema> ++ ++ <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MemoryMetrics.v1_0_3"> ++ <Annotation Term="Redfish.OwningEntity" String="DMTF"/> ++ <Annotation Term="OData.Description" String="This version shows that AlarmTrips was modified to add semantics about AlarmTrips resets upon system reset."/> ++ <EntityType Name="MemoryMetrics" BaseType="MemoryMetrics.v1_0_2.MemoryMetrics"/> ++ </Schema> ++ ++ <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MemoryMetrics.v1_0_4"> ++ <Annotation Term="Redfish.OwningEntity" String="DMTF"/> ++ <Annotation Term="OData.Description" String="This version was created to force the regeneration of JSON Schema so that OData properties are marked as required, and integer properties are marked as integer rather than number. It was also created to add missing percent units onto existing properties."/> ++ <EntityType Name="MemoryMetrics" BaseType="MemoryMetrics.v1_0_3.MemoryMetrics"/> ++ </Schema> ++ ++ <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MemoryMetrics.v1_0_5"> ++ <Annotation Term="Redfish.OwningEntity" String="DMTF"/> ++ <Annotation Term="OData.Description" String="This version was created to force the regeneration of JSON Schema so that URI properties use the uri-reference format."/> ++ <EntityType Name="MemoryMetrics" BaseType="MemoryMetrics.v1_0_4.MemoryMetrics"/> ++ </Schema> ++ ++ <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MemoryMetrics.v1_0_6"> ++ <Annotation Term="Redfish.OwningEntity" String="DMTF"/> ++ <Annotation Term="OData.Description" String="This version was created to update descriptions to give guidance to the usage of certain properties when the metrics is used for a summary of all memory in a system. It was also created to update descriptions that this schema defines."/> ++ <EntityType Name="MemoryMetrics" BaseType="MemoryMetrics.v1_0_5.MemoryMetrics"/> ++ </Schema> ++ ++ <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MemoryMetrics.v1_0_7"> ++ <Annotation Term="Redfish.OwningEntity" String="DMTF"/> ++ <Annotation Term="OData.Description" String="This version was created to update description HealthData to allow for usage when this resource is subordinate to the MemorySummary object."/> ++ <EntityType Name="MemoryMetrics" BaseType="MemoryMetrics.v1_0_6.MemoryMetrics"/> ++ </Schema> ++ ++ <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MemoryMetrics.v1_0_8"> ++ <Annotation Term="Redfish.OwningEntity" String="DMTF"/> ++ <Annotation Term="OData.Description" String="This version was created to fix typos in descriptions and long descriptions."/> ++ <EntityType Name="MemoryMetrics" BaseType="MemoryMetrics.v1_0_7.MemoryMetrics"/> ++ </Schema> ++ ++ <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MemoryMetrics.v1_1_0"> ++ <Annotation Term="Redfish.OwningEntity" String="DMTF"/> ++ <Annotation Term="Redfish.Release" String="2016.2"/> ++ <EntityType Name="MemoryMetrics" BaseType="MemoryMetrics.v1_0_0.MemoryMetrics"/> ++ ++ <ComplexType Name="HealthData" BaseType="MemoryMetrics.v1_0_0.HealthData"> ++ <Property Name="PredictedMediaLifeLeftPercent" Type="Edm.Decimal"> ++ <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> ++ <Annotation Term="OData.Description" String="The percentage of reads and writes that are predicted to still be available for the media."/> ++ <Annotation Term="OData.LongDescription" String="This property shall contain an indicator of the percentage of life remaining in the media."/> ++ <Annotation Term="Measures.Unit" String="%"/> ++ </Property> ++ </ComplexType> ++ </Schema> ++ ++ <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MemoryMetrics.v1_1_1"> ++ <Annotation Term="Redfish.OwningEntity" String="DMTF"/> ++ <Annotation Term="OData.Description" String="This version was created to show that annotations in previous namespaces were updated."/> ++ <EntityType Name="MemoryMetrics" BaseType="MemoryMetrics.v1_1_0.MemoryMetrics"/> ++ </Schema> ++ ++ <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MemoryMetrics.v1_1_2"> ++ <Annotation Term="Redfish.OwningEntity" String="DMTF"/> ++ <Annotation Term="OData.Description" String="This version was created to show BlocksWritten in CurrentPeriod and LifeTime ComplexTypes, and to update annotations in earlier versions of namespaces."/> ++ <EntityType Name="MemoryMetrics" BaseType="MemoryMetrics.v1_1_1.MemoryMetrics"/> ++ </Schema> ++ ++ <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MemoryMetrics.v1_1_3"> ++ <Annotation Term="Redfish.OwningEntity" String="DMTF"/> ++ <Annotation Term="OData.Description" String="This version shows that AlarmTrips was modified to add semantics about AlarmTrips resets upon system reset."/> ++ <EntityType Name="MemoryMetrics" BaseType="MemoryMetrics.v1_1_2.MemoryMetrics"/> ++ </Schema> ++ ++ <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MemoryMetrics.v1_1_4"> ++ <Annotation Term="Redfish.OwningEntity" String="DMTF"/> ++ <Annotation Term="OData.Description" String="This version was created to force the regeneration of JSON Schema so that OData properties are marked as required, and integer properties are marked as integer rather than number. It was also created to add missing percent units onto existing properties."/> ++ <EntityType Name="MemoryMetrics" BaseType="MemoryMetrics.v1_1_3.MemoryMetrics"/> ++ </Schema> ++ ++ <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MemoryMetrics.v1_1_5"> ++ <Annotation Term="Redfish.OwningEntity" String="DMTF"/> ++ <Annotation Term="OData.Description" String="This version was created to force the regeneration of JSON Schema so that URI properties use the uri-reference format."/> ++ <EntityType Name="MemoryMetrics" BaseType="MemoryMetrics.v1_1_4.MemoryMetrics"/> ++ </Schema> ++ ++ <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MemoryMetrics.v1_1_6"> ++ <Annotation Term="Redfish.OwningEntity" String="DMTF"/> ++ <Annotation Term="OData.Description" String="This version was created to update descriptions to give guidance to the usage of certain properties when the metrics is used for a summary of all memory in a system. It was also created to update descriptions that this schema defines."/> ++ <EntityType Name="MemoryMetrics" BaseType="MemoryMetrics.v1_1_5.MemoryMetrics"/> ++ </Schema> ++ ++ <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MemoryMetrics.v1_1_7"> ++ <Annotation Term="Redfish.OwningEntity" String="DMTF"/> ++ <Annotation Term="OData.Description" String="This version was created to update description HealthData to allow for usage when this resource is subordinate to the MemorySummary object."/> ++ <EntityType Name="MemoryMetrics" BaseType="MemoryMetrics.v1_1_6.MemoryMetrics"/> ++ </Schema> ++ ++ <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MemoryMetrics.v1_1_8"> ++ <Annotation Term="Redfish.OwningEntity" String="DMTF"/> ++ <Annotation Term="OData.Description" String="This version was created to fix typos in descriptions and long descriptions."/> ++ <EntityType Name="MemoryMetrics" BaseType="MemoryMetrics.v1_1_7.MemoryMetrics"/> ++ </Schema> ++ ++ <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MemoryMetrics.v1_2_0"> ++ <Annotation Term="Redfish.OwningEntity" String="DMTF"/> ++ <Annotation Term="Redfish.Release" String="2019.2"/> ++ <Annotation Term="OData.Description" String="This version was created to add the BandwidthPercent property. It was also created to update property descriptions for cases when the metrics are used in a summary of all memory in a system."/> ++ ++ <EntityType Name="MemoryMetrics" BaseType="MemoryMetrics.v1_1_6.MemoryMetrics"> ++ <Property Name="BandwidthPercent" Type="Edm.Decimal"> ++ <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> ++ <Annotation Term="OData.Description" String="The memory bandwidth utilization as a percentage."/> ++ <Annotation Term="OData.LongDescription" String="This property shall contain memory bandwidth utilization as a percentage. When this resource is subordinate to the MemorySummary object, this property shall be the memory bandwidth utilization over all memory as a percentage."/> ++ <Annotation Term="Validation.Minimum" Int="0"/> ++ <Annotation Term="Measures.Unit" String="%"/> ++ </Property> ++ </EntityType> ++ </Schema> ++ ++ <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MemoryMetrics.v1_2_1"> ++ <Annotation Term="Redfish.OwningEntity" String="DMTF"/> ++ <Annotation Term="OData.Description" String="This version was created to update description HealthData to allow for usage when this resource is subordinate to the MemorySummary object."/> ++ <EntityType Name="MemoryMetrics" BaseType="MemoryMetrics.v1_2_0.MemoryMetrics"/> ++ </Schema> ++ ++ <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MemoryMetrics.v1_2_2"> ++ <Annotation Term="Redfish.OwningEntity" String="DMTF"/> ++ <Annotation Term="OData.Description" String="This version was created to fix typos in descriptions and long descriptions."/> ++ <EntityType Name="MemoryMetrics" BaseType="MemoryMetrics.v1_2_1.MemoryMetrics"/> ++ </Schema> ++ ++ <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MemoryMetrics.v1_3_0"> ++ <Annotation Term="Redfish.OwningEntity" String="DMTF"/> ++ <Annotation Term="Redfish.Release" String="2020.1"/> ++ <Annotation Term="OData.Description" String="This version was created to add OperatingSpeedMHz property."/> ++ ++ <EntityType Name="MemoryMetrics" BaseType="MemoryMetrics.v1_2_1.MemoryMetrics"> ++ <Property Name="OperatingSpeedMHz" Type="Edm.Int64"> ++ <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> ++ <Annotation Term="OData.Description" String="Operating speed of memory in MHz or MT/s as appropriate."/> ++ <Annotation Term="OData.LongDescription" String="This property shall contain the operating speed of memory in MHz or MT/s (mega-transfers per second) as reported by the memory device. Memory devices that operate at their bus speed shall report the operating speed in MHz (bus speed), while memory devices that transfer data faster than their bus speed, such as DDR memory, shall report the operating speed in MT/s (mega-transfers/second). The reported value shall match the conventionally reported values for the technology used by the memory device."/> ++ <Annotation Term="Measures.Unit" String="MHz"/> ++ </Property> ++ </EntityType> ++ </Schema> ++ ++ <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MemoryMetrics.v1_3_1"> ++ <Annotation Term="Redfish.OwningEntity" String="DMTF"/> ++ <Annotation Term="OData.Description" String="This version was created to fix typos in descriptions and long descriptions."/> ++ <EntityType Name="MemoryMetrics" BaseType="MemoryMetrics.v1_3_0.MemoryMetrics"/> ++ </Schema> ++ ++ <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MemoryMetrics.v1_4_0"> ++ <Annotation Term="Redfish.OwningEntity" String="DMTF"/> ++ <Annotation Term="Redfish.Release" String="2020.3"/> ++ <Annotation Term="OData.Description" String="This version was created to add CorrectableECCErrorCount and UncorrectableECCErrorCount properties for CurrentPeriod and LifeTime of the memory."/> ++ ++ <EntityType Name="MemoryMetrics" BaseType="MemoryMetrics.v1_3_0.MemoryMetrics"/> ++ ++ <ComplexType Name="CurrentPeriod" BaseType="MemoryMetrics.v1_0_0.CurrentPeriod"> ++ <Property Name="CorrectableECCErrorCount" Type="Edm.Int64"> ++ <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> ++ <Annotation Term="OData.Description" String="The number of the correctable errors since reset."/> ++ <Annotation Term="OData.LongDescription" String="This property shall contain the number of correctable errors since reset. When this resource is subordinate to the MemorySummary object, this property shall be the sum of CorrectableECCErrorCount over all memory."/> ++ </Property> ++ <Property Name="UncorrectableECCErrorCount" Type="Edm.Int64"> ++ <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> ++ <Annotation Term="OData.Description" String="The number of the uncorrectable errors since reset."/> ++ <Annotation Term="OData.LongDescription" String="This property shall contain the number of uncorrectable errors since reset. When this resource is subordinate to the MemorySummary object, this property shall be the sum of UncorrectableECCErrorCount over all memory."/> ++ </Property> ++ </ComplexType> ++ ++ <ComplexType Name="LifeTime" BaseType="MemoryMetrics.v1_0_0.LifeTime"> ++ <Property Name="CorrectableECCErrorCount" Type="Edm.Int64"> ++ <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> ++ <Annotation Term="OData.Description" String="The number of the correctable errors for the lifetime of the memory."/> ++ <Annotation Term="OData.LongDescription" String="This property shall contain the number of the correctable errors for the lifetime of the memory. When this resource is subordinate to the MemorySummary object, this property shall be the sum of CorrectableECCErrorCount over all memory."/> ++ </Property> ++ <Property Name="UncorrectableECCErrorCount" Type="Edm.Int64"> ++ <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> ++ <Annotation Term="OData.Description" String="The number of the uncorrectable errors for the lifetime of the memory."/> ++ <Annotation Term="OData.LongDescription" String="This property shall contain the number of the uncorrectable errors for the lifetime of the memory. When this resource is subordinate to the MemorySummary object, this property shall be the sum of UncorrectableECCErrorCount over all memory."/> ++ </Property> ++ </ComplexType> ++ </Schema> ++ ++ <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MemoryMetrics.v1_4_1"> ++ <Annotation Term="Redfish.OwningEntity" String="DMTF"/> ++ <Annotation Term="OData.Description" String="This version was created to fix typos in descriptions and long descriptions."/> ++ <EntityType Name="MemoryMetrics" BaseType="MemoryMetrics.v1_4_0.MemoryMetrics"/> ++ </Schema> ++ ++ </edmx:DataServices> ++</edmx:Edmx> +-- +2.17.1 + diff --git a/meta-openbmc-mods/meta-common/recipes-phosphor/interfaces/bmcweb/biosconfig/0008-Add-BIOSAttributesChanged-message-entry.patch b/meta-openbmc-mods/meta-common/recipes-phosphor/interfaces/bmcweb/biosconfig/0008-Add-BIOSAttributesChanged-message-entry.patch new file mode 100644 index 000000000..bbcd7df12 --- /dev/null +++ b/meta-openbmc-mods/meta-common/recipes-phosphor/interfaces/bmcweb/biosconfig/0008-Add-BIOSAttributesChanged-message-entry.patch @@ -0,0 +1,88 @@ +From d2b0499ad8b8610f8be1963f5ca1bb8548a97641 Mon Sep 17 00:00:00 2001 +From: Snehalatha Venkatesh <snehalathax.v@intel.com> +Date: Mon, 11 Apr 2022 07:12:53 +0000 +Subject: [PATCH] Add BIOSAttributesChanged message entry + +When BIOS attributes are changed via OOB (using Redfish PATCH operation) +No Redfish event is logged. + +Added a Message Registry entry to inform that a set of BIOS attributes +are changed via OOB. It will be logged after BIOS reset, during which +attributes are re-populated with patched values. + +Changing the BIOS attributes via OOB is possible only through +Redfish PATCH operation currently and not supported through IPMI. + +This event is implemented for the following review. +https://gerrit.openbmc-project.xyz/c/openbmc/intel-ipmi-oem/+/52320 + +Tested: +1. Redfish validator - passed for this new addition. +2. Enable "BMC Remote Setup" and Set BIOS admin password. +3. Do BIOS reset. +4. Check for the attributes in redfish uri +GET: /redfish/v1/Systems/system/Bios +Response: Success +5. Patch any attribute. +PATCH: /redfish/v1/Systems/system/Bios/Settings +Body: +{ + "data": { + "serialDebugMsgLvl": "0x2" +}} +Response: Success +6. Do BIOS reset. +7. Verified in Redfish, Biosattribute change message populated. +GET: /redfish/v1/Systems/system/LogServices/EventLog/Entries +Response: +{ + "@odata.id": "/redfish/v1/Systems/system/LogServices/EventLog/Entries/32635", + "@odata.type": "#LogEntry.v1_8_0.LogEntry", + "Created": "1970-01-01T09:03:55+00:00", + "EntryType": "Event", + "Id": "32635", + "Message": "Set of BIOS Attributes changed.", + "MessageArgs": [], + "MessageId": "OpenBMC.0.1.BIOSAttributesChanged", + "Name": "System Event Log Entry", + "Severity": "OK" +} + +Signed-off-by: Snehalatha Venkatesh <snehalathax.v@intel.com> +--- + .../include/registries/openbmc_message_registry.hpp | 12 +++++++++++- + 1 file changed, 11 insertions(+), 1 deletion(-) + +diff --git a/redfish-core/include/registries/openbmc_message_registry.hpp b/redfish-core/include/registries/openbmc_message_registry.hpp +index a181080..f0e0e59 100644 +--- a/redfish-core/include/registries/openbmc_message_registry.hpp ++++ b/redfish-core/include/registries/openbmc_message_registry.hpp +@@ -29,7 +29,7 @@ const Header header = { + "0.3.1", + "OpenBMC", + }; +-constexpr std::array<MessageEntry, 200> registry = { ++constexpr std::array<MessageEntry, 201> registry = { + MessageEntry{ + "ADDDCCorrectable", + { +@@ -139,6 +139,16 @@ constexpr std::array<MessageEntry, 200> registry = { + "None.", + }}, + ++ MessageEntry{"BIOSAttributesChanged", ++ { ++ "Indicates that a set of BIOS attributes changed.", ++ "Set of BIOS Attributes changed.", ++ "OK", ++ "OK", ++ 0, ++ {}, ++ "None.", ++ }}, + MessageEntry{ + "BIOSBoot", + { +-- +2.17.1 + diff --git a/meta-openbmc-mods/meta-common/recipes-phosphor/interfaces/bmcweb/eventservice/0006-Add-EventService-SSE-filter-support.patch b/meta-openbmc-mods/meta-common/recipes-phosphor/interfaces/bmcweb/eventservice/0006-Add-EventService-SSE-filter-support.patch index 05018a47d..5b2c48926 100644 --- a/meta-openbmc-mods/meta-common/recipes-phosphor/interfaces/bmcweb/eventservice/0006-Add-EventService-SSE-filter-support.patch +++ b/meta-openbmc-mods/meta-common/recipes-phosphor/interfaces/bmcweb/eventservice/0006-Add-EventService-SSE-filter-support.patch @@ -33,18 +33,18 @@ Signed-off-by: AppaRao Puli <apparao.puli@linux.intel.com> Signed-off-by: P Dheeraj Srujan Kumar <p.dheeraj.srujan.kumar@intel.com> Change-Id: I55c6f53bb5e57aa1f2d1601f1a16525a33b13bd2 --- - include/eventservice_sse.hpp | 145 +++++++++++++++++- + include/eventservice_sse.hpp | 146 +++++++++++++++++- redfish-core/include/error_messages.hpp | 9 ++ .../include/event_service_manager.hpp | 5 + redfish-core/lib/event_service.hpp | 5 - redfish-core/src/error_messages.cpp | 26 ++++ - 5 files changed, 181 insertions(+), 9 deletions(-) + 5 files changed, 182 insertions(+), 9 deletions(-) diff --git a/include/eventservice_sse.hpp b/include/eventservice_sse.hpp index 14daf00..fed7fec 100644 --- a/include/eventservice_sse.hpp +++ b/include/eventservice_sse.hpp -@@ -23,16 +23,153 @@ static bool createSubscription(std::shared_ptr<crow::SseConnection>& conn, +@@ -23,16 +23,154 @@ static bool createSubscription(std::shared_ptr<crow::SseConnection>& conn, } BMCWEB_LOG_DEBUG << "Request query param size: " << req.urlParams.size(); @@ -199,6 +199,7 @@ index 14daf00..fed7fec 100644 + subValue->registryMsgIds = msgIds; + subValue->registryPrefixes = regPrefixes; + subValue->metricReportDefinitions = mrdsArray; ++ subValue->subscriptionOwner = req.session->username; std::string id = redfish::EventServiceManager::getInstance().addSubscription(subValue, diff --git a/meta-openbmc-mods/meta-common/recipes-phosphor/interfaces/bmcweb/eventservice/0015-Add-Configure-Self-support-for-Event-Subscriptions.patch b/meta-openbmc-mods/meta-common/recipes-phosphor/interfaces/bmcweb/eventservice/0015-Add-Configure-Self-support-for-Event-Subscriptions.patch new file mode 100644 index 000000000..ee62f1cbe --- /dev/null +++ b/meta-openbmc-mods/meta-common/recipes-phosphor/interfaces/bmcweb/eventservice/0015-Add-Configure-Self-support-for-Event-Subscriptions.patch @@ -0,0 +1,220 @@ +From fdc4667e34cb8ede4529e116b35ed4d411328e08 Mon Sep 17 00:00:00 2001 +From: P Dheeraj Srujan Kumar <p.dheeraj.srujan.kumar@intel.com> +Date: Fri, 11 Feb 2022 05:26:19 +0530 +Subject: [PATCH] Add Configure Self support for Event Subscriptions + +As per DTMF redfish schema privilege registry PATCH and DELETE operations +on event subscriptions require ConfigureManager or ConfigureSelf +privilege. +Currently, only ConfigureManager support was enabled, which implies only +Admin user will be able to PATCH and DELETE any given subscription. +This commits adds the support to enable ConfigureSelf, which implies, an +Operator user will be able to PATCH or DELETE self created subscription. +This support is enabled by adding SubscriptionOwner field to the +Subscriptions class, so that the Owner of the subscription will be +stored when a subscription is created. +This Commit also ensures backward compatibility by not mandating the +SubscriptionOwner field. Which implies, the older subscriptions which do +not have a SubscriptionOwner will not be force removed, but can only be +PATCHED or DELETED by Administrator. + +Tested: + - Created 2 Operator level users - Operator1 and Operator2 + - Created subscription by POST to + /redfish/v1/EventService/Subscriptions using Operator1 + - PATCH and DELETE on the subscription failed successfully when using + Operator2 user. + - PATCH and DELETE was successfull when using Operator1 user. + +Signed-off-by: P Dheeraj Srujan Kumar <p.dheeraj.srujan.kumar@intel.com> +--- + include/event_service_store.hpp | 11 +++ + include/persistent_data.hpp | 1 + + .../include/event_service_manager.hpp | 2 + + redfish-core/lib/event_service.hpp | 80 ++++++++++++++++--- + 4 files changed, 81 insertions(+), 13 deletions(-) + +diff --git a/include/event_service_store.hpp b/include/event_service_store.hpp +index dcc99f1..6997136 100644 +--- a/include/event_service_store.hpp ++++ b/include/event_service_store.hpp +@@ -22,6 +22,7 @@ struct UserSubscription + std::vector<std::string> resourceTypes; + boost::beast::http::fields httpHeaders; + std::vector<std::string> metricReportDefinitions; ++ std::string subscriptionOwner; + + static std::shared_ptr<UserSubscription> + fromJson(const nlohmann::json& j, const bool loadFromOldConfig = false) +@@ -172,6 +173,16 @@ struct UserSubscription + subvalue->metricReportDefinitions.emplace_back(*value); + } + } ++ else if (element.key() == "SubscriptionOwner") ++ { ++ const std::string* value = ++ element.value().get_ptr<const std::string*>(); ++ if (value == nullptr) ++ { ++ continue; ++ } ++ subvalue->subscriptionOwner = *value; ++ } + else + { + BMCWEB_LOG_ERROR +diff --git a/include/persistent_data.hpp b/include/persistent_data.hpp +index dbd3618..48855ec 100644 +--- a/include/persistent_data.hpp ++++ b/include/persistent_data.hpp +@@ -305,6 +305,7 @@ class ConfigFile + {"ResourceTypes", subValue->resourceTypes}, + {"SubscriptionType", subValue->subscriptionType}, + {"MetricReportDefinitions", subValue->metricReportDefinitions}, ++ {"SubscriptionOwner", subValue->subscriptionOwner}, + }); + } + persistentFile << data; +diff --git a/redfish-core/include/event_service_manager.hpp b/redfish-core/include/event_service_manager.hpp +index 1ba9f21..a1b8921 100644 +--- a/redfish-core/include/event_service_manager.hpp ++++ b/redfish-core/include/event_service_manager.hpp +@@ -692,6 +692,7 @@ class EventServiceManager + subValue->resourceTypes = newSub->resourceTypes; + subValue->httpHeaders = newSub->httpHeaders; + subValue->metricReportDefinitions = newSub->metricReportDefinitions; ++ subValue->subscriptionOwner = newSub->subscriptionOwner; + + if (subValue->id.empty()) + { +@@ -1008,6 +1009,7 @@ class EventServiceManager + newSub->resourceTypes = subValue->resourceTypes; + newSub->httpHeaders = subValue->httpHeaders; + newSub->metricReportDefinitions = subValue->metricReportDefinitions; ++ newSub->subscriptionOwner = subValue->subscriptionOwner; + persistent_data::EventServiceStore::getInstance() + .subscriptionsConfigMap.emplace(newSub->id, newSub); + +diff --git a/redfish-core/lib/event_service.hpp b/redfish-core/lib/event_service.hpp +index 9eb845c..2fb2ab1 100644 +--- a/redfish-core/lib/event_service.hpp ++++ b/redfish-core/lib/event_service.hpp +@@ -296,6 +296,7 @@ inline void requestRoutesEventDestinationCollection(App& app) + std::make_shared<Subscription>(host, port, path, uriProto); + + subValue->destinationUrl = destUrl; ++ subValue->subscriptionOwner = req.session->username; + + if (subscriptionType) + { +@@ -577,11 +578,7 @@ inline void requestRoutesEventDestination(App& app) + mrdJsonArray; + }); + BMCWEB_ROUTE(app, "/redfish/v1/EventService/Subscriptions/<str>/") +- // The below privilege is wrong, it should be ConfigureManager OR +- // ConfigureSelf +- // https://github.com/openbmc/bmcweb/issues/220 +- //.privileges(redfish::privileges::patchEventDestination) +- .privileges({{"ConfigureManager"}}) ++ .privileges(redfish::privileges::patchEventDestination) + .methods(boost::beast::http::verb::patch)( + [](const crow::Request& req, + const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, +@@ -595,6 +592,36 @@ inline void requestRoutesEventDestination(App& app) + return; + } + ++ Privileges effectiveUserPrivileges = ++ redfish::getUserPrivileges(req.userRole); ++ bool isConfigureManager = ++ effectiveUserPrivileges.isSupersetOf({"ConfigureManager"}); ++ ++ if (!isConfigureManager) ++ { ++ // If the user does not have Configure manager privilege ++ // then the user must be an Operator (i.e. Configure ++ // Components and Self) ++ // We need to ensure that the User is the actual owner of the ++ // Subscription being patched ++ // This also supports backward compatibility as subscription ++ // owner would be empty which would not be equal to current ++ // user, enabling only Admin to be able to patch the ++ // Subscription ++ ++ if (subValue->subscriptionOwner == "") ++ { ++ messages::insufficientPrivilege(asyncResp->res); ++ return; ++ } ++ ++ if (subValue->subscriptionOwner != req.session->username) ++ { ++ messages::insufficientPrivilege(asyncResp->res); ++ return; ++ } ++ } ++ + std::optional<std::string> context; + std::optional<std::string> retryPolicy; + std::optional<std::vector<nlohmann::json>> headers; +@@ -653,22 +680,49 @@ inline void requestRoutesEventDestination(App& app) + EventServiceManager::getInstance().updateSubscription(param); + }); + BMCWEB_ROUTE(app, "/redfish/v1/EventService/Subscriptions/<str>/") +- // The below privilege is wrong, it should be ConfigureManager OR +- // ConfigureSelf +- // https://github.com/openbmc/bmcweb/issues/220 +- //.privileges(redfish::privileges::deleteEventDestination) +- .privileges({{"ConfigureManager"}}) ++ .privileges(redfish::privileges::deleteEventDestination) + .methods(boost::beast::http::verb::delete_)( +- [](const crow::Request&, ++ [](const crow::Request& req, + const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, + const std::string& param) { +- if (!EventServiceManager::getInstance().isSubscriptionExist( +- param)) ++ std::shared_ptr<Subscription> subValue = ++ EventServiceManager::getInstance().getSubscription(param); ++ if (subValue == nullptr) + { + asyncResp->res.result( + boost::beast::http::status::not_found); + return; + } ++ ++ Privileges effectiveUserPrivileges = ++ redfish::getUserPrivileges(req.userRole); ++ bool isConfigureManager = ++ effectiveUserPrivileges.isSupersetOf({"ConfigureManager"}); ++ ++ if (!isConfigureManager) ++ { ++ // If the user does not have Configure manager privilege ++ // then the user must be an Operator (i.e. Configure ++ // Components and Self) ++ // We need to ensure that the User is the actual owner of the ++ // Subscription being deleted ++ // This also supports backward compatibility as subscription ++ // owner would be empty which would not be equal to current ++ // user, enabling only Admin to be able to patch the ++ // Subscription ++ ++ if (subValue->subscriptionOwner == "") ++ { ++ messages::insufficientPrivilege(asyncResp->res); ++ return; ++ } ++ ++ if (subValue->subscriptionOwner != req.session->username) ++ { ++ messages::insufficientPrivilege(asyncResp->res); ++ return; ++ } ++ } + EventServiceManager::getInstance().deleteSubscription(param); + }); + } +-- +2.17.1 + |