Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: 5.1.1 - release -

Table of Contents
maxLevel1
typeflat

...

Expand
titleClick here to show/hide properties changes in 4.0.x


Property_______________________________Description

4.0.0






Added




abiquo.amazon.public.subnet.mask

Mask to use when creating the public subnet in AWS to configure the nating
Default: 24

 

  

abiquo.backup.{BACKUP-PLUGIN}.config.path

    • avamar
    • veeam

This property indicates where the backup plugin configuration file is located for each backup plugin (BACKUP-PLUGIN}. This property is only required in the remote services that use the plugin: virtual-factory, cloud-provider-proxy
Default:

    • avamar = /opt/abiquo/config/avamar.properties
    • veeam = /opt/abiquo/config/veeam.properties
 

  

abiquo.vcd.reserved-ips

Number of IP addresses that are reserved for vCloudDirector in each private network to allocate to load balancers.
Default: 20

 

  

abiquo.virtualfactory.backup.openSession

Maximum number of simultaneous operations on a single backup manager
Default: 2

 

  

abiquo.virtualfactory.device.openSession

Maximum number of simultaneous operations on a single device
Default: 2

 

  

abiquo.vsm.vmsyncfrequency.vcd

The delay between virtual machine synchronizer operations in milliseconds. for each hypervisor or public cloud plugin (PLUGIN)
Default: 180000

 

  
Changed




abiquo.vcenter.port.connection

Port for connection to vCenter (only used in NSX)
Default: 443

 

  
Deprecated




abiquo.PROVIDERNAME.defaultprofiles


Used to create an allowlist for groups of hardware profiles, for example, abiquo.amazon.defaultprofiles=t1.micro,c4.small

Abiquo v4.0+ manages hardware profiles on the Hardware profiles tab in Infrastructure view, so Abiquo v4.0+ will ignore these properties.

During the upgrade process to v4.0, Abiquo will retrieve the profiles previously on the allowlist for the cloud provider from the Abiquo database and create them in Abiquo, and make them available to all enterprises with credentials for a public cloud provider.

When the Administrator synchronizes hardware profiles in Infrastructure view, ALL hardware profiles will be obtained from the cloud provider and created as active profiles in Abiquo. The administrator can then control the profiles available to each enterprise and recommended profiles for each virtual machine template

Note: This property was previously documented in the Abiquo 3.10 wiki in Control hardware profiles in public cloud.

 


  

4.0.1






Added




abiquo.virtualfactory.azurecompute-arm.maxconcurrentupdates

The maximum number of concurrent updates to a virtual machine in Azure ARM.
Default: 5

 

  
Deleted




abiquo.dvs.portgroup.maxsize

Number of available ports in each port group.

 

  

abiquo.dvs.vcenter.password

Password of the vCenter account

 

  

abiquo.dvs.vcenter.user

User of the vCenter user account

 

  

4.0.2






Added




abiquo.backup.check.delay

Delay between executions of the backup results check (milliseconds). Default is 10 minutes
Default: 600000
Default changed form 43,200,000 ms

   
abiquo.instance.targetDiskFormatType.esx

Disk format type for instances taken in virtual datacenters for each hypervisor plugin (HV). Set to empty with no value to avoid any additional conversion (use the instance operation result format).
Defaults: esx = vmdk_sparse




abiquo.m.instanceid

NOTE: You must set a unique value for each instance of the outbound API, which includes each member of the same cluster of M nodes or the platform will not run (minus)
Unique name for an M instance. All M instances must set this property to a unique name. The name must be unique even between the members of the same cluster of M nodes.

   

abiquo.rabbitmq.addresses

NOTE: Replaces the abiquo.rabbitmq.host and abiquo.rabbitmq.port. You MUST define this comma-separated list with the host:port value for each RabbitMQ server or the platform will not run (minus)
For your RabbitMQ server(s), an obligatory list of host:port values, separated by commas. Replaces the separate address and port properties that are now deprecated
Default: localhost:5672

 
abiquo.server.mail.authIf authentication is required to connect to the mail server
 Default: true
   
abiquo.server.mail.extra.(javax mail property)

