PCIeDevice

Schema Definition

This is the schema definition for the PCIeDevice resource. It represents the properties of a PCIeDevice 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.
}
Description	String	Yes		read-only	Provides a description of this resource and is used for commonality in the schema definitions.
DeviceType	String			read-only	The device type for this PCIe device. Possible Values: SingleFunction: A single-function PCIe device. MultiFunction: A multi-function PCIe device. Simulated: A PCIe device which is not currently physically present, but is being simulated by the PCIe infrastructure.
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.
PCIeFunctions [ {	Array[Reference(PCIeFunction)]			read-only	An array of references to PCIeFunctions exposed by this device.
@odata.id	String			read-only	The unique identifier for a resource. Format: uri
} ]
PCIeFunctions@odata.count	Int32			read-only	The number of items in a collection.
}
Manufacturer	String	Yes		read-only	This is the manufacturer of this PCIe device.
Model	String	Yes		read-only	This is the model number for the PCIe device.
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 PCIeDevice extension
Baseboard {	Reference(Baseboard)			read-only	The Baseboard hosting the PCIePort this PCIeDevice is attached to
@odata.id	String			read-only	The unique identifier for a resource. Format: uri
}
ComposedIn {	Reference(ComposedNode)	Yes		read-only	This is a link to the ComposedNode, this PCIeDevice is composed in.
@odata.id	String			read-only	The unique identifier for a resource. Format: uri
}
HSLLInterface {	Reference(HSLLInterface)			read-only	This is a link to the HSLLInterface provided by this device
@odata.id	String			read-only	The unique identifier for a resource. Format: uri
}
}
}
PartNumber	String	Yes		read-only	The part number for this PCIe device.
SKU	String	Yes		read-only	This is the SKU for this PCIe device.
SerialNumber	String	Yes		read-only	The serial number for this PCIe device.
Status {	Object	Yes		read-write	This type describes the status and health of a resource and its children.
Health	String	Yes		read-only	This represents the health state of this resource in the absence of its dependent resources. Possible Values: OK: Normal. Warning: A condition exists that requires attention. Critical: A critical condition exists that requires immediate attention.
HealthRollup	String	Yes		read-only	This represents the overall health state from the view of this resource. Possible Values: OK: Normal. Warning: A condition exists that requires attention. Critical: A critical condition exists that requires immediate attention.
Oem { }	Object			read-write	Oem extension object.
State	String	Yes		read-only	This indicates the known state of the resource, such as if it is enabled. Possible Values: Enabled: This function or resource has been enabled. Disabled: This function or resource has been disabled. StandbyOffline: This function or resource is enabled, but awaiting an external action to activate it. StandbySpare: This function or resource is part of a redundancy set and is awaiting a failover or other external action to activate it. InTest: This function or resource is undergoing testing. Starting: This function or resource is starting. Absent: This function or resource is not present or not detected. UnavailableOffline: This function or resource is present but cannot be used. Deferring: The element will not process any commands but will queue new requests. Quiesced: The element is enabled but only processes a restricted set of commands. Updating: The element is updating and may be unavailable or degraded.
}

Operations

GET

Request

GET /redfish/v1/Chassis/Chassis1/Baseboards/Baseboard1/PCIeDevices/PCIeDevice1
Content-Type: application/json

Response

{
    "@odata.context": "uri",
    "@odata.id": "/redfish/v1/Chassis/Chassis1/Baseboards/Baseboard1/PCIeDevices/PCIeDevice1",
    "@odata.type": "String",
    "Actions": {
        "Oem": { }
    }
    "Description": "String",
    "DeviceType": "SingleFunction",
    "Id": "String",
    "Links": {
        "Oem": { },
        "PCIeFunctions": [{
            "@odata.id": "/redfish/v1/Chassis/Chassis1/Baseboards/Baseboard1/PCIeDevices/PCIeDevice1/PCIeFunction1"
        }],
        "PCIeFunctions@odata.count": 1
    }
    "Manufacturer": "String",
    "Model": "String",
    "Name": "String",
    "Oem": {
        "EID_47597": {
            "Baseboard": {
                "@odata.id": "/redfish/v1/Chassis/Chassis1/Baseboards/Baseboard1"
            },
            "ComposedIn": {
                "@odata.id": "/redfish/v1/Chassis/Chassis1/ComposedNodes/ComposedNode1"
            },
            "HSLLInterface": {
                "@odata.id": "/redfish/v1/Chassis/Chassis1/Baseboards/Baseboard1/PCIeDevices/PCIeDevice1/HSLLInterface"
            }
        }
    }
    "PartNumber": "String",
    "SKU": "String",
    "SerialNumber": "String",
    "Status": {
        "Health": "OK",
        "HealthRollup": "OK",
        "Oem": { },
        "State": "Enabled"
    }
}

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

PCIeDevice

Schema Definition

Properties

Operations

GET

Request

Response

POST

PATCH

DELETE