1{
2    "$id": "http://redfish.dmtf.org/schemas/v1/FabricAdapter.v1_5_3.json",
3    "$ref": "#/definitions/FabricAdapter",
4    "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
5    "copyright": "Copyright 2014-2024 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright",
6    "definitions": {
7        "Actions": {
8            "additionalProperties": false,
9            "description": "The available actions for this resource.",
10            "longDescription": "This type shall contain the available actions for this resource.",
11            "patternProperties": {
12                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
13                    "description": "This property shall specify a valid odata or Redfish property.",
14                    "type": [
15                        "array",
16                        "boolean",
17                        "integer",
18                        "number",
19                        "null",
20                        "object",
21                        "string"
22                    ]
23                }
24            },
25            "properties": {
26                "Oem": {
27                    "$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."
30                }
31            },
32            "type": "object"
33        },
34        "FabricAdapter": {
35            "additionalProperties": false,
36            "description": "A fabric adapter represents the physical fabric adapter capable of connecting to an interconnect fabric.  Examples include, but are not limited to, Ethernet, NVMe over Fabrics, Gen-Z, and SAS fabric adapters.",
37            "longDescription": "This resource shall represent a physical fabric adapter capable of connecting to an interconnect fabric.",
38            "patternProperties": {
39                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
40                    "description": "This property shall specify a valid odata or Redfish property.",
41                    "type": [
42                        "array",
43                        "boolean",
44                        "integer",
45                        "number",
46                        "null",
47                        "object",
48                        "string"
49                    ]
50                }
51            },
52            "properties": {
53                "@odata.context": {
54                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context"
55                },
56                "@odata.etag": {
57                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag"
58                },
59                "@odata.id": {
60                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id"
61                },
62                "@odata.type": {
63                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type"
64                },
65                "ASICManufacturer": {
66                    "description": "The manufacturer name for the ASIC of this fabric adapter.",
67                    "longDescription": "This property shall contain the manufacturer name of the ASIC for the fabric adapter as defined by the manufacturer.",
68                    "readonly": true,
69                    "type": [
70                        "string",
71                        "null"
72                    ]
73                },
74                "ASICPartNumber": {
75                    "description": "The part number for the ASIC on this fabric adapter.",
76                    "longDescription": "This property shall contain the part number of the ASIC for the fabric adapter as defined by the manufacturer.",
77                    "readonly": true,
78                    "type": [
79                        "string",
80                        "null"
81                    ]
82                },
83                "ASICRevisionIdentifier": {
84                    "description": "The revision identifier for the ASIC on this fabric adapter.",
85                    "longDescription": "This property shall contain the revision identifier of the ASIC for the fabric adapter as defined by the manufacturer.",
86                    "readonly": true,
87                    "type": [
88                        "string",
89                        "null"
90                    ]
91                },
92                "Actions": {
93                    "$ref": "#/definitions/Actions",
94                    "description": "The available actions for this resource.",
95                    "longDescription": "This property shall contain the available actions for this resource."
96                },
97                "Description": {
98                    "anyOf": [
99                        {
100                            "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
101                        },
102                        {
103                            "type": "null"
104                        }
105                    ],
106                    "readonly": true
107                },
108                "FabricType": {
109                    "$ref": "http://redfish.dmtf.org/schemas/v1/Protocol.json#/definitions/Protocol",
110                    "description": "The configured fabric type of this fabric adapter.",
111                    "longDescription": "This property shall contain the configured fabric type of this fabric adapter.",
112                    "readonly": false,
113                    "versionAdded": "v1_3_0"
114                },
115                "FabricTypeCapabilities": {
116                    "description": "An array of fabric types supported by this fabric adapter.",
117                    "items": {
118                        "$ref": "http://redfish.dmtf.org/schemas/v1/Protocol.json#/definitions/Protocol"
119                    },
120                    "longDescription": "This property shall contain an array of fabric types supported by this fabric adapter.",
121                    "readonly": true,
122                    "type": "array",
123                    "versionAdded": "v1_3_0"
124                },
125                "FirmwareVersion": {
126                    "description": "The firmware version of this fabric adapter.",
127                    "longDescription": "This property shall contain the firmware version for the fabric adapter as defined by the manufacturer.",
128                    "readonly": true,
129                    "type": [
130                        "string",
131                        "null"
132                    ]
133                },
134                "GenZ": {
135                    "$ref": "#/definitions/GenZ",
136                    "description": "The Gen-Z specific properties for this fabric adapter.",
137                    "longDescription": "This property shall contain the Gen-Z specific properties for this fabric adapter."
138                },
139                "Id": {
140                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
141                    "readonly": true
142                },
143                "Links": {
144                    "$ref": "#/definitions/Links",
145                    "description": "The links to other resources that are related to this resource.",
146                    "longDescription": "This property shall contain links to resources that are related to but are not contained by, or subordinate to, this resource."
147                },
148                "Location": {
149                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Location",
150                    "description": "The location of the fabric adapter.",
151                    "longDescription": "This property shall contain the location information of the fabric adapter.",
152                    "versionAdded": "v1_1_0"
153                },
154                "LocationIndicatorActive": {
155                    "description": "An indicator allowing an operator to physically locate this resource.",
156                    "longDescription": "This property shall contain the state of the indicator used to physically identify or locate this resource.",
157                    "readonly": false,
158                    "type": [
159                        "boolean",
160                        "null"
161                    ],
162                    "versionAdded": "v1_4_0"
163                },
164                "Manufacturer": {
165                    "description": "The manufacturer or OEM of this fabric adapter.",
166                    "longDescription": "This property shall contain a value that represents the manufacturer of the fabric adapter.",
167                    "readonly": true,
168                    "type": [
169                        "string",
170                        "null"
171                    ]
172                },
173                "Model": {
174                    "description": "The model string for this fabric adapter.",
175                    "longDescription": "This property shall contain the information about how the manufacturer refers to this fabric adapter.",
176                    "readonly": true,
177                    "type": [
178                        "string",
179                        "null"
180                    ]
181                },
182                "Name": {
183                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
184                    "readonly": true
185                },
186                "Oem": {
187                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
188                    "description": "The OEM extension property.",
189                    "longDescription": "This property shall contain the OEM extensions.  All values for properties that this object contains shall conform to the Redfish Specification-described requirements."
190                },
191                "PCIeInterface": {
192                    "$ref": "http://redfish.dmtf.org/schemas/v1/PCIeDevice.json#/definitions/PCIeInterface",
193                    "description": "The PCIe interface details for this fabric adapter.",
194                    "longDescription": "This property shall contain details on the PCIe interface that connects this PCIe-based fabric adapter to its host."
195                },
196                "PartNumber": {
197                    "description": "The part number for this fabric adapter.",
198                    "longDescription": "This property shall contain the part number for the fabric adapter as defined by the manufacturer.",
199                    "readonly": true,
200                    "type": [
201                        "string",
202                        "null"
203                    ]
204                },
205                "Ports": {
206                    "$ref": "http://redfish.dmtf.org/schemas/v1/PortCollection.json#/definitions/PortCollection",
207                    "description": "The link to the collection of ports that exist on the fabric adapter.",
208                    "longDescription": "This property shall contain a link to a resource collection of type `PortCollection`.",
209                    "readonly": true
210                },
211                "SKU": {
212                    "description": "The manufacturer SKU for this fabric adapter.",
213                    "longDescription": "This property shall contain the SKU for the fabric adapter.",
214                    "readonly": true,
215                    "type": [
216                        "string",
217                        "null"
218                    ]
219                },
220                "SerialNumber": {
221                    "description": "The serial number for this fabric adapter.",
222                    "longDescription": "This property shall contain the serial number for the fabric adapter.",
223                    "readonly": true,
224                    "type": [
225                        "string",
226                        "null"
227                    ]
228                },
229                "SparePartNumber": {
230                    "description": "The spare part number for this fabric adapter.",
231                    "longDescription": "This property shall contain the spare part number for the fabric adapter as defined by the manufacturer.",
232                    "readonly": true,
233                    "type": [
234                        "string",
235                        "null"
236                    ]
237                },
238                "Status": {
239                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status",
240                    "description": "The status and health of the resource and its subordinate or dependent resources.",
241                    "longDescription": "This property shall contain any status or health properties of the resource."
242                },
243                "UUID": {
244                    "anyOf": [
245                        {
246                            "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/UUID"
247                        },
248                        {
249                            "type": "null"
250                        }
251                    ],
252                    "description": "The UUID for this fabric adapter.",
253                    "longDescription": "This property shall contain a universally unique identifier number for the fabric adapter.",
254                    "readonly": true
255                }
256            },
257            "required": [
258                "@odata.id",
259                "@odata.type",
260                "Id",
261                "Name"
262            ],
263            "type": "object"
264        },
265        "GenZ": {
266            "additionalProperties": false,
267            "description": "Gen-Z related properties for a fabric adapter.",
268            "longDescription": "This type shall contain Gen-Z related properties for a fabric adapter.",
269            "patternProperties": {
270                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
271                    "description": "This property shall specify a valid odata or Redfish property.",
272                    "type": [
273                        "array",
274                        "boolean",
275                        "integer",
276                        "number",
277                        "null",
278                        "object",
279                        "string"
280                    ]
281                }
282            },
283            "properties": {
284                "MSDT": {
285                    "$ref": "http://redfish.dmtf.org/schemas/v1/RouteEntryCollection.json#/definitions/RouteEntryCollection",
286                    "description": "The Multi Subnet Destination Table for the component.",
287                    "longDescription": "This property shall contain a link to a resource collection of type `RouteEntryCollection` that represents the Gen-Z Core Specification-defined MSDT structure.",
288                    "readonly": true
289                },
290                "PIDT": {
291                    "description": "An array of table entry values for the Packet Injection Delay Table.",
292                    "items": {
293                        "type": [
294                            "string",
295                            "null"
296                        ]
297                    },
298                    "longDescription": "This property shall contain an array of table entry values for the Gen-Z Core Specification-defined Packet Injection Delay Table for the component.",
299                    "readonly": false,
300                    "type": "array"
301                },
302                "RITable": {
303                    "description": "An array of table entry values for the Responder Interface Table.",
304                    "items": {
305                        "type": [
306                            "string",
307                            "null"
308                        ]
309                    },
310                    "longDescription": "This property shall contain an array of table entry values for the Gen-Z Core Specification-defined Responder Interface Table for the component.",
311                    "readonly": false,
312                    "type": "array"
313                },
314                "RequestorVCAT": {
315                    "$ref": "http://redfish.dmtf.org/schemas/v1/VCATEntryCollection.json#/definitions/VCATEntryCollection",
316                    "description": "The Requestor Virtual Channel Action Table for the component.",
317                    "longDescription": "This property shall contain a link to a resource collection of type `VCATEntryCollection` that represents the Gen-Z Core Specification-defined REQ-VCAT structure.",
318                    "readonly": true,
319                    "uriSegment": "REQ-VCAT"
320                },
321                "ResponderVCAT": {
322                    "$ref": "http://redfish.dmtf.org/schemas/v1/VCATEntryCollection.json#/definitions/VCATEntryCollection",
323                    "description": "The Responder Virtual Channel Action Table for the component.",
324                    "longDescription": "This property shall contain a link to a resource collection of type `VCATEntryCollection` that represents the Gen-Z Core Specification-defined RSP-VCAT structure.",
325                    "readonly": true,
326                    "uriSegment": "RSP-VCAT"
327                },
328                "SSDT": {
329                    "$ref": "http://redfish.dmtf.org/schemas/v1/RouteEntryCollection.json#/definitions/RouteEntryCollection",
330                    "description": "The Single Subnet Destination Table for the component.",
331                    "longDescription": "This property shall contain a link to a resource collection of type `RouteEntryCollection` that represents the Gen-Z Core Specification-defined SSDT structure.",
332                    "readonly": true
333                }
334            },
335            "type": "object"
336        },
337        "Links": {
338            "additionalProperties": false,
339            "description": "The links to other resources that are related to this resource.",
340            "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.",
341            "patternProperties": {
342                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
343                    "description": "This property shall specify a valid odata or Redfish property.",
344                    "type": [
345                        "array",
346                        "boolean",
347                        "integer",
348                        "number",
349                        "null",
350                        "object",
351                        "string"
352                    ]
353                }
354            },
355            "properties": {
356                "Endpoints": {
357                    "description": "An array of links to the endpoints that represent the logical fabric connection to this fabric adapter.",
358                    "items": {
359                        "$ref": "http://redfish.dmtf.org/schemas/v1/Endpoint.json#/definitions/Endpoint"
360                    },
361                    "longDescription": "This property shall contain an array of links to resources of type `Endpoint` that represent the logical fabric connections associated with this fabric adapter.",
362                    "readonly": true,
363                    "type": "array"
364                },
365                "Endpoints@odata.count": {
366                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
367                },
368                "MemoryDomains": {
369                    "description": "An array of links to the memory domains associated with this fabric adapter.",
370                    "items": {
371                        "$ref": "http://redfish.dmtf.org/schemas/v1/MemoryDomain.json#/definitions/MemoryDomain"
372                    },
373                    "longDescription": "This property shall contain an array of links to resources of type `MemoryDomain` that represent the memory domains associated with this fabric adapter.",
374                    "readonly": false,
375                    "type": "array",
376                    "versionAdded": "v1_3_0"
377                },
378                "MemoryDomains@odata.count": {
379                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
380                },
381                "Oem": {
382                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
383                    "description": "The OEM extension property.",
384                    "longDescription": "This property shall contain the OEM extensions.  All values for properties contained in this object shall conform to the Redfish Specification-described requirements."
385                },
386                "PCIeDevices": {
387                    "description": "An array of links to the PCIe devices associated with this fabric adapter.",
388                    "items": {
389                        "$ref": "http://redfish.dmtf.org/schemas/v1/PCIeDevice.json#/definitions/PCIeDevice"
390                    },
391                    "longDescription": "This property shall contain an array of links to resources of type `PCIeDevice` that represent the PCIe devices associated with this fabric adapter.",
392                    "readonly": true,
393                    "type": "array",
394                    "versionAdded": "v1_2_0"
395                },
396                "PCIeDevices@odata.count": {
397                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
398                },
399                "Processors": {
400                    "description": "An array of links to the processors that this fabric adapter provides to a fabric.",
401                    "items": {
402                        "$ref": "http://redfish.dmtf.org/schemas/v1/Processor.json#/definitions/Processor"
403                    },
404                    "longDescription": "This property shall contain an array of links to resources of type `Processor` that represent the processors that this fabric adapter provides to a fabric.",
405                    "readonly": true,
406                    "type": "array",
407                    "versionAdded": "v1_5_0"
408                },
409                "Processors@odata.count": {
410                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
411                }
412            },
413            "type": "object"
414        },
415        "OemActions": {
416            "additionalProperties": true,
417            "description": "The available OEM-specific actions for this resource.",
418            "longDescription": "This type shall contain the available OEM-specific actions for this resource.",
419            "patternProperties": {
420                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
421                    "description": "This property shall specify a valid odata or Redfish property.",
422                    "type": [
423                        "array",
424                        "boolean",
425                        "integer",
426                        "number",
427                        "null",
428                        "object",
429                        "string"
430                    ]
431                }
432            },
433            "properties": {},
434            "type": "object"
435        }
436    },
437    "language": "en",
438    "owningEntity": "DMTF",
439    "release": "2022.3",
440    "title": "#FabricAdapter.v1_5_3.FabricAdapter"
441}