Documentation

Versions Compared

Key

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

...

Changes to Properties

Excerpt
Include Page
_CONFIG PROP_CONFIG PROP


Note
titleDisabled properties
  1. abiquo.api.max.sessions: note that this property has been temporarily disabled and will be enabled in future releases

...

Range: all range values are inclusive

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

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

This table describes the abiquo.properties file of the Abiquo platform servers. For example, if a property is marked with Image Modified  symbol  in the Image Modified column, it can be configured in the abiquo.properties file of the Abiquo Server/API and Abiquo Monolithic Server.

...

Section


Div
classlandsc smallcode

Colortable

PropertyDescriptionInfo

Anchor
2fa
2fa
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

Image Modified

    

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

Image Modified

    

Anchor
abiquo
abiquo
abiquo.abiquo.task.ttl

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

Image Modified

    

Anchor
amazon
amazon
abiquo.amazon.loadbalancer.healthcheck.healthythreshold

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

 

Image Modified

   

Anchor
api
api
abiquo.api.login.failurelapse

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

Image Modified

    

abiquo.api.login.maxtries

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

Image Modified

    

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
Range: -1, >0

Image Modified

    

abiquo.api.networking.allowMultipleNicsVlan

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

Image Modified

    

abiquo.api.networking.nicspervm

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

Image Modified

    

abiquo.api.session.cookie.name

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

Image Modified

    

abiquo.api.zk.serverConnection

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

Image Modified

    

Anchor
appliancemanager
appliancemanager
abiquo.appliancemanager.check.repository

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

 

Image Modified

   

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

 

Image Modified

   

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

 

Image Modified

   

abiquo.appliancemanager.deploy.connection

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

 

Image Modified

   

abiquo.appliancemanager.deploy.idle

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

 

Image Modified

   

abiquo.appliancemanager.deploy.totalTimeout

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

 

Image Modified

   

abiquo.appliancemanager.downloadingPublishInterval

Frequency of download progress notification in milliseconds.
Default: 1500

 

Image Modified

   

abiquo.appliancemanager.downloads

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

 

Image Modified

   

abiquo.appliancemanager.fstimeoutms

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

 

Image Modified

   

abiquo.appliancemanager.localRepositoryPath

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

 

Image Modified

   

abiquo.appliancemanager.repository.ignoredPathPrefix

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

 

Image Modified

   

abiquo.appliancemanager.repository.ignoredPathRegex

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

 

Image Modified

   

abiquo.appliancemanager.repository.ignoredPathSuffix

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

 

Image Modified

   

abiquo.appliancemanager.repositoryLocation

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

 

Image Modified

   

abiquo.appliancemanager.upload.progressInterval

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

 

Image Modified

   

Anchor
auth
auth
abiquo.auth.module

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

Image Modified

    

Anchor
captcha
captcha
abiquo.captcha.private.key

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

Image Modified

    

Anchor
datacenter
datacenter
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

 

Image Modified

Image Modified

  

Anchor
docker
docker
abiquo.docker.registry

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

 

Image Modified

   

abiquo.docker.registry.tags

Docker registry filter that is a comma separated list of allowed tag patterns. Abiquo will compare the patterns with existing tags on images and only display the images with matching tags. The format of the pattern is defined by the Java regular expression pattern: http://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html, for example, ^fixedtag$,^tagswithprefix

 

Image Modified

   

Anchor
dvs and vcenter
dvs and vcenter
abiquo.dvs.portgroup.loadsharingmechanism

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

 

Image Modified

   

abiquo.dvs.portgroup.maxsize

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

 

Image Modified

   

abiquo.dvs.vcenter.password

Password of the vCenter user account
Default: change-me

 

Image Modified

   

abiquo.dvs.vcenter.user

Username of the vCenter user account
Default: change-me

 

Image Modified

   

Anchor
esxi
esxi
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.

 

Image Modified

   

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

    

com.abiquo.esxi.disk.enableuuid

Enforce disk UUID at VM level. Present disk UUID as SCSI serial number in the guest OS.
Default: false 

   (star) (star) v3.10.4
