org.jclouds.abiquo.features

Interface VirtualMachineTemplateApi

public interface VirtualMachineTemplateApi

Provides synchronous access to Abiquo Apps library API.

Author:

Ignasi Barrera, Francesc Montserrat

See Also:

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

Method Summary

Methods

Modifier and Type	Method and Description
com.abiquo.model.transport.AcceptedRequestDto<String>	createPersistentVirtualMachineTemplate(Integer enterpriseId, Integer datacenterRepositoryId, com.abiquo.server.core.appslibrary.VirtualMachineTemplatePersistentDto persistentOptions) Creates a persistent virtual machine template from other virtual machine template.
void	deleteVirtualMachineTemplate(com.abiquo.server.core.appslibrary.VirtualMachineTemplateDto template) Deletes an existing virtual machine template.
com.abiquo.server.core.appslibrary.ConversionDto	getConversion(com.abiquo.server.core.appslibrary.VirtualMachineTemplateDto template, com.abiquo.model.enumerator.DiskFormatType targetFormat) Get the conversions for a virtual machine template and the desired target format.
com.abiquo.server.core.appslibrary.VirtualMachineTemplateDto	getVirtualMachineTemplate(Integer entepriseId, Integer datacenterRepositoryId, Integer virtualMachineTemplateId) Get the given virtual machine template.
com.abiquo.server.core.appslibrary.ConversionsDto	listConversions(com.abiquo.server.core.appslibrary.VirtualMachineTemplateDto template) List all the conversions for a virtual machine template.
com.abiquo.server.core.appslibrary.ConversionsDto	listConversions(com.abiquo.server.core.appslibrary.VirtualMachineTemplateDto template, ConversionOptions options) List conversions for a virtual machine template.
com.abiquo.server.core.appslibrary.VirtualMachineTemplatesDto	listVirtualMachineTemplates(Integer enterpriseId, Integer datacenterRepositoryId) List all virtual machine templates for an enterprise in a datacenter repository.
com.abiquo.server.core.appslibrary.VirtualMachineTemplatesDto	listVirtualMachineTemplates(Integer enterpriseId, Integer datacenterRepositoryId, VirtualMachineTemplateOptions options) List all virtual machine templates for an enterprise in a datacenter repository.
com.abiquo.model.transport.AcceptedRequestDto<String>	requestConversion(com.abiquo.server.core.appslibrary.VirtualMachineTemplateDto template, com.abiquo.model.enumerator.DiskFormatType targetFormat, com.abiquo.server.core.appslibrary.ConversionDto conversion) Starts a V2V conversion of the current virtual machine template, or updates a failed conversion.
com.abiquo.server.core.appslibrary.VirtualMachineTemplateDto	updateVirtualMachineTemplate(com.abiquo.server.core.appslibrary.VirtualMachineTemplateDto template) Updates an existing virtual machine template.

Method Detail

listVirtualMachineTemplates

com.abiquo.server.core.appslibrary.VirtualMachineTemplatesDto listVirtualMachineTemplates(Integer enterpriseId,
                                                                                        Integer datacenterRepositoryId)

List all virtual machine templates for an enterprise in a datacenter repository.

Parameters:

enterpriseId - Id of the enterprise.

datacenterRepositoryId - Id of the datacenter repository contaning the templates.

Returns:

The list of virtual machine templates for the enterprise in the datacenter repository.

listVirtualMachineTemplates

com.abiquo.server.core.appslibrary.VirtualMachineTemplatesDto listVirtualMachineTemplates(Integer enterpriseId,
                                                                                        Integer datacenterRepositoryId,
                                                                                        VirtualMachineTemplateOptions options)

List all virtual machine templates for an enterprise in a datacenter repository.

Parameters:

enterpriseId - Id of the enterprise.

datacenterRepositoryId - Id of the datacenter repository contaning the templates.

options - The options to query the virtual machine templates.

Returns:

The filtered list of virtual machine templates for the enterprise in the datacenter repository.

getVirtualMachineTemplate

com.abiquo.server.core.appslibrary.VirtualMachineTemplateDto getVirtualMachineTemplate(Integer entepriseId,
                                                                                     Integer datacenterRepositoryId,
                                                                                     Integer virtualMachineTemplateId)

Get the given virtual machine template.

Parameters:

enterpriseId - Id of the enterprise.

datacenterRepositoryId - Id of the datacenter repository contaning the templates.

enterpriseId - The id of the virtual machine template.

Returns:

The virtual machine template or null if it does not exist.

updateVirtualMachineTemplate

com.abiquo.server.core.appslibrary.VirtualMachineTemplateDto updateVirtualMachineTemplate(com.abiquo.server.core.appslibrary.VirtualMachineTemplateDto template)

Updates an existing virtual machine template.

Parameters:

template - The new attributes for the template.

Returns:

The updated template.

deleteVirtualMachineTemplate

void deleteVirtualMachineTemplate(com.abiquo.server.core.appslibrary.VirtualMachineTemplateDto template)

Deletes an existing virtual machine template.

Parameters:

template - The virtual machine template to delete.

createPersistentVirtualMachineTemplate

com.abiquo.model.transport.AcceptedRequestDto<String> createPersistentVirtualMachineTemplate(Integer enterpriseId,
                                                                                           Integer datacenterRepositoryId,
                                                                                           com.abiquo.server.core.appslibrary.VirtualMachineTemplatePersistentDto persistentOptions)

Creates a persistent virtual machine template from other virtual machine template.

Parameters:

dcRepository - The repository where the persistent virtual machine template will be created.

options - The persistent options like name, volume/tier, virtual datacenter and original template.

Returns:

Response message to the persistent request.

listConversions

com.abiquo.server.core.appslibrary.ConversionsDto listConversions(com.abiquo.server.core.appslibrary.VirtualMachineTemplateDto template)

List all the conversions for a virtual machine template.

Parameters:

template, - The virtual machine template of the conversions.

Returns:

The list of conversions for the virtual machine template.

listConversions

com.abiquo.server.core.appslibrary.ConversionsDto listConversions(com.abiquo.server.core.appslibrary.VirtualMachineTemplateDto template,
                                                                ConversionOptions options)

List conversions for a virtual machine template.

Parameters:

template, - The virtual machine template of the conversions

options, - Optionally filter compatible conversions with a provided hypervisor or with the desired state.

Returns:

The list of conversions for the virtual machine template with the applied constrains.

getConversion

com.abiquo.server.core.appslibrary.ConversionDto getConversion(com.abiquo.server.core.appslibrary.VirtualMachineTemplateDto template,
                                                             com.abiquo.model.enumerator.DiskFormatType targetFormat)

Get the conversions for a virtual machine template and the desired target format.

Parameters:

template, - The virtual machine template of the conversion

targetFormat - The disk format type of the requested conversion

Returns:

The conversions for the virtual machine template with the desired target disk format type.

requestConversion

com.abiquo.model.transport.AcceptedRequestDto<String> requestConversion(com.abiquo.server.core.appslibrary.VirtualMachineTemplateDto template,
                                                                      com.abiquo.model.enumerator.DiskFormatType targetFormat,
                                                                      com.abiquo.server.core.appslibrary.ConversionDto conversion)

Starts a V2V conversion of the current virtual machine template, or updates a failed conversion.

Parameters:

template - The virtual machine template to convert

targetFormat - The requested target DiskFormatType of the conversion.

conversion, - the dto representing the conversion

Returns:

an accepted request with a link to track the progress of the conversion tasks.