DocsKnowledge BaseAPI Explorer
Documentation›HCI›SDDC Manager›User Guide
HCI

Overview

SDDC Manager is an installation and deployment tool that supports combinations of virtualization, storage, and container products. Supported products include ZStack Cube, ZCF, ZVF, Zaku, and compatible storage products.

Its visual wizard covers the deployment workflow, from installing operating systems on servers and configuring products to installation checks and verification of results. You can configure and install multiple products with the same tool, reducing repeated work and switching between tools.

This guide explains how to install and deploy products with SDDC Manager.

Scope

This guide applies to SDDC Manager 1.1.0.

Intended Audience

This guide is for the following personnel involved in installation and deployment:

  • Deployment staff.
  • Technical support staff.
  • Test staff.
  • Operations staff.

Readers need basic knowledge of servers, networks, disks, and virtualization.

How to Use This Guide

For your first deployment, follow the chapters in the order shown below, from preparation through product deployment. For unfamiliar terms, see Terminology in the appendix.

Chapter Guidance
Overview Learn about the product, document scope, intended audience, and conventions.
Preparing for Deployment Prepare the controller, servers, networks, packages, and OS images, and complete deployment planning.
Configuring the Controller Configure the network and start Manager for your deployment method. Configure and start PXE when installing server operating systems through PXE.
Installing Server Operating Systems If OS installation is required, install the server operating systems through PXE and save the installation report. If all target servers have the matching operating system installed and SDDC Agent running, skip PXE installation and proceed directly to the product deployment wizard.
Deploying Products with the Wizard Follow the wizard to select hosts, prepare products and packages, configure deployment, run pre-installation checks, install products, and verify the results.
Frequently Asked Questions Check page access, server discovery, and media or package validation issues, and collect error details and support information.
Appendix Look up common terms used in this guide.

Conventions

Interface labels and options may vary between versions. Follow the labels and options shown in your interface.

IP addresses, hostnames, and file paths in this guide are examples. Replace them with the corresponding values for your environment.

Preparing for Deployment

Preparation Checklist

Before deployment, prepare the devices, networks, and software required for the selected product combination. Review the linked requirements.

Item Description Detailed Requirements
Controller The device that runs SDDC deployment services. It can be a separate device or one of the target servers. Prepare the Controller
SDDC Manager package The package for running the SDDC client, Manager, and PXE services on the controller. Prepare the SDDC Manager Package
Servers The devices on which the selected products are installed and run. The interface calls them hosts. Prepare the Servers
Operating system images The supplied operating system image for installing server operating systems. Prepare the OS Images
Target product installation packages Installation files for the virtualization, storage, or container products in this deployment. Prepare the Target Product Packages
Network plan Network settings for communication between the controller and servers, OS installation, and product operation. Prepare the Network

Prepare the Controller

Prepare a device to run SDDC services using either method:

  • Separate controller: use a physical machine or virtual machine running Windows or macOS.
  • Target server as the controller: if the servers already have the supplied customized operating system installed, select one Linux server to run the deployment services.

Windows 11 x64 and macOS 13 or later are recommended.

  • Administrative permissions: ensure that you have the permissions required to run and manage SDDC Manager.
  • Network connectivity: ensure that the controller can access the servers through the deployment network.
  • Storage: reserve enough disk space for installation packages and extracted image files.

Prepare the SDDC Manager Package

Contact official technical support for the matching SDDC Manager package, and verify the following:

  • The package supports the controller operating system.
  • The package supports the controller CPU architecture.

Prepare the Servers

Prepare the servers according to the selected products' requirements:

  • Check the target products' hardware requirements and prepare the CPUs, memory, disks, and NICs accordingly.
  • Record each server's installation NIC MAC address, device serial number (SN), and the name, capacity, and model of its intended system disk.
  • Back up data that must be retained.
  • For PXE installation, confirm that the servers support booting from the connected NIC and disable Secure Boot. All servers in an OS installation batch must have the same CPU architecture.

Prepare the OS Images

Servers supplied as part of an integrated hardware and software solution may have operating systems preinstalled. First verify that the operating systems match the deployment requirements and that SDDC Agent is running.

If OS installation is required, use the supplied customized OS image. After installation, the servers run SDDC Agent so that SDDC Manager can discover and manage them. Contact official technical support for the image, and verify the following:

  • The image supports the server CPU architecture.
  • The image supports the server boot mode.
  • The image meets the requirements of the products being deployed.

Prepare the Target Product Packages

Contact official technical support to obtain the virtualization, storage, and container platform installation packages required for your deployment.

Prepare the Network

Plan the networks needed for deployment page access, PXE installation, and product operation:

  • Page access: plan a controller IPv4 address that the browser can reach to open the Manager and PXE pages. You can use the controller's existing address.
  • PXE installation: select a controller NIC on the same Layer 2 network as the target server NICs. Plan its IPv4 address, subnet mask, optional VLAN, and DHCP address pool. Keep the pool and PXE address on the same subnet. Exclude addresses already in use, the network address, and the broadcast address. Provide enough addresses for the batch.
  • Server discovery and communication: keep IPv6 enabled on the wired NICs between the controller and servers, and allow mDNS multicast for server discovery and SDDC Agent communication.
  • Product operation: plan each server's management address, storage network, and business network according to the selected products' requirements. For dual-node management, also plan the management VIPs. Record IP addresses, subnet masks, gateways, and NICs for use in the wizard.
