# Virtual appliance

## Overview

A **virtual appliance** (**VA**) is a virtual machine image running on a **Linux**-based system with the **Xopero ONE** application pre-installed. It can be deployed through the **Xopero ONE Management Service** (**XMS**).

The main purpose of a **VA** is to act as a backup proxy. It enables the use of SCSI **HotAdd**, one of the fastest transport methods, which allows attaching devices to a running virtual machine. This capability is especially useful for both backup and restore operations.

The default **virtual appliance** (**VA**) configuration parameters are:

* 2 CPUs
* 4 GB RAM
* 100 GB disk space

{% hint style="success" %}
**Xopero** recommends using a virtual appliance to achieve the highest backup efficiency.
{% endhint %}

***

## Deployment 

{% stepper %}
{% step %}
Log in to [**XMS**](#user-content-fn-1)[^1], open the **Virtual Machines** tab on the left side of the window, and select **Deploy virtual appliance** at the top.

{% hint style="info" %}
You must have at least one VMware organization added for this option to appear.
{% endhint %}

<figure><img src="https://319733277-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0CBTl43C3OO6ySL1DJ6k%2Fuploads%2FH6KraAbdA0niWXDuhvnI%2Fimage.png?alt=media&#x26;token=b7b5c0e2-0579-4c20-a0fd-eee6926281b6" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
The system will display the **New VMware protection** view, where you can select one of the **VMware** environments available in **Xopero ONE**.

<figure><img src="https://319733277-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0CBTl43C3OO6ySL1DJ6k%2Fuploads%2FKnLoTV77Rr5BUJzR8SzF%2Fimage.png?alt=media&#x26;token=28ac7714-4c2e-4e6f-899e-18728aa1dcb7" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
The selected environment will be responsible for running the **Xopero ONE** **virtual appliance**. You can choose the specific **host** or **cluster** on which the machine will run, as well as the **datastore** that will store the virtual machine drives.

<figure><img src="https://319733277-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0CBTl43C3OO6ySL1DJ6k%2Fuploads%2Fwc3aJ90auoRHEItgmktw%2Fimage.png?alt=media&#x26;token=7b534a19-f1e3-498c-9c4b-d276bd17389d" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
The next section is dedicated to the virtual network, where you can configure the **network** for your machine, **guest OS username** and **password**, as well as the **Xopero ONE Management Service** (**XMS**) address, which the application on the **virtual appliance** will use to establish a connection.

{% hint style="success" %}
The password for the created **virtual appliance** on the host can be found in its description (**notes**). It is recommended to change it to a new, secure password after the machine is created.
{% endhint %}

{% hint style="danger" %}
Make sure the device used for deployment can communicate with your **VMware** host or cluster, as it will be responsible for the installation. If communication between the selected device and **VMware** is unavailable, the process will fail.
{% endhint %}

{% hint style="warning" %}
Devices with **macOS** are <mark style="color:$danger;">**not supported**</mark> as deployment devices for **virtual appliances** in **Xopero ONE**.
{% endhint %}

<figure><img src="https://content.gitbook.com/content/0CBTl43C3OO6ySL1DJ6k/blobs/Vuf7fI3v3e6eWIpnKQbj/4.png" alt="Configuration of network, username and XMS address"><figcaption></figcaption></figure>
{% endstep %}

{% step %}
In **Network settings** you can also configure the IP settings by selecting **Automatic assignment** (**DHCP**) or **Manual setup** from the drop-down list. The first option automatically assigns network settings to the virtual machine adapter through the DHCP protocol, while the second option allows you to configure each parameter manually according to your preferences.

<figure><img src="https://content.gitbook.com/content/0CBTl43C3OO6ySL1DJ6k/blobs/NIZCydQjkJXryhKUuUWr/5.png" alt="Two options of network configuration"><figcaption></figcaption></figure>
{% endstep %}

{% step %}
After making your selection and providing all the required details, click the **Save** button in **Network settings**, then click **Next** to install the **virtual appliance**. The system will display the progress of the deployment process.

<figure><img src="https://319733277-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0CBTl43C3OO6ySL1DJ6k%2Fuploads%2FOvsgHDlGOfWZWKGcGCDI%2Fimage.png?alt=media&#x26;token=de419c90-959d-474c-810a-a96058971ae4" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Once the process completes successfully, the system will display a success message. You can now use the **virtual appliance** agent as a worker device in any **VMware** backup plan.
{% endstep %}
{% endstepper %}

[^1]: Xopero ONE Management Service