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.


Documentation

Skip to end of metadata
Go to start of metadata

Admin Guide 1. Abiquo. Config Properties

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.

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

Changes to Properties

New Properties in 3.4

Abiquo (task control)

  1. abiquo.abiquo.task.ttl

Docker

  1. abiquo.docker.registry
  2. abiquo.docker.registry.tags

Instance format

  1. abiquo.instance.targetDiskFormatType.hyperv_301

  2. abiquo.instance.targetDiskFormatType.kvm

  3. abiquo.instance.targetDiskFormatType.oracle_vm

  4. abiquo.instance.targetDiskFormatType.vmx_04

  5. abiquo.instance.targetDiskFormatType.xenserver

VSM

  1. abiquo.vsm.actor.creation.delay.{PLUGIN} 

    • for public cloud regions and hypervisors

  2. abiquo.vsm.max.backoff

  3. abiquo.vsm.measures.pusher.frequency

 

Deprecated and deleted properties

Deleted properties

  1. abiquo.database.host
  2. abiquo.database.password
  3. abiquo.database.user

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
Configure Abiquo Events Properties

Abiquo M Configuration

Abiquo has a default role called OUTBOUND_API that has access to events. This role is assigned to a default user, which is called "default_outbound_api_user".

Configure M

If you do not configure M properly, no events will be available in Abiquo. You will need to configure some of the M properties in the abiquo.properties file on the server where M will run. By default, M runs on the Abiquo Server. The API location is required and if you change the M user or password, you must update the M user account details.

The Abiquo M module listens for events in the Abiquo API. When it receives events, it performs requests to the Abiquo API to retrieve further details about the events. Then it writes the events to the Abiquo database and broadcasts them as the event stream of the Outbound API.

Automatic M User Account Configuration

When you install or upgrade Abiquo, it is essential to check that the M module is properly configured to ensure that your platform will record events.

  1. Fresh install
    1. Abiquo automatically configures M with a randomly generated M user password
    2. The M user credentials and password are included in properties file
    3. If the customer changes the user or password of the M user account, they must change the M user and the password in the abiquo.properties file as described below
  2. Upgrade from older version of Abiquo
    1. As part of the database upgrade, Abiquo automatically creates a new M user, assigns a password, and displays these credentials to the customer
    2. The customer must add the M user and password to the abiquo.properties file as described below

Configure M Properties

You must configure the abiquo.properties file on the server where M will run. Without this configuration, no events will be available in Abiquo

  1. Abiquo M User
    • M will use this identity and credential to access the Abiquo API and retrieve information about the events
    • It will record the events in the Abiquo database and stream them through the Outbound API
    • When you modify the default M user, the hidden default values will not function
    • This user must have appropriate permission to access all events
      • Since version 3.0, Abiquo has a default role called OUTBOUND_API that has the required privileges and a default outbound API user with the user name "default_outbound_api_user". See Privileges

  2. Abiquo API Location with Port
    • The API location must be an externally accessible IP and port
    • Use the API port to ensure that an event streaming user with a regular user role can access events
    • The API location IP address cannot be a localhost value (127.0.0.1 or localhost)
    • The Abiquo API location is also used for the Chef integration, so remember this if you have distributed platform components

Example of Manual M Configuration

Abiquo M Configuration
abiquo.m.identity = default_outbound_api_user
abiquo.m.credential = AbiquoMPassword
abiquo.server.api.location = http://my.api.location:80/api

Configure API Load Balancing Properties

API load balancing properties

  • API Servers: set ALL load balancing properties on all API servers that are load balanced. The properties must point to the datanode, which contains the common instances of RabbitMQ, Redis, Zookeeper, and MariaDB/MySQL
    1. abiquo.api.zk.serverConnection
    2. abiquo.database.user
    3. abiquo.database.password
    4. abiquo.database.host
    5. abiquo.redis.host
    6. abiquo.redis.port
  • Remote Services Servers: set RabbitMQ properties on all remote services servers in API load balancing datacenters
    1. abiquo.rabbitmq.connectionTimeout
    2. abiquo.rabbitmq.host
    3. abiquo.rabbitmq.password
    4. abiquo.rabbitmq.port

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

