1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
|
{
"$id": "http://redfish.dmtf.org/schemas/v1/PowerDistribution.v1_0_1.json",
"$ref": "#/definitions/PowerDistribution",
"$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
"copyright": "Copyright 2014-2020 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": {
"#PowerDistribution.TransferControl": {
"$ref": "#/definitions/TransferControl"
},
"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"
},
"Links": {
"additionalProperties": false,
"description": "The links to other resources that are related to this resource.",
"longDescription": "This Redfish Specification-described type shall contain links to resources that are related to but are not contained by, or subordinate to, 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": {
"Chassis": {
"description": "An array of links to the chassis that contain this equipment.",
"items": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Chassis.json#/definitions/Chassis"
},
"longDescription": "This property shall contain an array of links to resources of type Chassis that represents the physical container associated with this resource. This property should only be populated for modular and/or multi-chassis power distribution equipment.",
"readonly": true,
"type": "array"
},
"Chassis@odata.count": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
},
"Facility": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Facility.json#/definitions/Facility",
"description": "A link to the facility that contains this equipment.",
"longDescription": "This property shall contain a link to a resource of type Facility that represents the facility that contains this equipment.",
"readonly": true
},
"ManagedBy": {
"description": "An array of links to the managers responsible for managing this equipment.",
"items": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Manager.json#/definitions/Manager"
},
"longDescription": "This property shall contain an array of links to resources of type Manager that represent the managers that manage this equipment.",
"readonly": true,
"type": "array"
},
"ManagedBy@odata.count": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
},
"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 contained in this object shall conform to the Redfish Specification-described requirements."
}
},
"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"
},
"PowerDistribution": {
"additionalProperties": false,
"description": "This is the schema definition for a power distribution component or unit, such as a floor power distribution unit (PDU) or switchgear.",
"longDescription": "This resource shall be used to represent a power distribution component or unit 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"
},
"Actions": {
"$ref": "#/definitions/Actions",
"description": "The available actions for this resource.",
"longDescription": "This property shall contain the available actions for this resource."
},
"AssetTag": {
"description": "The user-assigned asset tag for this equipment.",
"longDescription": "This property shall contain the user-assigned asset tag, which is an identifying string that tracks the equipment for inventory purposes.",
"readonly": false,
"type": [
"string",
"null"
]
},
"Branches": {
"$ref": "http://redfish.dmtf.org/schemas/v1/CircuitCollection.json#/definitions/CircuitCollection",
"description": "A link to the branch circuits for this equipment.",
"longDescription": "This property shall contain a link to a resource collection of type CircuitCollection that contains the branch circuits for this equipment.",
"readonly": true
},
"Description": {
"anyOf": [
{
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
},
{
"type": "null"
}
],
"readonly": true
},
"EquipmentType": {
"$ref": "#/definitions/PowerEquipmentType",
"description": "The type of equipment this resource represents.",
"longDescription": "This property shall contain the type of equipment this resource represents.",
"readonly": true
},
"Feeders": {
"$ref": "http://redfish.dmtf.org/schemas/v1/CircuitCollection.json#/definitions/CircuitCollection",
"description": "A link to the feeder circuits for this equipment.",
"longDescription": "This property shall contain a link to a resource collection of type CircuitCollection that contains the feeder circuits for this equipment.",
"readonly": true
},
"FirmwareVersion": {
"description": "The firmware version of this equipment.",
"longDescription": "This property shall contain a string describing the firmware version of this equipment as provided by the manufacturer.",
"readonly": true,
"type": "string"
},
"Id": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
"readonly": true
},
"Links": {
"$ref": "#/definitions/Links",
"description": "The links to other resources that are related to this resource.",
"longDescription": "This property shall contain links to resources that are related to but are not contained by, or subordinate to, this resource."
},
"Location": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Location",
"description": "The location of the equipment.",
"longDescription": "This property shall contain location information of the associated equipment."
},
"Mains": {
"$ref": "http://redfish.dmtf.org/schemas/v1/CircuitCollection.json#/definitions/CircuitCollection",
"description": "A link to the power input circuits for this equipment.",
"longDescription": "This property shall contain a link to a resource collection of type CircuitCollection that contains the power input circuits for this equipment.",
"readonly": true
},
"Manufacturer": {
"description": "The manufacturer of this equipment.",
"longDescription": "This property shall contain the name of the organization responsible for producing the equipment. This organization might be the entity from which the equipment is purchased, but this is not necessarily true.",
"readonly": true,
"type": [
"string",
"null"
]
},
"Metrics": {
"$ref": "http://redfish.dmtf.org/schemas/v1/PowerDistributionMetrics.json#/definitions/PowerDistributionMetrics",
"description": "A link to the summary metrics for this equipment.",
"longDescription": "This property shall contain a link to a resource of type PowerDistributionMetrics.",
"readonly": true
},
"Model": {
"description": "The product model number of this equipment.",
"longDescription": "This property shall contain the manufacturer-provided model information of this equipment.",
"readonly": true,
"type": [
"string",
"null"
]
},
"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."
},
"OutletGroups": {
"$ref": "http://redfish.dmtf.org/schemas/v1/OutletGroupCollection.json#/definitions/OutletGroupCollection",
"description": "A link to the outlet groups for this equipment.",
"longDescription": "This property shall contain a link to a resource collection of type OutletCollection that contains the outlet groups for this equipment.",
"readonly": true
},
"Outlets": {
"$ref": "http://redfish.dmtf.org/schemas/v1/OutletCollection.json#/definitions/OutletCollection",
"description": "A link to the outlets for this equipment.",
"longDescription": "This property shall contain a link to a resource collection of type OutletCollection that contains the outlets for this equipment.",
"readonly": true
},
"PartNumber": {
"description": "The part number for this equipment.",
"longDescription": "This property shall contain the manufacturer-provided part number for the equipment.",
"readonly": true,
"type": [
"string",
"null"
]
},
"ProductionDate": {
"description": "The production or manufacturing date of this equipment.",
"format": "date-time",
"longDescription": "This property shall contain the date of production or manufacture for this equipment.",
"readonly": true,
"type": [
"string",
"null"
]
},
"Sensors": {
"$ref": "http://redfish.dmtf.org/schemas/v1/SensorCollection.json#/definitions/SensorCollection",
"description": "A link to the collection of sensors located in the equipment and sub-components.",
"longDescription": "This property shall be a link to a resource collection of type SensorCollection that contains the sensors located in the equipment and sub-components.",
"readonly": true
},
"SerialNumber": {
"description": "The serial number for this equipment.",
"longDescription": "This property shall contain a manufacturer-allocated number that identifies the equipment.",
"readonly": true,
"type": [
"string",
"null"
]
},
"Status": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status",
"description": "The status and health of the resource and its subordinate or dependent resources.",
"longDescription": "This property shall contain any status or health properties of the resource."
},
"Subfeeds": {
"$ref": "http://redfish.dmtf.org/schemas/v1/CircuitCollection.json#/definitions/CircuitCollection",
"description": "A link to the subfeed circuits for this equipment.",
"longDescription": "This property shall contain a link to a resource collection of type CircuitCollection that contains the subfeed circuits for this equipment.",
"readonly": true
},
"TransferConfiguration": {
"anyOf": [
{
"$ref": "#/definitions/TransferConfiguration"
},
{
"type": "null"
}
],
"description": "The configuration settings for an automatic transfer switch.",
"longDescription": "This property shall contain the configuration information regarding an automatic transfer switch function for this resource."
},
"TransferCriteria": {
"anyOf": [
{
"$ref": "#/definitions/TransferCriteria"
},
{
"type": "null"
}
],
"description": "The criteria used to initiate a transfer for an automatic transfer switch.",
"longDescription": "This property shall contain the criteria for initiating a transfer within an automatic transfer switch function for this resource."
},
"UUID": {
"anyOf": [
{
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/UUID"
},
{
"type": "null"
}
],
"description": "The UUID for this equipment.",
"longDescription": "This property shall contain the UUID for the equipment.",
"readonly": true
},
"Version": {
"description": "The hardware version of this equipment.",
"longDescription": "This property shall contain the hardware version of this equipment as determined by the vendor or supplier.",
"readonly": true,
"type": [
"string",
"null"
]
}
},
"required": [
"EquipmentType",
"@odata.id",
"@odata.type",
"Id",
"Name"
],
"type": "object"
},
"PowerEquipmentType": {
"enum": [
"RackPDU",
"FloorPDU",
"ManualTransferSwitch",
"AutomaticTransferSwitch",
"Switchgear"
],
"enumDescriptions": {
"AutomaticTransferSwitch": "An automatic power transfer switch.",
"FloorPDU": "A power distribution unit providing feeder circuits for further power distribution.",
"ManualTransferSwitch": "A manual power transfer switch.",
"RackPDU": "A power distribution unit providing outlets for a rack or similar quantity of devices.",
"Switchgear": "Electrical switchgear."
},
"type": "string"
},
"TransferConfiguration": {
"additionalProperties": false,
"description": "The configuration settings for an automatic transfer switch.",
"longDescription": "This type shall contain the configuration information regarding an automatic transfer switch function 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": {
"ActiveMainsId": {
"description": "The mains circuit that is switched on and qualified to supply power to the output circuit.",
"longDescription": "This property shall contain the mains circuit that is switched on and qualified to supply power to the output circuit. The value shall be a string that matches the Id property value of a circuit contained in the collection referenced by the Mains property.",
"readonly": false,
"type": [
"string",
"null"
]
},
"AutoTransferEnabled": {
"description": "Indicates if the qualified alternate mains circuit is automatically switched on when the preferred mains circuit becomes unqualified and is automatically switched off.",
"longDescription": "This property shall indicate if the qualified alternate mains circuit is automatically switched on when the preferred mains circuit becomes unqualified and is automatically switched off.",
"readonly": false,
"type": [
"boolean",
"null"
]
},
"ClosedTransitionAllowed": {
"description": "Indicates if a make-before-break switching sequence of the mains circuits is permitted when they are both qualified and in synchronization.",
"longDescription": "This property shall indicate if a make-before-break switching sequence of the mains circuits is permitted when they are both qualified and in synchronization.",
"readonly": false,
"type": [
"boolean",
"null"
]
},
"ClosedTransitionTimeoutSeconds": {
"description": "The time in seconds to wait for a closed transition to occur.",
"longDescription": "This property shall contain the time in seconds to wait for a closed transition to occur.",
"readonly": false,
"type": [
"integer",
"null"
]
},
"PreferredMainsId": {
"description": "The preferred source for the mains circuit to this equipment.",
"longDescription": "This property shall contain the preferred source for mains circuit to this equipment. The value shall be a string that matches the Id property value of a circuit contained in the collection referenced by the Mains property.",
"readonly": false,
"type": [
"string",
"null"
]
},
"RetransferDelaySeconds": {
"description": "The time in seconds to delay the automatic transfer from the alternate mains circuit back to the preferred mains circuit.",
"longDescription": "This property shall contain the time in seconds to delay the automatic transfer from the alternate mains circuit back to the preferred mains circuit.",
"readonly": false,
"type": [
"integer",
"null"
]
},
"RetransferEnabled": {
"description": "Indicates if the automatic transfer is permitted from the alternate mains circuit back to the preferred mains circuit after the preferred mains circuit is qualified again and the Retransfer Delay time has expired.",
"longDescription": "This property shall indicate if the automatic transfer is permitted from the alternate mains circuit back to the preferred mains circuit after the preferred mains circuit is qualified again and the RetransferDelaySeconds time has expired.",
"readonly": false,
"type": [
"boolean",
"null"
]
},
"TransferDelaySeconds": {
"description": "The time in seconds to delay the automatic transfer from the preferred mains circuit to the alternate mains circuit when the preferred mains circuit is disqualified.",
"longDescription": "This property shall contain the time in seconds to delay the automatic transfer from the preferred mains circuit to the alternate mains circuit when the preferred mains circuit is disqualified. A value of zero shall mean it transfers as fast as possible.",
"readonly": false,
"type": [
"integer",
"null"
]
},
"TransferInhibit": {
"description": "Indicates if any transfer is inhibited.",
"longDescription": "This property shall indicate if any transfer is inhibited.",
"readonly": false,
"type": [
"boolean",
"null"
]
}
},
"type": "object"
},
"TransferControl": {
"additionalProperties": false,
"description": "This action transfers control to the alternative input circuit.",
"longDescription": "This action shall transfer power input from the existing mains circuit to the alternative mains circuit.",
"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"
},
"TransferCriteria": {
"additionalProperties": false,
"description": "The criteria used to initiate a transfer for an automatic transfer switch.",
"longDescription": "This type shall contain the criteria for initiating a transfer within an automatic transfer switch function 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": {
"OverNominalFrequencyHz": {
"description": "The frequency in Hertz over the nominal value that satisfies a criterion for transfer.",
"longDescription": "This property shall contain the frequency in Hertz over the nominal value that satisfies a criterion for transfer.",
"readonly": false,
"type": [
"number",
"null"
],
"units": "Hz"
},
"OverVoltageRMSPercentage": {
"description": "The positive percentage of voltage RMS over the nominal value that satisfies a criterion for transfer.",
"longDescription": "This property shall contain the positive percentage of voltage RMS over the nominal value that satisfies a criterion for transfer.",
"readonly": false,
"type": [
"number",
"null"
],
"units": "%"
},
"TransferSensitivity": {
"anyOf": [
{
"$ref": "#/definitions/TransferSensitivityType"
},
{
"type": "null"
}
],
"description": "The sensitivity to voltage waveform quality to satisfy the criterion for initiating a transfer.",
"longDescription": "This property shall contain the setting that adjusts the analytical sensitivity of the detection of the quality of voltage waveform that satisfies a criterion for transfer.",
"readonly": false
},
"UnderNominalFrequencyHz": {
"description": "The frequency in Hertz under the nominal value that satisfies a criterion for transfer.",
"longDescription": "This property shall contain the frequency in Hertz under the nominal value that satisfies a criterion for transfer.",
"readonly": false,
"type": [
"number",
"null"
],
"units": "Hz"
},
"UnderVoltageRMSPercentage": {
"description": "The negative percentage of voltage RMS under the nominal value that satisfies a criterion for transfer.",
"longDescription": "This property shall contain the negative percentage of voltage RMS under the nominal value that satisfies a criterion for transfer.",
"readonly": false,
"type": [
"number",
"null"
],
"units": "%"
}
},
"type": "object"
},
"TransferSensitivityType": {
"enum": [
"High",
"Medium",
"Low"
],
"enumDescriptions": {
"High": "High sensitivity for initiating a transfer.",
"Low": "Low sensitivity for initiating a transfer.",
"Medium": "Medium sensitivity for initiating a transfer."
},
"type": "string"
}
},
"owningEntity": "DMTF",
"release": "2019.4",
"title": "#PowerDistribution.v1_0_1.PowerDistribution"
}
|
