Skip to main content

GET – Server PCIe devices

Use the GET method to retrieve properties in PCIeDevice collection for Redfish service.

Request URL​

GET https://<BMC_IPADDR>/redfish/v1/Chassis/1/PCIeDevices/{Location}

Request body​

None

Response body​

FieldTypeDescription

Id

String

The Id property uniquely identifies this PCIe device.

DeviceType

String

The device type for this PCIe device

FirmwareVersion

String

The version of firmware for this PCIe device

SKU

String

This is the SKU for this PCIe device

PCIeFunctions

Object

Link to related PCIeFunctions

Links

Object

Expand

 

Chassis

Link

Link to chassis resource

 

PCIeFunctions

Link

Link to the related PCIeFunctions

Manufacturer

String

This is the manufacturer of this PCIe device

Model

String

This is the model number for the PCIe device

Name

String

The card name in VPD for this PCIe device, if it is an on-board PCIe device, add “(onboard)” in the end.

If there is no VPD data, this property will be “Adapter”.

PartNumber

String

The part number for this PCIe device

SerialNumber

String

The serial number for this PCIe device

PCIeInterface

Object

These properties shall contain the definition for a PCIe Interface for a Redfish implementation.

 

LanesInUse

Integer

The number of PCIe lanes in use by this device.

 

MaxPCIeType

String

The highest version of the PCIe specification supported by this device.

 

MaxLanes

Integer

The number of PCIe lanes supported by this device.

Status

Object

Expand

 

State

String

Enabled

 

Health

String

This represents the health state of this resource

Description

String

This resource represents the properties of a PCIeDevice attached to a System.

Status code​

HTTP Status CodeError Message ID
500InternalError

Example​

The following example JSON response is returned:

{
    "SerialNumber": null,
    "@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/slot_3",
    "Links": {
        "Links/PCIeFunctions@Redfish.Deprecated": "The property is deprecated. Please use PCIeFunctions instead.",
        "Chassis": [
            {
                "@odata.id": "/redfish/v1/Chassis/1"
            }
        ],
        "PCIeFunctions": [
            {
                "@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/slot_3/PCIeFunctions/slot_3.00"
            }
        ]
    },
    "PCIeFunctions": {
        "@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/slot_3/PCIeFunctions"
    },
    "PCIeInterface": {
        "LanesInUse": null,
        "MaxLanes": null,
        "MaxPCIeType": "Gen3"
    },
    "PartNumber": null,
    "Description": "This resource represents the properties of a PCIeDevice attached to a System.",
    "FirmwareVersion": null,
    "Status": {
        "State": "Enabled",
        "Health": "OK"
    },
    "Name": "Adapter",
    "Id": "slot_3",
    "Oem": {
        "Lenovo": {
            "@odata.type": "#LenovoDeviceInfo.v1_0_0.LenovoDeviceInfo",
            "Location": {
                "PartLocation": {
                    "LocationType": "Slot",
                    "ServiceLabel": "PCIe 3",
                    "LocationOrdinalValue": 3
                },
                "InfoFormat": "Slot X",
                "Info": "Slot 3",
                "Info@Redfish.Deprecated": "The property is deprecated. Please use PartLocation instead.",
                "InfoFormat@Redfish.Deprecated": "The property is deprecated. Please use PartLocation instead."
            }
        }
    },
    "@odata.type": "#PCIeDevice.v1_4_0.PCIeDevice",
    "SKU": null,
    "Manufacturer": null,
    "@odata.etag": "\"e7a9cb060992cf9c73f21a48370932b8\"",
    "Model": null,
    "DeviceType": "SingleFunction"
}