Property

Default

Range

Description

Info
abiquo
        

abiquo.abiquo.task.ttl

  

Number of virtual infrastructure check executions that a locked virtual machine with a pending task can pass before it will be marked as failed

   (star)
amazon
        

abiquo.amazon.loadbalancer.healthcheck.healthythreshold

3

2-10

Specifies the number of consecutive health probe successes required before moving the instance to the Healthy state.

 

   
api
        

abiquo.api.login.failurelapse

60

 

Lapse of time in seconds where abiquo.api.login.maxtries apply

    

abiquo.api.login.maxtries

3

 

Max login failures in a given a lapse (abiquo.api.login.failurelapse)

    

abiquo.api.max.sessions

-1

-1, >0

Maximum number of sessions per user in the API. The default value of -1 means there is no limit and a value of 0 is invalid.

    

abiquo.api.networking.allowMultipleNicsVlan

True

 

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

    

abiquo.api.networking.nicspervm

0

 

Limit of NICs per Virtual Machine. If this is set to 0, there are no limits

    

abiquo.api.session.cookie.name

ABQSESSIONID

 

Abiquo session cookie name. This session does not store anything.

    

abiquo.api.zk.serverConnection

  

Location where ZooKeeper is listening in format <IP address>:<port> for example, 10.10.10.10:2181

    
appliancemanager
        

abiquo.appliancemanager.check.repository

600000

 

Datacenter NFS repository refresh interval (milliseconds)

 

   

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

 

   

abiquo.appliancemanager.client.timeoutInMilliseconds

60000

 

Timeout for HTTP connections to the ApplianceManager Server when using the ApplianceManager Client, this property configures read and connection timeout (milliseconds)

 

   

abiquo.appliancemanager.deploy.connection

120000

 

Timeout for HTTP connections to be established when downloading a virtual machine template (milliseconds)

 

   

abiquo.appliancemanager.deploy.idle

600000

 

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

 

   

abiquo.appliancemanager.deploy.totalTimeout

86400000

 

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

 

   

abiquo.appliancemanager.downloadingPublishInterval

1500

 

Frequency of download progress notification (milliseconds)

 

   

abiquo.appliancemanager.downloads

-1

 

Maximum number of concurrent template downloads. The default value of -1 means unlimited

 

   

abiquo.appliancemanager.fstimeoutms

7000

 

Maximum time for the appliance manager to perform a complete rescan of the repository filesystem (milliseconds)

 

   

abiquo.appliancemanager.localRepositoryPath

/opt/vm_repository

 

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

 

   

abiquo.appliancemanager.repository.ignoredPathPrefix

  

Path names prefixes to be ignored in the repository refresh (Comma separate value)

 

   

abiquo.appliancemanager.repository.ignoredPathRegex

  

Path names suffixes to be ignored in the repository refresh (java Regular Expression format)

 

   

abiquo.appliancemanager.repository.ignoredPathSuffix

  

Path names suffixes to be ignored in the repository refresh (Comma separate value)

 

   

abiquo.appliancemanager.repositoryLocation

<IP-repoLoc>:/opt/vm_repository

 

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

 

   

abiquo.appliancemanager.upload.progressInterval

5000

 

Refresh virtual machine template upload progress (milliseconds)

 

   
auth
        

abiquo.auth.module

abiquo

abiquo, ldap

Whether Abiquo will authenticate only via database or it will also authenticate against LDAP/Active Directory.

    
captcha
        

abiquo.captcha.private.key

  

reCAPTCHA private key for user password reset. Obtain keys from Google

    
datacenter
        

abiquo.datacenter.id

Abiquo

 

Identify the AMQP datacenter queues. The Datacenter ID is used for building routing keys and queue names, so that they are unique for each datacenter. Warning: Do not change this property! This property is required and the value is generated at installation. You can recover the property's value through the API with Get Datacenter

 

  
diskController
        

