Deploy the ZPLS Module

This page provides step-by-step instructions to deploy a ZPLS module within your account. After completing this section, you can expect to have a fully configured and operational ZPLS module within your account.

The ZPLS module must be configured when the Zoom Cloud is available and services are operational.

Download the OVA

The Zoom Node Open Virtual Appliance (OVA) must be installed on the virtual machine before installing the ZPLS module. To download and install the OVA, perform the following steps:

1. Navigate to the Zoom Web Portal at zoom.us, and sign in using your desk’s Zoom administrator credentials.

2. In the left-hand menu, locate the Node Management sub-menu. Extend it, and click Modules.

   

If the Zoom Node option is not available, the user’s role may not have the required privileges. Refer to the section on granting access to user roles for more information.

1. In the top-left corner of the screen, confirm Zoom Node - Phone Local Survivability is selected in the pulldown menu.

   
2. In the top right-hand corner of the screen, click the Nodes tab.

   
3. On the same screen, click Add Nodes in the top-right corner.

   
4. Download the Zoom Node OVA image for your environment.

   
5. Install the image on a virtual machine.

We will return to this screen in a future step to generate a registration code. It is advised to leave this screen open for future use, if possible.

Install the Zoom Node OVA

After the OVA file download is complete, deploy the Virtual Machine using the following steps:

1. Navigate to your ESXi host address.

2. Select Host and then Virtual Machines.

3. Right click on Virtual Machines and select Create/Register VM.

4. Select the option Deploy a virtual machine from OVF or OVA file.

5. Enter a name for the virtual machine and browse the local computer for the downloaded .ova file from the previous section.

6. Select the default network mappings unless the deployment environment has other requirements and click Next.

For production deployments only ‘Thick’ provisioning is supported. There are no hard requirements for IOPS at this stage.

1. Review the information and click Finish. Once the deployment is completed successfully, power on the virtual machine and open the console.

Install the Zoom Node Operating System

After installing the OVA, perform the following steps to install the Zoom Node Operating System:

1. Navigate to the console of the virtual machine that was deployed in the previous step.

2. After the virtual machine has booted, a screen will appear to set up the default password. The default admin username and password is zoom-setup.

3. When prompted, enter a new password for the zoom-setup user and press the enter key. Make note of this password, as we will need it soon.

   
4. On the following screen, configure the hostname of the virtual machine.

   
5. If DHCP is not available, there will be a prompt to set an IP address, Default Gateway and DNS server. Configure these settings as required for your environment.

Secure shell (SSH) access is not enabled on the Zoom Node OS. Direct access is only available through the virtual console.

Install the ZPLS Module

Once the IP addresses, hostname, and default password are set, the server must be associated and registered with your Zoom account to install the ZPLS module.

Associate the Zoom Node Appliance with your Account

To associate the Zoom Node appliance with your account perform the following steps:

1. Within the Zoom Node virtual machine menu, look for the blue URL that we will use to finish deployment and registration of the machine.

   
2. On another machine connected to the same network as the Node VM, navigate to the private IP address, being mindful of the https:// prefix and port :8443 suffix.

The IP address for your machine is likely to be different from the one pictured above.

1. You may receive a certificate warning when navigating to the page. If so, click Advanced and proceed to the address.

2. On the following screen, you will be prompted to enter the password for the Node that was previously configured in Step 3 of the Install the Zoom Node Operating System section.

   
3. Once authenticated, in the left-hand menu, click Node Agent.

   
4. Next, we must generate a registration code. To do this, we must repeat some familiar steps.

As mentioned at the end of the Download the OVA section, if you kept a tab open on the screen where we downloaded the OVA, you can fast track the following steps to generate a registration code. If not, the steps are detailed below.

1. Outside the virtual machine, navigate to the Zoom Web Portal at zoom.us, and sign in using your desk’s Zoom administrator credentials.

2. In the left-hand menu, locate the Node Management sub-menu. Extend it, and click Modules.

3. In the top-left corner of the screen, confirm Zoom Node - Phone Local Survivability is selected in the pulldown menu.

   
4. In the top right-hand corner of the screen, click the Nodes tab.

   
5. On the same screen, click Add Nodes in the top-right corner.

   
6. On the following screen, click Generate Code, and copy the result.

   

   
7. Navigate back to the virtual machine’s console, paste or enter the registration code, and click Register.

   

Performing this action will automatically download and install required components.

1. After, the machine will immediately begin downloading Zoom Node Agent services.

   
2. After a few minutes, **navigate back to the web portal outside the virtual machine,**and click the backbutton from where you generated the registration code.

   
3. Select the Unconfirmed Nodes tab.

   
4. Confirm the displayed hostname matches the previously configured name. If so, press Confirm, and define the Node’s location within the pop-up box.

   

   
5. After selecting Confirm, the Node should appear in the Confirmed Nodes tab.

Verify Agent Services are Running

After associating the ZPLS module with your account, it is essential to confirm that necessary Zoom Node Agents are operating within the recently confirmed Node. To confirm Agent services are running, perform the following steps:

1. From the web portal, select the Agents tab.

2. Select the hostname of the Node and confirm the Monitor Agent and Node Agent are present and running.

These services are essential to completing the ZPLS module installation process and it may take a few minutes for both Agents to appear.

Perform the ZPLS Module installation

To install the ZPLS Module onto the Zoom Node appliance, perform the following steps:

1. From the web portal, under the Zoom Nodesub-menu, select Modules.

2. In the top-left corner of the screen, confirm Zoom Node - Phone Local Survivability is selected in the pulldown menu.

3. On the screen, click Add Services, and a pop-up will appear.

   
4. In the pop-up, select Local Survivability.

   
5. On the following screen, select the hostname of the Zoom Node appliance defined earlier in the setup process. Then select its supported device amount, based on the machine’s hardware capabilities. Finally, confirm the static, internal IPv4 address.

The option to “Add prefix” is not applicable to the ZPLS module and can be left blank.

1. Click Add to complete the module assignment.

2. Installation of the module and associated components will begin and can be monitored from the web portal.

3. After the module completes the installation, the site must be associated with a site before it can initialize. At this time, the ZPLS module installation is complete. Move onto the next section, Configure ZPLS for Your Account to continue setup.