blob: 422ec2561908236d9ed0c91802dc4f0ac27f8f7c [file] [log] [blame]
Ed Tanous118b1c72018-09-13 13:45:51 -07001{
Gunnar Mills262d7d42021-01-20 16:28:41 -06002 "$id": "http://redfish.dmtf.org/schemas/v1/Endpoint.v1_5_1.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",
Gunnar Millsa778c022020-05-12 12:20:36 -05005 "copyright": "Copyright 2014-2020 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,
Gunnar Millsa778c022020-05-12 12:20:36 -05009 "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",
Gunnar Millsa778c022020-05-12 12:20:36 -050028 "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,
Gunnar Millsa778c022020-05-12 12:20:36 -050036 "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 },
Gunnar Millsa778c022020-05-12 12:20:36 -0500108 "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,
Gunnar Millsa778c022020-05-12 12:20:36 -0500144 "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",
Gunnar Millsa778c022020-05-12 12:20:36 -0500175 "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",
Gunnar Millsa778c022020-05-12 12:20:36 -0500243 "description": "The links to other resources that are related to this resource.",
244 "longDescription": "This property shall contain links to resources that are related to but are not contained by, or 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",
Gunnar Millsa778c022020-05-12 12:20:36 -0500274 "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",
Asmitha Karunanithic8ccb772020-09-22 10:56:46 -0500314 "FabricBridge",
315 "Manager"
Ed Tanous118b1c72018-09-13 13:45:51 -0700316 ],
317 "enumDescriptions": {
Ed Tanouscb103132019-10-08 11:34:22 -0700318 "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 -0700319 "Bridge": "The entity is a PCI(e) bridge.",
320 "DisplayController": "The entity is a display controller.",
Ed Tanouscb103132019-10-08 11:34:22 -0700321 "Drive": "The entity is a disk drive. The EntityLink property, if present, should be a Drive type.",
Gunnar Mills09b9d452020-02-11 13:27:39 -0600322 "FabricBridge": "The entity is a fabric bridge. The EntityLink property, if present, should be a FabricAdapter type.",
Asmitha Karunanithic8ccb772020-09-22 10:56:46 -0500323 "Manager": "The entity is a manager. The EntityLink property, if present, should be a Manager type.",
Gunnar Mills09b9d452020-02-11 13:27:39 -0600324 "MediaController": "The entity is a media controller. The EntityLink property, if present, should be a MediaController type.",
325 "MemoryChunk": "The entity is a memory chunk. The EntityLink property, if present, should be a MemoryChunk type.",
Ed Tanouscb103132019-10-08 11:34:22 -0700326 "NetworkController": "The entity is a network controller. The EntityLink property, if present, should contain an EthernetInterface type.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700327 "Processor": "The entity is a processor device.",
Ed Tanouscb103132019-10-08 11:34:22 -0700328 "RootComplex": "The entity is a PCI(e) root complex. The EntityLink property, if present, should be a ComputerSystem type.",
329 "StorageExpander": "The entity is a storage expander. The EntityLink property, if present, should be a Chassis type.",
Gunnar Millsa778c022020-05-12 12:20:36 -0500330 "StorageInitiator": "The entity is a storage initiator. The EntityLink property, if present, should be a StorageController type.",
Gunnar Mills09b9d452020-02-11 13:27:39 -0600331 "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 -0700332 "Volume": "The entity is a volume. The EntityLink property, if present, should be a Volume type."
Ed Tanous118b1c72018-09-13 13:45:51 -0700333 },
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600334 "enumVersionAdded": {
335 "AccelerationFunction": "v1_3_0",
Gunnar Mills09b9d452020-02-11 13:27:39 -0600336 "FabricBridge": "v1_4_0",
Asmitha Karunanithic8ccb772020-09-22 10:56:46 -0500337 "Manager": "v1_5_0",
Gunnar Mills09b9d452020-02-11 13:27:39 -0600338 "MediaController": "v1_4_0",
339 "MemoryChunk": "v1_4_0",
340 "Switch": "v1_4_0",
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600341 "Volume": "v1_1_0"
342 },
Ed Tanous118b1c72018-09-13 13:45:51 -0700343 "type": "string"
344 },
Gunnar Mills09b9d452020-02-11 13:27:39 -0600345 "GCID": {
346 "additionalProperties": false,
347 "description": "The Global Component ID (GCID).",
348 "longDescription": "This type shall contain the Gen-Z Core Specification-defined Global Component ID.",
349 "patternProperties": {
350 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
351 "description": "This property shall specify a valid odata or Redfish property.",
352 "type": [
353 "array",
354 "boolean",
355 "integer",
356 "number",
357 "null",
358 "object",
359 "string"
360 ]
361 }
362 },
363 "properties": {
364 "CID": {
365 "description": "The component identifier portion of the GCID for the entity.",
366 "longDescription": "This property shall contain the 12 bit component identifier portion of the GCID of the entity.",
367 "pattern": "^0[xX]([a-fA-F]|[0-9]){3}$",
368 "readonly": false,
369 "type": [
370 "string",
371 "null"
372 ],
373 "versionAdded": "v1_4_0"
374 },
375 "SID": {
376 "description": "The subnet identifier portion of the GCID for the entity.",
377 "longDescription": "This property shall contain the 16 bit subnet identifier portion of the GCID of the entity.",
378 "pattern": "^0[xX](([a-fA-F]|[0-9]){2}){2}$",
379 "readonly": false,
380 "type": [
381 "string",
382 "null"
383 ],
384 "versionAdded": "v1_4_0"
385 }
386 },
387 "type": "object"
388 },
389 "GenZ": {
390 "additionalProperties": false,
391 "description": "The Gen-Z related properties for an entity.",
392 "longDescription": "This type shall contain the Gen-Z related properties for an entity.",
393 "patternProperties": {
394 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
395 "description": "This property shall specify a valid odata or Redfish property.",
396 "type": [
397 "array",
398 "boolean",
399 "integer",
400 "number",
401 "null",
402 "object",
403 "string"
404 ]
405 }
406 },
407 "properties": {
408 "AccessKey": {
409 "description": "The Access Key for the entity.",
410 "longDescription": "This property shall contain the Gen-Z Core Specification-defined 6 bit Access Key for the entity.",
411 "pattern": "^0[xX]([a-fA-F]|[0-9]){2}$",
412 "readonly": false,
413 "type": [
414 "string",
415 "null"
416 ],
417 "versionAdded": "v1_4_0"
418 },
419 "GCID": {
420 "anyOf": [
421 {
422 "$ref": "#/definitions/GCID"
423 },
424 {
425 "type": "null"
426 }
427 ],
428 "description": "The Global Component ID (GCID) for the entity.",
429 "longDescription": "This property shall contain the Gen-Z Core Specification-defined Global Component ID for the entity.",
430 "versionAdded": "v1_4_0"
431 },
432 "RegionKey": {
433 "description": "The Region Key for the entity.",
434 "longDescription": "This property shall contain the Gen-Z Core Specification-defined 32 bit Region Key for the entity.",
435 "pattern": "^0[xX](([a-fA-F]|[0-9]){2}){4}$",
436 "readonly": false,
437 "type": [
438 "string",
439 "null"
440 ],
441 "versionAdded": "v1_4_0"
442 }
443 },
444 "type": "object"
445 },
Ed Tanous118b1c72018-09-13 13:45:51 -0700446 "IPTransportDetails": {
447 "additionalProperties": false,
Ed Tanouscb103132019-10-08 11:34:22 -0700448 "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.",
449 "longDescription": "The type shall contain properties that specify the details of the transport supported by the endpoint.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700450 "patternProperties": {
Ed Tanouscb103132019-10-08 11:34:22 -0700451 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
Ed Tanous118b1c72018-09-13 13:45:51 -0700452 "description": "This property shall specify a valid odata or Redfish property.",
453 "type": [
454 "array",
455 "boolean",
Ed Tanous530520e2019-01-02 13:41:37 -0800456 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -0700457 "number",
458 "null",
459 "object",
460 "string"
461 ]
462 }
463 },
464 "properties": {
465 "IPv4Address": {
466 "$ref": "http://redfish.dmtf.org/schemas/v1/IPAddresses.json#/definitions/IPv4Address",
Ed Tanouscb103132019-10-08 11:34:22 -0700467 "description": "The IPv4 addresses assigned to the endpoint.",
468 "longDescription": "This property shall contain the IPv4Address.",
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600469 "versionAdded": "v1_1_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700470 },
471 "IPv6Address": {
472 "$ref": "http://redfish.dmtf.org/schemas/v1/IPAddresses.json#/definitions/IPv6Address",
Ed Tanouscb103132019-10-08 11:34:22 -0700473 "description": "The IPv6 addresses assigned to the endpoint.",
474 "longDescription": "This property shall contain the IPv6Address.",
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600475 "versionAdded": "v1_1_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700476 },
477 "Port": {
Ed Tanouscb103132019-10-08 11:34:22 -0700478 "description": "The UDP or TCP port number used by the endpoint.",
479 "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 -0700480 "maximum": 65535,
481 "minimum": 0,
482 "readonly": true,
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600483 "type": "number",
484 "versionAdded": "v1_1_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700485 },
486 "TransportProtocol": {
487 "$ref": "http://redfish.dmtf.org/schemas/v1/Protocol.json#/definitions/Protocol",
488 "description": "The protocol used by the connection entity.",
Ed Tanouscb103132019-10-08 11:34:22 -0700489 "longDescription": "This property shall contain the protocol used by the connection entity.",
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600490 "readonly": true,
491 "versionAdded": "v1_1_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700492 }
493 },
494 "type": "object"
495 },
496 "Links": {
497 "additionalProperties": false,
Gunnar Millsa778c022020-05-12 12:20:36 -0500498 "description": "The links to other resources that are related to this resource.",
499 "longDescription": "This Redfish Specification-described type shall contain links to resources that are related to but are not contained by, or subordinate to, this resource.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700500 "patternProperties": {
Ed Tanouscb103132019-10-08 11:34:22 -0700501 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
Ed Tanous118b1c72018-09-13 13:45:51 -0700502 "description": "This property shall specify a valid odata or Redfish property.",
503 "type": [
504 "array",
505 "boolean",
Ed Tanous530520e2019-01-02 13:41:37 -0800506 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -0700507 "number",
508 "null",
509 "object",
510 "string"
511 ]
512 }
513 },
514 "properties": {
Gunnar Mills09b9d452020-02-11 13:27:39 -0600515 "AddressPools": {
516 "description": "An array of links to the address pools associated with this endpoint.",
517 "items": {
518 "$ref": "http://redfish.dmtf.org/schemas/v1/AddressPool.json#/definitions/AddressPool"
519 },
Gunnar Millsa778c022020-05-12 12:20:36 -0500520 "longDescription": "This property shall contain an array of links to resources of type AddressPool with which this endpoint is associated.",
Gunnar Mills09b9d452020-02-11 13:27:39 -0600521 "readonly": false,
522 "type": "array",
523 "versionAdded": "v1_4_0"
524 },
525 "AddressPools@odata.count": {
526 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
527 },
528 "ConnectedPorts": {
529 "description": "An array of links to the ports that connect to this endpoint.",
530 "items": {
531 "$ref": "http://redfish.dmtf.org/schemas/v1/Port.json#/definitions/Port"
532 },
Gunnar Millsa778c022020-05-12 12:20:36 -0500533 "longDescription": "This property shall contain an array of links to resources of type Port that represent ports associated with this endpoint.",
Gunnar Mills09b9d452020-02-11 13:27:39 -0600534 "readonly": true,
535 "type": "array",
536 "versionAdded": "v1_4_0"
537 },
538 "ConnectedPorts@odata.count": {
539 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
540 },
Asmitha Karunanithic8ccb772020-09-22 10:56:46 -0500541 "Connections": {
542 "description": "The connections to which this endpoint belongs.",
543 "items": {
544 "$ref": "http://redfish.dmtf.org/schemas/v1/Connection.json#/definitions/Connection"
545 },
546 "longDescription": "This property shall contain an array of links to resources of type Connection that represent the connections to which this endpoint belongs.",
547 "readonly": true,
548 "type": "array",
549 "versionAdded": "v1_5_0"
550 },
551 "Connections@odata.count": {
552 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
553 },
Ed Tanous118b1c72018-09-13 13:45:51 -0700554 "MutuallyExclusiveEndpoints": {
Gunnar Mills844b4152020-06-22 12:44:09 -0500555 "description": "An array of links to the endpoints that cannot be used in zones if this endpoint is in a zone.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700556 "items": {
557 "$ref": "http://redfish.dmtf.org/schemas/v1/Endpoint.json#/definitions/Endpoint"
558 },
Gunnar Millsa778c022020-05-12 12:20:36 -0500559 "longDescription": "This property shall contain an array of links to resources of type Endpoint that cannot be used in a zone if this endpoint is in a zone.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700560 "readonly": true,
561 "type": "array"
562 },
563 "MutuallyExclusiveEndpoints@odata.count": {
Ed Tanouscb103132019-10-08 11:34:22 -0700564 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
Ed Tanous118b1c72018-09-13 13:45:51 -0700565 },
566 "NetworkDeviceFunction": {
Gunnar Millsa778c022020-05-12 12:20:36 -0500567 "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 -0700568 "items": {
569 "$ref": "http://redfish.dmtf.org/schemas/v1/NetworkDeviceFunction.json#/definitions/NetworkDeviceFunction"
570 },
Gunnar Millsa778c022020-05-12 12:20:36 -0500571 "longDescription": "This property shall contain an array of links to resources of type NetworkDeviceFunction with which this endpoint is associated.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700572 "readonly": true,
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600573 "type": "array",
574 "versionAdded": "v1_1_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700575 },
576 "NetworkDeviceFunction@odata.count": {
Ed Tanouscb103132019-10-08 11:34:22 -0700577 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
Ed Tanous118b1c72018-09-13 13:45:51 -0700578 },
579 "Oem": {
580 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
Ed Tanouscb103132019-10-08 11:34:22 -0700581 "description": "The OEM extension property.",
582 "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 -0700583 },
584 "Ports": {
Ed Tanouscb103132019-10-08 11:34:22 -0700585 "description": "An array of links to the physical ports associated with this endpoint.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700586 "items": {
587 "$ref": "http://redfish.dmtf.org/schemas/v1/Port.json#/definitions/Port"
588 },
Gunnar Millsa778c022020-05-12 12:20:36 -0500589 "longDescription": "This property shall contain an array of links to resources of type Port that are utilized by this endpoint.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700590 "readonly": true,
591 "type": "array"
592 },
593 "Ports@odata.count": {
Ed Tanouscb103132019-10-08 11:34:22 -0700594 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
Ed Tanous118b1c72018-09-13 13:45:51 -0700595 }
596 },
597 "type": "object"
598 },
599 "OemActions": {
600 "additionalProperties": true,
Gunnar Millsa778c022020-05-12 12:20:36 -0500601 "description": "The available OEM-specific actions for this resource.",
602 "longDescription": "This type shall contain the available OEM-specific actions for this resource.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700603 "patternProperties": {
Ed Tanouscb103132019-10-08 11:34:22 -0700604 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
Ed Tanous118b1c72018-09-13 13:45:51 -0700605 "description": "This property shall specify a valid odata or Redfish property.",
606 "type": [
607 "array",
608 "boolean",
Ed Tanous530520e2019-01-02 13:41:37 -0800609 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -0700610 "number",
611 "null",
612 "object",
613 "string"
614 ]
615 }
616 },
617 "properties": {},
618 "type": "object"
619 },
620 "PciId": {
621 "additionalProperties": false,
622 "description": "A PCI ID.",
623 "longDescription": "This type shall describe a PCI ID.",
624 "patternProperties": {
Ed Tanouscb103132019-10-08 11:34:22 -0700625 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
Ed Tanous118b1c72018-09-13 13:45:51 -0700626 "description": "This property shall specify a valid odata or Redfish property.",
627 "type": [
628 "array",
629 "boolean",
Ed Tanous530520e2019-01-02 13:41:37 -0800630 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -0700631 "number",
632 "null",
633 "object",
634 "string"
635 ]
636 }
637 },
638 "properties": {
Ed Tanous530520e2019-01-02 13:41:37 -0800639 "ClassCode": {
Ed Tanouscb103132019-10-08 11:34:22 -0700640 "description": "The Class Code, Subclass, and Programming Interface code of this PCIe function.",
641 "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 -0800642 "pattern": "^0[xX](([a-fA-F]|[0-9]){2}){3}$",
643 "readonly": true,
644 "type": [
645 "string",
646 "null"
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600647 ],
648 "versionAdded": "v1_2_0"
Ed Tanous530520e2019-01-02 13:41:37 -0800649 },
Ed Tanous118b1c72018-09-13 13:45:51 -0700650 "DeviceId": {
651 "description": "The Device ID of this PCIe function.",
Ed Tanouscb103132019-10-08 11:34:22 -0700652 "longDescription": "This property shall contain the PCI Device ID of the PCIe device function.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700653 "pattern": "^0[xX](([a-fA-F]|[0-9]){2}){2}$",
654 "readonly": true,
655 "type": [
656 "string",
657 "null"
658 ]
659 },
Ed Tanous530520e2019-01-02 13:41:37 -0800660 "FunctionNumber": {
661 "description": "The PCI ID of the connected entity.",
Ed Tanouscb103132019-10-08 11:34:22 -0700662 "longDescription": "This property shall contain the PCI Function Number of the connected PCIe entity.",
Ed Tanous530520e2019-01-02 13:41:37 -0800663 "readonly": true,
664 "type": [
665 "integer",
666 "null"
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600667 ],
668 "versionAdded": "v1_2_0"
Ed Tanous530520e2019-01-02 13:41:37 -0800669 },
Ed Tanous118b1c72018-09-13 13:45:51 -0700670 "SubsystemId": {
671 "description": "The Subsystem ID of this PCIe function.",
Ed Tanouscb103132019-10-08 11:34:22 -0700672 "longDescription": "This property shall contain the PCI Subsystem Vendor ID of the PCIe device function.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700673 "pattern": "^0[xX](([a-fA-F]|[0-9]){2}){2}$",
674 "readonly": true,
675 "type": [
676 "string",
677 "null"
678 ]
679 },
680 "SubsystemVendorId": {
681 "description": "The Subsystem Vendor ID of this PCIe function.",
Ed Tanouscb103132019-10-08 11:34:22 -0700682 "longDescription": "This property shall contain the PCI Subsystem Vendor ID of the PCIe device function.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700683 "pattern": "^0[xX](([a-fA-F]|[0-9]){2}){2}$",
684 "readonly": true,
685 "type": [
686 "string",
687 "null"
688 ]
689 },
690 "VendorId": {
691 "description": "The Vendor ID of this PCIe function.",
Ed Tanouscb103132019-10-08 11:34:22 -0700692 "longDescription": "This property shall contain the PCI Vendor ID of the PCIe device function.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700693 "pattern": "^0[xX](([a-fA-F]|[0-9]){2}){2}$",
694 "readonly": true,
695 "type": [
696 "string",
697 "null"
698 ]
699 }
700 },
701 "type": "object"
702 }
703 },
Ed Tanous530520e2019-01-02 13:41:37 -0800704 "owningEntity": "DMTF",
Asmitha Karunanithic8ccb772020-09-22 10:56:46 -0500705 "release": "2020.3",
Gunnar Mills262d7d42021-01-20 16:28:41 -0600706 "title": "#Endpoint.v1_5_1.Endpoint"
Ed Tanous118b1c72018-09-13 13:45:51 -0700707}