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

Cloud Platform User Manual

4.2 2018-01-08

1. Configure your user account

Edit your account details, add an SSH public key, and configure two-factor authentication.

1.1. Edit your user account details

After you log in, you may need to edit your user account to update your details:

  1. Click on the user icon in top right-hand corner of the screen and select Edit user from the pull-down menu
  2. Change your password and edit your user details. Check you have the correct email and phone number to receive passwords and authentication codes
  3. Add your public key that that the platform will use to launch VMs so that you can access them with SSH
 Click here to expand...

Edit user general information

Edit user advanced

1.2. Enable two-factor authentication

Two-factor authentication is the use of a password and a special authentication code to make the login process more secure. You may be required to enable it for your account, or you may be able to choose to enable it for your account. You can choose to receive your authentication codes from Google Authentication app or by email.

To enable two-factor authentication

  1. If you wish to use Google Authenticator, first install the Google Authenticator app on your mobile phone
  2. From the username menu select the Two-factor authentication option
  3. From the configuration dialog or the login dialog, select the authentication method and enable.
    For all authentication methods, the platform will display the backup codes once. Copy them and keep them in a secure place
  4. For Google Authenticator, use the app on your mobile phone to scan the QR code to obtain your verification code in the app.
    For email authentication, every time you enter your user name and password to log in, a code will be sent to the email address registered in your user account.
 Click here to expand...

Select authentication method for two-factor authentication for

Two-factor authentication popup with backup codes and QR code

During login, the platform will ask for the authentication code from the app or your email. Enter the code in the field below the password.

Login with two-factor authentication

2. Create and manage VMs

2.1. Create a virtual machine

To create a virtual machine (VM) do the following steps:

  1. Open the Virtual datacenters view by clicking on its icon in the top menu
  2. Open a virtual appliance that will hold a group of VMs by clicking on its name
  3. To create the VM, drag and drop a VM template from the Templates tab into the Virtual machines pane. You can also double-click the VM template

    1. If there is more than one version of the VM template, you can select another version
    2. If your cloud provider uses hardware profiles, select one

The platform will create your VM. The status bar on the VM icon says it is NOT_ALLOCATED, which means that the VM has not been launched into the cloud.

2.2. Filter VM templates for creating VMs

The template tab contains compatible templates only. If you cannot see an expected template, contact your system administrator. If there are a lot of templates, you may wish to filter the templates first.

To filter templates in the left-hand Template library tab:

  • Click the filter button and select a category from the pull-down list
    • To display only ISOs, select the checkbox
  • Enter text (including * wildcards) in the search box and press enter

To clear the search

  • Click the Clear link on the Category filter popup, which will clear both category and text search box
  • Click the grey X button beside the Search box
 Click here to expand...

2.3. Configure a VM before you deploy it

To configure your VM before you launch it, do the following steps:

  1. Move the mouse over the VM icon and form the options menu, select Edit
  2. Change the configuration options as described in this section
  3. Click Save

2.3.1. General configuration

To configure the basic general VM settings:

  1. Optionally change the VM's friendly name. By default the platform deploys VMs in name order
  2. In private cloud, optionally enable guest setup
    1. Optionally request a Guest initial password that will be sent by SMS or email
  3. Optionally enter a fully qualified domain name that the platform will set at deploy time
  4. To Enable remote access
    1. Select the check-box
    2. Display and optionally change the password to open the remote access connection
    3. In public cloud you will need to:

      1. Edit your user account to add an SSH public key. See Configure your user account. You will need the SSH private key to log in to your VM 

      2. Assign a public IP to your VM. See VM Network

      3. Assign a firewall policy that allows access to the appropriate SSH or RDP port. See VM Firewall
  5. Optionally enter a description

You can now continue with further configuration or Save and deploy your VM.

2.3.2. VM Network

If you don't add an IP, the platform will automatically add one on the default network.

To configure IP addresses on your VM

  1. Select the Private, External, or Public tab
  2. Create NICs as required:
    • To request an automatically created NIC and IP, drag and drop "Automatically generated IP" to your VM
    • To create a new IP address and NIC, click the + button
    • To use an existing address, drag and drop the IP address into the Network interfaces list
  3. Continue configuring your VM or click Save to finish

