Document navigation

Basic ctl Commands

status

Description

Displays the status and other information of ZStack Cloud on a specified node.

Usage

Parameter Description Example
none Displays the status and other information on the current node. zstack-ctl status
--host HOST Displays the status and other information on the specified node. zstack-ctl status --host 192.168.0.10

start

Description

Starts services related to ZStack Cloud, including the management node and the UI service.

Usage

Parameter Description Example
none Starts the related services, including the management node and UI service. zstack-ctl start
--daemon Displays the daemon mode. zstack-ctl start --daemon

stop

Description

Stops services related to ZStack Cloud, including the management node and the UI service.

Usage

Parameter Description Example
none Stops the related services, including the management node and UI service. zstack-ctl stop

start_ui

Description

Starts the UI service of ZStack Cloud.

Usage

Parameter Description Example
--host HOST The IP address of the UI server. Default: localhost. zstack-ctl start_ui --host 172.20.11.122
--mn-host MN_HOST The IP address of the management node. Default: 127.0.0.1. zstack-ctl start_ui --mn-host 127.0.0.1
--mn-port MN_PORT The port of the management node. Default: 8080. zstack-ctl start_ui --mn-port 8080
--webhook-host WEBHOOK_HOST The IP address of the webhook host. Default: 127.0.0.1. zstack-ctl start_ui --webhook-host 127.0.0.1
--webhook-port WEBHOOK_PORT The port of the webhook host. Default: 5000. zstack-ctl start_ui --webhook-port 5000
--server-port SERVER_PORT The port of the UI server. Default: 5000. zstack-ctl start_ui --server-port 5000
--log LOG The directory to store UI logs. Default: /usr/local/zstack/apache-tomcat/logs. zstack-ctl start_ui --log /usr/local/zstack/apache-tomcat/logs
--enable-ssl Enables UI login through HTTPS. zstack-ctl start_ui --enable-ssl
--ssl-keyalias SSL_KEYALIAS The alias of the UI certificate. zstack-ctl start_ui --ssl-keyalias zstackui
--ssl-keystore SSL_KEYSTORE The path of the UI certificate. Default: /usr/local/zstack/zstack-ui/ui.keystore.p12. zstack-ctl start_ui --ssl-keystore /usr/local/zstack/zstack-ui/ui.keystore.p12
--ssl-keystore-type SSL_KEYSTORE_TYPE The type of the UI certificate. Default: PKCS12. zstack-ctl start_ui --ssl-keystore-type PKCS12
--ssl-keystore-password SSL_KEYSTORE_PASSWORD The private key password of the UI certificate. Default: password. zstack-ctl start_ui --ssl-keystore-password password
--db-url DB_URL The URL of the UI database. Default: jdbc:mysql://10.0.46.243:3306. zstack-ctl start_ui --db-url jdbc:mysql://10.0.46.243:3306
--db-username DB_USERNAME The username of the UI database. Default: zstack_ui. zstack-ctl start_ui --db-username zstack_ui
--db-password DB_PASSWORD The password of the UI database. Default: zstack.ui.password. zstack-ctl start_ui --db-password zstack.ui.password
--timeout TIMEOUT The time used for the UI to start up. Default: 120s. zstack-ctl start_ui --timeout 120
Note: If you want to change the username or password of the UI database, make sure that the zstack_ui database can be accessed by using the new username and password.

stop_ui

Description

Stops the UI service on the specified node.

Usage

Parameter Description Example
--host HOST The IP address of the UI server. Default: localhost. zstack-ctl stop_ui --host 172.20.12.111

start_node

Description

Starts the management node service of ZStack Cloud on a specified node.

Usage

Parameter Description Example
--host HOST Specifies the SSH URL of the management node to be started. zstack-ctl start_node --host 172.20.11.122
--timeout TIMEOUT Sets the time used for ZStack Cloud to start up. Default: 300s. zstack-ctl start_node --timeout 600
--daemon Displays the daemon mode. zstack-ctl start_node --daemon
--simulator Enable the display of the simulator mode. zstack-ctl start_node --simulator

stop_node

Description

Starts the management node service of ZStack Cloud on a specified node.

Usage

Parameter Description Example
--host HOST Specifies the SSH URL of the management node to be stopped. zstack-ctl stop_node --host 172.20.12.111
--force, -f Forcibly stops the java process. zstack-ctl stop_node --force

restart_node

Description

Restarts a management node.

Usage

Parameter Description Example
none Restarts a management node. zstack-ctl restart_node

configured_collect_log

Description

Collects diagnostic logs. The configured_collect_log command can be used to collect new logs and view the log size. You can also specify the log collection time, whether to collect logs of a single management node, database, or compute node, and whether to collect logs of all nodes.

Usage

Parameter Description Example
-p Customizes the YAML configuration file path for log collection. zstack-ctl configured_collect_log -p /var/lib/zstack/
--check Only checks and displays the log size without collecting logs. zstack-ctl configured_collect_log --check
--full (Default) Collects all logs other than database logs, including management node logs, compute node logs, backup storage logs, primary storage logs, and vRouter logs. zstack-ctl configured_collect_log --full
--full-db Collects all logs, including the database logs. zstack-ctl configured_collect_log --full-db
--mn-db Collects management node logs, including the database logs. zstack-ctl configured_collect_log --mn-db
--mn-only Collects only management node logs, excluding database logs. zstack-ctl configured_collect_log --mn-only
--mn-host Collects management node and compute node logs, excluding database logs. zstack-ctl configured_collect_log --mn-host
--since SINCE Collects logs within N days (Nd) or N hours (Nh). zstack-ctl configured_collect_log --since 2d
--from-date FROM_DATE
  • The date and time when logs are collected. Supported formats:
    • yyyy-MM-dd: Sets only the year, month, and day. The hour, minute, and second are 0 by default. For example, 2018-11-22 (equals to 2018-11-22 00:00:00).
    • Sets the specific time, accurate to minutes. For example, 2018-11-22_09:30:00.
  • If you set only FROM_DATE, you can collect logs generated from the value of FROM_DATE to the current time.
  • If you set FROM_DATE to -1, you can collect all logs generated before the deadline.
