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
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
|
{
"$id": "http://redfish.dmtf.org/schemas/v1/ResourceBlock.v1_3_0.json",
"$ref": "#/definitions/ResourceBlock",
"$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
"copyright": "Copyright 2014-2018 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": {
"Oem": {
"$ref": "#/definitions/OemActions",
"description": "This property contains the available OEM specific actions for this resource.",
"longDescription": "This property shall contain any additional OEM actions for this resource."
}
},
"type": "object"
},
"CompositionState": {
"enum": [
"Composing",
"ComposedAndAvailable",
"Composed",
"Unused",
"Failed",
"Unavailable"
],
"enumDescriptions": {
"Composed": "Final successful state of a Resource Block which has participated in composition.",
"ComposedAndAvailable": "Indicates the Resource Block is currently participating in one or more compositions, and is available to be used in more compositions.",
"Composing": "Intermediate state indicating composition is in progress.",
"Failed": "The final composition resulted in failure and manual intervention may be required to fix it.",
"Unavailable": "Indicates the Resource Block has been made unavailable by the service, such as due to maintenance being performed on the Resource Block.",
"Unused": "Indicates the Resource Block is free and can participate in composition."
},
"enumVersionAdded": {
"ComposedAndAvailable": "v1_1_0",
"Unavailable": "v1_2_0"
},
"type": "string"
},
"CompositionStatus": {
"additionalProperties": false,
"description": "Composition status of the Resource Block.",
"longDescription": "This type shall contain properties that describe the high level composition status of the Resource Block.",
"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": {
"CompositionState": {
"anyOf": [
{
"$ref": "#/definitions/CompositionState"
},
{
"type": "null"
}
],
"description": "This property represents the current state of the Resource Block from a composition perspective.",
"longDescription": "The value of this property shall be an enumerated value describing composition state of the Resource Block.",
"readonly": true
},
"MaxCompositions": {
"description": "The maximum number of compositions in which this Resource Block is capable of participating simultaneously.",
"longDescription": "The value of this property shall be a number indicating the maximum number of compositions in which this Resource Block is capable of participating simultaneously. Services may have additional constraints that prevent this value from being achieved, such as due to system topology and current composed resource utilization. If SharingCapable is set to false, this value shall be set to 1. The service shall support this property if SharingCapable supported.",
"minimum": 1,
"readonly": true,
"type": [
"integer",
"null"
],
"versionAdded": "v1_1_0"
},
"NumberOfCompositions": {
"description": "The number of compositions in which this Resource Block is currently participating.",
"longDescription": "The value of this property shall be the number of compositions in which this Resource Block is currently participating.",
"minimum": 0,
"readonly": true,
"type": [
"integer",
"null"
],
"versionAdded": "v1_1_0"
},
"Reserved": {
"description": "This represents if the Resource Block is reserved by any client.",
"longDescription": "This property shall be a boolean that is set by client once the Resource Block is identified to be composed. It shall provide multiple clients a way to negotiate its ownership. This will help clients to know if a Resource Block is reserved by other client.",
"readonly": false,
"type": [
"boolean",
"null"
]
},
"SharingCapable": {
"description": "Indicates if this Resource Block is capable of participating in multiple compositions simultaneously.",
"longDescription": "The value of this property shall be a boolean indicating whether this Resource Block is capable of participating in multiple compositions simultaneously. If this property is not provided, it shall be assumed that this Resource Block is not capable of being shared.",
"readonly": true,
"type": [
"boolean",
"null"
],
"versionAdded": "v1_1_0"
},
"SharingEnabled": {
"description": "Indicates if this Resource Block is allowed to participate in multiple compositions simultaneously.",
"longDescription": "The value of this property shall be a boolean indicating whether this Resource Block is allowed to participate in multiple compositions simultaneously. The service shall reject modifications of this property with HTTP 400 Bad Request if this Resource Block already being used as part of a composed resource. If this property is set to false, the service shall not use the ComposedAndAvailable state for this Resource Block.",
"readonly": false,
"type": [
"boolean",
"null"
],
"versionAdded": "v1_1_0"
}
},
"required": [
"CompositionState"
],
"type": "object"
},
"Links": {
"additionalProperties": false,
"description": "Contains references to other resources that are related to this resource.",
"longDescription": "This type, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (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 references to the Chassis in which this Resource Block is contained.",
"items": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Chassis.json#/definitions/Chassis"
},
"longDescription": "The value of this property shall be an array of references of type Chassis that represent the physical container associated with this Resource Block.",
"readonly": true,
"type": "array"
},
"Chassis@odata.count": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count"
},
"ComputerSystems": {
"description": "An array of references to the Computer Systems that are composed from this Resource Block.",
"items": {
"$ref": "http://redfish.dmtf.org/schemas/v1/ComputerSystem.json#/definitions/ComputerSystem"
},
"longDescription": "The value of this property shall be an array of references of type ComputerSystem that represent the Computer Systems composed from this Resource Block.",
"readonly": true,
"type": "array"
},
"ComputerSystems@odata.count": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count"
},
"Oem": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
"description": "Oem extension object.",
"longDescription": "This object represents the Oem property. All values for resources described by this schema shall comply to the requirements as described in the Redfish specification."
},
"Zones": {
"description": "An array of references to the Zones in which this Resource Block is bound.",
"items": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Zone.json#/definitions/Zone"
},
"longDescription": "The value of this property shall be an array of references of type Zone that represent the binding constraints associated with this Resource Block.",
"readonly": true,
"type": "array"
},
"Zones@odata.count": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count"
}
},
"type": "object"
},
"OemActions": {
"additionalProperties": true,
"description": "The available OEM specific actions for this resource.",
"longDescription": "This type shall contain any additional OEM 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"
},
"ResourceBlock": {
"additionalProperties": false,
"description": "This schema defines a Resource Block resource.",
"longDescription": "This resource shall be used to represent a Resource Block 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_0_3.json#/definitions/context"
},
"@odata.etag": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag"
},
"@odata.id": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id"
},
"@odata.type": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/type"
},
"Actions": {
"$ref": "#/definitions/Actions",
"description": "The available actions for this resource.",
"longDescription": "The Actions property shall contain the available actions for this resource."
},
"CompositionStatus": {
"$ref": "#/definitions/CompositionStatus",
"description": "This property describes the composition status details for this Resource Block.",
"longDescription": "The value of this property shall contain composition status information about this Resource Block."
},
"ComputerSystems": {
"description": "An array of references to the Computer Systems available in this Resource Block.",
"items": {
"$ref": "http://redfish.dmtf.org/schemas/v1/ComputerSystem.json#/definitions/ComputerSystem"
},
"longDescription": "The value of this property shall be an array of references of type ComputerSystem that are in this Resource Block.",
"readonly": true,
"type": "array"
},
"ComputerSystems@odata.count": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count"
},
"Description": {
"anyOf": [
{
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
},
{
"type": "null"
}
],
"readonly": true
},
"Drives": {
"description": "An array of references to the Drives available in this Resource Block.",
"items": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Drive.json#/definitions/Drive"
},
"longDescription": "The value of this property shall be an array of references of type Drive that are in this Resource Block.",
"readonly": true,
"type": "array",
"versionAdded": "v1_3_0"
},
"Drives@odata.count": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count"
},
"EthernetInterfaces": {
"description": "An array of references to the Ethernet Interfaces available in this Resource Block.",
"items": {
"$ref": "http://redfish.dmtf.org/schemas/v1/EthernetInterface.json#/definitions/EthernetInterface"
},
"longDescription": "The value of this property shall be an array of references of type EthernetInterface that are in this Resource Block.",
"readonly": true,
"type": "array"
},
"EthernetInterfaces@odata.count": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count"
},
"Id": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
"readonly": true
},
"Links": {
"$ref": "#/definitions/Links",
"description": "Contains references to other resources that are related to this resource.",
"longDescription": "The Links property, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource."
},
"Memory": {
"description": "An array of references to the Memory available in this Resource Block.",
"items": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Memory.json#/definitions/Memory"
},
"longDescription": "The value of this property shall be an array of references of type Memory that are in this Resource Block.",
"readonly": true,
"type": "array"
},
"Memory@odata.count": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count"
},
"Name": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
"readonly": true
},
"NetworkInterfaces": {
"description": "An array of references to the Network Interfaces available in this Resource Block.",
"items": {
"$ref": "http://redfish.dmtf.org/schemas/v1/NetworkInterface.json#/definitions/NetworkInterface"
},
"longDescription": "The value of this property shall be an array of references of type NetworkInterface that are in this Resource Block.",
"readonly": true,
"type": "array"
},
"NetworkInterfaces@odata.count": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count"
},
"Oem": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
"description": "This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections.",
"longDescription": "The value of this string shall be of the format for the reserved word *Oem*."
},
"Processors": {
"description": "An array of references to the Processors available in this Resource Block.",
"items": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Processor.json#/definitions/Processor"
},
"longDescription": "The value of this property shall be an array of references of type Processor that are in this Resource Block.",
"readonly": true,
"type": "array"
},
"Processors@odata.count": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count"
},
"ResourceBlockType": {
"description": "This property represents the types of resources available on this Resource Block.",
"items": {
"$ref": "#/definitions/ResourceBlockType"
},
"longDescription": "The value of this property shall be an array of enumerated values describing type of resources available.",
"readonly": true,
"type": "array"
},
"SimpleStorage": {
"description": "An array of references to the Simple Storage available in this Resource Block.",
"items": {
"$ref": "http://redfish.dmtf.org/schemas/v1/SimpleStorage.json#/definitions/SimpleStorage"
},
"longDescription": "The value of this property shall be an array of references of type SimpleStorage that are in this Resource Block.",
"readonly": true,
"type": "array"
},
"SimpleStorage@odata.count": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count"
},
"Status": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status",
"description": "This property describes the status and health of the resource and its children.",
"longDescription": "This property shall contain any status or health properties of the resource."
},
"Storage": {
"description": "An array of references to the Storage available in this Resource Block.",
"items": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Storage.json#/definitions/Storage"
},
"longDescription": "The value of this property shall be an array of references of type Storage that are in this Resource Block.",
"readonly": true,
"type": "array"
},
"Storage@odata.count": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count"
}
},
"required": [
"CompositionStatus",
"ResourceBlockType",
"@odata.id",
"@odata.type",
"Id",
"Name"
],
"type": "object"
},
"ResourceBlockLimits": {
"additionalProperties": false,
"description": "This object specifies the allowable quantities of types of Resource Blocks for a given composition request.",
"longDescription": "This object shall specify the allowable quantities of types of Resource Blocks for a given composition request.",
"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": {
"MaxCompute": {
"description": "The minimum number of Resource Blocks of type Compute required for the composition request.",
"longDescription": "The value of this property shall be an integer that specifies the minimum number of Resource Blocks of type Compute required for the composition request.",
"minimum": 1,
"readonly": true,
"type": [
"integer",
"null"
],
"versionAdded": "v1_3_0"
},
"MaxComputerSystem": {
"description": "The minimum number of Resource Blocks of type ComputerSystem required for the composition request.",
"longDescription": "The value of this property shall be an integer that specifies the minimum number of Resource Blocks of type Network required for the composition request.",
"minimum": 1,
"readonly": true,
"type": [
"integer",
"null"
],
"versionAdded": "v1_3_0"
},
"MaxExpansion": {
"description": "The minimum number of Resource Blocks of type Expansion required for the composition request.",
"longDescription": "The value of this property shall be an integer that specifies the minimum number of Resource Blocks of type Expansion required for the composition request.",
"minimum": 1,
"readonly": true,
"type": [
"integer",
"null"
],
"versionAdded": "v1_3_0"
},
"MaxMemory": {
"description": "The minimum number of Resource Blocks of type Memory required for the composition request.",
"longDescription": "The value of this property shall be an integer that specifies the minimum number of Resource Blocks of type Memory required for the composition request.",
"minimum": 1,
"readonly": true,
"type": [
"integer",
"null"
],
"versionAdded": "v1_3_0"
},
"MaxNetwork": {
"description": "The minimum number of Resource Blocks of type Network required for the composition request.",
"longDescription": "The value of this property shall be an integer that specifies the minimum number of Resource Blocks of type Network required for the composition request.",
"minimum": 1,
"readonly": true,
"type": [
"integer",
"null"
],
"versionAdded": "v1_3_0"
},
"MaxProcessor": {
"description": "The minimum number of Resource Blocks of type Processor required for the composition request.",
"longDescription": "The value of this property shall be an integer that specifies the minimum number of Resource Blocks of type Processor required for the composition request.",
"minimum": 1,
"readonly": true,
"type": [
"integer",
"null"
],
"versionAdded": "v1_3_0"
},
"MaxStorage": {
"description": "The minimum number of Resource Blocks of type Storage required for the composition request.",
"longDescription": "The value of this property shall be an integer that specifies the minimum number of Resource Blocks of type Storage required for the composition request.",
"minimum": 1,
"readonly": true,
"type": [
"integer",
"null"
],
"versionAdded": "v1_3_0"
},
"MinCompute": {
"description": "The minimum number of Resource Blocks of type Compute required for the composition request.",
"longDescription": "The value of this property shall be an integer that specifies the minimum number of Resource Blocks of type Compute required for the composition request.",
"minimum": 0,
"readonly": true,
"type": [
"integer",
"null"
],
"versionAdded": "v1_3_0"
},
"MinComputerSystem": {
"description": "The minimum number of Resource Blocks of type ComputerSystem required for the composition request.",
"longDescription": "The value of this property shall be an integer that specifies the minimum number of Resource Blocks of type Network required for the composition request.",
"minimum": 0,
"readonly": true,
"type": [
"integer",
"null"
],
"versionAdded": "v1_3_0"
},
"MinExpansion": {
"description": "The minimum number of Resource Blocks of type Expansion required for the composition request.",
"longDescription": "The value of this property shall be an integer that specifies the minimum number of Resource Blocks of type Expansion required for the composition request.",
"minimum": 0,
"readonly": true,
"type": [
"integer",
"null"
],
"versionAdded": "v1_3_0"
},
"MinMemory": {
"description": "The minimum number of Resource Blocks of type Memory required for the composition request.",
"longDescription": "The value of this property shall be an integer that specifies the minimum number of Resource Blocks of type Memory required for the composition request.",
"minimum": 0,
"readonly": true,
"type": [
"integer",
"null"
],
"versionAdded": "v1_3_0"
},
"MinNetwork": {
"description": "The minimum number of Resource Blocks of type Network required for the composition request.",
"longDescription": "The value of this property shall be an integer that specifies the minimum number of Resource Blocks of type Network required for the composition request.",
"minimum": 0,
"readonly": true,
"type": [
"integer",
"null"
],
"versionAdded": "v1_3_0"
},
"MinProcessor": {
"description": "The minimum number of Resource Blocks of type Processor required for the composition request.",
"longDescription": "The value of this property shall be an integer that specifies the minimum number of Resource Blocks of type Processor required for the composition request.",
"minimum": 0,
"readonly": true,
"type": [
"integer",
"null"
],
"versionAdded": "v1_3_0"
},
"MinStorage": {
"description": "The minimum number of Resource Blocks of type Storage required for the composition request.",
"longDescription": "The value of this property shall be an integer that specifies the minimum number of Resource Blocks of type Storage required for the composition request.",
"minimum": 0,
"readonly": true,
"type": [
"integer",
"null"
],
"versionAdded": "v1_3_0"
}
},
"type": "object"
},
"ResourceBlockType": {
"enum": [
"Compute",
"Processor",
"Memory",
"Network",
"Storage",
"ComputerSystem",
"Expansion"
],
"enumDescriptions": {
"Compute": "This Resource Block contains both Processor and Memory resources in a manner that creates a compute complex.",
"ComputerSystem": "This Resource Block contains ComputerSystem resources.",
"Expansion": "This Resource Block is capable of changing over time based on its configuration. Different types of devices within this Resource Block can be added and removed over time.",
"Memory": "This Resource Block contains Memory resources.",
"Network": "This Resource Block contains Network resources, such as Ethernet Interfaces.",
"Processor": "This Resource Block contains Processor resources.",
"Storage": "This Resource Block contains Storage resources, such as Storage and Simple Storage."
},
"enumVersionAdded": {
"Expansion": "v1_2_0"
},
"type": "string"
}
},
"owningEntity": "DMTF",
"release": "2018.3",
"title": "#ResourceBlock.v1_3_0.ResourceBlock"
}
|