2.3.3. Firewall policies

Select the firewall policies to add. You can add as many firewall policies as necessary, up to the cloud provider's limit. If you can't see the expected policies, you may need to synchronize with your provider or wait for the platform to update provider data

2.3.4. Load balancers

Select the load balancers to use for the VM.

2.3.5. Monitoring

To enable monitoring and metrics

  1. Select the Fetch metrics checkbox.
  2. Select from the available options for your provider, for example, for AWS, you can select basic or advanced monitoring
  3. Select the metrics you would like to display for your VM

2.3.6. Storage

In private cloud, you can create additional hard disks that are not persistent. This means that when you undeploy the VM or remove the hard disk, the platform will delete your hard disks and destroy all data on them. To store the contents of a hard disk, create an instance template that will copy the hard disk to the template library.

To add a hard disk:

  1. Click the add button at the top right of the Storage tab

  2. Select Assign virtual disk.

  3. In the dialog the options will depend on the platform configuration

    1. You must enter the size and the controller type

    2. Advanced options: to force the creation of a new controller, assign a new bus value. The platform will return the bus value assigned by the provider
    3. Optionally select the datastore tier with the appropriate storage service level
    4. Click Save

Note that you cannot change the size of the primary disk before you deploy a VM.

2.4. Deploy to launch into the cloud

To launch your VMs, click the Deploy virtual appliance button on the right-hand side of the screen.

The platform will launch the VMs and power them on. The status bar below each VM icon will be coloured green. And the Deploy button changes to become the Undeploy button, which you can use to destroy the VMs.

2.5. Display VM details

To display VM details, select a VM icon. The platform will display the control panel below the VMs with different tabs, such as General and NICs.

 Click here to show/hide the screenshots

Here are some examples of VM control panel tabs

  • The General tab contains the CPU and RAM and other information such as the remote access password for connecting to the VM.

General tab of VM control panel

  • The NICs tab contains the details of the IP addresses of the VM.

NICs tab of VM control panel

  • The Storage tab contains the details of the hard disks and volumes attached to the VM

Storage tab of VM control panel

2.6. View VM metrics

To display VM metrics, click the metrics symbol on the VM icon.

To refresh metrics data, click the arrow refresh button on the right-hand side. To toggle the display of metrics, click the selection list symbol on the left-hand side, and select the desired metrics.

To filter metrics, click the funnel symbol. Enter the granularity, statistics, period, and dimensions.

Privilege: Access virtual machine metrics

To configure the display of metrics at the virtual appliance level, do these steps.

  1. Select Virtual appliance → Monitoring
  2. Optionally configure the refresh interval: Select the "Refresh data every" checkbox and enter a number of minutes. 
  3. Choose the metrics you wish to display and filter by metric statistics.

 Click here to show/hide the screenshot

Screenshot: filtering metric statistics

2.7. VM power actions

To stop a VM that is deployed and powered on:
  1. Select the VM icon
  2. Click the power off button, which is square shape.
  3. Select from the following two options:
    1. Shutdown: The platform will try to gracefully shut down the VM. This option may require hypervisor and guest VM configuration

    2. Power off: The platform will perform a hard power off on the virtualization technology. Warning: Using this option may cause loss of data

Remember that stopping a VM does not destroy it in the cloud provider and the VM is still consuming resources.

To power on a VM, click the play arrow start button.

Depending on the cloud provider, you may also be perform the following actions:

  • pause a VM to suspend it using the double vertical bar button
  • reset a VM to restart it using the circular arrows button.

The platform displays the appropriate buttons for the provider and the current state of the VM.

 Click here to show/hide walkthrough screenshots

The following screenshots show two VMs: the VM on the left is selected to perform an operation; the VM on the right shows how the result of the operation will look.

Power on:




2.8. Connect to a VM

The platform enables you to connect to a console of a VM that is deployed and powered on.

  • It make take up to 15 minutes after deploy for the initial guest password to propagate to a VM, especially for Windows systems
  • To obtain the remote access password, go to the VM control panel → General
  • To obtain VM credentials check your email or SMS, or you may click the Key button for guest initial password or the default credentials button

