Query Ethernet VF

GET/zstack/v1/pci-device/ethernet-vfs

GET/zstack/v1/pci-device/ethernet-vfs/{uuid}

Headers

Authorization: OAuth the-session-uuid

Curl Example

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/pci-device/ethernet-vfs

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/pci-device/ethernet-vfs/bd26758dc3713723bfcd652b8c714e1e

Queryable Fields

Run the CLI command tool, enter QueryEthernetVF and press Tab to view all queryable fields and resource names that support cross-table queries.

API Response

Response Example

{
  "inventories": [
    {
      "interfaceName": "eth0",
      "vfStatus": "Available",
      "hostUuid": "e21879b9f8c63800a211852d183d6650",
      "parentUuid": "da87312aa5ab3ddbb05c61a3564bc5e4",
      "type": "Ethernet_Controller",
      "vendorId": "10de",
      "deviceId": "0e0f",
      "subvendorId": "10de",
      "subdeviceId": "118b",
      "pciDeviceAddress": "0000:06:00.1"
    }
  ]
}

Name	Type	Description	Starting Version
success	boolean		4.2.0
error	ErrorCode	Error code. If not null, the operation failed. This field is null when the operation succeeds. See error	4.2.0
inventories	List	See inventories	4.2.0

error

Name	Type	Description	Starting Version
code	String	Error code, a globally unique identifier of the error, e.g. SYS.1000, HOST.1001	4.2.0
description	String	Brief description of the error	4.2.0
details	String	Detailed error information	4.2.0
elaboration	String	Reserved field, defaults to null	4.2.0
opaque	LinkedHashMap	Reserved field, defaults to null	4.2.0
cause	ErrorCode	Root cause, the source error that caused the current error, null if no original error	4.2.0

inventories

Name	Type	Description	Starting Version
hostDevUuid	String	Host UUID	4.2.0
interfaceName	String	Physical NIC name	4.2.0
vmUuid	String	Virtual Machine UUID	4.2.0
l3NetworkUuid	String	Distributed Port Group UUID	4.2.0
uuid	String	UUID of the resource, uniquely identifies the resource	4.2.0
name	String	Resource name	4.2.0
description	String	Resource description	4.2.0
hostUuid	String	Host UUID	4.2.0
parentUuid	String		4.2.0
vmInstanceUuid	String	Virtual Machine UUID	4.2.0
pciSpecUuid	String		4.2.0
vendorId	String		4.2.0
deviceId	String		4.2.0
subvendorId	String		4.2.0
subdeviceId	String		4.2.0
pciDeviceAddress	String		4.2.0
iommuGroup	String		4.2.0
createDate	Timestamp	Create date	4.2.0
lastOpDate	Timestamp	Last update date	4.2.0
vfStatus	EthernetVfStatus	See vfStatus	4.2.0
type	PciDeviceType	See type	4.2.0
state	PciDeviceState	See state	4.2.0
status	PciDeviceStatus	See status	4.2.0
virtStatus	PciDeviceVirtStatus	See virtStatus	4.2.0
chooser	PciDeviceChooser	See chooser	4.2.0
metaData	PciDeviceMetaData	See metaData	4.2.0
matchedPciDeviceOfferingRef	List	See matchedPciDeviceOfferingRef	4.2.0
mdevSpecRefs	List	See mdevSpecRefs	4.2.0

vfStatus

Name	Type	Description	Starting Version
Available	EthernetVfStatus	Available	4.2.0
Reserved	EthernetVfStatus	Reserved	4.2.0
Attached	EthernetVfStatus	In use	4.2.0
Releasing	EthernetVfStatus	Releasing	4.2.0

type

Name	Type	Description	Starting Version
GPU_Video_Controller	PciDeviceType	GPU video controller	2.1
GPU_Audio_Controller	PciDeviceType	GPU audio controller	2.1
GPU_3D_Controller	PciDeviceType	GPU 3D controller	2.1
Moxa_Device	PciDeviceType	MOXA card	2.1
Generic	PciDeviceType	Generic device	2.1

state

Name	Type	Description	Starting Version
Enabled	PciDeviceState	Enabled	2.1
Disabled	PciDeviceState	Disabled	2.1

status

Name	Type	Description	Starting Version
Active	PciDeviceStatus	Ready	2.1
Attached	PciDeviceStatus	Attached	2.1
System	PciDeviceStatus	System	2.1

virtStatus

Name	Type	Description	Starting Version
UNVIRTUALIZABLE	PciDeviceVirtStatus	Not virtualizable	3.5.0
SRIOV_VIRTUALIZABLE	PciDeviceVirtStatus	SR-IOV virtualizable	3.5.0
VFIO_MDEV_VIRTUALIZABLE	PciDeviceVirtStatus	VFIO_MDEV virtualizable	3.5.0
SRIOV_VIRTUALIZED	PciDeviceVirtStatus	SR-IOV virtualized	3.5.0
VFIO_MDEV_VIRTUALIZED	PciDeviceVirtStatus	VFIO_MDEV virtualized	3.5.0
SRIOV_VIRTUAL	PciDeviceVirtStatus	SR-IOV virtual device	3.5.0
UNKNOWN	PciDeviceVirtStatus	Unknown	3.5.0

chooser

Name	Type	Starting Version
None	PciDeviceChooser	4.8.0
Device	PciDeviceChooser	4.8.0
Spec	PciDeviceChooser	4.8.0

metaData

Name	Type	Description	Starting Version
metaData	String		2.1
metaDataEntries	List	See metaDataEntries	2.1

metaDataEntries

Name	Type	Description	Starting Version
key	String	Key	2.1
value	String	Value	2.1
op	PciDeviceMetaDataOperator	See op	2.1

op

Name	Type	Description	Starting Version
Equal	PciDeviceMetaDataOperator	Equal	2.1
Unequal	PciDeviceMetaDataOperator	Not equal	2.1

matchedPciDeviceOfferingRef

Name	Type	Description	Starting Version
pciDeviceUuid	String		2.1
pciDeviceOfferingUuid	String		2.1

mdevSpecRefs

Name	Type	Description	Starting Version
pciDeviceUuid	String	PCI device UUID	3.5.0
mdevSpecUuid	String	MDEV device spec UUID	3.5.0
effective	Boolean	Whether the current MDEV spec is used to split this PCI device	3.5.0
createDate	Timestamp	Create date	3.5.0
lastOpDate	Timestamp	Last update date	3.5.0

SDK Examples

Java SDK

QueryEthernetVFAction action = new QueryEthernetVFAction();
action.conditions = asList();
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
QueryEthernetVFAction.Result res = action.call();

Python SDK

QueryEthernetVFAction action = QueryEthernetVFAction()
action.conditions = []
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
QueryEthernetVFAction.Result res = action.call()