Skip to main content

GET – PCIe Function Instance

Request​

Dependence

  1. This is the schema definition for the PCIeFunction resource.

  2. It represents the properties of a PCIeFunction attached to a System.

  3. These resources are populated by Host Interface, and Extra AMI BIOS Support is needed.

GET https://{{ip}}/redfish/v1/Chassis/Self/PCIeDevices/{{PCIeDevices_instance}}/PCIeFunctions/{{PCIeFunctions_instance}}
Content-Type: application/json

Response​

The response of the request will be in JSON format. The properties are mentioned in the following tables.

Table 1. PCIe Function Properties

Name

Type

Read only

Description

(OData Attributes)  

Refer to OData Support

OemObject 

OEM Extension (Optional), Refer to Resource Complex Types

Id(M)

String

True

Refer to Resource Type Definitions

Name(M)

String

True

Description

String

True

Status

Object

True

See Resource Complex Types.

PCIeFunction will take the State & Health values as per the parent PCIe Device.

FunctionId

Number

True

The the PCIe Function identifier.

FunctionType

 

True

The value of this property shall be the function type of the PC device function such as Physical or Virtual.

DeviceClass

 

True

The value of this property shall be the device class of the PCIe device function such as Storage, Network, Memory etc.

DeviceId

String

True

The Device ID of this PCIe function.

VendorId

String

True

The Vendor ID of this PCIe function.

ClassCode

String

True

The Class Code of this PCIe function.

RevisionId

String

True

The Revision ID of this PCIe function.

SubsystemId

String

True

The Subsystem ID of this PCIe function.

SubsystemVendorId

String

True

The Subsystem Vendor ID of this PCIe function.

Actions

Object

True

AmiBios.ChangeState is the only action under Oem.

Note
This action is supported by ami_bios DRE using HostInterface communication. This Action will be supported only for some PCIeFunctions based on the server configurations.

Links

Object

 

The links object contains the links to other resources that are related to this resource.

Name

Type

Read Only

Description

Oem

Object

 

See Resource Complex Types.

Drives

Array

True

An array of references to the drives which the PCIe device produces.

Drives@odata.count

Number

True

An integer representing the number of items in a collection.

StorageControllers

Array

True

An array of references to the storage controllers which the PCIe device produces.

StorageControllers@odata.count

Number

True

An integer representing the number of items in a collection.

EthernetInterfaces

Array

True

An array of references to the ethernet interfaces which the PCIe device produces.

EthernetInterfaces@odata.count

Number

True

An integer representing the number of items in a collection.

NetworkDeviceFunctions

Array

True

An array of references to the Network Device Functions which the PCIe device produces.

Currently, BIOS doesn’t populate this data.

NetworkDeviceFunctions@odata.count

Number

True

An integer representing the number of items in a collection.

PCIeDevice

Object

True

The value of this property shall be a reference to the resource that this function is a part of and shall reference a resource of type PCIe Device.

Response example​

{
    "@odata.context": "/redfish/v1/$metadata#PCIeFunction.PCIeFunction",
    "@odata.etag": "\"1619171734\"",
    "@odata.id": "/redfish/v1/Chassis/Self/PCIeDevices/00_01_00/PCIeFunctions/DevType3_OCP1_DevIndexF",
    "@odata.type": "#PCIeFunction.v1_2_2.PCIeFunction",
    "Actions": {
        "Oem": {
            "#AmiBios.ChangeState": {
                "State@Redfish.AllowableValues": [
                    "Enabled",
                    "Disabled"
                ],
                "target": "/redfish/v1/Chassis/Self/PCIeDevices/00_01_00/PCIeFunctions/
DevType3_OCP1_DevIndexF/Actions/AmiBios.ChangeState"
            }
        }
    },
    "ClassCode": "0x020000",
    "Description": "14E4 1657 UNCL Slot 10",
    "DeviceClass": "NetworkController",
    "DeviceId": "0x1657",
    "FunctionId": 3,
    "Id": "DevType3_OCP1_DevIndexF",
    "Links": {
        "EthernetInterfaces": [
            {
                "@odata.id": "/redfish/v1/Systems/Self/EthernetInterfaces/EthernetInterface3"
            }
        ],
        "EthernetInterfaces@odata.count": 1,
        "NetworkDeviceFunctions": [
            {
                "@odata.id": "/redfish/v1/Chassis/Self/NetworkAdapters/DevType7_NIC3/NetworkDeviceFunctions/
NetworkDeviceFunction3"
            }
        ],
        "NetworkDeviceFunctions@odata.count": 1,
        "PCIeDevice": {
            "@odata.id": "/redfish/v1/Chassis/Self/PCIeDevices/00_01_00"
        }
    },
    "Name": "DevType3_OCP1_DevIndexF",
    "RevisionId": "0x01",
    "Status": {
        "Health": "OK",
        "State": "Enabled"
    },
    "SubsystemId": "0x4104",
    "SubsystemVendorId": "0x17AA",
    "VendorId": "0x14E4"
}