1. Configure your user account
1.1. Edit your user account details
After you log in, you may need to edit your user account to update your details:
- Click on the user icon in top right-hand corner of the screen and select Edit user from the pull-down menu
- Change your password and edit your user details.
- Check you have the correct email address and phone number to receive passwords and authentication codes, and email notifications
- 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
Your platform may offer or require two-factor authentication (2fa) to improve user login security with an additional authentication code. For platform configuration instructions, see Configure two factor authentication.
Before you begin:
- To use Google Authenticator to obtain the codes, install the Google Authenticator app on your cell phone.
- To use email authentication to obtain the codes, check that you have a valid email address in your user account on the platform.
To enable two-factor authentication for your user account, do these steps:
- Click on the name or icon in the top right-hand corner of the screen, and in the username menu, select Two-factor authentication.
- Select the authentication method and click Enable
- Copy the backup codes from the bottom left-hand corner of the configuration window to a secure place. You can use these codes to log in to the platform if the authentication cycle fails
The platform will display backup codes ONCE only
- Authenticate according to your selected method
- For Google Authenticator, use the Google Authenticator app on your cell phone to scan the QR code. Google will supply a verification code in the app. During login, the platform will request the authentication code from the app. Enter the code in the field below the password
- For email, during login, every time you enter your user name and password to log in, a code will be sent to the email address registered in your Abiquo user account. Enter the code on the login dialog
Screenshot: Enabling two factor authentication
Screenshot: Two factor authentication with backup codes (left) and QR code (middle)
Screenshot: Login with two-factor authentication
2. Create and manage VMs
2.1. Create a VM
To create a virtual machine (VM) do the following steps:
- Open the Virtual datacenters view by clicking on its icon in the top menu
- If there are no virtual appliances to hold groups of VMs, click Create a virtual appliance
Enter a Name and select a Virtual datacenter, and enter optional values and click Save
- Open a virtual appliance to hold a group of VMs by clicking on its name
- To create a VM, drag and drop a VM template from the Templates tab into the Virtual machines pane. You can also double-click the VM template
- If there is more than one version of the VM template, you can select another version
- If your cloud provider uses hardware profiles, select one
If required, select the datastore service level for your VM disk/s
Click here to show/hide the screenshot
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.
2.2. Filter 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
2.3. Configure a VM before you deploy
To configure your VM before you launch it, do the following steps:
- On the VM icon, click on the options menu button, and from the options menu, select Edit
- Change the configuration options as described in this section
- Click Save
2.3.1. General configuration
To configure the basic general VM settings, optionally set the following:
- VM friendly name. Power-on is in alphanumeric order
- Guest setup in private cloud
- You can request a Guest initial password that will be sent by SMS or email
- Fully qualified domain name that the platform will set at deploy time
- Hardware profile and/or CPU, RAM and Cores per socket
To enable remote access to the VM:
- Select the Enable remote access check-box
- Display and optionally change the password for the remote access connection
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
- a firewall policy to allow access to the appropriate SSH or RDP port. See VM Firewall
You can now continue with further configuration or Save and deploy your VM.
If you don't add any IP addresses, the platform will automatically add one on the default network.
To configure IP addresses on your VM, do these steps:
- Select the Private, External, or Public tab
- For private and external, select the network
- Create NICs as required:
- To use an existing IP address, drag and drop it into the NICs list
- To request an automatically created NIC and IP, drag and drop the "Automatically generated IP" tag into the NICs list
- For private networks, to create a new IP address and NIC, click the + button
- For public networks, to obtain a new IP address, click the + button, select the network, and select the IP address
- Continue configuring your VM or click Save to finish
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
- 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
- Optionally select the datastore tier with the appropriate storage service level
- Click Save
- You cannot change the size of the primary disk before you deploy a VM.
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.
To enable monitoring and metrics do these steps:
- Select the Fetch metrics checkbox, which will retrieve all metrics
- Select from the available options for your provider, for example, for AWS, you can select basic or advanced monitoring
- Select the metrics you would like to display for your 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 click 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.
- The NICs tab contains the details of the IP addresses of the VM.
- The Storage tab contains the details of the hard disks and volumes attached to the VM
2.6. Display VM metrics
To display metrics of a deployed VM with metrics enabled, 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/or dimensions.
To configure the display of metrics at the virtual appliance level, do these steps.
- Select Virtual appliance → Monitoring
- Optionally configure the refresh interval. To do this, select the "Refresh data every" checkbox and enter a number of minutes.
- 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
The multicloud platform supports power actions to easily stop, start, pause, and reset VMs.
To stop a VM that is deployed and powered on:
- Select the VM icon
- Click the power off button, which is a square button.
- Select from the following options:
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:
- 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 action; the VM on the right shows how the result of the action will look.
2.8. Connect to a VM
The platform enables you to connect to a console of a VM for remote access. The VM must be 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, select the VM and go to the VM control panel → General → click Show password
- To obtain VM credentials check your email or SMS, or click the key button for guest initial password or the default credentials button
To connect to your VM from the user interface:
- Select the VM and on the control panel, click the eye icon
- In the remote access dialog, enter the credentials, for example:
- For VNC to hypervisors: the remote access password
- For SSH to Linux VMs: the remote access password and the SSH private key (in the Decryption password box)
- For RDP to Windows VMs: the VM user name and the password
- If necessary, 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.
- You cannot change the remote access password for ESXi using hot reconfigure. You must restart the VM for the password change to take effect
- Remember to add a firewall to allow access to the appropriate ports, for example, RDP for Windows
- In AWS, you must add a private IP on a public subnet to use a public IP
2.9. Add more VMs to a deployed virtual appliance
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.
2.10. Change the configuration of a deployed VM
After you deploy a VM, the changes you can make will depend on your cloud provider. To change the configuration of a deployed VM do these steps:
- Select the VM
- 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
- Move the mouse over the VM and from the options menu, select Edit.
- On the Edit VM dialog, go to General, make changes to the following as required:
- VM friendly name
- CPU and RAM if hardware profiles are not in use
- Remote access
- If you disable remote access, hypervisor configuration will remain but you cannot access it through the Eye icon
- 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.
- Description of the VM
- Hardware profiles
- Make changes to Networks and Storage, Firewalls, and Load balancers as required
- 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
- For ESXi hypervisors, you cannot change the remote access password using hot reconfigure
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.
2.11. Save VM disks to create an instance template
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 for VMs and filter the search
2.13. Move a VM to another virtual appliance
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.
2.14. Move a VM to a restricted virtual appliance
When you move a VM to a restricted virtual appliance, your administrator or platform provider will control the VM. Your provider may offer this as an option to Outsource a VM.
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
Click here to show/hide the screenshots
2.15. Move a deployed VM to another virtual datacenter
You can move a deployed VM to a virtual datacenter within the same Abiquo datacenter. The target VDC must have the same hypervisor type. If the VM is not deployed, the Move VM button will allow you to Move the VM to another virtual appliance
in the same virtual datacenter.
To move a deployed VM to another VDC:
- If your VM does not support hot-reconfigure, shut down the VM. This is because moving a VM will change the configuration of the VM, for example, the NICs
- Select the VM and click the Move VM button
- For a deployed VM, the platform will display a list of compatible virtual datacenters (with the same hypervisor technology and network device) and virtual appliances.
- After you select the virtual appliance, the platform will display the configuration dialog.
- You must select at least one network address. It is possible to select the same external IP address that was already attached to the VM.
- Optionally select firewalls and load balancers
- The platform may display a pricing estimate dialog for you to accept the new VM price.
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:
- External storage volumes
- NAT rules
- Scaling groups
- Anti-affinity layers.
- The platform will attempt to remove the VM from its layer and if it cannot do so, then the move will fail. For more details of layer constraints, see Configure VM High Availability. The platform will not add the VM to a layer in the target VDC.
2.16. 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.
3. Manage networks
3.1. Display virtual datacenter networks
To display 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.
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 including:
- 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:
- Go to Virtual datacenters → select virtual datacenter → Network
- Click the button and complete the form
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)
Click here to show/hide IPv6 networks
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
3.3. Use private networks in public cloud
In public cloud providers that support networks:
- When you onboard resources, the platform will onboard private networks, including details of IP addresses not used by VMs
- You can synchronize private networks
- You can create additional private networks in the provider
- When you create a custom private network in AWS, you can choose the Availability Zone. Availability Zones enable users to deploy VMs separately, with high availability.
- To deploy in an Availability Zone, assign a private IP address in the network belonging to that Availability Zone
3.4. Create IP addresses in private networks
To create new IP addresses in a private network do these steps.
- Go to Virtual datacenters → optionally select Virtual datacenter
- Go to Networks → Private → select Private network
- Click the Add button in the top right-hand corner of the Private IPs page and enter details
Or you can add an IP directly to a VM. To do this:
- Go to Virtual datacenters → edit VM → Network
- Click the + Add button and enter details (or drag "Auto-generated IP" into the network pane)
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 188.8.131.52, which are 30, 33, and 34 and then you request 3 new IPs from 184.108.40.206. The new IPs created should be as follows: 31, 32, 35.
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. Edit a private network
To edit a private network
- Select the network
- Click the Edit button above the Networks list:
- You can change the network name, gateway, DNS settings, and make the network the new default for this virtual datacenter.
- Click Save
The new settings will apply to all VMs deployed after you save the network.
3.6. Delete a private network
You can delete a private network if no VMs are using its IPs and it is not the default network for the virtual datacenter.
To delete a private network:
- Go to Virtual datacenters → Network → Private
- Select the network and click the delete button above the Networks list.
3.7. Display onboarded external networks
The platform automatically onboards external networks when you onboard virtual datacenters from vCloud Director.
To display onboarded external networks
- Go to Virtual datacenters → Network → Select vCloud VDC → External
3.8. Delete an onboarded external network
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, to delete the network in the platform, select it and click 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:
- When you create or edit 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, remember to obtain IP addresses for your VMs before you deploy!
4. View your resources and statistics
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.
|Severity||The severity of the event. Can be INFO, WARN or ERROR|
|Action||The action that generated the event. See Entity and Action Tables|
The user who performed the Action.
The date and time when the event was generated.
|User||The 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:
|Severity||Pull-down list of Severity types|
|Action||Pull-down list of Actions from Entity and Action Tables|
|Performed by||The name of the user who performed the action|
|Date from||Start date in format YYYY/MM/DD|
|Date to||End 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.
5.5. Storage System List
These values can be used to filter the Events list by Storage System:
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.