com.iland.core.web.rest.api

Interface VappResource

@Path(value="/vapps")
 @Consumes(value="application/json")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
public interface VappResource

Vapp Resource interface v1.

Author:

Cory Snyder

Method Summary

Modifier and Type	Method and Description
TaskResponse	addOrgVdcNetworkToVapp(String vappUuid, String networkUuid) Add a new Org Vdc Network Direct Network to the given vApp.
TaskResponse	addVappNetwork(String vappUuid, VappNetworkCreateRequest vappNetworkCreateRequest) Add a new vApp network to the given vApp.
TaskResponse	addVms(String vappUuid, List<VmCreateRequest> requests) Add virtual machines to the vApp from templates.
TaskResponse	buildVms(String vappUuid, List<BuildVmRequest> vms) Create virtual machines in a vApp
TaskResponse	copyVapp(String vappUuid, VappCopyMoveRequest spec) Creates a new vApp in the Vdc based on an existing vapp.
TaskResponse	createSnapshot(String vappUuid, SnapshotCreateRequest request) Create a snapshot for the given vApp.
TaskResponse	deleteMetadataForVapp(String vappUuid, String key) Delete a specific piece of metadata associated with a Vapp by its key.
TaskResponse	deleteVapp(String vappUuid) Delete a vApp.
InputStream	downloadVapp(String vappUuid) Download the vApp as an OVA package.
TaskResponse	enableDownload(String vappUuid) Enable the download of the vapp.
StorageProfileListResponse	getAvailableStorageProfiles(String vappUuid, Boolean includeDisabled) Get the storage profiles available to the vApp.
VappBackupStatusDetailResponse	getBackupStatus(String vappUuid) Gets the vApp's backup status.
BillResponse	getBillingForVapp(String vappUuid, Integer year, Integer month) Returns vApp Billing for a given invoice period.
DownloadDetailsResponse	getDownloadDetailsForVapp(String vappUuid) Gets download details for the vApp.
MetadataListResponse	getMetadataForVapp(String vappUuid) Retrieve metadata associated with a Vapp.
VappNetworkListResponse	getNetworksFor(String vappUuid) Get the networks for a given vApp.
PerformanceCounterListResponse	getPerformanceCounters(String vappUuid) Get the list of performance counters that can be used to query for vApp performance data.
PerfSampleSerieResponse	getPerformanceForVapp(String vappUuid, String group, String name, String type, Long start, Long end, String interval, String limit) Get vApp performance data for the given vApp, counter, and time range.
SnapshotResponse	getSnapshot(String vappUuid) Get the snapshot for the given vApp.
VappStartupSectionItemListResponse	getStartupSection(String vappUuid) Get the startup section for a particular Vapp.
VappResourceSummaryResponse	getSummary(String vappUuid) Get the resource summary for the given vApp.
VappResponse	getVapp(String vAppUuid) Get a vApp by UUID.
VmResourceSummaryMapResponse	getVmResourceSummariesForVapp(String vappUuid) Get the map of resource summaries for all VMs in the given vApp.
VmListResponse	getVmsForVapp(String vappUuid) Get the list of VMs for a vApp.
HasSnapshotResponse	hasVappSnapshot(String vappUuid) Check for the existence of a snapshot for the given vApp.
TaskResponse	managedShutdown(String vappUuid) Managed shutdown of a vApp using the vApp's startup section settings.
TaskResponse	moveVapp(String vappUuid, VappCopyMoveRequest spec) Creates a new vApp in the Vdc based on an existing vapp.
TaskResponse	powerOffVapp(String vappUuid) Power off a vApp.
TaskResponse	powerOnVapp(String vappUuid, boolean forceGuestCustomization) Power on a vApp.
TaskResponse	rebootVapp(String vappUuid) Reboot a vApp.
TaskResponse	removeSnapshot(String vappUuid) Remove a snapshot from a vApp.
TaskResponse	resetVapp(String vappUuid) Reset a vApp.
TaskResponse	restoreSnapshot(String vappUuid) Restore a vApp from a snapshot.
void	sendEventHistoryForVapp(String vappUuid, EventHistoryEmailRequest request) Email a CSV report with all event history for a given Vapp.
TaskResponse	shutdownVapp(String vappUuid) Shutdown a vApp.
TaskResponse	suspendVapp(String vappUuid) Suspend a vApp.
TaskResponse	updateDescription(String vappUuid, VappDescriptionUpdateRequest request) Update the description for a vapp.
TaskResponse	updateMetadataForVapp(String vappUuid, List<UpdateMetadataRequest> metadata) Add / update metadata associated with a Vapp.
TaskResponse	updateName(String vappUuid, VappRenameRequest request) Rename a vApp.
TaskResponse	updateRuntimeLease(String vappUuid, RuntimeLeaseUpdateRequest request) Update the runtime lease for the given vApp.
TaskResponse	updateStartupSection(String vappUuid, List<VappStartupSectionItemRequest> startupSection) Update the startup section of a particular Vapp.
TaskResponse	updateStorageLease(String vappUuid, StorageLeaseUpdateRequest request) Update the storage lease for the given vApp.