Note: No conflicting DHCP service may run on the PXE installation network. Before installation, check the DHCP services and address pool plan for that network.

Allow traffic on the following ports in the indicated directions. IPv4 addresses provide access to the deployment pages; server discovery and Agent communication also require the IPv6 and multicast conditions above.

Connection Port Purpose
Browser to controller TCP 10016 Manager product deployment page.
Browser to controller TCP 10018 PXE OS installation page.
Target server to controller PXE address TCP 10019 Network boot, installation content download, discovery, and installation result reporting.
Target server and PXE service UDP 67, 69 DHCP and TFTP network boot.
Controller to server TCP 10017 SDDC Agent communication.

Product deployment also requires access to the servers' SSH TCP port (default: 22). Use the actual port specified in Configure System.

Configuring the Controller

After completing Preparing for Deployment, configure the controller network and start Manager to deploy the target products. Configure and start PXE if you need to install server operating systems through PXE.

Use the local console on a separate Windows or macOS controller. If a target server also serves as the controller, use the command line on that Linux server.

Windows / macOS (Separate Controller)

  1. Extract the SDDC Manager package obtained during preparation to a writable directory. Keep all included directories and files, including bin and assets.
  2. Open the extracted bin directory. On Windows, double-click sddc-console.exe; on macOS, double-click sddc-console. Wait for the local console to open in the browser.
  3. Grant the required operating system permissions. Review the current network in the console and verify NICs, MAC addresses, and IPv4 addresses. If the status cannot be confirmed, click Authorization check, then Rescan.

  4. Configure and start Manager.

    If the Manager card shows Running and its network settings do not need changing, you do not need to start it again. Otherwise, choose the applicable option below:

    • To use the controller's existing IPv4 address, click Start Manager on the Manager card and grant the required operating system permissions.
    • To configure a static IPv4 address on the controller NIC, click Initialize and start on the Manager card, select static IPv4 configuration, and enter the NIC, IPv4 address, subnet mask, and optional VLAN. Review the changes, then confirm and start.

  5. Configure and start PXE if needed.

    For PXE installation, choose the applicable option below. If the PXE card shows Running and the installation network is unchanged, continue to check access to the service pages.

    • The first time you use PXE, click Initialize and start on the PXE card. Enter the network parameters in the table below, review the changes, then confirm and start.
    • When reusing the controller, if PXE was initialized previously and the installation NIC, address, and address pool remain unchanged, click Start PXE. If these settings need changing, use Initialize and start again.
    PXE network parameter Instructions
    NIC Select a wired NIC on the same Layer 2 network as the target servers, and verify its MAC address. A dedicated installation network is recommended to avoid affecting the management connection.
    IPv4 address and subnet mask Enter the controller's IPv4 address and subnet mask on the installation network in their separate fields. Do not include a CIDR suffix in the IPv4 address field.
    VLAN ID Follow the switch and NIC plan. Select the untagged option if VLAN tagging is not required. Changing a Windows NIC's VLAN may affect other connections on that NIC; verify the NIC's purpose first.
    DHCP address pool Use the same subnet as the PXE address. Exclude addresses used by the controller or other devices, the network address, and the broadcast address. No conflicting DHCP service may run on this installation network.

  6. Check the services and open their pages.

    Wait until the Manager card shows Running, then click Open service. If using PXE, also confirm that its card shows Running and open its service page.

    • Manager: http://127.0.0.1:10016/.
    • PXE: http://127.0.0.1:10018/.

    Use these addresses when accessing the services from the controller. From another device, replace 127.0.0.1 with the controller's reachable IPv4 address and ensure that the corresponding ports are accessible.

    When the services are ready, continue according to the server status:

Note: The portable package does not start automatically with the operating system. Keep the controller powered on during deployment. After sleep or restart, check and start the required services again.

Linux (Target Server as the Controller)

  1. Check SDDC Manager.

    Run the following command to check the version:

    sddc-manager version
    • Version displayed: verify that it matches the version supplied for this deployment, then continue to the next step.

    • Command not found: use the matching RPM package for the current system. Replace the path below with the actual file path and run:

      sudo rpm -Uvh "<path-to-SDDC-Manager-RPM>"

      After installation, run sddc-manager version again to check the version.

  2. Configure the Manager network.

    The first time you use Manager, run:

    sudo sddc-manager init
    1. Select the Manager NIC and enter the planned IPv4 address, subnet, gateway, DNS, and optional VLAN. Review and confirm the settings.
    2. Answer No to Enable PXE?. If PXE installation is required, configure PXE separately in the next step.

    If Manager was initialized previously and its network settings do not need changing, continue to the next step.

  3. Configure the PXE installation network if needed.

    If all target servers have the matching operating system installed and SDDC Agent running, skip PXE configuration and continue to check and start Manager. For the first PXE installation, run:

    sudo sddc-manager pxe init
    1. Select the PXE NIC on the same Layer 2 network as the target servers.
    2. Enter the PXE IPv4 address, subnet mask, optional VLAN, and DHCP address pool planned in Prepare the Network.
    3. Review and confirm the network settings, then wait for PXE initialization to finish.

    If PXE was initialized previously and the installation network remains unchanged, skip initialization and check the service status.

  4. Check and start the services.

    • Check Manager:

      sudo sddc-manager status

      If Manager is not running, run:

      sudo systemctl start sddc-manager.service

      Run the status command again to check that Manager is ready.

    • If using PXE for OS installation, check PXE:

      sudo sddc-manager pxe status

      If PXE is not running, run:

      sudo sddc-manager pxe serve

      Run the status command again to check that PXE is ready.

  5. Open the service pages.

    In a browser, use the controller's reachable IPv4 address to open:

    • Manager: http://<controller-IPv4>:10016/.
    • PXE (if using PXE for OS installation): http://<controller-IPv4>:10018/.

    When the services are ready, continue according to the server status:

