GET – Get PCIe Instance
Request
This is the schema definition for the PCIeDevice resource.
It represents the properties of a PCIeDevice attached to a System.
These resources are populated by Host Interface, and Extra AMI BIOS Support is needed.
GET https://{{ip}}/redfish/v1/Chassis/Self/PCIeDevices/{{PCIeDevices_instance}}
Content-Type: application/json
Response
The response of the request will be in JSON format. The properties are mentioned in the following tables.
Name | Type | Read only | Description | ||||
| OData Attributes) | Refer to OData Support | ||||||
| Oem | Object | OEM Extension (Optional), Refer to Resource Complex Types | |||||
Id(M) | String | True | Refer to Resource Type Definitions | ||||
Name(M) | String | True | |||||
Description | String | True | |||||
Status | Object | True | |||||
Manufacturer | String | True | This is the manufacturer of this PCIe device. | ||||
Model | String | True | This is the model number for the PCIe device. | ||||
SKU | String | True | This is the SKU for this PCIe device. | ||||
SerialNumber | String | True | The serial number for this PCIe device. | ||||
PartNumber | String | True | The part number for this PCIe device. | ||||
AssetTag | String | False | The user assigned asset tag for this PCIe device. | ||||
DeviceType | String | True | The device type for this PCIe device. | ||||
Enum | Description | ||||||
SingleFunction | A single-function PCIe device. | ||||||
MultiFunction | A multi-function PCIe device. | ||||||
Simulated | A PCIedevice which is not currently physically present, but is being simulated by the PCIe infrastructure. | ||||||
FirmwareVersion | String | True | The version of firmware for this PCIe device. | ||||
Links | Object | True | The links object contains the links to otherresources that are related to this resource. | ||||
Name | Type | Read Only | Description | ||||
Oem | Object | ||||||
Chassis | Array | True | An array of references to the chassis in which the PCIe device is contained. | ||||
Chassis@odata.count | Number | True | An integer representing the number of items in a collection. | ||||
| PCIeFunctions | Object | True | An reference to PCIeFunctionsCollection exposed by this device. | ||||
PCIeInterface | Object | True | This is the definition for a PCI Interface object. Refer to PCIe Interface Properties. | ||||
Assembly | Object | True | A reference to the Assembly resource associated with the PCIe device. Platform specific porting needed. | ||||
Name | Type | Read only | Description | ||||||||||||
LanesInUse | Number | True | This is the number of PCIe lanes in use by this device. | ||||||||||||
MaxLanes | Number | True | This is the number of PCIe lanes supported by this device. | ||||||||||||
MaxPCIeType | String | True | The highest version of the PCIe specification supported by this device.
| ||||||||||||
PCIeType | String | True | The version of the PCIe specification in use by this device.
| ||||||||||||
Oem | Object |
Response example
{
"@odata.context": "/redfish/v1/$metadata#PCIeDevice.PCIeDevice",
"@odata.etag": "\"1619171734\"",
"@odata.id": "/redfish/v1/Chassis/Self/PCIeDevices/00_01_00",
"@odata.type": "#PCIeDevice.v1_3_1.PCIeDevice",
"Description": "14E4 UNCL Slot 10",
"DeviceType": "MultiFunction",
"FirmwareVersion": "218.0.4.1",
"Id": "00_01_00",
"Links": {
"PCIeFunctions": [
{
"@odata.id": "/redfish/v1/Chassis/Self/PCIeDevices/00_01_00/PCIeFunctions/DevType3_OCP1_DevIndexD"
},
{
"@odata.id": "/redfish/v1/Chassis/Self/PCIeDevices/00_01_00/PCIeFunctions/DevType3_OCP1_DevIndexF"
},
{
"@odata.id": "/redfish/v1/Chassis/Self/PCIeDevices/00_01_00/PCIeFunctions/DevType3_OCP1_DevIndexE"
},
{
"@odata.id": "/redfish/v1/Chassis/Self/PCIeDevices/00_01_00/PCIeFunctions/DevType3_OCP1_DevIndexC"
}
],
"PCIeFunctions@odata.count": 4
},
"Manufacturer": "14E41657",
"Name": "00_01_00",
"Status": {
"Health": "OK",
"State": "Enabled"
}
}