GET /api/v1/data/devices/{id}/pciDevices
Use this method to return PCI-device information for a specific device.
Authentication
Authentication with user name and password is required.
Resource URI
GET https://{orchestrator_server_IP}/api/v1/data/devices/{id}/pciDevices
where {id} is the ID of the device. To obtain the device IDs, use GET /api/v1/data/devices.
Query parameters
None
Request body
None
Response codes
Code | Description | Comments |
---|---|---|
200 | OK | The request completed successfully. |
404 | Not found | The resource cannot be found. A descriptive error message is returned in the response body. |
Response body
When the request is successful, the following attributes are returned. If the request fails, standard message attributes are returned (see Status messages).
Attributes | Type | Description | ||||
---|---|---|---|---|---|---|
pciDevices | Array of objects | Information about each PCI device | ||||
class | String | Class (basic function) of the PCI device. This can be one of the following values.
| ||||
firmware | Array of objects | Flash storage firmware properties | ||||
build | String | Firmware build | ||||
classifications | Array of integers | Firmware type codes | ||||
date | String | Firmware date | ||||
name | String | Firmware name | ||||
revision | String | Firmware revision | ||||
role | String | Firmware role. This can be one of the following values.
| ||||
softwareID | String | Firmware ID | ||||
status | String | Firmware status. This can be one of the following values.
| ||||
type | String | Firmware type, such as UEFI, MP, or DSA | ||||
version | String | Firmware version | ||||
fodUniqueID | String | FoD unique ID | ||||
isAddOnCard | Boolean | Identifies whether the device is an add-on card. This can be one of the following values.
| ||||
isAgentless | Boolean | Identifies whether the device is agentless. This can be one of the following values.
| ||||
isPLDMUpdateSupported | Boolean | Identifies whether the Platform Level Data Model updates are supported. This can be one of the following values.
| ||||
name | String | Description | ||||
pciBusNumber | String | PCI bus number | ||||
pciDeviceNumber | String | PCI device number | ||||
pciFunctionNumber | String | PCI function number | ||||
pciRevision | String | PCI revision | ||||
pciSubID | String | PCI subsystem ID | ||||
pciSubVendorID | String | PCI sub-vendor ID | ||||
portInfo | Object | Information about the ports | ||||
physicalPorts | Array of objects | Information about the physical ports | ||||
logicalPorts | Array of objects | List of associated logical ports | ||||
addresses | String | Assigned addresses | ||||
logicalPortIndex | Integer | Number of logical ports | ||||
portNumber | Integer | Number of the logical port | ||||
portType | String | Logical port type. This can be one of the following values.
| ||||
vnicMode | Boolean | Identifies whether this is a vNIC port. This can be one of the following values.
| ||||
peerBay | Integer | Peer Flex switch bay | ||||
physicalPortIndex | Integer | Number of physical ports | ||||
portNumber | Integer | Number of the physical port | ||||
portType | String | Physical port type. This can be one of the following values.
| ||||
speed | Long | Link speed, in Gbps (for example, 2.5) | ||||
status | String | Link status. This can be one of the following values.
| ||||
posID | String | Device ID | ||||
vpdID | String | VPD ID | ||||
_links | Object | Device URI (see Links) |
The following example is returned if the request is successful.
{
"pciDevices": [{
"class": "Network controller",
"firmware": [{
"build": "0",
"classifications": [32773],
"date": "",
"name": "Combined Option ROM Image",
"revision": "0",
"role": "Primary",
"softwareID": "8086000A",
"status": "Active",
"type": "Boot ROM",
"version": "1.1638.0"
}],
"fodUniqueID": "N/A",
"isAddOnCard": true,
"isAgentless": true,
"isPLDMUpdateSupported": false
"name": "Intel X710 2x10GbE SFP+ Adapter",
"pciBusNumber": "91",
"pciDeviceNumber": "0",
"pciFunctionNumber": "1",
"pciRevision": "1",
"pciSubID": "0",
"pciSubVendorID": "8086",
"portInfo": {
"physicalPorts": [{
"logicalPorts": [{
"addresses": "6805CA7F5AE3",
"logicalPortIndex": 1,
"portNumber": 1,
"portType": "ETHERNET",
"vnicMode": false
}],
"peerBay": 0,
"physicalPortIndex": 2,
"portNumber": 74,
"portType": "ETHERNET",
"speed": 0,
"status": ""
}]
},
"posID": "1572",
"vpdID": "8086"
}],
"_links": {
"rel": "self",
"uri": "/api/v1/data/devices/C7199530FEDE4FE09540DFC3D75FC56C/pciDevices"
}
}
Give feedback