zstack-ctl configured_collect_log --from-date 2018-11-22
--to-date TO_DATE
  • The date and time when logs stop to collect. The format of this parameter is the same as the FROM_DATE parameter.
  • If you set only the TO_DATE parameter, the value of FROM_DATE is 24 hours earlier than the current time.
zstack-ctl configured_collect_log --to-date 2018-11-23

dump_mysql

Description

Saves the database to a backup file.

Usage

Parameter Description Example
--file-name FILE_NAME Specify a name for the backup database. Default: zstack-backup-db.
Note: The system auto-generates the IP address of the management node as the prefix of the backup file name and the file generation date and time as the suffix of the backup file name. In case of a double management node environment, the auto-generated IP address is the IP address of the management node where the VIP resides. For example, 172.20.1.123-zstack-backup-db-2016-12-07_14-43-43.gz indicates the database backup file of the management node 172.20.1.123 generated at 14:43:42 of 7 Dec, 2016.
zstack-ctl dump_mysql --file-name 'zstack-backup-db'
--file-path FILE_PATH Specify an absolute path for the database backup file. Default: /var/lib/zstack/mysql-backup. zstack-ctl dump_mysql --file-path '/var/lib/zstack/mysql-backup'
--keep-amount KEEP_AMOUNT Specify the number of database backup files. Default: 60. If the number of database backups exceeds the threshold, excessive database backups will be deleted. zstack-ctl dump_mysql --keep-amount 50
--host-info HOST_INFO Specify the remote host to which the database and UI data is synchronized. The format of the value is root@ip_address:port.
  • The destination directory of the remote host is /var/lib/zstack/from-zstack-remote-backup/.
  • The default port is 22.
zstack-ctl dump_mysql --host-info root@172.20.0.30:22
--host HOST_INFO zstack-ctl dump_mysql --host root@172.20.0.30:22
--h HOST_INFO zstack-ctl dump_mysql --h root@172.20.0.30:22
--delete-expired-file Delete the expired files on the /var/lib/zstack/from-zstack-remote-backup/ directory of the remote host. zstack-ctl dump_mysql --delete-expired-file
--delete zstack-ctl dump_mysql --delete
--d zstack-ctl dump_mysql --d
--append-sql-file APPEND_SQL_FILE Append a SQL file to operate on the database. zstack-ctl dump_mysql --append-sql-file SQL_File

change_ip

Description

Updates the management IP address from the configuration file of ZStack Cloud.

Usage

Parameter Description Example
--ip IP Sets a new IP address for a management node. The new IP address is automatically synchronized to the configuration file of ZStack Cloud.
Note: If you changed the OS IP address of the current management node, you can use this command to change the IP addresses of all configuration file related to ZStack Cloud to the new IP address.
zstack-ctl change_ip --ip 172.20.12.47
--mysql_ip MYSQL_IP Sets a new IP address for a database. By default, the IP address is the same as that of the corresponding management node. zstack-ctl change_ip --mysql_ip 172.20.12.47
--cloudbus_server_ip CLOUDBUS_SERVER_IP Sets a new IP for CloudBus. By default, the IP address is the same as that of the corresponding management node. zstack-ctl change_ip --cloudbus_server_ip 172.20.12.47

show_configuration

Description

Displays information about the zstack.properties configuration file of ZStack Cloud.

Parameter Description Example
none Displays the information about the zstack.properties configuration file of ZStack Cloud. zstack-ctl show_configuration

configure

Description

Modifies the configuration file of ZStack Cloud.

Usage

Parameter Description Example
--host HOST Sets the IP address or domain name for a management node. Default: localhost. zstack-ctl configure --host root@192.168.0.10
--duplicate-to-remote DUPLICATE_TO_REMOTE Synchronizes the configuration file of the current management node to a remote node. zstack-ctl configure --duplicate-to-remote root@192.168.0.10
--use-file USE_FILE Sets the location of the configuration file. zstack-ctl configure --use-file /usr/local/zstack/apache-tomcat/webapps/zstack/WEB-INF/classes/zstack.properties

show_ui_config

Description

Displays UI configurations, such as the service port.

Usage

Parameter Description Example
none Displays UI configurations, such as the service port. zstack-ctl show_ui_config

config_ui

Description

Configure the UI address, port, and other information.

Usage

Parameter Description Example
--host HOST The IP address of the UI server. Default: localhost. zstack-ctl config_ui --host 172.20.11.122
--init Initializes zstack.ui.properties. zstack-ctl config_ui --init
--restore Resets zstack.ui.properties to the default value. zstack-ctl config_ui --restore
--mn-host MN_HOST The IP address of the management node. Default: 127.0.0.1. zstack-ctl config_ui --mn-host 127.0.0.1
--mn-port MN_PORT The port of the management node. Default: 8080. zstack-ctl config_ui --mn-port 8080
--webhook-host WEBHOOK_HOST The IP address of the webhook host. Default: 127.0.0.1. zstack-ctl config_ui --webhook-host 127.0.0.1
--webhook-port WEBHOOK_PORT The port of the webhook host. Default: 5000. zstack-ctl config_ui --webhook-port 5000
--server-port SERVER_PORT The port of the UI server. Default: 5000. zstack-ctl config_ui --server-port 5000
--ui-address UI_ADDRESS Changes the IP address of the UI server. zstack-ctl config_ui --ui-address 172.20.0.10
--log LOG The UI log directory. Default: /usr/local/zstack/apache-tomcat/logs. zstack-ctl config_ui --log /usr/local/zstack/apache-tomcat/logs
--enable-ssl {True,False} Enables or Disables UI login through HTTPS. Default: False. zstack-ctl config_ui --enable-ssl True
--ssl-keyalias SSL_KEYALIAS The alias of the UI certificate. Default: zstackui. zstack-ctl config_ui --ssl-keyalias zstackui
--ssl-keystore SSL_KEYSTORE The path of the UI certificate. Default: /usr/local/zstack/zstack-ui/ui.keystore.p12. zstack-ctl config_ui --ssl-keystore /usr/local/zstack/zstack-ui/ui.keystore.p12
--ssl-keystore-type {PKCS12,JKS} The type of the UI certificate. Default: PKCS12. zstack-ctl config_ui --ssl-keystore-type PKCS12
--ssl-keystore-password SSL_KEYSTORE_PASSWORD The private key password of the UI certificate. Default: password. zstack-ctl config_ui --ssl-keystore-password password
--db-url DB_URL The URL of the UI database. Default: jdbc:mysql://10.0.46.243:3306. zstack-ctl config_ui --db-url jdbc:mysql://10.0.46.243:3306
--db-username DB_USERNAME The username of the UI database. Default: zstack_ui. zstack-ctl config_ui --db-username zstack_ui
--db-password DB_PASSWORD The password of the UI database. Default: zstack.ui.password. zstack-ctl config_ui --db-password zstack.ui.password
Note: If you want to change the username or password of the UI database, make sure that the zstack_ui database can be accessed by using the new username and password.

