1{
2    "$id": "http://redfish.dmtf.org/schemas/v1/PowerSupplyMetrics.v1_1_2.json",
3    "$ref": "#/definitions/PowerSupplyMetrics",
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                "#PowerSupplyMetrics.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        "PowerSupplyMetrics": {
59            "additionalProperties": false,
60            "description": "The `PowerSupplyMetrics` schema contains definitions for the metrics of a power supply.",
61            "longDescription": "This resource shall be used to represent the metrics of a power supply 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                "Actions": {
90                    "$ref": "#/definitions/Actions",
91                    "description": "The available actions for this resource.",
92                    "longDescription": "This property shall contain the available actions for this resource."
93                },
94                "Description": {
95                    "anyOf": [
96                        {
97                            "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
98                        },
99                        {
100                            "type": "null"
101                        }
102                    ],
103                    "readonly": true
104                },
105                "EnergykWh": {
106                    "anyOf": [
107                        {
108                            "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorEnergykWhExcerpt"
109                        },
110                        {
111                            "type": "null"
112                        }
113                    ],
114                    "description": "The energy consumption (kWh) of this unit.",
115                    "excerptCopy": "SensorEnergykWhExcerpt",
116                    "longDescription": "This property shall contain the total energy, in kilowatt-hour units, for this unit 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`."
117                },
118                "FanSpeedPercent": {
119                    "anyOf": [
120                        {
121                            "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorFanExcerpt"
122                        },
123                        {
124                            "type": "null"
125                        }
126                    ],
127                    "deprecated": "This property has been deprecated in favor of `FanSpeedsPercent` to support multiple fans within a power supply.",
128                    "description": "The fan speed (percent) for this power supply.",
129                    "excerptCopy": "SensorFanExcerpt",
130                    "longDescription": "This property shall contain the fan speed, 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`.",
131                    "versionDeprecated": "v1_1_0"
132                },
133                "FanSpeedsPercent": {
134                    "description": "Fan speeds (percent).",
135                    "excerptCopy": "SensorFanArrayExcerpt",
136                    "items": {
137                        "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorFanArrayExcerpt"
138                    },
139                    "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`.",
140                    "type": "array",
141                    "versionAdded": "v1_1_0"
142                },
143                "FanSpeedsPercent@odata.count": {
144                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
145                },
146                "FrequencyHz": {
147                    "anyOf": [
148                        {
149                            "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorExcerpt"
150                        },
151                        {
152                            "type": "null"
153                        }
154                    ],
155                    "description": "The frequency (Hz) for this power supply.",
156                    "excerptCopy": "SensorExcerpt",
157                    "longDescription": "This property shall contain the frequency, in hertz units, for this power supply."
158                },
159                "Id": {
160                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
161                    "readonly": true
162                },
163                "InputCurrentAmps": {
164                    "anyOf": [
165                        {
166                            "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorCurrentExcerpt"
167                        },
168                        {
169                            "type": "null"
170                        }
171                    ],
172                    "description": "The input current (A) for this power supply.",
173                    "excerptCopy": "SensorCurrentExcerpt",
174                    "longDescription": "This property shall contain the input current, in ampere units, for this power supply.  The value of the `DataSourceUri` property, if present, shall reference a resource of type `Sensor` with the `ReadingType` property containing the value `Current`."
175                },
176                "InputPowerWatts": {
177                    "anyOf": [
178                        {
179                            "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorPowerExcerpt"
180                        },
181                        {
182                            "type": "null"
183                        }
184                    ],
185                    "description": "The input power (W) for this power supply.",
186                    "excerptCopy": "SensorPowerExcerpt",
187                    "longDescription": "This property shall contain the input power, in watt units, for this power supply.  The value of the `DataSourceUri` property, if present, shall reference a resource of type `Sensor` with the `ReadingType` property containing the value `Power`."
188                },
189                "InputVoltage": {
190                    "anyOf": [
191                        {
192                            "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorVoltageExcerpt"
193                        },
194                        {
195                            "type": "null"
196                        }
197                    ],
198                    "description": "The input voltage (V) for this power supply.",
199                    "excerptCopy": "SensorVoltageExcerpt",
200                    "longDescription": "This property shall contain the input voltage, in volt units, for this power supply.  The value of the `DataSourceUri` property, if present, shall reference a resource of type `Sensor` with the `ReadingType` property containing the value `Voltage`."
201                },
202                "Name": {
203                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
204                    "readonly": true
205                },
206                "Oem": {
207                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
208                    "description": "The OEM extension property.",
209                    "longDescription": "This property shall contain the OEM extensions.  All values for properties that this object contains shall conform to the Redfish Specification-described requirements."
210                },
211                "OutputPowerWatts": {
212                    "anyOf": [
213                        {
214                            "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorPowerExcerpt"
215                        },
216                        {
217                            "type": "null"
218                        }
219                    ],
220                    "description": "The total power output (W) for this power supply.",
221                    "excerptCopy": "SensorPowerExcerpt",
222                    "longDescription": "This property shall contain the total output power, in watt units, for this power supply.  The value of the `DataSourceUri` property, if present, shall reference a resource of type `Sensor` with the `ReadingType` property containing the value `Power`."
223                },
224                "RailCurrentAmps": {
225                    "description": "The output currents (A) for this power supply.",
226                    "excerptCopy": "SensorCurrentExcerpt",
227                    "items": {
228                        "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorCurrentExcerpt"
229                    },
230                    "longDescription": "This property shall contain the output currents, in ampere units, for this power supply.  The value of the `DataSourceUri` property, if present, shall reference a resource of type `Sensor` with the `ReadingType` property containing the value `Current`.  The sensors shall appear in the same array order as the `OutputRails` property in the associated `PowerSupply` resource.",
231                    "type": "array"
232                },
233                "RailCurrentAmps@odata.count": {
234                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
235                },
236                "RailPowerWatts": {
237                    "description": "The output power readings (W) for this power supply.",
238                    "excerptCopy": "SensorPowerExcerpt",
239                    "items": {
240                        "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorPowerExcerpt"
241                    },
242                    "longDescription": "This property shall contain the output power readings, in watt units, for this power supply.  The value of the `DataSourceUri` property, if present, shall reference a resource of type `Sensor` with the `ReadingType` property containing the value `Power`.  The sensors shall appear in the same array order as the `OutputRails` property in the associated `PowerSupply` resource.",
243                    "type": "array"
244                },
245                "RailPowerWatts@odata.count": {
246                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
247                },
248                "RailVoltage": {
249                    "description": "The output voltages (V) for this power supply.",
250                    "excerptCopy": "SensorVoltageExcerpt",
251                    "items": {
252                        "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorVoltageExcerpt"
253                    },
254                    "longDescription": "This property shall contain the output voltages, in volt units, for this power supply.  The value of the `DataSourceUri` property, if present, shall reference a resource of type `Sensor` with the `ReadingType` property containing the value `Voltage`.  The sensors shall appear in the same array order as the `OutputRails` property in the associated `PowerSupply` resource.",
255                    "type": "array"
256                },
257                "RailVoltage@odata.count": {
258                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
259                },
260                "Status": {
261                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status",
262                    "description": "The status and health of the resource and its subordinate or dependent resources.",
263                    "longDescription": "This property shall contain any status or health properties of the resource."
264                },
265                "TemperatureCelsius": {
266                    "anyOf": [
267                        {
268                            "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorExcerpt"
269                        },
270                        {
271                            "type": "null"
272                        }
273                    ],
274                    "description": "The temperature (C) for this power supply.",
275                    "excerptCopy": "SensorExcerpt",
276                    "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`."
277                }
278            },
279            "required": [
280                "@odata.id",
281                "@odata.type",
282                "Id",
283                "Name"
284            ],
285            "type": "object"
286        },
287        "ResetMetrics": {
288            "additionalProperties": false,
289            "description": "This action resets the summary metrics related to this equipment.",
290            "longDescription": "This action shall reset any time intervals or counted values for this equipment.",
291            "parameters": {},
292            "patternProperties": {
293                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
294                    "description": "This property shall specify a valid odata or Redfish property.",
295                    "type": [
296                        "array",
297                        "boolean",
298                        "integer",
299                        "number",
300                        "null",
301                        "object",
302                        "string"
303                    ]
304                }
305            },
306            "properties": {
307                "target": {
308                    "description": "Link to invoke action",
309                    "format": "uri-reference",
310                    "type": "string"
311                },
312                "title": {
313                    "description": "Friendly action name",
314                    "type": "string"
315                }
316            },
317            "type": "object"
318        }
319    },
320    "language": "en",
321    "owningEntity": "DMTF",
322    "release": "2023.1",
323    "title": "#PowerSupplyMetrics.v1_1_2.PowerSupplyMetrics"
324}