# Appliance

The **Appliance** section enables quick setup of private VMs on your premises and hosts the data plane for browser isolation. This option is only available to PBI private Access licenses. 

<figure><img src="/files/ISB9wy29mjU7jfOpj1hg" alt=""><figcaption></figcaption></figure>

### **Add an Appliance**

To add an appliance:

1. Navigate to the **Appliance** category.
2. Click **Add**.
3. Configure the general  settings:
   * **Name**: The name of the Appliance.
   * (Optional) **Description**: The description of the Appliance.
4. Now you should see the appliance added in the **offline** state.&#x20;
5. Registering the appliance requires the admin to use the ellipse "..." option under the **Action** column.&#x20;

   1. This would bring up a pop-up asking to copy the code that needs to be pasted on the console (On-Prem VM)

   <figure><img src="/files/rrXIcx7TpkYukwYw33J0" alt=""><figcaption></figcaption></figure>

{% hint style="warning" %}
**Note:** You can use the "<kbd>...</kbd>" ellipse option to provide more info or remove an appliance
{% endhint %}

### **Adding VM Image**

1. Download the preferred Hypervisor Image (Azure, VMware ESXi, Hyper-V) from the download option.
2. Continue setting up the image mounting onto your premises using this [**link**](/landing/pbi-guides/pbi-private-access-administrators-guide/appendix/appliance-registration.md) for reference.&#x20;
3. When the setup is completed, use the IPv4 Address to navigate the console's web page to register the Appliance.

<figure><img src="/files/ZDOcX9MyHWMi2AgXbUPA" alt=""><figcaption></figcaption></figure>

4. Copy the code from [step 5](#add-an-appliance) above, and paste it into the Console's registration space.&#x20;
5. The Appliance should show online, both on the appliance page and the admin portal.&#x20;

<figure><img src="/files/MUurMCUmqbdn7W6lLhVz" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/rsKucV92cmgApCUB5f1d" alt=""><figcaption></figcaption></figure>

### **Appliance Details**

The table below provides various fields and their descriptions, covering the actions that can be taken on the appliance.

<table data-header-hidden><thead><tr><th width="145.23828125"></th><th></th></tr></thead><tbody><tr><td><strong>Field Name</strong></td><td><strong>Description</strong></td></tr><tr><td><strong>Name</strong></td><td>The unique identifier or display name of the appliance. Used to distinguish it from other appliances in the system. Typically configurable during registration.</td></tr><tr><td><strong>Description</strong></td><td>A short, optional, human-readable summary providing additional context about the appliance (e.g., purpose, location, environment, or role). Optional but recommended for easier management.</td></tr><tr><td><strong>Status</strong></td><td>Indicates the current operational state of the appliance:<br>• <strong>Not registered</strong> – Appliance exists in inventory but is not yet registered with the system.<br>• <strong>Online</strong> – Appliance is reachable and functioning normally.<br>• <strong>Offline</strong> – Appliance is unreachable or not responding.<br>• <strong>Draining</strong> – Appliance is in the process of gracefully stopping services or workloads before maintenance or shutdown.<br>• <strong>Drained</strong> – Appliance has completed draining and is safe for maintenance or shutdown.</td></tr><tr><td><strong>Update State</strong></td><td>Reflects the software/firmware update condition of the appliance:<br>• <strong>In progress</strong> – An update is currently being installed.<br>• <strong>Up-to-date</strong> – Appliance is running the latest approved version.<br>• <strong>Update available</strong> – A newer version is available for installation.</td></tr><tr><td><strong>CPU</strong></td><td>Displays current CPU utilization and/or allocation metrics. Helps monitor processing capacity.</td></tr><tr><td><strong>Disk</strong></td><td>Shows disk storage usage metrics, such as total capacity, used space, and usage percentage. Useful for capacity planning and alerting.</td></tr><tr><td><strong>Memory</strong></td><td>Displays RAM usage information, including total memory, used memory, and utilization percentage. Important for performance monitoring.</td></tr><tr><td><strong>Action Button</strong></td><td>A context-aware ellipsis (⋯) button that presents available actions based on the appliance’s current state. Possible options include:<br>• <strong>Register</strong> – Available when the appliance status is <em>not registered</em>.<br>• <strong>Delete</strong> – Removes the appliance from the system (availability may depend on status being offline).<br>• <strong>Enter Drain Mode</strong> – Initiates graceful draining process (available when Online).<br>• <strong>Exit Drain Mode</strong> – Returns the appliance to normal operation (available when Drained).</td></tr></tbody></table>

{% hint style="info" %}
**Note**: Troubleshooting an appliance requires navigating to the private appliance IP and accessing the logs, either by downloading the logs or by pushing the logs to the cloud.
{% endhint %}

### Drain Mode & Appliance Upgrades&#x20;

#### Perform Maintenance Without Disrupting Active User Sessions

Drain Mode allows administrators to perform platform maintenance and upgrades **without interrupting active user browser sessions**.

When enabled, the system stops assigning new sessions to selected infrastructure components while allowing existing sessions to continue normally. This ensures a seamless user experience during planned changes.

#### What Is Drain Mode?

Drain Mode is a controlled maintenance state that:

* Prevents new user sessions from being assigned
* Allows existing sessions to continue uninterrupted
* Gradually reduces active session count
* Safely prepares infrastructure for maintenance

Users currently working in isolated browser sessions will **not be logged out** when Drain Mode is enabled.

#### How to Enable Drain Mode

From the Admin Console, do the following:

1. Log in to the **Admin Portal**.
2. Navigate to:\
   **Appliance → Action Elipsis (...) → Enter Drain Mode**
3. The node status will change to `Draining`.
4. Review:
   * Session count
   * Resource usage
5. The Appliance is ready for maintenance when:
   * **Sessions Count** = `0`
   * Status shows `Drained`
6. Once fully drained, you can safely:
   * Restart the node
   * Apply updates or patches
   * Upgrade software versions
   * Delete the appliance
7. After maintenance:

   1. Navigate to&#x20;

   &#x20;      **Appliance → Action Elipsis (...) → Exit Drain Mode**

   1. Confirm


---

# 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://docs.parallels.com/landing/pbi-guides/pbi-private-access-administrators-guide/parallels-browser-isolation-interface/appliance.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.