1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
|
{
"$ref": "#/definitions/PCIeDevice",
"$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
"copyright": "Copyright 2014-2018 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright",
"definitions": {
"Actions": {
"additionalProperties": false,
"description": "The available actions for this resource.",
"longDescription": "This type shall contain the available actions for this resource.",
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
"description": "This property shall specify a valid odata or Redfish property.",
"type": [
"array",
"boolean",
"integer",
"number",
"null",
"object",
"string"
]
}
},
"properties": {
"Oem": {
"$ref": "#/definitions/OemActions",
"description": "This property contains the available OEM specific actions for this resource.",
"longDescription": "This property shall contain any additional OEM actions for this resource."
}
},
"type": "object"
},
"DeviceType": {
"enum": [
"SingleFunction",
"MultiFunction",
"Simulated"
],
"enumDescriptions": {
"MultiFunction": "A multi-function PCIe device.",
"Simulated": "A PCIe device which is not currently physically present, but is being simulated by the PCIe infrastructure.",
"SingleFunction": "A single-function PCIe device."
},
"type": "string"
},
"Links": {
"additionalProperties": false,
"description": "Contains references to other resources that are related to this resource.",
"longDescription": "This type, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource.",
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
"description": "This property shall specify a valid odata or Redfish property.",
"type": [
"array",
"boolean",
"integer",
"number",
"null",
"object",
"string"
]
}
},
"properties": {
"Chassis": {
"description": "An array of references to the chassis in which the PCIe device is contained.",
"items": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Chassis.json#/definitions/Chassis"
},
"longDescription": "The value of this property shall reference a resource of type Chassis that represents the physical container associated with this resource.",
"readonly": true,
"type": "array"
},
"Chassis@odata.count": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count"
},
"Oem": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
"description": "Oem extension object.",
"longDescription": "This object represents the Oem property. All values for resources described by this schema shall comply to the requirements as described in the Redfish specification."
},
"PCIeFunctions": {
"description": "An array of references to PCIeFunctions exposed by this device.",
"items": {
"$ref": "http://redfish.dmtf.org/schemas/v1/PCIeFunction.json#/definitions/PCIeFunction"
},
"longDescription": "The value of this property shall be a reference to the resources that this device exposes and shall reference a resource of type PCIeFunction.",
"readonly": true,
"type": "array"
},
"PCIeFunctions@odata.count": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count"
}
},
"type": "object"
},
"OemActions": {
"additionalProperties": true,
"description": "The available OEM specific actions for this resource.",
"longDescription": "This type shall contain any additional OEM actions for this resource.",
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
"description": "This property shall specify a valid odata or Redfish property.",
"type": [
"array",
"boolean",
"integer",
"number",
"null",
"object",
"string"
]
}
},
"properties": {},
"type": "object"
},
"PCIeDevice": {
"additionalProperties": false,
"description": "This is the schema definition for the PCIeDevice resource. It represents the properties of a PCIeDevice attached to a System.",
"longDescription": "This resource shall be used to represent a PCIeDevice attached to a System.",
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
"description": "This property shall specify a valid odata or Redfish property.",
"type": [
"array",
"boolean",
"integer",
"number",
"null",
"object",
"string"
]
}
},
"properties": {
"@odata.context": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context"
},
"@odata.etag": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag"
},
"@odata.id": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id"
},
"@odata.type": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/type"
},
"Actions": {
"$ref": "#/definitions/Actions",
"description": "The available actions for this resource.",
"longDescription": "The Actions property shall contain the available actions for this resource."
},
"Assembly": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Assembly.json#/definitions/Assembly",
"description": "A reference to the Assembly resource associated with this PCIe device.",
"longDescription": "The value of this property shall be a link to a resource of type Assembly.",
"readonly": true
},
"AssetTag": {
"description": "The user assigned asset tag for this PCIe device.",
"longDescription": "The value of this property shall be an identifying string used to track the PCIe device for inventory purposes.",
"readonly": false,
"type": [
"string",
"null"
]
},
"Description": {
"anyOf": [
{
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
},
{
"type": "null"
}
],
"readonly": true
},
"DeviceType": {
"$ref": "#/definitions/DeviceType",
"description": "The device type for this PCIe device.",
"longDescription": "The value of this property shall be the device type of the PCIe device such as SingleFunction or MultiFunction.",
"readonly": true
},
"FirmwareVersion": {
"description": "The version of firmware for this PCIe device.",
"longDescription": "The value of this property shall be the firmware version of the PCIe device.",
"readonly": true,
"type": [
"string",
"null"
]
},
"Id": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
"readonly": true
},
"Links": {
"$ref": "#/definitions/Links",
"description": "The links object contains the links to other resources that are related to this resource.",
"longDescription": "The Links property, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource."
},
"Manufacturer": {
"description": "This is the manufacturer of this PCIe device.",
"longDescription": "The value of this property shall be the name of the organization responsible for producing the PCIe device. This organization might be the entity from whom the PCIe device is purchased, but this is not necessarily true.",
"readonly": true,
"type": [
"string",
"null"
]
},
"Model": {
"description": "This is the model number for the PCIe device.",
"longDescription": "The value of this property shall be the name by which the manufacturer generally refers to the PCIe device.",
"readonly": true,
"type": [
"string",
"null"
]
},
"Name": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
"readonly": true
},
"Oem": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
"description": "This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections.",
"longDescription": "The value of this string shall be of the format for the reserved word *Oem*."
},
"PCIeInterface": {
"anyOf": [
{
"$ref": "#/definitions/PCIeInterface"
},
{
"type": "null"
}
],
"description": "The PCIe interface details for this PCIe device.",
"longDescription": "This object shall contain details on the PCIe interface used to connect this PCIe Device to its host or upstream switch."
},
"PartNumber": {
"description": "The part number for this PCIe device.",
"longDescription": "The value of this property shall be a part number assigned by the organization that is responsible for producing or manufacturing the PCIe device.",
"readonly": true,
"type": [
"string",
"null"
]
},
"SKU": {
"description": "This is the SKU for this PCIe device.",
"longDescription": "The value of this property shall be the stock-keeping unit number for this PCIe device.",
"readonly": true,
"type": [
"string",
"null"
]
},
"SerialNumber": {
"description": "The serial number for this PCIe device.",
"longDescription": "The value of this property shall be a manufacturer-allocated number used to identify the PCIe device.",
"readonly": true,
"type": [
"string",
"null"
]
},
"Status": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status",
"description": "This property describes the status and health of the resource and its children.",
"longDescription": "This property shall contain any status or health properties of the resource."
}
},
"required": [
"@odata.id",
"@odata.type",
"Id",
"Name"
],
"type": "object"
},
"PCIeInterface": {
"additionalProperties": false,
"description": "This is the definition for a PCI Interface object.",
"longDescription": "These properties shall be the definition for a PCIe Interface for a Redfish implementation.",
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
"description": "This property shall specify a valid odata or Redfish property.",
"type": [
"array",
"boolean",
"integer",
"number",
"null",
"object",
"string"
]
}
},
"properties": {
"LanesInUse": {
"description": "This is the number of PCIe lanes in use by this device.",
"longDescription": "The value of this property shall be the number of PCIe lanes in use by this device, which shall be equal or less than the value of MaxLanes.",
"maximum": 32,
"readonly": true,
"type": [
"integer",
"null"
]
},
"MaxLanes": {
"description": "This is the number of PCIe lanes supported by this device.",
"longDescription": "The value of this property shall be the maximum number of PCIe lanes supported by this device.",
"maximum": 32,
"readonly": true,
"type": [
"integer",
"null"
]
},
"MaxPCIeType": {
"anyOf": [
{
"$ref": "http://redfish.dmtf.org/schemas/v1/PCIeDevice.json#/definitions/PCIeTypes"
},
{
"type": "null"
}
],
"description": "The highest version of the PCIe specification supported by this device.",
"longDescription": "The value of this property shall be the maximum PCIe specification that this device supports.",
"readonly": true
},
"Oem": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
"description": "Oem extension object.",
"longDescription": "This object represents the Oem property. All values for resources described by this schema shall comply to the requirements as described in the Redfish specification."
},
"PCIeType": {
"anyOf": [
{
"$ref": "http://redfish.dmtf.org/schemas/v1/PCIeDevice.json#/definitions/PCIeTypes"
},
{
"type": "null"
}
],
"description": "The version of the PCIe specification in use by this device.",
"longDescription": "The value of this property shall be the negotiated PCIe interface version in use by this device.",
"readonly": true
}
},
"type": "object"
},
"PCIeTypes": {
"enum": [
"Gen1",
"Gen2",
"Gen3",
"Gen4",
"Gen5"
],
"enumDescriptions": {
"Gen1": "A PCIe v1.0 slot.",
"Gen2": "A PCIe v2.0 slot.",
"Gen3": "A PCIe v3.0 slot.",
"Gen4": "A PCIe v4.0 slot.",
"Gen5": "A PCIe v5.0 slot."
},
"type": "string"
}
},
"owningEntity": "DMTF",
"title": "#PCIeDevice.v1_3_0.PCIeDevice"
}
|
