文档目录

PCI设备相关接口

概览

ZStack Cloud支持将PCI设备提供给云主机使用。目前主要支持GPU透传以及vGPU两种方式将GPU设备提供给云主机使用。
  • ZStack支持物理GPU透传功能,物理GPU可携带其上全部外设(包括:GPU显卡、GPU声卡、以及其它GPU上的小设备)以为单位整体透传给云主机使用,让云主机享有物理机强劲的GPU并行计算能力。该功能适用于3D渲染、高清转解码、以及具备高密集运算特点的高性能计算(HPC)场景,如:机器学习、医疗成像、石油勘探数据分析、比特币挖掘等。

    ZStack支持以下型号的物理GPU透传:
    NVIDIA AMD
    • Tesla T4
    • Tesla M6/M10/M60
    • Tesla P100/P40/P6/P4
    • Tesla V100
    • RTX 6000/8000
    • 等等...
    • FirePro S7150
    • FirePro S7150X2
    Note: NVIDIA显卡支持透传的型号较多,仅列举常用显卡,更多详情请参考NVIDIA官方文档
  • ZStack支持vGPU功能,通过GPU虚拟化技术,将物理GPU切割成更细粒度的 vGPU,形成vGPU资源池。用户可使用vGPU规格快速创建轻量的vGPU云主机,实现更灵活弹性的资源部署、提高资源利用率、以及节约成本。该功能适用于云游戏、VDI、VR/AR、AI推理以及机器学习教学等轻量级GPU计算场景。

    ZStack支持对以下型号显卡进行虚拟化切割:
    NVIDIA AMD
    • Tesla T4
    • Tesla M6/M10/M60
    • Tesla P100/P40/P6/P4
    • Tesla V100
    • RTX 6000/8000
    • 更多请参考NVIDIA官方文档
    • FirePro S7150
    • FirePro S7150X2
    Note: NVIDIA显卡支持虚拟化切割的型号较多,仅列举常用显卡,更多详情请参考NVIDIA官方文档

清单

PCI设备清单(PciDevice inventory)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 请参见 资源属性 2.1
name 请参见 资源属性 2.1
description 请参见 资源属性 2.1
hostUuid 物理机UUID 2.1
parentUuid 物理PCI设备UUID 3.5.0
vmInstanceUuid 云主机UUID 2.1
pciSpecUuid PCI设备规格UUID 3.5.0
vendorId 供应商ID 2.1
deviceId 设备ID 2.1
subvendorId 子供应商ID 2.1
subdeviceId 子设备ID 2.1
pciDeviceAddress PCI设备地址 2.1
type 类型 2.1
state 2.1
status 状态 2.1
virtStatus 3.5.0
metaData 2.1
matchedPciDeviceOfferingRef 2.1
mdevSpecRefs 3.5.0
groupBy 以字段分组,相当于MySQL中的group by关键字。例如groupBy=type 2.1
createDate 请参见 资源属性 2.1
lastOpDate 请参见 资源属性 2.1
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 2.1
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 2.1

PCI设备规格信息清单(PciDeviceOffering inventory)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 请参见 资源属性 2.1
name 请参见 资源属性 2.1
description 请参见 资源属性 2.1
groupBy 以字段分组,相当于MySQL中的group by关键字。例如groupBy=type 2.1
createDate 请参见 资源属性 2.1
lastOpDate 请参见 资源属性 2.1
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 2.1
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 2.1

PCI设备规格匹配清单(PciDevicePciDeviceOffering inventory)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 请参见 资源属性 2.1
description 请参见 资源属性 2.1
hostUuid 物理机UUID 2.1
vmInstanceUuid 云主机UUID 2.1
vendorId 2.1
deviceId 2.1
subvendorId 2.1
subdeviceId 2.1
pciDeviceAddress PCI设备地址 2.1
status 2.1
state 2.1
type 类型 2.1
metaData 2.1
matchedPciDeviceOfferingRef 2.1
groupBy 以字段分组,相当于MySQL中的group by关键字。例如groupBy=type 2.1
createDate 请参见 资源属性 2.1
lastOpDate 请参见 资源属性 2.1
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 2.1
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 2.1