Method Detail

getBillingForVapp

@GET
 @Path(value="/{vappUuid}/billing")
BillResponse getBillingForVapp(@PathParam(value="vappUuid")
                                                                        String vappUuid,
                                                                        @QueryParam(value="year")
                                                                        Integer year,
                                                                        @QueryParam(value="month")
                                                                        Integer month)

Returns vApp Billing for a given invoice period.

If month and year are not explicitly supplied the current invoice period is used.

Parameters:

vappUuid - vapp uuid

year - the invoice period year (defaults to current year)

month - the invoice period month (defaults to the current month) must be in range 1-12

Returns:

billing for the vApp and given invoice period

updateDescription

@POST
 @Path(value="/{vappUuid}/actions/update-description")
 @Consumes(value="application/json")
TaskResponse updateDescription(@PathParam(value="vappUuid")
                                                                                                                                 String vappUuid,
                                                                                                                                 VappDescriptionUpdateRequest request)

Update the description for a vapp.

Parameters:

vappUuid - vapp uuid

request - request to update vapp description

Returns:

asynchronous task details

getStartupSection

@GET
 @Path(value="/{vappUuid}/startup-section")
VappStartupSectionItemListResponse getStartupSection(@PathParam(value="vappUuid")
                                                                                                      String vappUuid)

Get the startup section for a particular Vapp.

Parameters:

vappUuid - vapp uuid

Returns:

list of vapp startup section items

updateStartupSection

@POST
 @Path(value="/{vappUuid}/actions/update-startup-section")
 @Consumes(value="application/json")
TaskResponse updateStartupSection(@PathParam(value="vappUuid")
                                                                                                                                        String vappUuid,
                                                                                                                                        List<VappStartupSectionItemRequest> startupSection)

Update the startup section of a particular Vapp.

Parameters:

vappUuid - vapp uuid

startupSection - of instances

Returns:

list of vapp startup section items

sendEventHistoryForVapp

@POST
 @Path(value="/{vappUuid}/actions/email-event-history")
 @Consumes(value="application/json")
void sendEventHistoryForVapp(@PathParam(value="vappUuid")
                                                                                                                                String vappUuid,
                                                                                                                                EventHistoryEmailRequest request)

Email a CSV report with all event history for a given Vapp.

Parameters:

vappUuid - vapp uuid

request - email address request

getMetadataForVapp

@GET
 @Path(value="/{vappUuid}/metadata")
MetadataListResponse getMetadataForVapp(@PathParam(value="vappUuid")
                                                                                  String vappUuid)

Retrieve metadata associated with a Vapp.

Parameters:

vappUuid - vm uuid

Returns:

list of metadata for the vapp

updateMetadataForVapp

@PUT
 @Path(value="/{vappUuid}/metadata")
 @Consumes(value="application/json")
TaskResponse updateMetadataForVapp(@PathParam(value="vappUuid")
                                                                                                                  String vappUuid,
                                                                                                                  List<UpdateMetadataRequest> metadata)

Add / update metadata associated with a Vapp.

Parameters:

vappUuid - vapp uuid

metadata - of instances

Returns:

asynchronous task details

deleteMetadataForVapp

@DELETE
 @Path(value="/{vappUuid}/metadata/{key}")
TaskResponse deleteMetadataForVapp(@PathParam(value="vappUuid")
                                                                                      String vappUuid,
                                                                                      @PathParam(value="key")
                                                                                      String key)

Delete a specific piece of metadata associated with a Vapp by its key.

Parameters:

vappUuid - vapp uuid

key - metadata key

Returns:

asynchronous task details

copyVapp

@POST
 @Path(value="/{vappUuid}/actions/copy")
 @Consumes(value="application/json")
TaskResponse copyVapp(@PathParam(value="vappUuid")
                                                                                                          String vappUuid,
                                                                                                          VappCopyMoveRequest spec)