To connect to your VM from the user interface:

  1. Select the VM and on the control panel, click the eye icon
  2. On the remote access tab, enter:
    1. The remote access password
    2. The SSH private key in the Decryption password box 
  3. Log in to the VM with the appropriate credentials

The remote access connection to the VM will open and you can log in and work with the VM. Remember to change your administrator password as soon as possible.

2.9. Add more VMs to a deployed virtual appliance

When you add another VM to a deployed virtual appliance, it is not allocated to the provider directly. You can deploy new VMs individually or click the Deploy all VMs button in the top right-hand corner of the screen.

2.10. Reconfigure a VM after you deploy it

After you deploy a VM, the changes you can make will depend on your cloud provider. To change the configuration of a deployed VM

  1. Select the VM
  2. If your provider or operating system does not support using hot add and hot reconfigure, power off the VM, using the Stop button on the control panel
  3. Move the mouse over the VM and from the options menu, select Edit.
  4. On the Edit VM dialog, go to General, make changes to the following as required:
    1. VM friendly name
    2. CPU and RAM if hardware profiles are not in use
    3. Remote access
      1. If you disable remote access, hypervisor configuration will remain but you cannot access it through the Eye icon
      2. If you change the password, the change will be applied when you save the VM. Remember that it can be a maximum of 8 alphanumeric characters, i.e.. a to z, A to Z, 0 to 9. If you delete the password, the screen requesting the password will not appear. On ESXi hypervisors, if you set a password and later delete it, the password will be blank, not null. The screen requesting the password will appear, and you should press <Enter> to continue.
    4. Description of the VM
    5. Hardware profiles
  5. Make changes to Networks and Storage, Firewalls, and Load balancers as required
  6. Click Save

The changes will be applied in the cloud provider directly.

To change a VM's fully qualified domain name (FQDN), make the change in the VM's operating system and the platform will detect the new value

Do NOT change the Abiquo tag in public cloud

Do not change the Abiquo platform's tag on a VM in public cloud provider (e.g. on an AWS instance) because you could break the link between Abiquo and the VM. If the link is broken, you will not be able to manage the VM with Abiquo.

2.11. Save VM disks to create an instance template

An Abiquo instance is a new template that you create from VM disks.

Privilege: Create instance

Before you begin:

  1. In Azure, to create a VM snapshot (instance) you must first log in to the VM and generalize it using Sysprep. See https://docs.microsoft.com/en-us/azure/virtual-machines/windows/capture-image-resource. Then you should power it off and create the snapshot in the usual way. Note: after you generalize the VM, you cannot power it on again

To create an Abiquo instance, do these steps:

  1. Select and shut down each VM that you want to copy, then click Create instance

  2. Select a VM from the dialog
  3. Enter a name that will enable you to identify the new template
  4. In private cloud, optionally select the VM disks to save to a new template in the template library. If no disks are selected, the instance will copy all disks
  5. If you want to create more instances, select Keep window open
  6. Click Create instance. The platform will lock the VM to create the instance
    Select disks to clone for VM instance template
  7. If you kept the dialog open, click Back to list and create more instances as required, then close the dialog

Your new templates will be stored in the Template library.

2.11.1. Use a saved template in private cloud

To use an instance template in a VM, double-click or drag and drop the original template and an instance menu will open. Select the instance template.

 Click here to show/hide the screenshot

2.12. Display all VMs

To display all VMs of your enterprise, go to Virtual datacenters → All virtual datacenters → Virtual machines tab.

To display all the VMs in a specific virtual datacenter, select the virtual datacenter.

To select icon or grid view, click the icon symbol or the grid symbol in the top right hand corner.

To jump directly to the virtual appliance or virtual datacenter of the VM, go to Grid view and use the shortcut links by clicking on the name fields.

To filter the VMs, enter text from the VM details with wildcards as required. See Search and filter VMs

2.13. Move a VM to another virtual appliance

To move a VM to another VApp in the same virtual datacenter:

  1. Select the VM

  2. On the VM control panel, click the VM move button

  3. Select the virtual appliance or create a new one, and click Accept

