blob: 26388a2db0126e223c8eb73135aced4487549719 [file] [log] [blame]
Ed Tanous118b1c72018-09-13 13:45:51 -07001{
Ed Tanousa8d8f9d2023-01-26 13:57:00 -08002 "$id": "http://redfish.dmtf.org/schemas/v1/Resource.v1_15_0.json",
Ed Tanous530520e2019-01-02 13:41:37 -08003 "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
Ed Tanoused761212022-09-23 15:03:29 -07004 "copyright": "Copyright 2014-2022 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright",
Ed Tanous118b1c72018-09-13 13:45:51 -07005 "definitions": {
Ed Tanous530520e2019-01-02 13:41:37 -08006 "ContactInfo": {
7 "additionalProperties": false,
Gunnar Millsa778c022020-05-12 12:20:36 -05008 "description": "Contact information for this resource.",
9 "longDescription": "This object shall contain contact information for an individual or organization responsible for this resource.",
Ed Tanous530520e2019-01-02 13:41:37 -080010 "patternProperties": {
Ed Tanouscb103132019-10-08 11:34:22 -070011 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
Ed Tanous530520e2019-01-02 13:41:37 -080012 "description": "This property shall specify a valid odata or Redfish property.",
13 "type": [
14 "array",
15 "boolean",
16 "integer",
17 "number",
18 "null",
19 "object",
20 "string"
21 ]
22 }
23 },
24 "properties": {
25 "ContactName": {
26 "description": "Name of this contact.",
Gunnar Millsa778c022020-05-12 12:20:36 -050027 "longDescription": "This property shall contain the name of a person or organization to contact for information about this resource.",
Ed Tanous530520e2019-01-02 13:41:37 -080028 "readonly": false,
29 "type": [
30 "string",
31 "null"
Marri Devender Raod45d2d02019-01-21 10:11:34 -060032 ],
33 "versionAdded": "v1_7_0"
Ed Tanous530520e2019-01-02 13:41:37 -080034 },
35 "EmailAddress": {
36 "description": "Email address for this contact.",
Gunnar Millsa778c022020-05-12 12:20:36 -050037 "longDescription": "This property shall contain the email address for a person or organization to contact for information about this resource.",
Ed Tanous530520e2019-01-02 13:41:37 -080038 "readonly": false,
39 "type": [
40 "string",
41 "null"
Marri Devender Raod45d2d02019-01-21 10:11:34 -060042 ],
43 "versionAdded": "v1_7_0"
Ed Tanous530520e2019-01-02 13:41:37 -080044 },
45 "PhoneNumber": {
46 "description": "Phone number for this contact.",
Gunnar Millsa778c022020-05-12 12:20:36 -050047 "longDescription": "This property shall contain the phone number for a person or organization to contact for information about this resource.",
Ed Tanous530520e2019-01-02 13:41:37 -080048 "readonly": false,
49 "type": [
50 "string",
51 "null"
Marri Devender Raod45d2d02019-01-21 10:11:34 -060052 ],
53 "versionAdded": "v1_7_0"
Ed Tanous530520e2019-01-02 13:41:37 -080054 }
55 },
56 "type": "object"
57 },
Ed Tanous118b1c72018-09-13 13:45:51 -070058 "DurableNameFormat": {
59 "enum": [
60 "NAA",
61 "iQN",
62 "FC_WWN",
63 "UUID",
64 "EUI",
65 "NQN",
Asmitha Karunanithic8ccb772020-09-22 10:56:46 -050066 "NSID",
Sui Chen141d9432022-02-03 22:01:27 -080067 "NGUID",
Ed Tanousa8d8f9d2023-01-26 13:57:00 -080068 "MACAddress",
69 "GCXLID"
Ed Tanous118b1c72018-09-13 13:45:51 -070070 ],
Gunnar Mills10f270b2021-05-19 15:34:06 -050071 "enumDeprecated": {
72 "NSID": "This value has been deprecated due to its non-uniqueness and `NGUID` should be used."
73 },
Ed Tanous118b1c72018-09-13 13:45:51 -070074 "enumDescriptions": {
Ed Tanouscb103132019-10-08 11:34:22 -070075 "EUI": "The IEEE-defined 64-bit Extended Unique Identifier (EUI).",
76 "FC_WWN": "The Fibre Channel (FC) World Wide Name (WWN).",
Ed Tanousa8d8f9d2023-01-26 13:57:00 -080077 "GCXLID": "The globally unique CXL logical device identifier (GCXLID).",
Sui Chen141d9432022-02-03 22:01:27 -080078 "MACAddress": "The media access control address (MAC address).",
Ed Tanouscb103132019-10-08 11:34:22 -070079 "NAA": "The Name Address Authority (NAA) format.",
Asmitha Karunanithic8ccb772020-09-22 10:56:46 -050080 "NGUID": "The Namespace Globally Unique Identifier (NGUID).",
Ed Tanouscb103132019-10-08 11:34:22 -070081 "NQN": "The NVMe Qualified Name (NQN).",
82 "NSID": "The NVM Namespace Identifier (NSID).",
83 "UUID": "The Universally Unique Identifier (UUID).",
84 "iQN": "The iSCSI Qualified Name (iQN)."
Ed Tanous118b1c72018-09-13 13:45:51 -070085 },
86 "enumLongDescriptions": {
Ed Tanoused761212022-09-23 15:03:29 -070087 "EUI": "This durable name shall contain the hexadecimal representation of the IEEE-defined 64-bit Extended Unique Identifier (EUI), as defined in the IEEE's Guidelines for 64-bit Global Identifier (EUI-64) Specification. The DurableName property shall follow the regular expression pattern '^([0-9A-Fa-f]{2}[:-]){7}([0-9A-Fa-f]{2})$', where the most significant octet is first.",
88 "FC_WWN": "This durable name shall contain a hexadecimal representation of the World-Wide Name (WWN) format, as defined in the T11 Fibre Channel Physical and Signaling Interface Specification. The DurableName property shall follow the regular expression pattern '^([0-9A-Fa-f]{2}[:-]){7}([0-9A-Fa-f]{2})$', where the most significant octet is first.",
Ed Tanousa8d8f9d2023-01-26 13:57:00 -080089 "GCXLID": "This durable name shall be in the globally unique CXL logical device identifier (GCXLID). The DurableName property shall follow the regular expression pattern '^([0-9A-Fa-f]{2}-){7}[0-9A-Fa-f]{2}:([0-9A-Fa-f]{4})$', where the first eight hyphen-delimited octets contain the PCIe serial number, where the most significant octet is first, and the remaining 16-bit field contains the CXL Logical Device Identifier, where the most significant byte first.",
Ed Tanoused761212022-09-23 15:03:29 -070090 "MACAddress": "This durable name shall be a media access control address (MAC address), which is a unique identifier assigned to a network interface controller (NIC) for use as a network address. This value should not be used if a more specific type of identifier is available. The DurableName property shall follow the regular expression pattern '^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$', where the most significant octet is first.",
91 "NAA": "This durable name shall contain a hexadecimal representation of the Name Address Authority structure, as defined in the T11 Fibre Channel - Framing and Signaling - 3 (FC-FS-3) specification. The DurableName property shall follow the regular expression pattern '^(([0-9A-Fa-f]{2}){8}){1,2}$', where the most significant octet is first.",
92 "NGUID": "This durable name shall be in the Namespace Globally Unique Identifier (NGUID), as defined in the NVN Express Specification. The DurableName property shall follow the regular expression pattern '^([0-9A-Fa-f]{2}){16}$', where the most significant octet is first.",
Ed Tanouscb103132019-10-08 11:34:22 -070093 "NQN": "This durable name shall be in the NVMe Qualified Name (NQN) format, as defined in the NVN Express over Fabric Specification.",
94 "NSID": "This durable name shall be in the NVM Namespace Identifier (NSID) format, as defined in the NVN Express Specification.",
Ed Tanoused761212022-09-23 15:03:29 -070095 "UUID": "This durable name shall contain the hexadecimal representation of the UUID, as defined by RFC4122. The DurableName property shall follow the regular expression pattern '([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})'.",
Ed Tanouscb103132019-10-08 11:34:22 -070096 "iQN": "This durable name shall be in the iSCSI Qualified Name (iQN) format, as defined in RFC3720 and RFC3721."
Ed Tanous118b1c72018-09-13 13:45:51 -070097 },
Marri Devender Raod45d2d02019-01-21 10:11:34 -060098 "enumVersionAdded": {
Ed Tanousa8d8f9d2023-01-26 13:57:00 -080099 "GCXLID": "v1_15_0",
Sui Chen141d9432022-02-03 22:01:27 -0800100 "MACAddress": "v1_14_0",
Asmitha Karunanithic8ccb772020-09-22 10:56:46 -0500101 "NGUID": "v1_10_0",
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600102 "NQN": "v1_6_0",
103 "NSID": "v1_6_0"
Ed Tanous530520e2019-01-02 13:41:37 -0800104 },
Gunnar Mills10f270b2021-05-19 15:34:06 -0500105 "enumVersionDeprecated": {
106 "NSID": "v1_12_0"
107 },
Ed Tanous530520e2019-01-02 13:41:37 -0800108 "type": "string"
109 },
Ed Tanous118b1c72018-09-13 13:45:51 -0700110 "Identifier": {
111 "additionalProperties": false,
Gunnar Millsa778c022020-05-12 12:20:36 -0500112 "description": "Any additional identifiers for a resource.",
113 "longDescription": "This type shall contain any additional identifiers for a resource.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700114 "patternProperties": {
Ed Tanouscb103132019-10-08 11:34:22 -0700115 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
Ed Tanous118b1c72018-09-13 13:45:51 -0700116 "description": "This property shall specify a valid odata or Redfish property.",
117 "type": [
118 "array",
119 "boolean",
Ed Tanous530520e2019-01-02 13:41:37 -0800120 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -0700121 "number",
122 "null",
123 "object",
124 "string"
125 ]
126 }
127 },
128 "properties": {
129 "DurableName": {
Gunnar Millsa778c022020-05-12 12:20:36 -0500130 "description": "The world-wide, persistent name of the resource.",
131 "longDescription": "This property shall contain the world-wide unique identifier for the resource. The string shall be in the Identifier.DurableNameFormat property value format.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700132 "readonly": true,
133 "type": [
134 "string",
135 "null"
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600136 ],
137 "versionAdded": "v1_1_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700138 },
139 "DurableNameFormat": {
140 "anyOf": [
141 {
142 "$ref": "#/definitions/DurableNameFormat"
143 },
144 {
145 "type": "null"
146 }
147 ],
Ed Tanouscb103132019-10-08 11:34:22 -0700148 "description": "The format of the durable name property.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700149 "longDescription": "This property shall represent the format of the DurableName property.",
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600150 "readonly": true,
151 "versionAdded": "v1_1_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700152 }
153 },
154 "type": "object"
155 },
Ed Tanous118b1c72018-09-13 13:45:51 -0700156 "Location": {
157 "additionalProperties": false,
Gunnar Millsa778c022020-05-12 12:20:36 -0500158 "description": "The location of a resource.",
159 "longDescription": "This type shall describe the location of a resource.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700160 "patternProperties": {
Ed Tanouscb103132019-10-08 11:34:22 -0700161 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
Ed Tanous118b1c72018-09-13 13:45:51 -0700162 "description": "This property shall specify a valid odata or Redfish property.",
163 "type": [
164 "array",
165 "boolean",
Ed Tanous530520e2019-01-02 13:41:37 -0800166 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -0700167 "number",
168 "null",
169 "object",
170 "string"
171 ]
172 }
173 },
174 "properties": {
175 "AltitudeMeters": {
Gunnar Millsa778c022020-05-12 12:20:36 -0500176 "description": "The altitude of the resource in meters.",
Sui Chen141d9432022-02-03 22:01:27 -0800177 "longDescription": "This property shall contain the altitude of the resource, in meters units, defined as the elevation above sea level.",
Ed Tanous530520e2019-01-02 13:41:37 -0800178 "readonly": false,
Ed Tanous118b1c72018-09-13 13:45:51 -0700179 "type": [
180 "number",
181 "null"
182 ],
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600183 "units": "m",
184 "versionAdded": "v1_6_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700185 },
Ed Tanous530520e2019-01-02 13:41:37 -0800186 "Contacts": {
Ed Tanouscb103132019-10-08 11:34:22 -0700187 "description": "An array of contact information.",
Ed Tanous530520e2019-01-02 13:41:37 -0800188 "items": {
189 "anyOf": [
190 {
191 "$ref": "#/definitions/ContactInfo"
192 },
193 {
194 "type": "null"
195 }
196 ]
197 },
Gunnar Millsa778c022020-05-12 12:20:36 -0500198 "longDescription": "This property shall contain an array of contact information for an individual or organization responsible for this resource.",
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600199 "type": "array",
200 "versionAdded": "v1_7_0"
Ed Tanous530520e2019-01-02 13:41:37 -0800201 },
Ed Tanous118b1c72018-09-13 13:45:51 -0700202 "Info": {
Ed Tanouscb103132019-10-08 11:34:22 -0700203 "deprecated": "This property has been deprecated in favor of the PostalAddress, Placement, and PartLocation properties.",
Gunnar Millsa778c022020-05-12 12:20:36 -0500204 "description": "The location of the resource.",
205 "longDescription": "This property shall represent the location of the resource.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700206 "readonly": true,
207 "type": [
208 "string",
209 "null"
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600210 ],
Ed Tanouscb103132019-10-08 11:34:22 -0700211 "versionAdded": "v1_1_0",
212 "versionDeprecated": "v1_5_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700213 },
214 "InfoFormat": {
Ed Tanouscb103132019-10-08 11:34:22 -0700215 "deprecated": "This property has been deprecated in favor of the PostalAddress, Placement, and PartLocation properties.",
216 "description": "The format of the Info property.",
217 "longDescription": "This property shall represent the Info property format.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700218 "readonly": true,
219 "type": [
220 "string",
221 "null"
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600222 ],
Ed Tanouscb103132019-10-08 11:34:22 -0700223 "versionAdded": "v1_1_0",
224 "versionDeprecated": "v1_5_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700225 },
226 "Latitude": {
Gunnar Millsa778c022020-05-12 12:20:36 -0500227 "description": "The latitude of the resource.",
228 "longDescription": "This property shall contain the latitude of the resource specified in degrees using a decimal format and not minutes or seconds.",
Ed Tanous530520e2019-01-02 13:41:37 -0800229 "readonly": false,
Ed Tanous118b1c72018-09-13 13:45:51 -0700230 "type": [
231 "number",
232 "null"
233 ],
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600234 "units": "deg",
235 "versionAdded": "v1_6_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700236 },
237 "Longitude": {
Gunnar Millsa778c022020-05-12 12:20:36 -0500238 "description": "The longitude of the resource in degrees.",
239 "longDescription": "This property shall contain the longitude of the resource specified in degrees using a decimal format and not minutes or seconds.",
Ed Tanous530520e2019-01-02 13:41:37 -0800240 "readonly": false,
Ed Tanous118b1c72018-09-13 13:45:51 -0700241 "type": [
242 "number",
243 "null"
244 ],
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600245 "units": "deg",
246 "versionAdded": "v1_6_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700247 },
248 "Oem": {
Ed Tanous530520e2019-01-02 13:41:37 -0800249 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
Ed Tanouscb103132019-10-08 11:34:22 -0700250 "description": "The OEM extension property.",
251 "longDescription": "This property shall contain the OEM extensions. All values for properties contained in this object shall conform to the Redfish Specification-described requirements.",
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600252 "versionAdded": "v1_1_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700253 },
254 "PartLocation": {
Ed Tanouscb103132019-10-08 11:34:22 -0700255 "$ref": "#/definitions/PartLocation",
Gunnar Mills10f270b2021-05-19 15:34:06 -0500256 "description": "The part location for a resource within an enclosure.",
257 "longDescription": "This property shall contain the part location for a resource within an enclosure. This representation shall indicate the location of a part within a location specified by the Placement property.",
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600258 "versionAdded": "v1_5_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700259 },
260 "Placement": {
Ed Tanouscb103132019-10-08 11:34:22 -0700261 "$ref": "#/definitions/Placement",
Ed Tanous118b1c72018-09-13 13:45:51 -0700262 "description": "A place within the addressed location.",
Ed Tanouscb103132019-10-08 11:34:22 -0700263 "longDescription": "This property shall contain a place within the addressed location.",
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600264 "versionAdded": "v1_3_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700265 },
266 "PostalAddress": {
Ed Tanouscb103132019-10-08 11:34:22 -0700267 "$ref": "#/definitions/PostalAddress",
Gunnar Millsa778c022020-05-12 12:20:36 -0500268 "description": "The postal address of the addressed resource.",
269 "longDescription": "This property shall contain a postal address of the resource.",
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600270 "versionAdded": "v1_3_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700271 }
272 },
273 "type": "object"
274 },
275 "LocationType": {
Gunnar Mills10f270b2021-05-19 15:34:06 -0500276 "description": "The types of locations for a part within an enclosure.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700277 "enum": [
278 "Slot",
279 "Bay",
280 "Connector",
Gunnar Mills10f270b2021-05-19 15:34:06 -0500281 "Socket",
Gunnar Mills9d424662021-09-22 21:56:16 -0500282 "Backplane",
283 "Embedded"
Ed Tanous118b1c72018-09-13 13:45:51 -0700284 ],
285 "enumDescriptions": {
Gunnar Mills10f270b2021-05-19 15:34:06 -0500286 "Backplane": "A backplane.",
287 "Bay": "A bay.",
288 "Connector": "A connector or port.",
Gunnar Mills9d424662021-09-22 21:56:16 -0500289 "Embedded": "Embedded within a part.",
Gunnar Mills10f270b2021-05-19 15:34:06 -0500290 "Slot": "A slot.",
291 "Socket": "A socket."
Ed Tanous118b1c72018-09-13 13:45:51 -0700292 },
293 "enumLongDescriptions": {
Gunnar Mills10f270b2021-05-19 15:34:06 -0500294 "Backplane": "This value shall indicate the part is a backplane in an enclosure.",
295 "Bay": "This value shall indicate the part is located in a bay.",
296 "Connector": "This value shall indicate the part is located in a connector or port.",
Gunnar Mills9d424662021-09-22 21:56:16 -0500297 "Embedded": "This value shall indicate the part is embedded or otherwise permanently incorporated into a larger part or device. This value shall not be used for parts that can be removed by a user or are considered field-replaceable.",
Gunnar Mills10f270b2021-05-19 15:34:06 -0500298 "Slot": "This value shall indicate the part is located in a slot.",
299 "Socket": "This value shall indicate the part is located in a socket."
Ed Tanous118b1c72018-09-13 13:45:51 -0700300 },
Gunnar Mills10f270b2021-05-19 15:34:06 -0500301 "enumVersionAdded": {
Gunnar Mills9d424662021-09-22 21:56:16 -0500302 "Backplane": "v1_12_0",
303 "Embedded": "v1_13_0"
Gunnar Mills10f270b2021-05-19 15:34:06 -0500304 },
305 "longDescription": "This enumeration shall list the types of locations for a part within an enclosure.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700306 "type": "string"
307 },
308 "Orientation": {
Gunnar Mills10f270b2021-05-19 15:34:06 -0500309 "description": "The orientations for the ordering of the part location ordinal value.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700310 "enum": [
311 "FrontToBack",
312 "BackToFront",
313 "TopToBottom",
314 "BottomToTop",
315 "LeftToRight",
316 "RightToLeft"
317 ],
318 "enumDescriptions": {
Ed Tanouscb103132019-10-08 11:34:22 -0700319 "BackToFront": "The ordering for the LocationOrdinalValue is back to front.",
320 "BottomToTop": "The ordering for LocationOrdinalValue is bottom to top.",
321 "FrontToBack": "The ordering for LocationOrdinalValue is front to back.",
322 "LeftToRight": "The ordering for the LocationOrdinalValue is left to right.",
323 "RightToLeft": "The ordering for the LocationOrdinalValue is right to left.",
324 "TopToBottom": "The ordering for the LocationOrdinalValue is top to bottom."
Ed Tanous118b1c72018-09-13 13:45:51 -0700325 },
326 "enumLongDescriptions": {
Gunnar Mills10f270b2021-05-19 15:34:06 -0500327 "BackToFront": "This value shall indicate the ordering for LocationOrdinalValue is back to front.",
328 "BottomToTop": "This value shall indicate the ordering for LocationOrdinalValue is bottom to top.",
329 "FrontToBack": "This value shall indicate the ordering for LocationOrdinalValue is front to back.",
330 "LeftToRight": "This value shall indicate the ordering for LocationOrdinalValue is left to right.",
331 "RightToLeft": "This value shall indicate the ordering for LocationOrdinalValue is right to left.",
332 "TopToBottom": "This value shall indicate the ordering for LocationOrdinalValue is top to bottom."
Ed Tanous118b1c72018-09-13 13:45:51 -0700333 },
Gunnar Mills10f270b2021-05-19 15:34:06 -0500334 "longDescription": "This enumeration shall list the orientations for the ordering of the LocationOrdinalValue property.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700335 "type": "string"
336 },
337 "PartLocation": {
338 "additionalProperties": false,
Gunnar Mills10f270b2021-05-19 15:34:06 -0500339 "description": "The part location for a resource within an enclosure.",
340 "longDescription": "This type shall describe a location for a resource within an enclosure.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700341 "patternProperties": {
Ed Tanouscb103132019-10-08 11:34:22 -0700342 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
Ed Tanous118b1c72018-09-13 13:45:51 -0700343 "description": "This property shall specify a valid odata or Redfish property.",
344 "type": [
345 "array",
346 "boolean",
Ed Tanous530520e2019-01-02 13:41:37 -0800347 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -0700348 "number",
349 "null",
350 "object",
351 "string"
352 ]
353 }
354 },
355 "properties": {
356 "LocationOrdinalValue": {
Gunnar Mills10f270b2021-05-19 15:34:06 -0500357 "description": "The number that represents the location of the part. For example, if LocationType is `Slot` and this unit is in slot 2, the LocationOrdinalValue is `2`.",
358 "longDescription": "This property shall contain 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`.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700359 "readonly": true,
360 "type": [
Ed Tanous530520e2019-01-02 13:41:37 -0800361 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -0700362 "null"
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600363 ],
364 "versionAdded": "v1_5_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700365 },
366 "LocationType": {
367 "anyOf": [
368 {
369 "$ref": "#/definitions/LocationType"
370 },
371 {
372 "type": "null"
373 }
374 ],
Gunnar Mills9d424662021-09-22 21:56:16 -0500375 "description": "The type of location of the part.",
376 "longDescription": "This property shall contain the type of location of the part.",
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600377 "readonly": true,
378 "versionAdded": "v1_5_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700379 },
380 "Orientation": {
381 "anyOf": [
382 {
383 "$ref": "#/definitions/Orientation"
384 },
385 {
386 "type": "null"
387 }
388 ],
389 "description": "The orientation for the ordering of the slot enumeration used by the LocationOrdinalValue property.",
Ed Tanouscb103132019-10-08 11:34:22 -0700390 "longDescription": "This property shall contain the orientation for the ordering used by the LocationOrdinalValue property.",
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600391 "readonly": true,
392 "versionAdded": "v1_5_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700393 },
394 "Reference": {
395 "anyOf": [
396 {
397 "$ref": "#/definitions/Reference"
398 },
399 {
400 "type": "null"
401 }
402 ],
Ed Tanouscb103132019-10-08 11:34:22 -0700403 "description": "The reference point for the part location. Provides guidance about the general location of the part.",
404 "longDescription": "This property shall contain the general location within the unit of the part.",
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600405 "readonly": true,
406 "versionAdded": "v1_5_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700407 },
408 "ServiceLabel": {
Ed Tanouscb103132019-10-08 11:34:22 -0700409 "description": "The label of the part location, such as a silk-screened name or a printed label.",
410 "longDescription": "This property shall contain the label assigned for service at the part location.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700411 "readonly": true,
412 "type": [
413 "string",
414 "null"
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600415 ],
416 "versionAdded": "v1_5_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700417 }
418 },
419 "type": "object"
420 },
421 "Placement": {
422 "additionalProperties": false,
423 "description": "The placement within the addressed location.",
Gunnar Millsa778c022020-05-12 12:20:36 -0500424 "longDescription": "The value shall describe a location within a resource. Examples include a shelf in a rack.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700425 "patternProperties": {
Ed Tanouscb103132019-10-08 11:34:22 -0700426 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
Ed Tanous118b1c72018-09-13 13:45:51 -0700427 "description": "This property shall specify a valid odata or Redfish property.",
428 "type": [
429 "array",
430 "boolean",
Ed Tanous530520e2019-01-02 13:41:37 -0800431 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -0700432 "number",
433 "null",
434 "object",
435 "string"
436 ]
437 }
438 },
439 "properties": {
Ed Tanous530520e2019-01-02 13:41:37 -0800440 "AdditionalInfo": {
441 "description": "Area designation or other additional info.",
Ed Tanouscb103132019-10-08 11:34:22 -0700442 "longDescription": "This property shall contain additional information, such as Tile, Column (Post), Wall, or other designation that describes a location that cannot be conveyed with other properties defined for the Placement object.",
Ed Tanous530520e2019-01-02 13:41:37 -0800443 "readonly": false,
444 "type": [
445 "string",
446 "null"
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600447 ],
448 "versionAdded": "v1_7_0"
Ed Tanous530520e2019-01-02 13:41:37 -0800449 },
Ed Tanous118b1c72018-09-13 13:45:51 -0700450 "Rack": {
Ed Tanouscb103132019-10-08 11:34:22 -0700451 "description": "The name of a rack location within a row.",
452 "longDescription": "This property shall contain the name of the rack within a row.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700453 "readonly": false,
454 "type": [
455 "string",
456 "null"
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600457 ],
458 "versionAdded": "v1_3_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700459 },
460 "RackOffset": {
Ed Tanouscb103132019-10-08 11:34:22 -0700461 "description": "The vertical location of the item, in terms of RackOffsetUnits.",
462 "longDescription": "The vertical location of the item in the rack. Rack offset units shall be measured from bottom to top, starting with 0.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700463 "readonly": false,
464 "type": [
Ed Tanous530520e2019-01-02 13:41:37 -0800465 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -0700466 "null"
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600467 ],
468 "versionAdded": "v1_3_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700469 },
470 "RackOffsetUnits": {
471 "anyOf": [
472 {
473 "$ref": "#/definitions/RackUnits"
474 },
475 {
476 "type": "null"
477 }
478 ],
Ed Tanouscb103132019-10-08 11:34:22 -0700479 "description": "The type of rack units in use.",
480 "longDescription": "This property shall contain a RackUnit enumeration literal that indicates the type of rack units in use.",
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600481 "readonly": false,
482 "versionAdded": "v1_3_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700483 },
484 "Row": {
Ed Tanouscb103132019-10-08 11:34:22 -0700485 "description": "The name of the row.",
486 "longDescription": "This property shall contain the name of the row.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700487 "readonly": false,
488 "type": [
489 "string",
490 "null"
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600491 ],
492 "versionAdded": "v1_3_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700493 }
494 },
495 "type": "object"
496 },
497 "PostalAddress": {
498 "additionalProperties": false,
Gunnar Millsa778c022020-05-12 12:20:36 -0500499 "description": "The postal address for a resource.",
Gunnar Mills844b4152020-06-22 12:44:09 -0500500 "longDescription": "Instances shall describe a postal address for a resource. For more information, see RFC5139. Depending on use, the instance can represent a past, current, or future location.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700501 "patternProperties": {
Ed Tanouscb103132019-10-08 11:34:22 -0700502 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
Ed Tanous118b1c72018-09-13 13:45:51 -0700503 "description": "This property shall specify a valid odata or Redfish property.",
504 "type": [
505 "array",
506 "boolean",
Ed Tanous530520e2019-01-02 13:41:37 -0800507 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -0700508 "number",
509 "null",
510 "object",
511 "string"
512 ]
513 }
514 },
515 "properties": {
516 "AdditionalCode": {
Ed Tanouscb103132019-10-08 11:34:22 -0700517 "description": "The additional code.",
518 "longDescription": "The value shall conform to the RFC5139-defined requirements of the ADDCODE field.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700519 "readonly": false,
520 "type": [
521 "string",
522 "null"
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600523 ],
524 "versionAdded": "v1_3_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700525 },
Ed Tanous530520e2019-01-02 13:41:37 -0800526 "AdditionalInfo": {
Ed Tanouscb103132019-10-08 11:34:22 -0700527 "description": "The room designation or other additional information.",
528 "longDescription": "The value shall conform to the requirements of the LOC field as defined in RFC5139. Provides additional information.",
Ed Tanous530520e2019-01-02 13:41:37 -0800529 "readonly": false,
530 "type": [
531 "string",
532 "null"
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600533 ],
534 "versionAdded": "v1_7_0"
Ed Tanous530520e2019-01-02 13:41:37 -0800535 },
Ed Tanous118b1c72018-09-13 13:45:51 -0700536 "Building": {
Ed Tanouscb103132019-10-08 11:34:22 -0700537 "description": "The name of the building.",
538 "longDescription": "The value shall conform to the RFC5139-defined requirements of the BLD field. Names the building.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700539 "readonly": false,
540 "type": [
541 "string",
542 "null"
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600543 ],
544 "versionAdded": "v1_3_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700545 },
546 "City": {
547 "description": "City, township, or shi (JP).",
Ed Tanouscb103132019-10-08 11:34:22 -0700548 "longDescription": "The value shall conform to the RFC5139-defined requirements of the A3 field. Names a city, township, or shi (JP).",
Ed Tanous118b1c72018-09-13 13:45:51 -0700549 "readonly": false,
550 "type": [
551 "string",
552 "null"
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600553 ],
554 "versionAdded": "v1_3_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700555 },
556 "Community": {
Ed Tanouscb103132019-10-08 11:34:22 -0700557 "description": "The postal community name.",
558 "longDescription": "The value shall conform to the RFC5139-defined requirements of the PCN field. A postal community name.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700559 "readonly": false,
560 "type": [
561 "string",
562 "null"
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600563 ],
564 "versionAdded": "v1_3_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700565 },
566 "Country": {
Ed Tanouscb103132019-10-08 11:34:22 -0700567 "description": "The country.",
568 "longDescription": "The value shall conform to the RFC5139-defined requirements of the Country field.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700569 "readonly": false,
570 "type": [
571 "string",
572 "null"
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600573 ],
574 "versionAdded": "v1_3_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700575 },
576 "District": {
Ed Tanouscb103132019-10-08 11:34:22 -0700577 "description": "A county, parish, gun (JP), or district (IN).",
578 "longDescription": "The value shall conform to the RFC5139-defined requirements of the A2 field. Names a county, parish, gun (JP), or district (IN).",
Ed Tanous118b1c72018-09-13 13:45:51 -0700579 "readonly": false,
580 "type": [
581 "string",
582 "null"
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600583 ],
584 "versionAdded": "v1_3_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700585 },
586 "Division": {
Gunnar Millsa778c022020-05-12 12:20:36 -0500587 "description": "City division, borough, city district, ward, or chou (JP).",
588 "longDescription": "The value shall conform to the RFC5139-defined requirements of the A4 field. Names a city division, borough, city district, ward, or chou (JP).",
Ed Tanous118b1c72018-09-13 13:45:51 -0700589 "readonly": false,
590 "type": [
591 "string",
592 "null"
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600593 ],
594 "versionAdded": "v1_3_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700595 },
596 "Floor": {
Ed Tanouscb103132019-10-08 11:34:22 -0700597 "description": "The floor.",
598 "longDescription": "The value shall conform to the RFC5139-defined requirements of the FLR field. Provides a floor designation.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700599 "readonly": false,
600 "type": [
601 "string",
602 "null"
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600603 ],
604 "versionAdded": "v1_3_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700605 },
606 "GPSCoords": {
Ed Tanouscb103132019-10-08 11:34:22 -0700607 "deprecated": "This property has been deprecated in favor of the Longitude and Latitude properties.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700608 "description": "The GPS coordinates of the part.",
Ed Tanouscb103132019-10-08 11:34:22 -0700609 "longDescription": "The value shall conform to the RFC5139-defined requirements of the ADDCODE field. Shall contain the GPS coordinates of the location. If furnished, expressed in the '[-][nn]n.nnnnnn, [-][nn]n.nnnnn' format. For example, two comma-separated positive or negative numbers with six decimal places of precision.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700610 "readonly": false,
611 "type": [
612 "string",
613 "null"
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600614 ],
Ed Tanouscb103132019-10-08 11:34:22 -0700615 "versionAdded": "v1_3_0",
616 "versionDeprecated": "v1_6_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700617 },
618 "HouseNumber": {
Ed Tanouscb103132019-10-08 11:34:22 -0700619 "description": "The numeric portion of house number.",
620 "longDescription": "The value shall conform to the RFC5139-defined requirements of the HNO field. The numeric portion of the house number.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700621 "readonly": false,
622 "type": [
Ed Tanous530520e2019-01-02 13:41:37 -0800623 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -0700624 "null"
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600625 ],
626 "versionAdded": "v1_3_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700627 },
628 "HouseNumberSuffix": {
Ed Tanouscb103132019-10-08 11:34:22 -0700629 "description": "The house number suffix.",
630 "longDescription": "The value shall conform to the RFC5139-defined requirements of the HNS field. Provides a suffix to a house number, (F, B, or 1/2).",
Ed Tanous118b1c72018-09-13 13:45:51 -0700631 "readonly": false,
632 "type": [
633 "string",
634 "null"
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600635 ],
636 "versionAdded": "v1_3_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700637 },
638 "Landmark": {
Ed Tanouscb103132019-10-08 11:34:22 -0700639 "description": "The landmark.",
640 "longDescription": "The value shall conform to the RFC5139-defined requirements of the LMK field. Identifies a landmark or vanity address.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700641 "readonly": false,
642 "type": [
643 "string",
644 "null"
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600645 ],
646 "versionAdded": "v1_3_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700647 },
648 "LeadingStreetDirection": {
649 "description": "A leading street direction.",
Ed Tanouscb103132019-10-08 11:34:22 -0700650 "longDescription": "The value shall conform to the requirements of the PRD field as defined in RFC5139. Names a leading street direction, (N, W, or SE).",
Ed Tanous118b1c72018-09-13 13:45:51 -0700651 "readonly": false,
652 "type": [
653 "string",
654 "null"
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600655 ],
656 "versionAdded": "v1_3_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700657 },
658 "Location": {
Ed Tanouscb103132019-10-08 11:34:22 -0700659 "deprecated": "This property has been deprecated in favor of the AdditionalInfo property.",
660 "description": "The room designation or other additional information.",
661 "longDescription": "The value shall conform to the RFC5139-defined requirements of the LOC field. Provides additional information.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700662 "readonly": false,
663 "type": [
664 "string",
665 "null"
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600666 ],
Ed Tanouscb103132019-10-08 11:34:22 -0700667 "versionAdded": "v1_3_0",
668 "versionDeprecated": "v1_7_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700669 },
670 "Name": {
Ed Tanouscb103132019-10-08 11:34:22 -0700671 "description": "The name.",
672 "longDescription": "The value shall conform to the RFC5139-defined requirements of the NAM field. Names the occupant.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700673 "readonly": false,
674 "type": [
675 "string",
676 "null"
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600677 ],
678 "versionAdded": "v1_3_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700679 },
680 "Neighborhood": {
681 "description": "Neighborhood or block.",
Ed Tanouscb103132019-10-08 11:34:22 -0700682 "longDescription": "The value shall conform to the RFC5139-defined requirements of the A5 field. Names a neighborhood or block.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700683 "readonly": false,
684 "type": [
685 "string",
686 "null"
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600687 ],
688 "versionAdded": "v1_3_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700689 },
690 "POBox": {
Ed Tanouscb103132019-10-08 11:34:22 -0700691 "description": "The post office box (PO box).",
692 "longDescription": "The value shall conform to the RFC5139-defined requirements of the POBOX field. A post office box (PO box).",
Ed Tanous118b1c72018-09-13 13:45:51 -0700693 "readonly": false,
694 "type": [
695 "string",
696 "null"
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600697 ],
698 "versionAdded": "v1_3_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700699 },
700 "PlaceType": {
Ed Tanouscb103132019-10-08 11:34:22 -0700701 "description": "The description of the type of place that is addressed.",
702 "longDescription": "The value shall conform to the RFC5139-defined requirements of the PLC field. Examples include office and residence.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700703 "readonly": false,
704 "type": [
705 "string",
706 "null"
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600707 ],
708 "versionAdded": "v1_3_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700709 },
710 "PostalCode": {
Ed Tanouscb103132019-10-08 11:34:22 -0700711 "description": "The postal code or zip code.",
712 "longDescription": "The value shall conform to the RFC5139-defined requirements of the PC field. A postal code (or zip code).",
Ed Tanous118b1c72018-09-13 13:45:51 -0700713 "readonly": false,
714 "type": [
715 "string",
716 "null"
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600717 ],
718 "versionAdded": "v1_3_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700719 },
720 "Road": {
Ed Tanouscb103132019-10-08 11:34:22 -0700721 "description": "The primary road or street.",
722 "longDescription": "The value shall conform to the RFC5139-defined requirements of the RD field. Designates a primary road or street.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700723 "readonly": false,
724 "type": [
725 "string",
726 "null"
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600727 ],
728 "versionAdded": "v1_3_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700729 },
730 "RoadBranch": {
Ed Tanouscb103132019-10-08 11:34:22 -0700731 "description": "The road branch.",
732 "longDescription": "The value shall conform to the RFC5139-defined requirements of the RDBR field. Shall contain a post office box (PO box) road branch.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700733 "readonly": false,
734 "type": [
735 "string",
736 "null"
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600737 ],
738 "versionAdded": "v1_3_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700739 },
740 "RoadPostModifier": {
Ed Tanouscb103132019-10-08 11:34:22 -0700741 "description": "The road post-modifier.",
742 "longDescription": "The value shall conform to the RFC5139-defined requirements of the POM field. For example, Extended.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700743 "readonly": false,
744 "type": [
745 "string",
746 "null"
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600747 ],
748 "versionAdded": "v1_3_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700749 },
750 "RoadPreModifier": {
Ed Tanouscb103132019-10-08 11:34:22 -0700751 "description": "The road pre-modifier.",
752 "longDescription": "The value shall conform to the RFC5139-defined requirements of the PRM field. For example, Old or New.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700753 "readonly": false,
754 "type": [
755 "string",
756 "null"
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600757 ],
758 "versionAdded": "v1_3_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700759 },
760 "RoadSection": {
Ed Tanouscb103132019-10-08 11:34:22 -0700761 "description": "The road section.",
762 "longDescription": "The value shall conform to the RFC5139-defined requirements of the RDSEC field. A road section.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700763 "readonly": false,
764 "type": [
765 "string",
766 "null"
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600767 ],
768 "versionAdded": "v1_3_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700769 },
770 "RoadSubBranch": {
Ed Tanouscb103132019-10-08 11:34:22 -0700771 "description": "The road sub branch.",
772 "longDescription": "The value shall conform to the RFC5139-defined requirements of the RDSUBBR field.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700773 "readonly": false,
774 "type": [
775 "string",
776 "null"
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600777 ],
778 "versionAdded": "v1_3_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700779 },
780 "Room": {
Ed Tanouscb103132019-10-08 11:34:22 -0700781 "description": "The name or number of the room.",
Gunnar Millsa778c022020-05-12 12:20:36 -0500782 "longDescription": "The value shall conform to the RFC5139-defined requirements of the ROOM field. A name or number of a room to locate the resource within the unit.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700783 "readonly": false,
784 "type": [
785 "string",
786 "null"
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600787 ],
788 "versionAdded": "v1_3_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700789 },
790 "Seat": {
Ed Tanouscb103132019-10-08 11:34:22 -0700791 "description": "The seat, such as the desk, cubicle, or workstation.",
792 "longDescription": "The value shall conform to the RFC5139-defined requirements of the SEAT field. A name or number of a seat, such as the desk, cubicle, or workstation.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700793 "readonly": false,
794 "type": [
795 "string",
796 "null"
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600797 ],
798 "versionAdded": "v1_3_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700799 },
800 "Street": {
801 "description": "Street name.",
Ed Tanouscb103132019-10-08 11:34:22 -0700802 "longDescription": "The value shall conform to the RFC5139-defined requirements of the A6 field. Names a street.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700803 "readonly": false,
804 "type": [
805 "string",
806 "null"
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600807 ],
808 "versionAdded": "v1_3_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700809 },
810 "StreetSuffix": {
811 "description": "Avenue, Platz, Street, Circle.",
Ed Tanouscb103132019-10-08 11:34:22 -0700812 "longDescription": "The value shall conform to the RFC5139-defined requirements of the STS field. Names a street suffix.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700813 "readonly": false,
814 "type": [
815 "string",
816 "null"
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600817 ],
818 "versionAdded": "v1_3_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700819 },
820 "Territory": {
821 "description": "A top-level subdivision within a country.",
Ed Tanouscb103132019-10-08 11:34:22 -0700822 "longDescription": "The value shall conform to the RFC5139-defined requirements of the A1 field when it names a territory, state, region, province, or prefecture within a country.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700823 "readonly": false,
824 "type": [
825 "string",
826 "null"
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600827 ],
828 "versionAdded": "v1_3_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700829 },
830 "TrailingStreetSuffix": {
831 "description": "A trailing street suffix.",
Ed Tanouscb103132019-10-08 11:34:22 -0700832 "longDescription": "The value shall conform to the RFC5139-defined requirements of the POD field. Names a trailing street suffix.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700833 "readonly": false,
834 "type": [
835 "string",
836 "null"
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600837 ],
838 "versionAdded": "v1_3_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700839 },
840 "Unit": {
Ed Tanouscb103132019-10-08 11:34:22 -0700841 "description": "The name or number of the apartment unit or suite.",
Gunnar Millsa778c022020-05-12 12:20:36 -0500842 "longDescription": "The value shall conform to the RFC5139-defined requirements of the UNIT field. The name or number of a unit, such as the apartment or suite, to locate the resource.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700843 "readonly": false,
844 "type": [
845 "string",
846 "null"
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600847 ],
848 "versionAdded": "v1_3_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700849 }
850 },
851 "type": "object"
852 },
Ed Tanous118b1c72018-09-13 13:45:51 -0700853 "RackUnits": {
Ed Tanouscb103132019-10-08 11:34:22 -0700854 "description": "The type of rack unit in use.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700855 "enum": [
856 "OpenU",
857 "EIA_310"
858 ],
859 "enumDescriptions": {
Ed Tanouscb103132019-10-08 11:34:22 -0700860 "EIA_310": "A rack unit that is equal to 1.75 in (44.45 mm).",
861 "OpenU": "A rack unit that is equal to 48 mm (1.89 in)."
Ed Tanous118b1c72018-09-13 13:45:51 -0700862 },
863 "enumLongDescriptions": {
Ed Tanouscb103132019-10-08 11:34:22 -0700864 "EIA_310": "Rack units shall conform to the EIA-310 standard.",
Gunnar Millsa778c022020-05-12 12:20:36 -0500865 "OpenU": "Rack units shall be specified in terms of the Open Compute Open Rack Specification."
Ed Tanous118b1c72018-09-13 13:45:51 -0700866 },
Ed Tanouscb103132019-10-08 11:34:22 -0700867 "longDescription": "Enumeration literals shall name the type of rack unit in use.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700868 "type": "string"
869 },
870 "Reference": {
Gunnar Mills10f270b2021-05-19 15:34:06 -0500871 "description": "The reference areas for the location of the part within an enclosure.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700872 "enum": [
873 "Top",
874 "Bottom",
875 "Front",
876 "Rear",
877 "Left",
878 "Right",
879 "Middle"
880 ],
881 "enumDescriptions": {
Ed Tanouscb103132019-10-08 11:34:22 -0700882 "Bottom": "The part is in the bottom of the unit.",
883 "Front": "The part is in the front of the unit.",
884 "Left": "The part is on the left side of of the unit.",
885 "Middle": "The part is in the middle of the unit.",
886 "Rear": "The part is in the rear of the unit.",
887 "Right": "The part is on the right side of the unit.",
888 "Top": "The part is in the top of the unit."
Ed Tanous118b1c72018-09-13 13:45:51 -0700889 },
890 "enumLongDescriptions": {
Gunnar Mills10f270b2021-05-19 15:34:06 -0500891 "Bottom": "This value shall indicate the part is in the bottom of the unit.",
892 "Front": "This value shall indicate the part is in the front of the unit.",
893 "Left": "This value shall indicate the part is on the left side of of the unit.",
894 "Middle": "This value shall indicate the part is in the middle of the unit.",
895 "Rear": "This value shall indicate the part is in the rear of the unit.",
896 "Right": "This value shall indicate the part is on the right side of the unit.",
897 "Top": "This value shall indicate the part is in the top of the unit."
Ed Tanous118b1c72018-09-13 13:45:51 -0700898 },
Gunnar Mills10f270b2021-05-19 15:34:06 -0500899 "longDescription": "This enumeration shall list the reference areas for the location of the part within an enclosure.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700900 "type": "string"
901 },
902 "ReferenceableMember": {
903 "additionalProperties": false,
Ed Tanouscb103132019-10-08 11:34:22 -0700904 "description": "The base type for addressable members of an array.",
Gunnar Mills844b4152020-06-22 12:44:09 -0500905 "longDescription": "References array members by using the value returned in the @odata.id property, which can be a dereferenceable URL. The @odata.id of this entity shall contain the location of this element within an item.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700906 "patternProperties": {
Ed Tanouscb103132019-10-08 11:34:22 -0700907 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
Ed Tanous118b1c72018-09-13 13:45:51 -0700908 "description": "This property shall specify a valid odata or Redfish property.",
909 "type": [
910 "array",
911 "boolean",
Ed Tanous530520e2019-01-02 13:41:37 -0800912 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -0700913 "number",
914 "null",
915 "object",
916 "string"
917 ]
918 }
919 },
920 "properties": {
Ed Tanous530520e2019-01-02 13:41:37 -0800921 "@odata.id": {
Ed Tanouscb103132019-10-08 11:34:22 -0700922 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id"
Ed Tanous530520e2019-01-02 13:41:37 -0800923 },
Ed Tanous118b1c72018-09-13 13:45:51 -0700924 "MemberId": {
Gunnar Mills9d424662021-09-22 21:56:16 -0500925 "description": "The unique identifier for the member within an array.",
926 "longDescription": "This property shall contain the unique identifier for this member within an array. For services supporting Redfish v1.6 or higher, this value shall contain the zero-based array index.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700927 "readonly": true,
928 "type": "string"
929 },
930 "Oem": {
931 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
Ed Tanouscb103132019-10-08 11:34:22 -0700932 "description": "The OEM extension property.",
933 "longDescription": "This property shall contain the OEM extensions. All values for properties that this object contains shall conform to the Redfish Specification-described requirements."
Ed Tanous118b1c72018-09-13 13:45:51 -0700934 }
935 },
Ed Tanous530520e2019-01-02 13:41:37 -0800936 "required": [
937 "MemberId",
938 "@odata.id"
939 ],
Ed Tanous118b1c72018-09-13 13:45:51 -0700940 "type": "object"
941 },
942 "Resource": {
943 "additionalProperties": false,
Gunnar Millsa778c022020-05-12 12:20:36 -0500944 "description": "The base type for resources and members that can be linked to.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700945 "patternProperties": {
Ed Tanouscb103132019-10-08 11:34:22 -0700946 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
Ed Tanous118b1c72018-09-13 13:45:51 -0700947 "description": "This property shall specify a valid odata or Redfish property.",
948 "type": [
949 "array",
950 "boolean",
Ed Tanous530520e2019-01-02 13:41:37 -0800951 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -0700952 "number",
953 "null",
954 "object",
955 "string"
956 ]
957 }
958 },
959 "properties": {
960 "@odata.context": {
Ed Tanouscb103132019-10-08 11:34:22 -0700961 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context"
Ed Tanous530520e2019-01-02 13:41:37 -0800962 },
963 "@odata.etag": {
Ed Tanouscb103132019-10-08 11:34:22 -0700964 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag"
Ed Tanous118b1c72018-09-13 13:45:51 -0700965 },
966 "@odata.id": {
Ed Tanouscb103132019-10-08 11:34:22 -0700967 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id"
Ed Tanous118b1c72018-09-13 13:45:51 -0700968 },
969 "@odata.type": {
Ed Tanouscb103132019-10-08 11:34:22 -0700970 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type"
Ed Tanous118b1c72018-09-13 13:45:51 -0700971 },
972 "Description": {
973 "anyOf": [
974 {
975 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
976 },
977 {
978 "type": "null"
979 }
980 ],
981 "readonly": true
982 },
983 "Id": {
984 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
985 "readonly": true
986 },
987 "Name": {
988 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
989 "readonly": true
990 },
991 "Oem": {
992 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
Ed Tanouscb103132019-10-08 11:34:22 -0700993 "description": "The OEM extension property.",
994 "longDescription": "This property shall contain the OEM extensions. All values for properties that this object contains shall conform to the Redfish Specification-described requirements."
Ed Tanous118b1c72018-09-13 13:45:51 -0700995 }
996 },
997 "required": [
998 "Id",
Ed Tanous530520e2019-01-02 13:41:37 -0800999 "Name",
1000 "@odata.id",
1001 "@odata.type"
Ed Tanous118b1c72018-09-13 13:45:51 -07001002 ],
1003 "type": "object"
1004 },
1005 "ResourceCollection": {
1006 "additionalProperties": false,
1007 "patternProperties": {
Ed Tanouscb103132019-10-08 11:34:22 -07001008 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
Ed Tanous118b1c72018-09-13 13:45:51 -07001009 "description": "This property shall specify a valid odata or Redfish property.",
1010 "type": [
1011 "array",
1012 "boolean",
Ed Tanous530520e2019-01-02 13:41:37 -08001013 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -07001014 "number",
1015 "null",
1016 "object",
1017 "string"
1018 ]
1019 }
1020 },
1021 "properties": {
1022 "@odata.context": {
Ed Tanouscb103132019-10-08 11:34:22 -07001023 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context"
Ed Tanous530520e2019-01-02 13:41:37 -08001024 },
1025 "@odata.etag": {
Ed Tanouscb103132019-10-08 11:34:22 -07001026 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag"
Ed Tanous118b1c72018-09-13 13:45:51 -07001027 },
1028 "@odata.id": {
Ed Tanouscb103132019-10-08 11:34:22 -07001029 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id"
Ed Tanous118b1c72018-09-13 13:45:51 -07001030 },
1031 "@odata.type": {
Ed Tanouscb103132019-10-08 11:34:22 -07001032 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type"
Ed Tanous118b1c72018-09-13 13:45:51 -07001033 },
1034 "Description": {
1035 "anyOf": [
1036 {
1037 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
1038 },
1039 {
1040 "type": "null"
1041 }
1042 ],
1043 "readonly": true
1044 },
1045 "Name": {
1046 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
1047 "readonly": true
1048 },
1049 "Oem": {
1050 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
Ed Tanouscb103132019-10-08 11:34:22 -07001051 "description": "The OEM extension property.",
1052 "longDescription": "This property shall contain the OEM extensions. All values for properties contained in this object shall conform to the Redfish Specification-described requirements."
Ed Tanous118b1c72018-09-13 13:45:51 -07001053 }
1054 },
Ed Tanous530520e2019-01-02 13:41:37 -08001055 "required": [
1056 "Name",
1057 "@odata.id",
1058 "@odata.type"
1059 ],
Ed Tanous118b1c72018-09-13 13:45:51 -07001060 "type": "object"
1061 }
1062 },
Ed Tanous530520e2019-01-02 13:41:37 -08001063 "owningEntity": "DMTF",
Ed Tanousa8d8f9d2023-01-26 13:57:00 -08001064 "release": "2022.3",
1065 "title": "#Resource.v1_15_0"
Ed Tanous118b1c72018-09-13 13:45:51 -07001066}