Abiquo Documentation Cookies Policy

Our Documentation website uses cookies to improve your experience. Please visit our Cookie Policy page for more information about cookies and how we use them.


Abiquo 2.3


Skip to end of metadata
Go to start of metadata

Admin Guide 1. Abiquo. Config 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.

[root@localhost ~]# service abiquo-tomcat restart

There are NO new properties in Abiquo 2.3. To support direct upgrades between Abiquo 2.0-HF7 and Abiquo 2.3, the changes to properties in 2.2 are marked in this documentation for Abiquo 2.3.

New Flex GUI Properties in v2.2

New properties are marked with a (star) in the New column of the properties table.

You can now configure these UI properties in abiquo.properties so that you do not have to reapply them to client-config.xml.jsp after Abiquo upgrade.

  1. client.GOOGLE_MAPS_KEY
  2. client.USE_SECURE_CHANNEL_LOGIN
  3. client.SERVER_ADDRESS

New Properties in v2.2

New properties are marked with a (star) in the New column of the properties table.

  1. abiquo.api.networking.nicspervm
  2. abiquo.api.networking.allowMultipleNicsVlan
  3. abiquo.vcenter.port.connection
  4. abiquo.vi.check.delay
  5. abiquo.vsm.xen.refresh.retries
  6. abiquo.vsm.xen.refresh.mstosleep
  7. abiquo.tasks.trimmer.delay
  8. abiquo.tasks.history.size
  9. abiquo.rabbitmq.connectionTimeout
  10. abiquo.rabbitmq.requestedHeartbeat
  11. abiquo.server.blockduplicatedsessions (Note that this property was present in 2.0-HF6 but not 2.2 Beta

Changes to Properties in v2.2

 Properties that have been changed in this version are marked with the (warning) symbol in the New column of the properties table.

  1. abiquo.dvs.portgroup.loadsharingmechanism - the default value of this property in Abiquo has changed from loadbalance_srcid to loadbalance_ip.
  2. RemoteDisplay.vnc.keyMap

Deprecated Properties in v2.2

  1. abiquo.server.networking.vlanPerVdc - Set the Estimated VLANs per VDC in the GUI or vlanPerVdcReserved in the API when you create a Rack.
  2. abiquo.vsm.subscriber.delay - Force a subscription to VSM for all the deployed virtual machines managed by Abiquo (milliseconds)

Key to the Abiquo Configuration Properties Table

The following table describes the abiquo.properties file of the Abiquo platform servers. They should be applied in the abiquo.properties file of the server marked with a tick (tick) in the following columns.

    • AS
      • Abiquo Server (Distributed Install)
      • Abiquo Monolithic Server 
      • Abiquo Cloud in a Box
    • RS
      • Abiquo Remote Services Server (Distributed Install)
      • Abiquo Monolithic Server
      • Abiquo Cloud in a Box
    • V2V
      • Abiquo Business Process Manager Server - Abiquo V2V Server (Distributed Install))
      • Abiquo Monolithic Server
      • Abiquo Cloud in a Box

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.

Server/API Check Delay and Timeout Properties

      

Property

Default Value in Abiquo

Description

ASRSV2VNew

abiquo.ha.check.delay

300000

High availability (HA) check delay in milliseconds

(tick)   

abiquo.managedrack.check.delay

900000

Delay between checks of the managed racks. This property is used if there is a maximum number of empty machines configured in a UCS rack. This is the check performed to power on or off machines, according to the power-save configuration of the managed rack (milliseconds)

(tick)   

abiquo.storage.check.delay

900000

Delay between checks of the storage infrastructure (milliseconds)

(tick)   

abiquo.tasks.trimmer.delay

86400000

Delay between executions of the trimmer of task history in Redis for API/Server, in milliseconds

(tick)  (star)

abiquo.vi.check.delay

900000

Delay between executions of the virtual infrastructure check in ms

(tick)  (star)

abiquo.nodecollector.timeout

