# oVirt UI Plugin

## General

Integration with the oVirt Virtualization interface allows administrators to perform most of the basic operations without logging into the Storware Backup & Recovery dashboard.

After installation (which is described at the end of this article) you will see a new tab "VM Backups" in the oVirt menu.

![](https://3557270342-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2FOE03dnjP5f5aF1buzl%2Fuploads%2FCZEBmkU4kRZsuuMuUVZV%2Fintegration_plugins-ovirt-general.jpg?alt=media\&token=e3f9c0ff-0165-4dd8-927e-3bfb4a603fad)

### Dashboard

As usual, it contains a short summary of the environment along with a handful of statistics.

![](https://3557270342-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2FOE03dnjP5f5aF1buzl%2Fuploads%2F7beVIaL7GkMQ6DxEM8K6%2Fintegration_plugins-ovirt-dashboard.jpg?alt=media\&token=84e06d32-f9ad-40f4-9a9d-f7dd98cb1007)

You can also see the data summary of the backup destination.

![](https://3557270342-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2FOE03dnjP5f5aF1buzl%2Fuploads%2FVmOGY8Mc4I1eFlHPMdvq%2Fintegration_plugins-rhv-dashboard_2.jpg?alt=media\&token=29f46d21-ea51-4530-8137-551a80117f7b)

### Virtual Machines

This tab shows all inventoried virtual machines in your oVirt environment. Besides, you can also perform the basic backup or restore operations.

![](https://3557270342-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2FOE03dnjP5f5aF1buzl%2Fuploads%2FM117R42Pn9KV3YJOTtoA%2Fintegration_plugins-rhv-virtual-machines_1.jpg?alt=media\&token=a8c6172c-1446-4a17-afe1-f6dff3775a14)

But that's not all, you can also go into the details of the virtual machine by clicking on its name:

![](https://3557270342-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2FOE03dnjP5f5aF1buzl%2Fuploads%2FfF0fwAY1AS9CQ7YmViTg%2Fintegration_plugins-rhv-virtual-machines_2.jpg?alt=media\&token=4b02f946-d3ca-4a1b-a22b-bf5064247d95)

Backup window view:

![](https://3557270342-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2FOE03dnjP5f5aF1buzl%2Fuploads%2FyBlhXZfZ3c0wNfQicRk2%2Fintegration_plugins-rhv-virtual-machines_3.jpg?alt=media\&token=d630e58d-718e-4fe4-94a3-ad365707f200)

### Task console

Basic information about current tasks performed by Storware Backup & Recovery.

![](https://3557270342-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2FOE03dnjP5f5aF1buzl%2Fuploads%2FAFGiw560WpEielxfPF1W%2Fintegration_plugins-rhv-task-console.jpg?alt=media\&token=df074b90-bd3f-4df2-a6fb-365b1b99fb8d)

### Policies

Allows you to create policies for VM's backups and snapshots. It basically has the same functionalities as Storware Backup & Recovery WebUI.

![](https://3557270342-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2FOE03dnjP5f5aF1buzl%2Fuploads%2FOWzUdvlBoOZZtsmXg3ts%2Fintegration_plugins-rhv-policies.jpg?alt=media\&token=4f07a229-a0c2-49c1-b871-2ad47ff29778)

### Schedules

As with the policies tab, it allows you to create schedules for the created rules.

![](https://3557270342-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2FOE03dnjP5f5aF1buzl%2Fuploads%2FrVrIrCCVNfnw9iEaystX%2Fintegration_plugins-rhv-schedules.jpg?alt=media\&token=350e1024-5db7-4bd7-8d92-dd2c46c33be4)

### Mounted Backups

Finally, you can also browse your mounted backups from the oVirt dashboard. You only need to enter the backup details using the menu on the right.

![](https://3557270342-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2FOE03dnjP5f5aF1buzl%2Fuploads%2F3YEWjeAvRhFwOTmfmbwe%2Fintegration_plugins-rhv-mounted-backups_1.jpg?alt=media\&token=5e901be6-1f10-4172-b1e6-f506c30adae7)

From here we can see the basic information about the backup and start browsing the files using the "Browse" button on the right.

![](https://3557270342-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2FOE03dnjP5f5aF1buzl%2Fuploads%2FQLs8VMv2KxCpEEgsJU7L%2Fintegration_plugins-rhv-mounted-backups_2.jpg?alt=media\&token=687dcb59-285f-46f2-824f-b272dda87281)

Just select a folder or file and then press the "download selected" button to have the files on your computer.

![](https://3557270342-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2FOE03dnjP5f5aF1buzl%2Fuploads%2FLE4UCw6QFTAzqSdiSAiT%2Fintegration_plugins-rhv-mounted-backups_3.jpg?alt=media\&token=5ac63e39-9775-4c78-a57b-7463953b0af7)

## Installation

{% hint style="info" %}
You can find minimum requirements for oVirt UI Plugin in [Support Matrix](https://docs.storware.eu/70/overview/support-matrix#integration-plugins)
{% endhint %}

1. You can find the add-on in the [GitHub repository](https://github.com/Storware/ovirt-engine-ui-vprotect-extensions). Follow the instructions in the README to build or download the plugin. Then extract the provided archive onto your oVirt manager.
2. In the file `vprotect.json` edit these lines in the config part:
   * `Storware_URL` - the URL to Storware Backup & Recovery API
   * `username` - the name of admin in Storware Backup & Recovery
   * `password` - the admin password in Storware Backup & Recovery

**Example**:

```
   {
      "name": "vprotect",
      "url": "plugin/vprotect/plugin.html",
      "resourcePath": "vprotect-resources",
      "lazyLoad": false,

      "config": {
          "vProtectURL": "http://10.40.0.55:8080/api",
          "username": "admin",
          "password": "vPr0tect"
       }
   }
```

1. Put the `vprotect.json` file and `vprotect-resources` directory in the `/usr/share/ovirt-engine/ui-plugins` directory in the oVirt Engine.