ui_status

Description

Checks the UI service status of a specified node.

Usage

Parameter Description Example
--host HOST Specifies the IP address of the UI server to be checked. Default: localhost. zstack-ctl ui_status --host 172.20.11.12

install_license

Description

Installs the license of ZStack Cloud. Note that you need to refresh the UI after installing the license.

Usage

Parameter Description Example
--license LICENSE, -f LICENSE Specifies the complete path for the license. zstack-ctl install_license --license /root/trailext-license-100days-6hosts.txt
--prikey PRIKEY Optional. Specifies the path for the generated license private key. zstack-ctl install_license --prikey /root/tmp

reset_password

Description

Resets the password of the admin in ZStack Cloud.

Usage

Parameter Description Example
--password PASSWORD

Resets the password of the admin in ZStack Cloud. If not set, the default one (password) is used.

zstack-ctl reset_password --password 123456

change_mysql_password

Description

Changes the password of the MySQL database.

Usage

Parameter Description Example
--root-password ROOT_PASSWORD, -root ROOT_PASSWORD The original root password of the MySQL database. zstack-ctl change_mysql_password --root-password oldpswd
--user-name USER_NAME, -user USER_NAME The username whose password to be changed. zstack-ctl change_mysql_password --user-name root
--new-password NEW_PASSWORD, -new NEW_PASSWORD The new password. zstack-ctl change_mysql_password --new-password newpswd
--remote-ip REMOTE_IP, -ip REMOTE_IP The remote IP address to be set if you need to change the password of a remote database. zstack-ctl change_mysql_password --remote-ip 10.0.0.2

Advanced ctl Commands

install_management_node

Description

Installs ZStack Cloud management node on the current node or a remote node according to the configuration file. Before you can install other nodes, configure the current node first.

Usage

Parameter Description Example
--host HOST Specifies the IP address of the management node to be installed. zstack-ctl install_management_node --host 172.20.12.111
--install-path INSTALL_PATH Specifies the path for installing the management node. Default: /usr/local/zstack. zstack-ctl install_management_node --install-path /usr/local/zstack
--source-dir SOURCE_DIR Specifies the path for installing Apache Tomcat. Default: /usr/local/zstack/apache-tomcat/. zstack-ctl install_management_node --source-dir /usr/local/zstack/apache-tomcat/
--debug Displays Ansible debugging details. zstack-ctl install_management_node --debug
--force-reinstall Deletes the existing Apache Tomcat and re-installs the management node. zstack-ctl install_management_node --force-reinstall
--yum YUM Uses the YUM repos predefined by ZStack Cloud. Available repos: alibase, aliepel, 163base, ustcepel, and zstack-local. zstack-ctl install_management_node --yum 163base
--ssh-key SSH_KEY Sets a private key path for SSH login. zstack-ctl install_management_node --ssh-key /root/.ssh/id_rsa

upgrade_management_node

Description

Upgrades the management node to a specified version.

Usage

Parameter Description Example
--host HOST Specifies the SSH URL of the node to be upgraded. zstack-ctl upgrade_management_node --host 172.20.31.34
--war-file WAR_FILE Sets the URL for the zstack.war package. The URL can be an HTTP URL or a complete path. zstack-ctl upgrade_management_node --war-file /usr/local/zstack/zstack.war
--debug Displays Ansible debugging details. zstack-ctl upgrade_management_node --debug
--ssh-key SSH_KEY Sets a private key path for SSH login. zstack-ctl upgrade_management_node --ssh-key /root/.ssh/id_rsa

rollback_management_node

Description

Rolls back to the management node status if the upgrade fails.

Usage

Parameter Description Example
--host HOST Specifies the IP address of the management node to be rolled back. zstack-ctl rollback_management_node --host 172.20.12.111
--war-file WAR_FILE Sets the URL for the zstack.war package. The URL can be an HTTP URL or a complete path. zstack-ctl rollback_management_node --war-file /usr/local/zstack/zstack.war
--debug Displays Ansible debugging details. zstack-ctl rollback_management_node --debug
--ssh-key SSH_KEY Sets a private key path for SSH login. zstack-ctl rollback_management_node --ssh-key /root/.ssh/id_rsa
--property-file PROPERTY_FILE Specifies the configuration file to be rolled back. zstack-ctl rollback_management_node --property-file /usr/local/zstack/apache-tomcat/webapps/zstack/WEB-INF/classes/zstack.properties

taillog

Description

Displays log updates of the management node.

Usage

Parameter Description Example
none Displays log updates of the management node. zstack-ctl taillog

install_ui

Description

Installs ZStack Cloud UI.

Usage

Parameter Description Example
--host HOST

Specifies the node on which ZStack Cloud UI is installed.

By default, the UI is installed on the current management node.

zstack-ctl install_ui --host 172.20.12.144
--ssh-key SSH_KEY Sets a complete path for the private key. Ansible will automatically log in to the specified node to install the UI. zstack-ctl install_ui --ssh-key /root/.ssh/id_rsa

install_db

Description

Installs ZStack Cloud database.

Usage

Parameter Description Example
--host HOST Sets an IP address or a domain name for the database server. Default value: localhost. zstack-ctl install_db --host
--root-password ROOT_PASSWORD Sets a new password for root users of the MySQL database. zstack-ctl install_db --root-password
--login-password LOGIN_PASSWORD Sets an original login password for the MySQL database. zstack-ctl install_db --login-password password1
--yum YUM Uses the YUM repos predefined by ZStack Cloud. Available repos: alibase, aliepel, 163base, ustcepel, and zstack-local. zstack-ctl install_db --yum 163base
--no-backup NO_BACKUP Disables auto backup if your database is large and you want manual backup. Default: false, that is, the database is automatically backed up. zstack-ctl install_db --no-backup
--ssh-key SSH_KEY Sets a private key path for SSH login. zstack-ctl install_db --ssh-key /root/.ssh/id_rsa

