Changes to Abiquo configuration properties archive


3.8.x


 Click here to show/hide properties changes in 3.8.x
Property_______________________________Description
API
RS
V2V
OA

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

API



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





3.10.x


 Click here to show/hide properties changes in 3.10.x
Property_______________________________Description
API
RSV2VOA

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












4.0.x


 Click 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





4.2.x


 Click here to show/hide properties changes in 4.2.x
PropertyDescription

4.2.0






Added




abiquo.capturedhcp

Update DHCP during virtual machine capture
Default: false




abiquo.monitoring.max.statistic.period.days

Maximium period in days for statistical metrics queries through the API
Default: 7




abiquo.nsx.edge.datastore-policy

Allocation policy for selection of datastores to deploy Edge appliances.
Default: leastvms
Range: leastvms, mostspace




abiquo.rabbitmq.tls

Set to true if RabbitMQ server is SSL enabled
Default: false


abiquo.rabbitmq.tls.trustallcertificates

The platform will not enforce any server certificate authentication if set to true
Default: false


abiquo.vm.statsupdate.interval

Interval between executions of the virtual machine standardized stats updater in milliseconds
Default: 43200000




abiquo.vm.statsupdate.range.days

Number of days to consider in the statistic query executed by the virtual machine standardized stats updater
Default: 30




abiquo.watchtower.password

Watchtower password
Default: xabiquo



abiquo.watchtower.tls

Set to true if Watchtower server is SSL enabled
Default: false



abiquo.watchtower.tls.trustallcertificates

The platform will not enforce any server certificate authentication if true
Default: false



abiquo.watchtower.username

Watchtower username
Default: admin



Changed




abiquo.backup.check.delay

Delay between executions of the backup results check (milliseconds). Default is 10 minutes
Default: 600000
Change to default value




abiquo.nsx.edge.datastore-id

List of vCenter datastores where the Edge appliances will be deployed in CSV format with allocation according to abiquo.nsx.edge.datastore-policy
Changed to CSV list




Deprecated




com.abiquo.esxi.experimental.eagerzero.copy

If true, force eager zero thick provisioning on copied disks. Deprecated and replaced by Allocation attribute for VM templates and VM disks




com.abiquo.esxi.experimental.eagerzero.newIf true, force eager zero thick provisioning on new empty disks. Deprecated and replaced by Allocation attribute for VM templates and VM disks


Deleted




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.server.mail.authIf authentication is required to connect to the mail server
Default: true



4.2.1






Added




abiquo.cpp.cloudoorsphere.defaults.healthcheck.attempts

The load balancer health check attempts to return while syncing a load balancer
Default: 3




abiquo.cpp.cloudoorsphere.defaults.healthcheck.bodyregex

The load balancer health check body regex to return while syncing a load balancer




abiquo.cpp.cloudoorsphere.defaults.healthcheck.interval

The load balancer health check interval to return while syncing a load balancer
Default: 60000




abiquo.cpp.cloudoorsphere.defaults.healthcheck.path

The load balancer health check path to return while syncing a load balancer
Default: /




abiquo.cpp.cloudoorsphere.defaults.healthcheck.port

The load balancer health check port to return while syncing a load balancer
Default: 80




abiquo.cpp.cloudoorsphere.defaults.healthcheck.protocol

The load balancer health check protocol to return while syncing a load balancer
Default: http




abiquo.cpp.cloudoorsphere.defaults.healthcheck.statusregex

The load balancer health check status regex to return while syncing a load balancer
Default: 200




abiquo.cpp.cloudoorsphere.defaults.healthcheck.timeout

The load balancer health check timeout to return while syncing a load balancer
Default: 20000




abiquo.cpp.cloudoorsphere.defaults.loadbalancer.algorithm

The load balancer algorithm to return while syncing a load balancer
Default: round-robin




abiquo.cpp.cloudoorsphere.defaults.loadbalancer.instancetype

The instance type (hardware profile) to use when creating a load balancer
Default: t2.nano




abiquo.cpp.cloudoorsphere.loadbalancer.allowed.algorithms


The list of algorithms supported by the load balancers (comma-separated values)
Default: round-robin




abiquo.cpp.cloudoorsphere.loadbalancer.creation.timeout


Timeout to use while creating a load balancer and waiting for a finished status
Default: 600000




abiquo.cpp.cloudoorsphere.loadbalancer.deletion.timeout


Timeout to use while deleting a load balancer and waiting for a finished status because the API does not return this status
Default: 600000




abiquo.nsx.edge.description

Edge description. See Configure the NSX integration
Default: Managed by Abiquo
This property is obligatory in Abiquo 4.2.1+. You can add this property for the entire platform, or for each enterprise as "nsx.edge.description". You must add this property or the platform will not function (minus)


 