abiquo.diskController.primary

 

scsi, ide

Default value. Abiquo uses the property only if the disk controller attribute is not set in the virtual machine template. 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.

    

abiquo.diskController.secondary

 

scsi, ide

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.

    
docker
        

abiquo.docker.registry

  

The URL of the Docker Registry that Abiquo will use to pull images. For example: http://localhost:5000

  (star)

abiquo.docker.registry.tags

  

Comma separated list of tag patterns allowed. Existing tags in the Docker registry will be matched against these patterns and Abiquo will only show the ones that match. The format of the pattern is defined by the Java pattern: http://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html Example: ^fixedtag$,^tagswithprefix

  (star)
dvs and vcenter
        

abiquo.dvs.enabled

true

 

Enable DVS. Note that the vCenter login and password can be used when DVS is disabled

 

   

abiquo.dvs.portgroup.loadsharingmechanism

loadbalance_ip

loadbalance_ip, loadbalance_srcid

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'.

 

   

abiquo.dvs.portgroup.maxsize

48

 

Number of available ports in each port group

 

   

abiquo.dvs.vcenter.password

change-me

 

Password of the vCenter user account. The underscore character "_" 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

 

   

abiquo.dvs.vcenter.user

change-me

 

Username of the vCenter user account. Create a user account 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, 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

 

   
esxi
        

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

 

   
ha high availability
        

abiquo.ha.check.delay

300000

 

Delay between checks of all machines with state HA_IN_PROGRESS to determine if HA tasks on all VMs are complete, and if so, then set machine state to DISABLED_BY_HA (milliseconds) (Default value is 5 minutes)

    

abiquo.ha.infcheck.cycles

2

 

Number of failed infratructure checks on a machine before High Availability is triggered and the machine is set to state HA_IN_PROGRESS

    
heartbeat
        

abiquo.heartbeat.autostart

true

 

Automatically start Abiquo heartbeat

    
httpProxy
        

abiquo.httpProxy.host

  

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

   

abiquo.httpProxy.password

  

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

   

abiquo.httpProxy.port

  

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

   

abiquo.httpProxy.user

  

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

   
instance
        

abiquo.instance.targetDiskFormatType.hyperv_301

vhd_sparse

 

Disk format type for instances taken in virtual datacenters on Hyper-V set to no value to avoid any additional conversion (use the instance operation result format)

   (star)

abiquo.instance.targetDiskFormatType.kvm

qcow2_sparse

 

Disk format type for the instances taken in virtual datacenters on KVM set to no value to avoid any additional conversion (use the instance operation result format)

   (star)

abiquo.instance.targetDiskFormatType.oracle_vm

raw

 

Disk format type for instances taken in virtual datacenters Oracle VM set to no value to avoid any additional conversion (use the instance operation result format)

   (star)

abiquo.instance.targetDiskFormatType.vmx_04

vmdk_sparse

 

Disk format type for instances taken in virtual datacenters on ESX set to no value to avoid any additional conversion (use the instance operation result format)

   (star)

abiquo.instance.targetDiskFormatType.xenserver

vhd_sparse

 

Disk format type for instances taken in virtual datacenters XenServer set to no value to avoid any additional conversion (use the instance operation result format)

   (star)
kairosdb
        

abiquo.kairosdb.host

127.0.0.1

 

Address where KairosDb is located for VM monitoring

   

abiquo.kairosdb.port

8080

 

Port where KairosDb is listening for VM monitoring

   
ldap
        

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.

    

abiquo.ldap.authentication.autoUserCreation

true

 

Whether Abiquo must create a user in Abiquo based on a successful login to LDAP

    

abiquo.ldap.authentication.custom.userDnPattern

cn={0},CN=Users

 

Abiquo will perform an additional custom query against the specified schema in the LDAP/Active Directory. This value is required. The default value does not result in an additional query

    

abiquo.ldap.authentication.server.baseDN

DC=127.0.0.1,DC=local

 

Base Distinguished Name of the LDAP/Active Directory

    

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

    