upgrade_db

Description

Upgrades the database to the latest version.

Usage

Parameter Description Example
--force Upgrades the database without checking the management node status. zstack-ctl upgrade_db --force
--no-backup NO_BACKUP Disables auto backup if your database is large and you want manual backup. Default: false, that is, the database is automatically backed up. zstack-ctl upgrade_db --no-backup
--dry-run Checks whether the database can be upgraded. zstack-ctl upgrade_db --dry-run

deploydb

Description

Configures ZStack Cloud database.

Usage

Parameter Description Example
--root-password ROOT_PASSWORD Creates a MySQL root user and sets a password. zstack-ctl deploydb --root-password root123
--zstack-password ZSTACK_PASSWORD Creates a user with the name ZStack and sets a password. zstack-ctl deploydb --zstack-password zstack123
--host HOST Sets an IP address or a domain name for the database server. Default: localhost. zstack-ctl deploydb --host 172.20.11.133
--port PORT Sets the MySQL port. Default: 3306. zstack-ctl deploydb --port 3300
--no-update Does not upgrade the database information to the configuration file. zstack-ctl deploydb --no-update
--drop Deletes existing databases. zstack-ctl deploydb --drop
--keep-db Keeps existing databases from being upgraded. zstack-ctl deploydb --keep-db

rollback_db

Description

Rolls back to the database status if the upgrade fails.

Usage

Parameter Description Example
--db-dump DB_DUMP Specifies backup files to be recovered. zstack-ctl rollback_db --db-dump /zstackdb/backupdb.bk
--root-password ROOT_PASSWORD The MySQL root password, which is blank by default. zstack-ctl rollback_db --root-password password
--force
Ignores to check the management node status.
Note: Exercise caution. Make sure that you totally understand the consequence before you run this command.
zstack-ctl rollback_db --force

clear_license

Description

Clears and backs up ZStack Cloud licenses.

restore_config

Description

Restores ZStack Cloud from the configuration file in a specified directory, including keys of zstack.properties and ssh host.

Usage

Parameter Description Example
--restore-from RESTORE_FROM Specifies the path of the configuration file to be used. zstack-ctl restore_config --restore-from /usr/local/zstack/apache-tomcat/webapps/zstack

save_config

Description

Saves the configuration file of ZStack Cloud to a specified path under ZSTACK_HOME.

Usage

Parameter Description Example
--save-to SAVE_TO Specifies the path for the configuration file of ZStack Cloud. zstack-ctl save_config --save-to /usr/local/zstack/apache-tomcat/webapps/zstack

set_deployment

Description

Sets the cluster deployment scale of ZStack Cloud.

Usage

Parameter Description Example
--size Specifies the cluster deployment scale of ZStack Cloud. Options: small, large, medium, and default. zstack-ctl set_deployment --size small

Scenario

From version 3.10.0, ZStack Cloud allows you to specify the cluster deployment scale and assign different attribute values to clusters accordingly. Options: default, small, medium, and large, where default is the default scale.

The following table lists the attribute values of each scale.
Attribute Default Small Medium Large
Existing attribute: DbFacadeDataSource.maxPoolSize 100 64 128 128
Recommended resource configuration of each scale:
  • default: Default environment, which allows for 50 hosts.
  • small: Small-size environment, which allows for 100 hosts or 1000 VM instances.
  • medium: Medium-size environment, which allow for 400 hosts or 4,000 VM instances.
  • large: Large-size environment, which allows for 1,000 hosts or 10,000 VM instances.

start_vdi

Description

Starts the UI service of ZStack Cloud VDI.

Usage

Parameter Description Example
--mn-port MN_PORT The port of ZStack Cloud management node. Default: 8080. zstack-ctl start_vdi --mn-port 8000
--webhook-port WEBHOOK_PORT The port of the webhook node. Default: 9000. zstack-ctl start_vdi --webhook-port 9050
--server-port SERVER_PORT The port of the UI service. Default: 9000. zstack-ctl start_vdi --server-port 9050
--vdi-path VDI_PATH The VDI path. Default: /opt/zstack-dvd/zstack-vdi.war. zstack-ctl start_vdi --vdi-path /opt/root/zstack-vdi.war
--log LOG The UI log directory. Default: /usr/local/zstack/apache-tomcat/logs. zstack-ctl start_vdi --log /usr/log/logs

stop_vdi

Description

Stops the VDI service on the local node.

Usage

Parameter Description Example
none Stops the VDI service on the local node. zstack-ctl stop_vdi

vdi_status

Description

Checks the VDI status on the local node.

Usage

Parameter Description Example
none Checks the VDI status on the local node. zstack-ctl vdi_status

setenv

Description

Sets variables in /usr/local/zstack/zstack-ctl/ctl-env of zstack-ctl.

Usage

Parameter Description Example
none Sets variables in /usr/local/zstack/zstack-ctl/ctl-env of zstack-ctl. zstack-ctl setenv

unsetenv

Description

Cancels to set variables in /usr/local/zstack/zstack-ctl/ctl-env of zstack-ctl.

Usage

Parameter Description Example
none Cancels to set variables in /usr/local/zstack/zstack-ctl/ctl-env of zstack-ctl. zstack-ctl unsetenv

mysql_restrict_connection

Description

Sets an allowlist policy for the database account of the management node. After an allowlist is enabled, only the management node where the database is located can access the database. The path of other non-management nodes cannot access the database.

Usage

Parameter Description Example
--restrict Enables the allowlist policy to restrict database access. zstack-ctl mysql_restrict_connection --root-password zstack.mysql.password --restrict
--restore Restores the previous policy so that the access to the database is not restricted. zstack-ctl mysql_restrict_connection --root-password zstack.mysql.password --restore

getenv

Description

Obtains variables from /usr/local/zstack/zstack-ctl/ctl-env.

Usage

Parameter Description Example
none Obtains variables from /usr/local/zstack/zstack-ctl/ctl-env. zstack-ctl getenv

bootstrap

Description

Creates ZStack Cloud users and user groups and add them to sudoers.

Usage

Parameter Description Example
none Creates ZStack Cloud users and user groups and add them to sudoers. zstack-ctl bootstrap