abiquo.nsx.edge.dhcp.size

Specify the size of the DHCP Edge appliance (ecmp plugin). See Configure the NSX integration
Default: compact
Range: compact, large, quadlarge, xlarge
This property is obligatory in Abiquo 4.2.1+. You can add this property for the entire platform, or for each enterprise as nsx.edge.dhcp.size. You must add this property or the platform will not function (minus)


 



abiquo.nsx.edge.esg.size

Specify the size of the ESG Edge appliance (gateway and ecmp plugin). See Configure the NSX integration
Default: compact
Range: compact, large, quadlarge, xlarge
This property is obligatory in Abiquo 4.2.1+. You can add this property for the entire platform, or for each enterprise as nsx.edge.esg.size. You must add this property or the platform will not function (minus)


 



abiquo.nsx.edge.plr-esg-id

ID of the Edge that acts as the PLR (nsx-nat only)


 



abiquo.nsx.edge.plr-transit-cidr

CIDR of the transit network to be used between the PLR and the Edges of each Abiquo VDC (nsx-nat only)


 



abiquo.nsx.edge.plr-transit-ip

Configure the IP to be used to connect the PLR to the plr-transit vSwitch (nsx-nat only). Optional, if not set, use the lowest address in "abiquo.nsx.edge.plr-transit-cidr"


 



abiquo.virtualfactory.cloudoorsphere.vmstate.retry.timeoutInMilliseconds

The timeout to get the state of a VM after a power action
Default: 1800000




cloudoorsphere.non-retryableA list of API calls that must not be retried after an error code in the response (comma-separated values)
Default: server:create



abiquo.vcd.connectionTimeoutMs

Time to wait to establish the connection to vCloud Director (milliseconds)
Default: 10000




abiquo.vcd.login.TimeoutMs

Maximum time to wait for login to vCloud Director (milliseconds)
Default: 60000




abiquo.vcd.readTimeoutMs

Maximum time to wait to read from the connection to vCloud Director (milliseconds)
Default: 30000




4.2.1






Added




abiquo.nsx.nat.protocols

 Allowed NAT rule protocols (nsx-nat only)
Default: TCP,UDP,ANY,ICMP#ANY,ICMP#Parameter-Problem,ICMP#Echo-Request,ICMP#Destination-Unreachable,ICMP#Redirect,ICMP#Router-Solicitation,ICMP#Time-Exceeded,ICMP#Address-Mask-Request,ICMP#Timestamp-Reply,ICMP#Router-Advertisement,ICMP#Timestamp-Request,ICMP#Address-Mask-Reply,ICMP#Echo-Reply,ICMP#Source-Quench


 



Changed




abiquo.nsx.edge.public-network-cidr

Network range where the "public" load balancer IPs will be taken from. It must be a range dedicated to Abiquo.
Deleted from NAT plugin, still used in gateway plugin



4.2.3






Added




abiquo.guest.password.length


Template to configure guest initial passwords that enables you to define the length and the character set. The following tokens are allowed in the template:

  • lower= –configures the number of lower case characters to generate
  • upper= –configures the number of upper case characters to generate
  • numbers= –configures the number of numbers to generate
  • symbols= –configures the number of special characters to generate.
  • global= –configures the number of total characters to generate.

For each token, the value must be in one of the following formats:

  • N –generate this exact number of characters
  • N-M –generate between N and M characters
  • N- –generate at least N characters.
  • -M –generate at most M characters

Examples:

  1. Password with at least 2 lower case and upper case letters, between 2 and 4 special characters, and a total length of 10 characters: 
    abiquo.guest.password.length = lower=2-,upper=2-,numbers=0,symbols=2-4,global=10
  2. Password with at least 5 characters, regardless of the content: abiquo.guest.password.length = global=5-

Default: lower=2-6,upper=2-6,numbers=2-6,symbols=2-6




abiquo.guest.password.exclude

Characters to avoid when generating guest passwords, for example: ,;$




abiquo.vcd.metric.live.force

Do not try to retrieve historical metrics data for vCloud Director, only use live metrics
Default: false




abiquo.vcd.metric.live.fallback

If it is not possible to retrieve historical metrics data for vCloud Director, attempt to use live metrics
Default: true




abiquo.vcd.parentnetwork

Private network connection to allow outgoing traffic in vCloud Director. Value can be "none" for isolated networks or any existing organization network name. The default value of "edge-uplink" will use the external network connected to the edge gateway of the organization virtual datacenter.
Default: edge-uplink




abiquo.virtualfactory.hyperv.automaticShutdownAction

