xref: /openbmc/bmcweb/redfish-core/schema/dmtf/json-schema/PowerDistributionMetrics.v1_4_0.json (revision d125652e8a30dfeaad88bbfa5b1e04a80610469c)
1{
2    "$id": "http://redfish.dmtf.org/schemas/v1/PowerDistributionMetrics.v1_4_0.json",
3    "$ref": "#/definitions/PowerDistributionMetrics",
4    "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
5    "copyright": "Copyright 2014-2025 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                "#PowerDistributionMetrics.ResetMetrics": {
27                    "$ref": "#/definitions/ResetMetrics"
28                },
29                "Oem": {
30                    "$ref": "#/definitions/OemActions",
31                    "description": "The available OEM-specific actions for this resource.",
32                    "longDescription": "This property shall contain the available OEM-specific actions for this resource."
33                }
34            },
35            "type": "object"
36        },
37        "OemActions": {
38            "additionalProperties": true,
39            "description": "The available OEM-specific actions for this resource.",
40            "longDescription": "This type shall contain the available OEM-specific actions for this resource.",
41            "patternProperties": {
42                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
43                    "description": "This property shall specify a valid odata or Redfish property.",
44                    "type": [
45                        "array",
46                        "boolean",
47                        "integer",
48                        "number",
49                        "null",
50                        "object",
51                        "string"
52                    ]
53                }
54            },
55            "properties": {},
56            "type": "object"
57        },
58        "PowerDistributionMetrics": {
59            "additionalProperties": false,
60            "description": "The `PowerDistributionMetrics` schema contains metrics of a power distribution component or unit, such as a floor power distribution unit (PDU) or switchgear.",
61            "longDescription": "This resource shall represent the metrics of a power distribution component or unit for a Redfish implementation.",
62            "patternProperties": {
63                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
64                    "description": "This property shall specify a valid odata or Redfish property.",
65                    "type": [
66                        "array",
67                        "boolean",
68                        "integer",
69                        "number",
70                        "null",
71                        "object",
72                        "string"
73                    ]
74                }
75            },
76            "properties": {
77                "@odata.context": {
78                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context"
79                },
80                "@odata.etag": {
81                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag"
82                },
83                "@odata.id": {
84                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id"
85                },
86                "@odata.type": {
87                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type"
88                },
89                "AbsoluteHumidity": {
90                    "anyOf": [
91                        {
92                            "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorExcerpt"
93                        },
94                        {
95                            "type": "null"
96                        }
97                    ],
98                    "description": "Absolute humidity (g/m^3).",
99                    "excerptCopy": "SensorExcerpt",
100                    "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`.",
101                    "versionAdded": "v1_3_0"
102                },
103                "Actions": {
104                    "$ref": "#/definitions/Actions",
105                    "description": "The available actions for this resource.",
106                    "longDescription": "This property shall contain the available actions for this resource."
107                },
108                "AmbientTemperatureCelsius": {
109                    "anyOf": [
110                        {
111                            "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorExcerpt"
112                        },
113                        {
114                            "type": "null"
115                        }
116                    ],
117                    "description": "Ambient temperature (Celsius).",
118                    "excerptCopy": "SensorExcerpt",
119                    "longDescription": "This property shall contain the ambient temperature, in degree Celsius units, for this resource.  The ambient temperature shall be the temperature measured at a point exterior to the `Chassis` containing 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`.  This property shall only be present, if supported, in resource instances subordinate to a `Chassis` or `CoolingUnit` resource.",
120                    "versionAdded": "v1_4_0"
121                },
122                "Description": {
123                    "anyOf": [
124                        {
125                            "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
126                        },
127                        {
128                            "type": "null"
129                        }
130                    ],
131                    "readonly": true
132                },
133                "EnergykWh": {
134                    "anyOf": [
135                        {
136                            "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorEnergykWhExcerpt"
137                        },
138                        {
139                            "type": "null"
140                        }
141                    ],
142                    "description": "Energy consumption (kWh).",
143                    "excerptCopy": "SensorEnergykWhExcerpt",
144                    "longDescription": "This property shall contain the total energy, in kilowatt-hour units, for this resource that represents the `Total` `ElectricalContext` sensor when multiple energy sensors exist.  The value of the `DataSourceUri` property, if present, shall reference a resource of type `Sensor` with the `ReadingType` property containing the value `EnergykWh`."
145                },
146                "HumidityPercent": {
147                    "anyOf": [
148                        {
149                            "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorExcerpt"
150                        },
151                        {
152                            "type": "null"
153                        }
154                    ],
155                    "description": "Humidity (percent).",
156                    "excerptCopy": "SensorExcerpt",
157                    "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`.",
158                    "versionAdded": "v1_1_0"
159                },
160                "Id": {
161                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
162                    "readonly": true
163                },
164                "Name": {
165                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
166                    "readonly": true
167                },
168                "Oem": {
169                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
170                    "description": "The OEM extension property.",
171                    "longDescription": "This property shall contain the OEM extensions.  All values for properties that this object contains shall conform to the Redfish Specification-described requirements."
172                },
173                "PowerLoadPercent": {
174                    "anyOf": [
175                        {
176                            "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorExcerpt"
177                        },
178                        {
179                            "type": "null"
180                        }
181                    ],
182                    "description": "The power load (percent) for this equipment.",
183                    "excerptCopy": "SensorExcerpt",
184                    "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`.",
185                    "versionAdded": "v1_2_0"
186                },
187                "PowerWatts": {
188                    "anyOf": [
189                        {
190                            "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorPowerExcerpt"
191                        },
192                        {
193                            "type": "null"
194                        }
195                    ],
196                    "description": "Power consumption (W).",
197                    "excerptCopy": "SensorPowerExcerpt",
198                    "longDescription": "This property shall contain the total power, in watt units, for this resource that represents the `Total` `ElectricalContext` sensor when multiple power sensors exist.  The value of the `DataSourceUri` property, if present, shall reference a resource of type `Sensor` with the `ReadingType` property containing the value `Power`."
199                },
200                "TemperatureCelsius": {
201                    "anyOf": [
202                        {
203                            "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorExcerpt"
204                        },
205                        {
206                            "type": "null"
207                        }
208                    ],
209                    "description": "Temperature (Celsius).",
210                    "excerptCopy": "SensorExcerpt",
211                    "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`.",
212                    "versionAdded": "v1_1_0"
213                }
214            },
215            "required": [
216                "@odata.id",
217                "@odata.type",
218                "Id",
219                "Name"
220            ],
221            "type": "object"
222        },
223        "ResetMetrics": {
224            "additionalProperties": false,
225            "description": "This action resets the summary metrics related to this equipment.",
226            "longDescription": "This action shall reset any time intervals or counted values for this equipment.",
227            "parameters": {},
228            "patternProperties": {
229                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
230                    "description": "This property shall specify a valid odata or Redfish property.",
231                    "type": [
232                        "array",
233                        "boolean",
234                        "integer",
235                        "number",
236                        "null",
237                        "object",
238                        "string"
239                    ]
240                }
241            },
242            "properties": {
243                "target": {
244                    "description": "Link to invoke action",
245                    "format": "uri-reference",
246                    "type": "string"
247                },
248                "title": {
249                    "description": "Friendly action name",
250                    "type": "string"
251                }
252            },
253            "type": "object"
254        }
255    },
256    "language": "en",
257    "owningEntity": "DMTF",
258    "release": "2025.1",
259    "title": "#PowerDistributionMetrics.v1_4_0.PowerDistributionMetrics"
260}