Documentation

Skip to end of metadata
Go to start of metadata

Introduction to Abiquo Properties

Abiquo uses a system based on Java properties that is flexible and easy to configure.

Configuration options are grouped in the file /opt/abiquo/config/abiquo.properties on each server of the Abiquo platform (Abiquo Server, Remote Services, V2V Services). The Abiquo Installer will create configuration files for your installation and example configuration files can be found in the directory /opt/abiquo/config/examples. If you wish to change the configuration options, add the properties you wish to change to your abiquo.properties file and specify the new values. 

The tables below contain all the configuration options that can be modified and their default values as set by Abiquo. The default values for properties are used within the Abiquo platform if you do not set the properties. However, some default configuration options may also be set outside of the Abiquo platform, for example, in the hypervisor. 

After modifying this file, check carefully to ensure you have the correct values and no unnecessary whitespace around the properties. You must restart the abiquo-tomcat service for the changes to take effect.

Changes to Properties

TypeVersionCategoryPropertyNotes
(star) New3.8ESXiabiquo.esxi.datastoreVmFile 
  Monitoringabiquo.monitoring.enabled 
  Neutronabiquo.neutron.external-net 
   abiquo.neutron.region 
   abiquo.neutron.reserved-ips 
   abiquo.neutron.vlan-physical-net 
  VApp specabiquo.vappspec.retrydelayms 
   abiquo.vappspecpool 
  Watchtowerabiquo.watchtower.host 
   abiquo.watchtower.port 
 3.8.2NSXabiquo.nsx.transport-zone 
    abiquo.nsx.edge.cluster-id 
    abiquo.nsx.edge.datastore-id 
    abiquo.nsx.edge.dvportgroup-id 
    abiquo.nsx.edge.public-network-cidr 
    abiquo.nsx.load-balancer-reserved-ips 
 3.8.3NSX

abiquo.nsx.connection-timeout-ms

 
   abiquo.nsx.read-timeout-ms 
   abiquo.nsx.use-edge-dhcp 
  Storage

abiquo.storage.forcesamecontrollertype

 
 3.8.6OpenIDabiquo.openid.authorization.endpoint 
   abiquo.openid.client.id 
   abiquo.openid.client.name 
   abiquo.openid.client.redirect-uris 
   abiquo.openid.client.scopes 
   abiquo.openid.client.secret 
   abiquo.openid.endsession.endpoint 
   abiquo.openid.enterprise-claim 
   abiquo.openid.enterprise-property 
   abiquo.openid.issuer 
   abiquo.openid.jwks.endpoint 
   abiquo.openid.role-claim 
   abiquo.openid.target 
   abiquo.openid.token 
   

abiquo.openid.userinfo.endpoint

 
(minus) Deprecated3.8KairosDBabiquo.kairosdb.host 
   abiquo.kairosdb.port 
(warning) Changed 3.8RabbitMQ

abiquo.rabbitmq.username

Previously the default credentials were guest:guest.
Now the default credentials are abiquo:abiquo
   abiquo.rabbitmq.passwordPreviously the default credentials were guest:guest.
Now the default credentials are abiquo:abiquo
  Instanceabiquo.instance.targetDiskFormatType.hyperv_301

From Abiquo 3.8 by default, there is no value for
Hyper-V so that the result format will be the same
as the original template (VHD or VHDX)

 3.8.2ESXiabiquo.esxi.metrics.{METRIC}In version 3.8 and 3.8.1, the name of these properties
was "esx" instead of "esxi"
 3.8.3DVSabiquo.dvs.enabledThe default value of this property
was corrected to "true" in Abiquo 3.8.3
 3.8.5Storage

abiquo.storage.forcesamecontrollertype

Now determines controller as well as controller type 

Disabled properties

  1. abiquo.api.max.sessions: note that this property has been temporarily disabled and will be enabled in future releases

Open Sessions on Hyper-V

Set abiquo.virtualfactory.openSession=1 as a workaround to problems with concurrent deployments in Hyper-V. From version 3.8.1 this configuration is required by Abiquo for Hyper-V.

Reference properties files attached to this page

These reference files list all the properties that may be configured for each profile.

3.8.5

Key to the Abiquo Configuration Properties Table

Range: all range values are inclusive

(star)  – New property 
(warning)  – Changed property
(minus) – Deprecated Property

 – Abiquo Server / API
 – Remote Services
 – V2V Remote Services 
 – Outbound API
  

This table describes the abiquo.properties file of the Abiquo platform servers. For example, if a property is marked with   symbol  in the  column, it can be configured in the abiquo.properties file of the Abiquo Server/API and Abiquo Monolithic Server.

Abiquo Monolithic Server

An Abiquo Monolithic Server is a single-server install of all or most of the Abiquo platform components, so the properties present on the Abiquo Server and the Remote Service machines may not be necessary or may only need to be added once. For example, see the Note on Redis Properties below the table.

Abiquo Configuration Properties Table