PCI设备规格清单(PciDeviceSpec inventory)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 请参见 资源属性 3.5.0
name 请参见 资源属性 3.5.0
description 请参见 资源属性 3.5.0
vendorId 供应商ID 3.5.0
deviceId 设备ID 3.5.0
subvendorId 子供应商ID 3.5.0
subdeviceId 子设备ID 3.5.0
ramSize 显存容量 3.5.0
maxPartNum 最大切分数量 3.5.0
isVirtual 是否虚拟设备 3.5.0
romVersion 固件版本 3.5.0
romMd5sum 固件MD5 3.5.0
type 类型
  • GPU_Video_Controller
  • GPU_Audio_Controller
  • GPU_3D_Controller
  • Moxa_Device
  • Generic
3.5.0
state 状态
  • Enabled
  • Disabled
3.5.0
groupBy 以字段分组,相当于MySQL中的group by关键字。例如groupBy=type 3.5.0
createDate 请参见 资源属性 3.5.0
lastOpDate 请参见 资源属性 3.5.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 3.5.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 3.5.0
示例
{
  "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"
    }
  ]
}

云主机与PCI设备规格的关联关系清单(VmInstancePciDeviceSpecRef inventory)

名字 描述 可选的 可选的参数值 起始支持版本
vmInstanceUuid 云主机UUID 3.5.0
pciSpecUuid PCI设备规格UUID 3.5.0
pciDeviceNumber 需要为云主机挂载的符合设备规格的设备个数,默认为1 3.5.0
groupBy 以字段分组,相当于MySQL中的group by关键字。例如groupBy=type 3.5.0
createDate 请参见 资源属性 3.5.0
lastOpDate 请参见 资源属性 3.5.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 3.5.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 3.5.0
示例
{
  "inventories": [
    {
      "vmInstanceUuid": "c40d04f99f7647f2bf145aa6e3d463ff",
      "pciSpecUuid": "9afda707d3b14838adaa48d4295f3d5f",
      "pciDeviceNumber": 1.0,
      "createDate": "Nov 14, 2017 10:20:57 PM",
      "lastOpDate": "Nov 14, 2017 10:20:57 PM"
    }
  ]
}

PCI设备切分出的MDEV设备清单(MdevDeviceSpec inventory)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 请参见 资源属性 3.5.0
name 请参见 资源属性 3.5.0
description 请参见 资源属性 3.5.0
specification 规格详情 3.5.0
type 类型
  • GPU_Video_Controller
3.5.0
state 状态
  • Enabled
  • Disabled
3.5.0
groupBy 以字段分组,相当于MySQL中的group by关键字。例如groupBy=type 3.5.0
createDate 请参见 资源属性 3.5.0
lastOpDate 请参见 资源属性 3.5.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 3.5.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 3.5.0
示例
{
  "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"
    }
  ]
}

PCI设备切分出的MDEV设备清单(MdevDevice inventory)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 请参见 资源属性 3.5.0
name 请参见 资源属性 3.5.0
description 请参见 资源属性 3.5.0
parentUuid 物理PCI设备UUID 3.5.0
hostUuid 物理机UUID 3.5.0
vmInstanceUuid 云主机UUID 3.5.0
mdevSpecUuid MDEV设备规格UUID 3.5.0
type 类型
  • GPU_Video_Controller
3.5.0
state 状态
  • Enabled
  • Disabled
3.5.0
status
  • Active
  • Attached
3.5.0
groupBy 以字段分组,相当于MySQL中的group by关键字。例如groupBy=type 3.5.0
createDate 请参见 资源属性 3.5.0
lastOpDate 请参见 资源属性 3.5.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 3.5.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 3.5.0
示例
{
  "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"
    }
  ]
}