com.abiquo.esxi.experimental.eagerzero.copyIf true, force eager zero thick provisioning on copied disks   (star) (star) v3.10.3
com.abiquo.esxi.experimental.eagerzero.newIf true, force eager zero thick provisioning on new empty disks   (star)(star) v3.10.3

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

Image Modified

 

   

abiquo.esxi.metricsid.{METRIC}

    • cpu
    • cpu-mz
    • cpu-time
    • memory
    • memory-swap
    • memory-swap2
    • memory-vmmemctl
    • memory-physical
    • memory-host
    • disk-latency
    • uptime

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

 

  (star) (star) New in Abiquo 3.10

abiquo.esxi.scsicontroller

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

 

Image Modified

   

com.abiquo.esxi.disk.enableuuid

Present disk UUID as SCSI serial number in the guest OS
Default: True

 

Image Modified

   

Anchor
ha
ha
abiquo.ha.check.delay

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

Image Modified

    

abiquo.ha.infcheck.cycles

Number of failed infrastructure checks on a machine before High Availability is triggered and the machine is set to state HA_IN_PROGRESS.
Default: 2

Image Modified

    

Anchor
heartbeat
heartbeat
abiquo.heartbeat.autostart

Automatically start Abiquo heartbeat
Default: true

Image Modified

    

Anchor
httpProxy
httpProxy
abiquo.httpProxy.host

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

Image Modified

Image Modified

   

abiquo.httpProxy.password

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

Image Modified

Image Modified

   

abiquo.httpProxy.port

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

Image Modified

Image Modified

   

abiquo.httpProxy.user

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

Image Modified

Image Modified

   

Anchor
instance
instance
abiquo.instance.targetDiskFormatType.{HV}

    • vmx_04
    • kvm
    • hyperv_301
    • oracle_vm
    • xenserver

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:

    • vmx_04 = vmdk_sparse
    • kvm = qcow2_sparse
    • hyperv_301 =
    • oracle_vm = raw
    • xenserver = vhd_sparse

Image Modified

    

Anchor
ldap
ldap
abiquo.ldap.authentication.attribute.enterprise

The attribute in LDAP/Active Directory to look up the Enterprise Name which must be an enterprise in Abiquo.
Default: organizationname

Image Modified

    

abiquo.ldap.authentication.autoUserCreation

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

Image Modified

    

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

Image Modified

    

abiquo.ldap.authentication.server.baseDN

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

Image Modified

    

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

Image Modified

    

abiquo.ldap.authentication.server.protocol

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

Image Modified

    

abiquo.ldap.authentication.server.url

LDAP/Active Directory server URL
Default: 127.0.0.1

Image Modified

    

abiquo.ldap.connection.timeout

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

Image Modified

    

abiquo.ldap.read.timeout

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

Image Modified

    

Anchor
m
m
abiquo.m.accessToken

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

   

Image Modified

 

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.

   

Image Modified

 

abiquo.m.consumerSecret

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

   

Image Modified

 

abiquo.m.credential

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

   

Image Modified

 

abiquo.m.identity

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

   

Image Modified

 

Anchor
mail
mail
abiquo.mail.charset

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

Image Modified

   (star) (star) 3.10.5 and 4.0.1

abiquo.mail.path

Path to email template and text .properties files for email notifications
Default: /opt/abiquo/config/mail

Image Modified

   (warning) (warning) Applies to all mail types

Anchor
monitoring
monitoring
abiquo.monitoring.enabled

Enable/disable monitoring, alarms and alerts
Default: false

Image Modified

Image Modified

   

Anchor
neutron
neutron
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

 

Image Modified

   

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.

 

Image Modified

   

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

 

Image Modified

   

abiquo.neutron.vlan-physical-net

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

 

Image Modified

   

Anchor
nodecollector
nodecollector
abiquo.nodecollector.infcheck

Time between executions of infrastructure check in minutes
Default: 5

 

Image Modified

   

abiquo.nodecollector.infcheck.threads