abiquo.ldap.authentication.server.protocol

ldap

ldap, ldaps

Protocol to be used when authenticating to a LDAP/Active Directory.

    

abiquo.ldap.authentication.server.url

127.0.0.1

 

LDAP/Active Directory server URL

    

abiquo.ldap.connection.timeout

5000

 

Timeout to establish the connections to the LDAP/Active Directory server (milliseconds) Default value is 5000

    

abiquo.ldap.read.timeout

10000

 

Timeout to complete the connections to the LDAP/Active Directory server (milliseconds) Default value is 10000

    
m outbound api
        

abiquo.m.credential

xabiquo

 

Credentials that M should use to perform requests to the Abiquo Server (API)

   

 

abiquo.m.identity

admin

 

Identity that M should use to perform requests to the Abiquo Server (API)

   

 
mail
        

abiquo.mail.path

/opt/abiquo/config/mail

 

Path to email template and text .properties files for user password reset

    
nodecollector
        

abiquo.nodecollector.infcheck

5

 

Time between executions of infrastructure check (minutes)

 

   

abiquo.nodecollector.infcheck.threads

5

 

Infrastructure check concurrent machine checks This number should be tied to the number of cores of the machine running discovery manager service

 

   

abiquo.nodecollector.infcheck.timeout

300

 

Infrastructure check timeout in seconds

 

   

abiquo.nodecollector.timeout

180000

 

Timeout for Server/API connections to Nodecollector (Discovery manager) (milliseconds)

    
oauth
        

abiquo.oauth.accesstoken.validity

43200000

 

Number of milliseconds the OAuth access tokens are valid. A '0' value makes the tokens permanent so they don't expire. Default value is 43200000 (12 hours)

    

abiquo.oauth.requesttoken.validity

600000

 

Number of milliseconds the OAuth request tokens are valid. A '0' value makes the tokens permanent so they don't expire. Default value is 600000 (10 minutes)

    
openstack
        

abiquo.openstack.autoAllocateFloatingIps

true

true, false

Enable automatic Floating IP allocation. This property configures how public IP addresses are assigned to the virtual machines deployed in OpenStack clouds. If the virtual machines are not directly attached to a public network, enabling this property will automatically allocate a floating IP for the virtual machines. If virtual machines are deployed and attached directly to a public network, then this property should be set to false.

 

   

abiquo.openstack.autoGenerateKeyPairs

true

true, false

Enable automatic generation of key pairs. This enables the automatic generation of key pairs, to make sure that the owner of the virtual machine will have SSH access to the virtual machines that are deployed.

 

   

abiquo.openstack.credentialType

passwordCredentials

passwordCredentials, apiAccessKeyCredentials

Configures the authentication type. In OpenStack installations, the standard method of authentication is using a password. However, if the RAX_KSKEY extension (see http://docs.openstack.org/api/openstack-identity-service/2.0/content/Admin_API_Service_Developer_Operations-RAX-KSKEY-admin.html) is installed, users might be able to use an API key to authenticate.

 

   
rabbitmq
        

abiquo.rabbitmq.connectionTimeout

0

 

Timeout for establishing a connection to RabbitMQ. The default value of 0 means to wait indefinitely until connection established or error (milliseconds)

  

abiquo.rabbitmq.host

127.0.0.1

 

Address where RabbitMQ is located

  

abiquo.rabbitmq.password

guest

 

RabbitMQ password

  

abiquo.rabbitmq.port

5672

 

Port where RabbitMQ is located

  

abiquo.rabbitmq.requestedHeartbeat

0

 

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

  

abiquo.rabbitmq.username

guest

 

RabbitMQ username

  

abiquo.rabbitmq.virtualHost

/

 

Virtual host where RabbitMQ runs

  
redis
        

abiquo.redis.host

127.0.0.1

 

Address where Redis is located. By default Redis is installed on the Abiquo Server in addition to the Remote Services machine. In a monolithic install, the Redis host and port properties should point to the monolithic server. When configuring API load balancing, only the Abiquo Server Redis property should point to the central datanode

   

abiquo.redis.port

6379

 

Port where Redis is located. By default Redis is installed on the Abiquo Server in addition to the Remote Services machine. In a monolithic install, the Redis host and port properties should point to the monolithic server. When configuring API load balancing, only the Abiquo Server Redis property should point to the central datanode

   
repository
        

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)

 

   
security
        