Creates a new vApp in the Vdc based on an existing vapp.

Parameters:

vappUuid - vapp uuid

spec - specifications for newly copyied vapp

Returns:

asynchronous task details

moveVapp

@POST
 @Path(value="/{vappUuid}/actions/move")
 @Consumes(value="application/json")
TaskResponse moveVapp(@PathParam(value="vappUuid")
                                                                                                          String vappUuid,
                                                                                                          VappCopyMoveRequest spec)

Creates a new vApp in the Vdc based on an existing vapp.

Parameters:

vappUuid - vapp uuid

spec - specifications for newly copyied vapp

Returns:

asynchronous task details

addOrgVdcNetworkToVapp

@POST
 @Path(value="/{vappUuid}/org-vdc-network/{networkUuid}")
TaskResponse addOrgVdcNetworkToVapp(@PathParam(value="vappUuid")
                                                                                                    String vappUuid,
                                                                                                    @PathParam(value="networkUuid")
                                                                                                    String networkUuid)

Add a new Org Vdc Network Direct Network to the given vApp.

Parameters:

vappUuid - vapp uuid

networkUuid - network uuid

Returns:

asynchronous task details

addVappNetwork

@POST
 @Path(value="/{vappUuid}/actions/add-vapp-network")
 @Consumes(value="application/json")
TaskResponse addVappNetwork(@PathParam(value="vappUuid")
                                                                                                                            String vappUuid,
                                                                                                                            VappNetworkCreateRequest vappNetworkCreateRequest)

Add a new vApp network to the given vApp.

Parameters:

vappUuid - vapp uuid

vappNetworkCreateRequest - add vapp network request

Returns:

asynchronous task details

updateName

@POST
 @Path(value="/{vappUuid}/actions/update-name")
 @Consumes(value="application/json")
TaskResponse updateName(@PathParam(value="vappUuid")
                                                                                                                   String vappUuid,
                                                                                                                   VappRenameRequest request)

Rename a vApp.

Parameters:

vappUuid - vapp uuid

request - request for renaming a vApp

Returns:

asynchronous task details

deleteVapp

@DELETE
 @Path(value="/{vappUuid}")
TaskResponse deleteVapp(@PathParam(value="vappUuid")
                                                            String vappUuid)

Delete a vApp.

Parameters:

vappUuid - vapp uuid

Returns:

asynchronous task details

getSnapshot

@GET
 @Path(value="/{vappUuid}/snapshot")
SnapshotResponse getSnapshot(@PathParam(value="vappUuid")
                                                                       String vappUuid)

Get the snapshot for the given vApp.

Parameters:

vappUuid - vapp uuid

Returns:

snapshot

hasVappSnapshot

@GET
 @Path(value="/{vappUuid}/has-snapshot")
HasSnapshotResponse hasVappSnapshot(@PathParam(value="vappUuid")
                                                                                  String vappUuid)

Check for the existence of a snapshot for the given vApp.

Parameters:

vappUuid - vapp uuid

Returns:

whether snapshot exists

createSnapshot

@POST
 @Path(value="/{vappUuid}/actions/create-snapshot")
 @Consumes(value="application/json")
TaskResponse createSnapshot(@PathParam(value="vappUuid")
                                                                                                                           String vappUuid,
                                                                                                                           SnapshotCreateRequest request)

Create a snapshot for the given vApp.

Parameters:

vappUuid - vapp uuid

request - request for creating a snapshot of a vApp

Returns:

asynchronous task details

restoreSnapshot

@POST
 @Path(value="/{vappUuid}/actions/restore-snapshot")
TaskResponse restoreSnapshot(@PathParam(value="vappUuid")
                                                                                        String vappUuid)

Restore a vApp from a snapshot.

Parameters:

vappUuid - vapp uuid

Returns:

asynchronous task details

removeSnapshot

@POST
 @Path(value="/{vappUuid}/actions/remove-snapshot")
TaskResponse removeSnapshot(@PathParam(value="vappUuid")
                                                                                      String vappUuid)

Remove a snapshot from a vApp.

Parameters:

vappUuid - vapp uuid

Returns:

asynchronous task details

updateRuntimeLease

@POST
 @Path(value="/{vappUuid}/actions/update-runtime-lease")
TaskResponse updateRuntimeLease(@PathParam(value="vappUuid")
                                                                                               String vappUuid,
                                                                                               RuntimeLeaseUpdateRequest request)

Update the runtime lease for the given vApp.

Parameters:

vappUuid - vapp uuid

