blob: a85ae59f8da730825a482fe917fe61a92ead94ba [file] [log] [blame]
Ed Tanous118b1c72018-09-13 13:45:51 -07001{
Gunnar Mills09b9d452020-02-11 13:27:39 -06002 "$id": "http://redfish.dmtf.org/schemas/v1/Endpoint.v1_4_0.json",
Ed Tanous118b1c72018-09-13 13:45:51 -07003 "$ref": "#/definitions/Endpoint",
Ed Tanous530520e2019-01-02 13:41:37 -08004 "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
Ed Tanouscb103132019-10-08 11:34:22 -07005 "copyright": "Copyright 2014-2019 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright",
Ed Tanous118b1c72018-09-13 13:45:51 -07006 "definitions": {
7 "Actions": {
8 "additionalProperties": false,
Ed Tanouscb103132019-10-08 11:34:22 -07009 "description": "The available actions for this Resource.",
10 "longDescription": "This type shall contain the available actions for this Resource.",
Ed Tanous118b1c72018-09-13 13:45:51 -070011 "patternProperties": {
Ed Tanouscb103132019-10-08 11:34:22 -070012 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
Ed Tanous118b1c72018-09-13 13:45:51 -070013 "description": "This property shall specify a valid odata or Redfish property.",
14 "type": [
15 "array",
16 "boolean",
Ed Tanous530520e2019-01-02 13:41:37 -080017 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -070018 "number",
19 "null",
20 "object",
21 "string"
22 ]
23 }
24 },
25 "properties": {
26 "Oem": {
Ed Tanouscb103132019-10-08 11:34:22 -070027 "$ref": "#/definitions/OemActions",
28 "description": "The available OEM-specific actions for this Resource.",
29 "longDescription": "This property shall contain the available OEM-specific actions for this Resource."
Ed Tanous118b1c72018-09-13 13:45:51 -070030 }
31 },
32 "type": "object"
33 },
34 "ConnectedEntity": {
35 "additionalProperties": false,
Ed Tanouscb103132019-10-08 11:34:22 -070036 "description": "Represents a remote Resource that is connected to the network accessible to this endpoint.",
37 "longDescription": "This type shall represent a remote Resource that is connected to a network accessible to an endpoint.",
Ed Tanous118b1c72018-09-13 13:45:51 -070038 "patternProperties": {
Ed Tanouscb103132019-10-08 11:34:22 -070039 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
Ed Tanous118b1c72018-09-13 13:45:51 -070040 "description": "This property shall specify a valid odata or Redfish property.",
41 "type": [
42 "array",
43 "boolean",
Ed Tanous530520e2019-01-02 13:41:37 -080044 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -070045 "number",
46 "null",
47 "object",
48 "string"
49 ]
50 }
51 },
52 "properties": {
53 "EntityLink": {
Ed Tanouscb103132019-10-08 11:34:22 -070054 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Resource",
55 "description": "The link to the associated entity.",
56 "longDescription": "This property shall contain a link to an entity of the type specified by the description of the EntityType property value.",
Ed Tanous118b1c72018-09-13 13:45:51 -070057 "readonly": true
58 },
59 "EntityPciId": {
Ed Tanouscb103132019-10-08 11:34:22 -070060 "$ref": "#/definitions/PciId",
Ed Tanous118b1c72018-09-13 13:45:51 -070061 "description": "The PCI ID of the connected entity.",
Ed Tanouscb103132019-10-08 11:34:22 -070062 "longDescription": "This property shall contain the PCI ID of the connected PCIe entity."
Ed Tanous118b1c72018-09-13 13:45:51 -070063 },
64 "EntityRole": {
65 "anyOf": [
66 {
67 "$ref": "#/definitions/EntityRole"
68 },
69 {
70 "type": "null"
71 }
72 ],
73 "description": "The role of the connected entity.",
Ed Tanouscb103132019-10-08 11:34:22 -070074 "longDescription": "This property shall indicate if the specified entity is an initiator, target, or both.",
Ed Tanous118b1c72018-09-13 13:45:51 -070075 "readonly": true
76 },
77 "EntityType": {
78 "anyOf": [
79 {
80 "$ref": "#/definitions/EntityType"
81 },
82 {
83 "type": "null"
84 }
85 ],
86 "description": "The type of the connected entity.",
Ed Tanouscb103132019-10-08 11:34:22 -070087 "longDescription": "This property shall indicate if type of connected entity.",
Ed Tanous118b1c72018-09-13 13:45:51 -070088 "readonly": true
89 },
Gunnar Mills09b9d452020-02-11 13:27:39 -060090 "GenZ": {
91 "anyOf": [
92 {
93 "$ref": "#/definitions/GenZ"
94 },
95 {
96 "type": "null"
97 }
98 ],
99 "description": "The Gen-Z related properties for the entity.",
100 "longDescription": "This property shall contain the Gen-Z related properties for the entity.",
101 "versionAdded": "v1_4_0"
102 },
Ed Tanous118b1c72018-09-13 13:45:51 -0700103 "Identifiers": {
104 "description": "Identifiers for the remote entity.",
105 "items": {
Ed Tanouscb103132019-10-08 11:34:22 -0700106 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Identifier"
Ed Tanous118b1c72018-09-13 13:45:51 -0700107 },
Ed Tanouscb103132019-10-08 11:34:22 -0700108 "longDescription": "Identifiers for the remote entity shall be unique in the context of other Resources that can reached over the connected network.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700109 "type": "array"
110 },
111 "Oem": {
Ed Tanous530520e2019-01-02 13:41:37 -0800112 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
Ed Tanouscb103132019-10-08 11:34:22 -0700113 "description": "The OEM extension property.",
114 "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 -0700115 },
116 "PciClassCode": {
Ed Tanouscb103132019-10-08 11:34:22 -0700117 "deprecated": "This property has been deprecated in favor of the ClassCode property inside the EntityPciId object.",
118 "description": "The Class Code, Subclass, and Programming Interface code of this PCIe function.",
119 "longDescription": "This property shall contain the PCI Class Code, Subclass, and Programming Interface of the PCIe device function.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700120 "pattern": "^0[xX](([a-fA-F]|[0-9]){2}){3}$",
121 "readonly": true,
122 "type": [
123 "string",
124 "null"
Ed Tanouscb103132019-10-08 11:34:22 -0700125 ],
126 "versionDeprecated": "v1_2_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700127 },
128 "PciFunctionNumber": {
Ed Tanouscb103132019-10-08 11:34:22 -0700129 "deprecated": "This property has been deprecated in favor of the FunctionNumber property inside the EntityPciId object.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700130 "description": "The PCI ID of the connected entity.",
Ed Tanouscb103132019-10-08 11:34:22 -0700131 "longDescription": "This property shall contain the PCI Function Number of the connected PCIe entity.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700132 "readonly": true,
133 "type": [
Ed Tanous530520e2019-01-02 13:41:37 -0800134 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -0700135 "null"
Ed Tanouscb103132019-10-08 11:34:22 -0700136 ],
137 "versionDeprecated": "v1_2_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700138 }
139 },
140 "type": "object"
141 },
142 "Endpoint": {
143 "additionalProperties": false,
Ed Tanouscb103132019-10-08 11:34:22 -0700144 "description": "The Endpoint schema contains the properties of an Endpoint Resource that represents the properties of an entity that sends or receives protocol-defined messages over a transport.",
145 "longDescription": "This Resource contains a fabric endpoint for a Redfish implementation.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700146 "patternProperties": {
Ed Tanouscb103132019-10-08 11:34:22 -0700147 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
Ed Tanous118b1c72018-09-13 13:45:51 -0700148 "description": "This property shall specify a valid odata or Redfish property.",
149 "type": [
150 "array",
151 "boolean",
Ed Tanous530520e2019-01-02 13:41:37 -0800152 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -0700153 "number",
154 "null",
155 "object",
156 "string"
157 ]
158 }
159 },
160 "properties": {
161 "@odata.context": {
Ed Tanouscb103132019-10-08 11:34:22 -0700162 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context"
Ed Tanous530520e2019-01-02 13:41:37 -0800163 },
164 "@odata.etag": {
Ed Tanouscb103132019-10-08 11:34:22 -0700165 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag"
Ed Tanous118b1c72018-09-13 13:45:51 -0700166 },
167 "@odata.id": {
Ed Tanouscb103132019-10-08 11:34:22 -0700168 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id"
Ed Tanous118b1c72018-09-13 13:45:51 -0700169 },
170 "@odata.type": {
Ed Tanouscb103132019-10-08 11:34:22 -0700171 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type"
Ed Tanous118b1c72018-09-13 13:45:51 -0700172 },
173 "Actions": {
174 "$ref": "#/definitions/Actions",
Ed Tanouscb103132019-10-08 11:34:22 -0700175 "description": "The available actions for this Resource.",
176 "longDescription": "This property shall contain the available actions for this Resource."
Ed Tanous118b1c72018-09-13 13:45:51 -0700177 },
178 "ConnectedEntities": {
179 "description": "All the entities connected to this endpoint.",
180 "items": {
Ed Tanouscb103132019-10-08 11:34:22 -0700181 "$ref": "#/definitions/ConnectedEntity"
Ed Tanous118b1c72018-09-13 13:45:51 -0700182 },
Ed Tanouscb103132019-10-08 11:34:22 -0700183 "longDescription": "This property shall contain all entities to which this endpoint allows access.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700184 "type": "array"
185 },
186 "Description": {
187 "anyOf": [
188 {
189 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
190 },
191 {
192 "type": "null"
193 }
194 ],
195 "readonly": true
196 },
197 "EndpointProtocol": {
198 "anyOf": [
199 {
200 "$ref": "http://redfish.dmtf.org/schemas/v1/Protocol.json#/definitions/Protocol"
201 },
202 {
203 "type": "null"
204 }
205 ],
206 "description": "The protocol supported by this endpoint.",
Ed Tanouscb103132019-10-08 11:34:22 -0700207 "longDescription": "This property shall contain the protocol this endpoint uses to communicate with other endpoints on this fabric.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700208 "readonly": true
209 },
210 "HostReservationMemoryBytes": {
Ed Tanouscb103132019-10-08 11:34:22 -0700211 "description": "The amount of memory in bytes that the host should allocate to connect to this endpoint.",
212 "longDescription": "This property shall contain the amount of memory in bytes that the host should allocate to connect to this endpoint.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700213 "readonly": true,
214 "type": [
Ed Tanous530520e2019-01-02 13:41:37 -0800215 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -0700216 "null"
217 ],
218 "units": "By"
219 },
220 "IPTransportDetails": {
Ed Tanouscb103132019-10-08 11:34:22 -0700221 "description": "An array of details for each IP transport supported by this endpoint. The array structure can model multiple IP addresses for this endpoint.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700222 "items": {
Ed Tanouscb103132019-10-08 11:34:22 -0700223 "$ref": "#/definitions/IPTransportDetails"
Ed Tanous118b1c72018-09-13 13:45:51 -0700224 },
225 "longDescription": "This array shall contain the details for each IP transport supported by this endpoint.",
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600226 "type": "array",
227 "versionAdded": "v1_1_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700228 },
229 "Id": {
230 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
231 "readonly": true
232 },
233 "Identifiers": {
234 "description": "Identifiers for this endpoint.",
235 "items": {
Ed Tanouscb103132019-10-08 11:34:22 -0700236 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Identifier"
Ed Tanous118b1c72018-09-13 13:45:51 -0700237 },
238 "longDescription": "Identifiers for this endpoint shall be unique in the context of other endpoints that can reached over the connected network.",
239 "type": "array"
240 },
241 "Links": {
242 "$ref": "#/definitions/Links",
Ed Tanouscb103132019-10-08 11:34:22 -0700243 "description": "The links to other Resources that are related to this Resource.",
244 "longDescription": "The Redfish Specification-described Links Property shall contain links to Resources related to but not subordinate to this Resource."
Ed Tanous118b1c72018-09-13 13:45:51 -0700245 },
246 "Name": {
247 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
248 "readonly": true
249 },
250 "Oem": {
251 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
Ed Tanouscb103132019-10-08 11:34:22 -0700252 "description": "The OEM extension property.",
253 "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 -0700254 },
255 "PciId": {
Ed Tanouscb103132019-10-08 11:34:22 -0700256 "$ref": "#/definitions/PciId",
Ed Tanous118b1c72018-09-13 13:45:51 -0700257 "description": "The PCI ID of the endpoint.",
Ed Tanouscb103132019-10-08 11:34:22 -0700258 "longDescription": "This property shall contain the PCI ID of the endpoint."
Ed Tanous118b1c72018-09-13 13:45:51 -0700259 },
260 "Redundancy": {
Ed Tanous530520e2019-01-02 13:41:37 -0800261 "autoExpand": true,
Ed Tanouscb103132019-10-08 11:34:22 -0700262 "description": "Redundancy information for the lower-level endpoints supporting this endpoint.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700263 "items": {
264 "$ref": "http://redfish.dmtf.org/schemas/v1/Redundancy.json#/definitions/Redundancy"
265 },
Ed Tanouscb103132019-10-08 11:34:22 -0700266 "longDescription": "The values of the properties in this array shall show how this endpoint is grouped with other endpoints for form redundancy sets.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700267 "type": "array"
268 },
269 "Redundancy@odata.count": {
Ed Tanouscb103132019-10-08 11:34:22 -0700270 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
Ed Tanous118b1c72018-09-13 13:45:51 -0700271 },
272 "Status": {
Ed Tanous530520e2019-01-02 13:41:37 -0800273 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status",
Ed Tanouscb103132019-10-08 11:34:22 -0700274 "description": "The status and health of the Resource and its subordinate or dependent Resources.",
275 "longDescription": "This property shall contain any status or health properties of the Resource."
Ed Tanous118b1c72018-09-13 13:45:51 -0700276 }
277 },
278 "required": [
Ed Tanous530520e2019-01-02 13:41:37 -0800279 "@odata.id",
280 "@odata.type",
Ed Tanous118b1c72018-09-13 13:45:51 -0700281 "Id",
282 "Name"
283 ],
284 "type": "object"
285 },
286 "EntityRole": {
287 "enum": [
288 "Initiator",
289 "Target",
290 "Both"
291 ],
292 "enumDescriptions": {
Ed Tanouscb103132019-10-08 11:34:22 -0700293 "Both": "The entity can both send and receive commands, messages, and other requests to or from other entities on the fabric.",
294 "Initiator": "The entity sends commands, messages, or other types of requests to other entities on the fabric, but cannot receive commands from other entities.",
295 "Target": "The entity receives commands, messages, or other types of requests from other entities on the fabric, but cannot send commands to other entities."
Ed Tanous118b1c72018-09-13 13:45:51 -0700296 },
297 "type": "string"
298 },
299 "EntityType": {
300 "enum": [
301 "StorageInitiator",
302 "RootComplex",
303 "NetworkController",
304 "Drive",
305 "StorageExpander",
306 "DisplayController",
307 "Bridge",
308 "Processor",
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600309 "Volume",
Gunnar Mills09b9d452020-02-11 13:27:39 -0600310 "AccelerationFunction",
311 "MediaController",
312 "MemoryChunk",
313 "Switch",
314 "FabricBridge"
Ed Tanous118b1c72018-09-13 13:45:51 -0700315 ],
316 "enumDescriptions": {
Ed Tanouscb103132019-10-08 11:34:22 -0700317 "AccelerationFunction": "The entity is an acceleration function realized through a device, such as an FPGA. The EntityLink property, if present, should be an AccelerationFunction type.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700318 "Bridge": "The entity is a PCI(e) bridge.",
319 "DisplayController": "The entity is a display controller.",
Ed Tanouscb103132019-10-08 11:34:22 -0700320 "Drive": "The entity is a disk drive. The EntityLink property, if present, should be a Drive type.",
Gunnar Mills09b9d452020-02-11 13:27:39 -0600321 "FabricBridge": "The entity is a fabric bridge. The EntityLink property, if present, should be a FabricAdapter type.",
322 "MediaController": "The entity is a media controller. The EntityLink property, if present, should be a MediaController type.",
323 "MemoryChunk": "The entity is a memory chunk. The EntityLink property, if present, should be a MemoryChunk type.",
Ed Tanouscb103132019-10-08 11:34:22 -0700324 "NetworkController": "The entity is a network controller. The EntityLink property, if present, should contain an EthernetInterface type.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700325 "Processor": "The entity is a processor device.",
Ed Tanouscb103132019-10-08 11:34:22 -0700326 "RootComplex": "The entity is a PCI(e) root complex. The EntityLink property, if present, should be a ComputerSystem type.",
327 "StorageExpander": "The entity is a storage expander. The EntityLink property, if present, should be a Chassis type.",
328 "StorageInitiator": "The entity is a storage initator. The EntityLink property, if present, should be a StorageController type.",
Gunnar Mills09b9d452020-02-11 13:27:39 -0600329 "Switch": "The entity is a switch, not an expander. Use `Expander` for expanders. The EntityLink property, if present, should be a Switch type.",
Ed Tanouscb103132019-10-08 11:34:22 -0700330 "Volume": "The entity is a volume. The EntityLink property, if present, should be a Volume type."
Ed Tanous118b1c72018-09-13 13:45:51 -0700331 },
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600332 "enumVersionAdded": {
333 "AccelerationFunction": "v1_3_0",
Gunnar Mills09b9d452020-02-11 13:27:39 -0600334 "FabricBridge": "v1_4_0",
335 "MediaController": "v1_4_0",
336 "MemoryChunk": "v1_4_0",
337 "Switch": "v1_4_0",
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600338 "Volume": "v1_1_0"
339 },
Ed Tanous118b1c72018-09-13 13:45:51 -0700340 "type": "string"
341 },
Gunnar Mills09b9d452020-02-11 13:27:39 -0600342 "GCID": {
343 "additionalProperties": false,
344 "description": "The Global Component ID (GCID).",
345 "longDescription": "This type shall contain the Gen-Z Core Specification-defined Global Component ID.",
346 "patternProperties": {
347 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
348 "description": "This property shall specify a valid odata or Redfish property.",
349 "type": [
350 "array",
351 "boolean",
352 "integer",
353 "number",
354 "null",
355 "object",
356 "string"
357 ]
358 }
359 },
360 "properties": {
361 "CID": {
362 "description": "The component identifier portion of the GCID for the entity.",
363 "longDescription": "This property shall contain the 12 bit component identifier portion of the GCID of the entity.",
364 "pattern": "^0[xX]([a-fA-F]|[0-9]){3}$",
365 "readonly": false,
366 "type": [
367 "string",
368 "null"
369 ],
370 "versionAdded": "v1_4_0"
371 },
372 "SID": {
373 "description": "The subnet identifier portion of the GCID for the entity.",
374 "longDescription": "This property shall contain the 16 bit subnet identifier portion of the GCID of the entity.",
375 "pattern": "^0[xX](([a-fA-F]|[0-9]){2}){2}$",
376 "readonly": false,
377 "type": [
378 "string",
379 "null"
380 ],
381 "versionAdded": "v1_4_0"
382 }
383 },
384 "type": "object"
385 },
386 "GenZ": {
387 "additionalProperties": false,
388 "description": "The Gen-Z related properties for an entity.",
389 "longDescription": "This type shall contain the Gen-Z related properties for an entity.",
390 "patternProperties": {
391 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
392 "description": "This property shall specify a valid odata or Redfish property.",
393 "type": [
394 "array",
395 "boolean",
396 "integer",
397 "number",
398 "null",
399 "object",
400 "string"
401 ]
402 }
403 },
404 "properties": {
405 "AccessKey": {
406 "description": "The Access Key for the entity.",
407 "longDescription": "This property shall contain the Gen-Z Core Specification-defined 6 bit Access Key for the entity.",
408 "pattern": "^0[xX]([a-fA-F]|[0-9]){2}$",
409 "readonly": false,
410 "type": [
411 "string",
412 "null"
413 ],
414 "versionAdded": "v1_4_0"
415 },
416 "GCID": {
417 "anyOf": [
418 {
419 "$ref": "#/definitions/GCID"
420 },
421 {
422 "type": "null"
423 }
424 ],
425 "description": "The Global Component ID (GCID) for the entity.",
426 "longDescription": "This property shall contain the Gen-Z Core Specification-defined Global Component ID for the entity.",
427 "versionAdded": "v1_4_0"
428 },
429 "RegionKey": {
430 "description": "The Region Key for the entity.",
431 "longDescription": "This property shall contain the Gen-Z Core Specification-defined 32 bit Region Key for the entity.",
432 "pattern": "^0[xX](([a-fA-F]|[0-9]){2}){4}$",
433 "readonly": false,
434 "type": [
435 "string",
436 "null"
437 ],
438 "versionAdded": "v1_4_0"
439 }
440 },
441 "type": "object"
442 },
Ed Tanous118b1c72018-09-13 13:45:51 -0700443 "IPTransportDetails": {
444 "additionalProperties": false,
Ed Tanouscb103132019-10-08 11:34:22 -0700445 "description": "This type specifies the details of the transport supported by the endpoint. The properties that are present are dependent on the type of transport supported by the endpoint.",
446 "longDescription": "The type shall contain properties that specify the details of the transport supported by the endpoint.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700447 "patternProperties": {
Ed Tanouscb103132019-10-08 11:34:22 -0700448 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
Ed Tanous118b1c72018-09-13 13:45:51 -0700449 "description": "This property shall specify a valid odata or Redfish property.",
450 "type": [
451 "array",
452 "boolean",
Ed Tanous530520e2019-01-02 13:41:37 -0800453 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -0700454 "number",
455 "null",
456 "object",
457 "string"
458 ]
459 }
460 },
461 "properties": {
462 "IPv4Address": {
463 "$ref": "http://redfish.dmtf.org/schemas/v1/IPAddresses.json#/definitions/IPv4Address",
Ed Tanouscb103132019-10-08 11:34:22 -0700464 "description": "The IPv4 addresses assigned to the endpoint.",
465 "longDescription": "This property shall contain the IPv4Address.",
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600466 "versionAdded": "v1_1_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700467 },
468 "IPv6Address": {
469 "$ref": "http://redfish.dmtf.org/schemas/v1/IPAddresses.json#/definitions/IPv6Address",
Ed Tanouscb103132019-10-08 11:34:22 -0700470 "description": "The IPv6 addresses assigned to the endpoint.",
471 "longDescription": "This property shall contain the IPv6Address.",
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600472 "versionAdded": "v1_1_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700473 },
474 "Port": {
Ed Tanouscb103132019-10-08 11:34:22 -0700475 "description": "The UDP or TCP port number used by the endpoint.",
476 "longDescription": "This property shall contain an specify UDP or TCP port number used for communication with the endpoint.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700477 "maximum": 65535,
478 "minimum": 0,
479 "readonly": true,
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600480 "type": "number",
481 "versionAdded": "v1_1_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700482 },
483 "TransportProtocol": {
484 "$ref": "http://redfish.dmtf.org/schemas/v1/Protocol.json#/definitions/Protocol",
485 "description": "The protocol used by the connection entity.",
Ed Tanouscb103132019-10-08 11:34:22 -0700486 "longDescription": "This property shall contain the protocol used by the connection entity.",
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600487 "readonly": true,
488 "versionAdded": "v1_1_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700489 }
490 },
491 "type": "object"
492 },
493 "Links": {
494 "additionalProperties": false,
Ed Tanouscb103132019-10-08 11:34:22 -0700495 "description": "The links to other Resources that are related to this Resource.",
496 "longDescription": "The Redfish Specification-described type shall contain links to Resources related to but not subordinate to this Resource.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700497 "patternProperties": {
Ed Tanouscb103132019-10-08 11:34:22 -0700498 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
Ed Tanous118b1c72018-09-13 13:45:51 -0700499 "description": "This property shall specify a valid odata or Redfish property.",
500 "type": [
501 "array",
502 "boolean",
Ed Tanous530520e2019-01-02 13:41:37 -0800503 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -0700504 "number",
505 "null",
506 "object",
507 "string"
508 ]
509 }
510 },
511 "properties": {
Gunnar Mills09b9d452020-02-11 13:27:39 -0600512 "AddressPools": {
513 "description": "An array of links to the address pools associated with this endpoint.",
514 "items": {
515 "$ref": "http://redfish.dmtf.org/schemas/v1/AddressPool.json#/definitions/AddressPool"
516 },
517 "longDescription": "This property shall contain an array of links to Resources of type AddressPool with which this endpoint is associated.",
518 "readonly": false,
519 "type": "array",
520 "versionAdded": "v1_4_0"
521 },
522 "AddressPools@odata.count": {
523 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
524 },
525 "ConnectedPorts": {
526 "description": "An array of links to the ports that connect to this endpoint.",
527 "items": {
528 "$ref": "http://redfish.dmtf.org/schemas/v1/Port.json#/definitions/Port"
529 },
530 "longDescription": "This property shall contain an array of links to Resources of type Port that represent ports associated with this endpoint.",
531 "readonly": true,
532 "type": "array",
533 "versionAdded": "v1_4_0"
534 },
535 "ConnectedPorts@odata.count": {
536 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
537 },
Ed Tanous118b1c72018-09-13 13:45:51 -0700538 "MutuallyExclusiveEndpoints": {
Ed Tanouscb103132019-10-08 11:34:22 -0700539 "description": "An array of links to the endpoints that may not be used in zones if this endpoint is in a zone.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700540 "items": {
541 "$ref": "http://redfish.dmtf.org/schemas/v1/Endpoint.json#/definitions/Endpoint"
542 },
Ed Tanouscb103132019-10-08 11:34:22 -0700543 "longDescription": "This property shall contain an array of links of the Endpoint type that cannot be used in a zone if this endpoint is in a zone.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700544 "readonly": true,
545 "type": "array"
546 },
547 "MutuallyExclusiveEndpoints@odata.count": {
Ed Tanouscb103132019-10-08 11:34:22 -0700548 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
Ed Tanous118b1c72018-09-13 13:45:51 -0700549 },
550 "NetworkDeviceFunction": {
Ed Tanouscb103132019-10-08 11:34:22 -0700551 "description": "When NetworkDeviceFunction Resources are present, this array contains links to the network device functions that connect to this endpoint.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700552 "items": {
553 "$ref": "http://redfish.dmtf.org/schemas/v1/NetworkDeviceFunction.json#/definitions/NetworkDeviceFunction"
554 },
Ed Tanouscb103132019-10-08 11:34:22 -0700555 "longDescription": "This property shall contain a link to a NetworkDeviceFunction Resource, with which this endpoint is associated.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700556 "readonly": true,
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600557 "type": "array",
558 "versionAdded": "v1_1_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700559 },
560 "NetworkDeviceFunction@odata.count": {
Ed Tanouscb103132019-10-08 11:34:22 -0700561 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
Ed Tanous118b1c72018-09-13 13:45:51 -0700562 },
563 "Oem": {
564 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
Ed Tanouscb103132019-10-08 11:34:22 -0700565 "description": "The OEM extension property.",
566 "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 -0700567 },
568 "Ports": {
Ed Tanouscb103132019-10-08 11:34:22 -0700569 "description": "An array of links to the physical ports associated with this endpoint.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700570 "items": {
571 "$ref": "http://redfish.dmtf.org/schemas/v1/Port.json#/definitions/Port"
572 },
Ed Tanouscb103132019-10-08 11:34:22 -0700573 "longDescription": "This property shall contain an array of links of the Port type that are utilized by this endpoint.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700574 "readonly": true,
575 "type": "array"
576 },
577 "Ports@odata.count": {
Ed Tanouscb103132019-10-08 11:34:22 -0700578 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
Ed Tanous118b1c72018-09-13 13:45:51 -0700579 }
580 },
581 "type": "object"
582 },
583 "OemActions": {
584 "additionalProperties": true,
Ed Tanouscb103132019-10-08 11:34:22 -0700585 "description": "The available OEM-specific actions for this Resource.",
586 "longDescription": "This type shall contain the available OEM-specific actions for this Resource.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700587 "patternProperties": {
Ed Tanouscb103132019-10-08 11:34:22 -0700588 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
Ed Tanous118b1c72018-09-13 13:45:51 -0700589 "description": "This property shall specify a valid odata or Redfish property.",
590 "type": [
591 "array",
592 "boolean",
Ed Tanous530520e2019-01-02 13:41:37 -0800593 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -0700594 "number",
595 "null",
596 "object",
597 "string"
598 ]
599 }
600 },
601 "properties": {},
602 "type": "object"
603 },
604 "PciId": {
605 "additionalProperties": false,
606 "description": "A PCI ID.",
607 "longDescription": "This type shall describe a PCI ID.",
608 "patternProperties": {
Ed Tanouscb103132019-10-08 11:34:22 -0700609 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
Ed Tanous118b1c72018-09-13 13:45:51 -0700610 "description": "This property shall specify a valid odata or Redfish property.",
611 "type": [
612 "array",
613 "boolean",
Ed Tanous530520e2019-01-02 13:41:37 -0800614 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -0700615 "number",
616 "null",
617 "object",
618 "string"
619 ]
620 }
621 },
622 "properties": {
Ed Tanous530520e2019-01-02 13:41:37 -0800623 "ClassCode": {
Ed Tanouscb103132019-10-08 11:34:22 -0700624 "description": "The Class Code, Subclass, and Programming Interface code of this PCIe function.",
625 "longDescription": "This property shall contain the PCI Class Code, Subclass, and Programming Interface of the PCIe device function.",
Ed Tanous530520e2019-01-02 13:41:37 -0800626 "pattern": "^0[xX](([a-fA-F]|[0-9]){2}){3}$",
627 "readonly": true,
628 "type": [
629 "string",
630 "null"
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600631 ],
632 "versionAdded": "v1_2_0"
Ed Tanous530520e2019-01-02 13:41:37 -0800633 },
Ed Tanous118b1c72018-09-13 13:45:51 -0700634 "DeviceId": {
635 "description": "The Device ID of this PCIe function.",
Ed Tanouscb103132019-10-08 11:34:22 -0700636 "longDescription": "This property shall contain the PCI Device ID of the PCIe device function.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700637 "pattern": "^0[xX](([a-fA-F]|[0-9]){2}){2}$",
638 "readonly": true,
639 "type": [
640 "string",
641 "null"
642 ]
643 },
Ed Tanous530520e2019-01-02 13:41:37 -0800644 "FunctionNumber": {
645 "description": "The PCI ID of the connected entity.",
Ed Tanouscb103132019-10-08 11:34:22 -0700646 "longDescription": "This property shall contain the PCI Function Number of the connected PCIe entity.",
Ed Tanous530520e2019-01-02 13:41:37 -0800647 "readonly": true,
648 "type": [
649 "integer",
650 "null"
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600651 ],
652 "versionAdded": "v1_2_0"
Ed Tanous530520e2019-01-02 13:41:37 -0800653 },
Ed Tanous118b1c72018-09-13 13:45:51 -0700654 "SubsystemId": {
655 "description": "The Subsystem ID of this PCIe function.",
Ed Tanouscb103132019-10-08 11:34:22 -0700656 "longDescription": "This property shall contain the PCI Subsystem Vendor ID of the PCIe device function.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700657 "pattern": "^0[xX](([a-fA-F]|[0-9]){2}){2}$",
658 "readonly": true,
659 "type": [
660 "string",
661 "null"
662 ]
663 },
664 "SubsystemVendorId": {
665 "description": "The Subsystem Vendor ID of this PCIe function.",
Ed Tanouscb103132019-10-08 11:34:22 -0700666 "longDescription": "This property shall contain the PCI Subsystem Vendor ID of the PCIe device function.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700667 "pattern": "^0[xX](([a-fA-F]|[0-9]){2}){2}$",
668 "readonly": true,
669 "type": [
670 "string",
671 "null"
672 ]
673 },
674 "VendorId": {
675 "description": "The Vendor ID of this PCIe function.",
Ed Tanouscb103132019-10-08 11:34:22 -0700676 "longDescription": "This property shall contain the PCI Vendor ID of the PCIe device function.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700677 "pattern": "^0[xX](([a-fA-F]|[0-9]){2}){2}$",
678 "readonly": true,
679 "type": [
680 "string",
681 "null"
682 ]
683 }
684 },
685 "type": "object"
686 }
687 },
Ed Tanous530520e2019-01-02 13:41:37 -0800688 "owningEntity": "DMTF",
Gunnar Mills09b9d452020-02-11 13:27:39 -0600689 "release": "2019.4",
690 "title": "#Endpoint.v1_4_0.Endpoint"
Ed Tanous118b1c72018-09-13 13:45:51 -0700691}