PCI Device
Overview
ZStack Cloud allows you to attach a PCI device to a VM instance. For the current version, ZStack Cloud supports two methods, including GPU pass-through and virtual GPU (vGPU), both of which can be used to attach VM instances.
ZStack Cloud supports the physical GPU passthrough feature. Specifically, physical GPUs can pass through entirely all its peripheral devices (GPU graphics cards, GPU sound cards, and other small devices) as a group to VM instances, thus allowing the VM instances to obtain the powerful GPU parallel computing of hosts. This feature is applied to high performance computing (HPC) scenarios in fields of 3D rendering, high definition decoder, and highly intensive computing, such as machine learning, medical imaging, data analysis for petroleum exploitations, and Bitcoin mining.
ZStack Cloud supports the following physical GPU specifications.
NVIDIA AMD - Tesla T4
- Tesla M10/M60
- Tesla P100/P40/P6/P4
- Tesla V100
- RTX 6000/8000
- …
- FirePro S7150
- FirePro S7150X2
ZStack Cloud supports multiple passthrough GPU specifications. Here, we only display a common set of the GPU specifications. For more information about GPU specifications, see NVIDIV Virtual GPU Software Documentation.
ZStack Cloud supports the vGPU feature. Through the GPU virtualization technology, physical GPUs will be segmented to more fine-grained vGPUs, which will become vGPU resource pools. You can create lightweight vGPU VM instances by using vGPU specifications to achieve more flexible, scalable resource deployments, higher resource utilization, and lower cost. This feature is applied to the lightweight GPU computing scenarios in fields of cloud gaming, VDI, VR/AR, AI inference, and machine learning pedagogy.
ZStack Cloud supports the following vGPU (segmented by physical GPU virtualization technology) specifications.
NVIDIA AMD - Tesla T4
- Tesla M10/M60
- Tesla P100/P40/P6/P4
- Tesla V100
- RTX 6000/8000
- …
- FirePro S7150
- FirePro S7150X2
NVIDIA GPU supports multiple virtualization segmentation models. We only display a common set of GPU specifications. For more information about GPU models, see NVIDIV Virtual GPU Software Documentation.
Inventory
PCI Device Inventory
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The UUID. For more information, see Resource Property. | 2.1 | ||
| name | The name. For more information, see Resource Property. | 2.1 | ||
| description | The description. For more information, see Resource Property. | Yes | 2.1 | |
| hostUuid | The host UUID. | 2.1 | ||
| parentUuid | The physical PCI device UUID. | 3.5.0 | ||
| vmInstanceUuid | The VM instance UUID. | 2.1 | ||
| pciSpecUuid | The PCI device specification UUID. | 3.5.0 | ||
| vendorId | The vendor ID. | 2.1 | ||
| deviceId | The device ID. | 2.1 | ||
| subvendorId | The sub-vendor ID. | 2.1 | ||
| subdeviceId | The sub-device ID. | 2.1 | ||
| pciDeviceAddress | The PCI device address. | 2.1 | ||
| type | The type. | 2.1 | ||
| state | 2.1 | |||
| status | The status. | 2.1 | ||
| virtStatus | 3.5.0 | |||
| metaData | 2.1 | |||
| matchedPciDeviceOfferingRef | 2.1 | |||
| mdevSpecRefs | 3.5.0 | |||
| groupBy | Groups rows into subgroups based on values of columns or expressions. This field is equivalent to the Group By clause in MySQL, such as groupBy=type. | Yes | 2.1 | |
| createDate | The creation date. For more information, see Resource Property. | 2.1 | ||
| lastOpDate | The last operation date. For more information, see Resource Property. | 2.1 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 2.1 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 2.1 |
PCI Device Offering Inventory
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The UUID. For more information, see Resource Property. | 2.1 | ||
| name | The name. For more information, see Resource Property. | 2.1 | ||
| description | The description. For more information, see Resource Property. | Yes | 2.1 | |
| groupBy | Groups rows into subgroups based on values of columns or expressions. This field is equivalent to the Group By clause in MySQL, such as groupBy=type. | Yes | 2.1 | |
| createDate | The creation date. For more information, see Resource Property. | 2.1 | ||
| lastOpDate | The last operation date. For more information, see Resource Property. | 2.1 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 2.1 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 2.1 |
PCI Device and PCI Device Offering Reference Inventory
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The UUID. For more information, see Resource Property. | 2.1 | ||
| description | The description. For more information, see Resource Property. | Yes | 2.1 | |
| hostUuid | The host UUID. | 2.1 | ||
| vmInstanceUuid | The VM instance UUID. | 2.1 | ||
| vendorId | 2.1 | |||
| deviceId | 2.1 | |||
| subvendorId | 2.1 | |||
| subdeviceId | 2.1 | |||
| pciDeviceAddress | The PCI device address. | 2.1 | ||
| status | 2.1 | |||
| state | 2.1 | |||
| type | The type. | 2.1 | ||
| metaData | 2.1 | |||
| matchedPciDeviceOfferingRef | 2.1 | |||
| groupBy | Groups rows into subgroups based on values of columns or expressions. This field is equivalent to the Group By clause in MySQL, such as groupBy=type. | Yes | 2.1 | |
| createDate | The creation date. For more information, see Resource Property. | 2.1 | ||
| lastOpDate | The last operation date. For more information, see Resource Property. | 2.1 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 2.1 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 2.1 |
PCI Device Specification Inventory
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The UUID. For more information, see Resource Property. | 3.5.0 | ||
| name | The name. For more information, see Resource Property. | 3.5.0 | ||
| description | The description. For more information, see Resource Property. | Yes | 3.5.0 | |
| vendorId | The vendor ID. | 3.5.0 | ||
| deviceId | The device ID. | 3.5.0 | ||
| subvendorId | The sub-vendor ID. | 3.5.0 | ||
| subdeviceId | The sub-device ID. | 3.5.0 | ||
| ramSize | The RAM size. | 3.5.0 | ||
| maxPartNum | The maximum number of virtual functions. | 3.5.0 | ||
| isVirtual | Whether the device is a virtual device. | 3.5.0 | ||
| romVersion | The ROM version. | 3.5.0 | ||
| romMd5sum | The ROM MD5 checksum. | 3.5.0 | ||
| type | The type. |
|
3.5.0 | |
| state | The state. |
|
3.5.0 | |
| groupBy | Groups rows into subgroups based on values of columns or expressions. This field is equivalent to the Group By clause in MySQL, such as groupBy=type. | Yes | 3.5.0 | |
| createDate | The creation date. For more information, see Resource Property. | 3.5.0 | ||
| lastOpDate | The last operation date. For more information, see Resource Property. | 3.5.0 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.5.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.5.0 |
Sample
{
"inventories": [
{
"uuid": "4e583459b0bb4a8085f2acf4040ab802",
"name": "MSI_GTX1060",
"description": "NVIDIA Corporation, GP106 [GeForce GTX 1060 6GB], a1, VGA compatible controller",
"vendorId": "10de",
"deviceId": "1c03",
"subvendorId": "1462",
"subdeviceId": "3283",
"type": "GPU_Video_Controller",
"state": "Enabled",
"romVersion": "86.06.0E.00.28",
"createDate": "Nov 14, 2017 10:20:57 PM",
"lastOpDate": "Nov 14, 2017 10:20:57 PM"
}
]
}
VM Instance and PCI Device Specification Reference Inventory
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| vmInstanceUuid | The VM instance UUID. | 3.5.0 | ||
| pciSpecUuid | The PCI device specification UUID. | 3.5.0 | ||
| pciDeviceNumber | The number of PCI devices to be attached to the VM instance. Note that these devices must conform to the PCI device specification. Default value: 1. | 3.5.0 | ||
| groupBy | Groups rows into subgroups based on values of columns or expressions. This field is equivalent to the Group By clause in MySQL, such as groupBy=type. | Yes | 3.5.0 | |
| createDate | The creation date. For more information, see Resource Property. | 3.5.0 | ||
| lastOpDate | The last operation date. For more information, see Resource Property. | 3.5.0 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.5.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.5.0 |
Sample
{
"inventories": [
{
"vmInstanceUuid": "c40d04f99f7647f2bf145aa6e3d463ff",
"pciSpecUuid": "9afda707d3b14838adaa48d4295f3d5f",
"pciDeviceNumber": 1.0,
"createDate": "Nov 14, 2017 10:20:57 PM",
"lastOpDate": "Nov 14, 2017 10:20:57 PM"
}
]
}
MDEV Device Specification Inventory
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The UUID. For more information, see Resource Property. | 3.5.0 | ||
| name | The name. For more information, see Resource Property. | 3.5.0 | ||
| description | The description. For more information, see Resource Property. | Yes | 3.5.0 | |
| specification | The specification details. | 3.5.0 | ||
| type | The type. |
|
3.5.0 | |
| state | The state. |
|
3.5.0 | |
| groupBy | Groups rows into subgroups based on values of columns or expressions. This field is equivalent to the Group By clause in MySQL, such as groupBy=type. | Yes | 3.5.0 | |
| createDate | The creation date. For more information, see Resource Property. | 3.5.0 | ||
| lastOpDate | The last operation date. For more information, see Resource Property. | 3.5.0 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.5.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.5.0 |
Sample
{
"inventories": [
{
"uuid": "18ebda01fb874e7db54ccd3a6712e92d",
"name": "GRID_M60-2A",
"specification": "{Max Resolution\u003d1920*1080, GRID License\u003dGRID-Virtual-Apps,3.0, Instance Number\u003d4, Display Heads\u003d4, Vendor\u003dNVIDIA, Frame Rate Limit\u003d60FPS, Name\u003dGRID_M60-2A, RAM\u003d2048MB}",
"type": "GPU_Video_Controller",
"state": "Enabled",
"createDate": "Nov 14, 2017 10:20:57 PM",
"lastOpDate": "Nov 14, 2017 10:20:57 PM"
}
]
}
MDEV Device Inventory
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The UUID. For more information, see Resource Property. | 3.5.0 | ||
| name | The name. For more information, see Resource Property. | 3.5.0 | ||
| description | The description. For more information, see Resource Property. | Yes | 3.5.0 | |
| parentUuid | The physical PCI device UUID. | 3.5.0 | ||
| hostUuid | The host UUID. | 3.5.0 | ||
| vmInstanceUuid | The VM instance UUID. | 3.5.0 | ||
| mdevSpecUuid | The UUID of the MDEV device specification. | 3.5.0 | ||
| type | The type. |
|
3.5.0 | |
| state | The state. |
|
3.5.0 | |
| status |
|
3.5.0 | ||
| groupBy | Groups rows into subgroups based on values of columns or expressions. This field is equivalent to the Group By clause in MySQL, such as groupBy=type. | Yes | 3.5.0 | |
| createDate | The creation date. For more information, see Resource Property. | 3.5.0 | ||
| lastOpDate | The last operation date. For more information, see Resource Property. | 3.5.0 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.5.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.5.0 |
Sample
{
"inventories": [
{
"uuid": "597624b580d1458f82671b0ef77cf6a4",
"name": "GRID M60-2A",
"parentUuid": "90c171f07b21452b87b6d5ee58f4d687",
"hostUuid": "b440c9393fc644cc8394d789ea1e18e1",
"mdevSpecUuid": "91b07312092741f18a382942a92f1373",
"type": "GPU_Video_Controller",
"state": "Enabled",
"status": "Active",
"createDate": "Nov 14, 2017 10:20:57 PM",
"lastOpDate": "Nov 14, 2017 10:20:57 PM"
}
]
}
VM Instance and MDEV Device Specification Reference Inventory
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| vmInstanceUuid | The VM instance UUID. | 3.5.0 | ||
| mdevSpecUuid | The UUID of the MDEV device specification. | 3.5.0 | ||
| mdevDeviceNumber | The number of MDEV devices to be attached to the VM instance. Note that these devices must conform to the MDEV device specification. Default value: 1. | 3.5.0 | ||
| groupBy | Groups rows into subgroups based on values of columns or expressions. This field is equivalent to the Group By clause in MySQL, such as groupBy=type. | Yes | 3.5.0 | |
| createDate | The creation date. For more information, see Resource Property. | 3.5.0 | ||
| lastOpDate | The last operation date. For more information, see Resource Property. | 3.5.0 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.5.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.5.0 |
Sample
{
"inventories": [
{
"vmInstanceUuid": "56bfe280b3c84fe2abf1281a7050aabe",
"mdevSpecUuid": "461d734e25824e4e9516c4798fa27068",
"mdevDeviceNumber": 1.0,
"createDate": "Nov 14, 2017 10:20:57 PM",
"lastOpDate": "Nov 14, 2017 10:20:57 PM"
}
]
}
Operations
QueryPciDevice
Queries a PCI device. For example,
QueryPciDevice
Primitive Fields of Query
See PCI Device Inventory.
Nested and Expanded Fields of Query
| Field | Inventory | Description | Starting Version |
|---|---|---|---|
| host | Host Inventory | The host to which the PCI device belongs. | 3.4.0 |
| matchedPciDeviceOffering | PCI Device Offering Inventory | The PCI device offering. | 3.4.0 |
| matchedPciDeviceOfferingRef | PCI Device Offering Inventory | The PCI device offering list. | 3.4.0 |
| vmInstance | VM Inventory | The VM instance to which the PCI device is attached. | 3.4.0 |
UpdatePciDevice
Updates a PCI device. For example,
UpdatePciDevice uuid=47c749c4520c3c5ba2ddcb6bf725cc40 state=Enabled
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The resource UUID. | 2.1 | ||
| state | Yes |
|
2.1 | |
| description | The detailed description of the resource. | Yes | 2.1 | |
| metaData | Yes | 2.1 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 2.1 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 2.1 | |
| timeout | Yes |
DeletePciDevice
Deletes a PCI device. For example,
DeletePciDevice uuid=e48a9a18b86946af89ad991945942f6c
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The resource UUID. | |||
| deleteMode | Yes | |||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | ||
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | ||
| timeout | Yes |
GetPciDeviceCandidatesForAttachingVm
Obtains a PCI device list. For example,
GetPciDeviceCandidatesForAttachingVm vmInstanceUuid=99bc47cf68e340a1b0a85c874637ec7b
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| vmInstanceUuid | The VM instance UUID. | 2.1 | ||
| types | Yes | 2.1 | ||
| userTags | The user tags. For more information, see CreateUserTag | Yes | 2.1 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 2.1 | |
| timeout | Yes |
GetPciDeviceCandidatesForNewCreateVm
Obtains PCI devices that can be attached. For example,
GetPciDeviceCandidatesForNewCreateVm
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| hostUuid | The host UUID. | Yes | 2.4 | |
| clusterUuids | Yes | 2.4 | ||
| types | Yes | 2.4 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 2.4 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 2.4 | |
| timeout | Yes |
AttachPciDeviceToVm
Attaches a PCI device to a VM instance. For example,
AttachPciDeviceToVm pciDeviceUuid=b17bee8ff0814edc9661a65b281d2d78 vmInstanceUuid=4d0454694e264b2cafaa2adfd3e48602
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| pciDeviceUuid | The PCI device UUID. | 2.1 | ||
| vmInstanceUuid | The VM instance UUID. | 2.1 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 2.1 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 2.1 | |
| timeout | Yes |
DetachPciDeviceFromVm
Detaches a PCI device from a VM instance. For example,
DetachPciDeviceFromVm pciDeviceUuid=056dbc6f8170409a953c120a16a87d18 vmInstanceUuid=3b1256e08a6544f4abe7de5b9ea81970
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| pciDeviceUuid | The PCI device UUID. | 2.1 | ||
| vmInstanceUuid | The VM instance UUID. | 2.1 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 2.1 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 2.1 | |
| timeout | Yes |
CreatePciDeviceOffering
Creates a PCI device offering. For example,
CreatePciDeviceOffering vendorId=10de deviceId=0e0f
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| name | The resource name. | Yes | 2.1 | |
| description | The detailed description of the resource. | Yes | 2.1 | |
| type | Yes | 2.1 | ||
| vendorId | The vendor ID. | 2.1 | ||
| deviceId | The device ID. | 2.1 | ||
| subvendorId | The sub-vendor ID. | Yes | 2.1 | |
| subdeviceId | The sub-device ID. | Yes | 2.1 | |
| resourceUuid | Yes | 2.1 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 2.1 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 2.1 | |
| timeout | Yes |
DeletePciDeviceOffering
Deletes a PCI device offering. For example,
DeletePciDeviceOffering uuid=900f2eefdec630c68313eb025123375d
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The resource UUID. | 2.1 | ||
| deleteMode | The delete mode. | Yes | 2.1 | |
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 2.1 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 2.1 | |
| timeout | Yes |
QueryPciDeviceOffering
Queries a PCI device offering. For example,
QueryPciDeviceOffering
Primitive Fields of Query
See PCI Device Offering Inventory.
Nested and Expanded Fields of Query
| Field | Inventory | Description | Starting Version |
|---|---|---|---|
| attachedInstanceOfferingRef | Instance Offering Inventory | The attached instance offering list. | 2.1 |
| attachedInstanceOfferings | Instance Offering Inventory | The attached instance offering. | 2.1 |
| matchedPciDevice | PCI Device Inventory | The matched PCI device. | 2.1 |
| matchedPciDevices | PCI Device Inventory | The matched PCI device. | 2.1 |
QueryPciDevicePciDeviceOffering
Queries a matched PCI device offering. For example,
QueryPciDevicePciDeviceOffering
Primitive Fields of Query
See PCI Device and PCI Device Offering Reference Inventory.
Nested and Expanded Fields of Query
| Field | Inventory | Description | Starting Version |
|---|---|---|---|
| pciDevice | PCI Device Inventory | The matched PCI device. | 2.1 |
| pciDeviceOffering | PCI Device Offering Inventory | The matched PCI offering. | 2.1 |
GetHostIommuStatus
Obtains the host IOMMU status. For example,
GetHostIommuStatus uuid=5dd20f6d5e414a15a8923f349758b5ff
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The resource UUID. | 2.1 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 2.1 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 2.1 | |
| timeout | Yes |
UpdateHostIommuState
Updates the host IOMMU state. For example,
UpdateHostIommuState uuid=b86c9016b4f24953a9edefb53ca0678c state=Enabled
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The resource UUID. | 2.1 | ||
| state |
|
2.1 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 2.1 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 2.1 | |
| timeout | Yes |
GetHostIommuState
Obtains the host IOMMU state. For example,
GetHostIommuState uuid=637890e6fd754515a256c9c105d5c1c7
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The resource UUID. | 2.1 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 2.1 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 2.1 | |
| timeout | Yes |
AddPciDeviceSpecToVmInstance
Adds a PCI device specification to a VM instance. For example,
AddPciDeviceSpecToVmInstance pciSpecUuid=f9e3605232d343d99bca77ba13c1ca34 vmInstanceUuid=ed0836204dbd496bb9cfa25f091d9d4a
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| pciSpecUuid | The PCI device specification UUID. | 3.5.0 | ||
| vmInstanceUuid | The VM instance UUID. | 3.5.0 | ||
| pciDeviceNumber | Yes | 3.5.0 | ||
| userTags | The user tags. For more information, see CreateUserTag | Yes | 3.5.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.5.0 | |
| timeout | Yes |
RemovePciDeviceSpecFromVmInstance
Removes a PCI device specification from a VM instance. For example,
RemovePciDeviceSpecFromVmInstance pciSpecUuid=f9e3605232d343d99bca77ba13c1ca34 vmInstanceUuid=ed0836204dbd496bb9cfa25f091d9d4a
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| pciSpecUuid | The PCI device specification UUID. | 3.5.0 | ||
| vmInstanceUuid | The VM instance UUID. | 3.5.0 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.5.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.5.0 | |
| timeout | Yes |
UpdatePciDeviceSpec
Updates a PCI device specification. For example,
UpdatePciDeviceSpec uuid=ff483f5d5bf14587ac2d46a565b0f28f state=Disabled
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The resource UUID. | 3.5.0 | ||
| name | The resource name. | Yes | 3.5.0 | |
| description | The detailed description of the resource. | Yes | 3.5.0 | |
| romContent | The ROM content encoded in Base64 format. | Yes | 3.5.0 | |
| romVersion | The ROM version. | Yes | 3.5.0 | |
| abandonSpecRom | Whether to delete the existing ROM. | Yes | 3.5.0 | |
| state | The state of the PCI device specification. | Yes |
|
3.5.0 |
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.5.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.5.0 | |
| timeout | Yes |
GetPciDeviceSpecCandidates
Obtains a list of candidate PCI device specifications. For example,
GetPciDeviceSpecCandidates hostUuid=87aceed20b6a46fbb4e45b74a514afd9
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| clusterUuids | The cluster UUID. | Yes | 3.5.0 | |
| hostUuid | The host UUID. | Yes | 3.5.0 | |
| vmInstanceUuid | The VM instance UUID. | Yes | 3.5.0 | |
| vmInstanceUuids | The VM instance UUID list. | Yes | 3.6.1 | |
| types | The device type. | Yes | 3.5.0 | |
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.5.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.5.0 | |
| timeout | Yes |
QueryPciDeviceSpec
Queries a PCI device specification. For example,
QueryPciDeviceSpec
Primitive Fields of Query
QueryVmInstancePciDeviceSpecRef
Queries the reference between a VM instance and a PCI device specification. For example,
QueryVmInstancePciDeviceSpecRef
Primitive Fields of Query
See VM Instance and PCI Device Specification Reference Inventory.
Nested and Expanded Fields of Query
| Field | Inventory | Description | Starting Version |
|---|---|---|---|
| pciSpec | PCI Specification Inventory | The PCI device specification. | 3.5.0 |
| vmInstance | VM Instance Inventory | The VM instance associated with the PCI device specification. | 3.5.0 |
GenerateSriovPciDevices
Segments a PCI device that supports SR-IOV. For example,
GenerateSriovPciDevices pciDeviceUuid=ce07829a08273d129f3b9d11cdf830b9 virtPartNum=4.0
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| pciDeviceUuid | The PCI device UUID. | 3.5.0 | ||
| virtPartNum | The number of virtual functions. | 3.5.0 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.5.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.5.0 | |
| timeout | Yes |
UngenerateSriovPciDevices
Restores a PCI device that supports SR-IOV. For example,
UngenerateSriovPciDevices pciDeviceUuid=ce07829a08273d129f3b9d11cdf830b9
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| pciDeviceUuid | The PCI device UUID. | 3.5.0 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.5.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.5.0 | |
| timeout | Yes |
GenerateMdevDevices
Segments a PCI device that supports VFIO_MDEV. For example,
GenerateMdevDevices pciDeviceUuid=b5b60d1bc9353c948c635a500a044c97 mdevSpecUuid=013f5f259daa3e119ec79496ed2f5697
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| pciDeviceUuid | The PCI device UUID. | 3.5.0 | ||
| mdevSpecUuid | The UUID of the MDEV device specification. | 3.5.0 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.5.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.5.0 | |
| timeout | Yes |
UngenerateMdevDevices
Restores a PCI device that supports VFIO_MDEV. For example,
UngenerateMdevDevices pciDeviceUuid=772a0f2d8aaa3626964e080122a48c25
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| pciDeviceUuid | The UUID of the PCI device from which the MDEV device is generated. | 3.5.0 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.5.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.5.0 | |
| timeout | Yes |
QueryMdevDeviceSpec
Queries an MDEV device that is segmented from a PCI device. For example,
QueryMdevDeviceSpec
Primitive Fields of Query
AttachMdevDeviceToVm
Attaches an MDEV device, which is segmented from a PCI device, to a VM instance. For example,
AttachMdevDeviceToVm mdevDeviceUuid=072b847576c34b419a29b16f62198e09 vmInstanceUuid=e4108c6e45303e3bbd9743093127b894
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| mdevDeviceUuid | The MDEV device UUID. | 3.5.0 | ||
| vmInstanceUuid | The VM instance UUID. | 3.5.0 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.5.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.5.0 | |
| timeout | Yes |
DetachMdevDeviceFromVm
Detaches an MDEV device, which is segmented from a PCI device, from a VM instance. For example,
DetachMdevDeviceFromVm mdevDeviceUuid=4c2897ae50b8370489aa2e0caa96d370 vmInstanceUuid=16aefa196d5535f6836ec25d301ee3aa
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| mdevDeviceUuid | The MDEV device UUID. | 3.5.0 | ||
| vmInstanceUuid | The VM instance UUID. | 3.5.0 | ||
| deleteMode | The delete mode. Options: Permissive | Enforcing. Default mode: Permissive. | Yes | 3.5.0 | |
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.5.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.5.0 | |
| timeout | Yes |
UpdateMdevDevice
Updates the MDEV device that is segmented from a PCI device. For example,
UpdateMdevDevice uuid=d026caddef774497aaf494d032fc8d61 state=Disabled
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The resource UUID. | 3.5.0 | ||
| name | The resource name. | Yes | 3.5.0 | |
| description | The detailed description of the resource. | Yes | 3.5.0 | |
| state | The state of the MDEV device. | Yes |
|
3.5.0 |
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.5.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.5.0 | |
| timeout | Yes |
GetMdevDeviceCandidates
Obtains the available MDEV devices. For example,
GetMdevDeviceCandidates hostUuid=f1c21432e12245e78ee05324bb0886b4
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| clusterUuids | The cluster UUID. | Yes | 3.5.0 | |
| hostUuid | The host UUID. | Yes | 3.5.0 | |
| vmInstanceUuid | The VM instance UUID. | Yes | 3.5.0 | |
| types | The device types. | Yes | 3.5.0 | |
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.5.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.5.0 | |
| timeout | Yes |
QueryMdevDevice
Queries the MDEV device that is segmented from a PCI device. For example,
QueryMdevDevice
Primitive Fields of Query
Nested and Expanded Fields of Query
| Field | Inventory | Description | Starting Version |
|---|---|---|---|
| host | Host Inventory | The host to which the MDEV device belongs. | 3.5.0 |
| mdevDeviceSpec | MDEV Device Specification Inventory | The MDEV device specification. | 3.5.0 |
| parent | Parent Inventory | The parent device. | 3.5.0 |
| vmInstance | VM Instance Inventory | The VM instance to which the MDEV device is attached. | 3.5.0 |
AddMdevDeviceSpecToVmInstance
Adds an MDEV device specification to a VM instance. For example,
AddMdevDeviceSpecToVmInstance mdevSpecUuid=aa2e5e2cd0e749fab48ed045117ed70b vmInstanceUuid=e2af8f869eff49d2a3d6f86cadc27090
Parameters
| Name | Description | Optional | Valid Value| | Starting Version |
|---|---|---|---|---|
| mdevSpecUuid | The UUID of the MDEV device specification. | 3.5.0 | ||
| vmInstanceUuid | The VM instance UUID. | 3.5.0 | ||
| mdevDeviceNumber | Yes | 3.5.0 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.5.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.5.0 | |
| timeout | Yes |
RemoveMdevDeviceSpecFromVmInstance
Removes an MDEV device specification from a VM instance. For example,
RemoveMdevDeviceSpecFromVmInstance mdevSpecUuid=195f9b240d4a3f8b9946950694745fff vmInstanceUuid=76ce5da88e383ee983955f3a24aea5cf
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| mdevSpecUuid | The UUID of the MDEV device specification. | 3.5.0 | ||
| vmInstanceUuid | The VM instance UUID. | 3.5.0 | ||
| deleteMode | The delete mode. Options: Permissive | Enforcing. Default mode: Permissive. | Yes | 3.5.0 | |
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.5.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.5.0 | |
| timeout | Yes |
UpdateMdevDeviceSpec
Updates an MDEV device specification. For example,
UpdateMdevDeviceSpec uuid=7cb7791f5c334fa699670765199e47ae state=Enabled
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The resource UUID. | 3.5.0 | ||
| name | The resource name. | Yes | 3.5.0 | |
| description | The detailed description of the resource. | Yes | 3.5.0 | |
| state | The specification state. | Yes |
|
3.5.0 |
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.5.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.5.0 | |
| timeout | Yes |
GetMdevDeviceSpecCandidates
Obtains an MDEV device specification. For example,
GetMdevDeviceSpecCandidates hostUuid=319897b485313c7a96b0af986b91baea
Parameters
| Name | Description | Description | Valid Value | Starting Version |
|---|---|---|---|---|
| clusterUuids | The cluster UUID. | Yes | 3.5.0 | |
| hostUuid | The host UUID. | Yes | 3.5.0 | |
| vmInstanceUuid | The VM instance UUID. | Yes | 3.5.0 | |
| vmInstanceUuids | The VM instance UUID list. | Yes | 3.6.1 | |
| types | The device types. | Yes | 3.5.0 | |
| userTags | The user tags. For more information, see CreateUserTag | Yes | 3.5.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.5.0 | |
| timeout | Yes |
QueryVmInstanceMdevDeviceSpecRef
Queries the reference between a VM instance and an MDEV device specification. For example,
QueryVmInstanceMdevDeviceSpecRef
Primitive Fields of Query
See VM Instance and MDEV Device Specification Reference Inventory.
Nested and Expanded Fields of Query
| Field | Inventory | Description | Starting Version |
|---|---|---|---|
| mdevSpec | MDEV Specification Inventory | The MDEV device specification. | 3.5.0 |
| vmInstance | VM Instance Inventory | The VM instance associated with the MDEV device specification. | 3.5.0 |
Tags
You can create a tag on a PCI device offering by using resourceType=PciDeviceOfferingVO. For example,
CreateUserTag resourceType=PciDeviceOfferingVO tag=PciDeviceOffering \
resourceUuid=043ef942ef97460bba5c9381bb7a7455