If you have the privilege to restrict VMs, you may also be able to move the VM to a restricted VApp in the same virtual datacenter. 

2.14. Restrict a VM

To restrict a VM by moving it to a restricted VApp:

  1. Click the VM move button on the VM control panel

  2. Select the option to move the VM to a restricted VApp OR select a restricted VApp from the list, or create a new one

     Click here to show/hide the screenshots

2.15. Delete a VM

To delete a VM, move the mouse over the VM and from the VM options menu, select Delete.

If the virtual appliance or VM is deployed, you do not need to undeploy it. You can directly delete a VM that is deployed. 

 Click here to expand...

Select Delete from virtual machine options menu

3. Manage networks

3.1. View virtual datacenter networks

To view the networks available to a virtual datacenter, go to Virtual datacenters → select virtual datacenter → Network.

  • The default network is highlighted with a star symbol
  • A network with an internet gateway is highlighted with a globe symbol.

API Features

Virtual datacenter networks are available in the Abiquo API. For example, see VirtualDatacenterResource and PrivateNetworksResource.

Network tab in virtual datacenter highlighting default network and internet gateway

In the Networks list, to view the pool and allocation of IPs:

  • To see all the IPs in the virtual datacenter, click the All button on the top of the list
  • To see the IPs in a VLAN, click the VLAN name

You can then:

  • use the slider at the bottom of the list to move through the pages 
  • filter the list by entering text in the search box. The filter works with all the columns of the table:
    • IP Address
    • MAC address
    • VLAN name
    • Virtual appliance using the IP
    • VM using the IP
    • Provider ID of the entity using the IP (for example, a load balancer)

3.2. Create a private network

Private networks are only available within a virtual datacenter. However, your cloud provider may configure an external gateway for your virtual datacenter.

To create a private network in your virtual datacenter, click the  button  and complete the form below.

Create a private network




Name of the network (VLAN). The name can contain up to 128 characters

IPv6Select checkbox for IPv6 network
NetmaskNetwork mask with an integer value of between 16 and 30

Network Address

Private address range of the network


Gateway of the VLAN. Must be an IP within the range of the network address and mask

Primary DNS

The primary DNS

Secondary DNS

The secondary DNS

DNS suffix

The DNS suffix

Excluded from firewallSelect Excluded from firewall to define a network where VM firewalls will not apply

Static Routes

Select Define to create static routes. See Configure Static Routes

Default network

Make this network the default network, replacing the existing default network.

You can configure static routes when you create or edit a VLAN. However, you should check with your systems administrator about when changes to static routes may be received by your VM.





Destination network mask

Network ID

Destination network or host

Gateway IP

Next hop (on your network)

 Click here to show/hide IPv6 networks

Strict network


Non-strict network



Name of the VLAN. The name can contain up to 128 characters

IPv6Select checkbox for IPv6 network
StrictIPv6 only. If you select Strict, Abiquo will automatically generate the network address (ULA) and also the IP addresses. If you do not select strict, you can enter the network address and IP addresses.
NetmaskNetwork mask of 48, 56 or 64.

Network Address

Private address range of the network. Only for non-strict networks

Primary DNS

The primary DNS

Secondary DNS

The secondary DNS

DNS suffix

The DNS suffix

Default network

Make this network the default network. In a datacenter, this will override the existing default network

3.3. Private networks in public cloud

When you onboard from public cloud, if the provider supports networks, then the platform will onboard private networks, including details of IP addresses not used by VMs. You can synchronize these networks.

When working in Abiquo, DO NOT DELETE networks directly in the provider because this may cause inconsistency. The synchronization process is designed to onboard public cloud elements, especially when you begin to work with a public cloud provider

When creating a custom private network in AWS, you can choose the Availability Zone. Availability Zones enable users to deploy VMs separately, with high availability. You can deploy in an availability zone by assigning a private IP address in the network belonging to that Availability Zone.

3.4. Add IPs to private networks