60000

Timeout for Server/API connections to Nodecollector

(tick)   

abiquo.server.sessionTimeout

30

Time the server waits before marking  a client session as expired (minutes)

(tick)   

abiquo.server.timeout

600000000

Timeout for the Flex client stub for requests to the API (milliseconds). The Flex client connects to the Flex client stub, which launches requests to the API.

(tick)   

com.abiquo.schedulerlock.timeout

30000

Time to wait for a stable infrastructure state (if a hypervisor check takes more time, a 503 - Service Unavailable is thrown during deploy) (milliseconds)

(tick)   
Server/API Configuration Properties      

Property

Default Value

Description

ASRSV2V New

abiquo.api.networking.allowMultipleNicsVlan

true

If false (or any other value), allow only one NIC per VLAN on a VirtualMachine

(tick)  (star)

abiquo.api.networking.nicspervm

0

Limit of NICs per Virtual Machine. Default value of 0 means unlimited NICs

(tick)  (star)

abiquo.diskController.primary

 

*ESXi only* If null, the controller for primary disks on non-persistent  VMs is ide and on persistent VMs it is scsi. Values apply to both non-persistent and persistent VMs. This property does not apply to Hard Disks on the VMware datastore, which are always attached to a SCSI controller.

(tick)   

abiquo.diskController.secondary

 

*ESXi only* If null, the secondary disk controller will be scsi. If ide, you may only add one persistent data volume. This property does not apply to Hard Disks on the VMware datastore, which are always attached to a SCSI controller.

(tick)   

abiquo.heartbeat.autostart

true

Automatically start Abiquo heartbeat

(tick)   

abiquo.redis.host

localhost

Address where redis is located. See #Note on Redis Properties

(tick)   

abiquo.redis.port

6379

Port where redis is located. See #Note on Redis Properties

(tick)   

abiquo.server.api.location

http://localhost/api

Address where the API is running. Used in Chef: must be the public IP of the Abiquo API (or at least an address reachable from the deployed virtual machines). For example: http://80.169.25.32/api/

(tick)   
abiquo.server.blockduplicatedsessionsfalseIf not supplied, it is set to false. When false, no action is taken if multiple users are logged in with the same user account. The user who logged in most recently will have true control of the session and actions by other users may cause problems. When true, the most recent user has control of the session and other users are warned and logged out. Note that this property was present in 2.0-HF6 but not 2.2 Beta(tick)  (star)

abiquo.server.eventSinkAddress

http://localhost

/server/

EventSink

Address where Synchronization points are mounted waiting for events

(tick)   

abiquo.server.mail.password

none

Password for connecting to the mail server

(tick)   

abiquo.server.mail.server

127.0.0.1

Address where the mail server is located

(tick)   

abiquo.server.mail.user

none@none.es

System user with privileges for connecting to the mail server

(tick)   

abiquo.server.remoteSpace.default

http://abiquo-

repository.s3.

amazonaws.com

Default repository space (OVF package sources) attached to all appliance libraries

(tick)   

abiquo.server.virtualCpuPerCore

4

Maximum CPU value that can be set per core

(tick)   

abiquo.tasks.history.size

20

Maximum length of task history in Redis for API/Server by owner

(tick)  (star)

abiquo.vncport.min

5900

First port of the VNC range to be used when allocating virtual machines

(tick)   

abiquo.vncport.max

65534

Last port of the VNC range to be used when allocating virtual machines. Note that VMware only recommends ports 5900 to 5964.

(tick)   

Server Storage Configuration Properties

      

Property

Default Value

Description

ASRS V2V New

abiquo.storagemanager.netapp.debug

false

Records requests to ONTAP and responses in the Abiquo logs

(tick)   

abiquo.storagemanager.netapp.initiatorGroupName

abiGroup

Optional initial initiator group, will be created

(tick)   

abiquo.storagemanager.netapp.volumelunration

1.3

