文档中心知识库API Explorer
文档中心›ZCF›ZStack Cloud›探索更多›CLI命令使用手册ZCF
文档目录

创建云主机（CreateVmInstance）

用户可以使用CreateVmInstance来创建一个云主机。 例如：
CreateVmInstance name=vm imageUuid=d720ff0c60ee48d3a2e6263dd3e12c33 \
instanceOfferingUuid=76789b62aeb542a5b4b8b8488fbaced2 \
l3NetworkUuids=37d3c4a1e2f14a1c8316a23531e62988
#创建云主机指定多网卡、默认L3网络
CreateVmInstance name=test imageUuid=ee14c7c8cc46309d821c51bbae3adb70 \
instanceOfferingUuid=1cf417bfd0e94175aea92131f1000011 \
l3NetworkUuids='ac5c7e736f1b499bbd0c12763b30051d,e315b2cb6151454bbab362a6e92909e7' \
defaultL3NetworkUuid=ac5c7e736f1b499bbd0c12763b30051d
#创建云主机指定多网卡、默认L3网络、指定静态IP、控制台vnc模式、设置vnc密码、高可用级别为NeverStop
CreateVmInstance name=test imageUuid=ee14c7c8cc46309d821c51bbae3adb70 \
instanceOfferingUuid=1cf417bfd0e94175aea92131f1000011 \
l3NetworkUuids='ac5c7e736f1b499bbd0c12763b30051d,e315b2cb6151454bbab362a6e92909e7' \
defaultL3NetworkUuid="ac5c7e736f1b499bbd0c12763b30051d" \
systemTags="consolePassword::123456","ha::NeverStop","vmConsoleMode::vnc","staticIp::ac5c7e736f1b499bbd0c12763b30051d::172.24.0.5"

参数（Parameters）

名字 描述 可选的 可选的参数值 起始支持版本
name 云主机名称，请参见 资源属性 0.6
resourceUuid 资源UUID， 若指定，云主机会使用该字段值作为UUID。请参见 创建(Create Resources) 是 0.6
description 云主机的详细描述，请参见 资源属性 是 0.6
instanceOfferingUuid 计算规格UUID。指定云主机的CPU、内存等参数 是 0.6
imageUuid 镜像UUID。云主机的根云盘会从该字段指定的镜像创建 0.6
l3NetworkUuids 三层网络UUID列表。可以指定一个或多个三层网络，云主机会在每个网络上创建一个网卡 0.6
type 云主机类型。保留字段，无需指定 是
  • UserVm
  • ApplianceVm
 0.6
rootDiskOfferingUuid 根云盘规格UUID。如果imageUuid字段指定的镜像类型是ISO，该字段必须指定以确定需要创建的根云盘大小。如果镜像类型是非ISO，该字段无需指定 是 0.6
dataDiskOfferingUuids 云盘规格UUID列表。可以指定一个或多个云盘规格UUID（UUID可以重复）为云主机创建一个或多个数据云盘 是 0.6
dataDiskSizes 自定义云盘大小列表。可以指定一个或多个云盘大小（可重复）为云主机创建一个或多个数据云盘。 是 4.4.6
zoneUuid 区域UUID。若指定，云主机会在指定区域创建。 是 0.6
clusterUuid 集群UUID。若指定，云主机会在指定集群创建，该字段优先级高于zoneUuid 是 0.6
hostUuid 物理机UUID。若指定，云主机会在指定物理机创建，该字段优先级高于zoneUuid和clusterUuid 是 0.6
defaultL3NetworkUuid 默认三层网络UUID。当在l3NetworkUuids指定了多个三层网络时，该字段指定提供默认路由的三层网络。若不指定，l3NetworkUuids的第一个网络被选为默认网络。 是 0.6
primaryStorageUuidForRootVolume 主存储UUID。若指定，云主机的根云盘会在指定主存储创建。 是 1.8
strategy 云主机创建策略，创建后立刻启动或创建后不启动。 是
  • InstantStart
  • JustCreate
  • CreateStopped
 0.6