To create new IP addresses in your private network, click the Add button in the top right-hand corner of the Private IPs page. You can also create IPs automatically, directly in the Edit VM popup.

  • Enter the number of IPs and the first IP address in the range. The first IP address must be a new address that does not already exist in the network. After creating the first IP address, the platform will try to create the other IPs and it will skip any existing IP addresses. 

    For example, if you have IP addresses in network, which are 30, 33, and 34 and then you request 3 new IPs from The new IPs created should be as follows: 31, 32, 35. 
IP Addresses
 Click here to show/hide IPv6 details

When you add IPv6 addresses on strict networks, you don't need to set the starting address.

On non-strict IPv6 networks, Abiquo recommends that you create an automatic IP address, or you can enter an IP address manually as shown here.

3.5. Delete IPs

The platform will delete only the IP addresses that are not in use, which means not attached to a VM, or not purchased by the enterprise.

To delete IP addresses:

  1. Select the network, then select the IP addresses, and click the delete button. 

3.6. Edit a private network

To edit a private network

  1. Select the network
  2. Click the Edit button  above the Networks list:
  3. You can change the network name, gateway, DNS settings, and make the network the new default for this virtual datacenter.
  4. Click Save

The new settings will apply to all VMs deployed after you save the network.

3.7. Delete a private network

You can delete a private VLAN if no VMs are using its IPs and it is not the default network. To delete a private VLAN, select it and click the Delete button  above the Networks list. 

3.8. Manage onboarded external networks

The platform automatically onboards external networks when you onboard virtual datacenters from vCloud Director.

To manage External networks, go to Virtual datacenters → Network → Select vCloud VDC → External.

3.8.1. Manage networks that have been deleted in the provider

If an onboarded network has been deleted in the provider, its name will display in light gray text.

If a VM is using an IP from this network, then you cannot deploy the VM.

If there are no VMs using the IPs of an external network that was already deleted in the provider, then you can delete the network, by clicking the Delete button.

3.9. Set default virtual datacenter networks

If you deploy a VM without assigning a NIC, Abiquo will add one in the virtual datacenter's default network.

To set a new or existing network as the default:

  1. Create or editing the network, select the Default network checkbox. The new default network will apply to all VMs deployed after you set it.  

In private cloud, if you set a public network as the default, obtain IP addresses for your VMs before you deploy!

4. View your resources and statistics

4.1. Home view dashboard

This dashboard is the first screen you will see when you log in to Abiquo. It has Metrics, Hybrid and Optimization tabs. 

  • You can sort tables by columns by clicking on them on the header rows
  • To jump directly to a VM, virtual datacenter or virtual appliance, double-click on its name or label.

4.2. Metrics

The Metrics tab provides a general view of the resources currently being used by your virtual datacenters, as well events.


  • Enterprise resources - virtual datacenters shows statistics of the resources used by your virtual datacenters. Select the virtual datacenter name from the pull-down list.
    • Virtual CPUs as used by VMs that are currently deployed
    • Storage represents the VM disks that are created on the hypervisor datastore. This includes non-persistent VM system disks and hard disks. These disks will be deleted when the VM is undeployed. Gigabytes of disks created on datastores
    • Memory represents gigabytes of RAM used by VMs that are currently deployed
    • External storage represents the volumes created on integrated/managed iSCSI or NFS, or generic iSCSI storage. This includes volumes of persistent external storage and persistent VM system disks. Gigabytes of volumes created in VDCs
    • VLANs represents private VLANs defined in Abiquo. A default private VLAN is always created when you create a virtual datacenter. Number of VLANS created in VDCs
    • Public IPs represents the number of IP addresses purchased or reserved in public VLANs, NAT IPs in NAT networks, and floating public IPs in public cloud providers
    • Virtual machines represents the number of VMs deployed by the enterprise
    Key to the graph:
    • Green: Used resources
    • Orange: Soft limits
    • Red: Hard limits
     Click here to expand...

  • Virtual appliances: all the virtual appliances in the platform, with totals in the table header
  • Virtual datacenters: all the virtual datacenters of the current enterprise on the platform, with totals in the table header
  • Last deployed VMs: the last five VMs deployed by the tenant on the platform. It can be filtered by user, including deleted users.

  • Last triggered alerts: the last five alerts triggered for the tenant on the platform

  • Events: all events that you can access and you can click on a specific event to see the full details of this event. 

