com.iland.core.web.rest.api

Interface VmResource

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

VM Resource Interface.

Author:

Cory Snyder

Method Summary

Modifier and Type	Method and Description
TaskResponse	addVirtualDisk(String vmUuid, VmVirtualDiskCreateRequest disk) Updates the virtual disks for a VM.
TaskResponse	copyVm(String vmUuid, VmCopyMoveRequest spec) Creates a new Vm in the Vapp based on an existing Vm.
TaskResponse	createSnapshotForVm(String vmUuid, SnapshotCreateRequest spec) Create a snapshot for the given VM.
TaskResponse	deleteMetadataForVm(String vmUuid, String key) Delete a specific piece of metadata associated with a Vm by its key.
TaskResponse	deleteVirtualDisk(String vmUuid, String diskName) Delete a virtual disk from a VM.
TaskResponse	deleteVirtualNetworkCard(String vmUuid, String vnicId) Delete a vnic with the given ID for the given VM.
TaskResponse	deleteVm(String vmUuid) Delete a VM.
TaskResponse	disableNestedHypervisor(String vmUuid) Disable nested hypervisor for given VM.
InputStream	downloadBackupFileDownloadBundle(String vmUuid, String taskUuid) Downloads the backup file bundle (ZIP archive) that is associated with the specified bundle task.
InputStream	downloadBackupFileSnapshot(String vmUuid, String backupRunUid, String filename) Downloads a file from a specified backup run.
TaskResponse	ejectMedia(String vmUuid) Eject a media from a Vm.
TaskResponse	enableNestedHypervisor(String vmUuid) Enable nested hypervisor for given VM.
TaskResponse	generateBackupFileDownloadBundle(String vmUuid, GenerateBackupFileDownloadBundleParams params) Generates a new downloadable bundle (ZIP archive) of a collection of file snapshots.
StorageProfileListResponse	getAvailableStorageProfilesForVm(String vmUuid, Boolean includeDisabled) Get the storage profiles available to the VM.
VmBackupStatusDetailResponse	getBackupStatus(String vmUuid) Gets the VM's backup status.
BillResponse	getBillingForVm(String vmUuid, Integer year, Integer month) Returns VM Billing for a given invoice period.
VmBootOptionsResponse	getBootOptions(String vmUuid) Get the boot options for a given VM.
BillingSummaryResponse	getCurrentBilling(String vmUuid) Return current vm billing for a give Vm.
GuestCustomizationResponse	getGuestCustomization(String vmUuid, Boolean omitPasswords) Get the guest customization section of a Vm.
GuestToolsResponse	getGuestTools(String vmUuid) Get VMWare tools information for the given VM.
MetadataListResponse	getMetadataForVm(String vmUuid) Retrieve metadata associated with a Vm.
MksScreenTicketResponse	getMksScreenTicket(String vmUuid) Retrieve a mks screen ticket for viewing the console of a given Vm.
VmNetworkListResponse	getNetworksForVm(String vmUuid) Get the networks for a given VM.
PerformanceCounterListResponse	getPerformanceCountersForVm(String vmUuid) Get the list of performance counters that can be used to query for VM performance data.
PerfSampleSerieResponse	getPerformanceForVm(String vmUuid, String group, String name, String type, Long start, Long end, String interval, String limit) Get VM performance data for the given VM, counter, and time range.
ProductSectionPropertyListResponse	getProductSectionPropertiesForVm(String vmUuid) Get the product section properties for the given VM.
RecommendedDiskBusTypeResponse	getRecommendedDiskBusType(String vmUuid) Get the recommended hard disk bus type for the given VM.
RestorePointListResponse	getRestorePoints(String vmUuid) Get restore points for the given VM.
InputStream	getScreen(String vmUuid) Gets the current screen JPEG thumbnail image.
ScreenTicketResponse	getScreenTicket(String vmUuid) Retrieve a screen ticket for viewing the console of a given Vm.
SnapshotResponse	getSnapshotForVm(String vmUuid) Get the snapshot for the given VM.
VirtualDiskListResponse	getVirtualDisks(String vmUuid) Gets the virtual disks for a VM.
VirtualNetworkCardListResponse	getVirtualNetworkCards(String vmUuid) Get a list of virtual network cards for the given VM.
VmResponse	getVm(String vmUuid) Get a Vm by UUID.
VmCapabilityResponse	getVmCapabilities(String vmUuid) Get the VM capabilities for a VM.
VmResourceSummaryResponse	getVmSummary(String vmUuid) Get the resource summary for the given VM.
VmToolsUpgradePolicyResponse	getVmToolsUpgradePolicy(String vmUuid) Get the VMWare tools upgrade policy for the VM.
HasSnapshotResponse	hasVmSnapshot(String vmUuid) Check for the existence of a snapshot for the given VM.
TaskResponse	insertMedia(String vmUuid, VmMediaInsertRequest spec) Insert a media to a Vm.
TaskResponse	installVMWareTools(String vmUuid) The actual action performed will be to mount the VMWare tools ISO on the given VM.
DirectoryListingResponse	listBackupDirectoryContents(String vmUuid, String backupRunUid, String volumeName, String directoryPath, ListBackupSnapshotFilesAndFoldersFilters filters) Gets a directory listing for a VM backup snapshot.
FileSnapshotInfoListResponse	listBackupFileSnapshots(String vmUuid, String backupGroupUid, String filename) Lists all snapshots that are available for a specified file, in association with a specific backup group.
BackupGroupRunListResponse	listBackupRuns(String vmUuid, ListVmBackupGroupRunsFilters filters) Lists all backup runs that are associated with the specified VM.
FilesystemVolumeListResponse	listBackupVolumeSnapshots(String vmUuid, String backupRunUid, Integer attemptNumber) Lists all volumes that are present on a VM backup snapshot.
TaskResponse	moveVm(String vmUuid, VmCopyMoveRequest spec) Moves an existing VM into the specified Vapp.
TaskResponse	powerOffVm(String vmUuid) Power off a VM.
TaskResponse	powerOnVm(String vmUuid, boolean forceGuestCustomization) Power on a VM.
TaskResponse	rebootVm(String vmUuid) Reboot a VM.
TaskResponse	reconfigure(String vmUuid, VmReconfigureRequest spec) Reconfigure a VM.
TaskResponse	relocateVm(String vmUuid, VmRelocateRequest spec) Relocate a Vm to another storage profile.
TaskResponse	removeSnapshotForVm(String vmUuid) Remove a snapshot from a VM.
TaskResponse	rename(String vmUuid, VmNameUpdateRequest spec) Rename a VM.
TaskResponse	resetMacAddresses(String vmUuid) Reset the MAC addresses for all VNICs of the VM.
TaskResponse	resetVm(String vmUuid) Reset a VM.
TaskResponse	restoreSnapshotForVm(String vmUuid) Restore a VM from a snapshot.
TaskResponse	restoreVm(String vmUuid, VmRestoreRequest spec) Restore a VM from a restore point into the same vApp.
TaskResponse	restoreVMBackup(String vmUuid, RestoreVMBackupParams params) Restores a VM backup.
TaskResponse	restoreVmIntoVapp(String vmUuid, VmRestoreIntoVappRequest spec) Restore a VM from a restore point into the given vApp.
RecoverableFilesSearchResultListResponse	searchRecoverableFilesAndFolders(String vmUuid, SearchVmRecoverableFilesAndFoldersFilters filters) Searches for recoverable backup files and folders that are associated with the VM.
void	sendEventHistoryForVm(String vmUuid, EventHistoryEmailRequest spec) Retrieve a CSV report email with all event history for a given Vm.
TaskResponse	shutdownVm(String vmUuid) Shutdown a VM guest operating system.
TaskResponse	suspendVm(String vmUuid) Suspend a VM.
TaskResponse	updateBootOptions(String vmUuid, VmBootOptionsUpdateRequest bootOptions) Update boot options associated with a VM.
TaskResponse	updateCpuCount(String vmUuid, VmCpuCountUpdateRequest spec) Update the cpu count for the given VM.
TaskResponse	updateDescriptionForVm(String vmUuid, VmDescriptionUpdateRequest spec) Update the description for a vm.
TaskResponse	updateGuestCustomization(String vmUuid, GuestCustomizationUpdateRequest guestCustomizationSection) Update the guest customization section of a VM.
TaskResponse	updateMemorySize(String vmUuid, VmMemorySizeUpdateRequest spec) Update the memory size for the given VM.
TaskResponse	updateMetadataForVm(String vmUuid, List<UpdateMetadataRequest> metadata) Add / update metadata associated with a Vm.
TaskResponse	updateProductSectionProperties(String vmUuid, List<ProductSectionPropertyUpdateRequest> requests) Update the product section properties for the given VM.
TaskResponse	updateVirtualDisk(String vmUuid, VmVirtualDiskUpdateRequest disk) Updates a virtual disk.
TaskResponse	updateVirtualDisks(String vmUuid, List<VirtualDiskRequest> disks) Updates the virtual disks for a VM.
TaskResponse	updateVirtualHardwareVersion(String vmUuid) Upgrade the virtual hardware version of a vm to the latest available version.
TaskResponse	updateVirtualNetworkCards(String vmUuid, List<VirtualNetworkCardRequest> vnics) Update virtual network cards for a VM.
TaskResponse	updateVmCapabilities(String vmUuid, VmCapabilityUpdateRequest spec) Update the VM capabilites for a VM.
TaskResponse	updateVmToolsUpgradePolicy(String vmUuid, VmToolsUpgradePolicyUpdateRequest upgradePolicy) Update the VMware tools upgrade policy.
TaskResponse	upgradeGuestTools(String vmUuid) Upgrade VMWare tools for the given VM.

