Document navigation

VmInstance(vm)

Name Description Default Value Valid Value
bootMenu Specifies whether to enable the boot menu during VM instance startup. Default: true. If the host does not support the boot menu feature, you can set this parameter to false. true
  • true
  • false
cleanTraffic Specifies whether to enable the feature of defending against IP spoofing or MAC spoofing attacks for a VM instance. Default: false. false
  • true
  • false
deletionPolicy The policy used to delete VM instances. Default: Delay. Valid values: Direct, Delay, and Never.
  • Direct: If you delete a VM instance, the VM instance is deleted at once.
  • Delay: If you delete a VM instance, the VM instance is listed on the Deleted tab of the VM instance management page and is in Deleted state. If you set the value to Delay, you can set the retention period of deleted VM instances. The default retention period is 86,400 seconds. When the retention period expires or if you expunge a deleted VM instance, the VM instance is expunged.
  • Never: If you delete a VM instance, the system does not automatically expunge the deleted VM instance.
Delay
  • Direct
  • Delay
  • Never
emulateHyperV Specifies whether to enable Hyper-V emulation for a VM instance. Default: false. false
  • true
  • false
expungeInterval The interval of expunging a deleted VM instance. Default: 3600. Unit: second. 3600 [1,+∞)
expungePeriod The delay of expunging a deleted VM instance. Default: 86400. Unit: second. 86400 [0,+∞)
instanceOffering.setNullWhenDeleting Specifies whether to update the Instance Offering parameter of a VM instance to NULL after the instance offering of the VM instance is deleted. Default: true. true
  • true
  • false
kvmHiddenState Specifies whether to hide the KVM virtualization flag. Default: false. If set to true, <hidden state='on'> is inserted in the <kvm> field of the XML file defined for a newly started VM instance. If you use NVIDA video cards for VM instances, you need to set this parameter to true. false
  • true
  • false
numa Default: false. If set to true, you can modify the number of vCPUs and memory size of a VM instance online. We recommend that you do not modify the number of vCPUs and memory size of a Windows-based VM instance in the production environment. Please excise with caution. false
  • true
  • false
spiceStreamingMode
  • all: All video frames are encoded, compressed, and then transferred. This lowers bandwidth requirements, promotes streaming fluency, while increases the CPU pressure of thin clients.
  • filter: Incremental video frames are encoded, compressed, and then transferred. Compared with the all mode, this mode further lowers bandwidth requirements and promotes streaming fluency. The CPU pressure of thin clients is relatively low. However, Chrome flash of thin clients will cause streaking issues.
  • off: Video frames are not encoded or compressed before transmission. This produces HD video streaming while have highest requirements for bandwidth. The CPU pressure of thin clients is the lowest among the three modes.
off
  • off
  • filter
  • all
videoType The type of video card that is used when a VM instance is started up. Default: virtio. Valid values: virtio, vga, qxl, and cirrus.
  • virtio: provides basic video features.
  • vga: provides high definition video features.
  • qxl: provides high performance video features when used with the SPICE protocol.
  • cirrus: Not recommended.
virtio
  • virtio
  • cirrus
  • vga
  • qxl
soundType The type of voice card that is used when a VM instance is started up. Default: HDA(ICH6). Valid values: AC97, HDA(ICH6), and HDA(ICH9).
Note: If the console mode of a VM instance is vnc, set the VM console mode to spice or vnc + spice and restart the VM instance. Then this global setting will take effect on this VM instance.
HDA(ICH6)
  • AC97
  • HDA(ICH6)
  • HDA(ICH9)
dataVolume.deleteOnVmDestroy Specifies whether to delete attached data volumes while deleting a VM instance. Default: false. false
  • true
  • false
Disable VMware io port emulation Specifies whether to enable VMware I/O port simulation. Default: false. false
  • true
  • false
vmDefaultCdRomNum The default number of virtual drives that the system creates for a VM instance (the cdrom parameter is not specified). Default: 1. Valid values: 1, 2, and 3. This setting does not take effect on the VM instances whose number of virtual drives has exceeded the threshold. 1
  • 1
  • 2
  • 3
maximumCdRomNum The maximum of virtual drives that can be created for a VM instance. Default: 3. Valid values: 1, 2, and 3. This setting does not take effect on the VM instances whose number of virtual drives has exceeded the threshold. 3
  • 1
  • 2
  • 3
pciePortNums The number of PCIe root ports that can be configured for a x86-64 VM instance with Q35 motherboard. Default: 28. Valid values: 0 to 28. This setting predefines the number of PCIe devices that can be hot plugged during VM startup. Modifications of the setting on a VM instance take effect after you restart the VM instance. 28 0-28
multivNic.support Specifies whether to enable multi-vNIC configuration in the same IP range. Default: false. This value indicates that you can configure only one vNIC for a VM instance in the same private IP range. If set to true, you can configure multiple vNICs for a VM instance in the same private IP range. false
  • true
  • false
resourceBinding.strategy Specifies the binding strength for instances bound with clusters. Default: Soft.
  • Hard: Instances must start in the current cluster.
  • Soft: Instances are prioritized to start in the current cluster. If the current cluster has no available hosts, instances can start in other clusters.
Soft
  • Hard
  • Soft
vm.ha.across.clusters Specifies whether to allow instances' cross-cluster migrations.
  • true: Allow cross-cluster migrations.
  • false: Deny cross-cluster migrations.
true
  • true
  • false
crash.strategy Specifies whether to enable error inspection for VM instances. Default: false. If you enable error inspection, you can set the error handling policy. Three error handling polices are available: Preserve, Reboot, and Shutdown. If your VM instance crashes, the VM instance is handled based on the configured policy. Note that before you can enable error inspection, you must install GuestTools of the latest version and make sure the agent is in Running state. false
  • true
  • false
crash.rebootThreshold.duration The restart policy of VM instances upon errors. Default: Restart VM instance up to five times within 30 minutes. If the VM instance is not restarted after five attempts within 30 minutes, the VM instance remains crashed. 1800 [0,+∞)
crash.rebootThreshold.times 5 [0,+∞)
vm.clock.track
  • Specifies whether to sync Windows VM time with the host BIOS time. If enabled, Windows VM time is the same as that of the host. By default, the sync is enabled.
  • The time synchronization setting does not take effect on Linux VM instances.
  • If you specifically set time sync for a VM instance, the global setting does not take effect on the VM instance.
host
  • guest
  • host
vm.clock.sync.after.vm.resume Specifies whether to enable time sync when a paused VM instance resumes running. Default: false. false
  • true
  • false
vm.clock.sync.interval.in.seconds The interval of VM time syncing with the host. Unit: second. Default : 0. This value indicates that time sync is disabled. 0
  • 0
  • 60
  • 600
  • 1800
  • 3600
  • 7200
  • 21600
  • 43200
  • 86400
enable.vm.address.recording Specifies whether to record the addresses of PCI devices attached to a VM instance. Default: true. true
  • true
  • false
enable.vm.internal.ip.overwrite Specifies whether to allow the NIC IP configured in the VM instance to overwrite the NIC IP record existing on the Cloud. Default: false.
Note:
  • To use this feature, install GuestTools for VM instances in advance.
  • The NIC IP configured in the VM instance overwrites the IP record on the Cloud after you set this setting to true and the system detects that the NIC IP changes.
  • If you want to make the NIC IP configured in the VM instance overwrite the IP record on the Cloud, we recommend that you set this setting to true before you enter the VM instance and configure the IP.
false
  • true
  • false
CLI Command Manual | 5.5.30 | ZStack Cloud · ZCF | ZStack Resource Center