DocsKnowledge BaseAPI Explorer
Documentation›ZCF›ZStack Cloud›Explore more›CLI Command ManualZCF
Document navigation

Advanced Settings

Overview

Advanced settings allow you to make fine-grained configurations for multiple resource attributes, and are updated without rebooting your management nodes. Once the configurations are made, corresponding resource attributes will take effect globally. If any advanced setting is not made, the default values of the global settings will be used.

Inventory

Resource Configuration Inventory

Name Description Optional Valid Value Starting Version
name The name. For more information, see Resource Property. 3.4.0
description The description. For more information, see Resource Property. Yes 3.4.0
category The category. 3.4.0
value The value. Yes 3.4.0
createDate The creation date. For more information, see Resource Property. 3.4.0
groupBy 3.4.0
lastOpDate The last operation date. For more information, see Resource Property. 3.4.0
resourceType The resource type. 3.4.0
resourceUuid 3.4.0
uuid The UUID. For more information, see Resource Property. 3.4.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 3.4.0
userTags The user tags. For more information, see CreateUserTag. Yes 3.4.0

Operations

GetResourceConfig

Obtains an advanced setting. For example,
GetResourceConfig category=host name=test resourceUuid=46597de31eac41539c4e6eda52885769

Parameters

Name Description Optional Valid Value Starting Version
category The setting category. 3.4.0
name The setting name. 3.4.0
resourceUuid The resource UUID. 3.4.0
userTags The user tags. For more information, see CreateUserTag. Yes 3.4.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 3.4.0
timeout Yes

GetResourceBindableConfig

Obtains a configurable advanced setting. For example,
GetResourceBindableConfig

Parameters

Name Description Optional Valid Value Starting Version
category The setting category. Yes 3.4.0
userTags The user tags. For more information, see CreateUserTag. Yes 3.4.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 3.4.0
timeout Yes

DeleteResourceConfig

Deletes an advanced setting. For example,
DeleteResourceConfig category=host name=test resourceUuid=46597de31eac41539c4e6eda52885769

Parameters

Name Description Optional Valid Value Starting Version
category The setting category. 3.4.0
name The setting name. 3.4.0
resourceUuid The resource UUID. 3.4.0
deleteMode Yes 3.4.0
userTags The user tags. For more information, see CreateUserTag. Yes 3.4.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 3.4.0
timeout Yes

QueryResourceConfig

Queries an advanced setting. For example,
QueryResourceConfig

Primitive Fields of Query

See Resource Configuration Inventory.

UpdateResourceConfig

Updates an advanced setting. For example,
UpdateResourceConfig category=host name=test resourceUuid=435a7c71c82b4b0b971f4674ab346822 value=10

Parameters

Name Description Optional Valid Value Starting Version
category The setting category. 3.4.0
name The setting name. 3.4.0
resourceUuid The resource UUID. 3.4.0
value The setting value. 3.4.0
userTags The user tags. For more information, see CreateUserTag. Yes 3.4.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 3.4.0
timeout Yes

Tags

You can create a user tag on an advanced setting by using CreateUserTag resourceType=ResourceConfigVO. For example,
CreateUserTag resourceType=ResourceConfigVO tag=Test1 \
resourceUuid=3fd25b9e5b87423bba5612a45c1f5ecc

Entries

Cluster

Name Description Default Value Valid Value
zstack.experimental.repo Configures whether to enable ZStack Cloud experimental repositories for the cluster. false
  • true
  • false

drs

Name Description Default Valid Value
drs.enable Specifies whether to enable dynamic resource scheduling. false
  • true
  • false

Host

Name Description Default Value Valid Value
cpu.overProvisioning.ratio Provisions the vCPU number for the VM instance. vCPU formula: PhysicalCPUTotalThreads X CPUOverprovisioningratio = DistributablevCPUNumber. 10 1-1000

KVM

Name Description Default Value Valid Value
reservedMemory The reserved memories on all KVM hosts. 1G >= 0
vm.cpuMode
For cluster with x86_64 CPU architecture:
  • Specifies whether to select the same CPU model as the host for VM instances in the cluster. Default: none. Valid values: none, host-model, host-passthrough, and a specified CPU model.
  • If you select none, the VM CPU model is consistent with that configured in the global setting.
  • If you specify a custom CPU model, the VM instances in the cluster share the specified CPU model.
  • If you select host-model, the CPU model of the VM instances is the same as that of the host.
  • If you select host-passthrough, the CPU model and features of the VM instance in the cluster are the same as the CPU model and features of the hosts in the cluster.
Note:
  • If you select host-model, the CPU of the VM instance may not support the extended page table extension, huge page, and virtualization features.
  • If you select host-passthrough, the VM instance allows for virtualization. However, if you migrate the VM instance to a host whose CPU model is different from the current host, the migration may fail. In addition, the CPU utilization of the VM instance measured within the instance may differ from the CPU utilization measured from the host.
  • If you specifically set the CPU model of an individual VM instance to host-model or host-passthrough, the VM CPU model configured for the cluster does not take effect on the VM instance.
  • If you modify the CPU model, you need to restart the VM instance to make the modification take effect.

For cluster with aarch64 CPU architecture: You can select only host-passthrough. The CPU model and features of the VM instance in the cluster are the same as the CPU model and features of the hosts in the cluster.

