1{ 2 "$id": "http://redfish.dmtf.org/schemas/v1/EnvironmentMetrics.v1_3_2.json", 3 "$ref": "#/definitions/EnvironmentMetrics", 4 "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json", 5 "copyright": "Copyright 2014-2024 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright", 6 "definitions": { 7 "Actions": { 8 "additionalProperties": false, 9 "description": "The available actions for this resource.", 10 "longDescription": "This type shall contain the available actions for this resource.", 11 "patternProperties": { 12 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 13 "description": "This property shall specify a valid odata or Redfish property.", 14 "type": [ 15 "array", 16 "boolean", 17 "integer", 18 "number", 19 "null", 20 "object", 21 "string" 22 ] 23 } 24 }, 25 "properties": { 26 "#EnvironmentMetrics.ResetMetrics": { 27 "$ref": "#/definitions/ResetMetrics" 28 }, 29 "#EnvironmentMetrics.ResetToDefaults": { 30 "$ref": "#/definitions/ResetToDefaults" 31 }, 32 "Oem": { 33 "$ref": "#/definitions/OemActions", 34 "description": "The available OEM-specific actions for this resource.", 35 "longDescription": "This property shall contain the available OEM-specific actions for this resource." 36 } 37 }, 38 "type": "object" 39 }, 40 "EnvironmentMetrics": { 41 "additionalProperties": false, 42 "description": "The `EnvironmentMetrics` schema represents the environmental metrics of a device.", 43 "longDescription": "This resource shall represent the environmental metrics for a Redfish implementation.", 44 "patternProperties": { 45 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 46 "description": "This property shall specify a valid odata or Redfish property.", 47 "type": [ 48 "array", 49 "boolean", 50 "integer", 51 "number", 52 "null", 53 "object", 54 "string" 55 ] 56 } 57 }, 58 "properties": { 59 "@odata.context": { 60 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" 61 }, 62 "@odata.etag": { 63 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" 64 }, 65 "@odata.id": { 66 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id" 67 }, 68 "@odata.type": { 69 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type" 70 }, 71 "AbsoluteHumidity": { 72 "anyOf": [ 73 { 74 "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorExcerpt" 75 }, 76 { 77 "type": "null" 78 } 79 ], 80 "description": "Absolute humidity (g/m^3).", 81 "excerptCopy": "SensorExcerpt", 82 "longDescription": "This property shall contain the absolute (volumetric) humidity sensor reading, in grams per 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`.", 83 "versionAdded": "v1_2_0" 84 }, 85 "Actions": { 86 "$ref": "#/definitions/Actions", 87 "description": "The available actions for this resource.", 88 "longDescription": "This property shall contain the available actions for this resource." 89 }, 90 "Description": { 91 "anyOf": [ 92 { 93 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description" 94 }, 95 { 96 "type": "null" 97 } 98 ], 99 "readonly": true 100 }, 101 "DewPointCelsius": { 102 "anyOf": [ 103 { 104 "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorExcerpt" 105 }, 106 { 107 "type": "null" 108 } 109 ], 110 "description": "The dew point temperature (C).", 111 "excerptCopy": "SensorExcerpt", 112 "longDescription": "This property shall contain the dew point, in degree Celsius units, 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`.", 113 "versionAdded": "v1_1_0" 114 }, 115 "EnergyJoules": { 116 "anyOf": [ 117 { 118 "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorExcerpt" 119 }, 120 { 121 "type": "null" 122 } 123 ], 124 "description": "Energy consumption (J).", 125 "excerptCopy": "SensorExcerpt", 126 "longDescription": "This property shall contain the total energy, in joule 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 `EnergyJoules`. This property is used for reporting device-level energy consumption measurements, while `EnergykWh` is used for large-scale consumption measurements.", 127 "versionAdded": "v1_2_0" 128 }, 129 "EnergykWh": { 130 "anyOf": [ 131 { 132 "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorEnergykWhExcerpt" 133 }, 134 { 135 "type": "null" 136 } 137 ], 138 "description": "Energy consumption (kWh).", 139 "excerptCopy": "SensorEnergykWhExcerpt", 140 "longDescription": "This property shall contain the total energy, in kilowatt-hour 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 `EnergykWh`." 141 }, 142 "FanSpeedsPercent": { 143 "description": "Fan speeds (percent).", 144 "excerptCopy": "SensorFanArrayExcerpt", 145 "items": { 146 "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorFanArrayExcerpt" 147 }, 148 "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`.", 149 "type": "array" 150 }, 151 "FanSpeedsPercent@odata.count": { 152 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" 153 }, 154 "HumidityPercent": { 155 "anyOf": [ 156 { 157 "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorExcerpt" 158 }, 159 { 160 "type": "null" 161 } 162 ], 163 "description": "Humidity (percent).", 164 "excerptCopy": "SensorExcerpt", 165 "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`." 166 }, 167 "Id": { 168 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id", 169 "readonly": true 170 }, 171 "Name": { 172 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name", 173 "readonly": true 174 }, 175 "Oem": { 176 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem", 177 "description": "The OEM extension property.", 178 "longDescription": "This property shall contain the OEM extensions. All values for properties that this object contains shall conform to the Redfish Specification-described requirements." 179 }, 180 "PowerLimitWatts": { 181 "anyOf": [ 182 { 183 "$ref": "http://redfish.dmtf.org/schemas/v1/Control.json#/definitions/ControlSingleExcerpt" 184 }, 185 { 186 "type": "null" 187 } 188 ], 189 "description": "Power limit (W).", 190 "excerptCopy": "ControlSingleExcerpt", 191 "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`.", 192 "readonly": false, 193 "versionAdded": "v1_1_0" 194 }, 195 "PowerLoadPercent": { 196 "anyOf": [ 197 { 198 "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorExcerpt" 199 }, 200 { 201 "type": "null" 202 } 203 ], 204 "description": "The power load (percent) for this device.", 205 "excerptCopy": "SensorExcerpt", 206 "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`.", 207 "versionAdded": "v1_1_0" 208 }, 209 "PowerWatts": { 210 "anyOf": [ 211 { 212 "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorPowerExcerpt" 213 }, 214 { 215 "type": "null" 216 } 217 ], 218 "description": "Power consumption (W).", 219 "excerptCopy": "SensorPowerExcerpt", 220 "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`." 221 }, 222 "TemperatureCelsius": { 223 "anyOf": [ 224 { 225 "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorExcerpt" 226 }, 227 { 228 "type": "null" 229 } 230 ], 231 "description": "Temperature (Celsius).", 232 "excerptCopy": "SensorExcerpt", 233 "longDescription": "This property shall contain the temperature, in degree 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`." 234 } 235 }, 236 "required": [ 237 "@odata.id", 238 "@odata.type", 239 "Id", 240 "Name" 241 ], 242 "type": "object" 243 }, 244 "OemActions": { 245 "additionalProperties": true, 246 "description": "The available OEM-specific actions for this resource.", 247 "longDescription": "This type shall contain the available OEM-specific actions for this resource.", 248 "patternProperties": { 249 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 250 "description": "This property shall specify a valid odata or Redfish property.", 251 "type": [ 252 "array", 253 "boolean", 254 "integer", 255 "number", 256 "null", 257 "object", 258 "string" 259 ] 260 } 261 }, 262 "properties": {}, 263 "type": "object" 264 }, 265 "ResetMetrics": { 266 "additionalProperties": false, 267 "description": "This action resets the summary metrics related to this equipment.", 268 "longDescription": "This action shall reset any time intervals or counted values for this equipment.", 269 "parameters": {}, 270 "patternProperties": { 271 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 272 "description": "This property shall specify a valid odata or Redfish property.", 273 "type": [ 274 "array", 275 "boolean", 276 "integer", 277 "number", 278 "null", 279 "object", 280 "string" 281 ] 282 } 283 }, 284 "properties": { 285 "target": { 286 "description": "Link to invoke action", 287 "format": "uri-reference", 288 "type": "string" 289 }, 290 "title": { 291 "description": "Friendly action name", 292 "type": "string" 293 } 294 }, 295 "type": "object" 296 }, 297 "ResetToDefaults": { 298 "additionalProperties": false, 299 "description": "The action resets the values of writable properties to factory defaults.", 300 "longDescription": "This action shall reset the values of writable properties in this resource to their default values as specified by the manufacturer.", 301 "parameters": {}, 302 "patternProperties": { 303 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 304 "description": "This property shall specify a valid odata or Redfish property.", 305 "type": [ 306 "array", 307 "boolean", 308 "integer", 309 "number", 310 "null", 311 "object", 312 "string" 313 ] 314 } 315 }, 316 "properties": { 317 "target": { 318 "description": "Link to invoke action", 319 "format": "uri-reference", 320 "type": "string" 321 }, 322 "title": { 323 "description": "Friendly action name", 324 "type": "string" 325 } 326 }, 327 "type": "object", 328 "versionAdded": "v1_3_0" 329 } 330 }, 331 "language": "en", 332 "owningEntity": "DMTF", 333 "release": "2022.2", 334 "title": "#EnvironmentMetrics.v1_3_2.EnvironmentMetrics" 335}