Package org.jclouds.cloudstack.features

Interface ISOApi

public interface ISOApi

  • Method Details

    • attachISO

      @Named("attachIso") @GET @Consumes("application/json") AsyncCreateResponse attachISO(@QueryParam("id") String isoId, @QueryParam("virtualmachineid") String 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

      @Named("detachIso") @GET @Consumes("application/json") AsyncCreateResponse detachISO(@QueryParam("virtualmachineid") String 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

      @Named("listIsos") @GET @Consumes("application/json") ISO getISO(@QueryParam("id") String 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

      @Named("listIsos") @GET @Consumes("application/json") 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

      @Named("registerIso") @GET @Consumes("application/json") ISO registerISO(@QueryParam("name") String name, @QueryParam("displaytext") String displayText, @QueryParam("url") String url, @QueryParam("zoneid") String 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

      @Named("updateIso") @GET @Consumes("application/json") ISO updateISO(@QueryParam("id") String id, UpdateISOOptions... options)
      Parameters:
      id - the ID of the ISO file
      options - optional arguments
      Returns:
      the ISO object matching the ID

    • deleteISO

      @Named("deleteIso") @GET @Consumes("application/json") AsyncCreateResponse deleteISO(@QueryParam("id") String id, DeleteISOOptions... options)
      Deletes an ISO file.
      Parameters:
      id - the ID of the ISO file
      options - optional arguments
      Returns:
      an asynchronous job response.

    • copyISO

      @Named("copyIso") @GET @Consumes("application/json") AsyncCreateResponse copyISO(@QueryParam("id") String isoId, @QueryParam("sourcezoneid") String sourceZoneId, @QueryParam("destzoneid") String 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

      @Named("updateIsoPermissions") @GET @Consumes("application/json") void updateISOPermissions(@QueryParam("id") String id, UpdateISOPermissionsOptions... options)
      Updates iso permissions
      Parameters:
      id - the template ID
      options - optional arguments

    • listISOPermissions

      @Named("listIsoPermissions") @GET @Consumes("application/json") ISOPermissions listISOPermissions(@QueryParam("id") String 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

      @Named("extractIso") @GET @Consumes("application/json") AsyncCreateResponse extractISO(@QueryParam("id") String id, @QueryParam("mode") ExtractMode mode, @QueryParam("zoneid") String 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.