Skip to main content




The following prerequisites apply to all use cases listed within this guide.

First, you need to get your access key and secret key, from the Cubbit web app. Please follow these instructions on how to get started with a Cubbit account and generate these keys.

Backup via NFS gateway

The purpose of this guide is to describe the configuration of an environment that allows a Veeam backup directly to the Cubbit cloud by using a pre-configured virtual machine image.


Cubbit will provide - as an OVA file - the image of a pre-configured virtual machine, for which the following resources will be required:

  • 2x vcpu
  • 4GB Ram
  • 100 GB HDD - the best performance is achieved when the VM's hard disk can hold a full backup.

Below is the architectural diagram of the proposed solution:

Immagine 1


Please note that the ngc-s3gw VM is within the corporate LAN, and is therefore able to receive backups at a very high speed. The upload bandwidth to the Internet may not be as efficient, in which case the VM must be able to temporarily store data, waiting for the queue of data to the Internet to clear. The VM is equipped with a disk cache for this purpose. We suggest configuring the VM's disk with a capacity at least equal to the sum of the size of the full-backups that can be loaded onto it at the same time.

General requirements

In order to proceed with configuration, the following is required:

  1. Veeam Backup and Replication software (Version 11 and higher)
  2. OVA image of Cubbit NGC gateway (ngc-s3gw)
  3. Virtualisation environment (e.g. VMware)

OVA image installation

Connect to the ESXI web console, and press the Create/Register VM button:

Immagine 2

Choose Deploy a virtual machine from an OVF or OVA file:

Immagine 3

Choose a name for the VM and press Next. Choose a datastore with enough free space:

Immagine 4

Select the deployment options and press Next:

Immagine 5

Then press Finish:

Immagine 6

VM Services Configuration

