Method Detail

• attachISO

  @Named(value="attachIso")
  @GET
  @Consumes(value="application/json")
  AsyncCreateResponse attachISO(@QueryParam(value="id")
                                                 String isoId,
                                                 @QueryParam(value="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(value="detachIso")
  @GET
  @Consumes(value="application/json")
  AsyncCreateResponse detachISO(@QueryParam(value="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(value="listIsos")
  @GET
  @Consumes(value="application/json")
  ISO getISO(@QueryParam(value="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(value="listIsos")
  @GET
  @Consumes(value="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(value="registerIso")
  @GET
  @Consumes(value="application/json")
  ISO registerISO(@QueryParam(value="name")
                                   String name,
                                   @QueryParam(value="displaytext")
                                   String displayText,
                                   @QueryParam(value="url")
                                   String url,
                                   @QueryParam(value="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(value="updateIso")
  @GET
  @Consumes(value="application/json")
  ISO updateISO(@QueryParam(value="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(value="deleteIso")
  @GET
  @Consumes(value="application/json")
  AsyncCreateResponse deleteISO(@QueryParam(value="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(value="copyIso")
  @GET
  @Consumes(value="application/json")
  AsyncCreateResponse copyISO(@QueryParam(value="id")
                                               String isoId,
                                               @QueryParam(value="sourcezoneid")
                                               String sourceZoneId,
                                               @QueryParam(value="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(value="updateIsoPermissions")
  @GET
  @Consumes(value="application/json")
  void updateISOPermissions(@QueryParam(value="id")
                                             String id,
                                             UpdateISOPermissionsOptions... options)

  Updates iso permissions

  Parameters:

  id - the template ID

  options - optional arguments

• listISOPermissions

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