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/{Device_id}

Request body​

None

Response body​

FieldTypeDescription

AssetTag

String

The user-assigned asset tag for this PCIe device.

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

Expanded.

 

Chassis

Link

Link to chassis resource.

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.

Status

Object

Expanded.

 

State

String

Enabled

 

HealthRollup

String

This represents the health state of this resource and its dependent resources.

 

Health

String

This represents the health state of this resource.

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.

 

PCIeType

String

The version of the PCIe specification in use.

Slot

Object

Expanded.

 

Location

Object

Expanded.

  

PartLocation

Object

Expanded.

The part location within the placement.

   

LocationType

String

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

   

LocationOrdinalValue

Integer

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

 

SlotType

String

The PCIe slot type.

UUID

String

The UUID for this PCIe device.

Status code​

HTTP Status CodeError Message ID
500InternalError

Example​

The following example JSON response is returned:

{
    "@odata.context": "/redfish/v1/$metadata#PCIeDevice.PCIeDevice",
    "@odata.etag": "\"9F983D35\"",
    "@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/slot3_0xb0000",
    "@odata.type": "#PCIeDevice.v1_10_0.PCIeDevice",
    "Description": "This resource represents the properties of a                     PCIeDevice attached to a System.",
    "DeviceType": "MultiFunction",
    "FirmwareVersion": "4.07.04",
    "Id": "slot3_0xb0000",
    "Links": {
        "Chassis": [
            {
                "@odata.id": "/redfish/v1/Chassis/1"
            }
        ]
    },
    "Manufacturer": "QLogic",
    "Model": "QLE2772",
    "Name": "QLogic QLE2772 32Gb 2-Port PCIe Fibre Channel Adapter",
    "Oem": {
        ...
        }
    },
    "PCIeFunctions": {
        "@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/slot3_0xb0000/PCIeFunctions"
    },
    "PCIeInterface": {
        "LanesInUse": 8,
        "MaxLanes": 8,
        "MaxPCIeType": "Gen4",
        "PCIeType": "Gen4"
    },
    "PartNumber": "SN37A28357",
    "SKU": "01KR591",
    "SerialNumber": "C1MP0630A9E",
    "Slot": {
        "Location": {
            "PartLocation": {
                "LocationOrdinalValue": 3,
                "LocationType": "Slot"
            }
        },
        "SlotType": "CEM"
    },
    "Status": {
        "Health": "OK",
        "State": "Enabled"
    },
    "UUID": "AF3A10A6A2DC4039B6D055C969462255"
}