云主机与MDEV设备规格的关联关系清单(VmInstanceMdevDeviceSpecRef inventory)

名字 描述 可选的 可选的参数值 起始支持版本
vmInstanceUuid 云主机UUID 3.5.0
mdevSpecUuid MDEV设备规格UUID 3.5.0
mdevDeviceNumber 需要为云主机挂载的符合设备规格的设备个数,默认为1 3.5.0
groupBy 以字段分组,相当于MySQL中的group by关键字。例如groupBy=type 3.5.0
createDate 请参见 资源属性 3.5.0
lastOpDate 请参见 资源属性 3.5.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 3.5.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 3.5.0
示例
{
  "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)

查询PCI设备(QueryPciDevice)

管理员可以使用QueryPciDevice查询PCI设备。例如:
QueryPciDevice 

原生域查询(Primitive Fields of Query)

请参见 PCI设备清单(PciDevice inventory)

嵌套和扩展域查询(Nested And Expanded Fields of Query)

域(Field) 清单(Inventory) 描述 起始支持版本
host host inventory PCI所在的物理机 3.4.0
matchedPciDeviceOffering PCI设备规格信息清单(PciDeviceOffering inventory) PCI设备规格 3.4.0
matchedPciDeviceOfferingRef PCI设备规格信息清单(PciDeviceOffering inventory) PCI设备规格列表 3.4.0
vmInstance vm inventory PCI绑定的云主机 3.4.0

更新PCI设备(UpdatePciDevice)

用户可以使用UpdatePciDevice更新PCI设备。 例如:
UpdatePciDevice uuid=47c749c4520c3c5ba2ddcb6bf725cc40 state=Enabled

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 资源的UUID,唯一标示该资源 2.1
state
  • Enabled
  • Disabled
2.1
description 资源的详细描述 2.1
metaData 2.1
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 2.1
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 2.1
timeout

删除PCI设备(DeletePciDevice)

用户可以使用DeletePciDevice删除PCI设备。 例如:
DeletePciDevice uuid=e48a9a18b86946af89ad991945942f6c

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 资源的UUID,唯一标示该资源
deleteMode
userTags 用户标签,请参见 创建用户标签(CreateUserTag)
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag)
timeout

获取PCI设备列表(GetPciDeviceCandidatesForAttachingVm)

用户可以使用GetPciDeviceCandidatesForAttachingVm获取PCI设备列表。 例如:
GetPciDeviceCandidatesForAttachingVm vmInstanceUuid=99bc47cf68e340a1b0a85c874637ec7b

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
vmInstanceUuid 云主机UUID 2.1
types 2.1
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 2.1
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 2.1
timeout

获取可加载PCI设备(GetPciDeviceCandidatesForNewCreateVm)

用户可以使用GetPciDeviceCandidatesForNewCreateVm获取可加载PCI设备。 例如:
GetPciDeviceCandidatesForNewCreateVm 

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
hostUuid 物理机UUID 2.4
clusterUuids 2.4
types 2.4
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 2.4
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 2.4
timeout

绑定PCI设备到云主机(AttachPciDeviceToVm)

用户可以使用AttachPciDeviceToVm绑定PCI设备到云主机。 例如:
AttachPciDeviceToVm pciDeviceUuid=b17bee8ff0814edc9661a65b281d2d78 vmInstanceUuid=4d0454694e264b2cafaa2adfd3e48602

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
pciDeviceUuid PCI设备UUID 2.1
vmInstanceUuid 云主机UUID 2.1
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 2.1
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 2.1
timeout

卸载PCI设备(DetachPciDeviceFromVm)

用户可以使用DetachPciDeviceFromVm卸载PCI设备。 例如:
DetachPciDeviceFromVm pciDeviceUuid=056dbc6f8170409a953c120a16a87d18 vmInstanceUuid=3b1256e08a6544f4abe7de5b9ea81970

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
pciDeviceUuid 2.1
vmInstanceUuid 云主机UUID 2.1
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 2.1
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 2.1
timeout

