# 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.

{% hint style="danger" %}
The ZPLS module must be configured when the Zoom Cloud is available and services are operational.
{% endhint %}

### 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](https://zoom.us/signin#/login) 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**.

   <div data-with-frame="true"><figure><img src="/files/b8c4af3c986829d719897df585616c6633247beb" alt="" width="375"><figcaption></figcaption></figure></div>

{% hint style="info" %}
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](/zoom-workplace/zoom-phone/zoom-phone-local-survivability-field-guide/before-you-begin/grant-user-access-to-roles.md) for more information.
{% endhint %}

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

   <div data-with-frame="true"><figure><img src="/files/f943acc8e44e016fa8f191e0c5782f1e00c6e41c" alt=""><figcaption></figcaption></figure></div>
4. In the top right-hand corner of the screen, click the **Nodes** tab.

   <div data-with-frame="true"><figure><img src="/files/51297c2b91dc56ac54bca2cf4505159eb7ef9720" alt=""><figcaption></figcaption></figure></div>
5. On the same screen, click **Add Nodes** in the top-right corner.

   <div data-with-frame="true"><figure><img src="/files/095994ae8464d256548b65eda02292a0a096b2d6" alt="" width="563"><figcaption></figcaption></figure></div>
6. Download the Zoom Node OVA image for your environment.

   <div data-with-frame="true"><figure><img src="/files/c08750bc690c852ff8b403737edd51a602641e79" alt=""><figcaption></figcaption></figure></div>
7. Install the image on a virtual machine.

{% hint style="info" %}
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.
{% endhint %}

### 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**.

{% hint style="info" %}
For production deployments only ‘Thick’ provisioning is supported. There are no hard requirements for IOPS at this stage.
{% endhint %}

7. 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.

   <div data-with-frame="true"><figure><img src="/files/579b77d189e1bff3aefd7aad53dbf7500769ca96" alt="" width="563"><figcaption></figcaption></figure></div>
4. On the following screen, configure the hostname of the virtual machine.

   <div data-with-frame="true"><figure><img src="/files/8515be703efdb901c359332b5c0250c7e21e1287" alt="" width="563"><figcaption></figcaption></figure></div>
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.

{% hint style="info" %}
Secure shell (SSH) access is not enabled on the Zoom Node OS. Direct access is only available through the virtual console.
{% endhint %}

### 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.

#### <mark style="color:blue;">Associate the Zoom Node Appliance with your Account</mark>

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.

   <div data-with-frame="true"><figure><img src="/files/bca4a4eabd6cea18bbf42aa019c77ad4727a775e" alt="" width="563"><figcaption></figcaption></figure></div>
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.

{% hint style="info" %}
The IP address for your machine is likely to be different from the one pictured above.
{% endhint %}