upgrade_ctl

Description

Upgrades zstack-ctl to a new version.

Usage

Parameter Description Example
--package PACKAGE Specifies a path for zstack-ctl installation package. zstack-ctl upgrade_ctl --package ./apache-tomcat-7.0.35/webapps/zstack/WEB-INF/classes/tools/zstackctl-1.8.tar.gz

Glossary

Instance

An instance is a virtual machine or server that runs the images of operating systems in Cloud, such as VM instance and elastic baremetal instance.

VM Instance

A VM instance is a virtual machine instance running on a host. A VM instance has its own IP address and can access public networks and run application services.

Volume

A volume provides storage space for a VM instance. Volumes are categorized into root volumes and data volumes.

Root Volume

A root volume provides support for the system operations of a VM instance.

Data Volume

A data volume provides extended storage space for a VM instance.

Image

An image is a template file used to create a VM instance or volume. Images are categorized into system images and volume images.

Instance Offering

An instance offering defines the number of vCPU cores, memory size, network bandwidth, and other configuration settings of VM instances.

Disk Offering

A disk offering defines the capacity and other configuration settings of volumes.

GPU Specification

A GPU specification defines the frame per second (FPS), video memory, resolution, and other configuration settings of a physical or virtual GPU. GPU specifications are categorized into physical GPU specifications and virtual GPU specifications.

vNUMA Configuration

vNUMA uses CPU pinning to passthrough the topology of associated host physical NUMA (pNUMA) nodes to a VM instance, generating a topology of virtual NUMA (vNUMA) nodes for the VM instance. This topology enables a vCPU on a vNUMA node to primarily access the local memory and thus improves VM performance.

NUMA (Non-Uniform Memory Access)

Non-uniform memory access (NUMA) is a computer memory design where the memory access time depends on the memory location relative to the CPU. Under NUMA, a processor can access its own local memory faster than non-local memory and thus improves VM performance.

pNUMA Node (physical NUMA Node)

A pNUMA node (physical NUMA node) is a host NUMA node predefined based on the host NUMA architecture. It is used to manage the CPUs and memory of the host.

pNUMA Topology (physical NUMA Topology)

A pNUMA topology (physical NUMA topology) is the topology of the host NUMA nodes predefined by the CPU vendor based on the host NUMA architecture.

vNUMA Node (virtual NUMA Node)

A vNUMA node (virtual NUMA node) is generated by passing-through associated pNUMA nodes via CPU pinning. It is used to manage the CPUs and memory of a VM instance.

vNUMA Topology (virtual NUMA Topology)

A vNUMA topology (virtual NUMA topology) is the topology of VM NUMA nodes generated by passing-through associated pNUMA nodes via CPU pinning.

Local Memory

Local memory is the memory that a CPU (pCPU or vCPU) accesses through the Uncore iMC (Integrated Memory Controller) of the same NUMA (pNUMA or vNUMA) node. Compared with accessing non-local memory, accessing local memory has lower latencies.

CPU Pinning

CPU pinning assigns the virtual CPUs (vCPUs) of a VM instance to specific physical CPUs (pCPUs) of the host, which improves VM performance.

EmulatorPin Configuration

EmulatorPin assigns all other threads than virtual CPU (vCPU) threads and IO threads of a VM instance to physical CPUs (pCPUs) of the host so that these threads run on assigned pCPUs.

Auto-Scaling Group

An auto-scaling group is a group of VM instances that are used for the same scenarios. An auto-scaling group can automatically scale out or in based on application workloads or health status of VM instances in the group.

Snapshot

A snapshot is a point-in-time capture of data status in a volume.

Affinity Group

A VM scheduling policy is a resource orchestration policy based on which VM instances are assigned hosts to achieve the high performance and high availability of businesses.

Zone

A zone is a logical group of resources such as clusters, L2 networks, and primary storage. Zone is the largest resource scope defined in the Cloud.

Cluster

A cluster is a logical group of hosts (compute nodes).

Host

A host provides compute, network, and storage resources for VM instances.

Primary Storage

A primary storage is one or more servers that store volume files of VM instances. These files include root volume snapshots, data volume snapshots, image caches, root volumes, and data volumes.

Image Storage

An image storage is a storage server that stores VM image templates, including ISO image files.

iSCSI Storage

iSCSI storage is an SAN storage that uses the iSCSI protocol for data transmission. You can add an iSCSI SAN block as a Shared Block primary storage or pass through the block to a VM instance.

FC Storage

FC storage is an SAN storage that uses the FC technology for data transmission. You can add an FC SAN block as a Shared Block primary storage or pass through the block to a VM instance.

NVMe Storage

A type of storage implemented via the NVMe-oF (NVMe over fabrics) protocol. You can add a block device configured from an NVMe storage as SharedBlock primary storage.

L2 Network

An L2 network is a layer 2 broadcast domain used for layer 2 isolation. Generally, L2 networks are identified by names of devices on the physical network.

VXLAN Pool

A VXLAN pool is a collection of VXLAN networks established based on VXLAN Tunnel Endpoints (VTEPs). The VNI of each VXLAN network in a VXLAN pool must be unique.

L3 Network

An L3 network includes IP ranges, gateway, DNS, and other network configurations that are used by VM instances.

Public Network

Generally, a public network is a logical network that is connected to the Internet. However, in an environment that has no access to the Internet, you can also create a public network.

Flat Network

A flat network is connected to the network where the host is located and has direct access to the Internet. VM instances in a flat network can access public networks by using elastic IP addresses.

VPC Network

A VPC network is a private network where VM instances can be created. A VM instance in a VPC network can access the Internet through a VPC vRouter.

Management Network

A management network is used to manage physical resources in the Cloud. For example, you can create a management network to manage access to hosts, primary storage, image storage, and VPC vRouters.

Flow Network

A flow network is a dedicated network for port mirror transmission. You can use a flow network to transmit the mirrors of data packets of NIC ports to the target ports.

VPC vRouter

A VPC vRouter is a dedicated VM instance that provides multiple network services.

VPC vRouter HA Group

A VPC vRouter HA group consists of two VPC vRouters. Either VPC vRouter can be a primary or secondary VPC vRouter for the group. If the primary VPC vRouter does not work as expected, the VPC vRouter becomes the secondary VPC vRouter in the group to ensure high availability of business.

