org.jclouds.abiquo.features

Interface CloudApi

public interface CloudApi

Provides synchronous access to Abiquo Cloud API.

Author:

Ignasi Barrera, Francesc Montserrat

See Also:

http://community.abiquo.com/display/ABI20/API+Reference, CloudAsyncApi

Method Summary

Methods

Modifier and Type	Method and Description
com.abiquo.model.transport.AcceptedRequestDto<String>	changeVirtualMachineState(com.abiquo.server.core.cloud.VirtualMachineDto virtualMachine, com.abiquo.server.core.cloud.VirtualMachineStateDto state) Changes the state an existing virtual machine.
com.abiquo.server.core.infrastructure.storage.DiskManagementDto	createHardDisk(com.abiquo.server.core.cloud.VirtualDatacenterDto virtualDatacenter, com.abiquo.server.core.infrastructure.storage.DiskManagementDto hardDisk) Creates a new hard disk in the given virtual datacenter.
com.abiquo.server.core.infrastructure.network.VLANNetworkDto	createPrivateNetwork(com.abiquo.server.core.cloud.VirtualDatacenterDto virtualDatacenter, com.abiquo.server.core.infrastructure.network.VLANNetworkDto privateNetwork) Create a new private network in a virtual datacenter.
com.abiquo.server.core.cloud.VirtualApplianceDto	createVirtualAppliance(com.abiquo.server.core.cloud.VirtualDatacenterDto virtualDatacenter, com.abiquo.server.core.cloud.VirtualApplianceDto virtualAppliance) Create a new virtual appliance in a virtual datacenter.
com.abiquo.server.core.cloud.VirtualDatacenterDto	createVirtualDatacenter(com.abiquo.server.core.cloud.VirtualDatacenterDto virtualDatacenter, com.abiquo.server.core.infrastructure.DatacenterDto datacenter, com.abiquo.server.core.enterprise.EnterpriseDto enterprise) Create a new virtual datacenter.
com.abiquo.server.core.cloud.VirtualMachineWithNodeExtendedDto	createVirtualMachine(com.abiquo.server.core.cloud.VirtualApplianceDto virtualAppliance, com.abiquo.server.core.cloud.VirtualMachineWithNodeExtendedDto virtualMachine) Create a new virtual machine in a virtual appliance.
com.abiquo.server.core.infrastructure.storage.VolumeManagementDto	createVolume(com.abiquo.server.core.cloud.VirtualDatacenterDto virtualDatacenter, com.abiquo.server.core.infrastructure.storage.VolumeManagementDto volume) Creates a volume in the given virtual datacenter.
void	deleteHardDisk(com.abiquo.server.core.infrastructure.storage.DiskManagementDto hardDisk) Deletes the given hard disk.
void	deletePrivateNetwork(com.abiquo.server.core.infrastructure.network.VLANNetworkDto privateNetwork) Deletes an existing private network.
void	deleteVirtualAppliance(com.abiquo.server.core.cloud.VirtualApplianceDto virtualAppliance) Deletes an existing virtual appliance.
void	deleteVirtualAppliance(com.abiquo.server.core.cloud.VirtualApplianceDto virtualAppliance, VirtualApplianceOptions options) Deletes an existing virtual appliance.
void	deleteVirtualDatacenter(com.abiquo.server.core.cloud.VirtualDatacenterDto virtualDatacenter) Deletes an existing virtual datacenter.
void	deleteVirtualMachine(com.abiquo.server.core.cloud.VirtualMachineDto virtualMachine) Deletes an existing virtual machine.
void	deleteVolume(com.abiquo.server.core.infrastructure.storage.VolumeManagementDto volume) Delete the given volume.
com.abiquo.model.transport.AcceptedRequestDto<String>	deployVirtualAppliance(com.abiquo.server.core.cloud.VirtualApplianceDto virtualAppliance, com.abiquo.server.core.cloud.VirtualMachineTaskDto options) Deploy a virtual appliance.
com.abiquo.model.transport.AcceptedRequestDto<String>	deployVirtualMachine(com.abiquo.server.core.cloud.VirtualMachineDto virtualMachine, com.abiquo.server.core.cloud.VirtualMachineTaskDto options) Deploy a virtual machine with task options.
com.abiquo.model.transport.AcceptedRequestDto<String>	detachAllHardDisks(com.abiquo.server.core.cloud.VirtualMachineDto virtualMachine) Detach all hard disks from the given virtual machine.
com.abiquo.model.transport.AcceptedRequestDto<String>	detachAllVolumes(com.abiquo.server.core.cloud.VirtualMachineDto virtualMachine) Detach all volumes from the given virtual machine.
com.abiquo.server.core.infrastructure.network.VLANNetworkDto	getDefaultNetwork(com.abiquo.server.core.cloud.VirtualDatacenterDto virtualDatacenter) Get the default network of the virtual datacenter.
com.abiquo.server.core.infrastructure.storage.DiskManagementDto	getHardDisk(com.abiquo.server.core.cloud.VirtualDatacenterDto virtualDatacenter, Integer diskId) Get the hard disk with the given id in the given virtual datacenter.
com.abiquo.server.core.infrastructure.network.VLANNetworkDto	getPrivateNetwork(com.abiquo.server.core.cloud.VirtualDatacenterDto virtualDatacenter, Integer privateNetworkId) Get the given private network from the given virtual datacenter.
com.abiquo.server.core.infrastructure.network.PrivateIpDto	getPrivateNetworkIp(com.abiquo.server.core.infrastructure.network.VLANNetworkDto network, Integer ipId) Get the requested ip from the given private network.
com.abiquo.server.core.infrastructure.storage.TierDto	getStorageTier(com.abiquo.server.core.cloud.VirtualDatacenterDto virtualDatacenter, Integer tierId) Get the storage tier from the given virtual datacenter.
com.abiquo.server.core.cloud.VirtualApplianceDto	getVirtualAppliance(com.abiquo.server.core.cloud.VirtualDatacenterDto virtualDatacenter, Integer virtualApplianceId) Get the given virtual appliance from the given virtual datacenter.
com.abiquo.server.core.cloud.VirtualApplianceStateDto	getVirtualApplianceState(com.abiquo.server.core.cloud.VirtualApplianceDto virtualAppliance) Get the state of the given virtual appliance.
com.abiquo.server.core.cloud.VirtualDatacenterDto	getVirtualDatacenter(Integer virtualDatacenterId) Get the given virtual datacenter.
com.abiquo.server.core.cloud.VirtualMachineWithNodeExtendedDto	getVirtualMachine(com.abiquo.server.core.cloud.VirtualApplianceDto virtualAppliance, Integer virtualMachineId) Get the given virtual machine from the given virtual machine.
com.abiquo.server.core.cloud.VirtualMachineStateDto	getVirtualMachineState(com.abiquo.server.core.cloud.VirtualMachineDto virtualMachine) Get the state of the given virtual machine.
com.abiquo.server.core.appslibrary.VirtualMachineTemplateDto	getVirtualMachineTemplate(com.abiquo.server.core.cloud.VirtualMachineDto virtualMachine) Get the template of a virtual machine.
com.abiquo.server.core.infrastructure.storage.VolumeManagementDto	getVolume(com.abiquo.server.core.cloud.VirtualDatacenterDto virtualDatacenter, Integer volumeId) Get a volume from the given virtual datacenter.
com.abiquo.server.core.infrastructure.storage.DisksManagementDto	listAttachedHardDisks(com.abiquo.server.core.cloud.VirtualMachineDto virtualMachine) List all hard disks attached to the given virtual machine.
com.abiquo.server.core.infrastructure.storage.VolumesManagementDto	listAttachedVolumes(com.abiquo.server.core.cloud.VirtualMachineDto virtualMachine) Get the volumes attached to the given virtual machine.
com.abiquo.server.core.infrastructure.network.PublicIpsDto	listAvailablePublicIps(com.abiquo.server.core.cloud.VirtualDatacenterDto virtualDatacenter, IpOptions options) List all available ips to purchase in the datacenter by the virtual datacenter.
com.abiquo.server.core.appslibrary.VirtualMachineTemplatesDto	listAvailableTemplates(com.abiquo.server.core.cloud.VirtualDatacenterDto virtualDatacenter) List all available templates for the given virtual datacenter.
com.abiquo.server.core.appslibrary.VirtualMachineTemplatesDto	listAvailableTemplates(com.abiquo.server.core.cloud.VirtualDatacenterDto virtualDatacenter, VirtualMachineTemplateOptions options) List all available templates for the given virtual datacenter.
com.abiquo.server.core.infrastructure.storage.DisksManagementDto	listHardDisks(com.abiquo.server.core.cloud.VirtualDatacenterDto virtualDatacenter) List all hard disks in the given virtual datacenter.
com.abiquo.server.core.infrastructure.network.VMNetworkConfigurationsDto	listNetworkConfigurations(com.abiquo.server.core.cloud.VirtualMachineDto virtualMachine) List all available network configurations for a virtual machine.
com.abiquo.server.core.infrastructure.network.PrivateIpsDto	listPrivateNetworkIps(com.abiquo.server.core.infrastructure.network.VLANNetworkDto network) List all ips for a private network.
com.abiquo.server.core.infrastructure.network.PrivateIpsDto	listPrivateNetworkIps(com.abiquo.server.core.infrastructure.network.VLANNetworkDto network, IpOptions options) List all ips for a private network with options.
com.abiquo.server.core.infrastructure.network.VLANNetworksDto	listPrivateNetworks(com.abiquo.server.core.cloud.VirtualDatacenterDto virtualDatacenter) List all private networks for a virtual datacenter.
com.abiquo.server.core.infrastructure.network.PublicIpsDto	listPurchasedPublicIps(com.abiquo.server.core.cloud.VirtualDatacenterDto virtualDatacenter, IpOptions options) List all purchased public ip addresses in the virtual datacenter.
com.abiquo.server.core.infrastructure.storage.TiersDto	listStorageTiers(com.abiquo.server.core.cloud.VirtualDatacenterDto virtualDatacenter) List the storage tiers available for the given virtual datacenter.
com.abiquo.server.core.cloud.VirtualAppliancesDto	listVirtualAppliances(com.abiquo.server.core.cloud.VirtualDatacenterDto virtualDatacenter) List all virtual appliance for a virtual datacenter.
com.abiquo.server.core.cloud.VirtualDatacentersDto	listVirtualDatacenters(VirtualDatacenterOptions options) List all virtual datacenters.
com.abiquo.server.core.cloud.VirtualMachinesWithNodeExtendedDto	listVirtualMachines(com.abiquo.server.core.cloud.VirtualApplianceDto virtualAppliance) List all virtual machines for a virtual appliance.
com.abiquo.server.core.cloud.VirtualMachinesWithNodeExtendedDto	listVirtualMachines(com.abiquo.server.core.cloud.VirtualApplianceDto virtualAppliance, VirtualMachineOptions options) List all virtual machines for a virtual appliance.
com.abiquo.server.core.infrastructure.storage.VolumesManagementDto	listVolumes(com.abiquo.server.core.cloud.VirtualDatacenterDto virtualDatacenter) List all volumes in the given virtual datacenter.
com.abiquo.server.core.infrastructure.storage.VolumesManagementDto	listVolumes(com.abiquo.server.core.cloud.VirtualDatacenterDto virtualDatacenter, VolumeOptions options) List all volumes in the given virtual datacenter.
com.abiquo.server.core.infrastructure.storage.VolumeManagementDto	moveVolume(com.abiquo.server.core.infrastructure.storage.VolumeManagementDto volume, com.abiquo.server.core.cloud.VirtualDatacenterDto newVirtualDatacenter) Moves the given volume to a new virtual datacenter.
com.abiquo.server.core.infrastructure.network.PublicIpDto	purchasePublicIp(com.abiquo.server.core.infrastructure.network.PublicIpDto publicIp) Purchase a public IP.
com.abiquo.model.transport.AcceptedRequestDto<String>	rebootVirtualMachine(com.abiquo.server.core.cloud.VirtualMachineDto virtualMachine) Reboot a virtual machine.
com.abiquo.server.core.infrastructure.network.PublicIpDto	releasePublicIp(com.abiquo.server.core.infrastructure.network.PublicIpDto publicIp) Release a public IP.
com.abiquo.model.transport.AcceptedRequestDto<String>	replaceHardDisks(com.abiquo.server.core.cloud.VirtualMachineDto virtualMachine, com.abiquo.server.core.infrastructure.storage.DiskManagementDto... hardDisks) Replaces the current hard disks attached to the virtual machine with the given ones.
com.abiquo.model.transport.AcceptedRequestDto<String>	replaceVolumes(com.abiquo.server.core.cloud.VirtualMachineDto virtualMachine, VirtualMachineOptions options, com.abiquo.server.core.infrastructure.storage.VolumeManagementDto... volumes) Replaces the current volumes attached to the virtual machine with the given ones.
void	setDefaultNetwork(com.abiquo.server.core.cloud.VirtualDatacenterDto virtualDatacenter, com.abiquo.server.core.infrastructure.network.VLANNetworkDto network) Set the default network of the virtual datacenter.
void	setGatewayNetwork(com.abiquo.server.core.cloud.VirtualMachineDto virtualMachine, com.abiquo.server.core.infrastructure.network.VLANNetworkDto network) Sets the gateway network to be used by this virtual machine.
com.abiquo.model.transport.AcceptedRequestDto<String>	undeployVirtualAppliance(com.abiquo.server.core.cloud.VirtualApplianceDto virtualAppliance, com.abiquo.server.core.cloud.VirtualMachineTaskDto options) Undeploy a virtual appliance.
com.abiquo.model.transport.AcceptedRequestDto<String>	undeployVirtualMachine(com.abiquo.server.core.cloud.VirtualMachineDto virtualMachine, com.abiquo.server.core.cloud.VirtualMachineTaskDto options) Uneploy a virtual machine with task options.
com.abiquo.server.core.infrastructure.network.VLANNetworkDto	updatePrivateNetwork(com.abiquo.server.core.infrastructure.network.VLANNetworkDto privateNetwork) Updates an existing private network from the given virtual datacenter.
com.abiquo.server.core.cloud.VirtualApplianceDto	updateVirtualAppliance(com.abiquo.server.core.cloud.VirtualApplianceDto virtualAppliance) Updates an existing virtual appliance from the given virtual datacenter.
com.abiquo.server.core.cloud.VirtualDatacenterDto	updateVirtualDatacenter(com.abiquo.server.core.cloud.VirtualDatacenterDto virtualDatacenter) Updates an existing virtual datacenter.
com.abiquo.model.transport.AcceptedRequestDto<String>	updateVirtualMachine(com.abiquo.server.core.cloud.VirtualMachineWithNodeExtendedDto virtualMachine) Updates an existing virtual machine from the given virtual appliance.
com.abiquo.model.transport.AcceptedRequestDto<String>	updateVirtualMachine(com.abiquo.server.core.cloud.VirtualMachineWithNodeExtendedDto virtualMachine, VirtualMachineOptions options) Updates an existing virtual machine from the given virtual appliance.
com.abiquo.model.transport.AcceptedRequestDto<String>	updateVolume(com.abiquo.server.core.infrastructure.storage.VolumeManagementDto volume) Modifies the given volume.