Action to take for the VM when the host is shut down. Sets Msvm_VirtualSystemSettingData.AutomaticShutdownActionhttps://msdn.microsoft.com/en-us/Library/hh850257(v=vs.85).aspxwhen creating a VM. When it is set to "3", the state will be saved and swap files will be written; set their location with the swapFileDataRoot property.
Default: 3
Range: 2, 3, 4




abiquo.virtualfactory.hyperv.refreshMonitorJob.intervalms

Refresh interval in milliseconds for checking progress on operations that require monitoring of a job, such as disk copies.
Default: 1000




abiquo.virtualfactory.hyperv.sambaHosts

List of Samba hosts where the platform can discover shares to use as Hyper-V datastores. The list is in CSV format. Leave empty to not try discovery




abiquo.virtualfactory.hyperv.swapFileDataRoot

The path of a directory where swap files for the VM will be stored. When the automaticShutdownAction property is set to save the VM state, swap files will be written to this location.
Default: C:\ProgramData\Microsoft\Windows\Hyper-V





4.4.x


 Click here to show/hide properties changes in 4.4.x
PropertyDescription

4.4.0






Added




abiquo.amazon.waitforstatus.timeout

Default AWS wait for status timeout
Default: 1200000




abiquo.dnsmasq.serviceiface
Network interface onto which bridged VLAN interfaces will be attached



abiquo.dnsmasq.basedir

Folder in which to store lease information



abiquo.dnsmasq.startscript

Script to start a new instance of dnsmasq on a bridged VLAN interface



abiquo.dnsmasq.stopscript

Script to stop and clean up an instance of dnsmasq running on a bridged VLAN interface



abiquo.dnsmasq.reloadscript

Script to reload a running instance of dnsmasq




abiquo.oraclease.read-timeout-ms


Timeout to complete connections to the Oracle ASE manager (milliseconds). A value of 0 means no timeout
Default: 0




abiquo.oraclease.connection-timeout-ms

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


 



abiquo.oraclease.timeout

Timeout to get the state of a virtual machine
Default: 600


 



abiquo.oraclease.defaultLoginUser

ORACLE ASE default user for connecting to Linux VMs over SSH. For Windows VMs, edit the template and enter the Administrator username and password
Default: opc


 



abiquo.virtualfactory.azurecompute-arm.operationtimeout


The timeout to consider an operation failed in Azure ARM
Default: 46000000




abiquo.vsm.vmsyncforcedpublishcount.{PLUGIN}

    • vmx_04
    • esx
    • kvm
    • hyperv_301
    • oracle_vm
    • xenserver
    • amazon
    • vcd
    • azurecompute-arm
    • oracle-ase-emea
    • oracle-ase-us

Number of virtual machine synchronizer executions before force the publish of virtual machine definitions. The default value of 0 means never

Default: 0




Deleted




abiquo.virtualfactory. azure. defaultLoginPassword


Default password for virtual machines in Azure if not found in the template
Default: abqazure0!5




abiquo.virtualfactory. azure.defaultLoginUser

Default login for virtual machines in Azure if not found in the template.
Default: abiquo




abiquo.virtualfactory.azure.retry.timeBetweenTriesInSeconds

Time to wait between polls during a retry
Default: 30




abiquo.virtualfactory.azure.retry.timeoutInSeconds

Timeout retrying an operation
Default: 900




abiquo.virtualfactory.azure.storageAccountPrefix

Prefix of the name of the Azure Storage account created for deployments (one account per region).
Default: abiquostorage




abiquo.virtualfactory.azure.wait.timeBetweenTriesInSeconds

Time to wait between polls during an operation wait.
Default: 30




abiquo.virtualfactory.azure.wait.timeoutInSeconds

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




Changed




abiquo.vsm.actor.creation.delay.{PLUGIN}
    • vmx_04
    • esx
    • kvm
    • hyperv_301
    • oracle_vm
    • xenserver
    • amazon

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




abiquo.vsm.hostsyncfrequency.{HV}

    • vmx_04
    • esx
    • kvm
    • hyperv_301
    • oracle_vm
    • xenserver
    • vcd
    • oracle-ase-emea
    • orace-ase-us

Time between executions of infrastructure check in milliseconds
Default: 300000
Added oracle-ase-emea and oracle-ase-us




abiquo.vsm.pollingfrequency.{PC}

    • amazon
    • azurecompute-arm
    • digitalocean2
    • elastichosts-ams-e
    • elastichosts-hkg-e
    • elastichosts-lax-p
    • elastichosts-lon-b
    • elastichosts-lon-p
    • elastichosts-sat-p
    • elastichosts-sjc-c
    • cloudsigma2-lvs
    • cloudsigma2-zrh
    • cloudsigma2-hnl
    • cloudsigma2-sjc
    • cloudsigma2-wdc
    • google-compute-engine
    • openstack-nova
    • oracle-ase-emea
    • oracle-ase-us
    • packet
    • rackspace-cloudservers-us
    • rackspace-cloudservers-uk
    • softlayer

