Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

PCIeDevice

Description

This resource shall represent a PCIe device in a Redfish implementation. It may also represent a location, such as a slot, socket, or bay, where a unit may be installed, but the State property within the Status property contains Absent.

Fields

FieldTypeDescription
AssemblyAssemblyThis property shall contain a link to a resource of type `Assembly`.
AssetTagstringThis property shall contain an identifying string that tracks the PCIe device for inventory purposes.
CXLDeviceCXLDeviceThis property shall contain CXL-specific properties of this PCIe device.
CXLLogicalDevicesCXLLogicalDeviceCollectionThis property shall contain a link to a resource collection of type `CXLLogicalDeviceCollection`.
DescriptionDescription
DeviceTypeDeviceTypeThis property shall contain the device type of the PCIe device such as `SingleFunction` or `MultiFunction`.
EnvironmentMetricsEnvironmentMetricsThis property shall contain a link to a resource of type `EnvironmentMetrics` that specifies the environment metrics for this PCIe device.
FirmwareVersionstringThis property shall contain the firmware version of the PCIe device.
IdId
LinksLinksThis property shall contain links to resources that are related to but are not contained by, or subordinate to, this resource.
LocationIndicatorActivebooleanThis property shall contain the state of the indicator used to physically identify or locate this resource.
ManufacturerstringThis property shall contain the name of the organization responsible for producing the PCIe device. This organization may be the entity from whom the PCIe device is purchased, but this is not necessarily true.
ModelstringThis property shall contain the name by which the manufacturer generally refers to the PCIe device.
NameName
OemOemThis property shall contain the OEM extensions. All values for properties that this object contains shall conform to the Redfish Specification-described requirements.
PartNumberstringThis property shall contain a part number assigned by the organization that is responsible for producing or manufacturing the PCIe device.
PCIeInterfacePCIeInterfaceThis property shall contain details for the PCIe interface that connects this PCIe device to its host or upstream switch.
ReadyToRemovebooleanThis property shall indicate whether the PCIe device is ready for removal. Setting the value to `true` shall cause the service to perform appropriate actions to quiesce the device. A task may spawn while the device is quiescing.
SerialNumberstringThis property shall contain a manufacturer-allocated number that identifies the PCIe device.
SKUstringThis property shall contain the stock-keeping unit number for this PCIe device.
SlotSlotThis property shall contain information about the PCIe slot for this PCIe device.
SparePartNumberstringThis property shall contain the spare part number of the PCIe device.
StagedVersionstringThis property shall contain the staged firmware version for this PCIe device; this firmware is not yet active.
StatusStatusThis property shall contain any status or health properties of the resource.
UUIDUUIDThis property shall contain the universally unique identifier number for this PCIe device.