Installing Server Operating Systems

Note: If all target servers have the matching operating system installed and SDDC Agent running, skip this chapter and continue to Deploying Products with the Wizard.
Warning: Starting installation formats the selected system disks. Verify the target hosts and disks and back up any data that must be retained.

Complete Preparing for Deployment to obtain the supplied OS image and prepare the servers and PXE network. Configure the PXE network and start the PXE service as described in Configuring the Controller.

Use PXE to install the customized operating system on the target hosts: the servers selected for OS installation. The term “node” on pages or in reports refers to the same devices.

  1. Import and Confirm Installation Media

    Prepare installation media using the supplied OS image. A batch uses one set of media to install a group of target hosts with the same CPU architecture. The media must match the product version, CPU architecture, and boot mode confirmed during preparation.

    1. Open the PXE installation page.
      • On Windows/macOS, click Open service on the PXE card in the local console.
      • For direct access, open http://<reachable-controller-IPv4>:10018/ in a browser.

      Confirm that the page reports the PXE runtime as ready before selecting installation media.

    2. Open 安装介质 (Installation Media) and check the names, architectures, operating systems, and statuses of existing media. Reuse ready media for the supplied OS image if it is already available.
    3. If no suitable media is available, select a method under “导入新的 ISO” (Import a New ISO) and import the prepared OS image as described below.
      Method Action
      Browser upload Select a local OS image file and click 上传并导入 (Upload and Import).
      URL download Enter the HTTP/HTTPS URL of the supplied OS image and click 下载并导入 (Download and Import).
      Local file on the controller Place the image in the import directory shown on the page, scan the directory, then select and import the file. Windows/macOS portable packages use data/pxe-imports within the package.
    4. Confirm that the media status is “已就绪” (Ready); for newly imported media, wait for processing to complete. Verify that its architecture and supported boot mode match the target hosts, then select it.
    5. Click 确认介质并开始发现 (Confirm Media and Start Discovery).

      Confirming the media binds it to the current batch. Next, boot the target hosts from their PXE NICs.

    The page shows the selected media for this batch. Next, boot the target hosts from their PXE NICs to discover them.

  2. Discover and Select Target Hosts

    Use the PXE NIC MAC addresses and device serial numbers (SNs) recorded during preparation to identify the target hosts.

    1. Set each target host's boot device for the current boot to the NIC connected to the controller's PXE network, then power on or restart the target.
    2. Open 目标主机 (Target Hosts) and wait for discovery to complete.
    3. Verify each target host's PXE MAC address, serial number, architecture, boot mode, and detected disks.

      Select only target hosts that are online, ready, and fully discovered. Match the MAC address and SN to the planned installation targets, then check the detected disks.

    4. Select the intended target hosts and click 下一步 (Next).

      The selected target hosts must have the same architecture and match the media. System disks are configured in the next step; formatting and installation have not started yet.

    The System Configuration page opens for the selected target hosts.

  3. Configure System Disks and OS Parameters

    Configure a system disk, hostname, root password, and partitions for the target hosts selected in the previous step.

    1. On 系统配置 (System Configuration), select the system disk mode.
      • RAID1 模式（默认） (RAID1, default): use a detected software or hardware RAID1 logical disk. This mode does not create RAID1. RAID member disks cannot be used as separate system disks.
      • 自定义模式 (Custom): select one writable local whole disk for each target host. Choose this mode when the planned system disk is not a RAID1 logical disk.

      The example uses Custom mode, with /dev/vda as each server's system disk and /dev/vdb and /dev/vdc reserved for the products deployed later. Select system disks by the names, capacities, and models recorded during preparation.

    2. Enter the settings shared by this batch.
      Parameter Purpose Instructions
      Hostname and starting index Generate names for the target hosts. Enter the planned hostname prefix and starting index. Check the generated names and override individual names in their target host rows when necessary.
      Root password and confirmation Set the root password for the installed OS. Required for initial configuration; the two entries must match. After saving, the page shows only that a password is configured, without displaying the password.
      /boot partition Store OS boot files. Default: 1024 MB. Range: 1–10240 MB.
      Swap partition Configure swap if required. Disabled by default. Enable 设置 swap (Configure Swap) and enter a size when required; the default size is 4096 MB.
      Legacy biosboot partition Support Legacy boot. Default: 1 MB. Range: 0–2 MB. A Legacy system disk larger than 2 TiB cannot use 0.
      UEFI EFI partition Support UEFI boot. Default: 600 MB. Range: 1–4096 MB. Target host boot mode is detected automatically.
    3. Verify each target host's hostname, system disk, and detected boot mode.

      In Custom mode, check disk names, capacities, and models to avoid selecting a data disk.

    4. Click 保存并下一步 (Save and Next).

      If “系统盘信息需要确认” (Confirm the system disk information) appears, compare the selected disks with the disk information on the servers or their virtualization platform, then follow the relevant case:

      • If the selected system disks and capacities match the plan, click 仍然继续 (Continue Anyway).
      • If disk information cannot be confirmed or the selection is incorrect, click 返回修改 (Go Back and Edit) and check the system disks again.
      • If a disk issue prevents saving, resolve it as prompted before saving the configuration.

      The prompt can be caused by missing disk model or capacity information, or differences between the target hosts' system disks.

    After saving, the Review Configuration page opens. OS installation has not started.

  4. Review Configuration and Start Installation

    Review the saved installation settings on the Review Configuration page.

    Warning: Clicking “开始安装” (Start Installation) formats the selected system disks and erases their data. Recheck the target hosts, system disks, and data backups before proceeding.
    1. On 确认配置 (Review Configuration), verify that the DHCP NIC and subnet match the installation network plan.
    2. Check each target host's MAC address, hostname, and system disk. If an installation IP address is displayed, check that it belongs to this installation network.

      The temporary IP address is used for PXE installation. It does not replace the management network plan for subsequent product installation.

    3. Check the boot mode and the /boot, biosboot/EFI, and swap partition summaries.

      If changes are needed, return to the corresponding page, update and save the settings, then review them again here.

    4. After confirming the targets and system disks, click 开始安装 (Start Installation). Installation starts immediately.

    The Installation page opens and shows media preparation and progress for each target host. Keep the controller, PXE service, and required networks available throughout installation.

  5. Track Installation Progress and Results
    1. On 安装部署 (Installation), check the batch progress and each target host's stage, status, and message.

      The page refreshes automatically; you can also click 刷新 (Refresh). The estimated overall progress may differ from the installer progress reported in individual messages. Use each target host's final success or failure status to determine the installation result.

    2. To view the installation process, click 详情 (Details) for the target host.

      Review the stage, events, and previous installation attempts. Once the console is ready, click the 查看安装器控制台 (View Installer Console) icon to view the installation screen. The console is read-only.

    3. Wait for installation to finish on every target host in the batch and confirm that all installations are successful.

    Once installation succeeds on every target host in the batch, end the batch and save the report.

  6. End the Batch and Save the Report
    1. Click 结束部署 (End Deployment) to open 完成 (Completion).

      Verify the batch, media, target count, successful and failed host counts, and each target host's result and system disk. If any target hosts have failed, record their errors and the planned next actions.

    2. Click 下载装机报告 (Download Installation Report) and store the report securely.
      Note: The report contains sensitive information, including target host settings, root passwords, and installation results. Store it securely and use controlled channels to share it.

      Use 部署历史 (Deployment History) to review batches, target host results, and details later.

    3. Confirm that successfully installed target hosts boot from their local system disks into the installed OS.

      If a target host still boots into PXE, select the local system disk in the device boot menu or the hosting platform's boot settings. Once the OS starts, follow the next chapter to open Manager's Discover Hosts page and identify these target hosts.

