Abiquo 5.1

Skip to end of metadata
Go to start of metadata

Veeam versions

The Abiquo integrations supports the following versions of Veeam Backup & Replication with separate plugins.

All of the following backup plugins require their own license.

Veeam VersionBackup Plugin
Veeam 9.5 update 4Veeam 9.5 update version 4

Veeam 9.5 update version 4 with VMware Snapshot
Veeam 10Veeam 10

Veeam 10 with VMware Snapshot

Configure Veeam Backup as described below. Then to add VMware Snapshots, see Configure Snapshots for Abiquo Veeam Backup Plugin

For environments with no backup system, there is a separate standalone VMware Snapshot plugin.  See Configure Abiquo VMware Snapshot Plugin

Upgrade Veeam version

To upgrade to the next version of Veeam in Abiquo, follow these general instructions but remember to check for full details in the appropriate documentation:

  1. Obtain the new backup plugin license from Abiquo Customer Service
  2. Check properties for the veeam.properties file and add any new properties, as described below
    1. For example, the hypervisor property, which was added in Abiquo v5.1.1
  3. Change the optional abiquo.properties to match your Veaam version, as described below
  4. In Abiquo, delete the old backup manager and create a new backup manager
    1. Enter the endpoint for Veeam, for example, for Veeam 10 you should use an HTTPS connection to the default port of 9398, for example:

  5. To ensure that Veeam selects the correct backup repository, each job name (and policy code) must be used in only ONE instance of Veeam Backup & Replication
    1. If you already have job names (and policy codes) that are used in more than one instance of Veeam Backup & Replication, please contact Abiquo Support


The Abiquo Veeam backup plugins supports the following hypervisors:

  • VMware
  • Hyper-V

1. Install Veeam

Install the Veeam Enterprise Manager, which is an optional component in Veeam installations. As part of the install process, configure the API ports of the Veeam Enterprise Manager. Enter the HTTP and HTTPS port numbers that the Veeam Backup Restful API service will use. By default, the values are HTTP port 9399 and HTTPS port 9398. 

2. Create Base Veeam Resources for Abiquo

The Veeam API cannot be used to create backup and replication jobs. This means that you must create a dummy job for the Abiquo backup plugin to clone, with a base job for each hypervisor you will be using. A job must contain at least one VM, so you will need a placeholder VM on each hypervisor for use in the dummy job. 

  1. In your hypervisor, deploy a placeholder VM
    • Choose the VM name carefully to show that it is a placeholder VM so that it will not get accidentally deleted
  2. In Veeam create a new job for the hypervisor
    • The default names that the Abiquo backup plugin will detect are "Abiquo Dummy HyperV Job" for HyperV and "Abiquo Dummy VMWare Job" for ESX
  3. Add the placeholder VM
  4. DO NOT set a schedule for the job
  5. Save the job

Do not delete the placeholder VMs and dummy jobs because this could cause problems in the Abiquo backup plugin.

When viewing jobs in Veeam, dummy jobs with placeholder VMs are shown at the top of the list. Jobs created by the Abiquo backup plugin by cloning the dummy jobs are shown below it.

3. Configure Veeam properties