vRouter Image

A vRouter image encapsulates network services and can be used to create VPC vRouters.

Dedicated-Performance LB Image

A dedicated-performance load balancer (LB) image encapsulates dedicated-performance load-balancing services and can be used to create load balancer instances. However, a dedicated-performance load balancer image cannot be used to create VM instances.

vRouter Offering

A vRouter offering defines the number of vCPU cores, memory size, image, management network, and public network configuration settings of VPC vRouters. You can use a vRouter offering to create VPC vRouters that can provide network services for public networks and VPC networks.

LB Instance Offering

A load balancer (LB) instance offering defines the CPU, memory, image, and management network configuration settings used to create LB instances. LB instances provide load balancing services for the public network, flat network, and VPC network.

SDN Controller

The SDN controller is the core of the SDN architecture, responsible for centralized management and control of network devices.

SDN Cluster

A cluster of dedicated VM instances designed to provide highly available SDN capabilities.

SDN Instance

A dedicated VM instance designed to provide SDN network capabilities.

SDN Image

An SDN image encapsulates an SDN software and can be used to create SDN instances.

SDN Instance Offering

An SDN instance offering defines the CPU, memory, SDN image, and management network configuration used for creating SDN instances.

Security Group

A security group provides security control services for VM NICs. It filters the ingress or egress TCP, UDP, and ICMP packets of VM NICs based on the specified security rules.

VIP

In bridged network environments, a virtual IP address (VIP) provides network services such as serving as an elastic IP address (EIP), port forwarding, load balancing, IPsec tunneling. When a VIP provides the preceding network services, packets are sent to the VIP and then routed to the destination network where VM instances are located.

EIP

An elastic IP address (EIP) functions based on the NAT technology. IP addresses in a private network are translated into an EIP that is in another network. This way, private networks can be accessed from other networks by using EIPs.

Port Forwarding

Port forwarding functions based on the layer-3 forwarding service of VPC vRouters. This service forwards traffic flows of the specified IP addresses and ports in a public network to specified ports of VM instances by using the specified protocol. If your public IP addresses are insufficient, you can configure port forwarding for multiple VM instances by using one public IP address and port.

Load Balancer

A load balancer distributes traffic flows of a virtual IP address to backend servers. It automatically inspects the availability of backend servers and isolates unavailable servers during traffic distribution. This way, the load balancer improves the availability and service capability of your business.

Listener

A listener monitors the frontend requests of a load balancer and distributes the requests to a backend server based on the specified policy. In addition, the listener performs health checks on backend servers.

Forwarding Rule

A forwarding rule forwards the requests from different domain names or URLs to different backend server groups.

Backend Server Group

A backend server group is a group of backend servers that handles requests distributed by load balancers. It is the basic unit for traffic distribution by load balancer instances.

Backend Server

A backend server handles requests distributed by a load balancer. You can add a VM instance on the Cloud or a server on a third-party cloud as a backend server.

Frontend Network

A frontend network is a type of network that is associated with a load balancer. Requests from the network are distributed by the load balancer to backend servers based on a specified policy.

Backend Network

A backend network is a type of network that is associated with a load balancer. Requests from frontend networks are distributed by the load balancer to servers in the backend network.

Load Balancer Instance

A load balancer instance is a custom VM instance used to provide load balancing services.

Certificate

If you select HTTPS for a listener, associate it with a certificate to make the listener take effect. You can upload either a certificate or certificate chain.

Firewall

A firewall is an access control policy that monitors ingress and egress traffic of VPC vRouters and decides whether to allow or block specific traffic based on the associated rule sets and rules.

Firewall Rule Set

A firewall rule set is a set of rules that a firewall uses to defend against network attacks. You need to associate a rule set with the egress or ingress flow direction of VPC vRouter NICs to make the rule set take effect.

Firewall Rule

A firewall rule is an access control entry associated with the egress or ingress flow direction of VPC vRouter NICs to defend against network attacks. A firewall rule includes rule priority, match condition, and behavior.

Rule Template

A rule template is a template that you can select when you add rules to a rule set or a firewall.

IP/Port Set

An IP or port set is a set of IP addresses or ports that you can select when you add rules to a rule set or a firewall.

IPsec Tunnel

An IPSec tunnel encrypts and verifies IP packets that transmit over a virtual private network (VPN) from one site to another.

OSPF Area

An Open Shortest Path First (OSPF) area is divided from an autonomous system based on the OSPF protocol. This simplifies the hierarchical management of vRouters.

NetFlow

A NetFlow monitors the ingress and egress traffic of the NICs of VPC vRouters. The supported versions of data flows are V5 and V9.

Port Mirroring

Port mirroring mirrors the traffic data of VM NICs and sends the traffic data to the target ports. This allows for the analysis of data packets of ports and simplifies the monitoring and management of data traffic and makes it easier to locate network errors and exceptions.

Route Table

A route table contains information about various routes that you configure. Route entries in a route table must include the destination network, next hop, and route priority.

CloudFormation

CloudFormation is a service that simplifies the management of cloud resources and automates deployment and O&S. You can create a stack template to configure cloud resources and their dependencies. This way, resources can be automatically configured and deployed in batches. CloudFormation provides easy management of the lifecycle of cloud resources and integrates automatic O&S into API and SDK.

Resource Stack

A resource stack is a stack of resources that are configured by using a stack template. The resources in the stack have dependencies with each other. You can manage resources in the stack by managing the resource stack.

Stack Template

A stack template is a UTF8-encoded file based on which you can create resource stacks. The stack template defines the resources that you want, the dependencies between the resources, and the configuration settings of the resources. When you use a stack template to create a resource stack, CloudFormation parses the template and the resources are automatically created and configured.

Sample Template

A sample template is a commonly used resource stack. You can use a sample template provide by the Cloud to create resource stacks.

Designer

A designer is a CloudFormation tool that allows you to orchestrate cloud resources. You can drag and drop resources on a canvas and use lines to establish dependencies between the resources.

Baremetal Cluster

A baremetal cluster consists of baremetal chassis. You can manage baremetal chassis by managing a baremetal cluster where the chassis reside.

Deployment Server

A deployment server is a server that provides PXE service and console proxy service for baremetal chassis.

Baremetal Chassis