创建PCI设备规格(CreatePciDeviceOffering)

用户可以使用CreatePciDeviceOffering创建PCI设备规格。 例如:
CreatePciDeviceOffering vendorId=10de deviceId=0e0f

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
name 资源名称 2.1
description 资源的详细描述 2.1
type 2.1
vendorId 供应商ID 2.1
deviceId 产品ID 2.1
subvendorId 子供应商ID 2.1
subdeviceId 子设备ID 2.1
resourceUuid 2.1
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 2.1
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 2.1
timeout

删除PCI设备规格(DeletePciDeviceOffering)

用户可以使用DeletePciDeviceOffering删除PCI设备规格。 例如:
DeletePciDeviceOffering uuid=900f2eefdec630c68313eb025123375d

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 资源的UUID,唯一标示该资源 2.1
deleteMode 删除模式 2.1
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 2.1
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 2.1
timeout

查询PCI设备规格信息(QueryPciDeviceOffering)

管理员可以使用QueryPciDeviceOffering查询PCI设备规格信息。例如:
QueryPciDeviceOffering 

原生域查询(Primitive Fields of Query)

请参见 PCI设备规格信息清单(PciDeviceOffering inventory)

嵌套和扩展域查询(Nested And Expanded Fields of Query)

域(Field) 清单(Inventory) 描述 起始支持版本
attachedInstanceOfferingRef InstanceOffering inventory 附加的规格列表 2.1
attachedInstanceOfferings InstanceOffering inventory 附加的规格 2.1
matchedPciDevice PCI设备清单(PciDevice inventory) 匹配的PCI设备 2.1
matchedPciDevices PCI设备清单(PciDevice inventory) 匹配的PCI设备 2.1

查询PCI设备规格匹配(QueryPciDevicePciDeviceOffering)

管理员可以使用QueryPciDevicePciDeviceOffering查询PCI设备规格匹配。例如:
QueryPciDevicePciDeviceOffering 

原生域查询(Primitive Fields of Query)

请参见PCI设备规格匹配清单(PciDevicePciDeviceOffering inventory)

嵌套和扩展域查询(Nested And Expanded Fields of Query)

域(Field) 清单(Inventory) 描述 起始支持版本
pciDevice PCI设备清单(PciDevice inventory) 匹配的PCI设备 2.1
pciDeviceOffering PCI设备规格信息清单(PciDeviceOffering inventory) 匹配的PCI规格 2.1

获取物理机lommu启用状态(GetHostIommuStatus)

用户可以使用GetHostIommuStatus获取物理机lommu启用状态。 例如:
GetHostIommuStatus uuid=5dd20f6d5e414a15a8923f349758b5ff

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 资源的UUID,唯一标示该资源 2.1
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 2.1
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 2.1
timeout

更新物理机Iommu启用状态(UpdateHostIommuState)

用户可以使用UpdateHostIommuState更新物理机Iommu启用状态。 例如:
UpdateHostIommuState uuid=b86c9016b4f24953a9edefb53ca0678c state=Enabled

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 资源的UUID,唯一标示该资源 2.1
state
  • Enabled
  • Disabled
2.1
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 2.1
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 2.1
timeout

获取物理机lommu就绪状态(GetHostIommuState)

用户可以使用GetHostIommuState获取物理机lommu就绪状态。 例如:
GetHostIommuState uuid=637890e6fd754515a256c9c105d5c1c7

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 资源的UUID,唯一标示该资源 2.1
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 2.1
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 2.1
timeout

将PCI设备规格加载到云主机(AddPciDeviceSpecToVmInstance)

用户可以使用AddPciDeviceSpecToVmInstance将PCI设备规格加载到云主机。 例如:
AddPciDeviceSpecToVmInstance pciSpecUuid=f9e3605232d343d99bca77ba13c1ca34 vmInstanceUuid=ed0836204dbd496bb9cfa25f091d9d4a

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
pciSpecUuid PCI设备规格UUID 3.5.0
vmInstanceUuid 云主机UUID 3.5.0
pciDeviceNumber 3.5.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 3.5.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 3.5.0
timeout

