Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: 4.4.0 - group regions by providers

Table of Contents

Excerpt


  • The default Guacamole remote access configuration supports the config.keymaps property
  • Deprecated "client.remoteaccess.novnc.host" and "client.remoteaccess.novnc.port" properties
  • New "client.virtualmachine.guestinitialpassword.enabled" property
    Info
    titleChanges to UI config in Abiquo 4.2
    titleChanges to UI config in Abiquo 4.4
    • New "config.enterprise.onlyuseproviders" property to group public cloud regions by providers



    UI configuration properties

    ...

    Warning

    When customizing client UI with values in the client-config-custom.json file, you must:

    • Only add neccessary customizations to avoid inadvertantly overriding future default values
    • For each customization add a top level element with a complete set of values because your new configuration will override all previous elements, for example, if the element is a list, add a full list of values

    Property

    _______________________

    Description

    _______________________

    Example
    config.enterprise.onlyuseprovidersIf true, group clouds by provider when editing tenants to allow provider regions and when creating, editing, and displaying scopestrue

    config.languages

    Language definitions for each language file with a set of translated labels. Consists of:

    • language code
    • language name for the login menu 
    • default setting

    See  Abiquo UI Client Language Configuration

    {"value":"en_US","name":"English","isDefault":true},
    {"value":"es_ES","name":"Spanish"}

    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},
    {"value":"uk", "name":"UK English"},
    {"value":"es", "name":"Español"}

    config.protocols

    • Predefined values for firewall protocols. 
      • When users edit a firewall rule, they can select from the "Common protocols" as a guide to the standard ports for these protocols. As this is a guide only, users can edit all of the values as required. 
      • The port values for ALL PROTOCOL selections are fixed and users cannot edit the ports after they select these guides. In this case the user can only edit the Protocol and the Sources. To clear the port values, the user can change to another option

    To get an idea of how these protocols look in the UI, see Manage Firewalls

    {"value":"Custom protocol", "protocol":"", "port":"-" },
    {"value":"Own TCP rule", "protocol":"TCP", "port":"-" },
    {"value":"Own UDP rule", "protocol": "UDP", "port":"-" },
    {"value":"All Traffic", "protocol":"ALL", "port":"ALL" },
    {"value":"All TCP", "protocol":"TCP", "port":"ALL" },
    {"value":"All UDP", "protocol":"UDP", "port":"ALL" },
    {"value":"All ICMP", "protocol":"ICMP", "port":"ALL" },
    {"value":"SSH", "protocol":"TCP", "port":22 },
    {"value":"SMTP", "protocol":"TCP", "port":25 },
    {"value":"DNS", "protocol":"UDP", "port":53 },
    {"value":"HTTP", "protocol":"TCP", "port":80 },
    {"value":"POP3", "protocol":"TCP", "port":110 },
    {"value":"IMAP", "protocol":"TCP", "port":143 },
    {"value":"LDAP", "protocol":"TCP", "port":389 },
    {"value":"HTTPS", "protocol":"TCP", "port":443 },
    {"value":"SMTPS", "protocol":"TCP", "port":465 },
    {"value":"IMAPS", "protocol":"TCP", "port":993 },
    {"value":"POP3S", "protocol":"TCP", "port":995 },
    {"value":"MS SQL", "protocol":"TCP", "port":1433 },
    {"value":"MYSQL", "protocol":"TCP", "port":3306 },
    {"value":"RDP", "protocol":"TCP", "port":3389 }

    config.loadbalancerprotocols

    Predfined 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

    {"value":"Custom protocol", "protocol":"", "port":"-" },
    {"value":"Own TCP rule", "protocol":"TCP", "port":"-" },
    {"value":"Own UDP rule", "protocol": "UDP", "port":"-" },
    {"value":"All Traffic", "protocol":"ALL", "port":"ALL" },
    {"value":"All TCP", "protocol":"TCP", "port":"ALL" },
    {"value":"All UDP", "protocol":"UDP", "port":"ALL" },
    {"value":"All ICMP", "protocol":"ICMP", "port":"ALL" },
    {"value":"SSH", "protocol":"TCP", "port":22 },
    {"value":"SMTP", "protocol":"TCP", "port":25 },
    {"value":"DNS", "protocol":"UDP", "port":53 },
    {"value":"HTTP", "protocol":"TCP", "port":80 },
    {"value":"POP3", "protocol":"TCP", "port":110 },
    {"value":"IMAP", "protocol":"TCP", "port":143 },
    {"value":"LDAP", "protocol":"TCP", "port":389 },
    {"value":"HTTPS", "protocol":"TCP", "port":443 },
    {"value":"SMTPS", "protocol":"TCP", "port":465 },
    {"value":"IMAPS", "protocol":"TCP", "port":993 },
    {"value":"POP3S", "protocol":"TCP", "port":995 },
    {"value":"MS SQL", "protocol":"TCP", "port":1433 },
    {"value":"MYSQL", "protocol":"TCP", "port":3306 },
    {"value":"RDP", "protocol":"TCP", "port":3389 }

    config.loadbalanceralgorithms ROUND_ROBIN","LEAST_CONNECTIONS","SOURCE_IP"
    config.loadbalancerroutingrulesprotocols "TCP","HTTP","HTTPS"
    config.loadbalancerhealthcheckprotocols "PING","TCP","HTTP","HTTPS"
    config.loadbalancerhealthcheck.default.interval

    Default interval value when creating load balancer healthcheck (in second).

    Can be empty (no default value).

    15
    config.loadbalancerhealthcheck.default.timeout

    Default timeout value when creating load balancer healthcheck (in second). Can be empty.

    Can be empty (no default value).

    20
    config.loadbalancerhealthcheck.default.attempts

    Default attempts value when creating load balancer healthcheck (value between 0 and 10).

    Can be empty (no default value).

    2
    config.loadbalanceraddressesreuse false
    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"]

    {

    "nsx-gateway":["PRIVATE","PUBLIC"],
    "nsx-nat":["PRIVATE","NATIP"]
    }

    config.monitoringstatistics

    Monitoring statistics can restrict the available metrics

    {"value":"average", "name":"Average"},
    {"value":"maximum", "name":"Maximum"},
    {"value":"minimum", "name":"Minimum"},
    {"value":"sum", "name":"Sum"},
    {"value":"count", "name":"Count"},
    {"value":"dev", "name":"Deviation"}

    config.monitoringperiods 

    {"value":"hours", "name":"Hours"},
    {"value":"days", "name":"Days"}

    egg.speak

    Speak error messages with Egg Speak. By default, this experimental feature is not enabledfalse

    config.endpoint

    • URL of the API where the client can connect to the API
    • Abiquo users require direct access to the Abiquo API because the UI client interacts with the API directly. 
    • You would usually install the Abiquo UI together with the Abiquo Server, but you can install it separately. 
    • As part of the post-install configuration process, Abiquo asks you for the API endpoint and sets it. However, you can change this value to point to a load balancer, etc.
    From Abiquo 4.0, the default is the domain URL
    e.g. https://myabiquoserver.bcn.abiquo.com/api

    api.version

    • Mandatory version of the API to specify version for mediatypes in API requests
    • As part of the post-install configuration process, Abiquo sets this version and updates it during upgrades
    3.10
    client.id
    • Custom integration parameter
    "abiquo_client_id"

    client.backto.url

    • If there is no value set for the Redirect to this URL after logout (empty -> login screen) system property in Configuration View, when the user logs out, Abiquo will check for this URL and redirect to it. If it is not supplied, Abiquo will redirect to the login screen
    • This URL is also used when a redirect is necessary before the user has fully logged in. At this time, the application cannot access the logout redirect URL system property because it does not have access to the database yet
     
    client.modalblocker.timeout.milliseconds
    • Control the timeout for browser popup blocker
    800

    client.themes

    See Abiquo Branding Guide and Abiquo Branding Admin Guide["abicloudDefault"]

    client.window.title

    Browser tab title for Abiquo window

    ["Abiquo"]
    client.google.analytics.id  
    client.google.analytics.url  
    rdpaccess.usesslproxyIf false, allow insecure HTTP connections to Hyper-V VMs (not recommended).true
    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
    • Load custom JavaScript or HTML

    • You may want to add customized Javascript or HTML content to the UI. You can select a file which will be loaded in all Abiquo UI pages and may help you integrate UI with 3rd-party products or enhance a particular aspect of Abiquo

    • The default HTML file (externaljsloadertemplate.html) is located in the root path of the UI
    • You can add content to this file or you can specify the URL of a custom file
    externaljsloadertemplate.html

    client.google.maps.enabled

    • If your environment is not connected to the Internet, disable Google maps
    true
    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.true
    client.offline
    • Use the Abiquo UI in offline mode, which will prevent Abiquo from loading external libraries, set this option to true.
    false
    config.enterprise.properties 

    client.backup (minus)

     
    client.backup.policies.poweredvmeditableIf true, allow user to edit backup policies in VMs that are powered onfalse
    client.backup.policies.multipleselectionallowedIf true, allow user to select multiple policies for a VMfalse
    client.backup.restore.allowreplicabackuprestoreIf true, display Restore link for backups with replication, allowing the user to restore these backupstrue

    client.openid.enabled

    true

    client.openid.skip.login.view

    true
    client.header.link.usersmanagementURL of external link to open from users management button in main menu. See Add external link in Abiquo header menu 
    client.footer.about.hideHide external About link in footerfalse
    client.footer.support.hideHide external Support link in footerfalse

    client.virtualmachine.guestinitialpassword.enabled

    If true, if the user created a VM and it is deployed, display the key button on the VM control panel. The user can click the key button to display the initial guest password. See Guest setup

    true
    client.wiki.versionWiki 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.harddiskcustomcontrollertypesList 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.   

     

    Examples of Custom and Default UI configuration

    ...