Method Detail

listVirtualDatacenters

com.abiquo.server.core.cloud.VirtualDatacentersDto listVirtualDatacenters(VirtualDatacenterOptions options)

List all virtual datacenters.

Parameters:

options - Optional query params.

Returns:

The list of Datacenters.

getVirtualDatacenter

com.abiquo.server.core.cloud.VirtualDatacenterDto getVirtualDatacenter(Integer virtualDatacenterId)

Get the given virtual datacenter.

Parameters:

virtualDatacenterId - The id of the virtual datacenter.

Returns:

The virtual datacenter or null if it does not exist.

createVirtualDatacenter

com.abiquo.server.core.cloud.VirtualDatacenterDto createVirtualDatacenter(com.abiquo.server.core.cloud.VirtualDatacenterDto virtualDatacenter,
                                                                        com.abiquo.server.core.infrastructure.DatacenterDto datacenter,
                                                                        com.abiquo.server.core.enterprise.EnterpriseDto enterprise)

Create a new virtual datacenter.

Parameters:

virtualDatacenter - The virtual datacenter to be created.

datacenter - Datacenter where the virtualdatacenter will be deployed.

enterprise - Enterprise of the virtual datacenter.

Returns:

The created virtual datacenter.

updateVirtualDatacenter

com.abiquo.server.core.cloud.VirtualDatacenterDto updateVirtualDatacenter(com.abiquo.server.core.cloud.VirtualDatacenterDto virtualDatacenter)

