Abiquo Documentation Cookies Policy

Our Documentation website uses cookies to improve your experience. Please visit our Cookie Policy page for more information about cookies and how we use them.


Abiquo Documentation

Skip to end of metadata
Go to start of metadata

Privilege: Access Configuration view, Modify configuration data

Introduction to Configuration view

 

In Configuration view, administrators configure many aspects of the platform, including the user interface, infrastructure defaults, password security and so on.

If you have the appropriate permissions, you can access the Configuration view by clicking the Configuration view icon at the top of the screen. The Configuration view consists of two main sections: System Properties and Licenses. Within the system properties section there are five other sections: General, Infrastructure, Network, Dashboard, Wiki links and Security.

Configuration view changelog

Deleted Configuration view properties in Abiquo 4.4. The following properties were replaced with privileges:

  • Enable hybrid dashboard tab

  • Enable optimization dashboard tab

New wiki links in Abiquo 4.4

  • Manage excluded networks
  • Manage NAT
  • Manage NAT IPs
  • Manage VPNs
  • Manage classic firewalls

New Configuration view properties in Abiquo 4.2
  • Guest password email enabled
  • Guest password SMS gateway

Changes to wiki links in Abiquo 4.2

  • There have been numerous changes to wiki links in Abiquo 4.2, in relation to the restructuring of the Abiquo wiki. See Redirected wiki links

