System Parameters
ZSphere provides system parameters for controlling default platform behavior globally.
System parameters are organized into the following categories:
- Platform Policy: Provides platform-level parameters for timeout, management node, deletion, cleanup, concurrency, reconnection, and progress bar policies.
- Operations Management: Provides parameters for monitoring, alerts, tasks, and events.
- Host and VM: Provides parameters for hosts and VMs.
- Image Storage: Provides parameters for images and image storage.
- Data Storage: Provides parameters for disks and data storage.
- Network Resources: Provides parameters for distributed switches and security groups.
Modify System Parameters
Procedure
- Navigate to .
- Modify the system parameters.
Restore Default System Parameters
Procedure
- Navigate to .
-
Click Reset to Default Settings.
Note: Restoring default settings resets all system parameters, security settings, and advanced HA policy settings to their initial default values. Proceed with caution.
Platform Policy
| Category | Item Name | Item Description |
|---|---|---|
| Timeout Policy | Image Addition Timeout | Specify the maximum timeout limit for adding an image. If the image addition process exceeds this time limit, the operation will fail. Default: 3 days. Unit: second, minute, hour, and day. |
| Timeout for Creating Disk Image from Disk 1 | Specify the maximum timeout limit for creating a disk image from disk 1. If the creation exceeds this time limit, the operation will fail. Default: 3 days. Unit: second, minute, hour, and day. | |
| VM Creation Timeout | Specify the maximum timeout limit for creating a virtual machine. If the creation exceeds this time limit, the operation will fail. Default: 12 hours. Unit: second, minute, hour, and day. | |
| VNC Token Timeout | Specify the duration for which a VNC token remains valid. When you launch a VM console, the system generates a token required for the console connection. If you do not reconnect to the VM within the specified timeout period, the token becomes invalid and cannot be used for further console connections. To regain access, simply re-launch the VM console, which will generate a new token. Default: 1,800. Unit: second. | |
| Platform Service SSH Connection Timeout | Default: 30. Unit: seconds. Specifies the connection timeout for executing SSH commands on platform service VMs. | |
| WebShell Session Timeout | Specify the duration for which a WebShell session remains valid. Default: 1,800. Unit: second. | |
| Timeout for Creating Disk Image from Data Disk | Specify the maximum timeout limit for creating a disk image from a data disk. If the creation exceeds the time limit, the operation will fail. Default: 3 days. Unit: second, minute, hour, and day. | |
| Timeout for Creating Disk from Disk Image | Specify the maximum timeout limit for creating a disk from a disk image. If the creation exceeds this time limit, the operation will fail. Default: 3 days. Unit: second, minute, hour, and day. | |
| Max Failed Attempts for Compute Node Inspection | Specify the maximum number of failed attempts allowed when the management node inspects compute nodes. Default: 3. | |
| Management Node Policy | Max User Session Connections | Specify the maximum number of sessions that a single user can start with the management node. If the number of sessions for a user exceeds this limit, new sessions will be denied. Default: 500. |
| Image Storage Ping Interval | Specify the time interval at which the management node checks the connectivity of the image storage. If the check (ping) is successful, it indicates that the image storage is in a connected state. Default: 60. Unit: second. | |
| Orphan GC Scan Interval | Specify the time interval at which the management node scans for orphaned GC (Garbage Collection) jobs. If orphaned GC jobs are detected, the management node takes over the jobs. Default: 60. Unit: second. | |
| Auto Reconnect Host on Ping Failure | Specify whether to automatically reconnect hosts to the management node, if the management node fails to ping hosts. Default: enabled. | |
| Host Ping Interval | Specify the time interval at which the management node checks the connectivity of the host. If the check (ping) is successful, it indicates that the host is in a connected state. Default: 60. Unit: second. | |
| Heartbeat Inspection Interval | Specify the time interval at which the management node writes its heartbeat pulses to the database. Default: 5. Unit: second. | |
| Data Storage Ping Interval | Specify the time interval at which the management node checks the connectivity of the data storage. Default: 60. Unit: second. | |
| Check Time Zone in REST API Calls | Specify whether to enable the time zone check when making REST API calls. Deafult: disabled. If enabled, the system will recognize and validate the time zone during API requests. If disabled, the system will only compare local times without considering time zones. | |
| Deletion Policy | Image Deletion Policy | Specify the deletion policy for images. Default: Delayed Deletion. Options include Delayed Deletion, Immediate Deletion, and Never Delete.
|
| VM Deletion Policy | Specify whether to completely delete the virtual machine or retain it in the recycle bin when you delete a virtual machine. Default: Delayed Deletion. Options include Immediate Deletion, Delayed Deletion, and Never Delete.
|
|
| Disk Deletion Policy | Specify the deletion policy for disks. Default: Delayed Deletion. Options include Immediate Deletion, Delayed Deletion, and Never Delete. When selecting Delayed Deletion, the default retention period is 86,400 seconds. Unit: second, minute, hour, and day. | |
| Bare Metal Instance Deletion Policy | Specify the deletion policy for bare metal instances. Default: Never Delete. Options include Immediate Deletion and Never Delete.
|
|
| Sensitive Operation Confirmation Validation | Specify whether to require a secondary confirmation for sensitive operations on critical resources. For example, If you delete a virtual machine, the operation requires an input of specific characters to continue. Default: enabled. If disabled, no additional confirmation is required. | |
| Cleanup Policy | Recycle Bin Expired Resources Cleanup Interval | Specify the time interval for automatic cleanup of expired resources in the recycle bin. Default: 1 hour. Unit: hour. The interval can be set as an integer between 1 and 24. When resources under the delayed deletion policy reach their preset retention time in the recycle bin, the system will check for expired resources at the specified interval and automatically clean them up. |
| Standalone Image Storage Data Cleanup Interval | Specify the time interval for automatically cleaning up data in the standalone image storage. Default: 7 days. Unit: second, minute, hour, and day. If disabled, the automatic data cleanup is disabled. | |
| Session Cleanup Interval | Specify the time interval for cleanning up sessions that have timed out. Default: 1 hour. Unit: second, minute, hour, and day. | |
| Data Storage Garbage Collection | Specify whether to enable automatic garbage collection on the data storage after failed attempts to create virtual machines or disks. Default: enabled. | |
| Data Storage Garbage Collection Interval | Specify the time interval for garbage collection on the data storage. Default: 600. Unit: second. | |
| Data Storage Garbage Collection Frequency | Specify the number of times the garbage collection will be repeated on the data storage. Default: 50. | |
| Progress Bar Record Cleanup Interval | Specify the time interval for automatically cleaning up expired progress bar records. Default: 300. Unit: second. | |
| Failed Disk/Snapshot Cleanup Interval | Specify the time interval for automatically cleaning up failed or invalid disks or snapshots that remain in the SAN storage after deletion attempts. Default: 3,600. Unit: second. | |
| Concurrency Policy | Max Concurrent VM Creations | Specify the maximum number of virtual machines that can be created concurrently on a single host. Default: 1. |
| Max Concurrent VM Migrations | Specify the maximum number of virtual machines that can be migrated concurrently when a host is in maintenance mode. Default: 2. | |
| Image Storage Ping Max Concurrency | Specify the maximum number of image storage checks that can be performed concurrently by the management node. Default: 50. | |
| Host Allocation Concurrency | Specify whether the host allocation process supports concurrent operations. Default: disabled. If enabled, you can specify the maximum number of host allocators that can be concurrently running. Default: 10. Valid values: 1 to 255. Setting a high concurrent allocation may lead to increased host load. | |
| Host Concurrency Level | Specify the the maximum number of concurrent commands that can be executed on the host. Default: 10. Setting a high concurrency level may lead to increased host load. | |
| Host Reconnection Concurrency | Specify the maximum number of concurrent host reconnection processes that can be initiated by the management node. Default: 100. | |
| Host Ping Max Concurrency | Specify the maximum number of host connnectivity checks that can be performed concurrently by the management node. Default: 100. | |
| Concurrent Snapshot Creations on a Single Host | Specify the maximum number of concurrent snapshot creation processes that can be executed on a single host. Default: 10. Setting a high concurrency may lead to increased host load. | |
| Concurrent Image Distribution to Local Storage | Specify the maximum number of images that can be concurrently distributed to local storage after adding an image. Default: 2. | |
| Data Storage Ping Max Concurrency | Specify the maximum number of data storage checks that can be performed concurrently by the management node. Default: 50. | |
| Reconnection Policy | Auto Reconnect Distributed Storage Mon Node | Specify whether to automatically reconnect the monitoring nodes of a distributed storage to the management node upon check failures. Default: enabled. |
| Distributed Storage Mon Node Reconnection Interval | Specify the time interval before the management node of a distributed storage system attempts to reconnect after a failed check. Default: 30. Unit: second. | |
| Host Max Reconnection Failures | Specify the maximum number of consecutive failed reconnection attempts allowed by the management node before it stops trying to reconnect to a host. Default: 0. | |
| Auto Reconnect Host | Specify whether to automatically reconnect all hosts while the management node starts its services. Default: enabled. | |
| Progress Bar | Enable LongJob Task Progress Tracking | Enabled by default. When enabled, the platform records the progress of LongJob tasks for display in the task list and operation history. When disabled, the platform no longer records progress data for new LongJob tasks. This setting does not affect LongJob task execution or control the display of other progress bars. |
| Progress Bar Data Retention Period | Specify the maximum duration for which progress bar data is retained in the database. Default: 86,400 seconds. Unit: second, minute, hour, and day. |
Operations Management
| Category | Item Name | Item Description |
|---|---|---|
| Monitoring and Alarm | Management Node Log Retention Size | Specify whether to set the maximum size of locally retained management node logs. Logs exceeding this size will be permanently deleted. Default: disabled. Unit: GB. If disabled, there will be no limit on the log retention size. |
| Management Node Log Retention Period | Specify whether to set the maximum duration for which management node logs are retained locally. Logs older than this duration will be permanently deleted. Default: disabled. Unit: day. If disabled, there will be no limit on the log retention period. | |
| Monitoring Data Retention Period | Specify the maximum duration for locally retained monitoring data. Default: 6. Unit: month. Valid values: 1 to 12. | |
| Monitoring Data Retention Size | Specify the maximum size of locally retained monitoring data. Default: 64GB. Unit: MB, GB, and TB. You can enter an integer that is greater than 1 and is the power of 2. | |
| Operation Task Retention Period | Specify the maximum duration for retained operation tasks. Operation tasks older than this duration will be permanently deleted. Default: 90. Unit: day. | |
| Management Node Directory Monitored by System Alarm | Specify the management node directory monitored by the system alarm. | |
| Auto-Scheduling Task Retention Period | Specify the maximum duration for retained scheduling tasks. Scheduling tasks older than this duration will be permanently deleted. default: 90. Unit: day. | |
| Event Retention Period | Specify whether to set the maximum duration for retained events. Default: unlimited. If enabled, you can set a retention period. The default retention period is 180 days. Events older than this duration will be permanently deleted. | |
| Trigger Recovery Check Interval | Specify the time interval at which the system periodically checks whether a trigger has recovered. Default: 10. Unit: second. | |
| WAL Refresh Interval | Specify the time interval of refreshing Write Ahead Logs (WAL). Default: 2 hours. Unit: minute, hour, and day. If the monitoring data size is too large, it is recommended to set this interval to 30 minutes. | |
| Alarm Suppression Interval | Specify the time interval during which the alarm will not be triggered again after the initial alert. Default: 1,800. Unit: second. | |
| Alarm Message Retention Period in Cache | Specify the maximum duration for which the total count of alarm messages triggered by resource and event alarms is retained in the cache. Default: 10. Unit: second. Within the duration, user queries for the total count of alarm messages will retrieve the cached value directly. If caching is not required, you can set the value to 0. | |
| Alarm Inspection Interval | Specify the time interval at which an alarm inspects metric items. Default: 10. Unit: second. | |
| Alarm Inspection Concurrency | Specify the concurrency that an alarm inspects metric items. Default: 5. | |
| Alarm Message Threshold for Caching | Specify the threshold for the total count of alarm messages triggered by resource and event alarms that can be written to the cache. Default: 150. If the total count of alarm messages equals or exceeds this threshold, the alarm messages are allowed to be cached. If the count is below the threshold, user queries for the total count of alarm messages will retrieve the real-time value directly. |
Host and VM
| Category | Item Name | Item Description |
|---|---|---|
| VM | Overcommit VM Memory | Specify whether to enable memory overcommitment for virtual machines. Default: enabled. If enabled, when assigning a virtual machine to a host, any host where the requested memory quota exceeds the available memory will be filtered out. |
| Max Disks per VM | Specify the maximum number of data disks that can be attached to a virtual machine. Default: 24. | |
| Max CD/DVD Drives per VM | Specify the maximum number of CD/DVD drives that a virtual machine can create. Default: 3. Valid values: 1, 2, and 3. Note that this setting does not take effect on virtual machines that already have more virtual CD/DVD drives than the specified limit. | |
| AgentPing Interval | Specify the time interval for checking the status of the agent program on the console. Default: 60. Unit: second. | |
| Agent Idle Timeout | Specify the maximum idle time for the console agent before it times out. Default: 60. Unit: second. | |
| Inject DNS into VM | Specify whether to inject DNS server addresses into virtual machines. Default: disabled. If enabled, virtual machines will be able to resolve each other's hostnames. | |
| Max VMs in UI Batch Creation | Specify the maximum number of virtual machines that can be created in a single batch operation via the UI. Default: 100. Valid values: 1 to 10,000. | |
| User Data Service | Specify whether to enable the User Data service. Default: enabled. If disabled, virtual machines without Userdata settings will not be able to upload internal monitoring data through their agents. | |
| Display VNC Banner | Specify whether to display a banner notification for VMTools installation at the top of the VNC window. Default: enabled. If disabled, the banner notification will not be shown. | |
| VM Metadata | Default: Disabled. When enabled, the system creates an independent metadata file for each virtual machine. This feature is currently used only for VM registration. If VM registration is not required, it is recommended to keep this feature disabled. | |
| Host | Host Allocation Strategy |
|
| VM Migration Failure Policy in Maintenance Mode | Specify the policy for handling virtual machine migration failures when host enters maintenance mode. Default: Force Stop VM.
|
|
| Ignore Errors in Maintenance Mode | Specify whether to allow hosts to ignore errors and report requests as successful while the host is in maintenance mode. Default: disabled. | |
| Host Upgrade Parallelism | Specify the maximum number of hosts within a cluster that can undergo system upgrades simultaneously. Default: 2. | |
| Restart Hung KVM Agent | Specify whether to restart the KVM agent when it is detected hung. Default: enabled. | |
| Sync VM Status on Pinging Host | Specify whether to synchronize the virtual machine status while pinging the host. Default: enabled. | |
| Host CPU Utilization Collection Interval | Specify the time interval at which the CPU utilization of hosts is collected. The system uses this data to select the host with the lowest CPU utilization for creating new virtual machines. Default: 600. Unit: second. | |
| Host Memory Utilization Collection Interval | Specify the time interval at which the memory utilization of hosts is collected. The system uses this data to select the host with the lowest memory utilization for creating new virtual machines. Default: 600. Unit: second. | |
| Host SSH Reconnection Timeout | Specify the timeout period for SSH reconnection attempts to a host. If the SSH connection is not established within this period, the reconnection attempt is considered failed. Default: 300. Unit: second. | |
| Quick Host Connection Status Detection | Specify whether to enable or disable the quick detection of host connection status. Default: disabled. If enabled, the system will reduce the time interval between connection status checks. |
Image Storage
| Category | Item Name | Item Description |
|---|---|---|
| Image | Distribute Image | Specify whether to distribute newly added images to all hosts within the cluster to which the local storage is attached. Default: enabled. |
| Auto Delete Temporary Image | Specify whether to automatically delete temporary images generated while cloning virtual machines. Default: enabled. | |
| Image Storage | Auto Reconnect Image Storage Mon Node | Specify whether to automatically reconnect the monitoring nodes of a distributed image storage to the management node upon check failures. Default: enabled. |
| Image Storage Mon Node Reconnection Interval | Default: 30. Unit: Second. The interval that the management node reconnects the monitoring node of the distributed image storage if the monitoring node fails to be detected. |
Data Storage
| Category | Item Name | Item Description |
|---|---|---|
| Disk | Local Storage Disk Migration Timeout | Specify the maximum timeout limit for migrating disks from local storage. If the migration process exceeds this time limit, the operation will be considered failed. Default: 1 day. Unit: second, minute, hour, and day. |
| Physical I/O Block Size | Specify the size of the physical I/O block that a disk reports to the Hypervisor. Default: 0. Unit: byte. Valid values: 0, 512, and 4096. Note:
|
|
| Disk Capacity Refresh Interval | Specify the time interval at which the available space on disks is updated. Default: 3,600. Unit: second. The minimum interval cannot be set lower than 600 seconds. | |
| Disk Capacity Refresh Scope | Specify the scope of disks that will automatically refresh their capacity information. After setting, the corresponding disks will automatically refresh their capacity based on the configured refresh interval. Default: All Disks.
|
|
| Data Storage | Data Storage Utilization Threshold | Specify a threshold for data storage utilization to prevent overuse of storage space. This is particularly important when storage overcommitment is enabled, as excessive allocation can lead to storage overflow and cause virtual machine storage failures. Default: 0.9. Note: When the data storage usage reaches the set threshold, the system will prohibit adding new disks. Existing disks are not affected and work as expected. |
| NFS Data Storage GC Cleanup Time Interval | Defaulting to 3600 seconds, used for setting the time interval of NFS data storage GC cleanup and disk snapshot. | |
| Data Storage Reserved Capacity | Specify a reserved space for data storage. Default: 1GB. Unit: KB, MB, GB, and TB.
Note: The reserved capacity of data storage does not affect the normal read/write operations of existing disks. |
|
| Distributed Storage GC Interval | Specify the time interval at which the distributed storage system performs garbage collection to clean up unused or orphaned data on disks. Default: 3,600. Unit: second. | |
| ZCE Distributed Storage Image Cache Cleanup Interval | The interval of cleaning image caches from ZCE distributed storage. This setting is applied after images in distributed storage are deleted and image caches are no longer used by virtual machines. Default: 43,200. Unit: second. | |
| Distributed Storage Pool Deletion Policy | Specify whether to delete all storage pools when deleting distributed storage. Default: disabled. If enabled, this may result in data loss. Proceed with caution. | |
| Non-Distributed Storage Image Cache Cleanup Interval | The interval of cleaning image cache from non-distributed storage. This setting is applied after images in data storage (non-distributed storage) are deleted and image caches are no longer used by any virtual machines. Default: 86,400. Unit: second. | |
| Disable queue_if_no_path for Multipath Device | Specify whether to disable the queue_if_no_path feature for multipath devices. Default: enabled. The system will return I/O failures if all paths to the multipath device used by SAN storage are lost. If disabled, it may impact the reliability of heartbeat detection and failover mechanisms in the platform. Proceed with caution. | |
| Initial Size for Thin-Provisioned Disk | Specify the initial size of a thin-provisioned disk. Default: 5GB. Unit: MB, GB, and TB. The initial size cannot be lower than 1 GB. | |
| Min Available Space for Thin-Provisioned Disk | Specify the minimum available space threshold for a thin-provisioned disk. When the difference between the actual size of a thin-provisioned disk and the used storage space falls below this threshold, the disk will automatically expand based on a predefined size. Default: 5GB. Unit: MB, GB, and TB. | |
| Auto Expansion Size for Thin-Provisioned Disk | Specify the size by which a thin-provisioned disk will automatically expand. Default: 5GB. Default: MB, GB, and TB. | |
| Max Usage Ratio for Thin-Provisioned Disk | Specify the maximum usage ratio for a thin-provisioned disk. When the actual usage ratio of a thin-provisioned disk exceeds the maximum usage ratio, the disk will automatically expand based on a predefined size. Default: 85. Unit: %. | |
| Multipath Access to Data Storage | Specify the control policy of multipath access to data storage.
Note: If you modify this setting, you need to reconnect a host to make the modification take effect on the host. |
Network Resources
| Category | Item Name | Item Description |
|---|---|---|
| Distributed Switch | Distributed Switch NoVLAN Network MTU | Specify the maximum packet size that can be transmitted over a NoVLAN network. Default: 1,500. Unit: byte. |
| Distributed Switch VLAN Network MTU | Specify the maximum packet size that can be transmitted over a VLAN network. Default: 1,500. Unit: byte. | |
| Security Group | Default Egress Policy of Security Group | Specify the default egress policy of security groups. Default: accept. Valid values: accept and deny. |
| Default Ingress Policy of Security Group | Specify the default ingress policy of security groups. Default: drop. Valid values: accept, drop, and deny. |
