Deploying a Zoom Node management server

With a Zoom Node server, deploying and managing hybrid services can all be done from within the Zoom web portal. Unlike previous on-prem solutions, Zoom Node allows admins to deploy a server to handle multiple services.

Requirements for deploying a Zoom Node server

Note: When utilizing KVM Hypervisor, Zoom recommends using UEFI boot for the OS. 

Table of Contents

How to prepare for Zoom Node and module deployment

Before deploying a Zoom Node management server and modules, ensure that the virtual machine can be deployed with based on the system requirements for the desired modules below:

How to download the Zoom Node virtual machine image

  1. Sign in to the Zoom web portal.
  2. In the navigation menu, click Node Management then click Modules.
  3. Click the drop-down button , and click the desired module type.
  4. Click the Nodes tab.
  5. Click Add Nodes.
  6. Next to the desired image, click Download.
    Note: If deploying via VMware then utilize the OVA image. If deploying via KVM then utilize the qcow2 image.
  7. (Optional) Set the time for the Code Expiration in minutes.
  8. Click Generate Code.
  9. Click Copy, to copy the registration code, and save it for use later.
  10. Deploy the image within your environment.

How to deploy a Zoom Node virtual machine image

WMWare vSphere

Deplyoing via VMWare

  1. Download the Node OVA image for the VMWare Environment.
  2. Launch vCenter/ESXi.
  3. Click Create/Register VM.
  4. Select Deploy a virtual machine from an OVF or OVA file. 
  5. Click Next. 
  6. Enter the name for the Zoom Node virtual machine (VM). 
  7. Browse and select the OVA file, or drag and drop the OVA into the upload area.
  8. Click Next.
  9. Select the desired storage volume for the Zoom Node VM. 
  10. Click Next.
  11. Select the Network mappings for the Zoom Node server. 
  12. For the Disk Provisioning, select either Thin or Thick.
  13. Click Next. 
  14. Verify the settings for the VM, then click Finish. 
  15. Once the deployment is complete, boot the VM. 
  16. Begin configuration of the Node VM.
KVM: Proxmox VE

Deploying via Proxmox Virtualization Enviroment (VE)

Prepare the virtual environment

  1. Log in to the Proxmox management application. 
  2. Click Create VM.
  3. On the General page, enter the Name of the virtual machine (VM).
  4. Note the VM ID, as this will be used later in the installation process. 
  5. Click Next.
  6. On the OS page, select Do not use any media. 
  7. Click Next. 
  8. On the Systems page, configure the following:
    • Machine: Select q35.
    • BIOS: Select OVMF (UEFI).
    • EFI Storage: Select the storage volume you want the EFI settings stored on.
      Note: Typically, this is the same as the storage volume where the VM is stored itself.
  9. Click Next.
  10. On the Disks page, configure the following:
    • Storage: Select the volume from which the VM will run. 
    • Disk size (GiB): Set the value to 180.
    • Cache: Select Write-Through.
  11. Click Next.
  12. On the CPU page, set the value for Cores to 8.
  13. Click Next.
  14. On the Memory page, set the value for Memory (MiB) to 16384.
  15. Click Next. 
  16. On the Network page, configure the settings for the network device.
    Note: This is typically a bridge interface with a VLAN tag, depending on your network setup. 
  17. Click Next.
  18. On the Confirm page, verify Start after created is not enabled.
  19. Verify the settings for VM, then click Finish.

 

Prepare the Zoom Node image

  1. Download the Node image for the KVM Environment.
  2. Copy the file to the Proxmox directory with the same name as the VM ID noted earlier in the instructions. 
    Note: The file can also be copied to the Proxmox server volume, where your VMs are stored.
  3. Within the folder, there will be an empty disk image (ex.vm-111-disk-0.qcow2).
  4. Note the name of the disk image, as this will be used later in the installation process.
  5. Delete the file. 
  6. Copy the downloaded Node image.
  7. Rename the image to the name of the original image in the folder (ex.vm-111-disk-0.qcow2).
  8. Log in to the Proxmox management application.
  9. (Optional) To create a template for future use, right-click on the VM deployed earlier, then click Clone.
  10. Start the VM to begin configuration of the Node VM.
KVM: Virtual Machine Manager

Deplyoing via Virtual Machine Manager (virt-manager) 

  1. Download the Node image for the KVM Environment.
  2. Rename the file to the same name as your desired VM/disk (ex. ZN-SJC01-NODE01.qcow2).
  3. Move the file to a storage volume that Virtmanager can access. 
  4. Launch the Virtual Machine Manager.
  5. Click the New Virtual Machine button.
  6. Enter the name of the virtual machine (VM). 
  7. Under Choose how you would like to install the operating system, select Import existing disk image. 
  8. Click Forward.
  9. Select the storage volume where the renamed qcow2 image is, and click Choose Volume.
    Note: If you need to add a directory to Virtual Machine Manager, click Browse Local, and add the volume. 
  10. Under Choose the operating system you are installing, select Ubuntu 22.04 LTS.
  11. Click Forward.
  12. Next to Memory (RAM), enter 16384.
  13. Next to CPUs, enter 8.
  14. Click Forward. 
  15. Enter the desired Name for the Node VM. 
  16. Enable Customize configuration before install. 
  17. Under Network selection, ensure the Bridged device is an Ethernet device and not a NAT. 
  18. Click Finish. 
  19. On the VM details page, verify Chipset is set to Q35 and Firmware is set to UEFI.
  20. Click Apply. 
  21. Click Begin Installation.
  22. Once the VM has booted up, begin configuration of the Node VM.

