Abiquo 5.4

Skip to end of metadata
Go to start of metadata

Introduction to Abiquo Properties

The platform stores the configuration in the abiquo.properties file in Java properties format. There is one file on each server of the Abiquo platform (Abiquo Server, Remote Services, V2V Services). By default this file is located in the /opt/abiquo/config/ folder. The Abiquo Installer will create configuration files for your installation and example configuration files can be found in the directory /opt/abiquo/config/examples. 

The platform uses the default values if you do not set the properties. However, some default configuration options may also be set outside of the Abiquo platform, for example, in the hypervisor. 

To change the configuration options:

  1. Edit the abiquo.properties file and add the properties you wish to change, then specify the new values. 
    1. Check carefully to ensure you have the correct values
    2. Check that there is no white space around the properties
  2. After you edit the file, restart the abiquo-tomcat service for the changes to take effect 


Changes to Properties

For full details and changes to other versions, see Changes to Abiquo Configuration Properties

Changes to Abiquo Configuration Properties List

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

5.4.0





Added in 5.4.0

API

RS

V2V

OA

abiquo.ec2billing.parser.lineItemType.ignore

BILLING

 


 

abiquo.events.list.daysoffset

API

 


 

abiquo.nsxt.dhcp.leasetime-ms

 

RS

 

abiquo.nsxt.infra.dhcp-conf-name

API



 

abiquo.nsxt.infra.edge-cluster-name

API



 

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

 

RS

 

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

 

RS

 

abiquo.nsxt.infra.load-balancers.size

 

RS

 

abiquo.nsxt.infra.tier0-name

API



 

abiquo.nsxt.infra.tier1.pool-allocation

 

RS

 

abiquo.nsxt.infra.transport-zone-name

API



 

abiquo.nsxt.polling-ms

 

RS

 

abiquo.oci.default.polling.delay.seconds

 

RS

 

abiquo.oci.default.polling.termination.seconds

 

RS

 

abiquo.oci.public.subnet.mask

 

RS

 

abiquo.oci.retry.delay.seconds

 

RS

 

abiquo.oci.retry.max

 

RS

 

5.4.1





Added in 5.4.1



abiquo.auth.token.validseconds

API



abiquo.ec2billing.parser.lineItemType.ignore


RS



abiquo.nsxt.infra.tier0-external-ip

API




Changed in 5.4.1 (added plugins)



abiquo.backup.{plugin}.config.path

  • rubrik

RS



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

  • nsxt
  • rubrik

RS



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

  • nsxt
  • rubrik

RS



abiquo.virtualfactory.{plugin}.backup.openSession

  • rubrik

RS



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

  • rubrik

RS



abiquo.virtualfactory.{plugin}.device.openSession

  • nsxt

RS



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

  • nsxt

RS



Amended in 5.4.1



abiquo.nsx.virtualwire.teaming

API






Key to the Abiquo Configuration Properties Table

  • Range: all range values are inclusive
  • Default: value for the platform. The hypervisor or provider may have a different default configuration
  • Info column symbols

(star)  – New property 
(warning)  – Changed property
(minus) – Deprecated Property

  • Abiquo Servers

API – Abiquo Server / API
RS – Remote Services
V2V – V2V Remote Services 
OA – Outbound API
  

This table describes the abiquo.properties files of the Abiquo platform servers. For example, if a property is marked with an API symbol  in the API column, you can configure it in the abiquo.properties file on the Abiquo Server/API and Abiquo Monolithic Server.

Abiquo Configuration Properties Table

 

Property

Description

API

RS

V2V

OA

abiquo.2fa.email.timestep

Timestep for the email provider. This is the amount of time the two-factor authentication codes will be valid when generated (seconds).
Default: 60

API

 

 

 

abiquo.2fa.issuer

Name of the issuer of the verification codes for two-factor authentication. This will appear in the user's Google Authenticator app to identify where the generated code comes from.
Default: Abiquo

API

 

 

 

abiquo.abiquo.task.ttl

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

API

 

 

 

abiquo.actionplan.webhook.client.connectionrequesttimeoutms

For the HTTP client that sends a web hook in action plans, timeout in milliseconds used when requesting a connection from the connection manager.
Default: 1000
Valid values: >0

API

 

 

 

abiquo.actionplan.webhook.client.connecttimeoutms

For the HTTP client that sends a web hook in action plans, timeout in milliseconds until a connection is established.
Default: 1000
Valid values: >0

API

 

 

 

abiquo.actionplan.webhook.client.maxclientsperroute

For the HTTP client that sends a web hook in action plans, maximum clients per route.
Default: 10

API

 

 

 

abiquo.actionplan.webhook.client.maxkeepalivems

For the HTTP client that sends a web hook in action plans, maximum time to live in pool.
Default: 120000

API

 

 

 

abiquo.actionplan.webhook.client.maxtotalclients

For the HTTP client that sends a web hook in action plans, maximum total clients in pool.
Default: 50

API

 

 

 

abiquo.actionplan.webhook.client.redirects.enabled

For the HTTP client that sends a web hook in action plans, if true, follow redirects in web hook responses
Default: false

API

 

 

 

abiquo.actionplan.webhook.client.sockettimeoutms

For the HTTP client that sends a web hook in action plans, timeout in milliseconds for waiting for data or, put differently, a maximum period of inactivity between two consecutive data packets.
Default: 1000
Valid values: >0

API

 

 

 

abiquo.actionplan.webhook.client.ttlms

For the HTTP client that sends a web hook in action plans, TTL in the pool in milliseconds.
Default: 5000

API

 

 

 

abiquo.amazon.loadbalancer.healthcheck.healthythreshold

The number of consecutive health probe successes required before moving an AWS instance to the Healthy state.
Default: 3
Valid values: 2-10

 

RS

 

 

abiquo.amazon.public.subnet.mask

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

 

RS

 

 

abiquo.amazon.sleepbeforetry.seconds

Wait time between retries to create an AWS account
Default: 2

 

RS

 

 

abiquo.amazon.waitforaccount.minutes

AWS wait for account creation
Default: 5

 

RS

 

 

abiquo.amazon.waitforassumerole.minutes

AWS wait for assume role
Default: 5

 

RS

 

 

abiquo.amazon.waitforstatus.timeout

AWS wait for status timeout
Default: 1200000

 

RS

 

 

abiquo.api.fileresults.path

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

API

 

 

 

abiquo.api.login.failurelapse

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

API

 

 

 

abiquo.api.login.maxtries

Maximum login failures in a given lapse (abiquo.api.login.failurelapse).
Default: 3

API

 

 

 

abiquo.api.max.sessions

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