Method Detail

getCurrentBilling

@GET
 @Path(value="/{vmUuid}/billing-summary")
BillingSummaryResponse getCurrentBilling(@PathParam(value="vmUuid")
                                                                                        String vmUuid)

Return current vm billing for a give Vm.

Excluded from public API as its really only intended for consumption in console.

Parameters:

vmUuid - vm uuid

Returns:

current billing for VM

getBillingForVm

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

Returns VM Billing for a given invoice period.

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

Parameters:

vmUuid - VM 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 VM and given invoice period

getScreenTicket

@GET
 @Path(value="/{vmUuid}/screen-ticket")
ScreenTicketResponse getScreenTicket(@PathParam(value="vmUuid")
                                                                                  String vmUuid)

Retrieve a screen ticket for viewing the console of a given Vm.

Parameters:

vmUuid - vm uuid

Returns:

screen ticket

getMksScreenTicket

@GET
 @Path(value="/{vmUuid}/mks-screen-ticket")
MksScreenTicketResponse getMksScreenTicket(@PathParam(value="vmUuid")
                                                                                            String vmUuid)

Retrieve a mks screen ticket for viewing the console of a given Vm.

Parameters:

vmUuid - vm uuid

Returns:

screen ticket

updateVirtualHardwareVersion

@POST
 @Path(value="/{vmUuid}/actions/update-virtual-hardware-version")