For each SMTP property available in Java Mail (see the full reference here:
https://javaee.github.io/javamail/docs/api/com/sun/mail/smtp/package-summary.html) you can define an Abiquo propery to configure it by adding the 'abiquo.server.mail.extra.' prefix. For example, you could configure the 'mail.smtp.quitwait' by setting the following property: abiquo.server.mail.extra.mail.smtp.quitwait = false

   
abiquo.server.mail.portThe mail server port
 Default: 25
   
abiquo.server.mail.sslIf SSL should be used to connect to the mail server
 Default: false
   
abiquo.server.mail.tlsIf TLS should be used to connect to the mail server
Default: false
   

abiquo.virtualfactory.azurecompute-arm.maxconcurrentupdates

The maximum number of concurrent updates to a virtual machine in Azure ARM.
Default: 5

 

  

abiquo.vsm.actor.creation.delay.esx

The delay in milliseconds added between the creation of actors on VSM startup for each hypervisor or public cloud plugin (PLUGIN).
Default: 0




abiquo.vsm.hostsyncfrequency.{HV}

    • vmx_04
    • esx
    • kvm
    • hyperv_301
    • oracle_vm
    • xenserver
    • vcd

Time between executions of infrastructure check in milliseconds
Default: 300000

 

  

abiquo.vsm.pollingfrequency.packet

The delay between VSM polling of virtual machines in milliseconds for each public cloud plugin (PC).
Default: 300000

 

  

abiquo.vsm.pollingfrequency.esx

The delay between VSM polling of virtual machines in milliseconds for each hypervisor (HV).
Default: 300000

 

  

abiquo.vsm.vmsyncfrequency.esx

The delay between virtual machine synchronizer operations in milliseconds. for each hypervisor or public cloud plugin (PLUGIN)
Default: 180000

 

 
Changed




abiquo.auth.module

Whether Abiquo will authenticate via: database; database and LDAP/Active Directory; or OpenID.
Default: abiquo
Range: abiquo, ldap, openid
Added openid



 
Deleted




abiquo.rabbitmq.host

Address where RabbitMQ is located

 

abiquo.rabbitmq.port

RabbitMQ password

 
com.abiquo.esxi.experimental.customize.addnicRun hypervisor tools guest customization after adding a NIC



com.abiquo.esxi.experimental.customize.configureIf true, run hypervisor tools guest customization



com.abiquo.esxi.experimental.customize.ostypesRun hypervisor tools to customize the guest for the given operating system types



4.0.4






No changes to properties in version 4.0.4





...

Expand
titleClick here to show/hide properties changes in 4.6.x


PropertyDescription

4.6.0






Added




abiquo.enterprise.property.discount.suffix

Pricing discount is defined in the enterprise properties. The property key is built using the hypervisor type in lowercase and adding a suffix, which is defined by this property
Default: _discount

 


  

abiquo.enterprise.property.pricefactor.suffix

Pricing pricefactor is defined in the enterprise properties. The property key is built using the hypervisor type in lowercase and adding a suffix, which is defined by this property
Default=_price_factor

 


  

abiquo.nars.async.amqp.backoff.minseconds

AMQP consumer reconnection.  First attempt to restart in seconds
Default: 2

   

abiquo.nars.async.amqp.backoff.maxseconds

AMQP consumer reconnection.  Maximum number of seconds without restart attempt
Default: 2

   

abiquo.nars.async.pool.max

Default maximum number of simultaneous operations on a single hypervisor or region connection.
Default: 2

   

abiquo.nars.async.pool.byvdc

If true, the max number of simultaneous operations apply to a single virtualdatacenter (instead of single hypervisor or region connection)
Default: false

   

abiquo.nars.async.pool.inactivity.maxhours

Maximum hours without activity in a pool before release. Minimum value is 6, if a lower value is specified, will use 6
Default: 24

   

abiquo.nars.async.pool.{plugin}.max

  • oracle_vm

  • amazon

  • kvm

  • vmx_04

  • rackspace-cloudservers-uk

  • softlayer

  • esx

  • vcenter_cluster

  • openstack-nova

  • packet

  • hyperv_301

  • oracle-ase-emea

  • azurecompute-arm

  • oracle-ase-us

  • vcd

  • xenserver

  • digitalocean2

  • google-compute-engine

  • rackspace-cloudservers-us

  • cloudoorsphere

  • openstack-neutron

  • nsx-gateway

  • nsx-nat

  • logical

  • nsx-ecmp

  • omapi

  • dnsmasq

  • avamar

  • veeam80

  • veeam95


Maximum number of simultaneous operations on a single hypervisor or region connection, by type.
Default: abiquo.nars.async.pool.max

   

abiquo.nars.async.pool.{plugin}.byvdc

  • oracle_vm

  • amazon

  • kvm

  • vmx_04

  • rackspace-cloudservers-uk

  • softlayer

  • esx

  • vcenter_cluster

  • openstack-nova

  • packet

  • hyperv_301

  • oracle-ase-emea

  • azurecompute-arm

  • oracle-ase-us

  • vcd

  • xenserver

  • digitalocean2

  • google-compute-engine

  • rackspace-cloudservers-us

  • cloudoorsphere

  • openstack-neutron

  • nsx-gateway

  • nsx-nat

  • logical

  • nsx-ecmp

  • omapi

  • dnsmasq

  • avamar

  • veeam80

  • veeam95


If true, the max number of simultaneous operations apply on a single virtual datacenter (instead of single hypervisor or region connection), by type.

Default: abiquo.nars.async.pool.byvdc

   

abiquo.nars.async.prefetch

Limit of parallelism of async request execution. Number of unacknowledged messages from the requests queue.
Default: 4

   

abiquo.plugin-client.connectionrequesttimeout

API to NARS http client configuration: timeout in milliseconds used when requesting a connection. A value of 0 is interpreted as an infinite timeout. A negative value is interpreted as undefined
Default: -1

   

abiquo.plugin-client.connectiontimeout

API to NARS client configuration: timeout in milliseconds when a connection is established. A value of 0 is interpreted as an infinite timeout. A negative value is interpreted as undefined
Default: -1

   

abiquo.plugin-client.pool.checkconnections

API to NARS http client pool configuration: When reusing a connection checks if the elapsed time since the last use exceeds this timeout.
Default: 5000

   

abiquo.plugin-client.pool.maxclients

API to NARS http client pool configuration: Max active HTTP connections to any NARS.
Default: 50

   

abiquo.plugin-client.pool.maxclientsperendpoint

API to NARS http client pool configuration: Max active HTTP connections to the same NARS instance.
Default: 10

   

abiquo.plugin-client.pool.maxkeepalivesms

API to NARS http client pool configuration: Max time to keep a persistent connection.
Default: 120000

   

abiquo.plugin-client.timeout


API to NARS http client configuration: milliseconds to wait for a sync execution in the plugin. 
Implemented as socket timeout (SO_TIMEOUT) in milliseconds, which is the timeout for waiting for data or, put differently, a maximum period inactivity between two consecutive data packets). A value of 0 is interpreted as an infinite timeout. A negative value is interpreted as undefined
Default: -1

   