4.3. Hybrid

The Hybrid tab provides an overview of the distribution and cost of your resources between public cloud providers and private cloud. 


  • Virtual machines count: the enterprise's VMs that are deployed in public cloud providers or private cloud. You can filter the list by public cloud provider or private cloud.

  • Workload of VMs by location: a graph of the enterprise's VMs deployed in public cloud providers or private cloud. The virtual machines are counted by location (public cloud region or datacenter). To view the detailed list with a count of VMs in each location, click on the graph

Billing widgets:

  • Latest bills: the amount of the last bill and the change in spend from the previous bill for the selected provider
    • Show more bills: a graph with the most recent bills registered in the system. Move the mouse over the graph line to display the bill details
  • Estimated bill: for the current period, calculated using a linear regression of daily costs for the current period, and the change in spend from the last bill for the selected provider
  • Average cost per VM: calculated from the last bill and the number of VMs in the selected provider
 Click here to expand...

4.4. Optimization

The Optimization tab aims to help you make best use of your cloud resources. 

For more details of a VM, click on the arrow symbol beside the VM details

 Click here to expand...


  1. Highest CPU usage: the five VMs with highest average CPU usage over the last 30 days

  2. Highest RAM usage: the five VMs with highest average RAM usage over the last 30 days

  3. Longest time ON: the five VMs with the highest uptime on the platform in hours, calculated from the accounting data and not requiring the VMs to currently be in any specific state. You can filter by user name and deleted users

  4. Lowest CPU usage: the five VMs with lowest average CPU usage over the last 30 days

  5. Lowest RAM usage: the five VMs with lowest average RAM usage over the last 30 days

  6. Unused public IPs: the public, floating, or NAT IPs that have been reserved by the tenant but are not in use on a deployed VM

  7. Unused load balancers: the load balancers that have been created by the tenant in the provider but are not in use for deployed VMs  

5. View your actions and events on the cloud platform

The Events view allows users to find out what is happening in Abiquo. To open the Events view, click on the Events icon  in the main menu bar.

Event viewing can be restricted from no event privileges to events for the current enterprise only.

If the events you expected to display do not appear in Events view, check with your System Administrator.

To add new events to the list as they arrive, select the Update automatically checkbox. Otherwise, the list will refresh when you open the view.

Double-click on an event to see the event detail in the panel below the event list

5.1. The event list

The event list has the following columns:




Shows the system object that is the source of the event or error and its full hierarchy. For example, en event about deploying a VM could show the name of the virtual appliance and the virtual datacenter it belongs to.

SeverityThe severity of the event. Can be INFO, WARN or ERROR
ActionThe action that generated the event. See Entity and Action Tables

Performed by

The user who performed the Action.


The date and time when the event was generated.

UserThe user affected by the action


Additional information about the event that will display in the system logs.


5.2. Filtering events

To make it easier to find a specific event, use the filter tool. Click the filter button  at the top right of Events view. Enter your filter criteria and click Accept. To remove the filter, click Clear at the bottom of the popup.

5.2.1. Basic event filtering

Basic event filtering enables you to filter with the following fields:

Filter events by severity, action, user, dates and tenant

Event fieldDescription
SeverityPull-down list of Severity types
ActionPull-down list of Actions from Entity and Action Tables
Performed byThe name of the user who performed the action
Date fromStart date in format YYYY/MM/DD
Date toEnd date in format YYYY/MM/DD


5.2.2. Advanced event filtering

Click "See more" on the basic filter panel to filter on more fields. You can search for events related to specific entities.

5.3. Severity table

Events on the Abiquo platform are classified into three severity categories: info, warning and error. 




General information events for the user as part of the normal use of the platform


Warning about an abnormal situation that does not block normal use of the platform


Error that blocks the normal use of the platform

5.4. Component List

These values can be used to filter the events by Component.

  • RACK
  • USER
  • ROLE
  • API
  • UCS

5.5. Storage System List

These values can be used to filter the Events list by Storage System:

  • LVM

5.6. Entity and Action Tables

The entity and action tables show events that will be displayed for Cloud Users, with a basic cloud user role and privileges.

See Events View for Cloud Users for a full list of events.