Number of concurrent machine checks by infrastructure check. This number should be tied to the number of cores of the machine running the Discovery manager service.
Default: 5

 

Image Modified

   

abiquo.nodecollector.infcheck.timeout

Infrastructure check timeout in seconds
Default: 300

 

Image Modified

   

abiquo.nodecollector.timeout

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

Image Modified

    

Anchor
nsx
nsx
abiquo.nsx.connection-timeout-ms

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

 

Image Modified

   

abiquo.nsx.edge.cluster-id

vCenter cluster where the Edge appliances will be deployed.

 

Image Modified

   

abiquo.nsx.edge.datastore-id

vCenter datastore where the Edge appliances will be deployed.

 

Image Modified

   

abiquo.nsx.edge.dvportgroup-id

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

 

Image Modified

   

abiquo.nsx.edge.public-network-cidr

Configure primary addresses of Edge uplink interfaces from this pool.

 

Image Modified

   

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

 

Image Modified

   

abiquo.nsx.read-timeout-ms

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

 

Image Modified

   

abiquo.nsx.transport-zone

The transport zone that logical switches will be connected to.

 

Image Modified

   

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

 

Image Modified

   

Anchor
openid
openid
abiquo.openid.authorization.endpoint

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

Image Modified

    

abiquo.openid.client.id

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

Image Modified

    

abiquo.openid.client.name

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

Image Modified

    

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

Image Modified

    

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

Image Modified

   (warning)(warning)

abiquo.openid.client.secret

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

Image Modified

    

abiquo.openid.endsession.endpoint

(Optional) If configured, Abiquo will attempt to perform a global logout 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.

Image Modified

    

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.

Image Modified

    

abiquo.openid.enterprise-property

(Optional) If present, Abiquo will try to find an enterprise that has a property with the name configured in this 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 which name is returned in the "enterprise claim".

Image Modified

    

abiquo.openid.issuer

The OpenID Connect authorization issuer.

Image Modified

    

abiquo.openid.jwks.endpoint

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

Image Modified

    

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.

Image Modified

    

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

Image Modified

    

abiquo.openid.token.endpoint

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

Image Modified

    

abiquo.openid.userinfo.endpoint

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

Image Modified

    

Anchor
openstack
openstack
abiquo.openstack.credentialType

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

 

Image Modified

   

Anchor
pluginmetadata
pluginmetadata
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.

Image Modified

   (star) (star) v3.10.2

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.

Image Modified

   (star) (star) v3.10.2

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

Image Modified

   (star) (star) v3.10.2

Anchor
pcr
pcr
abiquo.pcr.template.check.delay

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

Image Modified

   (star)(star)

Anchor
pcrsync
pcrsync
abiquo.pcrsync.retrydelayms

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

Image Modified

    

abiquo.pcrsyncpool

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

Image Modified

    

Anchor
rabbitmq
rabbitmq
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

Image Modified

Image Modified

Image Modified

  

abiquo.rabbitmq.host

Address where RabbitMQ is located
Default: 127.0.0.1

Image Modified

Image Modified

Image Modified

  

abiquo.rabbitmq.password

RabbitMQ password
Default: guest

Image Modified

Image Modified

Image Modified

  

abiquo.rabbitmq.port

Port where RabbitMQ is located
Default: 5672

Image Modified

Image Modified

Image Modified

  

abiquo.rabbitmq.requestedHeartbeat

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

Image Modified

Image Modified

Image Modified

  

abiquo.rabbitmq.username

RabbitMQ username
Default: guest

Image Modified

Image Modified

Image Modified

  

abiquo.rabbitmq.virtualHost

Virtual host where RabbitMQ runs
Default: /

Image Modified

Image Modified

Image Modified

  

Anchor
redis
redis
abiquo.redis.host

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

Image Modified

Image Modified

   

abiquo.redis.port

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

Image Modified

Image Modified

   

Anchor
repository
repository
abiquo.repository.timeoutSeconds

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

 

Image Modified

   

Anchor
security
security
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
Range: true, false

Image Modified

Image Modified

Image Modified

  

Anchor
server
server
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