request - lease expiration from now in (seconds)

Returns:

asynchronous task details

updateStorageLease

@POST
 @Path(value="/{vappUuid}/actions/update-storage-lease")
TaskResponse updateStorageLease(@PathParam(value="vappUuid")
                                                                                               String vappUuid,
                                                                                               StorageLeaseUpdateRequest request)

Update the storage lease for the given vApp.

Parameters:

vappUuid - vapp uuid

request - lease expiration from now in (seconds)

Returns:

asynchronous task details

addVms

@POST
 @Path(value="/{vappUuid}/actions/add-vms-from-templates")
 @Consumes(value="application/json")
TaskResponse addVms(@PathParam(value="vappUuid")
                                                                                                                          String vappUuid,
                                                                                                                          List<VmCreateRequest> requests)

Add virtual machines to the vApp from templates.

Parameters:

vappUuid - vapp uuid

requests - list of add vm requests

Returns:

asynchronous task details

buildVms

@POST
 @Path(value="/{vappUuid}/actions/build-vms")
 @Consumes(value="application/json")
TaskResponse buildVms(@PathParam(value="vappUuid")
                                                                                                               String vappUuid,
                                                                                                               List<BuildVmRequest> vms)

Create virtual machines in a vApp

Parameters:

vappUuid - vapp uuid

vms - list of vapp vms

Returns:

asynchronous task details

getNetworksFor

@GET
 @Path(value="/{vappUuid}/networks")
VappNetworkListResponse getNetworksFor(@PathParam(value="vappUuid")
                                                                                 String vappUuid)

Get the networks for a given vApp.

Parameters:

vappUuid - vapp uuid

Returns:

list of networks

getPerformanceForVapp

@GET
 @Path(value="/{vappUuid}/performance/{group}::{name}::{type}")
PerfSampleSerieResponse getPerformanceForVapp(@PathParam(value="vappUuid")
                                                                                                                   String vappUuid,
                                                                                                                   @PathParam(value="group")
                                                                                                                   String group,
                                                                                                                   @PathParam(value="name")
                                                                                                                   String name,
                                                                                                                   @PathParam(value="type")
                                                                                                                   String type,
                                                                                                                   @QueryParam(value="start")
                                                                                                                   Long start,
                                                                                                                   @QueryParam(value="end")
                                                                                                                   Long end,
                                                                                                                   @QueryParam(value="interval")
                                                                                                                   String interval,
                                                                                                                   @QueryParam(value="limit")
                                                                                                                   String limit)

Get vApp performance data for the given vApp, counter, and time range.

Parameters:

vappUuid - vapp uuid

group - the performance counter group

name - the performance counter name

type - the performance counter type

start - start date

end - end date

interval - interval

limit - limit

Returns:

performance samples serie for the given vApp, counter and date range

getPerformanceCounters

@GET
 @Path(value="/{vappUuid}/performance-counters")
PerformanceCounterListResponse getPerformanceCounters(@PathParam(value="vappUuid")
                                                                                                            String vappUuid)

Get the list of performance counters that can be used to query for vApp performance data.

Parameters:

vappUuid - vApp UUID

Returns:

the list of performance counters

powerOnVapp

@POST
 @Path(value="/{vappUuid}/actions/poweron")
TaskResponse powerOnVapp(@PathParam(value="vappUuid")
                                                                           String vappUuid,
                                                                           @QueryParam(value="forceGuestCustomization")
                                                                           boolean forceGuestCustomization)

Power on a vApp.

Parameters:

vappUuid - vapp uuid

forceGuestCustomization - optional param to force guest re-customization on restart defaults to false

Returns:

asynchronous task details

powerOffVapp

@POST
 @Path(value="/{vappUuid}/actions/poweroff")
TaskResponse powerOffVapp(@PathParam(value="vappUuid")
                                                                             String vappUuid)

Power off a vApp.

Parameters:

vappUuid - vapp uuid

Returns:

asynchronous task details

managedShutdown

@POST
 @Path(value="/{vappUuid}/actions/managed-shutdown")
TaskResponse managedShutdown(@PathParam(value="vappUuid")
                                                                                        String vappUuid)

Managed shutdown of a vApp using the vApp's startup section settings.

Parameters:

vappUuid - vapp uuid

Returns:

asynchronous task details

suspendVapp

@POST
 @Path(value="/{vappUuid}/actions/suspend")
TaskResponse suspendVapp(@PathParam(value="vappUuid")
                                                                           String vappUuid)