After installing the VM, log in to the machine via console (user: cubbit password: cubbit) and set its network configuration. This can be carried out via a script located in /home/cubbit/ ( or manually by editing the system file in /etc/netplan. The script sets up the network interface as DHCP and needs to be run as a super user (password cubbit):

~$ sudo ./

Press enter (for default values) or answer as preferred. Generally speaking, it is not necessary to restart the machine after running the script. Once the VM is reachable on the network, you can connect via SSH to the IP it will have taken on the local network, which can be viewed via the command ip addr show. We will denote this IP by <your_local_ip> here and below:

~$ ssh cubbit@<your_local_ip>
Password: cubbit

Once the VM has access to the Internet, you can run the script ( that will allow you to locally mount a bucket from the Cubbit cloud. The script will need to be run as a superuser:

~$ sudo ./
Hello! This script will help you to mount a Cubbit bucket in your
filesystem using S3QL.
You will need the following information in order to correctly mount
a bucket via S3QL:
_ Your access_key and secret_key provided to you from your backup
_ A bucket name that has not been already created.
1 - Enter your access key: nWLh**bj2
2 - Enter your secret key:**********
3 - Enter a bucket name: test
4 - Enter maximum size for storage object in KiB - default 10MB: 10240
5 - Enter maximum number of parallel threads to use - default 20: 20
6 - Enter maximum size of cache in KiB - default 50GB: 50000000
Created bucket test

where: -Access_key (1) and secret_key (2) are the keys that can be created by the Cubbit web control interface (as specified in Prerequisites)

  • Bucket name (3): this is the name of the S3 bucket (Cubbit cloud) where the data of this VM will be loaded.
  • Maximum size for storage object (4): this is the maximum size of the objects into which the files written to this VM will be fragmented in KiB. This is a useful parameter for optimising transfer speed.
  • Maximum number of parallel threads (5): this is the number of parallel threads that will load file fragments to and from this VM. It is a useful parameter for optimising transfer speed.
  • Maximum size of cache in KiB (6) - is the size of the disk cache where the fragments will be written, before being moved to the cloud via an internet connection.

At the end of execution, the bucket will be mounted in the /mnt/cubbit folder. This can be verified with the command df -h:

~$ df -h
Filesystem Size Used Avail Use% Mounted on
/dev/root 97G 2.6G 95G 3% /
devtmpfs 965M 0 965M 0% /dev
tmpfs 971M 0 971M 0% /dev/shm
tmpfs 195M 1000K 194M 1% /run
tmpfs 5.0M 0 5.0M 0% /run/lock
tmpfs 971M 0 971M 0% /sys/fs/cgroup
/dev/loop1 62M 62M 0 100% /snap/core20/1587
/dev/loop0 56M 56M 0 100% /snap/core18/2538
/dev/loop3 68M 68M 0 100% /snap/lxd/22753
/dev/loop4 47M 47M 0 100% /snap/snapd/16292
/dev/sda15 105M 5.2M 100M 5% /boot/efi
tmpfs 195M 0 195M 0% /run/user/1001
/dev/loop5 62M 62M 0 100% /snap/core20/1611
s3c:// 1.0T 0 1.0T 0% /mnt/cubbit

The /mnt/cubbit folder will also be shared via NFS on the VM's first network interface. The full name of the NFS share on Windows systems will be:


While on Linux systems it will be:



The shared folder /mnt/cubbit can now be configured as any Veeam Linux backup repository. Choose Add Backup Repository and select the option Network attached storage:

Immagine 7

Select NFS Share:

Immagine 8

And right afterward a name for the new repository:

Immagine 9

Enter the IP and path of the previously created NFS Share (Next):

Immagine 10

In the Repository section, configure as shown in the image below and press Next:

Immagine 11

Continue by confirming the default settings until the end of the wizard. Finally, press Finish. The repository will appear among those selectable for any type of backup:

Immagine 12

In order to use it, you only need to choose the Cubbit repository, as the Backup repository of any Backup job (in the Storage section).

Immagine 13

Create an S3 Compatible Object Storage Backup Repository (Capacity tier)

In the Backup Infrastructure view, click on Backup Repositories and choose Add Backup Repository.

Immagine 14

In the Add Backup Repository window, choose Object Storage.

Immagine 15

Choose S3-compatible object storage to start the Object Storage Repository wizard.

Immagine 16

Enter the name and description for the new Object Storage repository and click Next.

In the Account window, enter in the Service point field and enter the value eu-west-1 in the region field. In the credentials field press the Add button to add the access credentials. In the dialog box that opens enter Access key and Secret key in the respective fields and press OK.

Immagine 17


Before proceeding further you will need to have created at least one Bucket via other S3 clients (e.g. Amazon AWS CLI or Cubbit Web Console).

After creating a new bucket from the Cubbit Web Console proceed to the Bucket section.

This window allows you, via the topmost Browse (1) button, to browse through the buckets on your S3 Cubbit account. After selecting the bucket press OK (2) and close the dialog box.

Likewise, clicking the Browse (3) button further down will allow you to browse through folders within the chosen bucket or create a new one (New folder button).

The chosen bucket and folder will be the destination of the backups. To move forward, select the folder and press OK. Then press the Apply (4) button.

Immagine 18

Review the information and finally click Finish to complete this step. The Cubbit Object Storage S3 Compatible repository has been successfully added to Veeam, you will be able to use it for various types of backup jobs with Veeam.

File Share (NFS) backup

In this use case, we will assume that we need to back up a resource with NFS File Share.


To proceed with the configuration, you will need the following:

  1. Veeam Backup and Replication software (Version 11 and higher)
  2. File Share meets the requirements listed in Platform Support
  3. If you plan to use a dedicated backup proxy server or cache repository, make sure these components are added to Backup Infrastructure.

Adding File Share (NFS)

To add an NFS share resource, select Inventory > File Shares and click Add File Share.

Immagine 19

In the Add File Share dialog box, select NFS Share to continue.

Immagine 20

In the NFS File Share section, add IP address and path to the NFS share <IP address>:/path_to_share.

Press Next to continue.

Immagine 21

Make sure the Cache repository points to the Default Backup Repository (in the screenshot below it has been renamed configurationbackup), and click Apply to add the NFS File Share network resource.

Immagine 22

Then press Finish to close the wizard. The new NFS File Share resource will be listed under File Shares > NFS Shares in the Inventory section.

Immagine 23

Backup Job Creation

Now you can proceed with the creation of the Backup Job. Select Home from the navigation panel on the left, press the top left Backup Job button, and then select File Share.

Immagine 24

A wizard will open that will help in creating the Backup Job. Choose the name of the Backup Job and the path of the files and folders to back up.

Immagine 25

In the Storage section set up the following:

  1. The Backup repository where to allocate files.
  2. The duration for which to keep the latest versions of files locally.
  3. How long to keep previous versions on the Cubbit S3 Archive repository.
  4. The Cubbit S3 Archive repository (as previously set up where to store previous versions of files.
  5. Press Next

Immagine 26

Leave the Secondary Target section blank and press Next. In the Schedule section set the date and time schedule of the Backup Job and press Next. Check the data entered in the Summary section and check the box if we intend to start the newly created Backup Job immediately. Finally, click on Apply.

The Backup Job on the File Share (NFS) will be added to Veeam's list of available Jobs and if needed, started directly.

Immagine 27

Backing up one or more VMs via Scale-Out repository

For other types of backups (such as that for Virtual Machines), it is necessary to implement a Scale-out type repository.

A Scale-out repository for backups is a repository system with horizontal scalability support for multi-level data storage. One or more backup repositories can be used to extend another. Commonly an S3 Compatible object-storage repository is used as an extension of a local disk-based (primary) repository. In this case the S3 Compatible repository is called Capacity Tier, while the local one is called Performance Tier.

The main advantages of this feature are:

  • It provides a convenient way to manage backup storage.
  • A Scale-out backup repository can be expanded at any time: if the extensions of the Scale-out backup repository run out of space, a new extension can be added to the existing Scale-out backup repository.
  • It supports any backup destination supported by Veeam: Windows or Linux servers with local or DAS storage, network shares, deduplicating storage devices. All features of any device or storage system are retained.
  • It allows to set granular performance criteria.
  • It provides virtually unlimited cloud-based storage capacity: you can instruct Veeam Backup & Replication to offload data from extensions to the cloud for long-term storage. For more information, see Capacity Tier.

The steps to create such a configuration are described below.


In this configuration, the repository created as S3 Object Storage Backup Repository cannot have an associated job, so we will first proceed with creating the primary repository, to which the backup jobs will be associated. This step can be skipped in case the primary repository already exists.


To proceed with the configuration, you will need the following:

  1. Veeam Backup and Replication software (Version 11 and higher)
  2. Veeam Universal License (VUL) or Per-socket license (Enterprise or higher)
  3. Virtualisation environment (e.g. VMware)

Veeam Backup and Replication Community e Standard editions do not allow to use the Scale-out repository functionality. With the Enterprise edition, users can create two Scale-out repositories with three active extensions and unlimited inactive ones (set in maintenance mode). The VUL and Enterprise Plus editions have no limitations on the number of repositories or extensions.

Creating a Performance tier SOBR (primary repository)

From VMware vCenter (or the VMware Workstation client), right-click on the Veeam server and select Edit Settings. Click on Add hard disk and select a hard disk from the drop-down list.

Immagine 28


The capacity of this hard disk will need to be sufficient to host the primary backup data (beware that Veeam full backup produces files not the same size as the backup itself).

On Veeam Backup & Replication open the Backup Infrastructure section, click on Backup Repository and then click Add Repository. In the window that opens select the connection type of the Direct attached storage primary repository (in this case a disk directly connected to Microsoft Windows or Linux server).

Immagine 29

Choose a name and description for the new primary repository and click Next. A dialog box will open, in the Server section press Populate and you can choose the disk you prefer as the target of your primary repository.

Immagine 30

In the Repository section disable the option Limit maximum concurrent tasks, to allow more concurrent tasks.

Immagine 31

Then click on Next until closing the whole wizard.

Immagine 32

Creating the Scale-out Repository

We now have both the Performance Tier and the Capacity Tier (Cubbit S3 Object Storage) needed to define the Scale-out.

Select Backup Infrastructure again, click on Scale-out Repositories and click on Add Scale-out.

Immagine 33

Enter the name and description for this new Scale-out Repository. Click on Next to continue. In the Performance Tier section that will open, click on Add... to add the primary repository (Performance Tier created in the previous paragraph).

Immagine 34

In the same Performance Tier dialog box, click on Advanced to display the advanced options of the Performance tier. Uncheck Use per-machine backup files and press OK. Then click on Next to continue.

Immagine 35

In the Placement Policy section, keep the default Data Locality policy. This policy allows all files (full and incremental) to be allocated in the same extension. Then click Next to proceed.

In the Capacity Tier section, check the box Extend scale-out backup repository capacity with object storage and from the drop-down menu select the Cubbit S3 object storage repository (the previously created Capacity Tier.

Check the box whose description starts with Copy backups to object storage as soon as... and uncheck the box whose description starts with Move backups to object storage as they age out...

This will move the backups to the cloud immediately after they are created. Finally, press Apply to apply the changes.

Immagine 36

In the Summary section review the list of changes applied and press Finish to complete the Scale-out Repository creation wizard.

You will be able to view the newly created Scale-out Repository from the Backup Infrastructure section on Scale-out Repositories.

Immagine 37

The newly created Scale-out Repository will be available as a target-repository in any Backup Job that is created from now on.

For additional information about Veeam Backup & Replication usage please visit the official documentation page.