The delay between VSM polling of virtual machines in milliseconds for each public cloud plugin (PC).
Default: 300000
Delete azure and added oracle-ase-emea and oracle-ase-us




abiquo.vsm.vmsyncfrequency.{PLUGIN}

    • vmx_04
    • esx
    • kvm
    • hyperv_301
    • oracle_vm
    • xenserver
    • amazon
    • vcd
    • oracle-ase-emea
    • oracle-ase-us
    • azurecompute-arm

The delay between virtual machine synchronizer operations in milliseconds. for each hypervisor or public cloud plugin (PLUGIN)
Default: 180000
Deleted azure and added oracle-ase-emea, oracle-ase-us, and azurecompute-arm





4.5.x


 Click here to show/hide properties changes in 4.5.x
PropertyDescription

4.5.0






Added




abiquo.openid.client.acr-validation


Validate acr values from jwt token when authenticating with an OpenID Connect Server, if true
Default: true

 




abiquo.openid.client.acr-values


Space separated values to send as acr values to an OpenID Connect Server when authenticating and to validate from jwt token if 'acr-validation' property is true
Default: 

 




abiquo.openid.cookie.maxage

After OpenID authentication flow, the API redirect adds a cookie with the access_token and the id_token. The expiry of the OpenID authentication cookie in seconds. A negative value means that the cookie is not stored persistently and will be deleted when the web browser exits. A zero value causes the cookie to be deleted
Default: 30




abiquo.openid.cookie.refreshtoken.includeIf true, the OpenID authentication cookie will also contain the refresh token.
Default: false




abiquo.pluginmetadata.{HP}.ethernetDrivers


Override default plugin metadata to update the compatible ethernet driver
Default: E1000, VMXNET3, PCNET32, VIRTIO

 




abiquo.server.mail.from

The sender of platform email notifications
Default: abiquo.server.mail.user




abiquo.virtualfactory.azurecompute-arm.defaultloginname


The default login name if not specified by the imported ARM template or by editing the template in the platform
Default: abiquo




abiquo.virtualfactory.azurecompute-arm.defaultloginpassword


The default login password if not specified by editing the template in the platform
Default: Password123456!




abiquo.virtualfactory.{HP}.openSession

  • 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

The maximum number of simultaneous operations on a single hypervisor or provider region.
Default: abiquo.virtualfactory.openSession





abiquo.virtualfactory.{DEV}.device.openSession

  • openstack-neutron
  • dnsmasq
  • omapi
  • nsx-ecmp
  • logical
  • nsx-nat
  • nsx-gateway

The maximum number of simultaneous operations on a single device
Default: abiquo.virtualfactory.device.openSession




abiquo.virtualfactory.{BM}.backup.openSession

  • veeam95
  • veeam80
  • avamar

The maximum number of simultaneous operations on a single backup manager, by type
Default: abiquo.virtualfactory.backup.openSession




abiquo.virtualfactory.openSession.byvdc


If true, the maximum number of simultaneous operations applies to a single virtual datacenter (instead of single hypervisor)
Default: false




abiquo.virtualfactory.{HP}.openSession.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

If true, the max number of simultaneous operations applies to a single virtualdatacenter (instead of single hypervisor), by type.
Default: abiquo.virtualfactory.openSession.byvdc





abiquo.virtualfactory.device.openSession.byvdc


If true, the default maximum number of simultaneous operations applies to a single virtualdatacenter (instead of a single device)
Default: false




abiquo.virtualfactory.{DEV}.device.openSession.byvdc

  • openstack-neutron
  • dnsmasq
  • omapi
  • nsx-ecmp
  • logical
  • nsx-nat
  • nsx-gateway

If true, the default maximum number of simultaneous operations applies to a single virtualdatacenter (instead of a single device), by type
Default: abiquo.virtualfactory.device.openSession.byvdc




abiquo.virtualfactory.backup.openSession.byvdc


If true, the default maximum number of simultaneous operations applies to a single virtualdatacenter (instead of a single backup manager)
Default: false




abiquo.virtualfactory.{BM}.backup.openSession.byvdc

  • veeam95
  • veeam80
  • avamar

If true, the default maximum number of simultaneous operations applies to a single virtualdatacenter (instead of a single backup manager), by type
Default: abiquo.virtualfactory.backup.openSession.byvdc




abiquo.inactivitysession.maxinhours

Maximum hours without activity in a pool before release. The minimum value is 6 and if a lower value is specified, the platform will use 6
Default: 24




abiquo.virtualfactory.openSession.faststatechanges


