This page describes how to configure the Abiquo user interface with UI configuration properties.
...
The default values are set in the client-config-default.json file. You can override the default values in the client-config-custom.json file.
Property _______________________ | Description _______________________ | Example |
---|---|---|
config.languages | Language definitions for each language file with a set of translated labels. Consists of:
| {"value":"en_US","name":"English","isDefault":true,"flagIconUrl": "theme/abicloudDefault/img/country_flags/united-states-of-america.svg"}
{"value":"fr_FR","name":"French","lcid":"1036"} |
config.keymaps | For configuring VM keyboards on ESXi hypervisors, users can select a keymap from the pulldown list. See VM general information. Configure keymaps in VMware first and then enter the Vmware keymap value and a name. See VMware Keyboard Map Documentation. The hypervisor's default keyboard map is the US101 keyboard map (US English). To configure a different default keyboard map, set the "RemoteDisplay.vnc.keyMap" property in the Abiquo Configuration Properties for Remote Services and then set the isDefault value to true for that keyboard. Warning: On ESXi for certain locales, when using remote access from a web client, some keystrokes do not translate. See https://kb.vmware.com/selfservice/microsites/search.do?language=en_US&cmd=displayKC&externalId=2071245 | {"value":"us", "name":"US English", "isDefault":true}, |
client.autoscaling.action.default | Default values for the automatic scaling action. See Configure default autoscaling actions | |
client.ostype.icon.{osType} | Full or relative URI of an icon to load for a template if it doesn't have an iconUrl. The osType of the template must exactly match the osType given here. If not, a generic icon will be used. | "client.ostype.icon.CENTOS": "theme/abicloudDefault/img/icon-ostype-centos.png", |
client.ostype.icon.generics | List of the client.ostype.icon marked as generic for an osType (non-strict osType compare). Example: WINDOWS_MYCUSTOM_VERSION will be resolved as client.ostype.icon.WINDOWS | "CENTOS" |
config.protocols |
To get an idea of how these protocols look in the UI, see Manage Firewalls | |
config.loadbalancerprotocols | Predefined protocols and preset options for load balancers. Very similar to the Firewall protocols. To get an idea of how these protocols look in the UI, see Manage Load Balancers | |
config.loadbalanceralgorithms | ||
config.loadbalancerroutingrulesprotocols | ||
config.loadbalancerhealthcheckprotocols | ||
config.loadbalancerhealthcheck.default.interval | Default interval value when creating load balancer healthcheck (in second). Can be empty (no default value). | |
config.loadbalancerhealthcheck.default.timeout | Default timeout value when creating load balancer healthcheck (in second). Can be empty. Can be empty (no default value). | |
config.loadbalancerhealthcheck.default.attempts | Default attempts value when creating load balancer healthcheck (value between 0 and 10). Can be empty (no default value). | |
config.loadbalanceraddressesreuse | ||
config.loadbalanceraddressestype | Override load balancer addresses type by hypervisor/device. Default value is an empty object(config.loadbalanceraddressestype: {}) To define values for an hypervisor/device, add a new property with the name of the hypervisor/device and set the list of accepted values. Values accepted: ["PRIVATE","PUBLIC","PRIVATE_AND_PUBLIC","NATIP","PRIVATE_AND_NATIP"] When private IPs are not allowed, do not display the private subnets section | "config.loadbalanceraddressestype" : { |
config.loadbalancersubnetstype | Override load balancer subnets type by hypervisor/device. Default value is an empty object(config.loadbalancersubnetstype: {}) To define values for an hypervisor/device, add a new property with the name of the hypervisor/device and set the list of accepted values. Values accepted: ["PRIVATE","EXTERNAL"] | "config.loadbalancersubnetstype" : { |
config.monitoringstatistics | Monitoring statistics can restrict the available metrics | |
config.monitoringperiods | ||
egg.speak | Speak error messages with Egg Speak. By default, this experimental feature is not enabled | |
config.endpoint |
| |
api.version |
| |
client.id |
| |
client.backto.url |
| |
client.modalblocker.timeout.milliseconds |
| |
client.themes | See Abiquo Branding Guide and Abiquo Branding Admin Guide | |
client.window.title | Browser tab title for Abiquo window | |
client.google.analytics.id | ||
client.google.analytics.url | ||
rdpaccess.usesslproxy | If false, allow insecure HTTP connections to Hyper-V VMs (not recommended). | |
client.captcha.publickey | Captcha public key. When users can reset their passwords in Abiquo, you can use ReCaptcha. To enable ReCaptcha for Abiquo, request keys from this link: https://www.google.com/recaptcha/admin#createsite. Set the private key value for abiquo.captcha.private.key in abiquo.properties. See Abiquo Configuration Properties#captcha. See also Configuration View#Password | |
client.external.js.loader.url |
| |
client.google.maps.enabled |
| |
client.google.maps.key |
| |
client.password.recovery | If the system property to Allow password reset is false (see Configuration View#Password), set this option to false to hide the "Forgot your password" link. | |
client.offline |
| |
config.enterprise.properties | ||
client.backup |
| |
config.enterprise.onlyuseproviders | If true, group regions by provider and group vCloud Director regions by endpoint when editing tenants to allow access to provider regions and when creating, editing, and displaying scopes, and so on | true |
client.backup.policies.poweredvmeditable | If true, allow user to edit backup policies in VMs that are powered on | |
client.backup.policies.multipleselectionallowed | If true, allow user to select multiple policies for a VM | |
client.backup.restore.allowreplicabackuprestore | If true, display Restore link for backups with replication, allowing the user to restore these backups | |
client.openid.enabled |
| |
client.openid.skip.login.view |
| |
client.skip.login.view |
| |
client.header.link.usersmanagement | URL of external link to open from users management button in main menu. See Add external link in Abiquo header menu | |
client.footer.about.hide | Hide external About link in footer | |
client.footer.support.hide | Hide external Support link in footer | false |
client.virtualmachine.guestinitialpassword.enabled | If true, if the user created a VM with guest setup, display the key button on the VM control panel. After deploy, the VM owner (or a user with the Display initial virtual machine password privilege) can click the key button to display the initial guest password. See Guest setup | true |
client.wiki.version | Wiki space to use for wiki links to Abiquo documentation, for example, "doc" for current version or "ABI40" after a new version is released | "doc" |
config.harddiskcustomcontrollertypes | List of controller types to display pull-down list when user adds a virtual disk to a VM. See Display custom list of controllers when adding virtual disk to VM. | |
config.harddiskcustomcontrollers | List of controllers to display pull-down list when user adds a virtual disk to a VM. See Display custom list of controllers when adding virtual disk to VM. | |
client.classicfirewalls.enabled | Display classic firewalls tab in the UI | false |
client.cookies.policy.url | URL of your privacy policy file. See Configure a cookie message and privacy policy | "https://www.abiquo.com/Privacy-Policy/ " |
client.cookies.cookiespolicy.url | URL of your cookies policy file. See Configure a cookie message and privacy policy | "" |
client.header.externalurlicons | List of URL objects with role IDs and symbols. See Add role based external links to the main menu | "client.header.externalurlicons" : [ |
client.dashboard.widgets.defaultvalues | Starting threshold for highest and lowest usage panels for CPU and RAM on the Optimization dashboard. See Optimization | "client.dashboard.widgets.defaultvalues": { |
client.dashboard.widgets.mindaysdeployed | Starting threshold for longest time deployed panel on the Optimization dashboard. See Optimization | 90 |
client.dashboard.widgets.lastbills.lastmonths | On the Hybrid billing dashboard, the number of months to display bills for. | 5 |
client.dashboard.widgets.lastbills.currenciesconversions | On the Hybrid billing dashboard, currency and conversion to another currency with a conversion rate. The inside currencyCode currency is multiplied by the conversion value to give the amount in the outside currencyCode currency. The example shows a conversion from euros to US dollars. The value of month is set to default, but you can specify a value for each month of the year (from 1 (January) to 12 (December)). You have to specify the year too (mandatory). If a specific value is present for the current month and year, the platform will use it; otherwise, it will use the default. Additionally, you need to add the new currencyLabel in each lang_xx_XX.json with the corresponding currencyCode Ex: "dashboard.lastbills.label.currency.USD":"Dollar", | { { "month": 12, }] |
client.asynctask.missingvars.schema | JSON schema to define the required variables for creating a virtual datacenter with NSX-ECMP. See Create more than one VDC in NSX ECMP | |
client.budget.currencies | Currencies to use for budgets. If an enterprise in a hierarchy uses another currency and it has an enterprise property for a conversion_factor, use this property to perform the conversion. | {"label": "€", "value": "EUR"} |
client.login.modules | Abiquo login modules to use with options for Basic Auth (default), Open ID, and SAML. See client-config-default.json for configuration examples. SAML and Open ID have cookies to store the user's login module in order to load it when the user opens the UI. | |
client.2fa.activated | If false, do not display the option in the username menu to allow customers to activate 2fa, even if it is available on the platform | true |
client.vm.datastoretiers.useonlyrecommended | If set to true, if VM is not deployed, then display recommended DS tiers only, and if the VM is deployed, display all compatible tiers. | false |
Default UI configuration
A sample UI config file for the current version is included here.
Abiquo
...
5.
...
0 client-config-default.json
Note that Abiquo will replace the api.location and api.version variables during the install process.
Expand | ||
---|---|---|
|
More configuration pages
...