org.jclouds.cloudstack.features
Interface ISOClient

public interface ISOClient

Author:

Richard Downer

See Also:

ISOAsyncClient, http://download.cloud.com/releases/2.2.12/api/TOC_User.html

Method Summary

AsyncCreateResponse	attachISO(long isoId, long vmId) Attaches an ISO to a virtual machine.
AsyncCreateResponse	copyISO(long isoId, long sourceZoneId, long destZoneId) Copies a template from one zone to another.
AsyncCreateResponse	deleteISO(long id, DeleteISOOptions... options) Deletes an ISO file.
AsyncCreateResponse	detachISO(long vmId) Detaches any ISO file (if any) currently attached to a virtual machine.
AsyncCreateResponse	extractISO(long id, ExtractMode mode, long zoneId, ExtractISOOptions... options) Extracts an ISO
ISO	getISO(long id) Gets information about an ISO by its ID.
ISOPermissions	listISOPermissions(long id, AccountInDomainOptions... options) List template visibility and all accounts that have permissions to view this template.
Set<ISO>	listISOs(ListISOsOptions... options) Lists all available ISO files.
ISO	registerISO(String name, String displayText, String url, long zoneId, RegisterISOOptions... options) Registers an existing ISO into the Cloud.com Cloud.
ISO	updateISO(long id, UpdateISOOptions... options)
void	updateISOPermissions(long id, UpdateISOPermissionsOptions... options) Updates iso permissions

Method Detail

attachISO

AsyncCreateResponse attachISO(long isoId,
                              long vmId)

Attaches an ISO to a virtual machine.

Parameters:

isoId - the ID of the ISO file

vmId - the ID of the virtual machine

Returns:

an asynchronous job response.

detachISO

AsyncCreateResponse detachISO(long vmId)

Detaches any ISO file (if any) currently attached to a virtual machine.

Parameters:

vmId - The ID of the virtual machine

Returns:

an asynchronous job response.

getISO

ISO getISO(long id)

Gets information about an ISO by its ID.

Parameters:

id - the ID of the ISO file

Returns:

the ISO object matching the ID

listISOs

Set<ISO> listISOs(ListISOsOptions... options)

Lists all available ISO files.

Parameters:

options - optional arguments

Returns:

a set of ISO objects the match the filter

registerISO

ISO registerISO(String name,
                String displayText,
                String url,
                long zoneId,
                RegisterISOOptions... options)

Registers an existing ISO into the Cloud.com Cloud.

Parameters:

name - the name of the ISO

displayText - the display text of the ISO. This is usually used for display purposes.

url - the URL to where the ISO is currently being hosted

zoneId - the ID of the zone you wish to register the ISO to.

options - optional arguments

Returns:

the newly-added ISO

updateISO

ISO updateISO(long id,
              UpdateISOOptions... options)

Parameters:

id - the ID of the ISO file

options - optional arguments

Returns:

the ISO object matching the ID

deleteISO

AsyncCreateResponse deleteISO(long id,
                              DeleteISOOptions... options)

Deletes an ISO file.

Parameters:

id - the ID of the ISO file

options - optional arguments

Returns:

an asynchronous job response.

copyISO

AsyncCreateResponse copyISO(long isoId,
                            long sourceZoneId,
                            long destZoneId)

Copies a template from one zone to another.

Parameters:

isoId - Template ID.

sourceZoneId - ID of the zone the template is currently hosted on.

destZoneId - ID of the zone the template is being copied to.

Returns:

an asynchronous job response.

updateISOPermissions

void updateISOPermissions(long id,
                          UpdateISOPermissionsOptions... options)

Updates iso permissions

Parameters:

id - the template ID

options - optional arguments

listISOPermissions

ISOPermissions listISOPermissions(long id,
                                  AccountInDomainOptions... options)

List template visibility and all accounts that have permissions to view this template.

Parameters:

id - the template ID

options - optional arguments

Returns:

A set of the permissions on this ISO

extractISO

AsyncCreateResponse extractISO(long id,
                               ExtractMode mode,
                               long zoneId,
                               ExtractISOOptions... options)

Extracts an ISO

Parameters:

id - the ID of the ISO file

mode - the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD

zoneId - the ID of the zone where the ISO is originally located

options - optional arguments

Returns:

an asynchronous job response.