To configure Veeam backup properties in Abiquo:

  1. Log in to the Abiquo Remote Services server
  2. Go to /opt/abiquo/config folder and edit the veeam.properties file. 
    • This is the default file location, and you can change it and configure the new location in abiquo.properties as described below
  3. The Abiquo backup plugin is designed to manage one Veeam host for each Abiquo datacenter. To associate a datacenter with its Veeam host, set a property pair for the datacenter name and the Veeam host IP or FQDN. 
    Set the datacenter name as it appears in the Abiquo UI and get the Veeam host value from the Veeam Enterprise Manager view. 
    For example, for two datacenters, called London and Frankfurt, and with the London veeamhost at and the Frankfurt veeamhost at, the properties file would look as follows.

  4. New in Abiquo 5.1.1. If you have hosts in Veeam that are not in Abiquo, and they contain duplicates of VMs in Abiquo, you must set the hypervisor property to define the hosts in Abiquo, as a comma separated list. The Abiquo backup system will manage VMs on the hypervisors on the list only, to prevent critical errors in the backup system. If the property is empty or not supplied, the platform will use Veeam data from all hypervisors.

  5. To control backup expiration times in Veeam, use properties to set maximum restore points. Remember to remove the hash '#' comment mark at the start of the property line.

    # Set the maximum restore points of a job for each schedule type
    # Set the maximum restore points for a specific polity, e.g. "mypolicy", with preference over other properties
    #veeam.maxrestorepoints.policycode.mypolicy = 5
  6. Set the name of the dummy backup job for your hypervisor

    ## Veeam api does not allow us to create new jobs, only clone the
    ## existing jobs. So Veeam needs a dummy job (disabled) on each Veeam
    ## host in order to clone it to create new jobs.
    veeam.dummy.vmware.name=Abiquo Dummy VMWare Job
  7. Set the name of the backup repository for the dummy backup job, to match the job's Backup repository configuration on the Veeam server. For example, if you are using a repository called "Default Backup Repository".

    veeam.dummy.vmware.repository=Default Backup Repository

    If you need to change the backup repository, remember to change this property.

    If you have one Entity Manager for two Veeam servers, the repositories specified with in the properties file must exist on each server. You do not have to use them, but they must exist. Otherwise, the repository search could fail if each Veeam server uses a different repository name.

  8. Optionally set other properties, according to your environment:

    ## Since veeam api does not allow to create new jobs, only clone the
    ## existent jobs. The veeam needs a dummy job (disabled) in each veeam
    ## host in order to clone it to create new jobs.
    ## The following properties define the name of the jobs for each
    ## virtualization type
    #veeam.dummy.vmware.name=Abiquo Dummy VMWare Job
    #veeam.dummy.vmware.repository=Default Backup Repository
    #veeam.dummy.hyperv.name=Abiquo Dummy HyperV Job
    #veeam.dummy.hyperv.repository=Default Backup Repository
    ## Some operations in veeam api causes an asynchronous task that needs
    ## to be tracked to know the result of the operation. All these properties
    ## are defined in milliseconds
    ## Time to wait between each task state retrieve operation.
    ## Min and Max exists because each operation increase the next interval
    ## in a half of the last one (nextinterval = currentinterval * 1.50)
    ## Maximum of time spent to retrieve the task result
    ## Timeout properties for synchronous request to Veeam api
    ## Cache expiry time in milliseconds

4. Configure all backup jobs with policy codes

For Veeam 9.5u4 and Veeam 10, you MUST create an Abiquo policy Code for each backup. Abiquo ALWAYS uses the backup policy Code attribute to identify the Veeam job to clone. This enables Abiquo to support retention time but it does not affect previously existing backup jobs of current VMs.

  • When a user assigns a backup policy to a VM, if Abiquo cannot find the Veeam job to match a backup policy code, then it will not be able to create a new backup job in Veeam and the VM backups will not run.

For each backup policy in Abiquo:

  1. On the Veeam Backup and Replication server for the Abiquo datacenter, clone the original Abiquo dummy job
  2. Rename the new job to a name that will exactly match the policy Code of an Abiquo backup policy in the Abiquo datacenter
    1. To ensure that the backup system uses the correct repository, check that the policy code and Veeam job name is unique for each backup policy in the backup manager
      • If you use the same policy codes in different datacenters with different repositories, please contact Abiquo Support
  3. To set how many backups should be kept on the server, go to Job → Edit → Storage and set Restore points to keep on disk
  4. In Abiquo, check that the backup policy has the right Code and that it is available to users

When users select this policy, the platform will use the appropriate Veeam job.

5. Configure Abiquo properties

To configure Abiquo properties for Veeam:

  1. Log in to the Remote Services server
  2. Edit the abiquo.properties file
  3. To activate the backup plugin and define the location of the properties file:
    1. Set the abiquo.backup.veaam.config.path property in the following format

  4. Optionally set the other abiquo.properties for your Veeam version.
    These properties are set for "veeam95u4" or "veeam10" and there is no change to add VMware Snapshots.
    1. abiquo.nars.async.pool.{backupplugin-Version}.max
    2. abiquo.nars.async.pool.{backupplugin-Version}.byvdc
    3. abiquo.virtualfactory.{backupplugin-Version}.backup.openSession
    4. abiquo.virtualfactory.{backupplugin-Version}.backup.openSession.byvdc
    See Abiquo Configuration Properties for more details.

Remember that you will need to restart the Tomcat server for changes to the properties file to take effect.