abiquo.security.encrypt

false

true, false

This property must have the same value on all API and remote services servers. If true, Abiquo will read the custom seed file at /etc/abiquo/.store If you create the seed file, but the property is not true, Abiquo will use the default seed. Abiquo requires access to the configured seed file to work with passwords. If it is lost, you will need to regenerate ALL passwords stored in Abiquo.

  
server
        

abiquo.server.api.location

http://127.0.0.1/api

 

Address where the API is running. For example: http://80.169.25.32/api/. Required for Remote Services (for Appliance manager, the address must be reachable by cloud users). Recommended for Abiquo API Server (for Chef, the address must be reachable from deployed VMs)

   

abiquo.server.blockduplicatedsessions

false

 

If 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

    

abiquo.server.mail.password

none

 

Password for connecting to the mail server

    

abiquo.server.mail.server

127.0.0.1

 

Address where the mail server is located

    

abiquo.server.mail.user

none@none.es

 

System user with privileges for connecting to the mail server

    

abiquo.server.remoteSpace.default

http://abiquo-repository.abiquo.com/ovfindex.xml

 

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

    

abiquo.server.sessionTimeout

30

 

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

    

abiquo.server.timeout

600000000

 

Time the server waits for long requests (milliseconds) (Default value is 7 days)

    
stale sessions
        

abiquo.stale.sessions.check.delay

300000

 

Delay between executions of stale sessions check (milliseconds)

    
storage
        

abiquo.storage.check.delay

900000

 

Delay between checks of the storage infrastructure (milliseconds)

    
storagemanager
        

abiquo.storagemanager.netapp.aggrfreespaceratio

0.05

0 - 1

Recommended free space on NetApp aggregates.

    

abiquo.storagemanager.netapp.debug

false

 

Records requests to ONTAP and responses in the Abiquo logs

    

abiquo.storagemanager.netapp.initiatorGroupName

abiGroup

 

Optional initial initiator group will be created

    

abiquo.storagemanager.netapp.volumelunration

1.3

1.3 - 1.9

Optional ratio to allow a LUN of a provided size to fill on its container volume (volSize = lunSize * volumelunratio).

    

abiquo.storagemanager.nexenta.blocksize

8

8, 16, 32, 64, 128

Specifies the block size in KB for the volumes created in Nexenta storage devices. Abiquo does not validate this property. Abiquo supports values from 8 to 128 KB inclusive but Nexenta requires the value to be a power of 2

 

   
tasks
        

abiquo.tasks.history.size

20

 

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

    

abiquo.tasks.trimmer.delay

86400000

 

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

    
vcenter
        

abiquo.vcenter.port.connection

443

 

Port for connection to vCenter

 

   
virtual infrastructure
        

abiquo.vi.check.delay

900000

 

Delay between executions of the virtual infrastructure check (milliseconds)

    
virtualfactory
        

abiquo.virtualfactory.azure.defaultLoginPassword

abqazure0!

 

Default password for virtual machines if not found in the template

 

   

abiquo.virtualfactory.azure.defaultLoginUser

abiquo

 

Default login for virtual machines if not found in the template

 

   

abiquo.virtualfactory.azure.retry.timeBetweenTriesInSeconds

30

 

Time to wait between polls during a retry

 

   

abiquo.virtualfactory.azure.retry.timeoutInSeconds

900

 

Timeout retrying an operation

 

   

abiquo.virtualfactory.azure.storageAccountPrefix

abiquostorage

 

Prefix of the name of the Azure Storage account created for deployments (one account per region)

 

   

abiquo.virtualfactory.azure.wait.timeBetweenTriesInSeconds

30

 

