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 2.6

Skip to end of metadata
Go to start of metadata



Introduction to the Import and Capture Process

When you add a physical machine to Abiquo, it may already have virtual machines running on it that were created outside of Abiquo. By default, when you create a physical machine, the virtual machines already running on it are imported into Abiquo. When you  import virtual machines, they are considered by Abiquo scheduling and counted in statistics. 

After the machines are imported, you can capture them, which means they will behave similarly to Abiquo virtual machines. However, the captured virtual machines will not have a template in the Apps Library, so you should make instances if you wish to undeploy and redeploy them. Abiquo cannot capture external storage volumes but you can add these later as Generic iSCSI volumes.

After you have captured all of the virtual machines you require, you can delete unmanaged virtual machines.  And if you wish to undo the capture process, release the virtual machines to the imported state.

Capture from datacenters only

Capture of virtual machines from public datacenters is not supported in Abiquo 2.6

Import and Capture Operations
ImportPhysical machineAll the virtual machines that were already running on the physical machine when it was added to Abiquo will be retrieved and listed in Abiquo. They will now be listed and counted by Abiquo statistics and scheduling but they are not managed by Abiquo, which means that Abiquo cannot control these virtual machines. Valid operations are capture VMs or remove unmanaged VMs.
Remove unmanagedPhysical machineThe imported virtual machines that have not been captured will be removed from Abiquo, which means that they will no longer be counted by Abiquo statistics and scheduling and they will not be listed by Abiquo.
CaptureImported virtual machineThe imported virtual machine that is selected when you press this button will be captured and if the capture is successful, it will be managed by Abiquo. Valid operations are now release the VM and Abiquo VM operations for example, power on, power off, reconfigure to add a new NIC, create an instance.
ReleaseCaptured virtual machineThe captured virtual machine is now released into the imported state, meaning that it is not managed by Abiquo but it is counted by Abiquo statistics and scheduling.


This diagram shows the possible steps to import and capture virtual machines that were created outside of Abiquo.

Prerequisites to Import Virtual Machines

Import virtual machines to get information about the virtual machines running on the hypervisor but not yet managed by the Abiquo platform.

You can import virtual machines:

  • automatically when you add a physical machine to Abiquo
    • by default, this option is selected
  • manually by clicking the import button on the physical machine control panel at any time

To import a virtual machine from a physical machine in Abiquo, the prerequisites are:

  • Physical machine
    • The machine is added (or will be added) to a datacenter (not a public datacenter)
    • The hypervisor datastore with the VM system disk is enabled in Abiquo. See Manage Datastores

Retrieve Once

Virtual machines that are already registered as retrieved or captured by Abiquo will not be retrieved again EXCEPT when the automatic import process is not complete and the user starts a manual import.

Prerequisites to Capture Virtual Machines

To capture a virtual machine Abiquo already discovered, the prerequisites are as follows.

Abiquo Elements

In Abiquo you will need:

  • Virtual datacenter
    • Create a virtual datacenter to hold the captured virtual machines before you capture them
  • Networks 
    • Create Abiquo networks matching the networks that the virtual machines are attached to before you capture them 
  • Virtual appliance 
    • Create virtual appliances to hold the captured virtual machines before or during the capture 
Virtual Machine

The virtual machine to be captured must be compatible with Abiquo:

  • The format of the virtual machine hard disk must be compatible. See Template Compatibility Table
  • The virtual machine must contain at least one compatible NIC with a MAC addresss configured

Abiquo will skip incompatible virtual machines

Virtual Hardware

All virtual hardware components should be compatible with Abiquo. See Compatibility Tables

  • Abiquo will skip incompatible components

Capture Process

When capturing a VM, as part of the capture process, Abiquo:

  • Adds the VM to the Abiquo database as a captured machine
  • Captures:
    • CPU and RAM
    • remote access configuration
      • Password is captured
      • If there is no password, remote access is disabled
      • Remote access can also be enabled when you reconfigure the VM after capture
    • Networks
      • Abiquo captures MAC addresses of compatible network cards
      • Abiquo lists the MAC addresses as NICs
        • IPs cannot be captured because hypervisors do not provide IPs
      • User assigns NICs to VDC networks 
        • Private network
          • User selects IP address
        • Unmanaged network
          • User optionally enters IPs
    • Hard Disks
      • Hard disks on the hypervisor datastore are captured
    • External Storage
      • Volumes of external storage are NOT captured

If you imported a VM from a datastore that was then disabled, you can still capture it without problems. The capture process checks if the machine exists in the hypervisor and if it has been changed

Captured VMs

When the VM is captured, it is essentially very similar to a VM created in Abiquo. Abiquo high availability supports captured virtual machines with an appropriate physical machine configuration (i.e. shared datastores, IPMI, etc.)

Undeploy Destroys the Captured Virtual Machine on the Hypervisor

If you undeploy the virtual machine, this will destroy the virtual machine on the hypervisor

  • Before you undeploy, create an instance to back up the virtual machine