A baremetal chassis is used to create a baremetal instance and is identified based on the BMC interface and IPMI configuration setting.

Preconfigured Template

A preconfigured template is used to create a preconfigured file that allows for unattended batch installation of an operating system for baremetal instances.

Baremetal Instance

A baremetal instance is an instantiated baremetal chassis.

Elastic Baremetal Management

Elastic Baremetal Management provides dedicated physical servers for your applications to ensure high performance and stability. In addition, this feature allows elastic scaling. You can apply for and scale resources based on your needs.

Provision Network

A provision network is a dedicated network for PXE boot and image downloads while creating elastic baremetal instances in a gateway proxy cluster.

Elastic Baremetal Cluster

Provides a separated cluster to manage baremetal nodes.

Gateway Node

A gateway node is a node where the ingress and egress traffic of the Cloud and elastic baremetal instances in gateway proxy clusters is forwarded.

Baremetal Node

A baremetal node is used to create a baremetal instance and is identified based on the BMC interface and IPMI configuration setting.

Elastic Baremetal Instance

An elastic baremetal instance has the same performance as physical servers and allows elastic scaling. You can apply for and scale resources based on your needs.

Elastic Baremetal Offering

An elastic baremetal offering defines the number of vCPU cores, memory size, CPU architecture, CPU model, and other configuration settings of elastic baremetal instances.

vCenter

The Cloud allows you to take over vCenter and manage resources on the vCenter.

VM Instance

A VM instance is an ESXi virtual machine instance running on a host. A VM instance has its own IP address to access public networks and can run application services.

Network

A vCenter network defines the network settings of VM instances on vCenter, such as IP range, gateway, DNS, and network services.

Volume

A volume provides storage space for a VM instance on vCenter. A volume attached to a VM instance can be used as a root volume or data volume. A root volume provides support for the system operations of a VM instance. A data volume provides extended storage space for a VM instance.

Image

An image is a template file used to create a VM instance or volume on vCenter. Images are categorized into system images and volume images.

Event Message

Event Message displays event alarm messages of vCenter that is took over by the Cloud. This feature allows you to locate errors and exceptions efficiently.

Network Topology

A network topology visualizes the network architecture of the Cloud. It allows for efficient planning, management, and improvement of network architecture. Network topologies can be categorized into global topologies and custom topologies.

Performance Analysis

Performance Analysis displays the performance metrics of key resources monitored externally or internally in the Cloud. You can view the performance analysis or export the analysis report as needed to improve the O&M efficiency.

Capacity Management

Capacity Management visualizes the capacities and usages of key resources in the Cloud. You can use this feature to improve O&S efficiency.

MN Monitoring

Management Node (MN) monitoring allows you to view the health status of each management node when you use multiple management nodes to achieve high availability.

Alarm

An alarm is used to monitor the status of time-series data and events and respond to the status change. Alarms can be categorized into resource alarm, event alarm, and extended alarm.

One-Click Alarm

A one-click alarm integrates multiple metrics of a resource. You can create one-click alarms for multiple resources to monitor these resources.

Alarm Template

An alarm template is a template of alarm rules. If you associate an alarm template with a resource group, an alarm is created to monitor the resources in the group.

Resource Group

A resource group consists of resources grouped based on your business needs. If you associate an alarm template with a resource group, the alarm rules specified by the template take effect on all the resources in the group.

Message Template

A message template specifies the text template of a resource alarm message or event alarm message sent to an SNS system.

Message Source

A message source is used to take over extended alarm messages. If you configure alarms for message sources, extended alarm messages can be sent to various endpoints.

Endpoint

An endpoint is a method that users obtain subscribed messages. Endpoints are categorized into system endpoints, email, DingTalk, HTTP application, short message service, and Microsoft Teams.

Alarm Message

An alarm message is a message sent the time when an alarm is triggered.

Current Task

A current task is an ongoing operation performed in the Cloud. You can perform centralized management over ongoing operations.

Operation Log

An operation log is a chronological record of operations on the specified objects and their operation results.

Audit

Audit monitors and records all activities on the Cloud. You can use this feature to implement operation tracking, cybersecurity classified protection compliance, security analysis, troubleshooting, and automatic O&M.

Log Collection

Allows you to collect with one click the log data from the Cloud and various nodes on the Cloud generated in the specified time period and download the log data.

One-Click Inspection

Comprehensively inspects the health status of key resources and services of the Cloud and scores their healthiness based on the inspection results. In addition, the one-click inspection service provides O&M suggestions and inspection reports.

Backup Management

Backup management integrates multiple disaster recovery technologies such as incremental backup and full backup that are suitable for multiple business scenarios. You can implement local backup and remote backup based on your business needs.

Backup Job

You can create a backup job to back up local VM instances, volumes, or databases to a specified storage server on a regular basis.

Local Backup Data

Local backup data of VM instances, volumes, and databases is stored in the local backup server.

Local Backup Server

A local backup server is located at the local data center and is used to store local backup data.

Remote Backup Server

A remote backup server is located at a remote data center or a public cloud and is used to store remote backup data.

Continuous Data Protection (CDP)

Continuous Data Protection (CDP) provides second-level and fine-grained continuous backups for important business systems in VM instances, allowing users to restore VM data to a specific time state, and retrieve files without restoring the system.

CDP Task

You can create a CDP task to continuously back up your VM data to a specified backup server to achieve continuous data protection and recovery.

CDP Data

The backup data generated from continuous data protection on VM instances is stored in local backup servers.

Recovery Point

A recovery point is a data point generated during continuous data protection. A recovery point corresponds to a data record within the recovery point interval specified by the user.

Locked Recovery Point

You can lock or unlock a recovery point as needed. After a recovery point is locked, data of the recovery point will not be automatically cleared or deleted.

Recovery Task

A recovery task helps you quickly restore data by specifying a CDP task and recovery point, and allows you to view the recovery progress and logs in a more friendly way.

Cryptography Security Compliance

The Cryptography Security Compliance service provides applications with cloud security capabilities based on commercial cryptography, meeting the requirements of commercial cryptography application security assessments.

HSM Pool

An HSM pool is a logical group of hardware security modules (HSMs) and is used to provide unified cryptography services such as signature validation and encryption.

HSM

A hardware security module (HSM) is a dedicated device that encrypts, decrypts, and authenticates information by using the cryptographic technology.

