Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents
maxLevel1
typeflat

...

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


Property_______________________________Description

3.8.0






Disabled




abiquo.api.max.sessionsThis property has been temporarily disabled and will be enabled in future releases



Added




abiquo.esxi.datastoreVmFile

The datastore to hold the VM definition file when deploying VMs with only volumes attached. If there are standard disks, use the datastore of one of these disks, otherwise use the property. The default value is defined by 'abiquo.esxi.datastoreRdm'.

 

  

abiquo.monitoring.enabled

Enable/disable monitoring, alarms and alerts
Default: false

  

abiquo.neutron.external-net

Name of the gateway network in Neutron where routers will be connected. This network is the one that connects the Neutron internal networks to the world.
Default: abq-external

 

  

abiquo.neutron.region

The region that configures the Neutron endpoint in the Keystone installation. By default Abiquo will use the value of the 'abiquo.datacenter.id' property.

 

  

abiquo.neutron.reserved-ips

Number of IP addresses that are reserved for Neutron in each network. For each network, Neutron needs at least: one address for the DHCP agent, one for the network gateway, one for the network router, and one for each load balancer. This has to be taken into account when planning the number of IPs reserved for Neutron, as it will determine the total number of load balancers that users will be able to create in each network.
Default: 20

 

  

abiquo.neutron.vlan-physical-net

Name of the physical network in Neutron where the VLANs created from Abiquo will be attached.
Default: abq-vlans

 

  

abiquo.vappspec.retrydelayms

Milliseconds to wait before retrying a virtual appliance spec materialization in the same virtual datacenter.
Default: 15000

   

abiquo.vappspecpool

Number of concurrent virtual appliance spec materialization operations at a given time (not in the same virtual datacenter).
Default: 3

   

abiquo.watchtower.host

Address where watchtower is located for monitoring use
Default: 127.0.0.1

  

abiquo.watchtower.port

Port where watchtower is listening for monitoring use
Default: 36638

  
Changed




abiquo.rabbitmq.username

RabbitMQ username
Default: abiquo

 

abiquo.rabbitmq.password

RabbitMQ password
Default: abiquo

 
abiquo.instance.targetDiskFormatType.hyperv_301

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

There is no default value for Hyper-V so that the result format will be the same as the original template (VHD or VHDX)




Deleted




abiquo.kairosdb.hostAddress where KairosDb is located for VM monitoring



abiquo.kairosdb.portPort where KairosDb is listening for VM monitoring



3.8.1






No changes to properties in this version




3.8.2






Added




abiquo.nsx.edge.cluster-id

vCenter cluster where the Edge appliances will be deployed.

 

  

abiquo.nsx.edge.datastore-id

vCenter datastore where the Edge appliances will be deployed.

 

  

abiquo.nsx.edge.dvportgroup-id

vCenter distributed port where the uplink interfaces of the Edges will be attached.

 

  

abiquo.nsx.edge.public-network-cidr

Configure primary addresses of Edge uplink interfaces from this pool.

 

  

abiquo.nsx.load-balancer-reserved-ips

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

 

  

abiquo.nsx.transport-zone

The transport zone that logical switches will be connected to.

 

  
Changed




abiquo.esxi.metrics.{METRIC}
  • cpu
  • cpu-mz
  • cpu-time
  • memory
  • memory-swap
  • memory-swap2
  • memory-vmmemctl
  • memory-physical
  • memory-host
  • disk-latency
  • uptime

To prevent Abiquo from retrieving metrics, set the property to false for each ESXi metric (METRIC) you do not wish to retrieve. After you change these properties, restart the Monitor Manager (VSM) remote service for the properties to take effect.
Default: true
Range: true,false

In version 3.8 and 3.8.1, the name of these properties was "esx" instead of "esxi"



 

3.8.3






Added




abiquo.nsx.connection-timeout-ms

Timeout to establish connections to the NSX manager in milliseconds. A value of 0 means no timeout.
Default: 0

 

  

abiquo.nsx.read-timeout-ms

Timeout to complete connections to the NSX manager in milliseconds. A value of 0 means no timeout.
Default: 0

 

  

abiquo.nsx.use-edge-dhcp

Configure DHCP in Edge only for selected network types. The default is all network types (comma separated values).
Default: internal, external, public, unmanaged

 

  
Changed




abiquo.dvs.enabled

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



 

3.8.4/5






Changed




abiquo.storage.forcesamecontrollertype

If true, the controller and controller type for all additional disks will be the same one defined for the first template disk.
Default: false



 

3.8.6






Changed




abiquo.auth.module

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



 

abiquo.openid.authorization.endpoint

The OpenID Connect authorization endpoint. This endpoint must be accessible from the user's browser

   

abiquo.openid.client.id

The ID of the client that has been registered in the OpenID Connect server for the Abiquo platform.

   

abiquo.openid.client.name

The name of the client that has been registered in the OpenID Connect server for the Abiquo platform.

   

abiquo.openid.client.redirect-uris

Comma separated list of allowed redirect (callback) URIs used during the authentication flow. Must be: http://<api endpoint>/api/openid_connect_login

   

abiquo.openid.client.scopes

Comma separated list of scopes to request during authentication. Must have, at least: openid,profile,email.

   

abiquo.openid.client.secret

The secret of the client that has been registered in the OpenID Connect server for the Abiquo platform.

   

abiquo.openid.endsession.endpoint