API

 

 

 

abiquo.api.networking.allowMultipleNicsVlan

Allow one NIC only per VLAN on a VM if false (or any other value).
Default: True

API

 

 

 

abiquo.api.networking.nicspervm

Limit of NICs per VM. If this is set to 0, there are no limits.
Default: 0

API

 

 

 

abiquo.api.session.cookie.name

Abiquo session cookie name. This session does not store anything.
Default: ABQSESSIONID

API

 

 

 

abiquo.api.zk.serverConnection

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

API

 

 

 

abiquo.appliancemanager.check.repository

Datacenter NFS repository refresh interval (milliseconds).
Default: 600000

 

RS

 

 

abiquo.appliancemanager.checkMountedRepository

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

 

RS

 

 

abiquo.appliancemanager.client.timeoutInMilliseconds

Timeout for HTTP connections to the ApplianceManager server when using the ApplianceManager client. This property configures read and connection timeout in milliseconds.
Default: 60000

 

RS

 

 

abiquo.appliancemanager.deploy.connection

Timeout for HTTP connections to be established when downloading a VM template (milliseconds).
Default: 120000

 

RS

 

 

abiquo.appliancemanager.deploy.idle

Timeout for idle HTTP connections when downloading a VM template (milliseconds)
Default: 600000

 

RS

 

 

abiquo.appliancemanager.deploy.totalTimeout

Timeout for HTTP connections when downloading a VM template (milliseconds).
Default: 86400000

 

RS

 

 

abiquo.appliancemanager.downloadingPublishInterval

Frequency of download progress notification in milliseconds.
Default: 1500

 

RS

 

 

abiquo.appliancemanager.downloads

Maximum number of concurrent template downloads. A value of -1 means unlimited.
Default: -1

 

RS

 

 

abiquo.appliancemanager.fstimeoutms

Maximum time for the appliance manager to perform a complete rescan of the repository filesystem in milliseconds.
Default: 7000

 

RS

 

 

abiquo.appliancemanager.localRepositoryPath

Folder where the abiquo.appliancemanager.repositoryLocation is mounted on the remote services node.
Default: /opt/vm_repository

 

RS

 

 

abiquo.appliancemanager.repository.ignoredPathPrefix

Path name prefixes to be ignored in the repository refresh (comma separated values).

 

RS

 

 

abiquo.appliancemanager.repository.ignoredPathRegex

Path name pattern to be ignored in the repository refresh in Java regular expression format.

 

RS

 

 

abiquo.appliancemanager.repository.ignoredPathSuffix

Path name suffixes to be ignored in the repository refresh (comma separated values).

 

RS

 

 

abiquo.appliancemanager.repositoryLocation

Local Appliance Library, NFS repository location denoted by nfs-server-address:exportpath.
Default: <IP-repoLoc>:/opt/vm_repository

 

RS

 

 

abiquo.appliancemanager.upload.progressInterval

Interval to refresh progress of upload of VM template (milliseconds).
Default: 5000

 

RS

 

 

abiquo.auth.basic.restricted

If true, the API will allow the use of basic authentication on the login resource only. Other API calls must use token authentication and set the token with the value of the X-Abiquo-Token header in the login response.
Default: false

API

 

 

 

abiquo.auth.module

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

API

 

 

 

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: 1800

API

 

 

 

abiquo.availabilityzones.check.delayInHrs

Delay between checks of availability zones
Default: 24

API

 

 

 

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

Role template ID of the Directory role to assign to the application created using 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

 

RS

 

 

abiquo.azure.account.creation.appname

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

 

RS

 

 

abiquo.azure.account.creation.default.organizationregistrationnumber

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

 

RS

 

 

abiquo.azure.account.creation.default.phone

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

 

RS

 

 

abiquo.azure.account.creation.organizationregistrationnumber.countries

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, a phone number must also be provided. Only used for field verification before customer creation. 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,ae

 

RS

 

 

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

Delay between polling requests for account creation.
Default: 10

 

RS

 

 

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

Delay between polling requests during wait for registration of resource providers
Default: 1

 

RS

 

 

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

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

 

RS

 

 

abiquo.azure.feign.connection.timeout.seconds

Connection timeout for Azure billing process.
Default: 10

 

RS

 

 

abiquo.azure.feign.logger.level

Logger level for Feign HTTP client in Azure.
Default: none
Valid values: none, basic, headers, full

 

RS

 

 

abiquo.azure.feign.read.timeout.seconds

Read timeout for Azure billing process.
Default: 60

 

RS

 

 

abiquo.azurecompute-arm.vpn.gatewaysubnet.mask

For Azure ARM VPN, the Virtual Network Gateway requires a 'gateway subnet', if this does not exist, the plugin tries to create it in some available range of the virtual network and using the mask given by this property.
Default: 29

 

RS

 

 

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

For Azure ARM VPN, the Virtual Network Gateway uses an SKU. If using a PolicyBased VPN, only the Basic SKU is supported. See https://docs.microsoft.com/en-us/azure/vpn-gateway/vpn-gateway-about-vpngateways#gwsku
Default: Basic
Valid values: Basic, HighPerformance, Standard, UltraPerformance, VpnGw1, VpnGw2, VpnGw3, VpnGw4, VpnGw5, VpnGw1AZ, VpnGw2AZ, VpnGw3AZ, VpnGw4AZ, VpnGw5AZ

 

RS

 

 

abiquo.azurecompute-arm.vpn.virtualnetworkgateway.type

For Azure ARM VPN, the routing type to use for the Virtual Network Gateway. See: https://docs.microsoft.com/en-us/azure/vpn-gateway/vpn-gateway-about-vpngateways
Default: RouteBased
Valid values: RouteBased, PolicyBased

 

RS

 

 

abiquo.backup.check.delay

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

API

 

 

 

abiquo.backup.{plugin}.config.path
- veeam
- networker
- rubrik

This property indicates where the backup plugin configuration file is located. The Tomcat user must be able to access the file. This property is only required for the API and the remote services that use the plugin: virtual-factory, nars Example: abiquo.backup.{plugin_type}.config.path
- veeam = /opt/abiquo/config/veeam.properties
- networker = /opt/abiquo/config/networker.properties
- rubrik = /opt/abiquo/config/rubrik.properties

 

RS

 

 

abiquo.billing.azure.country_code

Two character country code for azure REST API calls for standard subscriptions (not CSP).
Default: ES

API

 

 

 

abiquo.billing.execution.limit

Total number of billing executions allowed per day for each set of pricing credentials. To allow unlimited executions, set to 0
Default: 2

API

 

 

 

abiquo.billing.task.cron

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

API

 

 

 