Time to wait between polls during an operation wait

 

   

abiquo.virtualfactory.azure.wait.timeoutInSeconds

900

 

Timeout waiting for an operation to complete, e.g deploy / undeploy

 

   

abiquo.virtualfactory.hyperv.repositoryLocation

//<IP-repoLoc>/vm_repository

 

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

 

   

abiquo.virtualfactory.kvm.fullVirt

true

true, false

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.

 

   

abiquo.virtualfactory.networking.bridgePrefix

abiquo

 

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

 

   

abiquo.virtualfactory.openSession

2

 

Maximum number of simultaneous operations on a single hypervisor

 

   

abiquo.virtualfactory.oraclevm.createSparseDisks

true

true, false

Create additional hard disks on the datastore as sparse. The default value is ‘true’.

 

   

abiquo.virtualfactory.oraclevm.defaultVMDomain

HVM

HVM, PVM, PVHVM

Create all Oracle VMs with this domain type. Options are (Hardware Virtualized [HVM], Paravirtualized [PVM], Hardware Virtualized with Paravirtualized drivers [PVHVM]).

 

   

abiquo.virtualfactory.oraclevm.ha

false

true, false

This setting controls whether VMs created by Abiquo are configured within Oracle VM for ‘High Availability’. The default value is ‘false’ (no HA support). If set to ‘true’, then Abiquo will deploy a VM for HA if the Oracle VM Server hosting the VM is part of a Clustered Server Pool. Note that when a VM is re-configured, Abiquo will NOT update the HA status of the VM. Please note that some manual configuration of Oracle VM may be required for HA to be performed successfully - please review Oracle VM details in the Abiquo wiki for more details.

 

   

abiquo.virtualfactory.oraclevm.hardPartitioning

false

true, false

Enable Oracle VM Hard Partitioning support (CPU pinning). The default value is ‘false’.

 

   

abiquo.virtualfactory.oraclevm.hardPartitioningCPURatio

1

1 - 64

Expected ratio of virtual CPUs to Physical CPU cores (integer). For best performance, set to 1. To reduce physical CPUs per VM and thus licensing costs, set to a higher value. For example, A value of 1 means a 4xCPU VM will be pinned to 4 physical CPUs whereas a value of 4 means a 4xCPU VM will be pinned to one physical CPU.

 

   

abiquo.virtualfactory.oraclevm.jobStatusCheckDelayMs

1000

100 - 60000

Polling period for the job status check to monitor the status of asynchronous hypervisor jobs (milliseconds). Defaults to 1 second, with a valid range of 0.1 second to 1 minute.

 

   

abiquo.virtualfactory.oraclevm.jobTimeoutMs

28800000

60000 - 604800000

The maximum length of time the Oracle VM Hypervisor Plugin will wait for an individual API-based job to complete (milliseconds). The default is 8 hours, but the valid range is 1 minute to 1 week.

 

   

abiquo.virtualfactory.oraclevm.repositoryLocation

  

NFS Repository location denoted by nfs-server-address:exportpath used by Oracle VM. Defaults to the value of ‘abiquo.appliancemanager.repositoryLocation’ if not explicitly specified in the abiquo.properties file.

 

   

abiquo.virtualfactory.xenserver.repositoryLocation

<IP-repoLoc>:/opt/vm_repository

 

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

 

   

com.abiquo.virtualfactory.esxi.timeoutConnectionMs

10000

 

Time to wait to establish the connection to ESX (milliseconds)

 

   

com.abiquo.virtualfactory.esxi.timeoutReadMs

30000

 

Time to wait to read from the connection to ESX (milliseconds)

 

   
vncport
        

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

    

abiquo.vncport.min

5900

 

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

    
vsm
        

abiquo.vsm.actor.creation.delay.amazon

0

 

The delay in milliseconds added between the creation of actors for Amazon plugin type on VSM startup.

 

  (star)

abiquo.vsm.actor.creation.delay.azure

0

 

The delay in milliseconds added between the creation of actors for Azure plugin type on VSM startup.

 

  (star)