New Configuration view properties in Abiquo 4.0.2

  • Enable virtual machine monitoring by default: if this property is enabled and monitoring is configured (see Configure VM Monitoring and Metrics and Abiquo Configuration Properties#monitoring), by default Abiquo will fetch metrics for each virtual machine and display all metrics on the virtual machine graph. By default this property is disabled. In the API, the value of client.main.monitorEnabled system property is set to 0 (disabled) or 1 (enabled).

Changes to Configuration view properties in Abiquo 4.0

  • The Netmask value for the network mask of the default private VLAN has changed from 22 to 24

Changes to wiki links in Abiquo 4.0.x

  • Abiquo now configures the wiki links version using the {client.wiki.version} notation in each wiki link. You can set the version of the wiki to use in the client-config-custom.json file. See Configure Abiquo UI

New wiki links in Abiquo 4.0

  • Manage hardware profiles

  • Manage backup manager

  • Manage scaling group

Changes to wiki links in Abiquo 4.0

  • Manage action plans and task schedules
  • Synchronize public cloud

 

System Properties

API Documentation

For the Abiquo API documentation of this feature, see Abiquo API Resources and the page for this resource SystemPropertyResource.

The system properties tab allows the cloud administrator to view and change the properties that are currently used in each client by default.

The tab has the following pages: Infrastructure, Network, Dashboard, General, Wiki Links and Password.

Configuration

General

Default

Notes

Info

Logo file

theme/abicloudDefault/img/logo.png

Directory and filename of the tenant logo file. The directory is relative to the Abiquo installation directory. The logo file should be a .png, .jpg or other web compatible image file. The resolution should be 72 ppi and the image size should be 130 x 70 pixels

 

Enable tutorials

(tick)


 

Elements per page in main lists

25


 

URL displayed when the enterprise logo is clicked

http://www.abiquo.com

This web page will be displayed when the Abiquo server has access to the URL

 

Display Report button linked to this URL (empty -> no Report button display)

 

To display the report button, enter the report URL here. Clicking the icon will open this page and pass the user's enterprise as a parameter (in the form ?enterprise=1). Users must also have the Access Reports privilege in order to display the report icon and access the report page. By default this privilege is assigned to the cloud admin role

 

Allow user to change their password

(tick)

Mark this checkbox to enable users to open a popup to edit their personal details by clicking on the link in the top right corner of the screen. The user personal details include the password if platform authentication is used. The information that can be edited varies, depending on the user. If this option is disabled, the user details can only be edited in Users view

 

Allow user to log out

(tick)

Allow users to log out by clicking on the "logout" link in the top right corner of the screen. Otherwise the link will not be displayed, and users will only be logged out when their browser session ends

 

Show virtual machine hard disk tab

(tick)

Display the virtual machine hard disk tab.

 

Redirect to this URL after logout (empty -> login screen)

 

If no URL is supplied, the login screen is opened after logout

 

Default view after login

Home

Select from the pull-down list of Abiquo views - Home, Infrastructure, Virtual Datacenters, etc. The Home view is the system default. If another view is set as the system default and the user does not have enough privileges to open it, the Home view will open.

 

Show details of soft limits when reached

(tick)

If this option is not selected, the soft limits message will state that the limits have been reached and allow the user to decide if they want to continue

 

Show details of hard limit when reached

(tick)

If this option is not selected, the hard limits message will state that the limits have been reached and that the operation cannot be performed

 

Workflow endpoint

 

Enter the URL endpoint for the workflow process. If workflow is enabled, Abiquo will send workflow requests to this URL. The workflow endpoint is the URL of the web application that connects to the workflow tool. If you do not have the URL for the workflow endpoint, check with your system administrator

 

Enable workflow

(error)

If workflow is enabled, in Virtual Datacenters view, the Workflow Tasks tab will display queued tasks. Before you enable workflow, enter the Workflow endpoint, otherwise tasks in progress will fail because of the missing endpoint

 

Enable virtual machine monitoring by default

(error)

If this property is enabled and monitoring is configured (see Configure VM Monitoring and Metrics and Abiquo Configuration Properties#monitoring), by default Abiquo will fetch metrics for each virtual machine and display all metrics on the virtual machine graph. By default this property is disabled. This property will apply to all virtual machines created after you change its value, including newly captured virtual machines. In the API, the value of client.main.monitorEnabled system property is set to 0 (disabled) or 1 (enabled)

(star) 4.0.2

Infrastructure

Default

Notes

Info

Default Abiquo template repo (will not be created if empty)

http://abiquo-repository.abiquo.com/ovfindex.xml

 

Refresh interval for remote template download progress (seconds)

10

How often the background process will check the download to update the progress bar when you Add VM Template from Remote Repository to the appliance library of a datacenter. The update interval is indicated by a countdown timer in the lower right corner of the screen

 

Default latitude for datacenters map

41.3825

The decimal latitude of the map location you will see when OpenStreetMap opens in the Infrastructure view. The default value is for Barcelona

 

Default longitude for datacenters map

2.176944

The decimal longitude of the map location you will see when OpenStreetMap opens in the Infrastructure view. The default value is for Barcelona

 

Default zoom level for datacenters map

4


 

Refresh interval for infrastructure data (seconds)

30

More than one cloud administrator can work with the same Abiquo platform at the same time. Thus the infrastructure page is updated so that changes in datacenters are propagated to all servers. The update interval is indicated by a countdown timer in the lower right corner of the screen in Infrastructure view

 

Refresh interval for event log (seconds)

10

How often Abiquo updates the display of the event log in the Home View

 

Number of IP addresses in lists

25


 

Allow remote access to virtual machines

(tick)

When enabled, you can click the eye icon for a virtual machine within a virtual datacenter to open a hypervisor shell window. This option does not affect remote shell access (e.g. ssh). Otherwise, the eye icon is disabled. For more information see Configure Remote Access to Virtual Machines

 

Refresh interval for virtual appliance deployment progress (seconds)

5

How often the background process checks the deployment of virtual appliances and updates the virtual appliance state. Indicated by a countdown timer in the bottom right corner of the screen on the Virtual Appliance page. For more information please see Manage Virtual Appliances

 

Refresh interval for virtual appliance (seconds)

30

How often the background process checks the state of virtual appliances and updates the state. Indicated by a countdown timer in the bottom right corner of the screen on the Virtual Appliance page. For more information please see Manage Virtual Appliances

 

Default hypervisor password

temporal


 

Default hypervisor port

 


 

Default Hypervisor user

root


 

Allowed virtual storage volume sizes (gigabytes)

1,2,4,8,16,32,64,128,256

Values displayed in gigabytes on the form for adding a new volume to a virtual datacenter. Enter values separated by commas with no spaces. You can enter values with decimal places and values lower than one

 

Default minimum VLAN ID

2


 

Default maximum VLAN ID

4094


 

Refresh interval for missing VM template conversions (seconds)

5

When you edit a virtual machine template in your appliance library (uploaded from local machine/downloaded from repository), you can launch a background process to generate all the missing template formats for other hypervisors. In the template formats list, the state of all template conversions is indicated and it gets refreshed by a background process. Because this is a pop-up screen, there is no countdown timer

 

Max quantity of IPs to create

1022


 

Network

Default

Notes

Info

Network

 

Default private VLAN for virtual datacenters

 

Name

default_private_network

The name of the default private VLAN

 

Netmask

24

The network mask of the default private VLAN

(warning)

Network address

192.168.0.0

The network address of the default private VLAN

 

Gateway

192.168.0.1

The gateway of the network. Make sure the gateway is an IP address inside the range defined by the network address and the network mask

 

Primary DNS

 


 

Secondary DNS

 


 

DNS suffix

 


 

Dashboard

Default

Notes

Info

URL of documentation home page

http://wiki.abiquo.com

 

Show Users button on main toolbar

(tick)

If selected, the users button is displayed, and both cloud administrators and enterprise administrators can edit users. If not selected, no users icon is displayed and no one can edit users until the cloud administrator changes this option

 

Refresh interval for dashboard (seconds)

30

Time interval between updates of the monitoring dashboard of the Home View to allow multiple users to make and see changes. Indicated with a countdown timer in the lower right-hand corner of the screen

 

URL to purchase licenses

///www.abiquo.com/license

URL that will be shown in Abiquo to enable users to purchase licenses

 

Enable maintenance mode(error)Enable the display of maintenance window notices(star)
Maintenance start time
This attribute is used to specify the start of the maintenance period in Javascript date-time format: yyyy-mm-ddTHH:MM:ss.lo
For example, 2018-10-19T11:00:00.000+0200
(star)
Maintenance end time
This attribute is used to specify the end of the maintenance period in Javascript date-time format: yyyy-mm-ddTHH:MM:ss.lo
For example, 2018-10-20T11:00:00.000+0200
(star)
Additional maintenance info URL
Link in the maintenance popup to add additional information about this feature(star)
Security

Default

Notes

Info

Enable two-factor authentication

(error)


 

No. of previous passwords that cannot be repeated

1

Set a history value to prevent users from repeating old passwords. The platform will check new passwords against the password history. The range of values is 0 to 100, and the default value of 1 password means that users cannot repeat the previous password. To disable this check, set the value to 0

 

Maximum password age (days)

0

Prevent users from keeping the same password for a long time by setting a maximum password age. The range of values is from 0 to 999 days. To disable this check, set the value to 0

 

Minimum time between password changes (days)

0

Prevent users from quickly changing their password, especially back to an old password by setting a minimum password age. This is the minimum time from when a password is changed until the password can be changed again. The range of values is from 0 to 999 days. To disable this check, set the value to 0

 

Minimum password length

8

Prevent users from creating short passwords that are easier to break by setting a minimum password length. The range of values is from 1 to 21 characters

 

Require complex password

(error)

If selected, the user must enter a complex password. A complex password must not contain the user's name and must include at least three of the following five categories - uppercase letters, lowercase letters, digits, non-alphanumeric characters and other unicode characters

 

Tries before user account is locked

0

Number of unsuccessful login attempts that a user can make before their account is locked. The range of values is 0 to 5 tries. The default value of 0 means that the check is disabled by default

 

Account lock duration (minutes)

1

Length of time in minutes that a user account is locked after the user has made too many unsuccessful login attempts. The range of values is from 1 to 60 minutes

 

Allow password reset

(error)

If selected, the platform will allow a user to reset their password. See Configure Passwords. Further configuration and ReCaptcha is required

 

Reset password URI

http://localhost/ui/

Enter a URI that the platform will redirect to when users request a password reset. See Configure Passwords.

 

Guest password email enabled(error)Send guest password by email to the user email address. To configure guest password length and characters, see Abiquo Configuration Properties#guest

(star) 3.10.8

4.2.0

Guest password SMS gateway
The URL of an SMS gateway (e.g. email.smsgateway.com) for sending guest password by SMS. Leave empty to disable this feature. The platform will send an email to {{user phone number}}@{{sms gateway}}.(star) 3.10.8 4.2.0

Default

Notes

Info

Show help button

(tick)

To display the help icon on all pop-ups, mark the Show help icon checkbox. This icon will take the user to the specific help page for the pop-up or the default help page

 

Show default help button

(error)

If there is no specific help page for a pop-up, show a default help page

 

Default help URL

http://wiki.abiquo.com/display/doc/Abiquo+Documentation+Home

To show the help icon on pop-ups without specific help pages. Otherwise, the default help icon will not display

 

Wiki links

Infrastructure

Default

Info

Create datacenter

http://wiki.abiquo.com/display/doc/Manage+Datacenters+and+Public+Cloud+Regions

 

Edit datacenter

http://wiki.abiquo.com/display/doc/Manage+Datacenters+and+Public+Cloud+Regions#ManageDatacentersandPublicCloudRegions-ModifyaDatacenteroraPublicCloudRegion

 

Manage remote services

http://wiki.abiquo.com/display/doc/Manage+Datacenters+and+Public+Cloud+Regions#ManageDatacentersandPublicCloudRegions-ManageRemoteServices

 

Edit remote service

http://wiki.abiquo.com/display/doc/Manage+Datacenters+and+Public+Cloud+Regions#ManageDatacentersandPublicCloudRegions-ModifyRemoteServices

 

Create physical machine

http://wiki.abiquo.com/display/doc/Compute+in+Datacenters#ComputeinDatacenters-CreateMachines

 

Create rack

http://wiki.abiquo.com/display/doc/Compute+in+Datacenters#ComputeinDatacenters-CreateRacks

 

Mail notification

http://wiki.abiquo.com/display/doc/Compute+in+Datacenters#ComputeinDatacenters-SendingEmailNotifications

 

Manage hardware profiles

http://wiki.abiquo.com/display/doc/Hardware+profiles


Create public VLAN

http://wiki.abiquo.com/display/doc/Manage+Public+Networks

 

Create external VLAN

http://wiki.abiquo.com/display/doc/Manage+External+Networks

 

Manage devices

http://wiki.abiquo.com/display/doc/Manage+Devices

 

Create storage device

http://wiki.abiquo.com/display/doc/Manage+Storage#ManageStorage-CreatePersistentStorageDevices

 

Create storage pools

http://wiki.abiquo.com/display/doc/Manage+Storage#ManageStorage-StoragePools

 

Edit tiers

http://wiki.abiquo.com/display/doc/Manage+Storage#ManageStorage-ManageStorageServiceLevelswithTiers

 

Manage datastore tiers

http://wiki.abiquo.com/display/doc/Manage+Datastore+Service+Levels+with+Datastore+Tiers

 

Set global allocation rules

http://wiki.abiquo.com/display/doc/Allocation+Rules#AllocationRules-GlobalRulesManagement

 

Set datacenter allocation rules

http://wiki.abiquo.com/display/doc/Allocation+Rules#AllocationRules-DatacenterRulesManagement

 

Manage backup policies

http://wiki.abiquo.com/display/doc/Backup

 

Edit backup policy properties

http://wiki.abiquo.com/display/doc/Backup#Backup-ConfigureBackupPolicyProperties

 

Manage backup manager

http://wiki.abiquo.com/display/doc/Backup


Virtual datacenters

Default

Info

Create virtual datacenter

http://wiki.abiquo.com/display/doc/Manage+Virtual+Datacenters#ManageVirtualDatacenters-Createavirtualdatacenter

 

Synchronize public cloud

http://wiki.abiquo.com/display/doc/Manage+Virtual+Datacenters#ManageVirtualDatacenters-OnboardfromPublicCloud


Create virtual appliance

http://wiki.abiquo.com/display/doc/Manage+Virtual+Appliances#ManageVirtualAppliances-CreateaVirtualAppliance

 

Create virtual appliance based on spec

http://wiki.abiquo.com/display/doc/Manage+Virtual+Appliances#ManageVirtualAppliances-Createavirtualappliancebasedonaspec

 

Create virtual appliance spec

http://wiki.abiquo.com/display/doc/Save+VApp+Configurations+as+Specs#SaveVAppConfigurationsasSpecs-Createaspectosavevirtualapplianceconfiguration

R

Create private network

http://wiki.abiquo.com/display/doc/Manage+Networks#ManageNetworks-Createaprivatenetwork

 

Create public network

http://wiki.abiquo.com/display/doc/Manage+Networks#ManageNetworks-ObtainIPaddressesfrompublicnetworks

 

Create network IP

http://wiki.abiquo.com/display/doc/Manage+Networks#ManageNetworks-AddIPstoprivatenetworksindatacenters

 

Create volume

http://wiki.abiquo.com/display/doc/Manage+Virtual+Storage+in+Datacenters#ManageVirtualStorageinDatacenters-CreatingaVolumeofManagedStorage

Edit virtual machine

http://wiki.abiquo.com/display/doc/Configure+Virtual+Machines

 

Create VM network interface

http://wiki.abiquo.com/display/doc/VM+network

 

Create VM instance

http://wiki.abiquo.com/display/doc/Create+Virtual+Machine+Instances

 

Create persistent VM

http://wiki.abiquo.com/display/doc/Create+Persistent+Virtual+Machines+in+Datacenters

R

Capture VM

http://wiki.abiquo.com/display/doc/Import+and+Capture+Virtual+Machines

 

More info while deploying VApp

 

 

Create VM layer

http://wiki.abiquo.com/display/doc/Configure+VM+High+Availability#ConfigureVMHighAvailability-CreateanAnti-affinityLayer

R

Manage scaling group

http://wiki.abiquo.com/display/doc/Manage+scaling+groups

R

Create/edit firewall

http://wiki.abiquo.com/display/doc/Manage+Firewalls#ManageFirewalls-Createafirewall

Edit firewall rules

http://wiki.abiquo.com/display/doc/Manage+Firewalls#ManageFirewalls-Editfirewallrules

Create/edit load balancer

http://wiki.abiquo.com/display/doc/Manage+Load+Balancers

Manage virtual machine alarms

http://wiki.abiquo.com/display/doc/VM+Alarms#VMAlarms-Createanalarm

 

Manage virtual appliance alerts

http://wiki.abiquo.com/display/doc/Manage+Monitoring+Alerts#ManageMonitoringAlerts-Createalertsforvirtualmachines

R

Manage action plans and task schedules

http://wiki.abiquo.com/display/doc/Manage+action+plans+and+triggers

R

Apps library

Default

Info

VM template upload

http://wiki.abiquo.com/display/doc/Add+VM+Templates+to+the+Apps+Library#AddVMTemplatestotheAppsLibrary-UploadTemplatesfromtheLocalFilesystem

 

Edit VM template

http://wiki.abiquo.com/display/doc/Modify+a+VM+Template

 

Export VM template

http://wiki.abiquo.com/display/doc/VM+Template+Mobility

 

Manage spec versions

http://wiki.abiquo.com/display/doc/Manage+virtual+appliance+specs#ManageVirtualApplianceSpecs-Definetheversionofaspectouse

 

Users

Default

Info

Create enterprise

http://wiki.abiquo.com/display/doc/Manage+Enterprises#ManageEnterprises-CreateanEnterprise

 

Datacenter limits

http://wiki.abiquo.com/display/doc/Manage+Enterprises#ManageEnterprises-LimitResourcesforanEnterpriseinaLocation

 

Create user

http://wiki.abiquo.com/display/doc/Manage+Users#ManageUsers-CreateorEditaUser

 

Create role

http://wiki.abiquo.com/display/doc/Manage+Roles

 

Create scope

http://wiki.abiquo.com/display/doc/Manage+Scopes

 

Pricing

Default

Info

Create currency

http://wiki.abiquo.com/display/doc/Pricing+View#PricingView-ManageCurrencies

 

Create cost code

http://wiki.abiquo.com/display/doc/Pricing+View#PricingView-ManageCostCodes

 

Create pricing template

http://wiki.abiquo.com/display/doc/Pricing+View#PricingView-ManagePricingModels

 

Configuration

Default

Info

Configuration tab

http://wiki.abiquo.com/display/doc/Configuration+View

 

License tab

http://wiki.abiquo.com/display/doc/Configuration+View#ConfigurationView-LicenseManagement

 

 

 

License Management

API Documentation

For the Abiquo API documentation of this feature, see Abiquo API Resources and the page for this resource LicenseResource.

Abiquo licensing is based on managed CPU cores. When purchasing an Abiquo license, the user must specify the number of CPUs that will be managed by the Abiquo platform and obtain a license according to that number.

There is no restriction on the way a user licenses the product. Users can purchase more than one license, and combine them to fit their needs.

Cumulative licensing

Abiquo uses a cumulative licensing mechanism, so users who purchase several licenses L to manage C cores will have the ability to manage L1*N1 + L2*N2 + Ln*Nn cores.

Request a trial license

If you have not added a license, you can also open the license tab by clicking the red Unlicensed link that appears under the user icon in the top right corner of the screen. From the license tab, you can click on the link to Request a license for a free 30-day trial of the product.

Add a license

To add a license to the platform:

  1. Go to Configuration → Licenses
  2. Click the add button in the top right-hand corner of the screen
  3. On the Add license popup, paste the license in the License key field and click Save

The platform will display your license details in the Configuration tab, including the enabled plugins, support for scaling groups, available cores, and expiration date for each license.


To delete a license, select it in the list and click the delete button.

Related pages