将PCI设备规格从云主机卸载(RemovePciDeviceSpecFromVmInstance)

用户可以使用RemovePciDeviceSpecFromVmInstance将PCI设备规格从云主机卸载。 例如:
RemovePciDeviceSpecFromVmInstance pciSpecUuid=f9e3605232d343d99bca77ba13c1ca34 vmInstanceUuid=ed0836204dbd496bb9cfa25f091d9d4a

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
pciSpecUuid PCI设备规格UUID 3.5.0
vmInstanceUuid 云主机UUID 3.5.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 3.5.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 3.5.0
timeout

更新PCI设备规格(UpdatePciDeviceSpec)

用户可以使用UpdatePciDeviceSpec更新PCI设备规格。 例如:
UpdatePciDeviceSpec uuid=ff483f5d5bf14587ac2d46a565b0f28f state=Disabled

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 资源的UUID,唯一标示该资源 3.5.0
name 资源名称 3.5.0
description 资源的详细描述 3.5.0
romContent BASE64编码后的固件内容 3.5.0
romVersion 固件版本 3.5.0
abandonSpecRom 删除已有固件 3.5.0
state PCI设备规格启用状态
  • Enabled
  • Disabled
3.5.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 3.5.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 3.5.0
timeout

获取PCI设备规格候选列表(GetPciDeviceSpecCandidates)

用户可以使用GetPciDeviceSpecCandidates获取PCI设备规格候选列表。 例如:
GetPciDeviceSpecCandidates hostUuid=87aceed20b6a46fbb4e45b74a514afd9

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
clusterUuids 集群UUID 3.5.0
hostUuid 物理机UUID 3.5.0
vmInstanceUuid 云主机UUID 3.5.0
vmInstanceUuids 云主机UUID列表 3.6.1
types 设备类型 3.5.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 3.5.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 3.5.0
timeout

查询PCI设备规格(QueryPciDeviceSpec)

管理员可以使用QueryPciDeviceSpec查询PCI设备规格。例如:
QueryPciDeviceSpec 

原生域查询(Primitive Fields of Query)

请参见 PCI设备规格清单(PciDeviceSpec inventory)

查询云主机与PCI设备规格的关联关系(QueryVmInstancePciDeviceSpecRef)

管理员可以使用QueryVmInstancePciDeviceSpecRef查询云主机与PCI设备规格的关联关系。例如:
QueryVmInstancePciDeviceSpecRef

原生域查询(Primitive Fields of Query)

请参见 云主机与PCI设备规格的关联关系清单(VmInstancePciDeviceSpecRef inventory)

嵌套和扩展域查询(Nested And Expanded Fields of Query)

域(Field) 清单(Inventory) 描述 起始支持版本
pciSpec pciSpec inventory PCI设备规格 3.5.0
vmInstance vminstance inventory PCI设备规格关联的云主机 3.5.0

虚拟化切分支持SR-IOV的PCI设备(GenerateSriovPciDevices)

用户可以使用GenerateSriovPciDevices虚拟化切分支持SR-IOV的PCI设备。 例如:
GenerateSriovPciDevices pciDeviceUuid=ce07829a08273d129f3b9d11cdf830b9 virtPartNum=4.0

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
pciDeviceUuid PCI UUID 3.5.0
virtPartNum 切分数量 3.5.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 3.5.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 3.5.0
timeout

虚拟化还原支持SR-IOV的PCI设备(UngenerateSriovPciDevices)

用户可以使用UngenerateSriovPciDevices虚拟化还原支持SR-IOV的PCI设备。 例如:
UngenerateSriovPciDevices pciDeviceUuid=ce07829a08273d129f3b9d11cdf830b9

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
pciDeviceUuid PCI UUID 3.5.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 3.5.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 3.5.0
timeout