(Optional) If configured, Abiquo will attempt to perform a global logout by performing a request to this endpoint. This is part of the Session Management optional spec. This endpoint must be accessible from the user's browser

   

abiquo.openid.enterprise-claim

The name of the claim returned by the authorization server that contains the names used to map the Abiquo enterprise where the user belongs.

   

abiquo.openid.enterprise-property

(Optional) If present, Abiquo will try to find an enterprise that has a property with the name configured in this Abiquo property, and use its value to match the "enterprise claim" when resolving the user's enterprise. If absent, Abiquo will just look for an enterprise with the name returned in the "enterprise claim".

   

abiquo.openid.issuer

The OpenID Connect authorization issuer.

   

abiquo.openid.role-claim

The name of the claim returned by the authorization server that contains the names used to map the user permissions to an Abiquo role.

   

abiquo.openid.target

The URL where the user will be redirected from the OpenID connect server upon successful authentication. Something like http://<abiquo ui host>/ui/#/dashboard

   

abiquo.openid.jwks.endpoint

The OpenID Connect JWKS endpoint. This endpoint must be accessible from the Abiquo server

   

abiquo.openid.token.endpoint

The OpenID Connect token endpoint. This endpoint must be accessible from the Abiquo server

   

abiquo.openid.userinfo.endpoint

The OpenID Connect user info endpoint. This endpoint must be accessible from the Abiquo server

   


...

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


Property_______________________________Description

3.10.0






Added




abiquo.vsm.pollingfrequency.azurecompute-arm

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

 

  

abiquo.pcr.template.check.delay

Delay between executions of the public cloud provider templates check (milliseconds). Default is 12 hours
Default: 43200000

   
jclouds.azurecompute.arm.publishersjclouds property. See Microsoft Azure ARM Integration



Deleted




abiquo.vsm.pollingfrequency.hpcloud-compute

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

 

  

abiquo.openstack.autoAllocateFloatingIps

If true, 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

If true, enable automatic generation of key pairs. This will make sure that the owner of the virtual machines will have SSH access to the deployed virtual machines.

 

  

abiquo.server.sessionTimeout

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

   

3.10.1






No changes to properties in this version




3.10.2






Added




abiquo.pluginmetadata.{HV}.baseDiskFormatType

  • vmx_04
  • kvm
  • hyperv_301
  • oracle_vm
  • xenserver

Override default plugin metadata to update the preferred format when requesting compatible conversions. This format should be included in the 'compatibleDiskFormatTypes' list. Allowed values: any DiskFormatType; For more information and default values. See Template Compatibility Table.
Default: VMDK_FLAT

   

abiquo.pluginmetadata.{HV}.compatibleDiskFormatTypes

  • vmx_04
  • kvm
  • hyperv_301
  • oracle_vm
  • xenserver

Override default plugin metadata to update the list of compatible formats. Allowed values: any DiskFormatType. List of comma separated values, should contain 'baseDiskFormatType'. See Template Compatibility Table.
Default: VMDK_FLAT,VMDK_SPARSE 

   

abiquo.pluginmetadata.{HV}.diskControllers

  • vmx_04
  • kvm
  • hyperv_301
  • oracle_vm
  • xenserver

Override default plugin metadata to update the compatible controller. Allowed values: any DiskControllerType. List of comma separated values; first is used as default. Possible values are SCSI, IDE, VIRTIO
Default: SCSI,IDE 

   

3.10.3






Added




com.abiquo.esxi.experimental.eagerzero.copyIf true, force eager zero thick provisioning on copied disks 
  
com.abiquo.esxi.experimental.eagerzero.newIf true, force eager zero thick provisioning on new empty disks 
  

3.10.4






Added










com.abiquo.esxi.disk.enableuuid

Present Disk UUID as SCSI serial number in the guest OS
Default: true

 

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



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



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



com.abiquo.esxi.experimental.customize.configure.periodms

Polling interval for checking if guest tools is up and running after power on. The default value is 10 seconds
Default: 10000




com.abiquo.esxi.experimental.customize.configure.timeoutms

Time to wait for guest tools to get up and running after power on. The default value is 15 minutes
Default: 90000




com.abiquo.esxi.experimental.customize.win.unattendfile

Optional path to custom unattend file on the Remote Services server. Abiquo will replace the variables $adminPassword and $hostName
Default: /opt/abiquo/config/my_unattend.xml




3.10.5






Added




abiquo.mail.charset

Character set to be used in email notifications
Default: UTF-8

   

3.10.6






Added




com.abiquo.esxi.experimental.customize.waitpassword.periodms

Prevent the user from logging in before the guest customizations have applied the password. Wait in milliseconds between checks for the password set by guest customizations
Default: 10000




com.abiquo.esxi.experimental.customize.waitpassword.timeoutms

Timeout in milliseconds for checks for the password set by guest customizations. The default value of 0 means that the timeout is not activated. To activate it set a value, such as 9000000 ms (15 minutes)

Default: 0




com.abiquo.esxi.experimental.avoidvmxswap

Whether the platform should avoid swap or not.
Default: false

 
  
com.abiquo.esxi.experimental.memory.allocation

Set virtual machine memory reservation.
Default: 0

 
  

3.10.7






Changed




abiquo.openid.client.scopes

Comma separated list of scopes to request during authentication. Must have, at least: openid,profile,email.
Abiquo 3.10.7 added support for phone

   







...

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 whitelist 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 previously whitelisted profiles 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





...

Excerpt

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