abiquo.plugin-client.timeout.{plugintype}


API to NARS http client configuration: milliseconds to wait for a sync execution in the plugin by type

   

abiquo.plugin-client.timeout.{plugintype}.{operationname}


API to NARS http client configuration: milliseconds to wait for a sync execution in the plugin by type and operation

   

abiquo.pricing.import.check.delayInHrs

Delay between executions of the pricing import check in hours
Default: 24



 
Deleted




abiquo.nodecollector.timeout

Timeout for Server/API connections to Nodecollector (Discovery manager) in milliseconds.
Default: 180000



  
Changed




abiquo.cloudoorspherecloudoorspherecpp


For all CloudoorSphere properties, see CloudoorSphere

Property name changed from abiquo.cpp.cloudoorspherecpp




4.6.1






Added




com.abiquo.esxi.discovery.networkinterface.networks

Only use physical network interfaces connected to the specified networks when adding vCenter hosts or clusters. If ''onlymanagementip'' is true, then first check for IPs (management or not) in the specified networks and if none are found, use onlymanagementip filter. The filter is a comma separated list of network in CIDR format, and the order specifies the priority

 

  

com.abiquo.esxi.discovery.networkinterface.onlymanagementip

Only use virtual NICs of the host configured for management traffic<br/> Default: false

 

  

4.6.2






No changes to properties in 4.6.2




4.6.3






Added




abiquo.costusage.task.frequencyinhours

Frequency for executing the consolidation of usage accounted
Default: 24
Range: > 0

 

  

