GET /api/v1/data/devices/`{id}`/pciDevices

Use this method to return PCI-device information for a specific device.

Authentication

Authentication with username 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. Bridge Communication controller Coprocessor Display controller Docking station Encryption controller Generic system peripheral Input device controller Intelligent controller Mass storage controller Memory controller Multimedia controller Network controller Non-Essential Instrumentation Processing accelerators Processor Satellite communications controller Serial bus controller Signal processing controller Unassigned class Unclassified device Unknown device Wireless controller
	firmware				Array of objects	Flash storage firmware properties
		build			String	Firmware build
		classifications			Array of integers	Firmware type codes
		date			String	Firmware date
		deviceTypeKey			String	Device type key
		name			String	Firmware name
		revision			String	Firmware revision
		role			String	Firmware role. This can be one of the following values. Primary Backup Temporary Permanent
		softwareID			String	Firmware ID
		status			String	Firmware status. This can be one of the following values. Active Inactive
		type			String	Firmware type, such as UEFI, MP, or DSA
		version			String	Firmware version
	fodUniqueID				String	FoD unique ID
	FRU				String	Add-in card FRU part number
	fruSerialNumber				String	Add-in card FRU serial number
	isAddOnCard				Boolean	Identifies whether the device is an add-on card.
	isAgentless				Boolean	Identifies whether the device is agentless
	isPLDMUpdateSupported				Boolean	Identifies whether the Platform Level Data Model updates are supported
	manufacturer				String	Manufacturer
	name				String	Description
	partNumber				String	Part number
	pciBusNumber				String	PCI bus number
	pciDeviceNumber				String	PCI device number
	pciFunctionNumber				String	PCI function number
	pciRevision				String	PCI revision
	pciSegmentNumber				String	PCI segment number
	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. ATM BLUETOOTH ETHERNET FC FDDI FRAMERELAY IB INFRARED OTHER TOKENRING UNKNOWN WIRELESSLAN
				vnicMode	Boolean	Identifies whether this is a vNIC port
			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. ATM ETHERNET FC FDDI FRAMERELAY IB OTHER TOKENRING UNKNOWN
			speed		Long	Link speed, in Gbps (for example, 2.5)
			status		String	Link status. This can be one of the following values. up down unknown
		posID			String	Device ID
		productName			String	Product name
		slotName			String	Slot name
		slotNumber			String	Slot number
		slotSupportsHotPlug			String	Indicates whether the slot is hot pluggable. This can be one of the following values. true false
		vpdID			String	VPD ID
_links					Object	Device URI (see Links)

The following example is returned if the request is successful.

{
   "pciDevices": [{
      "class": "Display controller",
      "firmware": [],
      "fodUniqueID": "",
      "isAddOnCard": false,
      "isAgentless": false,
      "isPLDMUpdateSupported": false,
      "name": "Onboard VGA",
      "pciBusNumber": "198",
      "pciDeviceNumber": "0",
      "pciFunctionNumber": "0",
      "pciRevision": "0x0052",
      "pciSegmentNumber": "0",
      "pciSubID": "0x2000",
      "pciSubVendorID": "0x1a03",
      "portInfo": {},
      "posID": "0x2000",
      "vpdID": "0x1a03",
   },
   ...,
   {
      "class": "Network controller",
      "firmware": [{
         "build": "0",
         "classifications": [ 13 ],
         "date": "",
         "deviceTypeKey": "software bundle",
         "name": "Firmware Bundle",
         "revision": "0",
         "role": "",
         "softwareID": "17AA4104",
         "status": "Active",
         "type": "Software Bundle",
         "version": "222.0.2.1"
      }],
      "FRU": "01PE761"
      "fruSerialNumber": "01PE761",
      "fodUniqueID": "",
      "isAddOnCard": true,
      "isAgentless": false,
      "isPLDMUpdateSupported": false,
      "manufacturer": "Broadcom Limited",
      "name": "Broadcom 5719 1GbE RJ45 4-port OCP Ethernet Adapter",
      "partNumber": "SN37A28309",
      "pciBusNumber": "2",
      "pciDeviceNumber": "0",
      "pciFunctionNumber": "0",
      "pciRevision": "0x0001",
      "pciSegmentNumber": "0",
      "pciSubID": "0x4104",
      "pciSubVendorID": "0x17aa",
      "portInfo": {
         "physicalPorts": [{
            "logicalPorts": [{
               "addresses": "84:16:0c:ae:15:f2",
               "logicalPortIndex": 1,
               "portNumber": 1,
               "portType": "ETHERNET",
               "vnicMode": false
            }],
            "physicalPortIndex": 1,
            "peerBay": 0,
            "portType": "ETHERNET",
            "portNumber": 1,
            "speed": -1,
            "status": "Down"
         }]
      },
      "posID": "0x1657",
      "productName": "Broadcom 5719 1GbE RJ45 4-port OCP Ethernet Adapter",
      "slotName": "PCIe 13",
      "slotNumber": "13",
      "slotSupportsHotPlug": "false",
      "vpdID": "0x14e4"
   }],
   "_links": {
      "rel": "self",
      "uri": "/api/v1/data/devices/91C6C497643711ED9D3BA31E8F6751A9-B65EC401D9B741F49736CFC9380791F4/pciDevices"
   }
}

Give documentation feedback

GET /api/v1/data/devices/{id}/pciDevices

Authentication​

Resource URI​

Query parameters​

Request body​

Response codes​

Response body​