TaskResponse updateVirtualHardwareVersion(@PathParam(value="vmUuid")
                                                                                                                  String vmUuid)

Upgrade the virtual hardware version of a vm to the latest available version.

Parameters:

vmUuid - vm uuid

Returns:

asynchronous task details

updateDescriptionForVm

@POST
 @Path(value="/{vmUuid}/actions/update-description")
 @Consumes(value="application/json")
TaskResponse updateDescriptionForVm(@PathParam(value="vmUuid")
                                                                                                                                    String vmUuid,
                                                                                                                                    VmDescriptionUpdateRequest spec)

Update the description for a vm.

Parameters:

vmUuid - vm uuid

spec - specification to update VM description

Returns:

asynchronous task details

sendEventHistoryForVm

@POST
 @Path(value="/{vmUuid}/actions/email-event-history")
void sendEventHistoryForVm(@PathParam(value="vmUuid")
                                                                                       String vmUuid,
                                                                                       EventHistoryEmailRequest spec)

Retrieve a CSV report email with all event history for a given Vm.

Parameters:

vmUuid - vm uuid

spec - email address spec

getMetadataForVm

@GET
 @Path(value="/{vmUuid}/metadata")
MetadataListResponse getMetadataForVm(@PathParam(value="vmUuid")
                                                                              String vmUuid)

Retrieve metadata associated with a Vm.

Parameters:

vmUuid - vm uuid

Returns:

list of metadata for VM

updateMetadataForVm

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

Add / update metadata associated with a Vm.

Parameters:

vmUuid - vm uuid

metadata - list of metadata

Returns:

asynchronous task details

deleteMetadataForVm

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

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

Parameters:

vmUuid - vm uuid

key - metadata key

Returns:

asynchronous task details

insertMedia

@POST
 @Path(value="/{vmUuid}/actions/insert-media")
 @Consumes(value="application/json")
TaskResponse insertMedia(@PathParam(value="vmUuid")
                                                                                                                   String vmUuid,
                                                                                                                   VmMediaInsertRequest spec)

Insert a media to a Vm.

Parameters:

vmUuid - vm uuid

spec - specification detailing which media to insert into VM

Returns:

asynchronous task details

ejectMedia

@POST
 @Path(value="/{vmUuid}/actions/eject-media")
 @Consumes(value="application/json")
TaskResponse ejectMedia(@PathParam(value="vmUuid")
                                                                                                                 String vmUuid)

Eject a media from a Vm.

Parameters:

vmUuid - vm uuid

Returns:

asynchronous task details

relocateVm

@POST
 @Path(value="/{vmUuid}/actions/relocate")
 @Consumes(value="application/json")
TaskResponse relocateVm(@PathParam(value="vmUuid")
                                                                                                              String vmUuid,
                                                                                                              VmRelocateRequest spec)

Relocate a Vm to another storage profile.

Parameters:

vmUuid - vm uuid

spec - specification for relocating VM to another storage profile

Returns:

asynchronous task details

copyVm

@POST
 @Path(value="/{vmUuid}/actions/copy")
 @Consumes(value="application/json")
TaskResponse copyVm(@PathParam(value="vmUuid")
                                                                                                      String vmUuid,
                                                                                                      VmCopyMoveRequest spec)

Creates a new Vm in the Vapp based on an existing Vm.

Parameters:

vmUuid - vm uuid

spec - specification for newly copied vm

Returns:

asynchronous task details

moveVm

@POST
 @Path(value="/{vmUuid}/actions/move")
 @Consumes(value="application/json")
TaskResponse moveVm(@PathParam(value="vmUuid")
                                                                                                      String vmUuid,
                                                                                                      VmCopyMoveRequest spec)

