Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / bmcweb / 118b1c7102e942ace53dac9f92a954864462eebe / . / static / redfish / v1 / JsonSchemas / Resource / Resource.json
blob: 45064cbccafaee5399e18734b7cb8ccfaa212ff3 [file] [log] [blame]
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame^]1{
2 "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema.v1_3_0.json",
3 "copyright": "Copyright 2014-2017 Distributed Management Task Force, Inc. (DMTF). For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright",
4 "definitions": {
5 "DurableNameFormat": {
6 "enum": [
7 "NAA",
8 "iQN",
9 "FC_WWN",
10 "UUID",
11 "EUI",
12 "NQN",
13 "NSID"
14 ],
15 "enumDescriptions": {
16 "EUI": "IEEE-defined 64-bit Extended Unique Identifier.",
17 "FC_WWN": "Fibre Channel World Wide Name.",
18 "NAA": "Name Address Authority Format.",
19 "NQN": "NVMe Qualified Name.",
20 "NSID": "NVM Namespace Identifier.",
21 "UUID": "Universally Unique Identifier.",
22 "iQN": "iSCSI Qualified Name."
23 },
24 "enumLongDescriptions": {
25 "EUI": "This durable name shall be the hexadecimal representation of the IEEE-defined 64-bit Extended Unique Identifier as defined in the IEEE's Guidelines for 64-bit Global Identifier (EUI-64) Specification.",
26 "FC_WWN": "This durable name shall be a hexadecimal representation of the World Wide Name format as defined in the T11 Fibre Channel Physical and Signaling Interface Specification.",
27 "NAA": "This durable name shall be a hexadecimal representation of the Name Address Authority structure as defined in the T11 Fibre Channel - Framing and Signaling - 3 (FC-FS-3) specification.",
28 "NQN": "This durable name shall be in the NVMe Qualified Name format as defined in the NVN Express over Fabric Specification.",
29 "NSID": "This durable name shall be in the NVM Namespace Identifier format as defined in the NVN Express Specification.",
30 "UUID": "This durable name shall be the hexadecimal representation of the Universal Unique Identifier as defined in the Internation Telecom Union's OSI networking and system aspects - Naming, Addressing and Registration Specification.",
31 "iQN": "This durable name shall be in the iSCSI Qualified Name format as defined in RFC 3720 and RFC 3721."
32 },
33 "type": "string"
34 },
35 "Identifier": {
36 "additionalProperties": false,
37 "description": "This type describes any additional identifiers for a resource.",
38 "longDescription": "This type shall contain any additional identifiers of a resource.",
39 "patternProperties": {
40 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
41 "description": "This property shall specify a valid odata or Redfish property.",
42 "type": [
43 "array",
44 "boolean",
45 "number",
46 "null",
47 "object",
48 "string"
49 ]
50 }
51 },
52 "properties": {
53 "DurableName": {
54 "description": "This indicates the world wide, persistent name of the resource.",
55 "longDescription": "This property shall contain the world wide unique identifier for the resource. The string shall be in the format described by the value of the Identifier.DurableNameFormat property.",
56 "readonly": true,
57 "type": [
58 "string",
59 "null"
60 ]
61 },
62 "DurableNameFormat": {
63 "anyOf": [
64 {
65 "$ref": "#/definitions/DurableNameFormat"
66 },
67 {
68 "type": "null"
69 }
70 ],
71 "description": "This represents the format of the DurableName property.",
72 "longDescription": "This property shall represent the format of the DurableName property.",
73 "readonly": true
74 }
75 },
76 "type": "object"
77 },
78 "IndicatorLED": {
79 "deprecated": "This definition has been moved to the unversioned namespace so that external references can pick up changes over time.",
80 "enum": [
81 "Lit",
82 "Blinking",
83 "Off"
84 ],
85 "enumDescriptions": {
86 "Blinking": "The Indicator LED is blinking.",
87 "Lit": "The Indicator LED is lit.",
88 "Off": "The Indicator LED is off."
89 },
90 "enumLongDescriptions": {
91 "Blinking": "This value shall represent the Indicator LED is in a blinking state where the LED is being turned on and off in repetition. If this value is not supported by the service, the service shall reject PATCH or PUT requests containing this value by returning HTTP 400 (Bad Request).",
92 "Lit": "This value shall represent the Indicator LED is in a solid on state. If this value is not supported by the service, the service shall reject PATCH or PUT requests containing this value by returning HTTP 400 (Bad Request).",
93 "Off": "This value shall represent the Indicator LED is in a solid off state. If this value is not supported by the service, the service shall reject PATCH or PUT requests containing this value by returning HTTP 400 (Bad Request)."
94 },
95 "type": "string"
96 },
97 "Location": {
98 "additionalProperties": false,
99 "description": "This type describes the location of a resource.",
100 "longDescription": "This type shall describe the location of a resource.",
101 "patternProperties": {
102 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
103 "description": "This property shall specify a valid odata or Redfish property.",
104 "type": [
105 "array",
106 "boolean",
107 "number",
108 "null",
109 "object",
110 "string"
111 ]
112 }
113 },
114 "properties": {
115 "AltitudeMeters": {
116 "description": "The altitude of the resource in meters.",
117 "longDescription": "The altitude of the resource in meters.",
118 "readonly": true,
119 "type": [
120 "number",
121 "null"
122 ],
123 "units": "m"
124 },
125 "Info": {
126 "deprecated": "This property has been Deprecated in favor of new properties defined in Resource.v1_3_0.Location and Resource.v1_5_0.Location.",
127 "description": "This indicates the location of the resource.",
128 "longDescription": "This property shall represent the location of the resource.",
129 "readonly": true,
130 "type": [
131 "string",
132 "null"
133 ]
134 },
135 "InfoFormat": {
136 "deprecated": "This property has been Deprecated in favor of new properties defined in Resource.v1_3_0.Location and Resource.v1_5_0.Location.",
137 "description": "This represents the format of the Info property.",
138 "longDescription": "This property shall represent the format of the Info property.",
139 "readonly": true,
140 "type": [
141 "string",
142 "null"
143 ]
144 },
145 "Latitude": {
146 "description": "The latitude resource.",
147 "longDescription": "The value shall be the latitude of the resource specified in degrees using a decimal format and not minutes or seconds.",
148 "readonly": true,
149 "type": [
150 "number",
151 "null"
152 ],
153 "units": "deg"
154 },
155 "Longitude": {
156 "description": "The longitude resource in degrees.",
157 "longDescription": "The value shall be the longitude of the resource specified in degrees using a decimal format and not minutes or seconds.",
158 "readonly": true,
159 "type": [
160 "number",
161 "null"
162 ],
163 "units": "deg"
164 },
165 "Oem": {
166 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem"
167 },
168 "PartLocation": {
169 "anyOf": [
170 {
171 "$ref": "#/definitions/PartLocation"
172 },
173 {
174 "type": "null"
175 }
176 ],
177 "description": "Postal address of the addressed resource.",
178 "longDescription": "The value shall be a postal address of the resource."
179 },
180 "Placement": {
181 "anyOf": [
182 {
183 "$ref": "#/definitions/Placement"
184 },
185 {
186 "type": "null"
187 }
188 ],
189 "description": "A place within the addressed location.",
190 "longDescription": "The value shall be a place within the addressed location."
191 },
192 "PostalAddress": {
193 "anyOf": [
194 {
195 "$ref": "#/definitions/PostalAddress"
196 },
197 {
198 "type": "null"
199 }
200 ],
201 "description": "Postal address of the addressed resource.",
202 "longDescription": "The value shall be a postal address of the resource."
203 }
204 },
205 "type": "object"
206 },
207 "LocationType": {
208 "description": "Defines the location types for PartLocation.",
209 "enum": [
210 "Slot",
211 "Bay",
212 "Connector",
213 "Socket"
214 ],
215 "enumDescriptions": {
216 "Bay": "Defines a bay as the type of location.",
217 "Connector": "Defines a connector as the type of location.",
218 "Slot": "Defines a slot as the type of location.",
219 "Socket": "Defines a socket as the type of location."
220 },
221 "enumLongDescriptions": {
222 "Bay": "Bay shall be used to indicate the type of PartLocation is of type bay.",
223 "Connector": "Connector shall be used to indicate the type of PartLocation is of type connector.",
224 "Slot": "Slot shall be used to indicate the type of PartLocation is of type slot.",
225 "Socket": "Socket shall be used to indicate the type of PartLocation is of type socket."
226 },
227 "longDescription": "Enumeration literals shall name the type of location in use.",
228 "type": "string"
229 },
230 "Orientation": {
231 "description": "Defines a orientation for the ordering of the ordinal value of the part location.",
232 "enum": [
233 "FrontToBack",
234 "BackToFront",
235 "TopToBottom",
236 "BottomToTop",
237 "LeftToRight",
238 "RightToLeft"
239 ],
240 "enumDescriptions": {
241 "BackToFront": "Defines the ordering for the LocationOrdinalValue is back to front.",
242 "BottomToTop": "Defines the ordering for the LocationOrdinalValue is bottom to top.",
243 "FrontToBack": "Defines the ordering for the LocationOrdinalValue is front to back.",
244 "LeftToRight": "Defines the ordering for the LocationOrdinalValue is left to right.",
245 "RightToLeft": "Defines the ordering for the LocationOrdinalValue is right to left.",
246 "TopToBottom": "Defines the ordering for the LocationOrdinalValue is top to bottom."
247 },
248 "enumLongDescriptions": {
249 "BackToFront": "This value shall be used to specify the ordering for LocationOrdinalValue is back to front.",
250 "BottomToTop": "This value shall be used to specify the ordering for LocationOrdinalValue is bottom to top.",
251 "FrontToBack": "This value shall be used to specify the ordering for LocationOrdinalValue is front to back.",
252 "LeftToRight": "This value shall be used to specify the ordering for LocationOrdinalValue is left to right.",
253 "RightToLeft": "This value shall be used to specify the ordering for LocationOrdinalValue is right to left.",
254 "TopToBottom": "This value shall be used to specify the ordering for LocationOrdinalValue is top to bottom."
255 },
256 "longDescription": "Enumeration literals shall name the orientation for the location type ordering in determining the LocationOrdinalValue.",
257 "type": "string"
258 },
259 "PartLocation": {
260 "additionalProperties": false,
261 "description": "The part location within the placement.",
262 "longDescription": "The value shall describe a location within a resource. This representation shall be used to indicate the location within the Placement.",
263 "patternProperties": {
264 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
265 "description": "This property shall specify a valid odata or Redfish property.",
266 "type": [
267 "array",
268 "boolean",
269 "number",
270 "null",
271 "object",
272 "string"
273 ]
274 }
275 },
276 "properties": {
277 "LocationOrdinalValue": {
278 "description": "The number that represents the location of the part. If LocationType is slot and this unit is in slot 2 then the LocationOrdinalValue will be 2.",
279 "longDescription": "The value shall be the number that represents the location of the part based on the LocationType. LocationOrdinalValue shall be measured based on the Orientation value starting with 0.",
280 "readonly": true,
281 "type": [
282 "number",
283 "null"
284 ]
285 },
286 "LocationType": {
287 "anyOf": [
288 {
289 "$ref": "#/definitions/LocationType"
290 },
291 {
292 "type": "null"
293 }
294 ],
295 "description": "The type of location of the part, such as slot, bay, socket and slot.",
296 "longDescription": "The value shall be a LocationType enumeration literal indicating the type of rack units in use.",
297 "readonly": true
298 },
299 "Orientation": {
300 "anyOf": [
301 {
302 "$ref": "#/definitions/Orientation"
303 },
304 {
305 "type": "null"
306 }
307 ],
308 "description": "The orientation for the ordering of the slot enumeration used by the LocationOrdinalValue property.",
309 "longDescription": "The value shall be a Orientation enumeration literal indicating the orientation for the ordering used by the LocationOrdinalValue property.",
310 "readonly": true
311 },
312 "Reference": {
313 "anyOf": [
314 {
315 "$ref": "#/definitions/Reference"
316 },
317 {
318 "type": "null"
319 }
320 ],
321 "description": "The reference point for the part location. This is used to give guidance as to the general location of the part.",
322 "longDescription": "The value shall be a Reference enumeration literal indicating the general location within the unit of the part.",
323 "readonly": true
324 },
325 "ServiceLabel": {
326 "description": "This is the label of the part location, such as a silk screened name or a printed label.",
327 "longDescription": "The value shall be the label assigned for service at the part location.",
328 "readonly": true,
329 "type": [
330 "string",
331 "null"
332 ]
333 }
334 },
335 "type": "object"
336 },
337 "Placement": {
338 "additionalProperties": false,
339 "description": "The placement within the addressed location.",
340 "longDescription": "The value shall describe a location within a resource. Examples include a shelf in a rack.",
341 "patternProperties": {
342 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
343 "description": "This property shall specify a valid odata or Redfish property.",
344 "type": [
345 "array",
346 "boolean",
347 "number",
348 "null",
349 "object",
350 "string"
351 ]
352 }
353 },
354 "properties": {
355 "Rack": {
356 "description": "Name of a rack location within a row.",
357 "longDescription": "The value shall be the name of the rack within a row.",
358 "readonly": false,
359 "type": [
360 "string",
361 "null"
362 ]
363 },
364 "RackOffset": {
365 "description": "Vertical location of the item in terms of RackOffsetUnits.",
366 "longDescription": "Vertical location of the item in the rack. Rack offset units shall be measured from bottom to top starting with 0.",
367 "readonly": false,
368 "type": [
369 "number",
370 "null"
371 ]
372 },
373 "RackOffsetUnits": {
374 "anyOf": [
375 {
376 "$ref": "#/definitions/RackUnits"
377 },
378 {
379 "type": "null"
380 }
381 ],
382 "description": "The type of Rack Units in use.",
383 "longDescription": "The value shall be a RackUnit enumeration literal indicating the type of rack units in use.",
384 "readonly": false
385 },
386 "Row": {
387 "description": "Name of row.",
388 "longDescription": "The value shall be the name of the row.",
389 "readonly": false,
390 "type": [
391 "string",
392 "null"
393 ]
394 }
395 },
396 "type": "object"
397 },
398 "PostalAddress": {
399 "additionalProperties": false,
400 "description": "The PostalAddress for a resource.",
401 "longDescription": "Instances shall describe a postal address for a resource. For more information see RFC5139. Depending on use, the instance may represent a past, current, or future location.",
402 "patternProperties": {
403 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
404 "description": "This property shall specify a valid odata or Redfish property.",
405 "type": [
406 "array",
407 "boolean",
408 "number",
409 "null",
410 "object",
411 "string"
412 ]
413 }
414 },
415 "properties": {
416 "AdditionalCode": {
417 "description": "Additional code.",
418 "longDescription": "The value shall conform the requirements of the ADDCODE field as defined in RFC5139.",
419 "readonly": false,
420 "type": [
421 "string",
422 "null"
423 ]
424 },
425 "Building": {
426 "description": "Name of the building.",
427 "longDescription": "The value shall conform the requirements of the BLD field as defined in RFC5139. The value shall be name a building used to locate the resource.",
428 "readonly": false,
429 "type": [
430 "string",
431 "null"
432 ]
433 },
434 "City": {
435 "description": "City, township, or shi (JP).",
436 "longDescription": "The value shall conform the requirements of the A3 field as defined in RFC5139. It is used to name a city, township, or shi (JP).",
437 "readonly": false,
438 "type": [
439 "string",
440 "null"
441 ]
442 },
443 "Community": {
444 "description": "Postal community name.",
445 "longDescription": "The value shall conform the requirements of the PCN field as defined in RFC5139. The value shall be a postal community name.",
446 "readonly": false,
447 "type": [
448 "string",
449 "null"
450 ]
451 },
452 "Country": {
453 "description": "Country.",
454 "longDescription": "The value shall conform the requirements of the Country field as defined in RFC5139.",
455 "readonly": false,
456 "type": [
457 "string",
458 "null"
459 ]
460 },
461 "District": {
462 "description": "A county, parish, gun (JP), or district (IN).",
463 "longDescription": "The value shall conform the requirements of the A2 field as defined in RFC5139. It is used to name a county, parish, gun (JP), or district (IN).",
464 "readonly": false,
465 "type": [
466 "string",
467 "null"
468 ]
469 },
470 "Division": {
471 "description": "City division, borough, dity district, ward, chou (JP).",
472 "longDescription": "The value shall conform the requirements of the A4 field as defined in RFC5139. It is used to name a city division, borough, dity district, ward, chou (JP).",
473 "readonly": false,
474 "type": [
475 "string",
476 "null"
477 ]
478 },
479 "Floor": {
480 "description": "Floor.",
481 "longDescription": "The value shall conform the requirements of the FLR field as defined in RFC5139. It is used to provide a floor designation.",
482 "readonly": false,
483 "type": [
484 "string",
485 "null"
486 ]
487 },
488 "GPSCoords": {
489 "deprecated": "This property has been Deprecated in favor of Location.v1_6_0.Longitude and Location.v1_6_0.Latitude",
490 "description": "The GPS coordinates of the part.",
491 "longDescription": "The value shall conform the requirements of the ADDCODE field as defined in RFC5139. The value shall be the GPS coordinates of the location. If furnished, this shall be expressed in the format '[-][nn]n.nnnnnn, [-][nn]n.nnnnn', i.e. two numbers, either positive or negative, with six decimal places of precision, comma-separated.",
492 "readonly": false,
493 "type": [
494 "string",
495 "null"
496 ]
497 },
498 "HouseNumber": {
499 "description": "Numeric portion of house number.",
500 "longDescription": "The value shall conform the requirements of the HNO field as defined in RFC5139. It is the numeric portion of the house number.",
501 "readonly": false,
502 "type": [
503 "number",
504 "null"
505 ]
506 },
507 "HouseNumberSuffix": {
508 "description": "House number suffix.",
509 "longDescription": "The value shall conform the requirements of the HNS field as defined in RFC5139. It is used to provide a suffix to a house number, (F, B, 1/2).",
510 "readonly": false,
511 "type": [
512 "string",
513 "null"
514 ]
515 },
516 "Landmark": {
517 "description": "Landmark.",
518 "longDescription": "The value shall conform the requirements of the LMK field as defined in RFC5139. It is used to identify a landmark or vanity address.",
519 "readonly": false,
520 "type": [
521 "string",
522 "null"
523 ]
524 },
525 "LeadingStreetDirection": {
526 "description": "A leading street direction.",
527 "longDescription": "The value shall conform the requirements of the PRD field as defined in RFC5139. It is used to name a leading street direction, (N, W, SE).",
528 "readonly": false,
529 "type": [
530 "string",
531 "null"
532 ]
533 },
534 "Location": {
535 "description": "Room designation or other additional info.",
536 "longDescription": "The value shall conform the requirements of the LOC field as defined in RFC5139. It is used to provide additional information.",
537 "readonly": false,
538 "type": [
539 "string",
540 "null"
541 ]
542 },
543 "Name": {
544 "description": "Name.",
545 "longDescription": "The value shall conform the requirements of the NAM field as defined in RFC5139. It is used to name the occupant.",
546 "readonly": false,
547 "type": [
548 "string",
549 "null"
550 ]
551 },
552 "Neighborhood": {
553 "description": "Neighborhood or block.",
554 "longDescription": "The value shall conform the requirements of the A5 field as defined in RFC5139. It is used to name a neighborhood or block.",
555 "readonly": false,
556 "type": [
557 "string",
558 "null"
559 ]
560 },
561 "POBox": {
562 "description": "Post office box (P.O. box).",
563 "longDescription": "The value shall conform the requirements of the POBOX field as defined in RFC5139. The value shall be a Post office box (P.O. box).",
564 "readonly": false,
565 "type": [
566 "string",
567 "null"
568 ]
569 },
570 "PlaceType": {
571 "description": "A description of the type of place that is addressed.",
572 "longDescription": "The value shall conform the requirements of the PLC field as defined in RFC5139. Examples include: office, residence,...).",
573 "readonly": false,
574 "type": [
575 "string",
576 "null"
577 ]
578 },
579 "PostalCode": {
580 "description": "Postal code (or zip code).",
581 "longDescription": "The value shall conform the requirements of the PC field as defined in RFC5139. The value shall be a Postal code (or zip code).",
582 "readonly": false,
583 "type": [
584 "string",
585 "null"
586 ]
587 },
588 "Road": {
589 "description": "A primary road or street.",
590 "longDescription": "The value shall conform the requirements of the RD field as defined in RFC5139. The value designates a primary road or street.",
591 "readonly": false,
592 "type": [
593 "string",
594 "null"
595 ]
596 },
597 "RoadBranch": {
598 "description": "Road branch.",
599 "longDescription": "The value shall conform the requirements of the RDBR field as defined in RFC5139. The value shall be a Post office box (P.O. box)road branch.",
600 "readonly": false,
601 "type": [
602 "string",
603 "null"
604 ]
605 },
606 "RoadPostModifier": {
607 "description": "Road post-modifier.",
608 "longDescription": "The value shall conform the requirements of the POM field as defined in RFC5139. (Extended).",
609 "readonly": false,
610 "type": [
611 "string",
612 "null"
613 ]
614 },
615 "RoadPreModifier": {
616 "description": "Road pre-modifier.",
617 "longDescription": "The value shall conform the requirements of the PRM field as defined in RFC5139. (Old, New).",
618 "readonly": false,
619 "type": [
620 "string",
621 "null"
622 ]
623 },
624 "RoadSection": {
625 "description": "Road Section.",
626 "longDescription": "The value shall conform the requirements of the RDSEC field as defined in RFC5139. The value shall be a road section.",
627 "readonly": false,
628 "type": [
629 "string",
630 "null"
631 ]
632 },
633 "RoadSubBranch": {
634 "description": "Road sub branch.",
635 "longDescription": "The value shall conform the requirements of the RDSUBBR field as defined in RFC5139.",
636 "readonly": false,
637 "type": [
638 "string",
639 "null"
640 ]
641 },
642 "Room": {
643 "description": "Name or number of the room.",
644 "longDescription": "The value shall conform the requirements of the ROOM field as defined in RFC5139. The value shall be a name or number of a room used to locate the resource within the unit.",
645 "readonly": false,
646 "type": [
647 "string",
648 "null"
649 ]
650 },
651 "Seat": {
652 "description": "Seat (desk, cubicle, workstation).",
653 "longDescription": "The value shall conform the requirements of the SEAT field as defined in RFC5139. The value shall be a name or number of a Seat (desk, cubicle, workstation).",
654 "readonly": false,
655 "type": [
656 "string",
657 "null"
658 ]
659 },
660 "Street": {
661 "description": "Street name.",
662 "longDescription": "The value shall conform the requirements of the A6 field as defined in RFC5139. It is used to name a street.",
663 "readonly": false,
664 "type": [
665 "string",
666 "null"
667 ]
668 },
669 "StreetSuffix": {
670 "description": "Avenue, Platz, Street, Circle.",
671 "longDescription": "The value shall conform the requirements of the STS field as defined in RFC5139. It is used to name a street suffix.",
672 "readonly": false,
673 "type": [
674 "string",
675 "null"
676 ]
677 },
678 "Territory": {
679 "description": "A top-level subdivision within a country.",
680 "longDescription": "The value shall conform the requirements of the A1 field as defined in RFC5139 when used to name a territory, state, region, province, or prefecture within a country.",
681 "readonly": false,
682 "type": [
683 "string",
684 "null"
685 ]
686 },
687 "TrailingStreetSuffix": {
688 "description": "A trailing street suffix.",
689 "longDescription": "The value shall conform the requirements of the POD field as defined in RFC5139. It is used to name a trailing street suffix.",
690 "readonly": false,
691 "type": [
692 "string",
693 "null"
694 ]
695 },
696 "Unit": {
697 "description": "Name or number of the unit (apartment, suite).",
698 "longDescription": "The value shall conform the requirements of the UNIT field as defined in RFC5139. The value shall be a name or number of a unit (apartment, suite) used to locate the resource.",
699 "readonly": false,
700 "type": [
701 "string",
702 "null"
703 ]
704 }
705 },
706 "type": "object"
707 },
708 "PowerState": {
709 "deprecated": "This definition has been moved to the unversioned namespace so that external references can pick up changes over time.",
710 "enum": [
711 "On",
712 "Off",
713 "PoweringOn",
714 "PoweringOff"
715 ],
716 "enumDescriptions": {
717 "Off": "The state is powered Off.",
718 "On": "The state is powered On.",
719 "PoweringOff": "A temporary state between On and Off.",
720 "PoweringOn": "A temporary state between Off and On."
721 },
722 "type": "string"
723 },
724 "RackUnits": {
725 "description": "Defines a rack unit.",
726 "enum": [
727 "OpenU",
728 "EIA_310"
729 ],
730 "enumDescriptions": {
731 "EIA_310": "Defines a rack unit as being equal to 1.75 in (44.45 mm).",
732 "OpenU": "Defines a rack unit as being equal to 48 mm (1.89 in)."
733 },
734 "enumLongDescriptions": {
735 "EIA_310": "Rack units shall be specified as defined by the EIA-310 standard.",
736 "OpenU": "Rack units shall be specifie3d in terms of the Open Compute Open Rack specification."
737 },
738 "longDescription": "Enumeration literals shall name the type of rack units in use.",
739 "type": "string"
740 },
741 "Reference": {
742 "description": "Defines a reference area for the location of the part.",
743 "enum": [
744 "Top",
745 "Bottom",
746 "Front",
747 "Rear",
748 "Left",
749 "Right",
750 "Middle"
751 ],
752 "enumDescriptions": {
753 "Bottom": "Defines the part as being in the bottom of the unit.",
754 "Front": "Defines the part as being in the front of the unit.",
755 "Left": "Defines the part as being in the left of the unit.",
756 "Middle": "Defines the part as being in the middle of the unit.",
757 "Rear": "Defines the part as being in the rear of the unit.",
758 "Right": "Defines the part as being in the right of the unit.",
759 "Top": "Defines the part as being in the top of the unit."
760 },
761 "enumLongDescriptions": {
762 "Bottom": "Top shall be used to specify the part location is in the bottom of the unit.",
763 "Front": "Top shall be used to specify the part location is in the front of the unit.",
764 "Left": "Top shall be used to specify the part location is in the left of the unit.",
765 "Middle": "Top shall be used to specify the part location is in the middle of the unit.",
766 "Rear": "Top shall be used to specify the part location is in the rear of the unit.",
767 "Right": "Top shall be used to specify the part location is in the right of the unit.",
768 "Top": "Top shall be used to specify the part location is in the top of the unit."
769 },
770 "longDescription": "Enumeration literals shall name the reference for the part location.",
771 "type": "string"
772 },
773 "ReferenceableMember": {
774 "additionalProperties": false,
775 "description": "This is the base type for addressable members of an array.",
776 "longDescription": "Array members can be referenced using the value returned in the @odata.id property which may or may not be a dereferenceable URL. The @odata.id of this entity shall be the location of this element within an Item.",
777 "patternProperties": {
778 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
779 "description": "This property shall specify a valid odata or Redfish property.",
780 "type": [
781 "array",
782 "boolean",
783 "number",
784 "null",
785 "object",
786 "string"
787 ]
788 }
789 },
790 "properties": {
791 "MemberId": {
792 "description": "This is the identifier for the member within the collection.",
793 "longDescription": "The value of this string shall uniquely identify the member within the collection.",
794 "readonly": true,
795 "type": "string"
796 },
797 "Oem": {
798 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
799 "description": "This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections.",
800 "longDescription": "The value of this string shall be of the format for the reserved word *Oem*."
801 }
802 },
803 "type": "object"
804 },
805 "Resource": {
806 "additionalProperties": false,
807 "description": "This is the base type for resources and referenceable members.",
808 "patternProperties": {
809 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
810 "description": "This property shall specify a valid odata or Redfish property.",
811 "type": [
812 "array",
813 "boolean",
814 "number",
815 "null",
816 "object",
817 "string"
818 ]
819 }
820 },
821 "properties": {
822 "@odata.context": {
823 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_1.json#/definitions/context"
824 },
825 "@odata.id": {
826 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_1.json#/definitions/id"
827 },
828 "@odata.type": {
829 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_1.json#/definitions/type"
830 },
831 "Description": {
832 "anyOf": [
833 {
834 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
835 },
836 {
837 "type": "null"
838 }
839 ],
840 "readonly": true
841 },
842 "Id": {
843 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
844 "readonly": true
845 },
846 "Name": {
847 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
848 "readonly": true
849 },
850 "Oem": {
851 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
852 "description": "This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections.",
853 "longDescription": "The value of this string shall be of the format for the reserved word *Oem*."
854 }
855 },
856 "required": [
857 "Id",
858 "Name"
859 ],
860 "type": "object"
861 },
862 "ResourceCollection": {
863 "additionalProperties": false,
864 "patternProperties": {
865 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
866 "description": "This property shall specify a valid odata or Redfish property.",
867 "type": [
868 "array",
869 "boolean",
870 "number",
871 "null",
872 "object",
873 "string"
874 ]
875 }
876 },
877 "properties": {
878 "@odata.context": {
879 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_1.json#/definitions/context"
880 },
881 "@odata.id": {
882 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_1.json#/definitions/id"
883 },
884 "@odata.type": {
885 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_1.json#/definitions/type"
886 },
887 "Description": {
888 "anyOf": [
889 {
890 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
891 },
892 {
893 "type": "null"
894 }
895 ],
896 "readonly": true
897 },
898 "Name": {
899 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
900 "readonly": true
901 },
902 "Oem": {
903 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
904 "description": "This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections.",
905 "longDescription": "The value of this string shall be of the format for the reserved word *Oem*."
906 }
907 },
908 "type": "object"
909 }
910 },
911 "title": "#Resource.v1_6_0"
912}