Optional ratio to allow a LUN of a provided size to fill on its container volume (volSize = lunSize * volumelunratio). This property can accept values from 1.3 to 1.9.

(tick)   

abiquo.storagemanager.storageMethod

progressive

Allocation method for assigning external storage volumes to pools: progressive or performance. See Storage Pool Allocation and Managing External Storage

(tick)   

hypervisors.storagelink.address

<IP:port>

For use with XenServer and volumes or persistent images

(tick)   

hypervisors.storagelink.password

storagelink

For use with XenServer and volumes or persistent images

(tick)   

hypervisors.storagelink.user

admin

For use with XenServer and volumes or persistent images

(tick)   

Properties for Proxy between Abiquo Platform and Remote Template Repository

      

Property

Default Value

Description

ASRSV2VNew

abiquo.httpProxy.host

 

IP Address of HTTP proxy for Appliance Manager/API to Internet communication (download template definition list, template definition, VM disk file)

(tick)(tick)  

abiquo.httpProxy.password

 

Password of HTTP proxy for Appliance Manager/API to Internet communication (download template definition list, template definition, VM disk file)

(tick)(tick)  

abiquo.httpProxy.port

 

Port of HTTP proxy for Appliance Manager/API to Internet communication (download template definition list, template definition, VM disk file)

(tick)(tick)  

abiquo.httpProxy.user

 

User of HTTP proxy for Appliance Manager/API to Internet communication (download template definition list, template definition, VM disk file)

(tick)(tick)  

Messaging System Properties for RabbitMQ on Abiquo Server and Remote Services

      

Property

Default Value

Description

ASRSV2VNew

abiquo.rabbitmq.connectionTimeout

0

Connection to RabbitMQ establishment timeout in milliseconds. The default value of 0 means to wait indefinitely until connection established or error.

(tick)(tick)(tick)(star)

abiquo.rabbitmq.host

localhost

Address where RabbitMQ is located

(tick)(tick)(tick) 

abiquo.rabbitmq.password

guest

RabbitMQ password

(tick)(tick)(tick) 

abiquo.rabbitmq.port

5672

Port where RabbitMQ is located

(tick)(tick)(tick) 

abiquo.rabbitmq.requestedHeartbeat

0

The initially requested heartbeat interval, in seconds. The default value of 0 means no heartbeat.

(tick)(tick)(tick)(star)

abiquo.rabbitmq.username

guest

RabbitMQ username

(tick)(tick)(tick) 

abiquo.rabbitmq.virtualHost

/

Virtual host where RabbitMQ runs

(tick)(tick)(tick) 

Remote Services Check Delay and Timeout Properties

      

Property

Default Value

Description

ASRS V2V New

abiquo.appliancemanager.deploy.timeout

60000

Timeout for idle connections when downloading a virtual machine template (milliseconds)

 (tick)  

abiquo.appliancemanager.fstimeoutms

7000

Time to wait for the appliance manager to perform a complete rescan of the repository filesystem (related to abiquo.appliancemanager.timeout) (milliseconds)

 (tick)  

abiquo.appliancemanager.timeout

60000

Time to wait for requests to the appliance manager (such as request to rescan repository filesystem and find new templates, should be larger than fstimeoutms) (milliseconds)

 (tick)  

abiquo.repository.timeoutSeconds

10

Time to wait for checking if the .abiquo_repository file mark is present in the NFS repository filesystem (helps in finding a slow NFS repository) (seconds)

 (tick)  

abiquo.vsm.xen.refresh.mstosleep

1000

Delay between executions of the refresh operation for Xen hypervisor

 (tick) (star)

abiquo.vsm.xen.refresh.retries

5

Maximum number of retries on refresh operation for Xen hypervisor

 (tick) (star)

abiquo.vsm.esx.pollinginterval

5000

The delay between VSM polling of virtual machines on ESX in milliseconds

 (tick)  

com.abiquo.virtualfactory.esxi.timeoutConnectionMs

