Expand a PBXHub Server using Deployment Tool

This topic describes how to expand a PBXHub Server in your system architecture using the Yeastar-provided Deployment Tool.

Requirements

  • Your computer runs the Windows operating system, as the tools are .exe applications.
  • Your system has a Basic deployment architecture (i.e., no High Availability (HA) configured).
  • The firmware version of the YCM server is 87.19.0.27 or later to ensure the operations can be performed successfully using the tools.

Prerequisites

Item Prerequisites
Server
  • Prepare the required deployment environment for the new PBXHub Server.
  • Ensure that the SSH port 1022 is open on both the YCM Server and the new PBXHub Server.
  • Collect the following server information:
    • Public IP address of the YCM Server
    • Private IP address of the SBC Server and PBXHub Server
SSH Account On both the YCM Server and the new PBXHub Server, create an SSH account yeastar that meet the following requirements:
  • Set an SSH login password.
  • Grant passwordless sudo privileges (NOPASSWD) so it can execute commands requiring root privileges without entering a password.
Resources Contact Yeastar to obtain the following resources:
  • The Deployment Tool
  • The download URL of the PBXHub Server image

Procedure

  1. On your computer, install and launch the Yeastar Deployment Tool.
  2. Log in with the default credential.

    • Username: admin
    • Password: admin123
  3. Go to the Hub Expansion tab.
  4. On the SSH Config page, enter the SSH connection information for the servers.

    1. Enter the server information you have collected.
    2. Optional: Click the test button to verify that the tool can connect to the corresponding server using the provided information.

      The connection result is displayed on the interface.

    3. Click Next Step.
  5. On the YCM Config page, obtain the required deployment information from the YCM database.

    1. Click Get Auth Code and Region Key.

      The YCM system generates an Authentication Code and a Region Key, which are used to activate the PBXHub Server and validate its configuration file before installation.

    2. Click Next Step.
  6. On the Create Config page, create the configuration file for the PBXHub Server.

    1. Click Create Config File on YCM.

      If successful, a "Config file created successfully" message appears on the interface, indicating that the YCM system has generated a configuration file for the PBXHub Server.

    2. Click Next Step.
  7. On the Hub Install page, follow the on-screen instructions to complete the PBXHub server installation.
    1. Fill in the relevant information for the PBXHub server:

      • Installation Package URL: Paste the download URL for the PBXHub Server image.
      • Data Disk1 & Data Disk 2: Specify the mount paths for the data disks.
    2. Click the Execution button in each section to proceed the server installation.
      Note: Wait for the current step to complete and show a "Success" message before proceeding to the next step.

    3. Optional: In the Execute Install section, click Check Status then to view the installation process after the execute button displays as Re-execute.

      The installation takes 5 – 10 minutes. Upon completion, an "Installation completed successfully" message will appear at the top of the page.
    4. Click Next Step.
  8. On the Reboot page, reboot the server and verify the installation.

    1. Click Reboot Hub Server.

      Wait for 2-3 minutes for the reboot to complete.

    2. Click Start Verification to verify the installation.

      When successful, a confirmation message "Verification Passed" appears, and you can check the record of the PBXHub Server in YCM Database Verification section.

Result

The expanded PBXHub Server is now ready for use.

You can check the PBXHub Server on the Yeastar Central Management web portal (Path: Cluster > Cluster Management).