abiquo.nars.async.pendingpublish.minutes

Check for pending responses which failed to publish due to AMQP failure in nars
Default: 10

 

  

abiquo.nars.async.pendingpublish.path

Path to file that stores pending responses which failed to publish due to AMQP failure in nars
Default: /opt/abiquo/amqp-messages/nars.pending

 

  

abiquo.virtualfactory.pendingpublish.minutes

Check for pending responses which failed to publish due to AMQP failure in virtualfactory
Default: 10

 

  

abiquo.virtualfactory.pendingpublish.path

Path to file that stores pending responses which failed to publish due to AMQP failure in virtualfactory
Default: /opt/abiquo/amqp-messages/virtualfactory.pending

 

  

4.6.4






No changes to properties in 4.6.4




4.6.5






No changes to properties in 4.6.5






4.6.6






No changes to properties in 4.6.6






4.6.7






abiquo.experimental.shareddisks.bypass

Bypass restriction on multiple VMs using the same disk. Ignore additional VMs using the same disk during capture. After deleting or releasing the first VM, to assign a disk to another VM, you must force the VM to synchronize with the hypervisor

Default: false






4.7.x


Expand
titleClick here to show/hide the properties changes in 4.7.x


4.7.0






Added




com.abiquo.esxi.webmks

If true, enable console access to VMs on vCenter using WebMKS. This will automatically allow remote access to all vCenter VMs. If the VMs have VNC extradata, then use VNC; otherwise use WebMKS.

Default: false



com.abiquo.esxi.webmks.force

If true, force the use of WebMKS when it is enabled for console access to VMs in vCenter. The force action takes place during the next VM reconfigure, when the platform will check for VNC extradata and remove it. This will ensure that remote access will be via WebMKS

Default: false



abiquo.availabilityzones.check.delayInHrs

Delay between checks of availability zones
Default: 24




abiquo.nsx.firewall.applicationprotocolsFirewall protocols that are allowed to use services applications (aka ALG (Application Level Gateway)). Collections separated using # delimiter
Default: FTP#SMB#ORACLE_TNS#MS_RPC_TCP#SUN_RPC_TCP




Deprecated




abiquo.m.accessToken

OAuth access token that M should use to perform requests to the Abiquo Server (API).

   

abiquo.m.accessTokenSecretOAuth secret access token that M should use to perform requests to the Abiquo Server (API).   

abiquo.m.consumerKey

OAuth consumer key that M should use to perform requests to the Abiquo Server (API). If these tokens are set, M will use OAuth authentication. Otherwise Basic Authentication will be used.

   

abiquo.m.consumerSecret

OAuth consumer secret that M should use to perform requests to the Abiquo Server (API).

   

abiquo.m.credential

Credentials that M should use to perform requests to the Abiquo Server (API).
Default: xabiquo

   

abiquo.m.identity

Identity that M should use to perform requests to the Abiquo Server (API).
Default: admin

   

4.7.1






Added




abiquo.nsx.static-edge-gateway

If false, when modifying the gateway of a network only update edge interface address if the new gateway is not in use in any lease of the DHCP

Default: true




abiquo.saml.attributes.user.email.claim

Indicates which SAML Response attribute must be read in order to find the user's email
Default: EmailAddress




abiquo.saml.attributes.user.firstname.claim

Indicates which SAML Response attribute must be read in order to find the user's name
Default: FirstName




abiquo.saml.attributes.user.lastname.claim

Indicates which SAML Response attribute must be read in order to find the user's last name
Default: LastName




abiquo.saml.binding

The URN of the binding profile to allow




abiquo.saml.cookie.maxage

Expiry time of cookie with access tokens after successful login in seconds
Default: 30




abiquo.saml.cookie.name

The name of the cookie created after a successful login
Default: ABQSAMLTOKENS




abiquo.saml.keys.encryption.alias

The alias of the encryption key stored in the keystore




abiquo.saml.keys.encryption.password

The password of the encryption key stored in the keystore




abiquo.saml.keys.keystore.password

Password to unlock the keystore file




abiquo.saml.keys.keystore.path

Path to the Java keystore containing the keys and certificates to encrypt and sign




abiquo.saml.keys.metadata.sign

Indicates if the SAML Requests must be signed
Default: false




abiquo.saml.keys.signing.alias