10000

Time to wait to establish the connection to ESX (milliseconds) (default 10 seconds)

 (tick)  

com.abiquo.virtualfactory.esxi.timeoutReadMs

30000

Time to wait to read from the connection to ESX (milliseconds) (default 30 seconds)

 (tick)  
       

Remote Services Configuration Properties

      

Property

Default Value

Description

ASRS V2V New

abiquo.appliancemanager.checkMountedRepository

true

Perform the repository check against /etc/mtab. Set to false for local NFS Server installations in testing environment: Monolithic, Cloud in a Box, NFS on V2V Server or NFS on Remote Services

 (tick)  

abiquo.appliancemanager.downloadingPublishInterval

1500

Frequency of download progress notification (milliseconds)

 (tick)  

abiquo.appliancemanager.downloads

10

Maximum number of concurrent template downloads

 (tick)  

abiquo.appliancemanager.localRepositoryPath

 

Folder where the abiquo.appliancemanager.repositoryLocation  is mounted on the remote services node

 (tick)  

abiquo.appliancemanager.repositoryLocation

 

Local Appliance Library, NFS repository location denoted by nfs-server-address:exportpath

 (tick)  

abiquo.appliancemanager.upload.progressInterval

5000

Refresh virtual machine template upload progress (milliseconds)

 (tick)  

abiquo.datacenter.id

 

Identify the AMQP datacenter queues. The Datacenter ID is needed for building routing keys and queue names, so that they are unique for each datacenter.  (warning) Do not change this property! The value of this required property is generated at installation, but you can recover the property through the API with Get Datacenter.

 (tick)(tick) 

abiquo.esxi.datastoreRdm

 

When using volumes a VMFS datastore is required (Raw Device Mapping), if the provided target datastore is not VMFS, then try to use the configured datastore

 (tick)  

abiquo.redis.host

localhost

Address where redis is located

 (tick)  

abiquo.redis.port

6379

Port where redis is located

 (tick)  

abiquo.virtualfactory.hyperv.repositoryLocation

 

The CIFS address //IP/resource/ where Windows can locate the virtual disk repository

 (tick)  

abiquo.virtualfactory.kvm.fullVirt

true

If set to false libvirt machines will be created in KVM using PC emulation (software emulation, slower). Emulation only works with x86 64-bit based hosts, including virtual machines, such as cloud in a box

 (tick)  

abiquo.virtualfactory.networking.bridgePrefix

abiquo

Prefix name used to identify the VLAN bridge in the KVM, XEN, VBOX hypevisor nodes

 (tick)  

abiquo.virtualfactory.openSession

2

Maximum number of simultaneous operations on a single hypervisor

 (tick)  

abiquo.virtualfactory.storagelink.address

 

 

 (tick)  

abiquo.virtualfactory.storagelink.password

 

 

 (tick)  

abiquo.virtualfactory.storagelink.user

 

 

 (tick)  

abiquo.virtualfactory.xenserver.repositoryLocation

 

The Storage Area network datastore location where the virtual disks are stored (usually the same as abiquo.appliancemanager.repositoryLocation)

 (tick)  

RemoteDisplay.vnc.keyMap

 

ESX and ESXi only: When using a virtual machine as a VNC server, specify the language to use for the keyboard when VNC clients connect. If this property does not exist, the hypervisor will use the first value in the client-config.xml.jsp in webapps/client-premium/config and the default in this case is the US101 keyboard map (US English). This property is now the default setting to complement the Virtual Machine configuration popup. See Configuring Remote Access to Virtual Machines

 (tick) 

(warning)

Authorization Properties on Abiquo Server      

Property

Default Value

Description

ASRS V2V New

abiquo.auth.module

abiquo

Whether Abiquo will authenticate only via Database or it will also authenticate against LDAP/Active Directory. Values: abiquo , ldap

(tick)   

abiquo.ldap.authentication.attribute.enterprise

organizationname