Image Modified

Image Modified

   

abiquo.server.blockduplicatedsessions

Whether to take action if multiple users are logged in with the same account. If false, no action is taken. The user who logged in most recently will have true control of the session and actions by other users may cause problems. If true, the most recent user has control of the session and other users are warned and logged out. If not supplied, it is set to false.
Default: false

Image Modified

    

abiquo.server.mail.password

Password for connecting to the mail server
Default: none

Image Modified

    

abiquo.server.mail.server

Address where the mail server is located
Default: 127.0.0.1

Image Modified

    

abiquo.server.mail.user

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

Image Modified

    

abiquo.server.remoteSpace.default

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

Image Modified

    

abiquo.server.sessionTimeout

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

Image Modified

   (minus)(minus)

abiquo.server.timeout

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

Image Modified

    

Anchor
stale sessions
stale sessions
abiquo.stale.sessions.check.delay

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

Image Modified

    

Anchor
storage
storage
abiquo.storage.check.delay

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

Image Modified

    

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

Image Modified

    

Anchor
storagemanager
storagemanager
abiquo.storagemanager.netapp.aggrfreespaceratio

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

Image Modified

    

abiquo.storagemanager.netapp.debug

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

Image Modified

    

abiquo.storagemanager.netapp.initiatorGroupName

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

Image Modified

    

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
Range: 1.3 - 1.9

Image Modified

    

abiquo.storagemanager.nexenta.blocksize

The block size in KB for the volumes created in Nexenta storage devices. Abiquo does not validate this property. Abiquo supports values from 8 to 128 KB inclusive but Nexenta requires the value to be a power of 2.
Default: 8
Range: 8, 16, 32, 64, 128

 

Image Modified

   

Anchor
tasks
tasks
abiquo.tasks.history.size

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

Image Modified

    

abiquo.tasks.trimmer.delay

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

Image Modified

    

Anchor
vappspec
vappspec
abiquo.vappspec.retrydelayms

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

Image Modified

    

Anchor
vappspecpool
vappspecpool
abiquo.vappspecpool

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

Image Modified

    

Anchor
vcenter
vcenter
abiquo.vcenter.port.connection

Port for connection to vCenter
Default: 443

 

Image Modified

   

Anchor
virtual infrastructure
virtual infrastructure
abiquo.vi.check.delay

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

Image Modified

    

Anchor
virtualfactory
virtualfactory
abiquo.virtualfactory.azure.defaultLoginPassword

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

 

Image Modified

   

abiquo.virtualfactory.azure.defaultLoginUser

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

 

Image Modified

   

abiquo.virtualfactory.azure.retry.timeBetweenTriesInSeconds

Time to wait between polls during a retry
Default: 30

 

Image Modified

   

abiquo.virtualfactory.azure.retry.timeoutInSeconds

Timeout retrying an operation
Default: 900

 

Image Modified

   

abiquo.virtualfactory.azure.storageAccountPrefix

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

 

Image Modified

   

abiquo.virtualfactory.azure.wait.timeBetweenTriesInSeconds

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

 

Image Modified

   

abiquo.virtualfactory.azure.wait.timeoutInSeconds

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

 

Image Modified

   

abiquo.virtualfactory.hyperv.repositoryLocation

The CIFS address //IP/resource/ where Windows can locate the virtual disk repository.
Default: //<IP-repoLoc>/vm_repository

 

Image Modified

   

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 virtual machines.
Default: true
Range: true, false

 

Image Modified

   

abiquo.virtualfactory.networking.bridgePrefix

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

 

Image Modified

   

abiquo.virtualfactory.openSession

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

 

Image Modified

   

abiquo.virtualfactory.oraclevm.createSparseDisks

If true, create additional hard disks on the datastore as sparse.
Default: true
Range: true, false

 

Image Modified

   

abiquo.virtualfactory.oraclevm.defaultVMDomain

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

 

Image Modified

   

abiquo.virtualfactory.oraclevm.ha