If true, VM state changes (powerOn, powerOff, shutdown, reset, pause, resume) are executed outside the pool (not waiting for any operation)
Default: false




abiquo.virtualfactory.{HP}.openSession.faststatechanges

  • 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

If true, VM state changes (powerOn, powerOff, shutdown, reset, pause, resume) are executed outside the pool (not waiting for any operation), by type.
Default: abiquo.virtualfactory.openSession.faststatechanges




com.abiquo.esxi.experimental.vmgroup.gueststartswith.{OSprefix} Add newly deployed VMs to an existing VM group (naming convention is Lic_{clustername}_{osname}_VMs) using DRS rules when the template osType matches the OSprefix of a property. For example, to add Windows VMs to Lic_vcloudcluster_Windows_VMs, you could use "win" as the value of OSprefix,



Deleted




abiquo.heartbeat.autostart

Automatically start Abiquo heartbeat
Default: true

 




Changed




abiquo.virtualfactory.openSession


The default maximum number of simultaneous operations on a single hypervisor
Default: 2

Description changed from "maximum" to "The default maximum" due to the introduction of more specific properties




abiquo.virtualfactory.backup.openSession


The default maximum number of simultaneous operations on a single backup manager
Default: 2

Description changed from "maximum" to "The default maximum" due to the introduction of more specific properties




abiquo.virtualfactory.device.openSession


The default maximum number of simultaneous operations on a single device
Default: 2

Description changed from "maximum" to "The default maximum" due to the introduction of more specific properties




4.6.x


 Click 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


 Click 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






5.0.x


 Click here to show/hide properties changes 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





5.1.x


 Click here to show/hide properties changes 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



5.1.1






New in Abiquo 5.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




Changed in Abiquo 5.1.1




abiquo.azure.feign.logger.level

Default value changed from basic to none




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




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

Added - veeam10




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



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



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



5.1.2






New in Abiquo 5.1.2




abiquo.experimental.capturewithvolumes.bypassWhen true, for ESXi, import and capture VMs with volumes (except in position 0 in the disk sequence). The platform can capture the VMs but it does not register the external storage volumes as VM resources.
After you capture VMs, you can add the volumes to the platform as Generic iSCSI volumes. If you do not add the volumes as Generic iSCSI volumes and you wish to add more external volumes, in order to prevent issues with the unregistered volumes, add volumes to a new SCSI controller of a different type




abiquo.login.samesite

Specifies the value for the SameSite ABQOIDCTOKENS cookie. If "null" is set, the cookie will be sent without the SameSite flag.
Default: strict
Range: strict, lax, none, null




abiquo.virtualmachine.namesperdc

Allow unique VM name per datacenter or public cloud region instead of unique for the entire platform.
(warning)(warning)(warning) This property must have the same value on the Abiquo Server and all the Remote Services servers
Default: false


(warning)


5.2.x


 Click here to show/hide properties changes in 5.2.x
PropertyDescription


5.2.0







Added in Abiquo 5.2.0





abiquo.api.fileresults.path

Path to file storing pending results to be processed in the API.
Default: /opt/abiquo/results-api





abiquo.billing.task.cron

Cron expression to run the consolidation of usage and cost from public cloud providers.
Default: 0 30 0 ? * * *





abiquo.costusage.task.frequencyinhours

Frequency of running the consolidation of accounted usage.
Default: 24
Range: > 0





abiquo.draas.check.delay.seconds

Delay between executions of the DRaaS sync in seconds.
Default: 60





abiquo.draas.pg.journalhistory.hours

Default journal history hours for the protection groups.
Default: 24





abiquo.draas.pg.priority

Default priority for the protection groups.
Default: Medium
Range: Low, Medium, High





abiquo.draas.pg.rpo.seconds

Default recovery point objective for the protection groups in seconds.
Default: 180





abiquo.draas.recovery.cluster.name

Default host name where the DRaaS provider will recover the selected VMs.
Accepts wildcard (*) to match any string.
Default: *Cluster*




abiquo.draas.recovery.datastore.name

Default datastore name that the VMs will use when recovered by the DRaaS provider.
Accepts wildcard (*) to match any string.
Default: *datastore-local*




abiquo.draas.recovery.folder.name

Default folder name where the selected VMs will be recovered by the DRaaS provider.
Accepts wildcard (*) to match any string.
Default: /




abiquo.draas.recovery.network.name

Default network used for failover by the DRaaS provider.
Accepts wildcard (*) to match any string
Default: Draasnet




abiquo.draas.recovery.testnetwork.name

Default network used for failover test by the DRaaS provider.
Accepts wildcard (*) to match any string.
Default: DraasTestnet




abiquo.enterprise.property.billing.monthoffsetMonths of offset to regenerate and download bills back from current date. Regeneration is done with data from cost usage details.
Default: 2