虚拟化切分支持VFIO_MDEV的PCI设备(GenerateMdevDevices)

用户可以使用GenerateMdevDevices虚拟化切分支持VFIO_MDEV的PCI设备。 例如:
GenerateMdevDevices pciDeviceUuid=b5b60d1bc9353c948c635a500a044c97 mdevSpecUuid=013f5f259daa3e119ec79496ed2f5697

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
pciDeviceUuid PCI设备UUID 3.5.0
mdevSpecUuid MDEV设备规格UUID 3.5.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 3.5.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 3.5.0
timeout

虚拟化还原支持VFIO_MDEV的PCI设备(UngenerateMdevDevices)

用户可以使用UngenerateMdevDevices虚拟化还原支持VFIO_MDEV的PCI设备。 例如:
UngenerateMdevDevices pciDeviceUuid=772a0f2d8aaa3626964e080122a48c25

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
pciDeviceUuid 被切分的PCI设备UUID 3.5.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 3.5.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 3.5.0
timeout

查询PCI设备切分出的MDEV设备(QueryMdevDeviceSpec)

管理员可以使用QueryMdevDeviceSpec查询PCI设备切分出的MDEV设备。例如:
QueryMdevDeviceSpec 

原生域查询(Primitive Fields of Query)

请参见PCI设备切分出的MDEV设备清单(MdevDeviceSpec inventory)

将PCI设备切分出的MDEV设备绑定到云主机(AttachMdevDeviceToVm)

用户可以使用AttachMdevDeviceToVm将PCI设备切分出的MDEV设备绑定到云主机。 例如:
AttachMdevDeviceToVm mdevDeviceUuid=072b847576c34b419a29b16f62198e09 vmInstanceUuid=e4108c6e45303e3bbd9743093127b894

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
mdevDeviceUuid MDEV设备UUID 3.5.0
vmInstanceUuid 云主机UUID 3.5.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 3.5.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 3.5.0
timeout

将PCI设备切分出的MDEV设备从云主机卸载(DetachMdevDeviceFromVm)

用户可以使用DetachMdevDeviceFromVm将PCI设备切分出的MDEV设备从云主机卸载。 例如:
DetachMdevDeviceFromVm mdevDeviceUuid=4c2897ae50b8370489aa2e0caa96d370 vmInstanceUuid=16aefa196d5535f6836ec25d301ee3aa

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
mdevDeviceUuid MDEV设备UUID 3.5.0
vmInstanceUuid 云主机UUID 3.5.0
deleteMode 删除模式(Permissive 或者 Enforcing,默认 Permissive) 3.5.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 3.5.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 3.5.0
timeout

更新PCI设备切分出的MDEV设备(UpdateMdevDevice)

用户可以使用UpdateMdevDevice更新PCI设备切分出的MDEV设备。 例如:
UpdateMdevDevice uuid=d026caddef774497aaf494d032fc8d61 state=Disabled

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 资源的UUID,唯一标示该资源 3.5.0
name 资源名称 3.5.0
description 资源的详细描述 3.5.0
state 设备状态
  • Enabled
  • Disabled
3.5.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 3.5.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 3.5.0
timeout

获取可用的MDEV设备(GetMdevDeviceCandidates)

用户可以使用GetMdevDeviceCandidates获取可用的MDEV设备。 例如:
GetMdevDeviceCandidates hostUuid=f1c21432e12245e78ee05324bb0886b4

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
clusterUuids 集群UUID 3.5.0
hostUuid 物理机UUID 3.5.0
vmInstanceUuid 云主机UUID 3.5.0
types 设备类型 3.5.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 3.5.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 3.5.0
timeout

查询PCI设备切分出的MDEV设备(QueryMdevDevice)

管理员可以使用QueryMdevDevice查询PCI设备切分出的MDEV设备。例如:
QueryMdevDevice 

原生域查询(Primitive Fields of Query)

请参见 PCI设备切分出的MDEV设备清单(MdevDevice inventory)