3. You may receive a certificate warning when navigating to the page. If so, click **Advanced** and proceed to the address.
4. 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](#_xqxflbqfdqgv) section.

   <div data-with-frame="true"><figure><img src="/files/f7df96d41b48a9a8f1ffe8bfcd02e8cf26ddd355" alt="" width="563"><figcaption></figcaption></figure></div>
5. Once authenticated, in the left-hand menu, click **Node Agent**.

   <div data-with-frame="true"><figure><img src="/files/8ff41aeae65cf61ba1af88e8d140ce329e5787d9" alt=""><figcaption></figcaption></figure></div>
6. Next, we must generate a registration code. To do this, we must repeat some familiar steps.

{% hint style="info" %}
As mentioned at the end of the [**Download the OVA**](#_s6aeyhe667ms) 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.
{% endhint %}

7. **Outside the virtual machine**, navigate to the [Zoom Web Portal](https://zoom.us/signin#/login) at zoom.us, and sign in using your desk’s Zoom administrator credentials.
8. In the left-hand menu, locate the **Node Management** sub-menu. Extend it, and click **Modules**.
9. In the top-left corner of the screen, confirm **Zoom Node - Phone Local Survivability** is selected in the pulldown menu.

   <div data-with-frame="true"><figure><img src="/files/f943acc8e44e016fa8f191e0c5782f1e00c6e41c" alt=""><figcaption></figcaption></figure></div>
10. In the top right-hand corner of the screen, click the **Nodes** tab.

    <div data-with-frame="true"><figure><img src="/files/51297c2b91dc56ac54bca2cf4505159eb7ef9720" alt=""><figcaption></figcaption></figure></div>
11. On the same screen, click **Add Nodes** in the top-right corner.

    <div data-with-frame="true"><figure><img src="/files/095994ae8464d256548b65eda02292a0a096b2d6" alt="" width="563"><figcaption></figcaption></figure></div>
12. On the following screen, click **Generate Code**, and copy the result.

    <div data-with-frame="true"><figure><img src="/files/da0ca636358a763ea76582ee0712cae29f90ccf7" alt=""><figcaption></figcaption></figure></div>

    <div data-with-frame="true"><figure><img src="/files/ff5e59cb1c96a2891af839d6f953e1c15bf9c5a4" alt=""><figcaption></figcaption></figure></div>
13. **Navigate back to the virtual machine’s console**, paste or enter the registration code, and click **Register**.

    <div data-with-frame="true"><figure><img src="/files/04bf9a3e58ae2e5189bcb2ea8fe875b3464cde9c" alt=""><figcaption></figcaption></figure></div>

{% hint style="info" %}
Performing this action will automatically download and install required components.
{% endhint %}

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

    <div data-with-frame="true"><figure><img src="/files/9fc71372847dbadf7b2dfb732cd41a9f0a3b7e0c" alt=""><figcaption></figcaption></figure></div>
15. After a few minutes, \*\*navigate back to the web portal outside the virtual machine,\*\*and click the **back**button from where you generated the registration code.

    <div data-with-frame="true"><figure><img src="/files/c17c1856a0a717ebd7ab1ce2714b968d80fed1d9" alt=""><figcaption></figcaption></figure></div>
16. Select the **Unconfirmed Nodes** tab.

    <div data-with-frame="true"><figure><img src="/files/932d18bb7569db87d5dcb425db78d3dbd908614c" alt=""><figcaption></figcaption></figure></div>
17. Confirm the displayed hostname matches the previously configured name. If so, press **Confirm**, and define the Node’s location within the pop-up box.

    <div data-with-frame="true"><figure><img src="/files/e0eb94c3b002ebac173e64795982ab53f5943970" alt=""><figcaption></figcaption></figure></div>

    <div data-with-frame="true"><figure><img src="/files/1172954df46c32a313a1dbb587c43752bef676b5" alt="" width="563"><figcaption></figcaption></figure></div>
18. After selecting **Confirm**, the Node should appear in the **Confirmed Nodes** tab.

#### <mark style="color:blue;">Verify Agent Services are Running</mark>

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.

{% hint style="info" %}
These services are essential to completing the ZPLS module installation process and it may take a few minutes for *both* Agents to appear.
{% endhint %}

<div data-with-frame="true"><img src="/files/313fa7852c4c0ae8085958ffa7899a4963f690a8" alt=""></div>

#### <mark style="color:blue;">Perform the ZPLS Module installation</mark>

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

1. From the web portal, under the **Zoom Node**sub-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.

   <div data-with-frame="true"><figure><img src="/files/abefcf8b651a67bd327adfcb50db76802a4e2cbd" alt=""><figcaption></figcaption></figure></div>
4. In the pop-up, select **Local Survivability**.

   <div data-with-frame="true"><figure><img src="/files/f0c32fb9de7ec902ffb93ad341c45aa09d943b58" alt="" width="563"><figcaption></figcaption></figure></div>
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.

{% hint style="info" %}
The option to “Add prefix” is not applicable to the ZPLS module and can be left blank.
{% endhint %}

<div data-with-frame="true"><img src="/files/1e4b9571e151bf800b0c12da87edbc2c84a59b4f" alt="" width="563"></div>

6. Click **Add** to complete the module assignment.
7. Installation of the module and associated components will begin and can be monitored from the web portal.
8. 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.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://library.zoom.com/zoom-workplace/zoom-phone/zoom-phone-local-survivability-field-guide/deploy-the-zpls-module.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.