Add EnvironmentMetrics schema
Based on DSP8010_2022.2 and adds the EnvironmentMetrics schema.
Tested: built bmcweb successfully and validator passes
Signed-off-by: George Liu <liuxiwei@inspur.com>
Change-Id: I994b48c544edc22a6bf99187b536f3e51e10b052
diff --git a/static/redfish/v1/JsonSchemas/EnvironmentMetrics/EnvironmentMetrics.json b/static/redfish/v1/JsonSchemas/EnvironmentMetrics/EnvironmentMetrics.json
new file mode 100644
index 0000000..1f9622f
--- /dev/null
+++ b/static/redfish/v1/JsonSchemas/EnvironmentMetrics/EnvironmentMetrics.json
@@ -0,0 +1,334 @@
+{
+ "$id": "http://redfish.dmtf.org/schemas/v1/EnvironmentMetrics.v1_3_0.json",
+ "$ref": "#/definitions/EnvironmentMetrics",
+ "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
+ "copyright": "Copyright 2014-2022 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": {
+ "#EnvironmentMetrics.ResetMetrics": {
+ "$ref": "#/definitions/ResetMetrics"
+ },
+ "#EnvironmentMetrics.ResetToDefaults": {
+ "$ref": "#/definitions/ResetToDefaults"
+ },
+ "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"
+ },
+ "EnvironmentMetrics": {
+ "additionalProperties": false,
+ "description": "The EnvironmentMetrics schema represents the environmental metrics of a device.",
+ "longDescription": "This resource shall represent the environmental metrics for 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"
+ },
+ "AbsoluteHumidity": {
+ "anyOf": [
+ {
+ "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorExcerpt"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Absolute humidity (g/cu m).",
+ "excerptCopy": "SensorExcerpt",
+ "longDescription": "This property shall contain the absolute (volumetric) humidity sensor reading, in grams/cubic meter units, for this resource. The value of the DataSourceUri property, if present, shall reference a resource of type Sensor with the ReadingType property containing the value `AbsoluteHumidity`.",
+ "versionAdded": "v1_2_0"
+ },
+ "Actions": {
+ "$ref": "#/definitions/Actions",
+ "description": "The available actions for this resource.",
+ "longDescription": "This property shall contain the available actions for this resource."
+ },
+ "Description": {
+ "anyOf": [
+ {
+ "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "readonly": true
+ },
+ "DewPointCelsius": {
+ "anyOf": [
+ {
+ "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorExcerpt"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "The dew point temperature (C).",
+ "excerptCopy": "SensorExcerpt",
+ "longDescription": "This property shall contain the dew point, in degrees Celsius, based on the temperature and humidity values for this resource. The value of the DataSourceUri property, if present, shall reference a resource of type Sensor with the ReadingType property containing the value `Temperature`.",
+ "versionAdded": "v1_1_0"
+ },
+ "EnergyJoules": {
+ "anyOf": [
+ {
+ "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorExcerpt"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Energy consumption (J).",
+ "excerptCopy": "SensorExcerpt",
+ "longDescription": "This property shall contain the total energy, in joules, for this resource. The value of the DataSourceUri property, if present, shall reference a resource of type Sensor with the ReadingType property containing the value `EnergyJoules`. This property is used for reporting device-level energy consumption measurements, while EnergykWh is used for large-scale consumption measurements.",
+ "versionAdded": "v1_2_0"
+ },
+ "EnergykWh": {
+ "anyOf": [
+ {
+ "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorEnergykWhExcerpt"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Energy consumption (kWh).",
+ "excerptCopy": "SensorEnergykWhExcerpt",
+ "longDescription": "This property shall contain the total energy, in kilowatt-hours, for this resource. The value of the DataSourceUri property, if present, shall reference a resource of type Sensor with the ReadingType property containing the value `EnergykWh`."
+ },
+ "FanSpeedsPercent": {
+ "description": "Fan speeds (percent).",
+ "excerptCopy": "SensorFanArrayExcerpt",
+ "items": {
+ "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorFanArrayExcerpt"
+ },
+ "longDescription": "This property shall contain the fan speeds, in percent units, for this resource. The value of the DataSourceUri property, if present, shall reference a resource of type Sensor with the ReadingType property containing the value `Percent`.",
+ "type": "array"
+ },
+ "FanSpeedsPercent@odata.count": {
+ "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
+ },
+ "HumidityPercent": {
+ "anyOf": [
+ {
+ "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorExcerpt"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Humidity (percent).",
+ "excerptCopy": "SensorExcerpt",
+ "longDescription": "This property shall contain the humidity, in percent units, for this resource. The value of the DataSourceUri property, if present, shall reference a resource of type Sensor with the ReadingType property containing the value `Humidity`."
+ },
+ "Id": {
+ "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
+ "readonly": true
+ },
+ "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."
+ },
+ "PowerLimitWatts": {
+ "anyOf": [
+ {
+ "$ref": "http://redfish.dmtf.org/schemas/v1/Control.json#/definitions/ControlSingleExcerpt"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Power limit (W).",
+ "excerptCopy": "ControlSingleExcerpt",
+ "longDescription": "This property shall contain the power limit control, in watt units, for this resource. The value of the DataSourceUri property, if present, shall reference a resource of type Control with the ControlType property containing the value of `Power`.",
+ "readonly": false,
+ "versionAdded": "v1_1_0"
+ },
+ "PowerLoadPercent": {
+ "anyOf": [
+ {
+ "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorExcerpt"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "The power load (percent) for this device.",
+ "excerptCopy": "SensorExcerpt",
+ "longDescription": "This property shall contain the power load, in percent units, for this device, that represents the `Total` ElectricalContext for this device. The value of the DataSourceUri property, if present, shall reference a resource of type Sensor with the ReadingType property containing the value `Percent`.",
+ "versionAdded": "v1_1_0"
+ },
+ "PowerWatts": {
+ "anyOf": [
+ {
+ "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorPowerExcerpt"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Power consumption (W).",
+ "excerptCopy": "SensorPowerExcerpt",
+ "longDescription": "This property shall contain the total power, in watt units, for this resource. The value of the DataSourceUri property, if present, shall reference a resource of type Sensor with the ReadingType property containing the value `Power`."
+ },
+ "TemperatureCelsius": {
+ "anyOf": [
+ {
+ "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorExcerpt"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Temperature (Celsius).",
+ "excerptCopy": "SensorExcerpt",
+ "longDescription": "This property shall contain the temperature, in degrees Celsius units, for this resource. The value of the DataSourceUri property, if present, shall reference a resource of type Sensor with the ReadingType property containing the value `Temperature`."
+ }
+ },
+ "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"
+ },
+ "ResetMetrics": {
+ "additionalProperties": false,
+ "description": "This action resets the summary metrics related to this equipment.",
+ "longDescription": "This action shall reset any time intervals or counted values for this equipment.",
+ "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"
+ },
+ "ResetToDefaults": {
+ "additionalProperties": false,
+ "description": "The action resets the values of writable properties to factory defaults.",
+ "longDescription": "This action shall reset the values of writable properties in this resource to their default values as specified by the manufacturer.",
+ "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",
+ "versionAdded": "v1_3_0"
+ }
+ },
+ "owningEntity": "DMTF",
+ "release": "2022.2",
+ "title": "#EnvironmentMetrics.v1_3_0.EnvironmentMetrics"
+}
\ No newline at end of file