Suspend a vApp.

Parameters:

vappUuid - vapp uuid

Returns:

asynchronous task details

shutdownVapp

@POST
 @Path(value="/{vappUuid}/actions/shutdown")
TaskResponse shutdownVapp(@PathParam(value="vappUuid")
                                                                             String vappUuid)

Shutdown a vApp.

This action requires VMWare Tools to be installed on each VM in the vApp.

Parameters:

vappUuid - vapp uuid

Returns:

asynchronous task details

resetVapp

@POST
 @Path(value="/{vappUuid}/actions/reset")
TaskResponse resetVapp(@PathParam(value="vappUuid")
                                                                       String vappUuid)

Reset a vApp.

Parameters:

vappUuid - vapp uuid

Returns:

asynchronous task details

rebootVapp

@POST
 @Path(value="/{vappUuid}/actions/reboot")
TaskResponse rebootVapp(@PathParam(value="vappUuid")
                                                                         String vappUuid)

Reboot a vApp.

Parameters:

vappUuid - vapp uuid

Returns:

asynchronous task details

getVapp

@GET
 @Path(value="/{vappUuid}")
VappResponse getVapp(@PathParam(value="vappUuid")
                                                      String vAppUuid)

Get a vApp by UUID.

Parameters:

vAppUuid - vapp uuid

Returns:

vapp

getVmsForVapp

@GET
 @Path(value="/{vAppUuid}/vms")
VmListResponse getVmsForVapp(@PathParam(value="vAppUuid")
                                                                  String vappUuid)

Get the list of VMs for a vApp.

Parameters:

vappUuid - vapp uuid

Returns:

list of vms

getSummary

@GET
 @Path(value="/{vappUuid}/summary")
VappResourceSummaryResponse getSummary(@PathParam(value="vappUuid")
                                                                                String vappUuid)

Get the resource summary for the given vApp.

Parameters:

vappUuid - vapp uuid

Returns:

resource summary for the given vapp

enableDownload

@POST
 @Path(value="/{vappUuid}/actions/enable-download")
TaskResponse enableDownload(@PathParam(value="vappUuid")
                                                                                      String vappUuid)

Enable the download of the vapp. Returns a TaskResponse which monitors the progress of the download. Use downloadVapp(String) endpoint when task progress is synced to download the vapp.

Parameters:

vappUuid - String vapp uuid

Returns:

TaskResponse core task

downloadVapp

@GET
 @Path(value="/{vappUuid}/download")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+octet-stream")
InputStream downloadVapp(@PathParam(value="vappUuid")
                                                                                                                                        String vappUuid)

Download the vApp as an OVA package. enableDownload(String) must be called and synced before attempting to download the vapp.

Parameters:

vappUuid - String vapp uuid

Returns:

InputStream ova file

getDownloadDetailsForVapp

@GET
 @Path(value="/{vappUuid}/download-details")
DownloadDetailsResponse getDownloadDetailsForVapp(@PathParam(value="vappUuid")
                                                                                                    String vappUuid)

Gets download details for the vApp. Details include whether the vapp is enabled for download, and, if enabled, the size and name of the download.

Parameters:

vappUuid - String vapp uuid

Returns:

the download details

getVmResourceSummariesForVapp

@GET
 @Path(value="{vappUuid}/vm-summary-map")
VmResourceSummaryMapResponse getVmResourceSummariesForVapp(@PathParam(value="vappUuid")
                                                                                                          String vappUuid)

Get the map of resource summaries for all VMs in the given vApp.

Parameters:

vappUuid - vApp uuid

Returns:

map of VM uuid to vm resource summary

getAvailableStorageProfiles

@GET
 @Path(value="/{vappUuid}/available-storage-profiles")
StorageProfileListResponse getAvailableStorageProfiles(@PathParam(value="vappUuid")
                                                                                                                   String vappUuid,
                                                                                                                   @QueryParam(value="includeDisabled")
                                                                                                                   Boolean includeDisabled)

Get the storage profiles available to the vApp.

Parameters:

vappUuid - vApp uuid

includeDisabled - whether to include disabled profiles (defaults to false if not explicitly provided)

Returns:

list of storage profiles available to the vApp

getBackupStatus

@GET
 @Path(value="/{vappUuid}/backup-status")
VappBackupStatusDetailResponse getBackupStatus(@PathParam(value="vappUuid")
                                                                                              String vappUuid)

Gets the vApp's backup status.

Parameters:

vappUuid - the UUID of the vApp

Returns:

vApp backup status details