Skip to end of metadata
Go to start of metadata

Deploying and Undeploying Virtual Appliances

API Documentation

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

If you have the privilege to deploy and undeploy virtual appliances, you can do this from the Virtual Appliance Configuration Screen using the deploy button. If you deploy from this screen, a deploy progress popup will display, as shown below. When the virtual appliance is successfully deployed, the deploy button changes to a red Undeploy button. Virtual appliances can also be deployed or undeployed from the Virtual Datacenters View.

The status of the virtual appliance is displayed while the virtual appliance is deploying.

In the following screenshot, the platform is selecting the hypervisor.

In the next screenshot, the platform is copying and attaching the disk (or in the case of a persistent machine, only attaching the disk).

Abiquo Workflow Feature

When you request a deploy, undeploy or reconfigure operation, you may need to wait for response from a remote system to continue, for example, your manager must sign-off on new resources, the Network team must perform custom network configuration, and so on.

The Abiquo workflow feature enables administrators to control deploy, undeploy and reconfigure tasks for virtual machines and virtual appliances through integration with a remote workflow tool.

Abiquo will send a task request to the URL workflow endpoint configured in the Abiquo platform. The workflow tool can then continue or cancel the Abiquo task by responding to this request. Abiquo will wait for the response from the workflow tool.

If your virtual machine is paused by the workflow feature, it will have a status of "Waiting for Review".

See also Abiquo Workflow Feature and Manage Workflow Tasks

Virtual Appliance Notifications

When an error occurs during virtual appliance deployment, an Error status is shown.

Then an error symbol appears in the lower left corner of the virtual appliance icon. If you have the appropriate permissions to remove the error symbol, click on it view the error. If you wish, you can remove the error symbol.

The user and the administrator may be notified of the error. A red error notification message may appear in the lower right corner of the screen. Click on the notification to discard it.

The full details of the error can be found in Events view. They can also be seen in the Events panel in the Home view.

Modifying a Running Virtual Appliance

When a running virtual appliance is modified by adding virtual machines, these new virtual machines will not be automatically deployed. They are in the NOT_ALLOCATED state. And the Deploy button changes to the Sync virtual appliance button.

To apply the changes in the virtual appliance to the hypervisor, click the Sync virtual appliance button. This will deploy new virtual machines in a virtual appliance that already has some virtual machines deployed. Until you click the Sync virtual appliance button, the virtual appliance will not be synchronized with the target hypervisor.

Synchronize virtual appliances

We strongly recommend you keep all virtual appliances updated and synchronized in the hypervisor to avoid errors.

A running virtual appliance with a new virtual machine added and saved is shown in the image below. In this case, you would click Sync virtual appliance to update the virtual appliance in the hypervisor.


Control Virtual Machines

After you deploy a virtual appliance in Abiquo, control its virtual machines with the virtual machine control panel buttons. Open the virtual machine control panel from:

  • Virtual Datacenters view - open the virtual appliance and click the virtual machine

  • Infrastructure view- click the virtual machine in the list of virtual machines on the physical machine

  • The functionality available depends on the hypervisor
  • Full functionality is only available for virtual machines managed by Abiquo:
    • (tick) captured virtual machines
    • (error) virtual machines that were imported / retrieved from the phyiscal machine but not captured




Power off or Shutdown

Power off, shutdown or power on the virtual machine. The virtual machine status bar is green when the machine is powered on and red when it is powered off.


Suspend or restart the virtual machine. The virtual machine status bar is yellow when the virtual machine is paused.


Reboot the virtual machine.

Remote Access

Open a remote access window on the virtual machine. See Configuring Remote Access to Virtual Machines

Send Email

Send a mail to the owner of the virtual machine. Must be configured in the Server/API Properties of Abiquo Configuration Properties

Capture VM

Capture this remote VM. See Import and Capture Virtual Machines  

Release VMRelease this captured VM. See Import and Capture Virtual Machines  
Protect VMProtect a VM for maintenance.
Unprotect VMUnprotect a VM that is protected for maintenance