abiquo.feign.connection.timeout.seconds

Connection timeout for Azure billing process in seconds
Default: 10




abiquo.feign.read.timeout.seconds

Read timeout for Azure billing process in seconds
Default: 60




abiquo.googlecloud.public.image.projects

Publishers list for Google Cloud with a list of project names in CSV format.
See https://cloud.google.com/compute/docs/images/os-details
Default: centos-cloud,cos-cloud,debian-cloud,fedora-coreos-cloud,rhel-cloud,rhel-sap-cloud,suse-cloud,suse-byos-cloud,suse-sap-cloud,ubuntu-os-cloud,windows-cloud,windows-sql-cloud





abiquo.googlecloud.waitforstartupscript.retry.seconds

Google Cloud time to retry when waiting for startup script to run.
Default: 10




abiquo.googlecloud.waitforstartupscript.timeout.seconds

Google Cloud timeout when waiting for startup script to run.
Default: 1200




abiquo.googlecloud.waitforstatus.retry.seconds

Google Cloud time to retry in wait for status.
Default: 5





abiquo.googlecloud.waitforstatus.timeout.seconds

Default Google Cloud wait for status timeout.
Default: 180




abiquo.nars.async.fileresults.path

Path to file storing pending results to be downloaded by the API. if the same datacenter is using multiple NARS instances, then this path should be a shared folder accessible from all the NARS in the same datacenter. This is because the async task can be processed by any NARS instance but the API will request the download from the IP of the Remote Service in the database.
Default: /opt/abiquo/results-nars




abiquo.plugin-client.timeout.download

API to NARS HTTP client configuration: milliseconds to wait for a download to be completed.
Default: 600000





abiquo.pricing.credentials.check.delayInHrsDelay between executions of the pricing credentials check (hours)
Default: 720





abiquo.subscriptions.check.delayInHrs

Frequency in hours of the periodic check to clean up orphan VSM subscriptions for VMs that do not exist any more.
Default: 24





abiquo.tagging.synccheckcron

Cron expression to execute the periodic tag synchronization by enterprise
Default: 0 0 */4 ? * *





zerto.feign.logger.level

Logger level for Feign HTTP client.
Range: none, basic, headers, full
Default: none





zerto.polling.delay.seconds

Delay between polling requests to update Zerto tasks status.
Default: 60





zerto.propagation.delay.seconds

Wait time that finished Zerto tasks require to propagate the changes.
Default: 10





zerto.ssl.allow.insecure

Allow Zerto plugin to use insecure connections
Default: false





Changed in Abiquo 5.2





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

  • zerto

For zerto you must set this value to 1

  • Default: 1




abiquo.virtualfactory.{plugin}.defaultloginname

  • googlecloudplatform

Added googlecloudplatform





abiquo.virtualfactory.{plugin}.defaultloginpassword

  • googlecloudplatform
Added googlecloudplatform




Deleted in Abiquo 5.2.0





abiquo.azurecompute-arm.vpn.virtualnetworkgateway.check.maxperiod






abiquo.azurecompute-arm.vpn.virtualnetworkgateway.check.period






abiquo.azurecompute-arm.vpn.virtualnetworkgateway.check.timeout






abiquo.azurecompute-arm.vpn.virtualnetworkgateway.check.timeunit






abiquo.azurecompute-arm.vpn.virtualnetworkgateway.sku.capacity






abiquo.azurecompute-arm.vpn.virtualnetworkgateway.sku.tier






5.0.6 - changes included in 5.2.0







New





abiquo.azure.account.creation.app.directoryrole.templateid

Role template ID of the Directory role to be assigned to the application created by Create account.
The default is the role template ID of the "User Administrator" role.
See https://docs.microsoft.com/en-us/graph/api/resources/directoryroletemplate?view=graph-rest-1.0
Default: fe930be7-5e62-47db-91af-98c3a49a38b1





Deprecated





abiquo.azure.account.creation.appredirecturi




5.0.7 - changes included in 5.2.0







New





abiquo.azure.account.creation.organizationregistrationnumber.countries

The ISO 3166-1 alpha-2 code of the countries for which an organization registration number must be specified, in CSV format. Note that for all these countries, phone number will also be required. Only used for field verification before actual customer creation is performed.
See https://docs.microsoft.com/en-us/partner-center/develop/customer-resources#customercompanyprofile
Default: am,az,by,hu,kz,kg,md,ru,tj,uz,ua





abiquo.azure.account.creation.default.organizationregistrationnumberDefault organization registration number used in account creation if the country requires organization registration number, but the number is not provided.
Default: ABQDEFAULT




abiquo.azure.account.creation.default.phone

