Change Sever Public IP Address using Deployment Tool

This topic describes how to change the public IP address of the YCM Server, SBC Server, or SBC Proxy Server using the Yeastar-provided Deployment Tool.

Important: Changing the public IP address will interrupt active calls and may temporarily affect services. Perform this operation during a maintenance window or off-peak hours to minimize impact on users.

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
  • Ensure that the SSH port 1022 is open on the YCM Server, SBC Server, SBC Proxy Server, and PBXHub Server.
  • Collect the following server information:
    • Domain names, public IP addresses, and private IP addresses of the YCM Server, SBC Server, and SBC Proxy Server
    • The private IP address for the PBXHub Server
  • For servers whose public IP address needs to be changed, complete the following configurations:
    • Update the DNS A record of the domain name to point to the new IP address, and ensure that the DNS change has taken effect.
    • Ensure that the firewall rules for the new public IP address are consistent with those of the old environment (e.g., the same ports and protocols are open).
SSH Account On each 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.
Resource Contact Yeastar to obtain the Deployment Toolkit.

Procedure

  1. On your computer, install and launch the Deployment Toolkit.
  2. Log in with the default credentials.

    • Username: admin
    • Password: admin123
  3. On the Server Connection Information page, enter the required information:
    1. Enter the domain name, public IP, private IP, and SSH credentials for each server.
      Note:
      • For wildcard domains, use 11 to replace the wildcard *. For example, if the domain is *.sbc.example.com, enter 11.sbc.example.com.
      • When entering an IP address or domain name, make sure there are no extra spaces at the end, otherwise connection failures may occur.

      • For servers with a new public IP, enter the current public IP in the old IP field and the new public IP in the new IP field.
      • For servers with an unchanged public IP, enter the current public IP in both the old and new IP fields.
    2. Optional: At the bottom-right of the page, click Test All Connections to verify that the connection information is correct.

      A dialog box will appear at the top of the page, displaying the server connection results.

    3. Click Next Step.
  4. On the execution pages, complete the following steps in order.
    Note:
    • Wait for each step to complete successfully and display a success prompt before proceeding to the next step.
    • You can click Details in each section to view the corresponding execution results.
    1. On the Step 1: Backup Configuration Files and Database page, click Execute All at the top-right corner to back up the server configuration files and database.

    2. Go to the Step 2: Configuration Check page to verify domain resolution and time synchronization.

      1. Click Check All Domains to view the domain resolution results.

        This step verifies whether the domain name of each server can be correctly resolved to the intended public IP address.

      2. Click Check Time Sync to ensure the time synchronization among the servers.
    3. Go to the Step 3: Stop Services and Whatchdog page, click Execute All at the top-right corner to stop the current services for the IP change.

    4. Go to the Step 4: Update Configuration Files and Database page, update the configurations and switch the IP address.
      1. Click Execute All at the top-right corner to update the server configuration files and database.

        The system will detect whether there are any updates to the configuration files.
        Tip: You can click View Configuration Files to view the configuration file of a specific server.

      2. Click Confirm Switch.

        The system will apply the new IP configuration, and use the new public IP address in subsequent operations.

    5. Go to the Step 5: Restart Services page, click Execute All at the top-right corner to restart the previously stopped services.

    6. Go to the Step 6: Restore Watchdog page, click Execute All at the top-right corner to restore the previously paused background processes, ensuring all system components are running normally.

    7. Go to the Step 7: Service Validation page, click Start Validation to check the server status.

      The tool will check the process and port status of each server to confirm that services are running properly. If successful, an "All Verifications Passed" message will appear at the bottom of the tool.

Result

The IP change is successful. You can verify the updated server IP addresses on the Yeastar Central Management web portal:
  • Cluster Server (Path: Cluster > Cluster Management)

  • YCM Server (Path: System > Domains > Yeastar Central Management Domain Name)