The alias of the signing key stored in the keystore




abiquo.saml.keys.signing.password

The password of the signing key stored in the keystore




abiquo.saml.metadata.generator.bindingSSO

Bindings to activate if the SP metadata must be generated by the API
Default: POST,Artifact




abiquo.saml.metadata.identityprovider.path

The path of the IDP metadata to load




abiquo.saml.metadata.mode

Indicates if the SP metadata is provided or must be generated by the API.
Default: generated
Range: generated, provided




abiquo.saml.metadata.serviceprovider.path

The path of the SP metadata to load if it is provided




abiquo.saml.mode

Indicates which SAML integration mode is desired: - single: only one SAML IDP Server is allowed to be configured; - multiple: allows abiquo basic auth and one SAML IDP Server
Default: single




abiquo.saml.redirect.endpoint

URI where the platform should redirect a successful Abiquo login using SAML SSO. Something like: https://<your.env>/ui




abiquo.saml.redirect.error.endpoint

URI where the platform should redirect an unsuccessful Abiquo login using SAML SSO.
Default: /error.html




abiquo.vcd.fenceVappWhen true, the vCloud virtual appliance network is NATROUTED: Retain IP/MAC across deployments. When false, the vCloud virtual appliance network is BRIDGED
Default: true



Changed




abiquo.auth.module

Whether Abiquo will authenticate via: database; database and LDAP/Active Directory; OpenID; or SAML.
Default: abiquo
Range: abiquo, ldap, openid, saml




Deleted




abiquo.m.accessToken

OAuth access token that M should use to perform requests to the Abiquo Server (API).

   

abiquo.m.accessTokenSecretOAuth secret access token that M should use to perform requests to the Abiquo Server (API).   

abiquo.m.consumerKey

OAuth consumer key that M should use to perform requests to the Abiquo Server (API). If these tokens are set, M will use OAuth authentication. Otherwise Basic Authentication will be used.

   

abiquo.m.consumerSecret

OAuth consumer secret that M should use to perform requests to the Abiquo Server (API).

   

abiquo.m.credential

Credentials that M should use to perform requests to the Abiquo Server (API).
Default: xabiquo

   

abiquo.m.identity

Identity that M should use to perform requests to the Abiquo Server (API).
Default: admin

   

4.7.2






No changes to properties in this version





...

Expand
titleClick here to show/hide properties changes to properties in 5.0.x


5.0.0







Added





abiquo.actionplan.webhook.client.connectionrequesttimeoutms

Action plan send web hook HTTP client, timeout in milliseconds used when requesting a connection from the connection manager. Zero is not allowed.
Default: 1000





abiquo.actionplan.webhook.client.connecttimeoutms

Action plan send web hook HTTP client, timeout in milliseconds until a connection is established. Zero is not allowed.
Default: 1000





abiquo.actionplan.webhook.client.maxclientsperroute

Action plan send web hook HTTP client, maximum clients per route.
Default: 10





abiquo.actionplan.webhook.client.maxkeepalivems

Action plan send web hook HTTP client, maximum total clients in pool.
Default: 120000





abiquo.actionplan.webhook.client.maxtotalclients

Action plan send web hook HTTP client, maximum total clients in pool.
Default: 50





abiquo.actionplan.webhook.client.redirects.enabled

Action plan send web hook HTTP client, follow redirect on hook response.
Default: false





abiquo.actionplan.webhook.client.sockettimeoutms

Action plan send web hook HTTP client, timeout in milliseconds for waiting for data or, put differently, a maximum period inactivity between two consecutive data packets). Zero is not allowed.
Default: 1000





abiquo.actionplan.webhook.client.ttlms

Action plan send web hook HTTP client, TTL in the pool in milliseconds.
Default: 5000





abiquo.amazon.waitforaccount.minutes

Default AWS wait for account creation
Default: 5





abiquo.auth.basic.restricted

If the true, the API only will allow the use of Basic Authentication on the login resource. The next API calls must use Token Authentication using as token the value of the header X-Abiquo-Token in login response.
Default: false





abiquo.azure.account.creation.appname

Name of the application registered during the account creation process on Azure.
Default: abiquo





abiquo.azure.account.creation.appredirecturi

Redirect URI for the application registered during the account creation process on Azure.
Default: https://abiquo.com





