> For the complete documentation index, see [llms.txt](https://docs.storware.eu/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.storware.eu/deployment/backup-destinations/filesystem/catalogic-software-vstor.md).

# Catalogic Software vStor

Storware Backup & Recovery supports Catalogic vStor Server and integrates with it with extended File System Backup Destination logic.

You can use Catalogic volumes like any other file system (mount a single volume over NFS), or you can use the scripts provided to automatically create and replicate volumes whenever a vStor volume is being accessed. This documentation describes a setup with 2 vStor servers and a 1-volume-per-VM approach (with optional replication).

1. Storware Backup & Recovery accesses vStor Servers using SSH public key authentication - first generate the key:

   ```
   [root@vProtectbuild ~]# sudo -u vprotect ssh-keygen
   Generating public/private rsa key pair.
   Enter file in which to save the key (/opt/vprotect/.ssh/id_rsa):  
   Created directory '/opt/vprotect/.ssh'.
   Enter passphrase (empty for no passphrase): 
   Enter same passphrase again: 
   Your identification has been saved in /opt/vprotect/.ssh/id_rsa.
   Your public key has been saved in /opt/vprotect/.ssh/id_rsa.pub.
   The key fingerprint is:
   SHA256:xeceRtL4kq3zzQrUQH/K5SbiT/nv9QvAtBEfOxeT5us vprotect@vProtectbuild.lab.local
   The key's randomart image is:
   +---[RSA 2048]----+
   |          .. . o.|
   |         o +o ooo|
   |          *o=+=. |
   |         .o%o=o. |
   |        S =+@ o .|
   |         o *.= . |
   |          = +.. .|
   |           * +.Eo|
   |            +.++=|
   +----[SHA256]-----+
   ```
2. Add the VM fingerprint to the SSH known\_hosts on the **node** for the primary (and optionally secondary) vStor Server:

   * It must be a `known_hosts` file that belongs to the `vprotect` user
   * The algorithm must be set to `ssh-rsa`

   ```
   sudo -u vprotect ssh -o HostKeyAlgorithms=ssh-rsa admin@VSTOR_HOST
   ```

   **Example:**

   ```
   [root@vProtectbuild ~]# sudo -u vprotect ssh -o HostKeyAlgorithms=ssh-rsa admin@10.10.10.1
   The authenticity of host '10.10.10.1 (10.10.10.1)' can't be established.
   RSA key fingerprint is SHA256:65M/6jNBXJTFqti/798STSFeZigRzHMivDNl0t95FNI.
   RSA key fingerprint is MD5:cc:91:7d:17:8e:21:68:19:4b:c9:e4:76:bd:f5:4d:fc.
   Are you sure you want to continue connecting (yes/no)? yes
   Warning: Permanently added '10.10.10.1' (RSA) to the list of known hosts.
   ```
3. Copy the key to each vStor Server:

   ```
   [root@vProtectbuild ~]# sudo -u vprotect ssh-copy-id admin@10.10.10.1
   /bin/ssh-copy-id: INFO: Source of key(s) to be installed: "/opt/vprotect/.ssh/id_rsa.pub"
   /bin/ssh-copy-id: INFO: attempting to log in with the new key(s), to filter out any that are already installed
   /bin/ssh-copy-id: INFO: 1 key(s) remain to be installed -- if you are prompted now it is to install the new keys
   admin@10.10.10.1's password: 
   _
   Number of key(s) added: 1
   _
   Now try logging into the machine, with:   "ssh 'admin@10.10.10.1'"
   and check to make sure that only the key(s) you wanted were added.
   ```
4. Open the "BACKUP DESTINATIONS" section on the left menu.
5. Create a new Catalogic vStor Server Backup Destination (choose from the top-right drop-down menu).
6. Fill in the template with your information.

{% hint style="warning" %}
To ensure correct operation of SBR and vStor the only supported configuration is to create exactly one vStor Backup Destination per vStor pool, using the corresponding Pool ID. Creating multiple vStor Backup Destinations pointing to the same vStor pool is not supported and may lead to errors during the “Clean Old Backups” process, as well as issues with backup recovery and file accessibility.
{% endhint %}

**Pre access**

<figure><img src="https://2465790538-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwUsKWUrceYHp8e9TJ00e%2Fuploads%2FvLjRH4X9cgt2ZUmfIjh8%2Fimage.png?alt=media&amp;token=3c00ee8f-8785-4e2b-aee5-68f10ed6a575" alt=""><figcaption></figcaption></figure>

* `RIMARY_VSTOR_HOSTNAME_OR_IP` - your primary vStor Server IP/hostname
* `POOL_ID` - unique identifier of the target storage pool

You can retrieve the Pool ID using:\
• vStor CLI:

```
vstor pool show | grep -E '^(ID|NAME):' | paste - -
```

Example output:

```
ID: 3	NAME: poolas
ID: 4	NAME: dawid-test-pool
```

• vStor Web UI: Open the storage pools view; the ID is displayed in the details or in the URL

<figure><img src="https://2465790538-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwUsKWUrceYHp8e9TJ00e%2Fuploads%2Fx8PrFtD1d3GoE4pEpADy%2Fimage.png?alt=media&amp;token=874bded1-46aa-47f0-b516-410319f491d7" alt=""><figcaption></figcaption></figure>

**Post access**

<figure><img src="https://2465790538-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwUsKWUrceYHp8e9TJ00e%2Fuploads%2FOy2D7f4FLn3pbLrm3Reg%2Fimage.png?alt=media&amp;token=55c1a740-ef67-4c32-abd8-603e656df6e9" alt=""><figcaption></figcaption></figure>

* `PRIMARY_VSTOR_HOSTNAME_OR_IP` - your primary vStor Server IP/hostname
* `SECONDARY_VSTOR_HOSTNAME_OR_IP` - optional, secondary vStor Server IP/hostname, where the data will be replicated to
* `VS_PARTNER_ID` - optional, secondary vStor partner ID - you can get this ID by running this command on the vStor Server shell:

  ```
  [admin@localhost ~]# vstor partner show
  ID                               | MGMT ADDRESS | API PORT | SSH PORT
  55cd380b7dc848bbb439bfd444bc1799 | 10.10.10.2   | 8900     | 22
  ```
* If a secondary server is not provided, Storware Backup & Recovery will assume that no replication is needed.

7. Initiate backup to test if the scripts have been executed correctly - in the `vprotect_daemon.log` files you should be able to see messages like this:

```
2018-05-04 15:31:39.133  INFO
[0f2b9705-61a1-44d5-876f-ac81985c4a94] Executing pre/post store command...
```