How to configure the Zoom Node virtual machine 

Creating a password for the setup user

Note: While the account used for configuration named zoom-setup, is not required for the initial configuration, it is necessary for logging in during future use of the TUI (Text user interface) console.

  1. Start up the Zoom Node VM in vCenter.
  2. In the Zoom Node VM, create a new password for the zoom-setup user, and save the password for future use in the TUI console.

    Note: Currently exclamation marks (!) and hyphens (-) are not supported for the password.
  3. Once the password has been set, you will be prompted to modify the hostname for the server.
  4. Type Yes and press the Enter key.
  5. Enter the desired hostname and domain and press the Enter key.
  6. Press the ESC key to continue the configuration.

Configuring the network interfaces

  1. In the network interface menu, press 1 to add a new IP address.
    The following menu will be displayed.
    Note: If using DHCP for the subnet that the Node management server is deployed on, Zoom Node will automatically acquire an address. This address will be listed directly below the network interface name, as well as the Gateway and DNS addresses.
  2. Press 1 to add a Primary IP address.
  3. Press the Enter key (or manually type the name of the network interface), to choose the network interface for configuration.
  4. Enter the IP address and subnet mask using CDIR notation without spacing (ex. 192.168.1.100/24).
    Note: For more information on using CIDR notation, please refer to this table.
  5. Press Enter to accept the new address.
  6. When prompted for confirmation, type Yes and press Enter.
  7. The new IP addresses will be listed with the rest of the network information.
  8. (Optional) Press 3 to update the DNS and gateway information.
    Note: This step is only optional if utilizing DHCP for the subnet the server is deployed on.
  9. Enter the Gateway address and press Enter.
  10. For DNS1, enter the primary DNS address and press Enter.
  11. For DNS2, enter the secondary DNS address and press Enter.
  12. (Optional) For DNS3, enter a third DNS address and press Enter.
    Note: If you don't have an additional DNS IP address, press Enter to skip adding additional
  13. To activate the network interface, type Yes and press Enter.

Removing addresses set via DHCP

While this is not necessary for configuration, it is recommended to remove any addresses that were automatically assigned if DHCP was utilized and utilize static addresses only.

  1. Under the network interface configuration menu, press 2.
  2. Press the Enter key to modify the suggested interface, or type the name of the desired network interface and press Enter to modify it.
  3. Type the IP address (in CDIR format), and press Enter.
  4. Type YES to confirm you want to remove the address.

How to verify Node network connectivity

Once the network interfaces have been configured for the Zoom Node instance, network connectivity for the Node server should be tested to ensure proper function.

  1. In your browser, navigate to the Zoom node web console at https://[IPaddress]:8443, with the IP address being the address configured in the previous steps.
    Note: If you receive a security warning, accept the warning and continue to the site.
  2. Log in with the password created during the initial setup.
  3. In the Node Web Console, click Diagnostics.
  4. On the Connectivity tab, verify all connections are listed as Connected.

How to register a Zoom Node server

Once connectivity to the Zoom Cloud has been established and verified, the Zoom Node server is ready to be registered within the Zoom web portal.

  1. In the navigation panel click Node Agent.
  2. Enter the registration code saved in the previous steps, and click Register.

    Note: If the configuration of the Zoom Node server takes longer than the expiration time, then click Generate Code to create a new registration code.
    Once the agents have installed and registered, there will be a message that the installation was successful.
  3. Return to the Zoom web portal, and under the Nodes tab, click Unconfirmed Nodes.
  4. The newly added server will be listed under Unconfirmed Nodes.
  5. Click Confirm, to authorize and complete the server registration.
  6. In the next window enter the following information:
  7. Click Confirm.
  8. Click the Confirmed Nodes tab to view the registered server.
  9. Click the name of the server to view the server’s properties.
    After 1-2 minutes, refresh the page to verify both the node and monitor agent are running.
    The Zoom Node server is now ready to deploy services and modules.

How to disable Zoom Node

If your organization decides to disable Zoom Node, any related settings for the Meeting Connector, the Zoom Hybrid Meeting Service, or Zoom Phone Local Survivability will need to be disabled at the account level, as well as any groups or users it was enabled for. Once the service(s) has been disabled, the VMs can be decommissioned, and removed from the Zoom Web Portal.

To remove the VMs from the Zoom Web Portal:

  1. Sign in to the Zoom web portal.
  2. In the navigation menu, click Node Management then click Modules.
  3. Click the drop-down button , and click the desired module type.
  4. Click Nodes, then click Confirmed Nodes.
  5. Next to the desired Node, click Delete.
  6. Verify the correct Node has been selected.
  7. (Optional) Enable Delete node immediately, if you want the Node VM to be dissociated from your account.
    Note: If this option is not enabled, then the Node will be deleted once the VM has gone into an idle state.
  8. Click Delete.
    The Node server and associated modules will now be dissociated from your account.