嵌套和扩展域查询(Nested And Expanded Fields of Query)

域(Field) 清单(Inventory) 描述 起始支持版本
host host inventory MDEV设备所在物理机 3.5.0
mdevDeviceSpec mdevDeviceSpec inventory MDEV设备规格 3.5.0
parent parent inventory 父设备 3.5.0
vmInstance vminstance inventory MDEV设备加载的云主机 3.5.0

将MDEV设备规格加载到云主机(AddMdevDeviceSpecToVmInstance)

用户可以使用AddMdevDeviceSpecToVmInstance将MDEV设备规格加载到云主机。 例如:
AddMdevDeviceSpecToVmInstance mdevSpecUuid=aa2e5e2cd0e749fab48ed045117ed70b vmInstanceUuid=e2af8f869eff49d2a3d6f86cadc27090

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
mdevSpecUuid MDEV设备规格UUID 3.5.0
vmInstanceUuid 云主机UUID 3.5.0
mdevDeviceNumber 3.5.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 3.5.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 3.5.0
timeout

将MDEV设备规格从云主机卸载(RemoveMdevDeviceSpecFromVmInstance)

用户可以使用RemoveMdevDeviceSpecFromVmInstance将MDEV设备规格从云主机卸载。 例如:
RemoveMdevDeviceSpecFromVmInstance mdevSpecUuid=195f9b240d4a3f8b9946950694745fff vmInstanceUuid=76ce5da88e383ee983955f3a24aea5cf

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
mdevSpecUuid MDEV设备规格UUID 3.5.0
vmInstanceUuid 云主机UUID 3.5.0
deleteMode 删除模式(Permissive 或者 Enforcing,默认 Permissive) 3.5.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 3.5.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 3.5.0
timeout

更新MDEV设备规格(UpdateMdevDeviceSpec)

用户可以使用UpdateMdevDeviceSpec更新MDEV设备规格。 例如:
UpdateMdevDeviceSpec uuid=7cb7791f5c334fa699670765199e47ae state=Enabled

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 资源的UUID,唯一标示该资源 3.5.0
name 资源名称 3.5.0
description 资源的详细描述 3.5.0
state 规格状态
  • Enabled
  • Disabled
3.5.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 3.5.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 3.5.0
timeout

获取可用的MDEV设备规格(GetMdevDeviceSpecCandidates)

用户可以使用GetMdevDeviceSpecCandidates获取可用的MDEV设备规格。 例如:
GetMdevDeviceSpecCandidates hostUuid=319897b485313c7a96b0af986b91baea

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
clusterUuids 集群UUID 3.5.0
hostUuid 物理机UUID 3.5.0
vmInstanceUuid 云主机UUID 3.5.0
vmInstanceUuids 云主机UUID列表 3.6.1
types 设备类型 3.5.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 3.5.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 3.5.0
timeout

查询云主机与MDEV设备规格的关联关系(QueryVmInstanceMdevDeviceSpecRef)

管理员可以使用QueryVmInstanceMdevDeviceSpecRef查询云主机与MDEV设备规格的关联关系。例如:
QueryVmInstanceMdevDeviceSpecRef

原生域查询(Primitive Fields of Query)

请参见云主机与MDEV设备规格的关联关系清单(VmInstanceMdevDeviceSpecRef inventory)

嵌套和扩展域查询(Nested And Expanded Fields of Query)

域(Field) 清单(Inventory) 描述 起始支持版本
mdevSpec mdevSpec inventory MDEV设备规格 3.5.0
vmInstance vminstance inventory MDEV设备规格关联的云主机 3.5.0

标签(Tags)

用户可以使用resourceType=PciDeviceOfferingVO创建PCI设备规格标签。 例如:
CreateUserTag resourceType=PciDeviceOfferingVO tag=PciDeviceOffering \
resourceUuid=043ef942ef97460bba5c9381bb7a7455
CLI命令使用手册 | 5.5.30 | ZStack Cloud · ZCF | ZStack 资源中心