Differences from Abiquo VMs:

  • Undeploy 
    • Destroys the virtual machine on the hypervisor 
      • Create an instance before you undeploy the VM 
        • The instance will become a master VM template
  • Release 
    • Captured VMs can be released so they are no longer managed by Abiquo
    • These VMs will not be modified on the hypervisor

Capture Limitations

  • External storage volumes are not imported
    • Persistent virtual machines will not be retrieved because their system disks are located on external volumes
    • External iSCSI storage volumes can be added as generic iSCSI volumes

Capture Virtual Machines

Step 1: Prepare Network Configuration

Abiquo can manage network connections when capturing virtual machines. Create Abiquo networks for the virtual datacenter where you will capture the virtual machines.

Step 2: Add the Physical Machine in Abiquo
  1. Add the physical machine
    1. Make sure the datastore(s) containing the virtual machine(s) to import is enabled.

Screenshot: Enable the datastore with your virtual machine(s), in this example, data1

Automatically Import Virtual Machines When You Create a Physical Machine

Click the checkbox to enable or disable the automatic import.

In Abiquo 2.6, there is no progress indicator to show that the machines are being imported. If you press the retrieve button before the import process is completed, you may see duplicate machines. Or one set of machines for each time you press the retrieve button. If this occurs:

  • Remove unmanaged machines
  • Retrieve virtual machines again using the manual import process described below

Step 3: Manually Import Virtual Machines Running on the Physical Machine

If you did not automatically import existing virtual machines when you added the physical machine to Abiquo, you can import them manually now.

Click the     Import Button.  All the virtual machines found will appear in the Virtual Machine list with the following icon:  (warning) .

These machines have been imported but not captured so they are known as unmanaged virtual machines .

Abiquo will:

  • refresh the state of these VMs as part of the VM health check
  • include these VMs in resource usage statistics, improving accuracy of physical machine statistics
  • take into account the resources used by the virtual machines when scheduling and allocating resources
Step 4: Capture a Retrieved Virtual Machine

To import a retrieved virtual machine into Abiquo, select a virtual machine and press the Import Button  which is on the left of the Virtual Machine detail pane.

The Capture Virtual Machine screen will open, listing all the virtual appliances into which you can import the virtual machine.

Select a virtual appliance or create a new one by pressing the  Create Button. The form to create a new virtual appliance is the same as the Create Virtual Appliance form.

When you have selected the virtual appliance where you want to put the virtual machine, click Accept to capture the virtual machine. The state of the virtual machine will be the same as in the hypervisor before the capture (powered on or powered off).

Step 5: Review General Information

Abiquo will show the General Information it has captured from the virtual machine. After the capture is complete, you can reconfigure the virtual machine. For example, when you reconfigure, you can enable remote access if it is not already enabled.

Step 6: Configure Network

Abiquo will detect the MAC addresses of the NICs in your virtual machine. 

  • For each NIC
    • Select network type 
      • Unmanaged networks
        • Optionally enter IP address
      • Private networks
        • Select IP address


Step 7: Review Hard Disks

Abiquo will detect the hard disks created on the hypervisor datastore.

After reviewing the virtual machine configuration, click Accept to continue. Abiquo will capture the virtual machine.

State of the Virtual Appliance and Virtual Machines After Capture

If the virtual appliance was deployed before the capture, the new virtual machine will be added to the virtual appliance but no other changes will be made.

If the virtual appliance was undeployed before the capture, afterwards it will be deployed and Needs Sync . The VM state of "Needs Sync" means the Update Running Appliance button  will display on the Virtual Appliance Detail Screen . When you click Update Running Appliance, any machines that were not deployed before the capture will be deployed.

View Captured Virtual Machines

Captured virtual machines are indicated on the virtual machines pane with the capture icon beside the virtual machine.


Save a Template for a Captured Machine

After you capture a virtual machine, it is similar to an Abiquo virtual machine. However, this machine was not created from an Abiquo template, so the virtual machine will be destroyed if it is undeployed. To save a template for this virtual machine, create an instance. The instance will be stored as a master template. From this template, you can redeploy the virtual machine or create a persistent virtual machine.

Removing Unmanaged Virtual Machines

API Documentation

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

You can remove all unmanaged virtual machines from the platform. Unmanaged virtual machines are ones that were imported but not captured. The unmanaged machines are identified by the (warning) icon. Select the physical machine, and press the  button.

The unmanaged virtual machines will no longer be displayed on the screen. Remember you can retrieve them again at any time.

Reconfigure Captured Virtual Machines

Since Abiquo 2.6, you can reconfigure captured virtual machines in exactly the same way as virtual machines created in Abiquo.

Release Captured Virtual Machines

Captured virtual machines can be released so that they are no longer managed by Abiquo. Released machines are not modified or destroyed in the hypervisor. A captured virtual machine must be deployed in order for Abiquo to release it.

To release a captured virtual machine, click the release button on the virtual machine control panel.


Administrators should be aware of the implications of changes made in Abiquo for released machines. For example, users may have reconfigured the virtual machine to enable VNC or DVD.