Skip to main content

GET – Server PCIe devices

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

Request URL​

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

Request body​

None

Response body​

FieldTypeDescription
IdString

The Id property uniquely identifies this PCIe device.

DeviceTypeString

The device type for this PCIe device

FirmwareVersionString

The version of firmware for this PCIe device

SKUString

This is the SKU for this PCIe device

PCIeFunctionsObject

Link to related PCIeFunctions

LinksObject

Expand

 ChassisLink

Link to chassis resource

 PCIeFunctionsLink

Link to the related PCIeFunctions

 Links/PCIeFunctions@ Redfish.DeprecatedString

The property is deprecated. Please use PCIeFunctions instead.

ManufacturerString

This is the manufacturer of this PCIe device

ModelString

This is the model number for the PCIe device

NameString

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”.

PartNumberString

The part number for this PCIe device

SerialNumberString

The serial number for this PCIe device

PCIeInterfaceObject

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

 LanesInUseInteger

The number of PCIe lanes in use by this device.

 MaxPCIeTypeString

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

 MaxLanesInteger

The number of PCIe lanes supported by this device.

 PCIeTypeString

The version of the PCIe specification in use.

StatusObject

Expand

 StateString

Enabled

 HealthString

This represents the health state of this resource

DescriptionString

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

SlotObject

Expanded

 LocationObject

Expanded

  InfoFormatString

The format of the Info property. “Slot X” or “OnBoard”.

  InfoString

The location of the Resource: Slot {N} (N is the slot number) or “OnBoard”.

  PartLocationObject

Expanded.

The part location within the placement.

   ServiceLabelString

The label of the part location.

PCIe X (X is the slot number) for PCIeCard.

OnBoard for on board device.

   LocationTypeString

The type of location of PCIe device. Fixed value : Slot

   LocationOrdinalValueInteger

The number that represents the location of the part. If LocationType is `slot` and this unit is in slot 2, the LocationOrdinalValue is 2.

Status code​

HTTP Status CodeError Message ID
500InternalError

Example​

The following example JSON response is returned:

{
    "PCIeInterface": {
        "LanesInUse": 8,
        "MaxPCIeType": "Gen4",
        "MaxLanes": 8,
        "PCIeType": "Gen4"
    },
    "FirmwareVersion": "52.22.0-4475",
    "Slot": {
        "Location": {
            "InfoFormat": "Slot X",
            "PartLocation": {
                "ServiceLabel": "PCIe 2",
                "LocationType": "Slot",
                "LocationOrdinalValue": 2
            },
            "Info": "Slot 2"
        }
    },
    "PartNumber": "SR17A32440",
    "SKU": "01PE818",
    "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_2/PCIeFunctions/slot_2.00"
            }
        ]
    },
    "@odata.etag": "\"907b2398e42d2ff67233e\"",
    "PCIeFunctions": {
        "@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/slot_2/PCIeFunctions"
    },
    "Description": "This resource represents the properties of a PCIeDevice attached to a System.",
    "Status": {
        "Health": "OK",
        "State": "Enabled"
    },
    "Name": "ThinkSystem RAID 940-16i 8GB Flash PCIe Gen4 12Gb Adapter",
    "@odata.type": "#PCIeDevice.v1_9_0.PCIeDevice",
    "DeviceType": "SingleFunction",
    "@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/slot_2",
    "@odata.context": "/redfish/v1/$metadata#PCIeDevice.PCIeDevice",
    "Oem": {
        …
    },
    "SerialNumber": "L1FM195SA55",
    "Model": "SAS3916",
    "Id": "slot_2",
    "Manufacturer": "Lenovo"
} {
    "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"
}