Updates an existing virtual datacenter.

Parameters:

virtualDatacenter - The new attributes for the virtual datacenter.

Returns:

The updated virtual datacenter.

deleteVirtualDatacenter

void deleteVirtualDatacenter(com.abiquo.server.core.cloud.VirtualDatacenterDto virtualDatacenter)

Deletes an existing virtual datacenter.

Parameters:

virtualDatacenter - The virtual datacenter to delete.

listAvailableTemplates

com.abiquo.server.core.appslibrary.VirtualMachineTemplatesDto listAvailableTemplates(com.abiquo.server.core.cloud.VirtualDatacenterDto virtualDatacenter)

List all available templates for the given virtual datacenter.

Parameters:

virtualDatacenter - The virtual datacenter.

Returns:

The list of available templates.

listAvailableTemplates

com.abiquo.server.core.appslibrary.VirtualMachineTemplatesDto listAvailableTemplates(com.abiquo.server.core.cloud.VirtualDatacenterDto virtualDatacenter,
                                                                                   VirtualMachineTemplateOptions options)

List all available templates for the given virtual datacenter.

Parameters:

virtualDatacenter - The virtual datacenter.

options - Filtering options.

Returns:

The list of available templates.

listAvailablePublicIps

com.abiquo.server.core.infrastructure.network.PublicIpsDto listAvailablePublicIps(com.abiquo.server.core.cloud.VirtualDatacenterDto virtualDatacenter,
                                                                                IpOptions options)