Moves an existing VM into the specified Vapp.

Parameters:

vmUuid - vm uuid

spec - specification for newly moved vm

Returns:

asynchronous task details

getRestorePoints

@GET
 @Path(value="/{vmUuid}/backups")
RestorePointListResponse getRestorePoints(@PathParam(value="vmUuid")
                                                                                 String vmUuid)

Get restore points for the given VM.

Parameters:

vmUuid - vm uuid

Returns:

list of restore points

deleteVm

@DELETE
 @Path(value="/{vmUuid}")
TaskResponse deleteVm(@PathParam(value="vmUuid")
                                                        String vmUuid)

Delete a VM.

Parameters:

vmUuid - vm uuid

Returns:

asynchronous task details

restoreVm

@POST
 @Path(value="/{vmUuid}/actions/restore")
 @Consumes(value="application/json")
TaskResponse restoreVm(@PathParam(value="vmUuid")
                                                                                                            String vmUuid,
                                                                                                            VmRestoreRequest spec)

Restore a VM from a restore point into the same vApp.

Parameters:

vmUuid - vm uuid

spec - VM restore specification

Returns:

asynchronous task details

restoreVmIntoVapp

@POST
 @Path(value="/{vmUuid}/actions/restore-into-vapp")
 @Consumes(value="application/json")
TaskResponse restoreVmIntoVapp(@PathParam(value="vmUuid")
                                                                                                                              String vmUuid,
                                                                                                                              VmRestoreIntoVappRequest spec)

Restore a VM from a restore point into the given vApp.

Parameters:

vmUuid - vm uuid

spec - VM restore specification

Returns:

asynchronous task details

resetMacAddresses

@POST
 @Path(value="/{vmUuid}/actions/reset-mac-addresses")
TaskResponse resetMacAddresses(@PathParam(value="vmUuid")
                                                                                           String vmUuid)

Reset the MAC addresses for all VNICs of the VM.

Parameters:

vmUuid - vm uuid

Returns:

asynchronous task details

rename

@POST
 @Path(value="/{vmUuid}/actions/update-name")
 @Consumes(value="application/json")
TaskResponse rename(@PathParam(value="vmUuid")
                                                                                                             String vmUuid,
                                                                                                             VmNameUpdateRequest spec)

Rename a VM.

Parameters:

vmUuid - vm uuid

spec - specification for renaming the VM

Returns:

asynchronous task details

getVirtualNetworkCards

@GET
 @Path(value="/{vmUuid}/vnics")
VirtualNetworkCardListResponse getVirtualNetworkCards(@PathParam(value="vmUuid")
                                                                                           String vmUuid)

Get a list of virtual network cards for the given VM.

Parameters:

vmUuid - vm uuid

Returns:

list of virtual network cards

getNetworksForVm

@GET
 @Path(value="/{vmUuid}/networks")
VmNetworkListResponse getNetworksForVm(@PathParam(value="vmUuid")
                                                                               String vmUuid)

Get the networks for a given VM.

Parameters:

vmUuid - vm uuid

Returns:

list of networks

deleteVirtualNetworkCard

@DELETE
 @Path(value="/{vmUuid}/vnics/{vnicId}")
 @Consumes(value="application/json")
TaskResponse deleteVirtualNetworkCard(@PathParam(value="vmUuid")
                                                                                                                            String vmUuid,
                                                                                                                            @PathParam(value="vnicId")
                                                                                                                            String vnicId)

Delete a vnic with the given ID for the given VM.

Parameters:

vmUuid - vm uuid

vnicId - vnic id

Returns:

asynchronous task details

updateVirtualNetworkCards

@POST
 @Path(value="/{vmUuid}/actions/update-vnics")
 @Consumes(value="application/json")
TaskResponse updateVirtualNetworkCards(@PathParam(value="vmUuid")
                                                                                                                                 String vmUuid,
                                                                                                                                 List<VirtualNetworkCardRequest> vnics)

Update virtual network cards for a VM.

Parameters:

vmUuid - vm uuid

vnics - of instances

Returns:

asynchronous task details

deleteVirtualDisk

@DELETE
 @Path(value="/{vmUuid}/disks/{diskName}")
 @Consumes(value="application/json")
TaskResponse deleteVirtualDisk(@PathParam(value="vmUuid")
                                                                                                                       String vmUuid,
                                                                                                                       @PathParam(value="diskName")
                                                                                                                       String diskName)

Delete a virtual disk from a VM.

Parameters:

vmUuid - vm uuid

diskName - diskName

Returns:

asynchronous task details

getSnapshotForVm

@GET
 @Path(value="/{vmUuid}/snapshot")
SnapshotResponse getSnapshotForVm(@PathParam(value="vmUuid")
                                                                          String vmUuid)

Get the snapshot for the given VM.

Parameters:

vmUuid - vm uuid

Returns:

snapshot

hasVmSnapshot

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

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

