Skip to main content

GET – Functions of server PCIe functions

Use the GET method to retrieve properties in PCIeFunction collection 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.

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:

{
    "VendorId": "0x14e4",
    "Id": "ob_3.01",
    "Links": {
        "Drives": [],
        "PCIeDevice": {
            "@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/ob_3"
        },
        "StorageControllers": [],
        "NetworkDeviceFunctions": [],
        "EthernetInterfaces": []
    },
    "FunctionId": 1,
    "SubsystemId": "0x4042",
    "Description": "This resource represents the properties of a PCIeFunction attached to a System.",
    "FunctionType": "Physical",
    "Status": {
        "State": "Enabled",
        "Health": "OK",
        "HealthRollup": "OK"
    },
    "DeviceClass": "NetworkController",
    "Name": "Adapter 03:00:01",
    "SubsystemVendorId": "0x17aa",
    "@odata.type": "#PCIeFunction.v1_2_3.PCIeFunction",
    "DeviceId": "0x165f",
    "@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/ob_3/PCIeFunctions/ob_3.01",
    "@odata.etag": "\"8c4b6c7797c87b8affd4bef11ee9df50\"",
    "RevisionId": "0x00",
    "ClassCode": "0x020000"
}