After confirming that the servers have started the installed OS and the installation report is saved, continue to Deploying Products with the Wizard to identify and select these servers in Manager.

After saving the report, click 关闭服务 (Stop Service) if PXE is no longer required. This stops the PXE page and installation service. Keep the service running if more OS installations are needed.

Deploying Products with the Wizard

The servers must have the matching operating system installed and SDDC Agent running. Manager must be running. For servers that need OS installation, first follow Installing Server Operating Systems.

SDDC Manager supports the following deployment scenarios. Choose the products and options for your deployment.

Scenario Description
Standalone virtualization deployment Deploy ZCF or ZVF without a storage product. Select only one virtualization platform.
Virtualization platform + storage Deploy ZCF or ZVF with ZStone, ZBS, or ZCE storage. Select only one virtualization platform.
Virtualization platform + container platform Deploy Zaku with ZCF. Add ZStone, ZBS, or ZCE storage as required.
Note: Zaku requires ZCF and cannot be deployed on its own.
Standalone storage deployment Deploy ZCE storage on its own.
Note: Only ZCE supports standalone deployment in this wizard. ZStone and ZBS require a virtualization platform.
Cube deployment

When deploying ZCF with ZCE, ZStone, or ZBS storage, turn on Enable Cube management UI to deliver and manage the combined products through a unified Cube UI.

This chapter walks through the deployment wizard using ZCF and ZStone with the Cube management UI enabled. Zaku settings and operations apply when Zaku is selected.

