PCIeFunction

Schema Definition

This is the schema definition for the PCIeFunction resource. It represents the properties of a PCIeFunction attached to a System.

Properties

Property	Type	Nullable	Required	Permission	Description
@odata.context	String			read-only	The OData description of a payload. Format: uri
@odata.id	String			read-only	The unique identifier for a resource. Format: uri
@odata.type	String			read-only	The type of a resource.
Actions {	Object			read-write	The available actions for this resource.
Oem { }	Object			read-write	The available OEM specific actions for this resource.
}
ClassCode	String	Yes		read-only	The Class Code of this PCIe function. Pattern: ^0[xX](([a-fA-F]\|[0-9]){2}){3}$
Description	String	Yes		read-only	Provides a description of this resource and is used for commonality in the schema definitions.
DeviceClass	String			read-only	The class for this PCIe Function. Possible Values: UnclassifiedDevice: An unclassified device. MassStorageController: A mass storage controller. NetworkController: A network controller. DisplayController: A display controller. MultimediaController: A multimedia controller. MemoryController: A memory controller. Bridge: A bridge. CommunicationController: A communication controller. GenericSystemPeripheral: A generic system peripheral. InputDeviceController: An input device controller. DockingStation: A docking station. Processor: A processor. SerialBusController: A serial bus controller. WirelessController: A wireless controller. IntelligentController: An intelligent controller. SatelliteCommunicationsController: A satellite communications controller. EncryptionController: An encryption controller. SignalProcessingController: A signal processing controller. ProcessingAccelerators: A processing accelerators. NonEssentialInstrumentation: A non-essential instrumentation. Coprocessor: A coprocessor. UnassignedClass: An unassigned class. Other: A other class. The function Device Class Id needs to be verified.
DeviceId	String	Yes		read-only	The Device ID of this PCIe function. Pattern: ^0[xX](([a-fA-F]\|[0-9]){2}){2}$
FunctionId	Int64	Yes		read-only	The the PCIe Function identifier.
FunctionType	String			read-only	The type of the PCIe Function. Possible Values: Physical: A physical PCie function. Virtual: A virtual PCIe function.
Id	String		GET	read-only	Uniquely identifies the resource within the collection of like resources.
Links {	Object			read-write	The links object contains the links to other resources that are related to this resource.
Oem {	Object			read-write	Oem extension object.
EID_47597 {	Object			read-only	RECS\|Box PCIeFunction links extension.
Provider {	Reference			read-only	The provider of this PCIeFunction. This can either be a PCIeDevice or a Port.
@odata.id	String			read-only	The unique identifier for a resource. Format: uri
}
}
}
}
Name	String		GET	read-only	The name of the resource or array element.
Oem {	Object			read-write	This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections.
EID_47597 {	Object			read-write	RECS\|Box PCIeFunction extension
BusId	Int64	Yes		read-only	The bus ID of this PCIe function.
DomainId	String	Yes		read-only	The domain ID of this PCIe function. Pattern: ^0[xX](([a-fA-F]\|[0-9]){2}){2}$
FunctionNumber	Int64	Yes		read-only	The function number of this PCIe function.
InstanceNumber	Int64	Yes		read-only	The instance number of this PCIe function.
SlotId	Int64	Yes		read-only	The slot ID of this PCIe function.
}
}
RevisionId	String	Yes		read-only	The Revision ID of this PCIe function. Pattern: ^0[xX](([a-fA-F]\|[0-9]){2}){1}$
SubsystemId	String	Yes		read-only	The Subsystem ID of this PCIe function. Pattern: ^0[xX](([a-fA-F]\|[0-9]){2}){2}$
SubsystemVendorId	String	Yes		read-only	The Subsystem Vendor ID of this PCIe function. Pattern: ^0[xX](([a-fA-F]\|[0-9]){2}){2}$
VendorId	String	Yes		read-only	The Vendor ID of this PCIe function. Pattern: ^0[xX](([a-fA-F]\|[0-9]){2}){2}$

Operations

GET

Request

GET /redfish/v1/Chassis/Chassis1/Switch1/PCIeFunctions/PCIeFunction1
Content-Type: application/json

Response

{
    "@odata.context": "uri",
    "@odata.id": "/redfish/v1/Chassis/Chassis1/Switch1/PCIeFunctions/PCIeFunction1",
    "@odata.type": "String",
    "Actions": {
        "Oem": { }
    }
    "ClassCode": "String",
    "Description": "String",
    "DeviceClass": "UnclassifiedDevice",
    "DeviceId": "String",
    "FunctionId": 0,
    "FunctionType": "Physical",
    "Id": "String",
    "Links": {
        "Oem": {
            "EID_47597": {
                "Provider": {
                    "@odata.id": "uri"
                }
            }
        }
    }
    "Name": "String",
    "Oem": {
        "EID_47597": {
            "BusId": 0,
            "DomainId": "String",
            "FunctionNumber": 0,
            "InstanceNumber": 0,
            "SlotId": 0
        }
    }
    "RevisionId": "String",
    "SubsystemId": "String",
    "SubsystemVendorId": "String",
    "VendorId": "String"
}

POST

This operation is not supported on this resource and will result in the following response:

HTTP/1.1 405 Method Not Allowed

PATCH

This operation is not supported on this resource and will result in the following response:

HTTP/1.1 405 Method Not Allowed

DELETE

This operation is not supported on this resource and will result in the following response:

HTTP/1.1 405 Method Not Allowed

Schema Navigation

PCIeFunction

Schema Definition

Properties

Operations

GET

Request

Response

POST

PATCH

DELETE