List all available ips to purchase in the datacenter by the virtual datacenter.

Parameters:

virtualDatacenter - The virtual datacenter.

options - Filtering options.

Returns:

The list of available ips.

listPurchasedPublicIps

com.abiquo.server.core.infrastructure.network.PublicIpsDto listPurchasedPublicIps(com.abiquo.server.core.cloud.VirtualDatacenterDto virtualDatacenter,
                                                                                IpOptions options)

List all purchased public ip addresses in the virtual datacenter.

Parameters:

virtualDatacenter - The virtual datacenter.

options - Filtering options.

Returns:

The list of purchased ips.

purchasePublicIp

com.abiquo.server.core.infrastructure.network.PublicIpDto purchasePublicIp(com.abiquo.server.core.infrastructure.network.PublicIpDto publicIp)

Purchase a public IP.

Parameters:

ip - The public ip address to purchase.

Returns:

The purchased public ip.

releasePublicIp

com.abiquo.server.core.infrastructure.network.PublicIpDto releasePublicIp(com.abiquo.server.core.infrastructure.network.PublicIpDto publicIp)

Release a public IP.

Parameters:

ip - The public ip address to purchase.

Returns:

The release public ip.

listStorageTiers

com.abiquo.server.core.infrastructure.storage.TiersDto listStorageTiers(com.abiquo.server.core.cloud.VirtualDatacenterDto virtualDatacenter)

List the storage tiers available for the given virtual datacenter.

Parameters:

virtualDatacenter - The virtual datacenter.

Returns:

The storage tiers available to the given virtual datacenter.

getStorageTier

com.abiquo.server.core.infrastructure.storage.TierDto getStorageTier(com.abiquo.server.core.cloud.VirtualDatacenterDto virtualDatacenter,
                                                                   Integer tierId)

Get the storage tier from the given virtual datacenter.

Parameters:

virtualDatacenter - The virtual datacenter.

The - id of the storage tier.

Returns:

The storage tiers available to the given virtual datacenter.

getDefaultNetwork

com.abiquo.server.core.infrastructure.network.VLANNetworkDto getDefaultNetwork(com.abiquo.server.core.cloud.VirtualDatacenterDto virtualDatacenter)

Get the default network of the virtual datacenter.

Parameters:

virtualDatacenter - The virtual datacenter.

Returns:

The default network of the virtual datacenter.

setDefaultNetwork

void setDefaultNetwork(com.abiquo.server.core.cloud.VirtualDatacenterDto virtualDatacenter,
                     com.abiquo.server.core.infrastructure.network.VLANNetworkDto network)

Set the default network of the virtual datacenter.

Parameters:

virtualDatacenter - The virtual datacenter.

network - The default network.

listPrivateNetworks

com.abiquo.server.core.infrastructure.network.VLANNetworksDto listPrivateNetworks(com.abiquo.server.core.cloud.VirtualDatacenterDto virtualDatacenter)

List all private networks for a virtual datacenter.

Parameters:

virtualDatacenter - The virtual datacenter.

Returns:

The list of private networks for the virtual datacenter.

getPrivateNetwork

com.abiquo.server.core.infrastructure.network.VLANNetworkDto getPrivateNetwork(com.abiquo.server.core.cloud.VirtualDatacenterDto virtualDatacenter,
                                                                             Integer privateNetworkId)

Get the given private network from the given virtual datacenter.

Parameters:

virtualDatacenter - The virtual datacenter.

virtualApplianceId - The id of the private network.

Returns:

The private network or null if it does not exist.

createPrivateNetwork

com.abiquo.server.core.infrastructure.network.VLANNetworkDto createPrivateNetwork(com.abiquo.server.core.cloud.VirtualDatacenterDto virtualDatacenter,
                                                                                com.abiquo.server.core.infrastructure.network.VLANNetworkDto privateNetwork)

Create a new private network in a virtual datacenter.

Parameters:

virtualDatacenter - The virtual datacenter.

privateNetwork - The private network to be created.

Returns:

The created private network.

updatePrivateNetwork

com.abiquo.server.core.infrastructure.network.VLANNetworkDto updatePrivateNetwork(com.abiquo.server.core.infrastructure.network.VLANNetworkDto privateNetwork)

Updates an existing private network from the given virtual datacenter.

Parameters:

privateNetwork - The new attributes for the private network.

Returns:

The updated private network.

deletePrivateNetwork

void deletePrivateNetwork(com.abiquo.server.core.infrastructure.network.VLANNetworkDto privateNetwork)

Deletes an existing private network.

Parameters:

privateNetwork - The private network to delete.

listPrivateNetworkIps

com.abiquo.server.core.infrastructure.network.PrivateIpsDto listPrivateNetworkIps(com.abiquo.server.core.infrastructure.network.VLANNetworkDto network)

List all ips for a private network.

Parameters:

network - The private network.

Returns:

The list of ips for the private network.

listPrivateNetworkIps

com.abiquo.server.core.infrastructure.network.PrivateIpsDto listPrivateNetworkIps(com.abiquo.server.core.infrastructure.network.VLANNetworkDto network,
                                                                                IpOptions options)

List all ips for a private network with options.

Parameters:

network - The private network.

options - Filtering options.

Returns:

The list of ips for the private network.

getPrivateNetworkIp

com.abiquo.server.core.infrastructure.network.PrivateIpDto getPrivateNetworkIp(com.abiquo.server.core.infrastructure.network.VLANNetworkDto network,
                                                                             Integer ipId)

Get the requested ip from the given private network.

Parameters:

network - The private network.

ipId - The id of the ip to get.

Returns:

The requested ip.

listVirtualAppliances

com.abiquo.server.core.cloud.VirtualAppliancesDto listVirtualAppliances(com.abiquo.server.core.cloud.VirtualDatacenterDto virtualDatacenter)

List all virtual appliance for a virtual datacenter.

Parameters:

virtualDatacenter - The virtual datacenter.

Returns:

The list of virtual appliances for the virtual datacenter.

getVirtualAppliance

com.abiquo.server.core.cloud.VirtualApplianceDto getVirtualAppliance(com.abiquo.server.core.cloud.VirtualDatacenterDto virtualDatacenter,
                                                                   Integer virtualApplianceId)

Get the given virtual appliance from the given virtual datacenter.

Parameters:

virtualDatacenter - The virtual datacenter.

virtualApplianceId - The id of the virtual appliance.

Returns:

The virtual appliance or null if it does not exist.

createVirtualAppliance

com.abiquo.server.core.cloud.VirtualApplianceDto createVirtualAppliance(com.abiquo.server.core.cloud.VirtualDatacenterDto virtualDatacenter,
                                                                      com.abiquo.server.core.cloud.VirtualApplianceDto virtualAppliance)

Create a new virtual appliance in a virtual datacenter.

Parameters:

virtualDatacenter - The virtual datacenter.

virtualAppliance - The virtual appliance to be created.

Returns:

The created virtual appliance.

updateVirtualAppliance