The example deploys ZStack Cloud 5.4.16 and ZStone 5.5.12 on three servers. Hostnames in the screenshots can change during Configure System. Use device SNs and MAC addresses to identify the same servers across steps.

  1. Discover Hosts
    1. Open Manager and go to Discover Hosts.
      • On Windows/macOS, click Open service on the Manager card in the local console.
      • For direct access, open http://<reachable-controller-IPv4>:10016/ in a browser.
    2. Wait for server discovery and hardware collection to finish, then check the following information.
      • Server identity: identify each server by the device SN recorded during preparation and the hostname set during OS installation.
      • Hardware information: check that CPU, memory, disk, and NIC information has been collected.
      • CPU architecture: select servers with the same architecture for a single product deployment.
      • SDDC version: review the version shown in the discovery list.
    3. Select the servers for this deployment and click Next.
      Figure 1. Select the Servers for This Deployment

      The three intended servers are selected in the discovery list, with hardware information and SDDC versions displayed.

    The Select Products page opens.

  2. Select Products
    1. Select the products to deploy.
    2. For ZStack Cube, turn on Enable Cube management UI under Delivery Options.

      This option applies to ZCF with ZCE, ZStone, or ZBS storage.

    3. Confirm that the product combination and server resources meet the displayed requirements, then click Next.

      Requirements include server count, CPU, memory, disks, and NICs.

      Figure 2. Select Products and Enable the Cube Management UI

      ZCF and ZStone are selected and the Cube management UI option is enabled. Product combination and node count checks pass.

    The Manage Packages page opens.

  3. Manage Packages
    1. Click Product Compatibility List and check that the selected product versions are compatible.
    2. Import packages for the selected products as needed.

      This example uses the following matching packages:

      • ZCF: use a ZCF package in tar format or a ZStack Cloud package in iso format. This example uses the latter.
      • ZStone: use a package in tar.gz format.
      Note:

      For other products, use matching packages in the following formats:

      • ZVF: use a ZStack ZSphere package in iso format.
      • ZBS: a package in tar.gz format. ZBS and ZStone use the same matching installation package.
      • ZCE: a package in tar.gz format.
      • Zaku: an image in qcow2 format.

      Reuse the required packages if they are already listed. Otherwise, import packages as follows:

      • Local Upload: click Upload Package, select Local Upload, and upload the package from the computer running your browser.
      • Remote URL: click Upload Package, select Remote URL, and enter an HTTP/HTTPS package URL accessible from the controller. The controller downloads and imports the package.
      • Preset directory scan: check the preset directory in the supplied deployment instructions, place packages there, then click Rescan. For the Windows/macOS portable package, check package.presetPath in config/config.yaml. Relative paths are based on the package root directory.
    3. After package verification finishes, check the following information.
      • The package status is Ready.
      • The package contains the product and version required for this deployment.
      • Its supported CPU architecture and target operating system match the selected servers.
      • The MD5 checksum matches the value supplied by the vendor.
    4. Select a package for each product, confirm the packages under Selected Products, and click Next.
      Manage Packages

    After deployment validation passes, the Assign Hosts page opens.

  4. Assign Hosts
    1. Configure management nodes and management access addresses.

      Configure the following parameters according to the deployment plan. This example uses Shared Management Nodes in single-node mode.

      Parameter Configuration instructions
      Management node assignment
      • Shared Management Nodes: ZCF/ZVF and storage share one management node group. Select the nodes once in the shared management section.
      • Separate Management Nodes: select management nodes in the virtualization and storage sections separately. The two groups must not overlap.
      Management node count
      • Single Node (1): select one management node per group.
      • Dual Node (2): select two management nodes per group.
      Management nodes
      • Shared mode: select servers in the Shared Management Nodes section. Select these servers once to manage both virtualization and storage.
      • Separate mode: select servers in each product's management node section.

      Identify servers by hostname and discovery/access IP. Product configuration uses the management IPs planned on Configure Network.
      Management VIPs, dual-node mode Enter virtual IP addresses for accessing the product management interfaces.
      • Shared mode: enter the Management VIP.
      • Separate mode: enter each product's VIP, such as ZCF VIP and ZStone VIP.

      Each VIP must be unused and on the same management subnet as its management nodes. No VIP is required in single-node mode.
      Assign Management Nodes and Review Assignments

    2. Review the management and non-management nodes in Assignment Preview.

      Assignments must match the deployment plan. In shared mode, ZCF/ZVF and storage must show the same management nodes.

    3. Click Next to save the assignments.

    The Configure Network page opens.

  5. Configure Network
    1. Configure management, storage, and any required business networks for the servers.

      This example configures the management network for each host, reuses it for storage, and leaves business networking disabled.

      Configuration area Parameter Configuration instructions
      / Configuration scope
      • All hosts: use the same configuration for all hosts.
      • By role: configure management and non-management nodes separately.
      • By product: configure each product independently.
      • By host: select a host card before entering its network parameters. Complete all hosts before proceeding.
      Management network NIC selection Click Add NIC and identify the management NIC by its name and MAC address. Use the server NIC for management networking; the controller PXE NIC is configured separately.
      IP, subnet mask, gateway For per-host configuration, enter the planned management IP, subnet mask, and gateway for the selected server. For unified configuration, enter the start and end IP addresses. Check each address against its intended server.
      Bond

      To bond NICs, select the member NICs, enable Bond, and select a mode:

      • Active-backup (mode1): switch to a backup NIC if the active NIC fails.
      • LACP (mode4): enable LACP on the switch.
      VLAN ID Enter the VLAN ID required by the network plan. Leave this blank if the server NIC does not need VLAN tagging. Do not copy a VLAN ID from an upstream virtual network or switch without checking the tagging plan.
      Storage network Configuration mode
      • Unified: share network parameters between storage public and cluster traffic.
      • Separate: configure the storage public and cluster networks separately.
      • Reuse Management Network: use the current management network configuration and addresses.
      Storage Public network Available when storage networking is configured separately. This network carries client reads and writes. Configure the NICs, IP range or host IP, subnet mask, and optional VLAN ID.
      Storage Cluster network Available when storage networking is configured separately. This network carries replication, backfill, and heartbeats between storage nodes. Configure the NICs, IP range or host IP, subnet mask, and optional VLAN ID.
      Bond

      To bond NICs, select the member NICs, enable Bond, and select a mode:

      • Active-backup (mode1): switch to a backup NIC if the active NIC fails.
      • LACP (mode4): enable LACP on the switch.
      VLAN ID Enter the VLAN ID required by the network plan. Leave this blank if the server NIC does not need VLAN tagging. Do not copy a VLAN ID from an upstream virtual network or switch without checking the tagging plan.
      Business network Enable business networking Enable this to generate ZCF/ZVF business networking through the wizard. This example leaves this option disabled.
      NIC selection
      • When business networking is enabled, select one NIC or two NICs with the same speed. You can reuse NICs assigned to management or storage networks.
      • When reusing NICs already configured in a Bond, the existing Bond is retained and the Bond selector is not displayed.
      • When selecting unused, separate NICs, the Bond selector is displayed for optional configuration.
      IP range, subnet mask, gateway When business networking is enabled, enter these parameters to generate the recommended ZCF/ZVF network configuration. Enter the start and end addresses, subnet mask, and gateway according to the business network plan. This IP range belongs to virtualization business networking, not server management.
      VLAN ID When business networking is enabled, enter the VLAN ID required by the business network plan. Leave this blank if VLAN tagging is not required.
      Configure Host Networks

    2. Review each server's network settings and click Next.

    After the IP conflict check passes, the network settings are saved and the Configure System page opens.

  6. Configure System
    1. Configure hostnames, connection credentials, and system services.
      Parameter Configuration instructions
      Hostname Enter the hostname prefix and suffix in batch configuration, review the generated names, and click Apply. In the host list, check each hostname against the device SN and planned management IP. Hostnames must not exceed 16 characters, including hyphens.
      Root password Enter the servers' current root password. For servers installed through the preceding PXE procedure, use the password set during OS installation. This password is used for subsequent SSH connectivity checks; the root password remains unchanged.
      SSH port Enter the servers' current SSH port. The default is 22. All servers in the batch must use the same port. The servers' SSH port remains unchanged.
      NTP time sources Enter the addresses of NTP time sources that the servers can reach. Only IPv4 addresses are supported; domain names are not supported. Separate multiple addresses with commas.
      DNS servers Enter DNS server addresses that the servers can reach for name resolution. Separate multiple addresses with commas.
      Firewall Set the firewall according to the site security policy. When enabled, the system automatically opens ports required by the products.
      Extra Open Ports To open additional ports, click Add port, enter ports or port ranges, and select TCP or UDP. Separate multiple ports or ranges with commas, for example, 8092,8093-8095.
      Passwordless login Deploying storage products requires SSH keyless login to be enabled. We recommend keeping the default enabled setting.
      Batch System Configuration

      Review the Host List

    2. Review each server's system settings, save, and continue.
      To locate a server on site, use Locator LED in the host list and select Turn on, Blink, or Turn off locator.

    The Configure Products page opens.

  7. Configure Products
    1. Choose a configuration method.
      Parameter Configuration instructions
      Recommended Configuration Click Recommended Configuration at the upper right to generate settings from the saved server, network, and product configuration and open Review Configuration. This example uses this method.
      Manual configuration Enter settings for the selected products according to the deployment plan.
      Note: Recommended Configuration replaces existing settings for the selected products. If prompted, confirm that existing settings do not need to be retained before clicking Generate and replace.
    2. Review or enter settings for the selected products.
      • Recommended Configuration: After generation, the Review Configuration page opens. ZCF administrator and database passwords must be entered manually. In this example, click Previous to return to Configure Products, enter and confirm both passwords, review the table below, and save. For other products, complete any required fields that were not generated.
      • Manual configuration: Enter and save the settings on Configure Products using the table below.

      The parameter descriptions below use ZCF + ZStone as an example. Follow the fields and requirements shown for the selected products, and enter values according to your deployment plan.

      Configuration area Parameter Configuration instructions
      ZStone storage configuration Host Config Management, Monitor, Data, Gateway: In Storage Config (ZStone) > Host Config, select servers and assign roles. At least three nodes must each have all four roles: Management, Monitor, Data, and Gateway. These are internal ZStone service roles, separate from the product management nodes selected on Assign Hosts.
      Data Disk Config Disk type:
      • Hybrid disks: use SATA SSD or NVMe cache disks to accelerate HDD data disks.
      • Raw disks: use HDD, SSD, or NVMe disks directly as data disks.

      You can configure both types, using separate disks for each type. This example uses raw disks because the three servers have HDD data disks without separate cache disks.
      • Cache disks: For hybrid disks, select the cache disks first.
      • Allocation mode: After selecting cache disks, choose how they map to data disks:
        • Automatic allocation: let the tool assign the mappings.
        • Manual allocation: specify the mappings manually.
      • Data disks: For hybrid disks, assign them using the selected allocation mode. For raw disks, select the data disks directly.

      This example selects vdb and vdc on each server and preserves the vda system disk.
      Storage Pool Config

      Click Add Storage Pool and configure:

      • Name: Enter a pool name. This example uses the recommended pool-hdd pool.
      • Replicas: Select according to the storage plan. This example uses three replicas.
      • Failure Domain: Select according to the storage plan. This example uses Server.
      OSD Assignment: Select the data disks configured in the preceding step. Create at least one pool. Each disk can belong to only one pool. This example assigns all six raw data disks to the same pool.
      ZCF virtualization configuration Host Config Compute Node: Review the management nodes selected on Assign Hosts and select the servers that provide compute resources. A server can serve as both a management node and a compute node. In this example, all three servers are compute nodes and one is also a management node.
      Common Config
      • Administrator password: Set and confirm the password used to log in to the product UI after deployment.
      • Database password: Set and confirm the password used by product database users.
      • Cluster scale: Select according to delivery requirements.

      Enter both passwords manually and follow the rules shown on the page. Recommended Configuration leaves these fields for you to complete.
      Create Zone
      • Name: Enter the zone name. This example keeps the recommended ZONE-1.
      • Description: Enter a description if needed.
      Create Cluster

      Check the parent zone, then configure:

      • Name: Enter a cluster name. This example uses Cluster-1.
      • Hypervisor Type: Select according to the deployment plan. This example uses KVM.
      • CPU Architecture: Match the selected servers. This example uses x86_64.
      Add Backup Storage
      • Type: This example uses ZStone; select Ceph.
      • Mon Nodes: Select the ZStone servers assigned the Monitor role. Use their management IPs from Configure Network and their SSH ports and root credentials from Configure System.
      • Backup Storage Pool: Enter the pool created earlier.

      Recommended Configuration generates these settings from the saved nodes, credentials, and pool information. Review each value.
      Add Primary Storage
      • Type: This example selects Ceph.
      • Mon Nodes: Review each node's management IP and SSH connection settings.
      • Image Cache Pool: Check the pool. This example uses pool-hdd.
      • Data Volume Pool: Check the pool. This example uses pool-hdd.
      • Root Volume Pool: Check the pool. This example uses pool-hdd.
      • Storage Gateway CIDR: Enter the CIDR for the storage network.
      • Optional settings: Configure Cephx, the cold migration network, and the enterprise access token as needed.
      Create Instance Offering
      • Name: Enter the instance offering name.
      • CPU Cores: Set the CPU count for VM instances.
      • Memory: Set the memory capacity for VM instances.
      • Host Allocation Strategy: Select according to the deployment plan.
      • Optional settings: Configure disk bandwidth, IOPS, network bandwidth limits, and advanced settings as needed.

      This example keeps the recommended 1-core, 1-GB offering.
      Add Image
      • Image Format: Select the actual image format.
      • CPU Architecture: Select the image CPU architecture.
      • Platform: Select the image platform.
      • Operating System: Select the image's operating system.
      • Image URL: Enter the image file URL.
      • BIOS Mode: Select a boot mode supported by the image.

      Also review Virtio and backup storage. This example uses the recommended bundled qcow2 image. Its URL points to a file on the product installation media, not the OS image path on the controller.
      Create L2 Network, Create L3 Network Enable and configure these according to the business network plan. This example leaves business networking disabled on Configure Network, so Recommended Configuration disables both options and no L2 or L3 network is created during installation. For Zaku deployment, prepare the business network it requires.
      Zaku configuration (if selected) Cluster name and deployment mode
      • Cluster name: Enter the management cluster name.
      • Deployment mode: Select single-node or HA mode. HA mode uses three management virtual machines.
      Management VM specifications

      Configure the following resources for each management node and check that the virtualization platform has sufficient resources:

      • CPU: Configure according to the deployment plan.
      • Memory: Configure according to the deployment plan.
      • System disk: Configure according to the deployment plan.
      • Data disk: Configure according to the deployment plan.
      Addresses Assign addresses from the allocatable pool of the business IPv4 L3 network and ensure that IPAM is enabled. Single-node mode requires at least two addresses; HA mode requires at least five for management nodes, the cluster VIP, and console access.
      Cloud Admin Password This password is inherited from the virtualization platform configuration. Return to that configuration to change it.
      Cloud address and NTP
      • Cloud address: Enter or review the address of the current virtualization platform.
      • NTP: Review the time source configured earlier.
      Configure a Storage Pool

    Product settings are saved and the Review Configuration page opens.

  8. Preview
    1. Review the following deployment settings.
      • Product combination, versions, packages, and the Cube management UI option.
      • Management mode and VIPs, node roles, system disks, and data disks.
      • Storage pools and virtualization storage bindings, management networks, and business IP pools.
      • SSH credential configuration status, ports, NTP, and DNS.
      • For Zaku, the management cluster mode, per-node resources, addresses, and storage dependencies.
      Review Host Addresses

      Review Products and Management Nodes

    2. If adjustments are needed, return to the corresponding step, edit, and save.

      If nodes, networks, or packages change, review the affected product settings again.

    3. After confirming the settings, continue.

    The Pre-flight Check page opens.

  9. Precheck
    1. Run the prechecks and wait for the results.

      Checks include Agent communication, package integrity and compatibility, product settings, available space, hardware compatibility, and SSH connections. The checks vary by product and version.

      Figure 9. Pre-installation check results


    2. Confirm that all checks pass, then continue.

    All prechecks have passed and product deployment can proceed.

  10. Install
    1. Submit the deployment task.
      Warning: Submitting the deployment task changes the selected servers and installs products using the saved settings. Recheck the target servers, disk roles, and data backups before submission.
    2. View deployment progress, logs, and status for each product and server.

      The tool follows the product dependencies to configure servers, install storage and virtualization, initialize Cloud, and deploy any additional selected products.

      • For Cube, check the Configure Cube management UI stage and its verification result.
      • For Zaku, check prerequisites, image processing, management virtual machine creation, and cluster readiness.
    3. Wait for all selected products to deploy successfully.

    All selected products are deployed successfully and the Finish page opens.

  11. Finish
    1. Review the deployment results for each product and server.
    2. Open each product console, verify access, and check the following items.
      • Virtualization and storage: check management interfaces, storage connections, and the configured key resources. If no business network was created, configure the required networks before using VM instances.
      • ZStack Cube: verify the Cube management UI, storage information, and storage management access. For multiple management nodes, also check the expected access point and node status.
      • Zaku: check the management virtual machine count, cluster readiness, console access, actual addresses, and storage configuration.
    3. Download the deployment report and store it securely.

      After the current deployment is complete and the report is saved, you can click Reset on the Manager page if you need to deploy another environment. Reset archives the current batch, clears the wizard configuration, and discovers hosts again. It retains installation packages and does not affect the environment already deployed.

      Note: During deployment, Reset clears the current wizard configuration and affects the current task. Use it only if you decide to abandon the current deployment and configure it again.

      If the Finish page provides a shutdown countdown or service stop control, save the report and complete verification first. Stopping the deployment service does not stop the installed products.

    Product verification is complete and the deployment report is saved.