tagUuids 标签UUID列表 是 3.4.0
userTags 用户标签，请参见 创建用户标签(CreateUserTag)；资源类型是 VmInstanceVO 是 0.6
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag)； 资源类型是 VmInstanceVO 是 0.6
dataVolumeSystemTagsOnIndex 是 4.4.24
rootVolumeSystemTags 云主机根盘所需要的系统标签 是 3.0
dataVolumeSystemTags 云主机数据盘所需要的系统标签 是 3.0
cpuNum 是 3.4.0
memorySize 是 3.4.0
rootDiskSize 是 3.4.0
sshKeyPairUuids 是 4.7.21
reservedMemorySize 是 4.7.21
Note:
  • ZStack Cloud创建云主机时支持亲和组功能，SystemTags增加affinityGroup选项。
    • 选项格式为：affinityGroupUuid::UUID
    • 例如：affinityGroupUuid::5fd71606d5af451d981413f35367a8d6
  • ZStack Cloud创建云主机时支持指定PCI设备，SystemTags增加PCI设备选项。
    • 选项格式为：pciDevice::UUID
    • 例如：pciDevice::634b48a7bca139d9944a0f95b0c2dddf
  • ZStack Cloud创建云主机时支持CPU绑定功能，SystemTags增加vmCpuPinning选项。
    • 选项格式为：vmCpuPinning::绑定策略
    • 例如：vmCpuPinning::1:3;1-3:4-7,^6
    • 仅admin支持更新、创建、删除该SystemTag。克隆云主机时，同时会克隆此SystemTag
  • ZStack Cloud创建云主机时支持userdata功能，SystemTags增加userdata选项。
    • 选项格式为：userdata::脚本的base64编码
    • 例如：userdata::I2Nsb3VkLWNvbmZpZwp1c2VyczoKIC0gbmFtZTogdGVzdAogICBzaGVsbDogL2Jpbi9iYXNoCiAgIGdyb3VwczogdXNlcnMKICAgc3VkbzogWydBTEw9KEFMTCkgTk9QQVNTV0Q6QUxMJ10KICAgc3NoLWF1dGhvcml6ZWQta2V5czoKICAgICAgIC0gc3NoLXJzYSBBQUFBQjNOemFDMUxYQ0pmanJvRDFsVCByb290QDEwLTAtMC0xOApib290Y21kOgogLSBta2RpciAvdG1wL3RlbXAgCndyaXRlX2ZpbGVzOgogLSBwYXRoOiAvdG1wL1pTdGFja19jb25maWcKICAgY29udGVudDogfAogICAgICAgSGVsbG8sd29ybGQhCiAgIHBlcm1pc3Npb25zOiAnMDc1NScKaG9zdG5hbWU6IFBlcmYtdGVzdApkaXNhYmxlX3Jvb3Q6IGZhbHNlCnNzaF9wd2F1dGg6IHllcwpjaHBhc3N3ZDoKICBsaXN0OiB8CiAgICAgIHJvb3Q6d29yZAogIGV4cGlyZTogRmFsc2UKcnVuY21kOgogLSBlY2hvIGxzIC1sIC8gPi9yb290L2xpc3Quc2g=
  • ZStack Cloud创建云主机时支持指定sshkey功能，SystemTags增加sshkey选项。
    • 选项格式为：sshkey::公钥内容
    • 例如：sshkey::ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDPAGDmLG2yW1fGQsek4PdBL6wiVMHuLrl566ITPAf8A2Oi5BaExoUwdPjA96OaUSrtlsKlrXUMGEJwN1r1TrL9JdUMg7jww3QysGuS3P+bRsBe1TSGHS8LNc9JY9HpoL4ZN/j0zTaZfju9eDzbVsbDrF91x3yDeeGH6IG6gWJn96HPfrlg7REfo04eBdflsTaaFC0lAXoBOrnGVnzRdQfwTNRGmMAyFzCV83HOhVzBJuL5VqtAT8a0lSC4QgZTNROh6zbkTUUYYQu0QS65EaJCTyAhksuidRzyjLX3p3oMileKdJNugRa5IDHhGJXExIK+58Nvaqfj/03yN8IfO7sj root@hpe-77
  • ZStack Cloud创建云主机时支持指定云主机高可用功能，SystemTags增加ha选项。
    • 选项格式为：ha::NeverStop
    • 例如：ha::NeverStop
  • ZStack Cloud创建云主机时支持指定云主机控制台模式，SystemTags增加vmConsoleMode选项。
    • 选项格式为：vmConsoleMode::控制台模式
    • 例如：vmConsoleMode::spice或者vmConsoleMode::vnc
  • ZStack Cloud创建云主机时支持指定云主机USB重定向功能，SystemTags增加usbRedirect选项。
    • 选项格式为：usbRedirect::true
    • 例如：usbRedirect::true
  • ZStack Cloud创建云主机时支持指定云主机控制台密码，SystemTags增加consolePassword选项。
    • 选项格式为：consolePassword::控制台密码
    • 例如：consolePassword::123456
  • ZStack Cloud创建云主机时支持指定L3的IP，SystemTags增加staticIp选项，若网络地址类型是双栈网络（IPv4+IPv6），可携带两个staticIp选项的SystemTags，分别配置IPv4地址和IPv6地址。
    • 选项格式为：staticIp::三层网络UUID::指定的IP
    • 例如：staticIp::f00d593dff2e4bd58473388ac411ade2::192.168.0.10
  • ZStack Cloud创建云主机时支持指定对应L3的网卡MAC地址，SystemTags增加customMac选项。
    • 选项格式为：customMac::三层网络UUID::指定的MAC地址
    • 例如：customMac::81a21a81cde84c1084c191354053a3b5::fa:00:37:ee:9f:00
  • ZStack Cloud创建云主机时支持指定云盘置备方式，SystemTags增加volumeProvisioningStrategy选项，使用 rootVolumeSystemTags参数来传递 SystemTag。
    • 选项格式为：volumeProvisioningStrategy::ThinProvisioning, volumeProvisioningStrategy::ThickProvisioning
    • 例如：volumeProvisioningStrategy::ThinProvisioning, volumeProvisioningStrategy::ThickProvisioning
  • ZStack Cloud创建云主机时支持指定根云盘所在的Ceph存储池，SystemTags增加rootPoolName选项，使用 rootPoolName参数来传递 SystemTag。
    • 选项格式为：ceph::rootPoolName::xxx, 其中xxx代表池名称
    • 例如：ceph::rootPoolName::pri-v-r-26e11ca6814d4e1ba504d845f7848db3
  • ZStack Cloud创建云主机时支持指定云主机的主板类型，SystemTags增加vmMachineType选项，使用 vmMachineType参数来传递 SystemTag。
    • 选项格式为：vmMachineType::xx, 其中xx代表pc或q35
    • 例如：vmMachineType::pc
  • ZStack Cloud创建云主机时支持指定cdrom列表，SystemTags增加cdroms选项，使用 cdroms参数来传递 SystemTag。
    • 选项格式为：cdroms::${cdrom-1 config}::${cdrom-2 config}::${cdrom-3 config}，cdrom config有三种可选择值: iso uuid(cdrom想要加载的iso uuid)，empty(不选择任何iso)，none(不配置光驱)。
    • 例如：
      • 创建一个空的cdrom: cdroms::empty::none::none
      • 创建三个空的cdrom: cdroms::empty::empty::empty
      • 创建3个挂载了iso的cdrom：cdroms::iso_1_uuid::iso_2_uuid::iso_3_uuid
  • ZStack Cloud创建云主机时支持不创建任何cdrom，SystemTags增加createWithoutCdRom选项，使用 createWithoutCdRom参数来传递 SystemTag。
    • 选项格式为：createWithoutCdRom::true
    • 例如：createWithoutCdRom::true
  • ZStack Cloud创建云主机时支持指定MDEV设备，SystemTags增加mdevDevice选项。
    • 选项格式为：mdevDevice::MDEV_DEV_UUID
    • 例如：mdevDevice::e2af8f869eff49d2a3d6f86cadc27090
  • ZStack Cloud创建云主机时支持配置是否关机自动卸载从设备规格分配的物理PCI设备，对已有云主机，也可以删除或更改其配置。SystemTags增加autoReleaseSpecReleatedPhysicalPciDevice选项。
    • 选项格式为：autoReleaseSpecReleatedPhysicalPciDevice
    • 例如：autoReleaseSpecReleatedPhysicalPciDevice
  • ZStack Cloud创建云主机时支持配置是否关机自动卸载从设备规格分配的虚拟PCI设备，对已有云主机，也可以删除或更改其配置。SystemTags增加autoReleaseSpecReleatedVirtualPciDevice选项。
    • 选项格式为：autoReleaseSpecReleatedVirtualPciDevice
    • 例如：autoReleaseSpecReleatedVirtualPciDevice
  • ZStack Cloud创建云主机时支持指定MDEV设备规格，同时指定从该规格中分配的设备数量。SystemTags增加mdevDeviceSpec选项。
    • 选项格式为：mdevDeviceSpec::MDEV_SPEC_UUID::MDEV_DEV_NUM
    • 例如：mdevDeviceSpec::e2af8f869eff49d2a3d6f86cadc27090::4
  • ZStack Cloud创建云主机时支持指定PCI设备规格，同时指定从该规格中分配的设备数量。SystemTags增加pciDeviceSpec选项。
    • 选项格式为：pciDeviceSpec::PCI_SPEC_UUID::PCI_DEV_NUM
    • 例如：pciDeviceSpec::e2af8f869eff49d2a3d6f86cadc27090::4
  • ZStack Cloud创建云主机时支持指定资源优先级，SystemTags增加vmPriority选项。
    • 选项格式为：vmPriority::PRIORITY_LEVEL，其中PRIORITY_LEVEL可以为Normal/High
    • 例如：vmPriority::Normal
  • ZStack Cloud创建云主机时支持记录云主机内安装的GuestTools版本，与物理机GuestTools ISO版本对比，决定是否需要升级，SystemTags增加GuestTools选项。
    • 选项格式为：GuestTools::TOOLS_VERSION，其中TOOLS_VERSION初值为1.0.0，未来随着工具版本的提升，这个值会随之变化。
    • 例如：GuestTools::1.0.0
    • 补充说明：使用镜像创建云主机时，如果该镜像带有GuestTools标签，则从镜像拷贝GuestTools标签值到新云主机。
  • ZStack Cloud创建云主机时支持设置跨集群高可用策略，SystemTags增加resourceBindings选项。
    • 选项格式为：resourceBindings::Cluster:clusterUuid，其中clusterUuid为对应的集群uuid
    • 例如：resourceBindings::Cluster:2sdasf231jvznsdak
  • ZStack Cloud创建云主机时支持设置主机名，SystemTags增加hostname选项。
    • 选项格式为：hostname::xxxxx，其中xxxxx就是用户设置的主机名
    • 例如：hostname::host.cloud.org
  • ZStack Cloud创建云主机时支持启用SR-IOV功能，SystemTags增加enableSRIOV选项。
    • 选项格式为：enableSRIOV::{L3_NETWORK_UUID}
    • 例如：enableSRIOV::9e19dafe81c64fed8e34f72e27582339
  • ZStack Cloud判断云主机是否使用virtio驱动，SystemTags增加driver选项。
    • 选项格式为：driver::virtio
    • 例如：driver::virtio
  • ZStack Cloud创建云主机时候可以配置vNUMA，SystemTags增加vmNumaEnable选项。
    • 选项格式为：vmNumaEnable::boolean
    • 例如：vmNumaEnable::true
  • ZStack Cloud创建云主机时候可以配置EmulatorPin，SystemTags增加vmEmulatorPinning选项。
    • 选项格式为：vmEmulatorPinning::CPU
    • 例如：vmEmulatorPinning::1,2,3,4,5,6,7
  • ZStack Cloud创建云主机时可以绑定XML Hook，SystemTags增加xmlHook选项。
    • 选项格式为：xmlhook::{xmlhookUuid}
    • 例如：xmlhook::35a678b482514da5aee22a6ab17d71e1
  • ZStack Cloud创建云主机时，支持指定云盘的分配路径，以此与第三方存储对接使用。SystemTags增加required::installUrl选项。
    • 选项格式为：required::installUrl::{%s}
    • 例如：required::installUrl::zbs://poolname
    • ZStack Cloud创建云主机时支持开启Hygon SE设备透传，SystemTags增加hygonSecurityElementEnable选项。
      • 选项格式为：hygonSecurityElementEnable::{%s}
      • 例如：hygonSecurityElementEnable::true
      • 注意事项：使用该选项，需确保云主机所在物理机支持Hygon CCP特性，并已虚拟化切割SE设备。
上一篇操作（Operations）下一篇从云盘创建云主机(CreateVmInstanceFromVolume)
CLI命令使用手册 | 5.5.30 | ZStack Cloud · ZCF | ZStack 资源中心