abiquo.captcha.private.key

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

API

 

 

 

abiquo.capturedhcp

Update DHCP during VM capture
Default: false

API

 

 

 

abiquo.costusage.task.frequencyinhours

Frequency of running the consolidation of accounted usage from providers.
Default: 24
Valid values: >0

API

 

 

 

abiquo.datacenter.id

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

 

RSV2V

 

abiquo.dnsmasq.basedir

Folder where the platform should store lease information

 

DNSMASQ

 

 

abiquo.dnsmasq.reloadscript

Script to reload a running instance of dnsmasq

 

DNSMASQ

 

 

abiquo.dnsmasq.serviceiface

Use this network interface to attach bridged VLAN interfaces

 

DNSMASQ

 

 

abiquo.dnsmasq.startscript

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

 

DNSMASQ

 

 

abiquo.dnsmasq.stopscript

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

 

DNSMASQ

 

 

abiquo.draas.check.delay.seconds

Delay between executions of DRaaS sync in seconds
Default: 60

 

RS

 

 

abiquo.draas.pg.journalhistory.hours

Default journal history hours for protection groups
Default: 24

 

RS

 

 

abiquo.draas.pg.priority

Default priority for protection groups
Default: Medium
Valid values: Low, Medium, High

 

RS

 

 

abiquo.draas.pg.rpo.seconds

Default recovery point objective seconds for protection groups
Default: 180

 

RS

 

 

abiquo.draas.recovery.cluster.name

Default host name where the selected VMs will be recovered by the DRaaS provider. It can include a wildcard (*) to match any string.
Default: *Cluster*

 

RS

 

 

abiquo.draas.recovery.datastore.name

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

 

RS

 

 

abiquo.draas.recovery.folder.name

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

 

RS

 

 

abiquo.draas.recovery.network.name

Default network used for recovery by the DRaaS provider. It can include a wildcard (*) to match any string. In the recovery vCenter you must create a network for each enterprise, and you may create a matching external network in Abiquo. If there is more than one enterprise, the first part of the network name is this property's value, and the second part is the value of an enterprise property with a key of ''DR-code'', for example, ''DraasnetEnterprise1''.
Default: Draasnet

 

RS

 

 

abiquo.draas.recovery.testnetwork.name

Default network used for failover testing by the DRaaS provider. It can include a wildcard (*) to match any string. In the recovery vCenter you must create a test network for each enterprise. If there is more than one enterprise, the first part of the network name is this property's value, and the second part is the value of an enterprise property with a key of ''DR-code'', for example, ''DraasTestnetEnterprise1''.
Default: DraasTestnet

 

RS

 

 

abiquo.dvs.portgroup.loadsharingmechanism

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

 

RS

 

 

abiquo.dvs.portgroup.maxsize

Number of available ports in each port group.
Default: 48

 

RS

 

 

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)

 

RS

 

 

abiquo.enterprise.property.billing.monthoffset

Number of months of bills to download and regenerate counting back from the current date. Regeneration is done with data from cost usage details.
Default: 2

API

 

 

 

abiquo.enterprise.property.discount.suffix

Pricing discount is defined in the enterprise properties. The property key is built using the hypervisor type in lower case and adding a suffix that is defined using this property.
Default: _discount

API

 

 

 

abiquo.enterprise.property.pricefactor.suffix

Pricing price factor is defined in the enterprise properties. The property key is built using the hypervisor type in lower case and adding a suffix that is defined using this property.
Default: _price_factor

API

 

 

 

abiquo.esxi.cloudinit.sata

For the CD device used by cloud-init, if this property is true, use the SATA disk controller. If not specified or false, use IDE

 

RS

 

 

abiquo.esxi.datastoreRdm

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

 

RS

 

 

com.abiquo.esxi.discovery.datastore.ignorebyname

If specified, filter datastores by name. For the filtered datastores, Abiquo will not check if the datastores are mounted or 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.

 

RS

 

 

com.abiquo.esxi.discovery.networkinterface.networks

Set this property to 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 property is a comma separated list of networks in CIDR format, in priority order

 

RS

 

 

com.abiquo.esxi.discovery.networkinterface.onlymanagementip

If true, only use virtual NICs of the host that are configured for management traffic.
Default: false

 

RS

 

 

com.abiquo.esxi.disk.enableuuid

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

 

RS

 

 

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

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

API

 

 

 

abiquo.esxi.metricsid.{metric}
- cpu
- cpu-mz
- cpu-time
- memory
- memory-swap
- memory-swap2
- memory-vmmemctl
- memory-physical
- memory-host
- disk-latency
- uptime

On ESXi, to support dynamic metric IDs, set a value to override the default metric ID as given in the table in Abiquo documentation on Override IDs of ESXi metrics. Contact Abiquo Support for more information about how to determine the required metric IDs.

 

RS

 

 

abiquo.esxi.scsicontroller

Default VirtualSCSIController implementation when diskController is not specified.
Default: lsilogic
Valid values: lsilogic, paravirtual, bus, sas

 

RS

 

 

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

 

RS

 

 

com.abiquo.esxi.webmks.force

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

 

RS

 

 

com.abiquo.esxi.webmks.proxypath

When ''com.abiquo.esxi.webmks'' is true (enabled), this property defines the path to a websocket proxy to avoid direct connection to ESXi 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 ESXi hosts.

 

RS

 

 

abiquo.events.list.daysoffset

Number of days of events to display in lists of events for the platform.
Default: 7

API

 

 

 

abiquo.experimental.capturewithvolumes.bypass

When 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
Default: false

API

 

 

 

abiquo.experimental.shareddisks.bypass

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

API

 

 

 

abiquo.fqdn.label.pattern

Pattern to check between dots ''.'' in VM FQDN and network DNS suffix.
Default:

[a-zA-Z](([a-zA-Z0-9-]{1,61})?[a-zA-Z0-9])?
API

 

 

 

abiquo.googlecloud.public.image.projects

Publishers list for Google Cloud, consisting of 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

 

RS

 

 

abiquo.googlecloud.waitforstartupscript.retry.seconds

Google Cloud time between retries when waiting for startup script to run
Default: 10

 

RS

 

 

abiquo.googlecloud.waitforstartupscript.timeout.seconds

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

 

RS

 

 

abiquo.googlecloud.waitforstatus.retry.seconds

Google Cloud time between retries when waiting for status
Default: 5

 

RS

 

 

abiquo.googlecloud.waitforstatus.timeout.seconds

Google Cloud timeout when waiting for status
Default: 180

 

RS

 

 

abiquo.guest.password.exclude

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

API

 

 

 

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 the following format:

  • 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