com.abiquo.server.core.cloud.VirtualApplianceDto updateVirtualAppliance(com.abiquo.server.core.cloud.VirtualApplianceDto virtualAppliance)

Updates an existing virtual appliance from the given virtual datacenter.

Parameters:

virtualAppliance - The new attributes for the virtual appliance.

Returns:

The updated virtual appliance.

deleteVirtualAppliance

void deleteVirtualAppliance(com.abiquo.server.core.cloud.VirtualApplianceDto virtualAppliance)

Deletes an existing virtual appliance.

Parameters:

virtualAppliance - The virtual appliance to delete.

deleteVirtualAppliance

void deleteVirtualAppliance(com.abiquo.server.core.cloud.VirtualApplianceDto virtualAppliance,
                          VirtualApplianceOptions options)

Deletes an existing virtual appliance.

Parameters:

virtualAppliance - The virtual appliance to delete.

options - The options to customize the delete operation (e.g. Force delete).

deployVirtualAppliance

com.abiquo.model.transport.AcceptedRequestDto<String> deployVirtualAppliance(com.abiquo.server.core.cloud.VirtualApplianceDto virtualAppliance,
                                                                           com.abiquo.server.core.cloud.VirtualMachineTaskDto options)

Deploy a virtual appliance.

Parameters:

virtualAppliance - The virtual appliance to deploy

options - the extra options for the deploy process.

Returns:

Response message to the deploy request.

undeployVirtualAppliance

com.abiquo.model.transport.AcceptedRequestDto<String> undeployVirtualAppliance(com.abiquo.server.core.cloud.VirtualApplianceDto virtualAppliance,
                                                                             com.abiquo.server.core.cloud.VirtualMachineTaskDto options)

Undeploy a virtual appliance.

Parameters:

virtualAppliance - The virtual appliance to undeploy

options - the extra options for the undeploy process.

Returns:

Response message to the undeploy request.

getVirtualApplianceState

com.abiquo.server.core.cloud.VirtualApplianceStateDto getVirtualApplianceState(com.abiquo.server.core.cloud.VirtualApplianceDto virtualAppliance)

Get the state of the given virtual appliance.

Parameters:

virtualAppliance - The given virtual appliance.

Returns:

The state of the given virtual appliance.

listVirtualMachines

com.abiquo.server.core.cloud.VirtualMachinesWithNodeExtendedDto listVirtualMachines(com.abiquo.server.core.cloud.VirtualApplianceDto virtualAppliance)

List all virtual machines for a virtual appliance.

Parameters:

virtualAppliance - The virtual appliance.

Returns:

The list of virtual machines for the virtual appliance.

listVirtualMachines

com.abiquo.server.core.cloud.VirtualMachinesWithNodeExtendedDto listVirtualMachines(com.abiquo.server.core.cloud.VirtualApplianceDto virtualAppliance,
                                                                                  VirtualMachineOptions options)

List all virtual machines for a virtual appliance.

Parameters:

virtualAppliance - The virtual appliance.

options - The options to filter the list of virtual machines.

Returns:

The list of virtual machines for the virtual appliance.

getVirtualMachine

com.abiquo.server.core.cloud.VirtualMachineWithNodeExtendedDto getVirtualMachine(com.abiquo.server.core.cloud.VirtualApplianceDto virtualAppliance,
                                                                               Integer virtualMachineId)

Get the given virtual machine from the given virtual machine.

Parameters:

virtualAppliance - The virtual appliance.

virtualMachineId - The id of the virtual machine.

Returns:

The virtual machine or null if it does not exist.

createVirtualMachine

com.abiquo.server.core.cloud.VirtualMachineWithNodeExtendedDto createVirtualMachine(com.abiquo.server.core.cloud.VirtualApplianceDto virtualAppliance,
                                                                                  com.abiquo.server.core.cloud.VirtualMachineWithNodeExtendedDto virtualMachine)

Create a new virtual machine in a virtual appliance.

Parameters:

virtualAppliance - The virtual appliance.

virtualMachine - The virtual machine to be created.

Returns:

The created virtual machine.

deleteVirtualMachine

void deleteVirtualMachine(com.abiquo.server.core.cloud.VirtualMachineDto virtualMachine)

Deletes an existing virtual machine.

Parameters:

virtualMachine - The virtual machine to delete.

updateVirtualMachine

com.abiquo.model.transport.AcceptedRequestDto<String> updateVirtualMachine(com.abiquo.server.core.cloud.VirtualMachineWithNodeExtendedDto virtualMachine)

Updates an existing virtual machine from the given virtual appliance.

Parameters:

virtualMachine - The new attributes for the virtual machine.

Returns:

The task reference or null if the operation completed synchronously.

updateVirtualMachine

com.abiquo.model.transport.AcceptedRequestDto<String> updateVirtualMachine(com.abiquo.server.core.cloud.VirtualMachineWithNodeExtendedDto virtualMachine,
                                                                         VirtualMachineOptions options)

Updates an existing virtual machine from the given virtual appliance.

Parameters:

virtualMachine - The new attributes for the virtual machine.

options - The update options.

Returns:

The task reference or null if the operation completed synchronously.

changeVirtualMachineState