If true, Abiquo creates VMs configured within Oracle VM for ‘High Availability’. This means Abiquo will deploy a VM for HA if the Oracle VM Server hosting the VM is part of a Clustered Server Pool. Note that when a VM is re-configured, Abiquo will NOT update the HA status of the VM. Please note that some manual configuration of Oracle VM may be required for HA to be performed successfully.
Default: false
Range: true, false

 

Image Modified

   

abiquo.virtualfactory.oraclevm.hardPartitioning

If true, enable Oracle VM Hard Partitioning support (CPU pinning).
Default: false
Range: true, false

 

Image Modified

   

abiquo.virtualfactory.oraclevm.hardPartitioningCPURatio

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

 

Image Modified

   

abiquo.virtualfactory.oraclevm.jobStatusCheckDelayMs

Polling period for the job status check to monitor the status of asynchronous hypervisor jobs (milliseconds). Defaults to 1 second, with a valid range of 0.1 second to 1 minute.
Default: 1000
Range: 100 - 60000

 

Image Modified

   

abiquo.virtualfactory.oraclevm.jobTimeoutMs

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

 

Image Modified

   

abiquo.virtualfactory.oraclevm.repositoryLocation

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

 

Image Modified

   

abiquo.virtualfactory.xenserver.repositoryLocation

The Storage Area network datastore location where the virtual disks are stored (usually the same as abiquo.appliancemanager.repositoryLocation).
Default: <IP-repoLoc>:/opt/vm_repository

 

Image Modified

   

com.abiquo.virtualfactory.esxi.timeoutConnectionMs

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

 

Image Modified

   

com.abiquo.virtualfactory.esxi.timeoutReadMs

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

 

Image Modified

   

Anchor
vncport
vncport
abiquo.vncport.max

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

Image Modified

    

abiquo.vncport.min

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

Image Modified

    

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

    • vmx_04
    • kvm
    • hyperv_301
    • oracle_vm
    • xenserver
    • amazon
    • azure

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

 

Image Modified

   

abiquo.vsm.backoff.enabled

Enable or disable backoff
Default: false

 

Image Modified

   

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

 

Image Modified

   

abiquo.vsm.measures.pusher.frequency

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

 

Image Modified

   

abiquo.vsm.pollingfrequency.{PC}

    • amazon
    • azure
    • 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
    • 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

 

Image Modified

  

(star) (star) azurecompute-arm
(minus) (minus) hpcloud-compute

abiquo.vsm.pollingfrequency.{HV}

    • vmx_04
    • kvm
    • hyperv_301
    • oracle_vm
    • xenserver

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

 

Image Modified

   

abiquo.vsm.vmmetrics.rewindonboot.{PLUGIN}

    • vmx_04
    • kvm
    • xenserver
    • amazon
    • vcd
    • docker

When the VSM starts up, the first metrics request by a virtual machine on (PLUGIN) is at the current time minus the minutes configured by this property.
Default: 60 

  Image RemovedImage Added   (warning) (warning) New in docs

abiquo.vsm.vmsyncfrequency.{PLUGIN}

    • vmx_04
    • kvm
    • hyperv_301
    • oracle_vm
    • xenserver
    • amazon
    • azure

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

 

Image Modified

   

Anchor
watchtower
watchtower
abiquo.watchtower.host

Address where watchtower is located
Default: 127.0.0.1

Image Modified

Image Modified

   

abiquo.watchtower.port

Port where watchtower is listening
Default: 36638

Image Modified

Image Modified

   

Anchor
vnc
vnc
RemoteDisplay.vnc.keyMap

ESXi only: When using a virtual machine as a VNC server, specify the language to use for the keyboard when supported VNC clients connect. If this property does not exist, the hypervisor will use the default value of config.keymaps in client-config-custom.json or client-config-default.json and the default in this case is the US101 keyboard map (US English). This property is now the default setting to complement the Virtual Machine configuration popup. See Configuring Remote Access to Virtual Machines. Not supported by noVNC.

 

Image Modified

   

Anchor
workflow
workflow
workflow.connect.timeout

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

Image Modified

    

workflow.read.timeout

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

Image Modified