API

 

 

 

abiquo.httpProxy.host

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

APIRS

 

 

abiquo.httpProxy.password

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

APIRS

 

 

abiquo.httpProxy.port

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

APIRS

 

 

abiquo.httpProxy.user

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

APIRS

 

 

abiquo.hyperv.sambaHosts

CSV list of Samba hosts where the platform will discover shares to use as Hyper-V datastores. If not supplied, the platform will not try to discover shares.

 

RS

 

 

abiquo.inactivitysession.maxinhours

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

 

RS

 

 

abiquo.instance.targetDiskFormatType.{plugin}
- vmx_04
- kvm
- 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).
- vmx_04 = vmdk_sparse
- kvm = qcow2_sparse
- hyperv_301 =

API

 

 

 

abiquo.ldap.authentication.attribute.enterprise

The attribute in LDAP/Active Directory that will contain the Enterprise Name, which must be an enterprise in Abiquo.
Default: organizationname

API

 

 

 

abiquo.ldap.authentication.autoUserCreation

If true, Abiquo will create a user in Abiquo based on a successful login to LDAP.
Default: true

API

 

 

 

abiquo.ldap.authentication.custom.userDnPattern

Abiquo will perform an additional custom query against the specified schema in the LDAP/Active Directory. This value is required. The default value does not result in an additional query.
Default: cn={0},CN=Users

API

 

 

 

abiquo.ldap.authentication.server.baseDN

Base Distinguished Name of the LDAP/Active Directory
Default: DC=127.0.0.1,DC=local

API

 

 

 

abiquo.ldap.authentication.server.port

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

API

 

 

 

abiquo.ldap.authentication.server.protocol

Protocol to use when authenticating to an LDAP/Active Directory.
Default: ldap
Valid values: ldap, ldaps

API

 

 

 

abiquo.ldap.authentication.server.url

LDAP/Active Directory server URL
Default: 127.0.0.1

API

 

 

 

abiquo.ldap.connection.timeout

Timeout to establish the connections to the LDAP/Active Directory server (milliseconds).
Default: 5000

API

 

 

 

abiquo.ldap.read.timeout

Timeout to complete the connections to the LDAP/Active Directory server (milliseconds).
Default: 10000

API

 

 

 

abiquo.login.samesite

Specifies the value for the SameSite cookie flag. If the value is set to ''null'', the cookie will be sent without the SameSite flag.
Default: strict
Valid values: strict, lax, none, null

API

 

 

 

abiquo.m.instanceid

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.

 

 

 

OA

abiquo.mail.charset

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

API

 

 

 

abiquo.mail.path

Path to email template and text .properties files for user password reset, two-factor authentication, guest password notifications, monitoring alert notifications.
Default: /opt/abiquo/config/mail

API

 

 

 

abiquo.monitoring.enabled

Enable/disable monitoring, alarms and alerts
Default: false

APIRS

 

 

abiquo.monitoring.max.statistic.period.days

Maximum period in days for statistical metric queries through the API
Default: 7

API

 

 

 

abiquo.nars.async.amqp.backoff.maxseconds

AMQP consumer reconnection. Maximum seconds without restart attempt
Default: 60

 

RS

 

 

abiquo.nars.async.amqp.backoff.minseconds

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

 

RS

 

 

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 that is accessible from all the NARS instances 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

 

RS

 

 

abiquo.nars.async.pendingpublish.minutes

Check for pending responses that failed to publish due to AMQP failure in NARS
Default: 10

 

RS

 

 

abiquo.nars.async.pendingpublish.path

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

 

RS

 

 

abiquo.nars.async.pool.byvdc

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

 

RS

 

 

abiquo.nars.async.pool.inactivity.maxhours

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

 

RS

 

 

abiquo.nars.async.pool.max

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

 

RS

 

 

abiquo.nars.async.pool.{plugin}.byvdc
- amazon
- kvm
- vmx_04
- vcenter_cluster
- hyperv_301
- azurecompute-arm
- vcd
- e1c
- googlecloudplatform
- dnsmasq
- omapi
- nsx-ecmp
- logical
- nsx-nat
- nsx-gateway
- nsxt
- veeam95u4
- veeam10
- networker
- rubrik

If true, the maximum number of simultaneous operations apply on a single virtualdatacenter (instead of single hypervisor or region connection), by type. The default value is the value of abiquo.nars.async.pool.byvdc
Default: false

 

RS

 

 

abiquo.nars.async.pool.{plugin}.max
- amazon
- kvm
- vmx_04
- vcenter_cluster
- hyperv_301
- azurecompute-arm
- vcd
- e1c
- googlecloudplatform
- dnsmasq
- omapi
- nsx-ecmp
- logical
- nsx-nat
- nsx-gateway
- nsxt
- veeam95u4
- veeam10
- networker
- rubrik
- zerto

Maximum number of simultaneous operations on a single hypervisor or region connection, by type. default abiquo.nars.async.pool.max
Default: 2
- zerto = 1

 

RS

 

 

abiquo.nars.async.prefetch

Limit parallelism of asyncrequest execution. Number of unacknowledged messages from the requests queue.
Default: 50

 

RS

 

 

abiquo.nsx.connection-timeout-ms

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

 

RS

 

 

abiquo.nsx.edge.cluster-id

vCenter cluster where the Edge appliances will be deployed.

 

RS

 

 

abiquo.nsx.edge.datastore-id

vCenter datastores where the Edge appliances will be deployed. List of datastore identifiers in CSV format.

 

RS

 

 

abiquo.nsx.edge.datastore-policy

Allocation policy for selection of datastores from list to deploy Edge appliances
Default: leastvms
Valid values: leastvms, mostspace

 

RS

 

 

abiquo.nsx.edge.description

Edge description
Default: Managed by Abiquo

 

RS

 

 

abiquo.nsx.edge.dhcp.size

Specify the size of the DHCP edge appliance (ecmp plugin)
Default: compact
Valid values: compact, large, quadlarge, xlarge

 

RS

 

 

abiquo.nsx.edge.dvportgroup-id

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

 

RS

 

 

abiquo.nsx.edge.esg.size

Specify the size of the ESG edge appliance (gateway and ecmp plugin)
Default: compact
Valid values: compact, large, quadlarge, xlarge

 

RS

 

 

abiquo.nsx.edge.plr-esg-id

ID of the Edge that acts as the PLR (nat plugin)

 

RS

 

 

abiquo.nsx.edge.plr-transit-cidr

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

 

RS

 

 

abiquo.nsx.edge.plr-transit-ip

IP address from the PLR transit network to be assigned to the PLR. If not set, use the first IP address in the transit network (nat plugin).

 