abiquo.vsm.actor.creation.delay.hyperv_301

0

 

The delay in milliseconds added between the creation of actors for HYPER-V plugin type on VSM startup.

 

  (star)

abiquo.vsm.actor.creation.delay.kvm

0

 

The delay in milliseconds added between the creation of actors for KVM plugin type on VSM startup.

 

  (star)

abiquo.vsm.actor.creation.delay.oracle_vm

0

 

The delay in milliseconds added between the creation of actors for ORACLE VM plugin type on VSM startup.

 

  (star)

abiquo.vsm.actor.creation.delay.vmx_04

0

 

The delay in milliseconds added between the creation of actors for ESX plugin type on VSM startup.

 

  (star)

abiquo.vsm.actor.creation.delay.xenserver

0

 

The delay in milliseconds added between the creation of actors for XEN SERVER plugin type on VSM startup.

 

  (star)

abiquo.vsm.max.backoff

3600

 

Maximum backoff time in seconds between connection errors to reduce load and logging of these errors. A counter has been added to register the number of failed attempts to connect to the hypervisor or public cloud to perform any type of operation. When rescheduling operations, Abiquo will multiply the maximum backoff time by the number of failed connection attempts to determine the wait time until the next try. If a connection is established, the error counter is reset.

 

  (star)

abiquo.vsm.measures.pusher.frequency

10000

 

The heartbeat frequency of measures pusher in milliseconds. Or the delay between reconnection process to Kairos.

 

  (star)

abiquo.vsm.pollingfrequency.amazon

5000

 

The delay between VSM polling of virtual machines in milliseconds in Amazon plugin

 

   

abiquo.vsm.pollingfrequency.azure

5000

 

The delay between VSM polling of virtual machines in milliseconds in Azure plugin

 

   

abiquo.vsm.pollingfrequency.hyperv_301

5000

 

The delay between VSM polling of virtual machines in milliseconds in Hyper-V plugin

 

   

abiquo.vsm.pollingfrequency.kvm

5000

 

The delay between VSM polling of virtual machines in milliseconds in KVM plugin

 

   

abiquo.vsm.pollingfrequency.oracle_vm

5000

 

The delay between VSM polling of virtual machines in milliseconds in Oracle VM plugin

 

   

abiquo.vsm.pollingfrequency.vmx_04

5000

 

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

 

   

abiquo.vsm.pollingfrequency.xenserver

5000

 

The delay between VSM polling of virtual machines in milliseconds in XenServer plugin

 

   

abiquo.vsm.vmsyncfrequency.amazon

180000

 

The delay between virtual machine synchronizer operations in milliseconds on Amazon plugin

 

   

abiquo.vsm.vmsyncfrequency.azure

180000

 

The delay between virtual machine synchronizer operations in milliseconds on Azure plugin

 

   

abiquo.vsm.vmsyncfrequency.hyperv_301

180000

 

The delay between virtual machine synchronizer operations in milliseconds in Hyper-V plugin

 

   

abiquo.vsm.vmsyncfrequency.kvm

180000

 

The delay between virtual machine synchronizer operations in milliseconds in KVM plugin

 

   

abiquo.vsm.vmsyncfrequency.oracle_vm

180000

 

The delay between virtual machine synchronizer operations in milliseconds in Oracle VM plugin

 

   

abiquo.vsm.vmsyncfrequency.vmx_04

180000

 

The delay between virtual machine synchronizer operations in milliseconds in ESX plugin

 

   

abiquo.vsm.vmsyncfrequency.xenserver

180000

 

The delay between virtual machine synchronizer operations in milliseconds on XenServer plugin

 

   
vnc
        

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

 

   
workflow
        

workflow.connect.timeout

60000

 

Maximum waiting time in milliseconds to establish a connection with workflow endpoint

    

workflow.read.timeout

10000

 

Maximum waiting time in milliseconds to receive data from workflow endpoint

    

Note on Redis Properties

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

When configuring API load balancing, only the Abiquo Server Redis property should point to the central datanode.

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.