Parameters:

vmUuid - String vm uuid

Returns:

boolean indicating whether snapshot exists

createSnapshotForVm

@POST
 @Path(value="/{vmUuid}/actions/create-snapshot")
 @Consumes(value="application/json")
TaskResponse createSnapshotForVm(@PathParam(value="vmUuid")
                                                                                                                              String vmUuid,
                                                                                                                              SnapshotCreateRequest spec)

Create a snapshot for the given VM.

Parameters:

vmUuid - vm uuid

spec - specification for creating a VM snapshot

Returns:

asynchronous task details

restoreSnapshotForVm

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

Restore a VM from a snapshot.

Parameters:

vmUuid - vm uuid

Returns:

asynchronous task details

removeSnapshotForVm

@POST
 @Path(value="/{vmUuid}/actions/remove-snapshot")
TaskResponse removeSnapshotForVm(@Context @PathParam(value="vmUuid")
                                                                                         String vmUuid)

Remove a snapshot from a VM.

Parameters:

vmUuid - vm uuid

Returns:

asynchronous task details

getRecommendedDiskBusType

@GET
 @Path(value="/{vmUuid}/recommended-disk-bus-type")
RecommendedDiskBusTypeResponse getRecommendedDiskBusType(@PathParam(value="vmUuid")
                                                                                                                  String vmUuid)

Get the recommended hard disk bus type for the given VM.

Parameters:

vmUuid - vm uuid

Returns:

recommended hard disk bus type

getGuestTools

@GET
 @Path(value="/{vmUuid}/guest-tools")
GuestToolsResponse getGuestTools(@PathParam(value="vmUuid")
                                                                            String vmUuid)

Get VMWare tools information for the given VM.

Parameters:

vmUuid - vm uuid

Returns:

guest tools information

upgradeGuestTools

@POST
 @Path(value="/{vmUuid}/actions/upgrade-guest-tools")
TaskResponse upgradeGuestTools(@PathParam(value="vmUuid")
                                                                                           String vmUuid)

Upgrade VMWare tools for the given VM.

Parameters:

vmUuid - vm uuid

Returns:

asynchronous task details

getPerformanceForVm

@GET
 @Path(value="/{vmUuid}/performance/{group}::{name}::{type}")
