Skip to main content

GET – Functions of server PCIe functions

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

Request URL​

GET https://<BMC_IPADDR>/redfish/v1/Chassis/1/PCIeDevice/{Device_id}/PCIeFunctions/{Location}

Request body​

None

Response body​

The response is a JSON object that contains the following parameters:
FieldTypeDescription

Id

String

The Id property uniquely identifies this PCIe function.

ClassCode

String

The Class Code of this PCIe function.

Description

String

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

DeviceClass

String

The class for this PCIe Function.

DeviceId

String

The Device ID of this PCIe function.

FunctionId

String

The PCIe Function identifier.

FunctionType

String

Physical

Links

Object

Expand

 

Drives

Array

Link to related the Drive resources.

 

EthernetInterfaces

Array

Link to related the EthernetInterface resources.

 

StorageControllers

Array

Link to related the StorageController resources.

 

PCIeDevice

Link

Link to related the PCIeDevice resource.

 

NetworkDeviceFunctions

Link

Link to related NetworkDeviceFunctions resource.

Name

String

The card name in VPD + bus number, device number, function number.

If there is no VPD data, using “Adapter” instead of card name.

Status

Object

Expand

 

State

String

Enabled

 

Health

String

OK

 

HealthRollup

String

The health of this PCIe device. Possible values are “OK”, “Warning” and “Critical”.

RevisionId

String

The Revision ID of this PCIe function.

SubsystemId

String

The Subsystem ID of this PCIe function.

SubsystemVendorId

String

The Subsystem Vendor ID of this PCIe function.

VendorId

String

The Vendor ID of this PCIe function.

Status code​

HTTP Status CodeError Message ID
500InternalError

Example​

The following example JSON response is returned:

{
    "FunctionId": 0,
    "SubsystemId": "0x060c",
    "ClassCode": "0x010400",
    "FunctionType": "Physical",
    "SubsystemVendorId": "0x1d49",
    "Links": {
        "PCIeDevice": {
            "@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/slot_2"
        },
        "StorageControllers": [
            {
                "@odata.id": "/redfish/v1/Systems/1/Storage/RAID_Slot2#/StorageControllers/0"
            }
        ],
        "Drives": [
            {
                "@odata.id": "/redfish/v1/Systems/1/Storage/RAID_Slot2/Drives/Disk.0"
            },
            {
                "@odata.id": "/redfish/v1/Systems/1/Storage/RAID_Slot2/Drives/Disk.1"
            }
        ]
    },
    "DeviceClass": "MassStorageController",
    "@odata.etag": "\"6bbb730cc84e2aef6d4\"",
    "Description": "This resource represents the properties of a PCIeFunction attached to a System.",
    "Id": "slot_2.00",
    "Name": "ThinkSystem RAID 940-16i 8GB Flash PCIe Gen4 12Gb Adapter 6a:00:00",
    "@odata.type": "#PCIeFunction.v1_3_0.PCIeFunction",
    "@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/slot_2/PCIeFunctions/slot_2.00",
    "Status": {
        "Health": "OK",
        "State": "Enabled",
        "HealthRollup": "OK"
    },
    "RevisionId": "0x00",
    "VendorId": "0x1000",
    "@odata.context": "/redfish/v1/$metadata#PCIeFunction.PCIeFunction",
    "DeviceId": "0x10e2"
}