After installation, use each product's management interface for day-to-day management of cloud resources, storage, and containers.

Frequently Asked Questions

Cannot Access Deployment Pages or Confirm Service Status

  1. Check the URL and use an IPv4 address through which the controller is reachable. Manager uses port 10016 and PXE uses port 10018. Confirm that the device running the browser can access the address and port.

  2. Check whether the corresponding service is running:

    • Windows/macOS controllers: check the Manager or PXE service card in the local console. If the service status cannot be confirmed, click Authorization check, grant the required operating system permissions, and click Rescan.
    • Linux controllers: use the status commands in Linux (Target Server as the Controller).
  3. If the service is not running, start it as described in Configuring the Controller, then try opening the page again.

Servers Are Not Discovered

Target servers do not appear in PXE

  1. Confirm that ready installation media has been selected and confirmed for the current batch and supports the servers' CPU architecture and boot mode.
  2. Confirm that the servers boot from NICs connected to the controller's PXE network, both ends are on the same Layer 2 network, and there is no conflicting DHCP service on the installation network.
  3. Wait for discovery to finish, then identify the servers using the MAC addresses and device SNs recorded during preparation.

Servers with installed operating systems do not appear in Manager

  1. Check each server console to confirm that it has booted from its local system disk into the matching operating system.
  2. Confirm that the operating system and SDDC Agent have started and that the network between the controller and servers meets the requirements in Prepare the Network.
  3. On Discover Hosts, click Rescan and identify the servers by device SN. If hardware information collection still reports errors, save the messages and do not select servers whose information has not been confirmed.

