Package com.iland.core.web.rest.api

Interface VappTemplateResource

@Path("/vapp-templates") @Consumes("application/json") @Produces("application/vnd.ilandcloud.api.v1.0+json") public interface VappTemplateResource
Vapp Template Resource Interface v1.
Author:
Cory Snyder

  • Method Details

    • getVappTemplate

      @GET @Path("/{templateUuid}") VappTemplateResponse getVappTemplate(@PathParam("templateUuid") String templateUuid)
      Retrieve a vApp Template.
      Parameters:
      templateUuid - vapp template uuid
      Returns:
      vapp template object

    • getVappTemplateConfiguration

      @GET @Path("/{templateUuid}/configuration") VappTemplateConfigurationResponse getVappTemplateConfiguration(@PathParam("templateUuid") String templateUuid)
      Retrieve a vApp Template's detailed configuration.
      Parameters:
      templateUuid - vapp template uuid
      Returns:
      vapp template configuration details

    • getVappTemplateVms

      @GET @Path("/{templateUuid}/vms") VappTemplateVmListResponse getVappTemplateVms(@PathParam("templateUuid") String templateUuid)
      Retrieve a vApp Template's VMs.
      Parameters:
      templateUuid - vapp template uuid
      Returns:
      vapp template vms list

    • getMetadataForVappTemplate

      @GET @Path("/{templateUuid}/metadata") MetadataListResponse getMetadataForVappTemplate(@PathParam("templateUuid") String templateUuid)
      Retrieve metadata associated with a vapp template.
      Parameters:
      templateUuid - vapp template uuid
      Returns:
      list of metadata for the vapp template

    • updateMetadataForVappTemplate

      @PUT @Path("/{templateUuid}/metadata") @Consumes("application/json") com.iland.core.web.rest.response.task.TaskResponse updateMetadataForVappTemplate(@PathParam("templateUuid") String templateUuid, List<UpdateMetadataRequest> metadata)
      Add / update metadata associated with a vapp template.
      Parameters:
      templateUuid - vapp template uuid
      metadata - of instances
      Returns:
      asynchronous task details

    • deleteMetadataForVappTemplate

      @DELETE @Path("/{templateUuid}/metadata/{key}") com.iland.core.web.rest.response.task.TaskResponse deleteMetadataForVappTemplate(@PathParam("templateUuid") String templateUuid, @PathParam("key") String key)
      Delete a specific piece of metadata associated with a vapp template by its key.
      Parameters:
      templateUuid - vapp template uuid
      key - metadata key
      Returns:
      asynchronous task details

    • updateVappTemplate

      @PUT @Path("/{templateUuid}") @Consumes("application/json") com.iland.core.web.rest.response.task.TaskResponse updateVappTemplate(@PathParam("templateUuid") String templateUuid, VappTemplateUpdateRequest req)
      Update a Vapp Template.

      Capable of updating the templates name, and description.

      Parameters:
      templateUuid - vapp template uuid
      req - vapp template update request
      Returns:
      asynchronous task details

    • deleteVappTemplate

      @DELETE @Path("/{templateUuid}") com.iland.core.web.rest.response.task.TaskResponse deleteVappTemplate(@PathParam("templateUuid") String templateUuid)
      Delete a Vapp template.
      Parameters:
      templateUuid - vapp template uuid
      Returns:
      asynchronous task details

    • enableVappTemplateDownload

      @POST @Path("/{templateUuid}/actions/enable-download") com.iland.core.web.rest.response.task.TaskResponse enableVappTemplateDownload(@PathParam("templateUuid") String templateUuid)
      Enable the download of the vapp template. Returns a CoreTask which monitors the progress of the download. Use download(String) endpoint when task progress is synced to download the vapp template.
      Parameters:
      templateUuid - vapp template uuid

    • download

      @GET @Path("/{templateUuid}/download") @Produces("application/vnd.ilandcloud.api.v1.0+octet-stream") InputStream download(@PathParam("templateUuid") String templateUuid)
      Download the vApp template. enableVappTemplateDownload(String) must be called first and synced before attempting to download.
      Parameters:
      templateUuid - vapp template uuid
      Returns:
      InputStream ova file

    • getDownloadDetails

      @GET @Path("/{templateUuid}/download-details") VappTemplateDownloadDetailsResponse getDownloadDetails(@PathParam("templateUuid") String templateUuid)
      Gets download details for the vApp Template. Details include whether the template is enabled for download, and, if enabled, the size and name of the download.
      Parameters:
      templateUuid - vapp template uuid
      Returns:
      the download details

    • syncVappTemplate

      @POST @Path("/{templateUuid}/actions/sync") com.iland.core.web.rest.response.task.TaskResponse syncVappTemplate(@PathParam("templateUuid") String templateUuid)
      Sync a vapp template item belonging to a catalog with its source object.
      Parameters:
      templateUuid - vapp template uuid to sync
      Returns:
      asynchronous task details