Platform Cryptography Security Compliance

Enables the Cloud to meet the requirements of Cryptography Security Compliance through the cryptography capabilities provided by HSM pools.

Certificate Login

Authenticates the identity of a user by using a UKey device.

Data Protection

Protects important data on the Cloud to ensure the data confidentiality and integrity.

Scheduled Job

A scheduled job defines that a specific action be implemented at a specified time based on a scheduler.

Scheduler

A scheduler is used to schedule jobs. It is suitable for business scenarios that last for a long time.

Tag

A tag is used to mark resources. You can use a tag to search for and aggregate resources.

Migration Service

The Cloud provides V2V migration service that allows you to migrate VM instances and data from other virtualized platform to the current cloud platform.

ZMigrate Migration Service

A migration service installed from Application Market that migrates VM instances and their data from VMware environments to the current cloud platform.

V2V Migration

V2V Migration allows you to migrate VM instances from the VMware or KVM platform to the current cloud platform.

V2V Conversion Host

A V2V conversion host is a host in the destination cluster that you need to specify during V2V migration to cache VM instances and data when you implement V2V migration. After the VM instances and data are cached in the V2Vconversion host, they are migrated to the destination primary storage.

User

A user is a natural person that constructs the most basic unit in Tenant Management.

User Group

A user group is a collection of natural persons or a collection of project members. You can use a user group to grant permissions.

Role

A role is a collection of permissions that can be granted to users. A user that assumes a role can call API operations based on the permissions specified by the role. Roles are categorized into platform roles and project roles.

Single Sign-On

The Single Sign-On service provided by the Cloud. It supports seamless access to SSO systems. Through the service, related users can directly log in to the Cloud and manage cloud resources.

Project

A project is a task that needs to be accomplished by specific personnel at a specified time. In Tenant Management, you can plan resources at the project granularity and allocate an independent resource pool to a project. The word Tenant in Tenant Management mainly refers to projects. A project is a tenant.

Project Member

A project member is a member in a project who is granted permissions on specific project resources and can use the resources to accomplish tasks. Project members include the project admin, project managers, and normal project members.

Process Management

Process management is part of ticket management that manages the processes related to the resources of projects. Processes can be categorized into default processes and custom processes.

My Approvals

In the Cloud, only the administrator and project administrators are granted approval permissions. the administrator and project administrators can approve or reject a ticket. If a ticket is approved, resources are automatically deployed and allocated to the specified project.

Bills

A bill is the expense of resources totaled at a specified time period. Billing is accurate to the second. Bills can be categorized into project bills, department bills, and account bills.

Pricing List

A pricing list is a list of unit prices of different resources. The unit price of a resource is set based on the specification and usage time of the resource.

Console Proxy

Console proxy allows you to log in to a VM instance by using the IP address of a proxy.

AccessKey Management

An AccessKey pair is a security credential that one party authorizes another party to call API operations and access its resources in the Cloud. AccessKey pairs shall be kept confidential.

IP Allowlist/Blocklist

An IP allowlist or blocklist identifies and filters IP addresses that access the Cloud. You can create an IP allowlist or blocklist to improve access control of the Cloud.

Application Center

Application Market allows you to add applications to the Cloud and then access the applications with one click. It extends the functionality of the Cloud. You can add default applications through the built-in installation package or add more applications through URLs.

Sub-Account Management

A sub-account can be created by the admin or synced from an SSO authentication system and is managed by the admin. Resources created under a sub-account are managed by the sub-account.

Theme and Appearance

You can customize the theme and appearance of the Cloud.

Email Server

If you select Email as the endpoint of an alarm, you need to set an email server. Then alarm messages are sent to the email server.

Log Server

A log server is used to collect management node logs or the platform operation logs. You can add a log server to the cloud and use the collected logs for operation trace or troubleshooting. This makes your O&M more efficient.

Global Setting

Global Setting allows you to configure settings that take effect on the whole platform.

Scenario Template

Scenario Template provides multiple templates that encapsulate scenario-based global settings. You can apply a template globally with one click based on your business needs. This improves your O&M efficiency.

HA Policy

HA Policy is a mechanism that ensures sustained and stable running of the business if VM instances are unexpectedly stopped or are errored because of errors occurring to compute, network, or storage resources associated with the VM instances. By enabling this feature, you can customize VM HA policies to ensure your business continuity and stability.

Time Management

Manages the Cloud system time and allows you to configure time servers for the Cloud. After you configure NTP time servers for the Cloud, the clock of the time servers is synced with all nodes of the Cloud.

GPU Device

A GPU device is a powerful microprocessor with high computational capabilities. You can use a GPU device to handle intricate graphics rendering and parallel computing jobs, thus improving the efficiency of businesses such as graphic production, video processing, and machine learning.

Script Library

The script library stores and manages script files centrally. By executing scripts on VM instances, you can complete complex O&M operations and automated jobs.

XML Hook

An XML Hook is a script that can flexibly insert or modify parameters in XML files of VM instances. By attaching an XML Hook to a VM instance, you can customize VM configurations and enable specialized functionalities.

Container Service

A simple and user-friendly container management service, providing features like GPU management & scheduling, multi-tenancy, multi-cluster, quota configuration, CI/CD. and microservice. The service reduces the container using complexity and aligns well with traditional user's habits, helping you easily manage and deploy your container cluster, and enjoy the benefits of cloud-native technologies in a quick and convenient way.

Advanced Monitoring Server

An advanced monitoring server is a dedicated VM instance used to receive advanced monitoring data of load balancers and other resources.

Advanced Monitoring Server Image

An advanced monitoring server image encapsulates the advanced monitoring service and can be used to create advanced monitoring server.

Advanced Monitoring Server Offering

An advanced monitoring server offering defines the CPU cores, memory size, image, management network, and public network configurations of advanced monitoring server. You can use an advanced monitoring server offering to create advanced monitoring servers.

Plugin Management

You can package extended resources or tools into standardized plugins for quick installation and integration, expanding the Cloud capabilities.

Region Management

A region is a self-contained cloud environment with independent management node(s), networks, hardware, and cloud resources. ZStack IAM enabled user synchronization and SSO across multiple regions.
CTL Command Manual | 5.5.38 | ZStack Cloud · ZCF | ZStack Resource Center