Default phone number used in account creation if the country requires organization registration number, but the phone number is not provided.
Default: ABQ-PHONE





5.0.8 - changes included in 5.2.0







New





abiquo.azure.account.creation.polling.delay.seconds

Delay between polling requests for account creation
Default: 10





5.0.9 - changes included in 5.2.0







New





abiquo.azure.account.creation.resource.provider.polling.delay.minutes

Delay in minutes between resource provider registration wait polling requests.
Default: 1





abiquo.azure.account.creation.resource.provider.timeout.minutes

Timeout used for resource provider registration wait.
A value of 0 will disable the wait and the account creation will not wait for registration of the resource providers to complete before finishing the process.
Default: 20





5.0.10 - changes included in 5.2.1







abiquo.azure.feign.connection.timeout.seconds

Connection timeout for Azure billing process in seconds
Default: 10
Name changed from abiquo.feign.connection.timeout.seconds



(warning)

abiquo.azure.feign.read.timeout.seconds

Read timeout for Azure billing process in seconds
Default: 60
Name changed from abiquo.feign.read.timeout.seconds




(warning)

5.1.3 - changes included in 5.2.1







abiquo.fqdn.label.pattern

Pattern to check between "." in VM FQDN and network DNS suffix
Default: [a-zA-Z](([a-zA-Z0-9-]{1,61})?[a-zA-Z0-9])?





5.2.1







New in Abiquo 5.2.1





com.abiquo.esxi.discovery.datastore.ignorebyname

If specified filter datastores by name and for filtered datastores, the platform will not check if is mounted or for the abiquo folder UUID. For example, 'some.*' will discard any datastore starting with 'some' and '.*some.*' will discard any datastore containing 'some'. Comma separated list of java patterns.





abiquo.amazon.sleepbeforetry.seconds


Default wait time between retries on AWS account creation
Default: 2





abiquo.amazon.waitforassumerole.minutes

Default AWS wait for assume role
Default: 5





abiquo.saml.metadata.identityprovider.default.idThe ID of the default IdP. You must add this property to all SAML environments. If you do not set a default IdP, the API tomcat server will not start




(minus)

abiquo.saml.metadata.identityprovider.userdomain.map

Specify user domains and the IdPs to use for them. Allows comma separated equalities. For example, somedomain.com=someIdP,anotherdomain.com=anotherIdP





zerto.task.timeout.seconds

# The timeout to get a response from a provider task
Default: 300





Changed in Abiquo 5.2.1





abiquo.saml.metadata.identityprovider.path

The path of the IdP metadata to load. Supports comma separated values for multiple IdP file paths

Added support for multiple IdP file paths with comma separated values





abiquo.saml.redirect.error.endpoint

URI where the platform should redirect an unsuccessful Abiquo login using SAML SSO. This has to be set to a queryparameter "?error" or a valid URI like the one from the example.
Example: https://your.env.com/ui/?error=ERROR_CODE
Default: ?error

Default value changed from /error.html





abiquo.vsm.vmmetrics.collectfrequency.googlecloudplatformDefault value for googlecloudplatform changed to 300000




5.2.2







New in 5.2.2, also in 5.0.11





abiquo.saml.login.allow.enterprise.pool

Allow the use of multiple enterprises with the same enterprise claim property as a pool. Will assign the user to the first enterprise match. Only valid for "SAML" mode, not for "SAML + user" (multiple IDPs).
Default: false





Amendments

  • In Abiquo 4.6.0, the "abiquo.plugin-client.pool.checkconnectionms" property was name documented with an error in the last section as "checkconnections"
  • In Abiquo 5.0.0, the "abiquo.azure.feign.logger.level" property was omitted.
  • In Abiquo 5.1.2, the "abiquo.virtualmachine.namepervdc" property MUST be configured on the Abiquo Server and the Remote Services server with the same value on all servers.


5.3.x


 Click here to show/hide the changes to properties in 5.3.x...
PropertyNotes

OA

5.3.0






Deprecated in 5.3.0




abiquo.virtualmachine.namesperdcThe provider ID replaces the VM name as the unique identifier of a deployed VM, so now there is no restriction on duplicate VM names in Abiquo.




ALL "oracle-ase" and "oraclease" propertiesThis deprecated provider will be replaced with OCI in future versions.



Added in Abiquo 5.3.0




abiquo.vsm.vmsyncmode.fetchall.{plugin}

  • vcenter_cluster
  • vmx_04
Forces VSM's VirtualMachineDefinitionsSyncOp to fetch all VMs before looking for differences in virtual machine definitions
Default: true




abiquo.billing.azure.country_codeTwo character country code for azure REST API calls for "standard" subscriptions (not CSP)
Default: ES




abiquo.billing.execution.limit