RS

 

 

abiquo.nsx.edge.public-network-cidr

Configure primary addresses of Edge uplink interfaces from this pool.

 

RS

 

 

abiquo.nsx.firewall.applicationprotocols

Firewall protocols that are allowed to use services applications, aka ALG (Application Level Gateway). Collections separated by a hash ''#'' delimiter.
Default: FTP#SMB#ORACLE_TNS#MS_RPC_TCP#SUN_RPC_TCP

 

RS

 

 

abiquo.nsx.load-balancer-acceleration

Enable load balancer acceleration in NSX load balancers.
Default: false

 

RS

 

 

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

 

RS

 

 

abiquo.nsx.nat.protocols

Allowed NAT rule protocols (nat plugin). Collections separated by a hash ''#'' delimiter.
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

 

RS

 

 

abiquo.nsx.read-timeout-ms

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

 

RS

 

 

abiquo.nsx.static-edge-gateway

If false, when modifying the gateway of a network only update the Edge interface address if the new gateway is not used in any of the DHCP leases.
Default: true

 

RS

 

 

abiquo.nsx.transport-zone

The transport zone that logical switches will be connected to.

 

RS

 

 

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

 

RS

 

 

abiquo.nsx.virtualwire.teaming

Set a teaming policy for the portGroup that is the backing for the VirtualWire when it is created. This value cannot be changed after it is created.
Default: failover_explicit
Valid values: failover_explicit, loadbalance_ip, loadbalance_loadbased, loadbalance_srcid, loadbalance_srcmac

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.
Default: INFO
Valid values: INFO, WARNING, ERROR, CRITICAL, ALERT, EMERGENCY

 

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.
Default: SMALL
Valid values: SMALL, MEDIUM, LARGE, XLARGE

 

RS

 

 

abiquo.nsxt.infra.tier0-external-ip

External IP used by the Tier-0.

API

 

 

 

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

Allocation size of Edges in pool defined in Tier-1.
Default: LB_SMALL
Valid values: ROUTING, LB_SMALL, LB_MEDIUM, LB_LARGE, LB_XLARGE

 

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 checks of the NSX-T API.
Default: 3000

 

RS

 

 

abiquo.oci.default.polling.delay.seconds

Oracle Cloud Infrastructure polling delay during wait.
Default: 30

 

RS

 

 

abiquo.oci.default.polling.termination.seconds

Oracle Cloud Infrastructure polling termination during waits.
Default: 600

 

RS

 

 

abiquo.oci.public.subnet.mask

Oracle Cloud Infrastructure mask to use when creating the public subnet.
Default: 24

 

RS

 

 

abiquo.oci.retry.delay.seconds

Oracle Cloud Infrastructure time to wait to retry an API call.
Default: 5

 

RS

 

 

abiquo.oci.retry.max

Oracle Cloud Infrastructure maximum number of API call retries.
Default: 10

 

RS

 

 

abiquo.openid.authorization.endpoint

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

API

 

 

 

abiquo.openid.client.acr-validation

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

API

 

 

 

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 the 'acr-validation' property is true (default value)

API

 

 

 

abiquo.openid.client.id

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

API

 

 

 

abiquo.openid.client.name

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

API

 

 

 

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
API

 

 

 

abiquo.openid.client.scopes

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

API

 

 

 

abiquo.openid.client.secret

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

API

 

 

 

abiquo.openid.cookie.maxage

