PCIeDevice

Schema Definition

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

Properties

PropertyTypeNullableRequiredPermissionDescription
@odata.contextStringread-onlyThe OData description of a payload.
Format: uri
@odata.idStringread-onlyThe unique identifier for a resource.
Format: uri
@odata.typeStringread-onlyThe type of a resource.
Actions {Objectread-writeThe available actions for this resource.
    Oem { }Objectread-writeThe available OEM specific actions for this resource.
}
DescriptionStringYesread-onlyProvides a description of this resource and is used for commonality in the schema definitions.
DeviceTypeStringread-onlyThe 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.
IdStringGETread-onlyUniquely identifies the resource within the collection of like resources.
Links {Objectread-writeThe links object contains the links to other resources that are related to this resource.
    Oem { }Objectread-writeOem extension object.
    PCIeFunctions [ {Array[Reference(PCIeFunction)]read-onlyAn array of references to PCIeFunctions exposed by this device.
        @odata.idStringread-onlyThe unique identifier for a resource.
Format: uri
    } ]
    PCIeFunctions@odata.countInt32read-onlyThe number of items in a collection.
}
ManufacturerStringYesread-onlyThis is the manufacturer of this PCIe device.
ModelStringYesread-onlyThis is the model number for the PCIe device.
NameStringGETread-onlyThe name of the resource or array element.
Oem {Objectread-writeThis is the manufacturer/provider specific extension moniker used to divide the Oem object into sections.
    EID_47597 {Objectread-writeRECS|Box PCIeDevice extension
        Baseboard {Reference(Baseboard)read-onlyThe Baseboard hosting the PCIePort this PCIeDevice is attached to
            @odata.idStringread-onlyThe unique identifier for a resource.
Format: uri
        }
        ComposedIn {Reference(ComposedNode)Yesread-onlyThis is a link to the ComposedNode, this PCIeDevice is composed in.
            @odata.idStringread-onlyThe unique identifier for a resource.
Format: uri
        }
        HSLLInterface {Reference(HSLLInterface)read-onlyThis is a link to the HSLLInterface provided by this device
            @odata.idStringread-onlyThe unique identifier for a resource.
Format: uri
        }
    }
}
PartNumberStringYesread-onlyThe part number for this PCIe device.
SKUStringYesread-onlyThis is the SKU for this PCIe device.
SerialNumberStringYesread-onlyThe serial number for this PCIe device.
Status {ObjectYesread-writeThis type describes the status and health of a resource and its children.
    HealthStringYesread-onlyThis 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.
    HealthRollupStringYesread-onlyThis 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 { }Objectread-writeOem extension object.
    StateStringYesread-onlyThis 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