Number of total allowed billing executions in a day for a single set of pricing credentials. For unlimited executions, set to 0.
Default: 2




5.3.1






No changes to properties in 5.3.1




5.4.x


 Click here to show/hide changes to properties in 5.4.x


5.4.0






Added in 5.4.0

Description

API

RS

V2V

OA

abiquo.ec2billing.parser.lineItemType.ignore

Values to filter out from column lineItem/lineItemType from AWS billing CSVs. Configure on the server running the public cloud billing integration (usually the API server)


BILLING




abiquo.events.list.daysoffset

Days offset to consider by default in list of platform events
Default: 7

API




abiquo.nsxt.dhcp.leasetime-ms

Time to keep the lease in the NSX-T DHCP
Default: 86400


RS


abiquo.nsxt.infra.dhcp-conf-name

Name of the NSX-T DHCP Profile used to create Tier-1 VPCs. NSX-T UI path is: Policy - Networking - IP Management - DCHP

API




abiquo.nsxt.infra.edge-cluster-name

Name of the NSX-T Edge Cluster used to create Tier-1 VPCs. NSX-T UI path is: Policy - System - Fabric - Nodes - Edge Clusters

API




abiquo.nsxt.infra.load-balancers.error-log-level

Error log level of the NSX-T Load Balancers Valid values are: INFO, WARNING, ERROR, CRITICAL, ALERT, EMERGENCY
Default: INFO


RS


abiquo.nsxt.infra.load-balancers.reserved-ips

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


RS


abiquo.nsxt.infra.load-balancers.size

Size of the NSX-T Load Balancer. Valid values are: SMALL, MEDIUM, LARGE, XLARGE
Default: SMALL


RS


abiquo.nsxt.infra.tier0-name

Name of the NSX-T Tier-0 used to create the Tier-1 VPCs. NSX-T UI path is: Policy - Networking - Tier-0 Gateway

API




abiquo.nsxt.infra.tier1.pool-allocation

Edges Pool Allocation Size defined at Tier-1 Valid values are: ROUTING, LB_SMALL, LB_MEDIUM, LB_LARGE, LB_XLARGE
Default: LB_SMALL


RS


abiquo.nsxt.infra.transport-zone-name

Name of the NSX-T Transport Zone (overlay) used to create segments / networks. NSX-T UI path is: Policy - System - Fabric - Transport Zones

API




abiquo.nsxt.polling-ms

Time to wait between check on the NSX-T API
Default: 3000


RS


abiquo.oci.default.polling.delay.seconds

OCI wait polling delay
Default: 30


RS


abiquo.oci.default.polling.termination.seconds

OCI wait polling termination
Default: 600


RS


abiquo.oci.public.subnet.mask

OCI Mask to use when creating the public subnet
Default: 24


RS


abiquo.oci.retry.delay.seconds

OCI Time to wait to retry an API call
Default: 5


RS


abiquo.oci.retry.max

OCI Max number of API call retry
Default: 10


RS


5.4.1






Added in 5.4.1

Description

API

RS

V2V

OA

abiquo.auth.token.validseconds

Time in seconds for the Abiquo authorization token to expire. This token is returned by the API in the X-Abiquo-Token header.
Default: 1´800

API




abiquo.ec2billing.parser.lineItemType.ignore


Values to filter out from column lineItem/lineItemType from AWS ec2billing CSVs.
(warning) possible error

(warning)

RS



abiquo.nsxt.infra.tier0-external-ip

External IP used by the Tier-0.


RS

Changed in 5.4.1




abiquo.backup.{plugin}.config.path

  • rubrik
Added rubrik

RS



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

  • nsxt
  • rubrik
Added nsxt and rubrik

RS



abiquo.virtualfactory.{plugin}.backup.openSession

  • rubrik

Added rubrik


RS



abiquo.virtualfactory.{plugin}.backup.openSession.byvdc

  • rubrik

Added rubrik


RS



abiquo.virtualfactory.{plugin}.device.openSession

  • nsxt
Added nsxt

RS



abiquo.virtualfactory.{plugin}.device.openSession.byvdc

  • nsxt
Added nsxt

RS



Amended in 5.4.1




abiquo.nsx.virtualwire.teaming

Added to properties page

API




5.4.6






Added in 5.4.6 and 6.0.1




abiquo.azure.billing.parser.lineitem.publisher.ignore

Publishers to filter out Azure billing line items. Configure on the server running the public cloud billing integration (usually the API server).

Example value to filter out Office products: Microsoft Corporation

BILLING







6.0.x

For Abiquo 6.0.x, see Changes to Abiquo configuration properties.



6.1.x

For Abiquo 6.1.x, see Changes to Abiquo configuration properties.

Copyright © 2006-2024, Abiquo Holdings SL. All rights reserved