Skip to end of metadata
Go to start of metadata

How to Import Templates into the Appliance Library

The options for importing templates are described below. They are:

  • Use GUI upload
  • Use Abiquo API download
  • Manually upload the virtual disk and OVF file
  • Use template-repository

Use the UI to Upload a VM Disk File into the Abiquo Appliance Library

For smaller VM disk files, using the GUI upload is recommended. Abiquo will generate the OVF descriptor for the disk file.

In Abiquo 3.0 and above, the browser performs a multi-part upload, but the HTTP protocol is still used, so there is no recovery of partially uploaded files.

See Adding VM Templates to the Appliance Library in the User's Guide.

Manually Upload a VM Template to the NFS Repository

Use manual upload for larger VM templates.

Manual Upload Prerequisites

Adding templates to the NFS Repository requires access to the NFS repository file system, so a system administrator should be responsible for this task.

You should be familiar with Appliance Library and VM Template Concepts

Abiquo VM Templates are OVF Packages and they consist of disk files and ovf descriptors.

You can use external tools to generate an OVF Package to be imported into Abiquo as a VM template. These tools include recent versions of VirtualBox and VMware vShpere.

Current OVF Package restrictions are:

  • Abiquo only supports single disk based OVF descriptions.
  • Abiquo only supports single system based OVF descriptions.

Templates exported from VirtualBox with command line export

VirtualBox export from the command line does not generate an OVF document compliant to the OVF xsd. The ''size'' attribute of all the File elements in the References section is missing, so you should add it to virtual machine templates exported with VBoxManage command line utility. The VirtualBox GUI correctly generates the ''size'' attribute.

Manual Upload Process

To upload VM templates to the Abiquo Platform, the manual process consists of these steps:

  1. Copy the file(s) to the Abiquo NFS repository.
  2. Create the OVF file that describes the uploaded VM template disk file if necessary.
  3. Refresh the Appliance Library view of the repository.

Copy the file(s) to the repository

VM Templates and Directories

Each VM template must have its own directory. The directory name is not important, but a directory must be created for each VM template.

VM Template files must be copied to the Abiquo NFS repository.

  • Create a separate directory for each OVF Package on the repository file system under the directory for your enterprise ID.
    The first level of directories in the repository matches the Enterprise ID. The default enterprise is Abiquo and the default enterprise ID is 1. For other enterprises, you
    can determine your enterprise id using the API.
  • Copy the disk file (e.g. .vmdk, .vdi ...) and the ovf descriptor document (.ovf) if you have one; otherwise you can create the OVF descriptor document.

The general format is:

In this example we will upload images to the default enterprise repository. The Abiquo default enterprise ID is 1, so the working directory will be: /opt/vm_repository/1.
Create a separate directory for each template to be uploaded and copy it in (using SCP, for example)

If you have an OVF descriptor, copy it too.

In this example, we will use a standard Debian icon called "debian.png" and the Abiquo Server has the IP address of, so the command will look as follows:

You can check if your icon is available by going to its web address in your browser. In our example, this will be:

Add the icon to the VM template in the appliance library

Now log in to Abiquo and go to the Appliance Library. In our example, the microlinux virtual machine template has the Abiquo default icon.

Select the virtual machine template that you want to change the icon of. Click edit. In our example, we have edited the microlinux template.

Enter the URL of the template icon in the format "http://<abiquo-server-ip>/icons/<filename>". In our example this is:

Then click Validate. You should now see the new image beneath the URL.

Click Accept to save the new icon.

You're done. Now your virtual machine template has a new look!

  • No labels