Cloud Platform User Manual
Edit user general information
Edit user advanced
Before you begin:
To enable two-factor authentication for your user account, do these steps:
Screenshot: Enabling two factor authentication
Screenshot: Two factor authentication with backup codes (left) and QR code (middle)
Screenshot: Login with two-factor authentication
If required, select the datastore service level for your VM disk/s
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.
The next step is to Configure a VM before you deploy.
To filter templates in the left-hand Template library tab:
To clear the search
To configure the basic general VM settings, optionally set the following:
To enable remote access to the VM:
Before you deploy:
For SSH access, check that your user account has an SSH public key. See Configure your user account. You will need the SSH private key to log in to your VM
In public cloud regions, assign:
a public IP to your VM. See VM Network
You can now continue with further configuration or Save and deploy your VM.
To configure IP addresses on your VM, do these steps:
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:
Click the + add button at the top right of the Storage tab
Select Assign virtual disk
In the dialog the options will depend on the platform configuration
You must enter the size and the controller type
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
Select the load balancers to use for the VM.
To enable monitoring and metrics do these steps:
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 click to destroy the VMs.
Here are some examples of VM control panel tabs
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/or dimensions.
To configure the display of metrics at the virtual appliance level, do these steps.
Screenshot: filtering metric statistics
The multicloud platform supports power actions to easily stop, start, pause, and reset VMs.
To stop a VM that is deployed and powered on:
Shutdown: The platform will try to gracefully shut down the VM. This option may require hypervisor and guest VM configuration
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 start button, which is an arrow in a circle.
Depending on the cloud provider, you may also be able to perform the following actions:
The platform displays the appropriate buttons for the provider and the current state of the VM.
The following screenshots show two VMs: the VM on the left is selected to perform an action; the VM on the right shows how the result of the action will look.
To connect to your VM from the user interface:
The remote access connection to the VM will open and you can log in and work with the VM.
When you add another VM to a deployed virtual appliance, the platform does not launch it directly into the cloud.
You can deploy new VMs individually or click the Deploy all VMs button in the top right-hand corner of the screen.
The changes will be applied in the cloud provider directly.
Do NOT change the Abiquo tag in public cloud
Do not change the Abiquo platform's tag on a VM in a 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.
An Abiquo instance is a new template that you create from VM disks.
To create an Abiquo instance, do these steps:
The platform will store your new templates in the Apps library.
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.
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 for VMs and filter the search
To move a VM to another VApp in the same virtual datacenter:
Select the VM
On the VM control panel, click the VM move button
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.
To move a VM to a restricted virtual appliance:
Click the VM move button on the VM control panel
Select the option to move the VM to a restricted VApp OR select a restricted VApp from the list, or create a new one
To move a deployed VM to another VDC:
The platform will move the VM to the new virtual datacenter. If the move is not successful, the VM will be restored to the original virtual datacenter.
This feature does not move VMs with the following configuration:
If the virtual appliance or VM is deployed, you do not need to undeploy it. You can directly delete a VM that is deployed.
In the Networks list, to view the pool and allocation of IPs:
You can then:
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:
Name of the network (VLAN). The name can contain up to 128 characters
|IPv6||Select checkbox for IPv6 network|
|Netmask||Network mask with an integer value of between 16 and 30|
Private address range of the network
Gateway of the VLAN. Must be an IP within the range of the network address and mask
The primary DNS
The secondary DNS
The DNS suffix
|Excluded from firewall||Select Excluded from firewall to define a network where VM firewalls will not apply|
Select Define to create static routes. See Configure Static Routes
Make this network the default network, replacing the existing default network.
You can configure static routes when you create or edit a network. However, you should check with your systems administrator about when your VM will receive changes to static routes.
Destination network mask
Destination network or host
Next hop (on your network)
Name of the VLAN. The name can contain up to 128 characters
|IPv6||Select checkbox for IPv6 network|
|Strict||IPv6 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.|
|Netmask||Network mask of 48, 56 or 64.|
Private address range of the network. Only for non-strict networks
The primary DNS
The secondary DNS
The DNS suffix
Make this network the default network. In a datacenter, this will override the existing default network
In public cloud providers that support networks:
To create new IP addresses in a private network do these steps.
Or you can add an IP directly to a VM. To do this:
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.
The new settings will apply to all VMs deployed after you save the network.
To delete a private network:
To display onboarded external networks
If there are no VMs using the IPs of an external network that was already deleted in the provider, to delete the network in the platform, select it and click the Delete button.
To set a new or existing network as the default:
In private cloud, if you set a public network as the default, remember to obtain IP addresses for your VMs before you deploy!
This dashboard is the first screen you will see when you log in to Abiquo. It has Metrics, Hybrid, and Optimization tabs.
The Metrics tab provides a general view of the resources currently being used by your virtual datacenters, as well as 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 used by VMs that are currently deployed
VM disks that are created on the hypervisor datastore. This includes non-persistent VM system disks and hard disks.
|Memory||Gigabytes of RAM used by VMs that are currently deployed|
|Ext. Storage||Volumes of storage created on integrated/managed iSCSI or NFS, or generic iSCSI storage devices. |
This includes volumes of persistent external storage and persistent VM system disks. Gigabytes of volumes created in VDCs.
|VLANs||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||Number of IP addresses purchased or reserved in public VLANs|
|Repository||NFS Repository space used by the enterprise in the Apps library including templates and instances but not conversions (GB). Available for enterprises only, not individual virtual datacenters|
|Virtual machines||Number of VMs deployed by the enterprise|
Key to the graph:
|Virtual appliances||All the virtual appliances of the current enterprise in the platform, with totals in the table header|
|Virtual datacenters||All the virtual datacenters of the current enterprise in the platform, with totals in the table header|
|Last deployed VMs||The last VMs deployed by the tenant on the platform. It can be filtered by user, including deleted users|
|Last triggered alerts||The last alerts triggered for the tenant on the platform|
|Events||All events that you can access; to display full details of an event, can click on the event line.|
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|
Hybrid 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|
The hybrid billing dashboard for a cloud provider
Hybrid billing details for a cloud provider
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
|CPU usage > 80%||The VMs with highest average CPU usage over the last 30 days|
|RAM usage > 80%|
The VMs with highest average RAM usage over the last 30 days
|Longest time deployed||The VMs with the highest time deployed on the platform in days and hours, and not requiring the VMs to currently be in any specific state. You can filter by user name and deleted users|
|CPU usage < 30%||The VMs with lowest average CPU usage over the last 30 days|
|RAM usage < 30%||The VMs with lowest average RAM usage over the last 30 days|
|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|
|Unused load balancers||The load balancers that have been created by the tenant in the provider but are not in use for deployed VMs|
The Events view allows users to find out what is happening on the platform.
To open the Events view, click on the Events icon in the main menu bar. To add new events as they arrive, select the Update automatically checkbox. Otherwise, you must refresh the list manually.
To display the event details in the panel below the event list, double-click on an event.
Depending on user privileges, you may not be allowed to view events, or you may be able to view events for your tenant.
If the events you expected to display do not appear in Events view, check with your System Administrator.
An event has the following attributes:
The system object that is the source of the event or error. For example, it could be a VIRTUAL_APPLIANCE for a group of virtual machines.
The name of the system object that is the source of the event or error, for example, myVirtualAppliance.
|Action||The action that generated the event, for example, DELETE. See Events Table|
The user who performed the Action, for example, admin.
|Severity||The severity of the event. Can be INFO, WARN or ERROR|
The date and time when the event was generated.
Additional information about the event. See Events Table for more details. The traces displayed in Events view are also found in the Logs, which are documented in the Troubleshooting section of the Abiquo Administrator's Guide. See Abiquo Logs, especially catalina.out
|Context||The identifier of a group of related events. This attribute is in the event detail but not in the event list.|
When you view the event detail, the platform will display the context of the event. The context is an ID that the platform assigns to each event in a group of related events. For example, if you undeploy a virtual appliance, the platform will create events for the undeploy of each VM, the destruction of the related hard disks, and the release of the NICs. And the platform will assign the context ID to each of these events. You can filter by context to display this group of events.
To make it easier to find a specific event, use the filter tool. Click the filter buttonat 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.
When events are filtered, the text (events filtered) will be displayed next to the filter button.
|Entity||Pull-down list of Entities|
|Action||Pull-down list of Actions|
|Entity name||The name of the entity. The Name field may contain the UUID or the friendly name of the entity|
|Severity||Pull-down list of event severity. See Events View#Severity table|
|User||The name of the user who performed the action|
|Enterprise||The tenant that the event occurred in|
|Date from||Calendar selection for start date in format YYYY/MM/DD|
|Date to||Calendar selection for end date in format YYYY/MM/DD|
|Message||The message field will contain the details of the event, including the friendly name. See Events Table|
To filter alarm events by name, enter the friendly name of the alarm in the "Message" field of the filter. Note that the Name field contains the UUID of the alarm.
To display all the events related to an event, select the event, copy the context ID and filter by context.
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
The Events Table describes all the actions that can be performed on each entity and the event that they can generate on the platform. For example, for the Action plan entity, you can perform the Create, Modify and Delete actions, and events will also be generated when you run an action plan.