com.abiquo.model.transport.AcceptedRequestDto<String> changeVirtualMachineState(com.abiquo.server.core.cloud.VirtualMachineDto virtualMachine,
                                                                              com.abiquo.server.core.cloud.VirtualMachineStateDto state)

Changes the state an existing virtual machine.

Parameters:

virtualMachine - The given virtual machine.

state - The new state.

Returns:

The task reference.

getVirtualMachineState

com.abiquo.server.core.cloud.VirtualMachineStateDto getVirtualMachineState(com.abiquo.server.core.cloud.VirtualMachineDto virtualMachine)

Get the state of the given virtual machine.

Parameters:

virtualMachine - The given virtual machine.

Returns:

The state of the given virtual machine.

deployVirtualMachine

com.abiquo.model.transport.AcceptedRequestDto<String> deployVirtualMachine(com.abiquo.server.core.cloud.VirtualMachineDto virtualMachine,
                                                                         com.abiquo.server.core.cloud.VirtualMachineTaskDto options)

Deploy a virtual machine with task options.

Parameters:

virtualMachine - The virtual machine to deploy.

options - extra deploy options.

Returns:

Response message to the deploy request.

undeployVirtualMachine

com.abiquo.model.transport.AcceptedRequestDto<String> undeployVirtualMachine(com.abiquo.server.core.cloud.VirtualMachineDto virtualMachine,
                                                                           com.abiquo.server.core.cloud.VirtualMachineTaskDto options)

Uneploy a virtual machine with task options.

Parameters:

virtualMachine - The virtual machine to undeploy.

options - extra deploy unoptions.

Returns:

Response message to the undeploy request.

listNetworkConfigurations

com.abiquo.server.core.infrastructure.network.VMNetworkConfigurationsDto listNetworkConfigurations(com.abiquo.server.core.cloud.VirtualMachineDto virtualMachine)

List all available network configurations for a virtual machine.

Parameters:

virtualMachine - The virtual machine.

Returns:

The list of network configurations.

setGatewayNetwork

void setGatewayNetwork(com.abiquo.server.core.cloud.VirtualMachineDto virtualMachine,
                     com.abiquo.server.core.infrastructure.network.VLANNetworkDto network)

Sets the gateway network to be used by this virtual machine.

Parameters:

virtualMachine - The virtual machine.

network - The gateway network to use.

rebootVirtualMachine

com.abiquo.model.transport.AcceptedRequestDto<String> rebootVirtualMachine(com.abiquo.server.core.cloud.VirtualMachineDto virtualMachine)

Reboot a virtual machine.

Parameters:

virtualMachine - The virtual machine to reboot.

Returns:

Response message to the reset request.

getVirtualMachineTemplate

com.abiquo.server.core.appslibrary.VirtualMachineTemplateDto getVirtualMachineTemplate(com.abiquo.server.core.cloud.VirtualMachineDto virtualMachine)

Get the template of a virtual machine.

Parameters:

virtualMachine - The given virtual machine.

Returns:

The template of the given virtual machine.

listAttachedVolumes

com.abiquo.server.core.infrastructure.storage.VolumesManagementDto listAttachedVolumes(com.abiquo.server.core.cloud.VirtualMachineDto virtualMachine)

Get the volumes attached to the given virtual machine.

Parameters:

virtualMachine - The virtual machine.

Returns:

The volumes attached to the given virtual machine.

detachAllVolumes

com.abiquo.model.transport.AcceptedRequestDto<String> detachAllVolumes(com.abiquo.server.core.cloud.VirtualMachineDto virtualMachine)

Detach all volumes from the given virtual machine.

If the virtual machine is deployed, the operation will be executed asynchronously.

Parameters:

virtualMachine - The virtual machine.

Returns:

The task reference or null if the operation completed synchronously.

replaceVolumes

com.abiquo.model.transport.AcceptedRequestDto<String> replaceVolumes(com.abiquo.server.core.cloud.VirtualMachineDto virtualMachine,
                                                                   VirtualMachineOptions options,
                                                                   com.abiquo.server.core.infrastructure.storage.VolumeManagementDto... volumes)

Replaces the current volumes attached to the virtual machine with the given ones.

If the virtual machine is deployed, the operation will be executed asynchronously.

Parameters:

virtualMachine - The virtual machine.

options - virtual machine parameters

volumes - The new volumes for the virtual machine.

Returns:

The task reference or null if the operation completed synchronously.

listAttachedHardDisks

com.abiquo.server.core.infrastructure.storage.DisksManagementDto listAttachedHardDisks(com.abiquo.server.core.cloud.VirtualMachineDto virtualMachine)

List all hard disks attached to the given virtual machine.

Parameters:

virtualMachine - The virtual machine.

Returns:

The hard disks attached to the virtual machine.

detachAllHardDisks

com.abiquo.model.transport.AcceptedRequestDto<String> detachAllHardDisks(com.abiquo.server.core.cloud.VirtualMachineDto virtualMachine)

Detach all hard disks from the given virtual machine.

If the virtual machine is deployed, the operation will be executed asynchronously.

Parameters:

virtualMachine - The virtual machine.

Returns:

The task reference or null if the operation completed synchronously.

replaceHardDisks

com.abiquo.model.transport.AcceptedRequestDto<String> replaceHardDisks(com.abiquo.server.core.cloud.VirtualMachineDto virtualMachine,
                                                                     com.abiquo.server.core.infrastructure.storage.DiskManagementDto... hardDisks)

Replaces the current hard disks attached to the virtual machine with the given ones.

If the virtual machine is deployed, the operation will be executed asynchronously.

Parameters:

virtualMachine - The virtual machine.

hardDisks - The new hard disks for the virtual machine.

Returns:

The task reference or null if the operation completed synchronously.

listHardDisks

com.abiquo.server.core.infrastructure.storage.DisksManagementDto listHardDisks(com.abiquo.server.core.cloud.VirtualDatacenterDto virtualDatacenter)

List all hard disks in the given virtual datacenter.

Parameters:

virtualDatacenter - The virtual datacenter.

Returns:

The hard disks in the virtual datacenter.

getHardDisk

com.abiquo.server.core.infrastructure.storage.DiskManagementDto getHardDisk(com.abiquo.server.core.cloud.VirtualDatacenterDto virtualDatacenter,
                                                                          Integer diskId)

Get the hard disk with the given id in the given virtual datacenter.

Parameters:

virtualDatacenter - The virtual datacenter.

diskId - The id of the hard disk to get.

Returns:

The requested hard disk or null if it does not exist.

createHardDisk

com.abiquo.server.core.infrastructure.storage.DiskManagementDto createHardDisk(com.abiquo.server.core.cloud.VirtualDatacenterDto virtualDatacenter,
                                                                             com.abiquo.server.core.infrastructure.storage.DiskManagementDto hardDisk)

Creates a new hard disk in the given virtual datacenter.

Parameters:

virtualDatacenter - The virtual datacenter where the hard disk will be created.

hardDisk - The hard disk to create.

Returns:

The created hard disk.

deleteHardDisk

void deleteHardDisk(com.abiquo.server.core.infrastructure.storage.DiskManagementDto hardDisk)

Deletes the given hard disk.

Parameters:

hardDisk - The hard disk to delete.

listVolumes

com.abiquo.server.core.infrastructure.storage.VolumesManagementDto listVolumes(com.abiquo.server.core.cloud.VirtualDatacenterDto virtualDatacenter)

List all volumes in the given virtual datacenter.

Parameters:

virtualDatacenter - The virtual datacenter.

Returns:

The volumes in the virtual datacenter.

listVolumes

com.abiquo.server.core.infrastructure.storage.VolumesManagementDto listVolumes(com.abiquo.server.core.cloud.VirtualDatacenterDto virtualDatacenter,
                                                                             VolumeOptions options)

List all volumes in the given virtual datacenter.

Parameters:

virtualDatacenter - The virtual datacenter.

options - Optional parameters to filter the volume list.

Returns:

The volumes in the virtual datacenter.

getVolume

com.abiquo.server.core.infrastructure.storage.VolumeManagementDto getVolume(com.abiquo.server.core.cloud.VirtualDatacenterDto virtualDatacenter,
                                                                          Integer volumeId)

Get a volume from the given virtual datacenter.

Parameters:

virtualDatacenter - The virtual datacenter.

volumeId - The id of the volume to get.

Returns:

The volume or null if it does not exist.

createVolume

com.abiquo.server.core.infrastructure.storage.VolumeManagementDto createVolume(com.abiquo.server.core.cloud.VirtualDatacenterDto virtualDatacenter,
                                                                             com.abiquo.server.core.infrastructure.storage.VolumeManagementDto volume)

Creates a volume in the given virtual datacenter.

Parameters:

virtualDatacenter - The virtual datacenter where the volume will be created.

volume - The volume to create. This volume dto must contain a link to the tier where the volume should be created.

Returns:

The created volume.

updateVolume

com.abiquo.model.transport.AcceptedRequestDto<String> updateVolume(com.abiquo.server.core.infrastructure.storage.VolumeManagementDto volume)

Modifies the given volume.

If the virtual machine is deployed and the size of the volume is changed, then an asynchronous task will be generated to refresh the resources of the virtual machine in the hypervisor.

Parameters:

volume - The volume to modify.

Returns:

The task reference or null if no task was generated.

deleteVolume

void deleteVolume(com.abiquo.server.core.infrastructure.storage.VolumeManagementDto volume)

Delete the given volume.

Parameters:

volume - The volume to delete.

moveVolume

com.abiquo.server.core.infrastructure.storage.VolumeManagementDto moveVolume(com.abiquo.server.core.infrastructure.storage.VolumeManagementDto volume,
                                                                           com.abiquo.server.core.cloud.VirtualDatacenterDto newVirtualDatacenter)

Moves the given volume to a new virtual datacenter.

The Abiquo API will return a 301 (Moved Permanently), so redirects must be enabled to make this method succeed.

Parameters:

volume - The volume to move.

newVirtualDatacenter - The destination virtual datacenter.

Returns:

The reference to the volume in the new virtual datacenter.