PerfSampleSerieResponse getPerformanceForVm(@PathParam(value="vmUuid")
                                                                                                               String vmUuid,
                                                                                                               @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 VM performance data for the given VM, counter, and time range.

Parameters:

vmUuid - VM 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 VM, counter and date range

getPerformanceCountersForVm

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

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

Parameters:

vmUuid - VM UUID

Returns:

the list of performance counters

powerOnVm

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

Power on a VM.

Parameters:

vmUuid - vm uuid

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

Returns:

asynchronous task details

powerOffVm

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

Power off a VM.

Parameters:

vmUuid - vm uuid

Returns:

asynchronous task details

suspendVm

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

Suspend a VM.

Parameters:

vmUuid - vm uuid

Returns:

asynchronous task details

shutdownVm

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

Shutdown a VM guest operating system.

This action requires VMWare tools to be installed.

Parameters:

vmUuid - vm uuid

Returns:

asynchronous task details

resetVm

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

Reset a VM.

Parameters:

vmUuid - vm uuid

Returns:

asynchronous task details

rebootVm

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

Reboot a VM.

Parameters:

vmUuid - vm uuid

Returns:

asynchronous task details

updateCpuCount

@POST
 @Path(value="/{vmUuid}/actions/update-cpu-count")
 @Consumes(value="application/json")
TaskResponse updateCpuCount(@PathParam(value="vmUuid")
                                                                                                                          String vmUuid,
                                                                                                                          VmCpuCountUpdateRequest spec)

Update the cpu count for the given VM.

Parameters:

vmUuid - vm uuid

spec - specification detailing number of cpus to update VM with

Returns:

asynchronous task details

updateMemorySize

@POST
 @Path(value="/{vmUuid}/actions/update-memory-size")
TaskResponse updateMemorySize(@PathParam(value="vmUuid")
                                                                                         String vmUuid,
                                                                                         VmMemorySizeUpdateRequest spec)

Update the memory size for the given VM.

Parameters:

vmUuid - vm uuid

spec - specification detailing memory size to update VM with

Returns:

asynchronous task details

getVm

@GET
 @Path(value="/{vmUuid}")
VmResponse getVm(@PathParam(value="vmUuid")
                                                String vmUuid)

Get a Vm by UUID.

Parameters:

vmUuid - vm uuid

Returns:

vm

getVmSummary

@GET
 @Path(value="/{vmUuid}/summary")
VmResourceSummaryResponse getVmSummary(@PathParam(value="vmUuid")
                                                                              String vmUuid)

Get the resource summary for the given VM.

Parameters:

vmUuid - vm uuid

Returns:

vm resource summary

updateGuestCustomization

@POST
 @Path(value="/{vmUuid}/actions/update-guest-customization")
 @Consumes(value="application/json")
TaskResponse updateGuestCustomization(@PathParam(value="vmUuid")
                                                                                                                                              String vmUuid,
                                                                                                                                              GuestCustomizationUpdateRequest guestCustomizationSection)

Update the guest customization section of a VM.

The guest customization section includes properties of the guest operating system that can be modified such as passwords, and domain names.

Parameters:

vmUuid - vm uuid

guestCustomizationSection - guest customization section

Returns:

asynchronous task details

getGuestCustomization

@GET
 @Path(value="/{vmUuid}/guest-customization")
GuestCustomizationResponse getGuestCustomization(@PathParam(value="vmUuid")
                                                                                                    String vmUuid,
                                                                                                    @QueryParam(value="omitPasswords")
                                                                                                    Boolean omitPasswords)

Get the guest customization section of a Vm.

The guest customization section includes properties of the guest operating system that can be modified such as passwords, and domain names.

Parameters:

vmUuid - vm uuid

omitPasswords - whether to omit the guest customization passwords

Returns:

guest customization section

getBootOptions

@GET
 @Path(value="/{vmUuid}/boot-options")
VmBootOptionsResponse getBootOptions(@PathParam(value="vmUuid")
                                                                                 String vmUuid)

Get the boot options for a given VM.

Parameters:

vmUuid - vm uuid

Returns:

vm boot options

updateBootOptions

@POST
 @Path(value="/{vmUuid}/actions/update-boot-options")
 @Consumes(value="application/json")
TaskResponse updateBootOptions(@PathParam(value="vmUuid")
                                                                                                                                String vmUuid,
                                                                                                                                VmBootOptionsUpdateRequest bootOptions)

Update boot options associated with a VM.

Properties capable of being updated are boot delay and whether to force enter BIOS.

Parameters:

vmUuid - vm uuid

bootOptions - vm boot options

Returns:

asynchronous task details

getVmToolsUpgradePolicy

@GET
 @Path(value="/{vmUuid}/tools-upgrade-policy")
VmToolsUpgradePolicyResponse getVmToolsUpgradePolicy(@PathParam(value="vmUuid")
                                                                                                         String vmUuid)

Get the VMWare tools upgrade policy for the VM.

Parameters:

vmUuid - vm uuid

Returns:

vmware tools upgrade polciy

updateVmToolsUpgradePolicy

@POST
 @Path(value="/{vmUuid}/actions/update-tools-upgrade-policy")
 @Consumes(value="application/json")
TaskResponse updateVmToolsUpgradePolicy(@PathParam(value="vmUuid")
                                                                                                                                                 String vmUuid,
                                                                                                                                                 VmToolsUpgradePolicyUpdateRequest upgradePolicy)

Update the VMware tools upgrade policy.

Parameters:

vmUuid - vm uuid

Returns:

asynchronous task details

getVmCapabilities

@GET
 @Path(value="/{vmUuid}/capabilities")
VmCapabilityResponse getVmCapabilities(@PathParam(value="vmUuid")
                                                                                   String vmUuid)

Get the VM capabilities for a VM.

VM capabilites include cpu and memory hot add abilities.

Parameters:

vmUuid - vm uuid

Returns:

vm capabilities

updateVmCapabilities

@POST
 @Path(value="/{vmUuid}/actions/update-capabilities")
 @Consumes(value="application/json")
TaskResponse updateVmCapabilities(@PathParam(value="vmUuid")
                                                                                                                                   String vmUuid,
                                                                                                                                   VmCapabilityUpdateRequest spec)

Update the VM capabilites for a VM.

VM capabilities include cpu and memory hot add.

Parameters:

vmUuid - vm uuid

spec - vm capability spec

Returns:

asynchronous task details

getVirtualDisks

@GET
 @Path(value="/{vmUuid}/virtual-disks")
VirtualDiskListResponse getVirtualDisks(@PathParam(value="vmUuid")
                                                                                     String vmUuid)

Gets the virtual disks for a VM.

Parameters:

vmUuid - the VM uuid

Returns:

list of virtual disks for the VM

updateVirtualDisks

@POST
 @Path(value="/{vmUuid}/actions/update-virtual-disks")
 @Consumes(value="application/json")
TaskResponse updateVirtualDisks(@PathParam(value="vmUuid")
                                                                                                                                  String vmUuid,
                                                                                                                                  List<VirtualDiskRequest> disks)

Updates the virtual disks for a VM. The name attribute should be null for new disks.

Parameters:

vmUuid - the VM uuid

disks - the new list of disks

Returns:

asynchronous task details

updateVirtualDisk

@POST
 @Path(value="/{vmUuid}/actions/update-virtual-disk")
 @Consumes(value="application/json")
TaskResponse updateVirtualDisk(@PathParam(value="vmUuid")
                                                                                                                                String vmUuid,
                                                                                                                                VmVirtualDiskUpdateRequest disk)

Updates a virtual disk.

Parameters:

vmUuid - the VM uuid

disk - the new disk

Returns:

asynchronous task details

addVirtualDisk

@POST
 @Path(value="/{vmUuid}/actions/add-virtual-disk")
 @Consumes(value="application/json")
TaskResponse addVirtualDisk(@PathParam(value="vmUuid")
                                                                                                                          String vmUuid,
                                                                                                                          VmVirtualDiskCreateRequest disk)

Updates the virtual disks for a VM.

Parameters:

vmUuid - the VM uuid

disk - the new disk

Returns:

asynchronous task details

installVMWareTools

@POST
 @Path(value="/{vmUuid}/actions/install-vmware-tools")
TaskResponse installVMWareTools(@PathParam(value="vmUuid")
                                                                                             String vmUuid)

The actual action performed will be to mount the VMWare tools ISO on the given VM. It is the responsiblity of the user to actually log into the VM and install the VMWare tools.

Parameters:

vmUuid - the VM uuid

Returns:

asynchrounous task details

reconfigure

@POST
 @Path(value="/{vmUuid}/actions/reconfigure")
 @Consumes(value="application/json")
TaskResponse reconfigure(@PathParam(value="vmUuid")
                                                                                                                  String vmUuid,
                                                                                                                  VmReconfigureRequest spec)

Reconfigure a VM. This will update the name and description of the VM as well as the guest customization section, the cpu, memory, and disk specifications.

Any sections left out of the VmReconfigureRequest will be left unchanged.

Parameters:

vmUuid - VM uuid

spec - reconfigure specification

Returns:

asynchronous task details

getScreen

@GET
 @Path(value="/{vmUuid}/screen")
 @Produces(value="image/vnd.ilandcloud.api.v1.0+jpeg")
InputStream getScreen(@PathParam(value="vmUuid")
                                                                                                                   String vmUuid)

Gets the current screen JPEG thumbnail image.

Parameters:

vmUuid - the UUID of the VM

Returns:

JPEG thumbnail image

enableNestedHypervisor

@POST
 @Path(value="/{vmUuid}/actions/enable-nested-hypervisor")
TaskResponse enableNestedHypervisor(@PathParam(value="vmUuid")
                                                                                                     String vmUuid)

Enable nested hypervisor for given VM.

Parameters:

vmUuid - the UUID of the VM

Returns:

asynchrounous task details

disableNestedHypervisor

@POST
 @Path(value="/{vmUuid}/actions/disable-nested-hypervisor")
TaskResponse disableNestedHypervisor(@PathParam(value="vmUuid")
                                                                                                       String vmUuid)

Disable nested hypervisor for given VM.

Parameters:

vmUuid - the UUID of the VM

Returns:

asynchrounous task details

getAvailableStorageProfilesForVm

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

Get the storage profiles available to the VM.

Parameters:

vmUuid - VM uuid

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

Returns:

list of storage profiles available to the VM

getProductSectionPropertiesForVm

@GET
 @Path(value="/{vmUuid}/product-section")
ProductSectionPropertyListResponse getProductSectionPropertiesForVm(@PathParam(value="vmUuid")
                                                                                                                   String vmUuid)

Get the product section properties for the given VM.

Parameters:

vmUuid - the UUID of the VM

Returns:

a list of product section properties

updateProductSectionProperties

@PUT
 @Path(value="/{vmUuid}/actions/product-section")
 @Consumes(value="application/json")
TaskResponse updateProductSectionProperties(@PathParam(value="vmUuid")
                                                                                                                                        String vmUuid,
                                                                                                                                        List<ProductSectionPropertyUpdateRequest> requests)

Update the product section properties for the given VM.

Parameters:

vmUuid - the UUID of the VM

requests - a list of product section properties

Returns:

asynchrounous task details

getBackupStatus

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

Gets the VM's backup status.

Parameters:

vmUuid - the UUID of the VM

Returns:

VM backup status details

searchRecoverableFilesAndFolders

@GET
 @Path(value="/{vmUuid}/recoverable-files-and-folders")
RecoverableFilesSearchResultListResponse searchRecoverableFilesAndFolders(@PathParam(value="vmUuid")
                                                                                                                                       String vmUuid,
                                                                                                                                       @BeanParam
                                                                                                                                       SearchVmRecoverableFilesAndFoldersFilters filters)

Searches for recoverable backup files and folders that are associated with the VM.

Parameters:

vmUuid - the UUID of the VM

filters - optional query filters

Returns:

a list of recoverable files and folders

listBackupRuns

@GET
 @Path(value="/{vmUuid}/backup-runs")
BackupGroupRunListResponse listBackupRuns(@PathParam(value="vmUuid")
                                                                                     String vmUuid,
                                                                                     @BeanParam
                                                                                     ListVmBackupGroupRunsFilters filters)

Lists all backup runs that are associated with the specified VM.

Parameters:

vmUuid - the UUID of the VM

filters - optional query filters

Returns:

a list of backup runs that are associated with the VM

listBackupFileSnapshots

@GET
 @Path(value="/{vmUuid}/backup-groups/{backupGroupUid}/files/{filename}")
FileSnapshotInfoListResponse listBackupFileSnapshots(@PathParam(value="vmUuid")
                                                                                                                                    String vmUuid,
                                                                                                                                    @PathParam(value="backupGroupUid")
                                                                                                                                    String backupGroupUid,
                                                                                                                                    @PathParam(value="filename") @Encoded
                                                                                                                                    String filename)

Lists all snapshots that are available for a specified file, in association with a specific backup group.

Parameters:

vmUuid - the UUID of the VM

backupGroupUid - the UID of the backup group

filename - the name of the file

Returns:

list of all snapshots available for the file

downloadBackupFileSnapshot

@GET
 @Path(value="/{vmUuid}/backup-runs/{backupRunUid}/files/{filename}")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+octet-stream")
InputStream downloadBackupFileSnapshot(@PathParam(value="vmUuid")
                                                                                                                                                                                       String vmUuid,
                                                                                                                                                                                       @PathParam(value="backupRunUid")
                                                                                                                                                                                       String backupRunUid,
                                                                                                                                                                                       @PathParam(value="filename") @Encoded
                                                                                                                                                                                       String filename)

Downloads a file from a specified backup run.

Parameters:

vmUuid - the UUID of the VM

backupRunUid - the UID of the backup run that created the snapshot

filename - the name of the file

Returns:

content of the file

listBackupVolumeSnapshots

@GET
 @Path(value="/{vmUuid}/backup-runs/{backupRunUid}/volumes")
FilesystemVolumeListResponse listBackupVolumeSnapshots(@PathParam(value="vmUuid")
                                                                                                                         String vmUuid,
                                                                                                                         @PathParam(value="backupRunUid")
                                                                                                                         String backupRunUid,
                                                                                                                         @QueryParam(value="attemptNumber")
                                                                                                                         Integer attemptNumber)

Lists all volumes that are present on a VM backup snapshot.

Parameters:

vmUuid - the UUID of the VM

backupRunUid - the UID of the backup run

attemptNumber - the snapshot attempt number

Returns:

list of vm backup volume snapshots

listBackupDirectoryContents

@GET
 @Path(value="/{vmUuid}/backup-runs/{backupRunUid}/volumes/{volumeName}/directories/{directoryPath}/contents")
DirectoryListingResponse listBackupDirectoryContents(@PathParam(value="vmUuid")
                                                                                                                                                                         String vmUuid,
                                                                                                                                                                         @PathParam(value="backupRunUid")
                                                                                                                                                                         String backupRunUid,
                                                                                                                                                                         @PathParam(value="volumeName") @Encoded
                                                                                                                                                                         String volumeName,
                                                                                                                                                                         @PathParam(value="directoryPath") @Encoded
                                                                                                                                                                         String directoryPath,
                                                                                                                                                                         @BeanParam
                                                                                                                                                                         ListBackupSnapshotFilesAndFoldersFilters filters)

Gets a directory listing for a VM backup snapshot.

Parameters:

vmUuid - the UUID of the VM

backupRunUid - the UID of the backup run that the snapshot is associated with

volumeName - the name of the volume

directoryPath - the full directory path to list

filters - optional query filters

Returns:

vm backup directory listing

generateBackupFileDownloadBundle

@POST
 @Path(value="/{vmUuid}/actions/generate-backup-file-download-bundle")
TaskResponse generateBackupFileDownloadBundle(@PathParam(value="vmUuid")
                                                                                                                           String vmUuid,
                                                                                                                           GenerateBackupFileDownloadBundleParams params)

Generates a new downloadable bundle (ZIP archive) of a collection of file snapshots.

Parameters:

vmUuid - the UUID of the VM

params - the specification for which files to download

Returns:

asynchronous task that indicates eventual completion and success/failure

downloadBackupFileDownloadBundle

@GET
 @Path(value="/{vmUuid}/backup-file-download-bundles/{taskUuid}")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+octet-stream")
InputStream downloadBackupFileDownloadBundle(@PathParam(value="vmUuid")
                                                                                                                                                                                         String vmUuid,
                                                                                                                                                                                         @PathParam(value="taskUuid")
                                                                                                                                                                                         String taskUuid)

Downloads the backup file bundle (ZIP archive) that is associated with the specified bundle task.

Parameters:

vmUuid - the UUID of the VM

taskUuid - the UUID of the bundle task

Returns:

zip archive content

restoreVMBackup

@POST
 @Path(value="/{vmUuid}/actions/restore-vm-backup")
TaskResponse restoreVMBackup(@PathParam(value="vmUuid")
                                                                                       String vmUuid,
                                                                                       RestoreVMBackupParams params)

Restores a VM backup.

Parameters:

vmUuid - the UUID of the VM

params - restoration parameters

Returns:

the restore task, used to track the asynchronous operation