After openid auth flow, the API redirect adds a cookie with the access_token and the id_token. This cookie expires after 30 seconds by default, also configurable by this property (value 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

API

 

 

 

abiquo.openid.cookie.refreshtoken.include

If true, the OpenID authentication cookie will also contain the refresh token.
Default: false

API

 

 

 

abiquo.openid.endsession.endpoint

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

API

 

 

 

abiquo.openid.enterprise-claim

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

API

 

 

 

abiquo.openid.enterprise-property

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

API

 

 

 

abiquo.openid.issuer

The OpenID Connect authorization issuer.

API

 

 

 

abiquo.openid.jwks.endpoint

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

API

 

 

 

abiquo.openid.role-claim

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

API

 

 

 

abiquo.openid.target

The URL where the user will be redirected from the Identity Server upon successful authentication. Something like

http://<abiquo_ui_host>/ui/#/dashboard
API

 

 

 

abiquo.openid.token.endpoint

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

API

 

 

 

abiquo.openid.userinfo.endpoint

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

API

 

 

 

abiquo.pcr.template.check.delay

Delay between executions of the template check in public cloud providers (milliseconds). The default is 12 hours.
Default: 43200000

API

 

 

 

abiquo.pcrsync.retrydelayms

Milliseconds to wait before retrying a synchronize of a public cloud region in the same enterprise and PCR.
Default: 15000

API

 

 

 

abiquo.pcrsyncpool

Number of concurrent public cloud region synchronize operations at a given time, not in the same enterprise and PCR.
Default: 3

API

 

 

 

abiquo.plugin-client.connectionrequesttimeout

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

API

 

 

 

abiquo.plugin-client.connectiontimeout

API to NARS HTTP client configuration: timeout in milliseconds until a connection is established. A value of 0 means an infinite timeout. A negative value is interpreted as undefined (system default).
Default: -1

API

 

 

 

abiquo.plugin-client.pool.checkconnectionms

API to NARS HTTP client pool configuration: when reusing a connection, check if the elapsed time since the last use exceeds this timeout.
Default: 5000

API

 

 

 

abiquo.plugin-client.pool.maxclients

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

API

 

 

 

abiquo.plugin-client.pool.maxclientsperendpoint

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

API

 

 

 

abiquo.plugin-client.pool.maxkeepalivems

API to NARS HTTP client pool configuration: maximum time to keep a persistent connection.
Default: 120000

API

 

 

 

abiquo.plugin-client.timeout

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

API

 

 

 

abiquo.plugin-client.timeout.download

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

API

 

 

 

abiquo.plugin-client.timeout.{pluginType}

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

API

 

 

 

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.

API

 

 

 

abiquo.pluginmetadata.{pluginTypeLowerCase}.baseDiskFormatType

Override default plugin metadata to update the preferred format when requesting compatible conversions. Allowed values: any DiskFormatType. Single element that should be in 'compatibleDiskFormatTypes'.
Default: VMDK_FLAT

API

 

 

 

abiquo.pluginmetadata.{pluginTypeLowerCase}.compatibleDiskFormatTypes

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

API

 

 

 

abiquo.pluginmetadata.{pluginTypeLowerCase}.diskControllers

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

API

 

 

 

abiquo.pluginmetadata.{pluginTypeLowerCase}.ethernetDrivers

Override default plugin metadata to update the compatible Ethernet Driver. Allowed values: any EthernetDriver. List of comma separated values, and the first one is used as the default.
Default: E1000, VMXNET3, PCNET32, VIRTIO

API

 

 

 

abiquo.pricing.credentials.check.delayInHrs

Delay between executions of the pricing credentials check (hours)
Default: 720

API

 

 

 

abiquo.pricing.import.check.delayInHrs

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

API

 

 

 

abiquo.rabbitmq.addresses

Define your RabbitMQ server(s) as a list of host:port values, separated by commas.
Default: 127.0.0.1:5672

APIRSV2V

 

abiquo.rabbitmq.connectionTimeout

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

APIRSV2V

 

abiquo.rabbitmq.password

RabbitMQ password
Default: guest

APIRSV2V

 

abiquo.rabbitmq.requestedHeartbeat

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

APIRSV2V

 

abiquo.rabbitmq.tls

Set to true if the RabbitMQ server has TLS enabled
Default: false

APIRSV2V

 

abiquo.rabbitmq.tls.trustallcertificates

If true, Abiquo will not enforce any server certificate authentication.
Default: false

APIRSV2V

 

abiquo.rabbitmq.username

RabbitMQ username
Default: guest

APIRSV2V

 

abiquo.rabbitmq.virtualHost

Virtual host where RabbitMQ runs
Default: /

APIRSV2V

 

abiquo.redis.host

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

APIRS

 

 

abiquo.redis.port

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

APIRS

 

 

abiquo.repository.timeoutSeconds

Time in seconds to wait for checking if the .abiquo_repository file mark is present on the NFS repository filesystem, which helps in finding a slow NFS repository.
Default: 10

 

RS

 

 

abiquo.saml.attributes.enterprise.claims

The SAML response attribute that contains the enterprise properties that will indicate the enterprise to assign the user to in a successful login. Accepts a comma-separated value with a composed string with the SAML attribute and the enterprise property name separated by a colon '':''. Pattern: <saml-attr1>:<ent-prop1>,<saml-attr2>:<ent-prop2>

API

 

 

 

abiquo.saml.attributes.role.claim

The SAML response attribute that will contain the role to assign to the user in a successful login

API

 

 

 

abiquo.saml.attributes.user.email.claim

The SAML response attribute that will contain the user's email
Default: EmailAddress

API

 

 

 

abiquo.saml.attributes.user.firstname.claim

The SAML response attribute that will contain the user's first name
Default: FirstName

API

 

 

 

abiquo.saml.attributes.user.id.claim

The SAML response attribute that will identify the user as unique. If not set, the principal will be used as identifier

API

 

 

 

abiquo.saml.attributes.user.lastname.claim

The SAML response attribute that will contain the user's last name
Default: LastName

API

 

 

 

abiquo.saml.binding

The URN of the binding profile to allow

API

 

 

 

abiquo.saml.cookie.maxage

The time (in seconds) for the cookie with access tokens to expire after a successful login
Default: 30

API

 

 

 

abiquo.saml.cookie.name

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

API

 

 

 

abiquo.saml.keys.encryption.alias

The alias of the encryption key stored in the keystore

API

 

 

 

abiquo.saml.keys.encryption.password

The password of the encryption key stored in the keystore

API

 

 

 

abiquo.saml.keys.keystore.password

Password to unlock the keystore file

API

 

 

 

abiquo.saml.keys.keystore.path

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

API

 

 

 

abiquo.saml.keys.metadata.sign

Indicates if the SAML Requests must be signed
Default: false

API

 

 

 

abiquo.saml.keys.signing.alias

The alias of the signing key stored in the keystore

API

 

 

 

abiquo.saml.keys.signing.password

The password of the signing key stored in the keystore

API

 

 

 

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 matched. Only valid for ''SAML'' mode, not for ''SAML + user'' (multiple IDPs).
Default: false

API

 

 

 

abiquo.saml.metadata.generator.bindingSSO

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

API

 

 

 

abiquo.saml.metadata.identityprovider.default.id

The ID of the default IdP. Required for all SAML environments

API

 

 

 

abiquo.saml.metadata.identityprovider.path

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

API

 

 

 

abiquo.saml.metadata.identityprovider.userdomain.map

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

API

 

 

 

abiquo.saml.metadata.mode

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

API

 

 

 

abiquo.saml.metadata.serviceprovider.path

The path of the SP metadata to load if the metadata mode is set to ''provided''.

API

 

 

 

abiquo.saml.mode

Specify the SAML integration mode to use, which can be ''single'' for SAML only, or ''multiple'' for Abiquo basic auth and SAML
Default: single

API

 

 

 

abiquo.saml.redirect.endpoint

URI where Abiquo should redirect a successful login using SAML SSO. Something like:

https://<your_env>/ui
API

 

 

 

abiquo.saml.redirect.error.endpoint

URI where Abiquo should redirect an unsuccessful login using SAML SSO. This property must be an endpoint, which can be relative to the UI endpoint, for example ''?error'', or an absolute endpoint that is a valid URI, for example, https://your.env.com/ui/?error=ERROR_CODE
Default: ?error

API

 

 

 

abiquo.security.encrypt

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

APIRSV2V

 

abiquo.server.api.location

URL where the API is running. For example, https://abiquo.example.com/api/ or http://80.169.25.32/api
Default: http://127.0.0.1/api

APIRS

 

 

abiquo.server.mail.extra.{javaxMailProperty}

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 ''mail.smtp.quitwait'' by setting the following property: abiquo.server.mail.extra.mail.smtp.quitwait = false

API

 

 

 

abiquo.server.mail.from

The sender of platform email notifications

API

 

 

 

abiquo.server.mail.password

Password for connecting to the mail server
Default: none

API

 

 

 

abiquo.server.mail.port

The mail server port
Default: 25

API

 

 

 

abiquo.server.mail.server

Address where the mail server is located
Default: 127.0.0.1

API

 

 

 

abiquo.server.mail.ssl

If SSL should be used to connect to the mail server
Default: false

API

 

 

 

abiquo.server.mail.tls

If TLS should be used to connect to the mail server
Default: false

API

 

 

 

abiquo.server.mail.user

System user with privileges for connecting to the mail server
Default: none@none.es

API

 

 

 

abiquo.server.remoteSpace.default

Default remote repository space (OVF package sources) attached to all appliance libraries
Default: http://abiquo-repository.abiquo.com/ovfindex.xml

API

 

 

 

abiquo.server.sessionTimeout

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

API

 

 

 

abiquo.server.timeout

Time the server waits for long requests in milliseconds. The default value represents 7 days.
Default: 600000000

API

 

 

 

abiquo.stale.sessions.check.delay

Delay between executions of the check for stale sessions (milliseconds).
Default: 300000

API

 

 

 

abiquo.storage.check.delay

Delay between checks of the storage infrastructure (milliseconds)
Default: 900000

API

 

 

 

abiquo.storage.forcesamecontrollertype

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

API

 

 

 

abiquo.storagemanager.netapp.aggrfreespaceratio

Recommended free space on NetApp aggregates.
Default: 0.05
Valid values: 0 - 1

API

 

 

 

abiquo.storagemanager.netapp.debug

If true, record requests to ONTAP and responses in the Abiquo logs.
Default: false

API

 

 

 

abiquo.storagemanager.netapp.initiatorGroupName

Optionally create an initial initiator group with this name.
Default: abiGroup

API

 

 

 

abiquo.storagemanager.netapp.volumelunration

Optional ratio to allow a LUN of a provided size to fill on its container volume (volSize = lunSize * volumelunratio).
Default: 1.3
Valid values: 1.3 - 1.9

API

 

 

 

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

API

 

 

 

abiquo.tagging.synccheckcron

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

API

 

 

 

abiquo.tasks.history.size

Maximum length of task history in Redis for API/Server by owner.
Default: 20

API

 

 

 

abiquo.tasks.trimmer.delay

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

API

 

 

 

abiquo.vappspec.retrydelayms

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

API

 

 

 

abiquo.vappspecpool

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

API

 

 

 

abiquo.vcd.connectionTimeoutMs

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

 

RS

 

 

abiquo.vcd.fenceVapp

When true, the vCloud virtual appliance network is NATROUTED, which retains IP/MAC across deployments. When false, the vCloud virtual appliance network is BRIDGED
Default: true

 

RS

 

 

abiquo.vcd.firewall.vappnetwork

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

 

RS

 

 

abiquo.vcd.login.timeoutMs

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

 

RS

 

 

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

 

RS

 

 

abiquo.vcd.metric.live.force

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

 

RS

 

 

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 user that created the new user.
Default: default

 

RS

 

 

abiquo.vcd.parentnetwork

Private network connection to allow outgoing traffic. 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

 

RS

 

 

abiquo.vcd.readTimeoutMs

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

 

RS

 

 

abiquo.vcd.reserved-ips

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

 

RS

 

 

abiquo.vcenter.port.connection

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

 

RS

 

 

abiquo.vi.check.delay

Delay between executions of the virtual infrastructure check (milliseconds).
Default: 900000

API

 

 

 

abiquo.virtualfactory.azure.storageaccountprefix

Prefix for Abiquo generated storage accounts
Default: abq

 

RS

 

 

abiquo.virtualfactory.azurecompute-arm.maxconcurrentupdates

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

 

RS

 

 

abiquo.virtualfactory.azurecompute-arm.operationtimeout

The timeout to consider an operation as failed in Azure ARM (seconds)
Default: 46000000

 

RS

 

 

abiquo.virtualfactory.backup.openSession

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

 

RS

 

 

abiquo.virtualfactory.backup.openSession.byvdc

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

 

RS

 

 

abiquo.virtualfactory.device.openSession

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

 

RS

 

 

abiquo.virtualfactory.device.openSession.byvdc

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

 

RS

 

 

com.abiquo.virtualfactory.esxi.timeoutConnectionMs

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

 

RS

 

 

com.abiquo.virtualfactory.esxi.timeoutReadMs

Time to wait to read from the connection to ESXi (milliseconds)
Default: 30000

 

RS

 

 

abiquo.virtualfactory.hyperv.automaticShutdownAction

Action to take for the VM when the host is shut down. Sets Msvm_VirtualSystemSettingData.AutomaticShutdownAction. See https://msdn.microsoft.com/en-us/Library/hh850257(v=vs.85).aspx.
Default: 3
Valid values: 2, 3, 4

 

RS

 

 

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

 

RS

 

 

abiquo.virtualfactory.hyperv.repositoryLocation

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

//<IP-repoLoc>/vm_repository

 

RS

 

 

abiquo.virtualfactory.hyperv.swapFileDataRoot

The path of a directory where swap files for the VM are 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

 

RS

 

 

abiquo.virtualfactory.kvm.fullVirt

If false, create libvirt machines in KVM using PC emulation (software emulation, slower). Emulation only works with x86 64-bit based hosts, including VMs.
Default: true
Valid values: true, false

 

RS

 

 

abiquo.virtualfactory.networking.bridgePrefix

Prefix to name used to identify the VLAN bridge in the KVM hypervisor nodes.
Default: abiquo

 

RS

 

 

abiquo.virtualfactory.openSession

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

 

RS

 

 

abiquo.virtualfactory.openSession.byvdc

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

 

RS

 

 

abiquo.virtualfactory.openSession.faststatechanges

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

 

RS

 

 

abiquo.virtualfactory.pendingpublish.minutes

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

 

RS

 

 

abiquo.virtualfactory.pendingpublish.path

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

 

RS

 

 

abiquo.virtualfactory.{plugin}.backup.openSession
- veeam95u4
- veeam10
- networker
- rubrik

Maximum number of simultaneous operations on a single backup manager, by type. The default value is the value of abiquo.virtualfactory.backup.openSession
Default: 2

 

RS

 

 

abiquo.virtualfactory.{plugin}.backup.openSession.byvdc
- veeam95u4
- veeam10
- networker
- rubrik

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

 

RS

 

 

abiquo.virtualfactory.{plugin}.defaultloginname
- azurecompute-arm
- googlecloudplatform

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

 

RS

 

 

abiquo.virtualfactory.{plugin}.defaultloginpassword
- azurecompute-arm
- googlecloudplatform

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

 

RS

 

 

abiquo.virtualfactory.{plugin}.device.openSession
- dnsmasq
- omapi
- nsx-ecmp
- logical
- nsx-nat
- nsx-gateway
- nsxt

Maximum number of simultaneous operations on a single device, by type. The default value is the value of abiquo.virtualfactory.device.openSession
Default: 2

 

RS

 

 

abiquo.virtualfactory.{plugin}.device.openSession.byvdc
- dnsmasq
- omapi
- nsx-ecmp
- logical
- nsx-nat
- nsx-gateway
- nsxt

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

 

RS

 

 

abiquo.virtualfactory.{plugin}.openSession
- amazon
- kvm
- vmx_04
- vcenter_cluster
- hyperv_301
- azurecompute-arm
- vcd
- e1c

Maximum number of simultaneous operations on a single hypervisor, by type. The default value is the value of abiquo.virtualfactory.openSession
Default: 2

 

RS

 

 

abiquo.virtualfactory.{plugin}.openSession.byvdc
- amazon
- kvm
- vmx_04
- vcenter_cluster
- hyperv_301
- azurecompute-arm
- vcd
- e1c

If true, the maximum number of simultaneous operations apply to a single virtualdatacenter (instead of single hypervisor), by type. The default value is the value of abiquo.virtualfactory.openSession.byvdc
Default: false

 

RS

 

 

abiquo.virtualfactory.{plugin}.openSession.faststatechanges
- amazon
- kvm
- vmx_04
- vcenter_cluster
- hyperv_301
- azurecompute-arm
- vcd
- e1c

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

 

RS

 

 

abiquo.vm.statsupdate.interval

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

API

 

 

 

abiquo.vm.statsupdate.range.days

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

API

 

 

 

abiquo.vncport.max

Last port of the VNC range to be used when allocating VMs.
Default: 65534

API

 

 

 

abiquo.vncport.min

First port of the VNC range to be used when allocating VMs.
Default: 5900

API

 

 

 

abiquo.vsm.actor.creation.delay.{plugin}
- vmx_04
- kvm
- hyperv_301
- amazon

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

 

RS

 

 

abiquo.vsm.backoff.enabled

Enable or disable backoff
Default: false

 

RS

 

 

abiquo.vsm.hostsyncfrequency.{plugin}
- vmx_04
- kvm
- hyperv_301
- vcd
- e1c

Time between executions of infrastructure check in milliseconds.
Default: 300000

 

RS

 

 

abiquo.vsm.max.backoff

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

 

RS

 

 

abiquo.vsm.measures.pusher.frequency

The heartbeat frequency of measurements pusher in milliseconds. Or the delay between reconnection process to Watchtower.
Default: 10000

 

RS

 

 

abiquo.vsm.pollingfrequency.{plugin}
- vmx_04
- kvm
- hyperv_301
- vcd
- e1c
- amazon
- azurecompute-arm
- oci
- googlecloudplatform

The delay between VSM polling of VMs in milliseconds for each hypervisor or public cloud plugin.
Default: 5000
- amazon = 300000
- azurecompute-arm = 900000
- oci = 900000
- googlecloudplatform = 300000

 

RS

 

 

abiquo.vsm.vmmetrics.collectfrequency.{plugin}
- vmx_04
- kvm
- amazon
- vcd
- e1c
- azurecompute-arm
- googlecloudplatform
- oci

The delay between VM metric recollection operations in milliseconds for each hypervisor or public cloud plugin.
Default: 120000
- azurecompute-arm = 300000
- googlecloudplatform = 300000
- oci = 300000

 

RS

 

 

abiquo.vsm.vmsyncforcedpublishcount.{plugin}
- vmx_04
- kvm
- hyperv_301
- amazon
- vcd
- e1c
- azurecompute-arm

Number of VM synchronizer executions before forcing a publish of VM definitions. The default value of 0 means never force.
Default: 0

 

RS

 

 

abiquo.vsm.vmsyncfrequency.{plugin}
- vmx_04
- kvm
- hyperv_301
- amazon
- vcd
- e1c
- azurecompute-arm
- oci

The delay between VM synchronizer operations in milliseconds for each hypervisor or public cloud plugin.
Default: 180000
- azurecompute-arm = 900000
- oci = 900000

 

RS

 

 

abiquo.vsm.vmsyncmode.fetchall.{plugin}
- vcenter_cluster
- vmx_04

Forces VSM VirtualMachineDefinitionsSyncOp to fetch all VMs before looking for differences in VM definitions.
Default: true

 

RS

 

 

abiquo.watchtower.host

Address where watchtower is located
Default: 127.0.0.1

APIRS

 

 

abiquo.watchtower.password

Watchtower password
Default: xabiquo

APIRS

 

 

abiquo.watchtower.port

Port where watchtower is listening
Default: 36638

APIRS

 

 

abiquo.watchtower.tls

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

APIRS

 

 

abiquo.watchtower.tls.trustallcertificates

If true, Abiquo will not enforce any server certificate authentication.
Default: false

APIRS

 

 

abiquo.watchtower.username

Watchtower username
Default: admin

APIRS

 

 

jclouds.azurecompute.arm.publishers

Publishers to use for filtering Azure ARM templates as a comma-separated list. Display only templates from these publishers to improve performance
Default: Canonical,RedHat,MicrosoftWindowsServer

 

RS

 

 

RemoteDisplay.vnc.keyMap

ESXi only: When using a VM as a VNC server, specify the language to use for the keyboard when supported VNC clients connect. If this property is not set, the hypervisor will use the default value of config.keymaps in client-config-custom.json or client-config-default.json, which is the US101 keyboard map (US English). This property is now the default setting to complement the VM configuration popup. See Configure Remote Access to Virtual Machines.

 

RS

 

 

veeam.vcenter.ip

vCenter IP to use backup now (snapshot) functionality in ''Veeam95u4+snapshot'' backup plugin. To load the plugin, you must set a value on the API Server

 

RS

 

 

veeam.vcenter.password

vCenter password to use backup now (snapshot) functionality in ''Veeam95u4+snapshot'' backup plugin. To load the plugin, you must set a value on the API server.

 

RS

 

 

veeam.vcenter.port

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

 

RS

 

 

veeam.vcenter.user

vCenter user to use backup now (snapshot) functionality in ''Veeam95u4+snapshot'' backup plugin. To load the plugin, you must set a value on the API server.

 

RS

 

 

vmware.snapshot.keep

Maximum number of snapshots for a VM in vCenter. If the user performs an additional backup now, then only the older snapshots are removed from vCenter. applies to ''VMWARE_SNAPSHOT'' and ''Veeam95u4+snapshot'' backup plugins. Set to '0' to keep all snapshots.
Default: 2

 

RS

 

 

workflow.connect.timeout

Maximum waiting time in milliseconds to establish a connection with workflow endpoint.
Default: 60000

API

 

 

 

workflow.read.timeout

Maximum waiting time in milliseconds to receive data from workflow endpoint.
Default: 10000

API

 

 

 

zerto.feign.logger.level

Logger level for Feign HTTP client with Zerto.
Default: none
Valid values: none, basic, headers, full

 

RS

 

 

zerto.polling.delay.seconds

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

 

RS

 

 

zerto.propagation.delay.seconds

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

 

RS

 

 

zerto.ssl.allow.insecure

Allow Zerto plugin to use insecure connections
Default: false

 

RS

 

 

zerto.task.timeout.seconds

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

 

RS