Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / bmcweb / 118b1c7102e942ace53dac9f92a954864462eebe / . / static / redfish / v1 / JsonSchemas / Power / Power.json
blob: 8634c7c08d60ed1155ffd62119da8c090a39d6a6 [file] [log] [blame]
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame^]1{
2 "$ref": "#/definitions/Power",
3 "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema.v1_3_0.json",
4 "copyright": "Copyright 2014-2017 Distributed Management Task Force, Inc. (DMTF). For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright",
5 "definitions": {
6 "Actions": {
7 "additionalProperties": false,
8 "description": "The available actions for this resource.",
9 "longDescription": "This type shall contain the available actions for this resource.",
10 "patternProperties": {
11 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
12 "description": "This property shall specify a valid odata or Redfish property.",
13 "type": [
14 "array",
15 "boolean",
16 "number",
17 "null",
18 "object",
19 "string"
20 ]
21 }
22 },
23 "properties": {
24 "Oem": {
25 "$ref": "#/definitions/OemActions"
26 }
27 },
28 "type": "object"
29 },
30 "InputRange": {
31 "additionalProperties": false,
32 "description": "This type describes an input range for a power supply.",
33 "longDescription": "This type shall describe an input range that the associated power supply is able to utilize.",
34 "patternProperties": {
35 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
36 "description": "This property shall specify a valid odata or Redfish property.",
37 "type": [
38 "array",
39 "boolean",
40 "number",
41 "null",
42 "object",
43 "string"
44 ]
45 }
46 },
47 "properties": {
48 "InputType": {
49 "anyOf": [
50 {
51 "$ref": "#/definitions/InputType"
52 },
53 {
54 "type": "null"
55 }
56 ],
57 "description": "The Input type (AC or DC).",
58 "longDescription": "This property shall contain the input type (AC or DC) of the associated range.",
59 "readonly": true
60 },
61 "MaximumFrequencyHz": {
62 "description": "The maximum line input frequency at which this power supply input range is effective.",
63 "longDescription": "This property shall contain the value in Hertz of the maximum line input frequency which the power supply is capable of consuming for this range.",
64 "minimum": 0,
65 "readonly": true,
66 "type": [
67 "number",
68 "null"
69 ],
70 "units": "Hz"
71 },
72 "MaximumVoltage": {
73 "description": "The maximum line input voltage at which this power supply input range is effective.",
74 "longDescription": "This property shall contain the value in Volts of the maximum line input voltage which the power supply is capable of consuming for this range.",
75 "readonly": true,
76 "type": [
77 "number",
78 "null"
79 ],
80 "units": "V"
81 },
82 "MinimumFrequencyHz": {
83 "description": "The minimum line input frequency at which this power supply input range is effective.",
84 "longDescription": "This property shall contain the value in Hertz of the minimum line input frequency which the power supply is capable of consuming for this range.",
85 "minimum": 0,
86 "readonly": true,
87 "type": [
88 "number",
89 "null"
90 ],
91 "units": "Hz"
92 },
93 "MinimumVoltage": {
94 "description": "The minimum line input voltage at which this power supply input range is effective.",
95 "longDescription": "This property shall contain the value in Volts of the minimum line input voltage which the power supply is capable of consuming for this range.",
96 "readonly": true,
97 "type": [
98 "number",
99 "null"
100 ],
101 "units": "V"
102 },
103 "Oem": {
104 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem"
105 },
106 "OutputWattage": {
107 "description": "The maximum capacity of this Power Supply when operating in this input range.",
108 "longDescription": "This property shall contiain the maximum amount of power, in Watts, that the associated power supply is rated to deliver while operating in this input range.",
109 "minimum": 0,
110 "readonly": true,
111 "type": [
112 "number",
113 "null"
114 ],
115 "units": "W"
116 }
117 },
118 "type": "object"
119 },
120 "InputType": {
121 "enum": [
122 "AC",
123 "DC"
124 ],
125 "enumDescriptions": {
126 "AC": "Alternating Current (AC) input range.",
127 "DC": "Direct Current (DC) input range."
128 },
129 "type": "string"
130 },
131 "LineInputVoltageType": {
132 "enum": [
133 "Unknown",
134 "ACLowLine",
135 "ACMidLine",
136 "ACHighLine",
137 "DCNeg48V",
138 "DC380V",
139 "AC120V",
140 "AC240V",
141 "AC277V",
142 "ACandDCWideRange",
143 "ACWideRange",
144 "DC240V"
145 ],
146 "enumDeprecated": {
147 "ACHighLine": "This value has been Deprecated in favor of AC277V.",
148 "ACLowLine": "This value has been Deprecated in favor of AC120V.",
149 "ACMidLine": "This value has been Deprecated in favor of AC240V."
150 },
151 "enumDescriptions": {
152 "AC120V": "AC 120V nominal input.",
153 "AC240V": "AC 240V nominal input.",
154 "AC277V": "AC 277V nominal input.",
155 "ACHighLine": "277V AC input.",
156 "ACLowLine": "100-127V AC input.",
157 "ACMidLine": "200-240V AC input.",
158 "ACWideRange": "Wide range AC input.",
159 "ACandDCWideRange": "Wide range AC or DC input.",
160 "DC240V": "DC 240V nominal input.",
161 "DC380V": "High Voltage DC input (380V).",
162 "DCNeg48V": "-48V DC input.",
163 "Unknown": "The power supply line input voltage type cannot be determined."
164 },
165 "type": "string"
166 },
167 "OemActions": {
168 "additionalProperties": true,
169 "description": "The available OEM specific actions for this resource.",
170 "longDescription": "This type shall contain any additional OEM actions for this resource.",
171 "patternProperties": {
172 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
173 "description": "This property shall specify a valid odata or Redfish property.",
174 "type": [
175 "array",
176 "boolean",
177 "number",
178 "null",
179 "object",
180 "string"
181 ]
182 }
183 },
184 "properties": {},
185 "type": "object"
186 },
187 "Power": {
188 "additionalProperties": false,
189 "description": "This is the schema definition for the Power Metrics. It represents the properties for Power Consumption and Power Limiting.",
190 "longDescription": "This resource shall be used to represent a power metrics resource for a Redfish implementation.",
191 "patternProperties": {
192 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
193 "description": "This property shall specify a valid odata or Redfish property.",
194 "type": [
195 "array",
196 "boolean",
197 "number",
198 "null",
199 "object",
200 "string"
201 ]
202 }
203 },
204 "properties": {
205 "@odata.context": {
206 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_1.json#/definitions/context"
207 },
208 "@odata.id": {
209 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_1.json#/definitions/id"
210 },
211 "@odata.type": {
212 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_1.json#/definitions/type"
213 },
214 "Actions": {
215 "$ref": "#/definitions/Actions",
216 "description": "The available actions for this resource.",
217 "longDescription": "The Actions property shall contain the available actions for this resource."
218 },
219 "Description": {
220 "anyOf": [
221 {
222 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
223 },
224 {
225 "type": "null"
226 }
227 ],
228 "readonly": true
229 },
230 "Id": {
231 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
232 "readonly": true
233 },
234 "Name": {
235 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
236 "readonly": true
237 },
238 "Oem": {
239 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
240 "description": "This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections.",
241 "longDescription": "The value of this string shall be of the format for the reserved word *Oem*."
242 },
243 "PowerControl": {
244 "description": "This is the definition for power control function (power reading/limiting).",
245 "items": {
246 "$ref": "#/definitions/PowerControl"
247 },
248 "longDescription": "These properties shall be the definition for power control (power reading and limiting) for a Redfish implementation.",
249 "type": "array"
250 },
251 "PowerControl@odata.count": {
252 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_1.json#/definitions/count"
253 },
254 "PowerSupplies": {
255 "description": "Details of the power supplies associated with this system or device.",
256 "items": {
257 "$ref": "#/definitions/PowerSupply"
258 },
259 "longDescription": "This object shall contain details of the power supplies associated with this system or device.",
260 "type": "array"
261 },
262 "PowerSupplies@odata.count": {
263 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_1.json#/definitions/count"
264 },
265 "Redundancy": {
266 "description": "Redundancy information for the power subsystem of this system or device.",
267 "items": {
268 "$ref": "http://redfish.dmtf.org/schemas/v1/Redundancy.json#/definitions/Redundancy"
269 },
270 "type": "array"
271 },
272 "Redundancy@odata.count": {
273 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_1.json#/definitions/count"
274 },
275 "Voltages": {
276 "description": "This is the definition for voltage sensors.",
277 "items": {
278 "$ref": "#/definitions/Voltage"
279 },
280 "longDescription": "These properties shall be the definition for voltage sensors for a Redfish implementation.",
281 "type": "array"
282 },
283 "Voltages@odata.count": {
284 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_1.json#/definitions/count"
285 }
286 },
287 "required": [
288 "Id",
289 "Name"
290 ],
291 "type": "object"
292 },
293 "PowerControl": {
294 "additionalProperties": false,
295 "patternProperties": {
296 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
297 "description": "This property shall specify a valid odata or Redfish property.",
298 "type": [
299 "array",
300 "boolean",
301 "number",
302 "null",
303 "object",
304 "string"
305 ]
306 }
307 },
308 "properties": {
309 "Actions": {
310 "$ref": "#/definitions/PowerControlActions",
311 "description": "The available actions for this resource.",
312 "longDescription": "The Actions property shall contain the available actions for this resource."
313 },
314 "MemberId": {
315 "description": "This is the identifier for the member within the collection.",
316 "longDescription": "The value of this string shall uniquely identify the member within the collection.",
317 "readonly": true,
318 "type": "string"
319 },
320 "Name": {
321 "description": "Power Control Function name.",
322 "longDescription": "The value of this property shall be the name of the Voltage sensor.",
323 "readonly": true,
324 "type": [
325 "string",
326 "null"
327 ]
328 },
329 "Oem": {
330 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
331 "description": "This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections.",
332 "longDescription": "The value of this string shall be of the format for the reserved word *Oem*."
333 },
334 "PhysicalContext": {
335 "$ref": "http://redfish.dmtf.org/schemas/v1/PhysicalContext.json#/definitions/PhysicalContext",
336 "description": "Describes the area, device, or set of devices to which this power control applies.",
337 "longDescription": "The value of this property shall be a description of the affected device(s) or region within the chassis to which this power control applies.",
338 "readonly": true
339 },
340 "PowerAllocatedWatts": {
341 "description": "The total amount of power that has been allocated (or budegeted)to chassis resources.",
342 "longDescription": "The value of this property shall represent the total power currently allocated to chassis resources.",
343 "minimum": 0,
344 "readonly": true,
345 "type": [
346 "number",
347 "null"
348 ],
349 "units": "W"
350 },
351 "PowerAvailableWatts": {
352 "description": "The amount of power not already budgeted and therefore available for additional allocation. (powerCapacity - powerAllocated). This indicates how much reserve power capacity is left.",
353 "longDescription": "The value of this property shall represent the amount of power capacity (in Watts) not already allocated and shall equal PowerCapacityWatts - PowerAllocatedWatts.",
354 "minimum": 0,
355 "readonly": true,
356 "type": [
357 "number",
358 "null"
359 ],
360 "units": "W"
361 },
362 "PowerCapacityWatts": {
363 "description": "The total amount of power available to the chassis for allocation. This may the power supply capacity, or power budget assigned to the chassis from an up-stream chassis.",
364 "longDescription": "The value of this property shall represent the total power capacity that is available for allocation to the chassis resources.",
365 "minimum": 0,
366 "readonly": true,
367 "type": [
368 "number",
369 "null"
370 ],
371 "units": "W"
372 },
373 "PowerConsumedWatts": {
374 "description": "The actual power being consumed by the chassis.",
375 "longDescription": "The value of this property shall represent the actual power being consumed (in Watts) by the chassis.",
376 "minimum": 0,
377 "readonly": true,
378 "type": [
379 "number",
380 "null"
381 ],
382 "units": "W"
383 },
384 "PowerLimit": {
385 "$ref": "#/definitions/PowerLimit",
386 "description": "Power limit status and configuration information for this chassis.",
387 "longDescription": "This object shall contain power limit status and configuration information for this chassis."
388 },
389 "PowerMetrics": {
390 "$ref": "#/definitions/PowerMetric",
391 "description": "Power readings for this chassis.",
392 "longDescription": "This object shall contain power metrics for power readings (interval, min/max/ave power consumption) for the chassis."
393 },
394 "PowerRequestedWatts": {
395 "description": "The potential power that the chassis resources are requesting which may be higher than the current level being consumed since requested power includes budget that the chassis resource wants for future use.",
396 "longDescription": "The value of this property shall represent the amount of power (in Watts) that the chassis resource is currently requesting be budgeted to it for future use.",
397 "minimum": 0,
398 "readonly": true,
399 "type": [
400 "number",
401 "null"
402 ],
403 "units": "W"
404 },
405 "RelatedItem": {
406 "description": "The ID(s) of the resources associated with this Power Limit.",
407 "items": {
408 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_1.json#/definitions/idRef"
409 },
410 "longDescription": "The value of this property shall be an array of IDs containing pointers consistent with JSON pointer syntax to the resource that is being limited.",
411 "readonly": true,
412 "type": "array"
413 },
414 "RelatedItem@odata.count": {
415 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_1.json#/definitions/count"
416 },
417 "Status": {
418 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status"
419 }
420 },
421 "type": "object"
422 },
423 "PowerControlActions": {
424 "additionalProperties": false,
425 "description": "The available actions for this resource.",
426 "longDescription": "This type shall contain the available actions for this resource.",
427 "patternProperties": {
428 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
429 "description": "This property shall specify a valid odata or Redfish property.",
430 "type": [
431 "array",
432 "boolean",
433 "number",
434 "null",
435 "object",
436 "string"
437 ]
438 }
439 },
440 "properties": {
441 "Oem": {
442 "$ref": "#/definitions/PowerControlOemActions"
443 }
444 },
445 "type": "object"
446 },
447 "PowerControlOemActions": {
448 "additionalProperties": true,
449 "description": "The available OEM specific actions for this resource.",
450 "longDescription": "This type shall contain any additional OEM actions for this resource.",
451 "patternProperties": {
452 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
453 "description": "This property shall specify a valid odata or Redfish property.",
454 "type": [
455 "array",
456 "boolean",
457 "number",
458 "null",
459 "object",
460 "string"
461 ]
462 }
463 },
464 "properties": {},
465 "type": "object"
466 },
467 "PowerLimit": {
468 "additionalProperties": false,
469 "description": "This object contains power limit status and configuration information for the chassis.",
470 "longDescription": "This type shall contain power limit status and configuration information for this chassis.",
471 "patternProperties": {
472 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
473 "description": "This property shall specify a valid odata or Redfish property.",
474 "type": [
475 "array",
476 "boolean",
477 "number",
478 "null",
479 "object",
480 "string"
481 ]
482 }
483 },
484 "properties": {
485 "CorrectionInMs": {
486 "description": "The time required for the limiting process to reduce power consumption to below the limit.",
487 "longDescription": "The value of this property shall represent the time interval in ms required for the limiting process to react and reduce the power consumption below the limit.",
488 "readonly": false,
489 "type": [
490 "number",
491 "null"
492 ],
493 "units": "ms"
494 },
495 "LimitException": {
496 "anyOf": [
497 {
498 "$ref": "#/definitions/PowerLimitException"
499 },
500 {
501 "type": "null"
502 }
503 ],
504 "description": "The action that is taken if the power cannot be maintained below the LimitInWatts.",
505 "longDescription": "The value of this property shall represent the action to be taken if the resource power consumption can not be limited below the specified limit after several correction time periods.",
506 "readonly": false
507 },
508 "LimitInWatts": {
509 "description": "The Power limit in watts. Set to null to disable power capping.",
510 "longDescription": "The value of this property shall represent the power cap limit in watts for the resource. If set to null, power capping shall be disabled.",
511 "minimum": 0,
512 "readonly": false,
513 "type": [
514 "number",
515 "null"
516 ],
517 "units": "W"
518 }
519 },
520 "type": "object"
521 },
522 "PowerLimitException": {
523 "enum": [
524 "NoAction",
525 "HardPowerOff",
526 "LogEventOnly",
527 "Oem"
528 ],
529 "enumDescriptions": {
530 "HardPowerOff": "Turn the power off immediately when the limit is exceeded.",
531 "LogEventOnly": "Log an event when the limit is exceeded, but take no further action.",
532 "NoAction": "Take no action when the limit is exceeded.",
533 "Oem": "Take an OEM-defined action."
534 },
535 "type": "string"
536 },
537 "PowerMetric": {
538 "additionalProperties": false,
539 "description": "This type describe the power metrics for a resource.",
540 "longDescription": "This type shall contain power metrics for power readings (interval, min/max/ave power consumption) for a resource.",
541 "patternProperties": {
542 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
543 "description": "This property shall specify a valid odata or Redfish property.",
544 "type": [
545 "array",
546 "boolean",
547 "number",
548 "null",
549 "object",
550 "string"
551 ]
552 }
553 },
554 "properties": {
555 "AverageConsumedWatts": {
556 "description": "The average power level over the measurement window (the last IntervalInMin minutes).",
557 "longDescription": "The value of this property shall represent the average power level that occured averaged over the last IntervalInMin minutes.",
558 "minimum": 0,
559 "readonly": true,
560 "type": [
561 "number",
562 "null"
563 ],
564 "units": "W"
565 },
566 "IntervalInMin": {
567 "description": "The time interval (or window) in which the PowerMetrics are measured over.",
568 "longDescription": "The value of this property shall represent the time interval (or window), in minutes, in which the PowerMetrics properties are measured over.",
569 "minimum": 0,
570 "readonly": true,
571 "type": [
572 "number",
573 "null"
574 ],
575 "units": "min"
576 },
577 "MaxConsumedWatts": {
578 "description": "The highest power consumption level that has occured over the measurement window (the last IntervalInMin minutes).",
579 "longDescription": "The value of this property shall represent the maximum power level in watts that occured within the last IntervalInMin minutes.",
580 "minimum": 0,
581 "readonly": true,
582 "type": [
583 "number",
584 "null"
585 ],
586 "units": "W"
587 },
588 "MinConsumedWatts": {
589 "description": "The lowest power consumption level over the measurement window (the last IntervalInMin minutes).",
590 "longDescription": "The value of this property shall represent the minimum power level in watts that occured within the last IntervalInMin minutes.",
591 "minimum": 0,
592 "readonly": true,
593 "type": [
594 "number",
595 "null"
596 ],
597 "units": "W"
598 }
599 },
600 "type": "object"
601 },
602 "PowerSupply": {
603 "additionalProperties": false,
604 "description": "Details of a power supplies associated with this system or device.",
605 "patternProperties": {
606 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
607 "description": "This property shall specify a valid odata or Redfish property.",
608 "type": [
609 "array",
610 "boolean",
611 "number",
612 "null",
613 "object",
614 "string"
615 ]
616 }
617 },
618 "properties": {
619 "Actions": {
620 "$ref": "#/definitions/PowerSupplyActions",
621 "description": "The available actions for this resource.",
622 "longDescription": "The Actions property shall contain the available actions for this resource."
623 },
624 "Assembly": {
625 "$ref": "http://redfish.dmtf.org/schemas/v1/Assembly.json#/definitions/Assembly",
626 "description": "A reference to the Assembly resource associated with this power supply.",
627 "longDescription": "The value of this property shall be a link to a resource of type Assembly.",
628 "readonly": true
629 },
630 "EfficiencyPercent": {
631 "description": "The measured efficiency of this Power Supply as a percentage.",
632 "longDescription": "This property shall contain the value of the measured power efficiency, as a percentage, of the associated power supply.",
633 "maximum": 100,
634 "minimum": 0,
635 "readonly": true,
636 "type": [
637 "number",
638 "null"
639 ],
640 "units": "%"
641 },
642 "FirmwareVersion": {
643 "description": "The firmware version for this Power Supply.",
644 "longDescription": "This property shall contain the firwmare version as defined by the manufacturer for the associated power supply.",
645 "readonly": true,
646 "type": [
647 "string",
648 "null"
649 ]
650 },
651 "HotPluggable": {
652 "description": "Indicates if this device can be inserted or removed while the equipment is in operation.",
653 "longDescription": "The value of this property shall indicate whether the device can be inserted or removed while the underlying equipment otherwise remains in its current operational state. Devices indicated as hot-pluggable shall allow the device to become operable without altering the operational state of the underlying equipment. Devices that cannot be inserted or removed from equipment in operation, or devices that cannot become operable without affecting the operational state of that equipment, shall be indicated as not hot-pluggable.",
654 "readonly": true,
655 "type": [
656 "boolean",
657 "null"
658 ]
659 },
660 "IndicatorLED": {
661 "anyOf": [
662 {
663 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/IndicatorLED"
664 },
665 {
666 "type": "null"
667 }
668 ],
669 "description": "The state of the indicator LED, used to identify the power supply.",
670 "longDescription": "The value of this property shall contain the indicator light state for the indicator light associated with this power supply.",
671 "readonly": false
672 },
673 "InputRanges": {
674 "description": "This is the input ranges that the power supply can use.",
675 "items": {
676 "$ref": "#/definitions/InputRange"
677 },
678 "longDescription": "The value of this property shall be a collection of ranges usable by the power supply unit.",
679 "type": "array"
680 },
681 "LastPowerOutputWatts": {
682 "description": "The average power output of this Power Supply.",
683 "longDescription": "This property shall contain the average power output, measured in Watts, of the associated power supply.",
684 "minimum": 0,
685 "readonly": true,
686 "type": [
687 "number",
688 "null"
689 ],
690 "units": "W"
691 },
692 "LineInputVoltage": {
693 "description": "The line input voltage at which the Power Supply is operating.",
694 "longDescription": "This property shall contain the value in Volts of the line input voltage (measured or configured for) that the power supply has been configured to operate with or is currently receiving.",
695 "readonly": true,
696 "type": [
697 "number",
698 "null"
699 ],
700 "units": "V"
701 },
702 "LineInputVoltageType": {
703 "anyOf": [
704 {
705 "$ref": "#/definitions/LineInputVoltageType"
706 },
707 {
708 "type": "null"
709 }
710 ],
711 "description": "The line voltage type supported as an input to this Power Supply.",
712 "longDescription": "This property shall contain the type of input line voltage supported by the associated power supply.",
713 "readonly": true
714 },
715 "Location": {
716 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Location"
717 },
718 "Manufacturer": {
719 "description": "This is the manufacturer of this power supply.",
720 "longDescription": "The value of this property shall be the name of the organization responsible for producing the power supply. This organization might be the entity from whom the power supply is purchased, but this is not necessarily true.",
721 "readonly": true,
722 "type": [
723 "string",
724 "null"
725 ]
726 },
727 "MemberId": {
728 "description": "This is the identifier for the member within the collection.",
729 "longDescription": "The value of this string shall uniquely identify the member within the collection.",
730 "readonly": true,
731 "type": "string"
732 },
733 "Model": {
734 "description": "The model number for this Power Supply.",
735 "longDescription": "This property shall contain the model information as defined by the manufacturer for the associated power supply.",
736 "readonly": true,
737 "type": [
738 "string",
739 "null"
740 ]
741 },
742 "Name": {
743 "description": "The name of the Power Supply.",
744 "longDescription": "This property shall contain a descriptive name for the associated power supply.",
745 "readonly": true,
746 "type": [
747 "string",
748 "null"
749 ]
750 },
751 "Oem": {
752 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
753 "description": "This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections.",
754 "longDescription": "The value of this string shall be of the format for the reserved word *Oem*."
755 },
756 "PartNumber": {
757 "description": "The part number for this Power Supply.",
758 "longDescription": "This property shall contain the part number as defined by the manufacturer for the associated power supply.",
759 "readonly": true,
760 "type": [
761 "string",
762 "null"
763 ]
764 },
765 "PowerCapacityWatts": {
766 "description": "The maximum capacity of this Power Supply.",
767 "longDescription": "This property shall contiain the maximum amount of power, in Watts, that the associated power supply is rated to deliver.",
768 "minimum": 0,
769 "readonly": true,
770 "type": [
771 "number",
772 "null"
773 ],
774 "units": "W"
775 },
776 "PowerInputWatts": {
777 "description": "The measured input power of this Power Supply.",
778 "longDescription": "This property shall contain the value of the measured input power, in Watts, of the associated power supply.",
779 "minimum": 0,
780 "readonly": true,
781 "type": [
782 "number",
783 "null"
784 ],
785 "units": "W"
786 },
787 "PowerOutputWatts": {
788 "description": "The measured output power of this Power Supply.",
789 "longDescription": "This property shall contain the value of the measured output power, in Watts, of the associated power supply.",
790 "minimum": 0,
791 "readonly": true,
792 "type": [
793 "number",
794 "null"
795 ],
796 "units": "W"
797 },
798 "PowerSupplyType": {
799 "anyOf": [
800 {
801 "$ref": "#/definitions/PowerSupplyType"
802 },
803 {
804 "type": "null"
805 }
806 ],
807 "description": "The Power Supply type (AC or DC).",
808 "longDescription": "This property shall contain the input power type (AC or DC) of the associated power supply.",
809 "readonly": true
810 },
811 "Redundancy": {
812 "description": "This structure is used to show redundancy for power supplies. The Component ids will reference the members of the redundancy groups.",
813 "items": {
814 "$ref": "http://redfish.dmtf.org/schemas/v1/Redundancy.json#/definitions/Redundancy"
815 },
816 "longDescription": "The values of the properties in this array shall be used to show redundancy for power supplies and other elements in this resource. The use of IDs within these arrays shall reference the members of the redundancy groups.",
817 "type": "array"
818 },
819 "Redundancy@odata.count": {
820 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_1.json#/definitions/count"
821 },
822 "RelatedItem": {
823 "description": "The ID(s) of the resources associated with this Power Limit.",
824 "items": {
825 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_1.json#/definitions/idRef"
826 },
827 "longDescription": "The value of this property shall be an array of IDs containing pointers consistent with JSON pointer syntax to the resource that is being limited.",
828 "type": "array"
829 },
830 "RelatedItem@odata.count": {
831 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_1.json#/definitions/count"
832 },
833 "SerialNumber": {
834 "description": "The serial number for this Power Supply.",
835 "longDescription": "This property shall contain the serial number as defined by the manufacturer for the associated power supply.",
836 "readonly": true,
837 "type": [
838 "string",
839 "null"
840 ]
841 },
842 "SparePartNumber": {
843 "description": "The spare part number for this Power Supply.",
844 "longDescription": "This property shall contain the spare or replacement part number as defined by the manufacturer for the associated power supply.",
845 "readonly": true,
846 "type": [
847 "string",
848 "null"
849 ]
850 },
851 "Status": {
852 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status"
853 }
854 },
855 "type": "object"
856 },
857 "PowerSupplyActions": {
858 "additionalProperties": false,
859 "description": "The available actions for this resource.",
860 "longDescription": "This type shall contain the available actions for this resource.",
861 "patternProperties": {
862 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
863 "description": "This property shall specify a valid odata or Redfish property.",
864 "type": [
865 "array",
866 "boolean",
867 "number",
868 "null",
869 "object",
870 "string"
871 ]
872 }
873 },
874 "properties": {
875 "Oem": {
876 "$ref": "#/definitions/PowerSupplyOemActions"
877 }
878 },
879 "type": "object"
880 },
881 "PowerSupplyOemActions": {
882 "additionalProperties": true,
883 "description": "The available OEM specific actions for this resource.",
884 "longDescription": "This type shall contain any additional OEM actions for this resource.",
885 "patternProperties": {
886 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
887 "description": "This property shall specify a valid odata or Redfish property.",
888 "type": [
889 "array",
890 "boolean",
891 "number",
892 "null",
893 "object",
894 "string"
895 ]
896 }
897 },
898 "properties": {},
899 "type": "object"
900 },
901 "PowerSupplyType": {
902 "enum": [
903 "Unknown",
904 "AC",
905 "DC",
906 "ACorDC"
907 ],
908 "enumDescriptions": {
909 "AC": "Alternating Current (AC) power supply.",
910 "ACorDC": "Power Supply supports both DC or AC.",
911 "DC": "Direct Current (DC) power supply.",
912 "Unknown": "The power supply type cannot be determined."
913 },
914 "type": "string"
915 },
916 "Voltage": {
917 "additionalProperties": false,
918 "patternProperties": {
919 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
920 "description": "This property shall specify a valid odata or Redfish property.",
921 "type": [
922 "array",
923 "boolean",
924 "number",
925 "null",
926 "object",
927 "string"
928 ]
929 }
930 },
931 "properties": {
932 "Actions": {
933 "$ref": "#/definitions/VoltageActions",
934 "description": "The available actions for this resource.",
935 "longDescription": "The Actions property shall contain the available actions for this resource."
936 },
937 "LowerThresholdCritical": {
938 "description": "Below normal range but not yet fatal.",
939 "longDescription": "The value of this property shall indicate the present reading is below the normal range but is not yet fatal. Units shall use the same units as the related ReadingVolts propoerty.",
940 "readonly": true,
941 "type": [
942 "number",
943 "null"
944 ],
945 "units": "V"
946 },
947 "LowerThresholdFatal": {
948 "description": "Below normal range and is fatal.",
949 "longDescription": "The value of this property shall indicate the present reading is below the normal range and is fatal. Units shall use the same units as the related ReadingVolts propoerty.",
950 "readonly": true,
951 "type": [
952 "number",
953 "null"
954 ],
955 "units": "V"
956 },
957 "LowerThresholdNonCritical": {
958 "description": "Below normal range.",
959 "longDescription": "The value of this property shall indicate the present reading is below the normal range but is not critical. Units shall use the same units as the related ReadingVolts propoerty.",
960 "readonly": true,
961 "type": [
962 "number",
963 "null"
964 ],
965 "units": "V"
966 },
967 "MaxReadingRange": {
968 "description": "Maximum value for this Voltage sensor.",
969 "longDescription": "The value of this property shall indicate the highest possible value for ReadingVolts. Units shall use the same units as the related ReadingVolts propoerty.",
970 "readonly": true,
971 "type": [
972 "number",
973 "null"
974 ],
975 "units": "V"
976 },
977 "MemberId": {
978 "description": "This is the identifier for the member within the collection.",
979 "longDescription": "The value of this string shall uniquely identify the member within the collection.",
980 "readonly": true,
981 "type": "string"
982 },
983 "MinReadingRange": {
984 "description": "Minimum value for this Voltage sensor.",
985 "longDescription": "The value of this property shall indicate the lowest possible value for ReadingVolts. Units shall use the same units as the related ReadingVolts propoerty.",
986 "readonly": true,
987 "type": [
988 "number",
989 "null"
990 ],
991 "units": "V"
992 },
993 "Name": {
994 "description": "Voltage sensor name.",
995 "longDescription": "The value of this property shall be the name of the Voltage sensor.",
996 "readonly": true,
997 "type": [
998 "string",
999 "null"
1000 ]
1001 },
1002 "Oem": {
1003 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
1004 "description": "This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections.",
1005 "longDescription": "The value of this string shall be of the format for the reserved word *Oem*."
1006 },
1007 "PhysicalContext": {
1008 "$ref": "http://redfish.dmtf.org/schemas/v1/PhysicalContext.json#/definitions/PhysicalContext",
1009 "description": "Describes the area or device to which this voltage measurement applies.",
1010 "longDescription": "The value of this property shall be a description of the affected device or region within the chassis to which this voltage measurement applies.",
1011 "readonly": true
1012 },
1013 "ReadingVolts": {
1014 "description": "The present reading of the voltage sensor.",
1015 "longDescription": "The value of this property shall be the present reading of the voltage sensor's reading.",
1016 "readonly": true,
1017 "type": [
1018 "number",
1019 "null"
1020 ],
1021 "units": "V"
1022 },
1023 "RelatedItem": {
1024 "description": "Describes the areas or devices to which this voltage measurement applies.",
1025 "items": {
1026 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_1.json#/definitions/idRef"
1027 },
1028 "longDescription": "The value of this property shall be an array of IDs containing pointers consistent with JSON pointer syntax to the areas or devices to which this voltage measurement applies.",
1029 "readonly": true,
1030 "type": "array"
1031 },
1032 "RelatedItem@odata.count": {
1033 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_1.json#/definitions/count"
1034 },
1035 "SensorNumber": {
1036 "description": "A numerical identifier to represent the voltage sensor.",
1037 "longDescription": "The value of this property shall be a numerical identifier for this voltage sensor that is unique within this resource.",
1038 "readonly": true,
1039 "type": [
1040 "number",
1041 "null"
1042 ]
1043 },
1044 "Status": {
1045 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status"
1046 },
1047 "UpperThresholdCritical": {
1048 "description": "Above normal range but not yet fatal.",
1049 "longDescription": "The value of this property shall indicate the present reading is above the normal range but is not yet fatal. Units shall use the same units as the related ReadingVolts propoerty.",
1050 "readonly": true,
1051 "type": [
1052 "number",
1053 "null"
1054 ],
1055 "units": "V"
1056 },
1057 "UpperThresholdFatal": {
1058 "description": "Above normal range and is fatal.",
1059 "longDescription": "The value of this property shall indicate the present reading is above the normal range and is fatal. Units shall use the same units as the related ReadingVolts propoerty.",
1060 "readonly": true,
1061 "type": [
1062 "number",
1063 "null"
1064 ],
1065 "units": "V"
1066 },
1067 "UpperThresholdNonCritical": {
1068 "description": "Above normal range.",
1069 "longDescription": "The value of this property shall indicate the present reading is above the normal range but is not critical. Units shall use the same units as the related ReadingVolts propoerty.",
1070 "readonly": true,
1071 "type": [
1072 "number",
1073 "null"
1074 ],
1075 "units": "V"
1076 }
1077 },
1078 "type": "object"
1079 },
1080 "VoltageActions": {
1081 "additionalProperties": false,
1082 "description": "The available actions for this resource.",
1083 "longDescription": "This type shall contain the available actions for this resource.",
1084 "patternProperties": {
1085 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
1086 "description": "This property shall specify a valid odata or Redfish property.",
1087 "type": [
1088 "array",
1089 "boolean",
1090 "number",
1091 "null",
1092 "object",
1093 "string"
1094 ]
1095 }
1096 },
1097 "properties": {
1098 "Oem": {
1099 "$ref": "#/definitions/VoltageOemActions"
1100 }
1101 },
1102 "type": "object"
1103 },
1104 "VoltageOemActions": {
1105 "additionalProperties": true,
1106 "description": "The available OEM specific actions for this resource.",
1107 "longDescription": "This type shall contain any additional OEM actions for this resource.",
1108 "patternProperties": {
1109 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
1110 "description": "This property shall specify a valid odata or Redfish property.",
1111 "type": [
1112 "array",
1113 "boolean",
1114 "number",
1115 "null",
1116 "object",
1117 "string"
1118 ]
1119 }
1120 },
1121 "properties": {},
1122 "type": "object"
1123 }
1124 },
1125 "title": "#Power.v1_5_0.Power"
1126}