Installation Media or Package Validation Fails

  1. Confirm that the file is supplied for this release. Check its filename, version, and MD5 checksum against the values provided by official technical support.

  2. Check the following requirements for the intended use of the file:

    • Server operating system image: supports the servers' CPU architecture and boot mode.
    • Product installation package: its product, version, file format, CPU architecture, and target operating system match the deployment. For format requirements, see Manage Packages.
  3. Wait for import and verification to finish and check the result. Select PXE media when its status is “已就绪” (Ready) and product packages when their status is Ready, then continue. If verification still fails, record the file information and complete error message.

Collect Error Details for Technical Support

If deployment still cannot proceed after these checks, save the following information and contact official technical support:

  • The SDDC Manager and selected product versions, current step, device SNs of affected servers, and complete error messages.
  • Package import issues: check task status in the Upload Package window or package list, and record the filename and failure reason.
  • PXE installation issues: on 安装部署 (Installation), click the affected server's 详情 (Details) and save its stage, status, and error details.
  • Product deployment issues: on Install, record the failed product, server, and stage, and save the related logs.

After OS installation or product deployment completes, save the corresponding report as described in End the Batch and Save the Report or Finish in the product wizard.

Reports may contain sensitive information such as server settings and passwords. Store them securely and redact sensitive information before sharing them.