For cluster with mips64el CPU architecture: You can specify a custom CPU model. If you specify a custom CPU model, VM instances in the cluster share the specified CPU model.
  • For cluster with x86_64 CPU architecture: None
  • For cluster with aarch64 CPU architecture: host-passthrough
  • For cluster with mips64el CPU architecture: a custom CPU model.
  • None
  • a custom CPU model
  • host-model
  • host-passthrough

localstorage

Name Description Default Valid Value
qcow2.allocation The preallocation policy of LocalStorage storage space for volumes. none
  • none
  • metadata
  • falloc
  • full

nfsPrimaryStorage

Name Description Default Valid Value
qcow2.allocation The policy used to allocate NFS primary storage space for volumes. none
  • none
  • metadata
  • falloc
  • full

Premium Cluster

Name Description Default Value Valid Value
hugepage.enable Specifies whether to enable hugepages for a cluster. Default: false. If set to true, hugepages is enabled for all hosts in the cluster, with a size of 2 MB for each page. In addition, hugepage space is allocated to VM instances.
Note:
  • Before you enable hugepages for a cluster, make sure that all hosts in the cluster are in maintenance mode.
  • If you enable or disable hugepages for a cluster, you need to restart the hosts in the cluster for the change to take effect.
  • If hugepages is enabled for a cluster and you modify the memory of a host in the cluster, you need to re-enable hugepages and restart the host to make the hugepages feature take effect.
  • If you enable hugepages for a cluster and the reserved memory size of a host in the cluster is smaller than 4 GB, the reserved memory size of the host is automatically increased to 4 GB. In addition, the rest of the memory in the host is allocated to hugepage memory.
  • Hugepage memory can only be used by VM instances. You need to set a reasonable reserved memory size for hosts. A too-small reserved memory may cause system service exceptions of hosts. We recommend that you set the reserved memory size to over 16 GB.
 false
  • true
  • false
hugepage.size The size of each page for each host after hugepages is enabled for a cluster. Default: 2 MB. 2 (0, +∞)
network.ovsdpdk Specifies whether to enable network acceleration support for a cluster. Default: false. false
  • true
  • false

sharedblock

Name Description Default Valid Value
qcow2.allocation The policy used to allocate Shared Block primary storage space for volumes. none
  • none
  • metadata
device.allocate.strategy
  • If you select maxFreeSize, when you create a volume or snapshot, the SharedBlock LUN that has the the most available space is distributed to the volume or snapshot.
  • If you select minLvCounts, when you create a volume or snapshot, the SharedBlock LUN that has the smallest total number of volumes and snapshots and has sufficient available space is distributed to the volume or snapshot.
  • If you select none, when you create a volume or snapshot, a SharedBlock LUN is distributed to the volume or snapshot based on the drive letter of the LUNs. If the first LUN does not have sufficient space to store the volume or snapshot, the second LUN that has sufficient space is used to store the volume or snapshot.
  • The policy used to distribute a SharedBlock LUN to a volume and snapshot. Valid values: none (default), minLvCounts, and maxFreeSize.
  • If you have already set the LUN distribution policy specifically for a SharedBlock primary storage, this global setting does not take effect on the primary storage.
 none
  • none
  • minLvCounts
  • maxFreeSize

sharedMountPointPrimaryStorage

Name Description Default Valid Value
qcow2.allocation The policy used to allocate SMP primary storage space for volumes. none
  • none
  • metadata
  • falloc
  • full

System (Mevoco)

Name Description Default Value Valid Value
overProvisioning.primaryStorage Provisions the virtual memory capacity for the VM instance. The memory capacity formula: PhysicalMemoryCapacity X MemoryOverprovisioningratio = DistributableMemoryCapacity. 1.0 >0
overProvisioning.memory Provisions the available space of the virtual primary storage for the VM instance. The primary storage space formula: PhysicalAvailablePrimaryStorageSpace X PrimaryStorageSuperResolution = DistributableAvailablePrimaryStorageSpace. 1.0 >0

Instance (VM)

Name Description Default Value Valid Value
numa The Instance Offering Online Modification value, which allows you to modify the VM CPU and the memory. It's not recommended to modify he VM CPU and the memory for Windows VM instance online in a production environment. false
  • true
  • false
emulateHyperV Sets whether to emulate Hyper-V. false
  • true
  • false
kvmHiddenState Specifies whether to hide the KVM hypervisor signature for a VM instance. If this parameter is true, <hidden state='on'> is added under <kvm> in the VM instance XML definition when the VM instance starts. If this parameter is false, it is not added. If this parameter is configured for a VM instance, the global setting and cluster advanced setting do not take effect on the VM instance. Enable this parameter for NVIDIA GPU clusters. false
  • true
  • false
vm.hyperv.clock.feature Specifies whether to enable hypervclock for VM instances. Default: true. If set to false, the VM instances are disabled with hyperclock. If you enable kvm hidden for a VM instance, disable VM hypervclock to avoid hanging the guest after hot migrations. Restart the VM instance to make the modification take effect after you turn off the button. true
  • true
  • false
PreviousZWatchNextTemplate
CLI Command Manual | 4.8.38 | ZStack Cloud · ZCF | ZStack Resource Center