The attribute in LDAP/Active Directory to look up the Enterprise Name which must be an Enterprise in Abiquo.

(tick)   

abiquo.ldap.authentication.server.baseDN

 

Base Distinguished Name of the LDAP/Active Directory

(tick)   

abiquo.ldap.authentication.server.port

389

LDAP/Active Directory port. In LDAP mode this property is required, even if the server is listening at the default LDAP/Active Directory port

(tick)   

abiquo.ldap.authentication.server.protocol

ldap

Protocol to be used when authenticating to a LDAP/Active Directory. Values: ldap , ldaps

(tick)   

abiquo.ldap.authentication.server.url

localhost

LDAP/Active Directory server URL

(tick)   
abiquo.ldap.authentication.autoUserCreationtrueWhether Abiquo must create a user in Abiquo based on a successful login to LDAP(tick)   

Distributed Virtual Switch and vCenter Properties

      

Property

Default Value

Description

AS RS V2V New

abiquo.dvs.enabled

false

The customer may enable this feature if they wish to use it

 (tick)  

abiquo.dvs.portgroup.loadsharingmechanism

loadbalance_ip

Network adapter teaming policy in DVS port groups. This property controls the algorithm used for network  adapter load balancing when multiple NICs are used in  'teaming mode'. Available values are: loadbalance_ip, loadbalance_srcid.

 (tick) (warning)

abiquo.dvs.portgroup.maxsize

128

Number of available ports in each port group

 (tick)  

abiquo.dvs.vcenter.password

N/A

Password of the vCenter user account. The underscore character "_" it is not allowed in this field. Create a user with the same password in the vCenter in order to use the DVS or vCenter with Abiquo. In vSphere 5.1, you must create this account in an Active Directory domain or using a VMware Single Sign-on system, NOT as a local Windows account on the vCenter. If 'abiquo.dvs.enabled' is set to true, this property is required. The DVS vCenter user and password properties are also used for connecting to vCenter even if DVS is not used, for example, when deleting orphans. So the user and password properties can be used even when abiquo.dvs.enabled is set to FALSE. Set these parameters if vCenter is used, even if DVS is not used.

 (tick)  

abiquo.dvs.vcenter.user

N/A

Username of the vCenter user account. Create a user with the same username in the vCenter in order to use the DVS or vCenter with Abiquo. In vSphere 5.1, you must create this account in an Active Directory domain or using a VMware Single Sign-on system, NOT as a local Windows account on the vCenter. If 'abiquo.dvs.enabled' is set to true, the property is required. The DVS vCenter user and password properties are also used for connecting to vCenter even if DVS is not used, for example, when deleting orphans. So the user and password properties can be used even when abiquo.dvs.enabled is set to FALSE. Set these parameters if vCenter is used, even if DVS is not used.

 (tick)  

abiquo.vcenter.port.connection

443

Port for connection to vCenter

 (tick) (star)
Client Properties      

Property

Default Value

Description

ASRSV2V New

client.GOOGLE_MAPS_KEY

0

The Google Maps API key

(tick)  (star)

client.USE_SECURE_CHANNEL_LOGIN

0

Configures the AMF secure channel (0 for regular, 1 for secure)

(tick)  (star)

client.SERVER_ADDRESS

127.0.0.1

Used by the Flex UI to test connectivity to the backend API stub

(tick)  (star)

 

 

Note on Redis Properties

In Abiquo v2.0, by default Redis is installed on the Abiquo Server in addition to the Remote Services machine. The default abiquo.redis.host configuration is as follows.

Distributed Install

Abiquo Server

abiquo.redis.host = 127.0.0.1

Abiquo Remote Services

abiquo.redis.host = 127.0.0.1

Monolithic Install

Abiquo Server ________

abiquo.redis.host = 127.0.0.1

The abiquo.redis.port should also be set on the Abiquo Server and the Remote Services machine. In a monolithic install, the Redis host and port properties should appear only once.