abiquo.azure.feign.logger.level

Logger level for Feign HTTP client.
Default: basic

Range: none, basic, headers, full




abiquo.vcd.firewall.vappnetwork

If true, create vCloud firewall at vCloud vApp network level
Default: false





5.0.1







Added





com.abiquo.esxi.webmks.proxypath

When ''com.abiquo.esxi.webmks'' is enabled, this property defines the path to a websocket proxy to avoid direct connection to ESX hosts. You can configure a different value for each datacenter on its Remote Services server. The default of no value means the UI will attempt to connect directly to ESX hosts.





abiquo.vcd.org.userRoleName

The name of the role for users created in vCloud Director. The role should be ''Organization Administrator'' or another role with equivalent privileges. The default value of "default" will use the role of the creator user.
Default: default





Deprecated in Abiquo 4.7.2





abiquo.nars.async.pool.avamar.maxAvamar deprecation

 

abiquo.nars.async.pool.avamar.byvdcAvamar deprecation




abiquo.virtualfactory.avamar.backup.openSessionAvamar deprecation




abiquo.virtualfactory.avamar.backup.openSession.byvdcAvamar deprecation




abiquo.backup.avamar.config.pathAvamar deprecation




5.0.4







Changed





abiquo.azure.feign.logger.level

Change default Logger level for Feign HTTP client.
Default: none








Excerpt

5.1.x


Expand
titleClick here to show/hide properties changes to properties in 5.1.x


5.1.0






Added




veeam.vcenter.ip

vCenter IP to use backup now (snapshot) functionality in ''Veeam95u4+snapshot'' backup plugin. Needs a value in API in order to load the plugin.



veeam.vcenter.password

vCenter password to use backup now (snapshot) functionality in ''Veeam95u4+snapshot'' backup plugin. Needs a value in API in order to load the plugin.



veeam.vcenter.port

vCenter port to use backup now (snapshot) functionality in ''Veeam95u4+snapshot'' backup plugin.
Default: 443



veeam.vcenter.user

vCenter user to use backup now (snapshot) functionality in ''Veeam95u4+snapshot'' backup plugin. Needs a value in API in order to load the plugin.



vmware.snapshot.keep

Maximum number of snapshots for a VM in vCenter. If the user performs an additional backup now then keep the new snapshot plus older snapshots up to this number. Applies to ''VMWARE_SNAPSHOT'' and ''Veeam95u4+snapshot'' backup plugins. Use '0' to keep all.
Default: 2




Changed in Abiquo 5.1




abiquo.backup.{backupplguin}.config.pathValid values are now veeam and networker



abiquo.nars.async.pool.{backupplugin}.max

Added - networker, veeam95u4
Deprecated - veeam80, veeam90




abiquo.nars.async.pool.{backupplugin}.byvdcAdded - networker, veeam95u4
Deprecated - veeam80, veeam90



abiquo.virtualfactory.{backupplugin}.backup.openSessionAdded - networker, veeam95u4
Deprecated - veeam80, veeam90



abiquo.virtualfactory.{backupplugin}.backup.openSession.byvdcAdded - networker, veeam95u4
Deprecated - veeam80, veeam90

Amendment

In the documentation of


5.1.1






New in Abiquo 5.
0.0, the new
1.1




abiquo.esxi.cloudinit.sata

For the CD device that configures cloud-init, if true, use the SATA disk controller.
If not specified or false, use IDE
Default: IDE


Image Added



Changed in Abiquo 5.1.1




abiquo.azure.feign.logger.level

Default value changed from basic to none


Image Added



abiquo.pluginmetadata.{HV}.diskControllers

Added to description "first [value] is used as default. Default ISO controller uses the order of supported controllers."
Added SATA to range of values. Default is now IDE, SCSI, SATA

Image Added




abiquo.nars.async.pool.{backupplugin}.max

Added - veeam10


Image Added



abiquo.nars.async.pool.{backupplugin}.byvdcAdded - veeam10


abiquo.virtualfactory.{backupplugin}.backup.openSessionAdded - veeam10


abiquo.virtualfactory.{backupplugin}.backup.openSession.byvdcAdded - veeam10


Amendment

In the documentation of Abiquo 5.0.0, the abiquo.azure.feign.logger.level property was omitted.



...