Appendix

Terminology

Term Description
Controller The device that runs SDDC deployment services. It can be a separate device or one of the target servers.
Server (host) A server on which the selected products are installed and run. The interface refers to it as a host.
SDDC Manager The deployment tool used to configure and install target products.
Local console The web interface in the Windows/macOS portable package for viewing and configuring the controller network and starting or stopping Manager and PXE services.
Manager service The service that provides the product deployment wizard.
PXE Preboot Execution Environment, used to boot servers over the network and install operating systems.
SDDC Agent The agent installed on servers for host discovery, hardware information collection, and deployment operations.
ISO image A disc image file format used by the ZStack Cloud product installation package in this guide.
RPM package A Linux software package format used to install SDDC Manager with the rpm command.
MD5 A message-digest algorithm used in this guide to compare a file checksum with the value supplied by the provider.
MAC address A network interface address used in this guide to identify the controller NIC and each target server’s PXE NIC.
Device SN The device serial number, used to identify a target server.
DHCP Dynamic Host Configuration Protocol, used in the PXE workflow to assign IP addresses and other network settings to target servers.
DHCP address pool The range of IP addresses the PXE service can assign to target servers.
IPv4 / IPv6 Two versions of the Internet Protocol. This guide uses IPv4 addresses to access service pages and requires IPv6 for server discovery and Agent communication.
CIDR A notation that uses an IP address, a slash, and a prefix length to specify an address and its network range, such as 192.168.10.0/24.
Gateway A device that forwards traffic between the local network and other networks, usually specified by its IP address on the local network.
DNS Domain Name System, used to resolve domain names to IP addresses and other information.
mDNS Multicast DNS, used for automatic server discovery on the network.
Zaku management VM A VM created in the virtualization platform to run the Zaku management cluster.
Management VIP A virtual IP address used to access a product management interface.
Recommended Configuration Deployment settings generated from the selected products, server hardware, and network information.
Deployment report A file that records the progress and results of OS installation or product deployment.
Mon node A Ceph monitor node. In this example, it is a ZStone server assigned the Monitor role.