org.jclouds.vcloud.director.v1_5.features

Interface VmApi

public interface VmApi

Provides synchronous access to Vm objects.

Version:

1.5

Author:

grkvlt@apache.org, Adrian Cole

See Also:

VmAsyncApi

Method Summary

Methods

Modifier and Type	Method and Description
void	answerQuestion(String vmUrn, VmQuestionAnswer answer) Answer a pending question on a Vm.
void	answerQuestion(URI vmHref, VmQuestionAnswer answer)
Task	consolidate(String vmUrn) Consolidates a Vm.
Task	consolidate(URI vmHref)
Task	deploy(String vmUrn, DeployVAppParams params) Deploys a Vm.
Task	deploy(URI vmHref, DeployVAppParams params)
Task	discardSuspendedState(String vmUrn) Discard suspended state of a Vm.
Task	discardSuspendedState(URI vmHref)
Task	edit(String vmUrn, Vm vm) Modifies the name/description of a Vm.
Task	edit(URI vmHref, Vm vm)
Task	editGuestCustomizationSection(String vmUrn, GuestCustomizationSection section) Modifies the guest customization section of a Vm.
Task	editGuestCustomizationSection(URI vmHref, GuestCustomizationSection section)
Task	editNetworkConnectionSection(String vmUrn, NetworkConnectionSection section) Modifies the network connection section of a Vm.
Task	editNetworkConnectionSection(URI vmHref, NetworkConnectionSection section)
Task	editOperatingSystemSection(String vmUrn, OperatingSystemSection section) Modifies the operating system section of a Vm.
Task	editOperatingSystemSection(URI vmHref, OperatingSystemSection section)
Task	editProductSections(String vmUrn, ProductSectionList sectionList) Modifies the product section information of a Vm.
Task	editProductSections(URI vmHref, ProductSectionList sectionList)
Task	editVirtualHardwareSection(String vmUrn, VirtualHardwareSection section) Modifies the virtual hardware section of a Vm.
Task	editVirtualHardwareSection(URI vmHref, VirtualHardwareSection section)
Task	editVirtualHardwareSectionCpu(String vmUrn, RasdItem rasd) Modifies the CPU properties in virtual hardware section of a Vm.
Task	editVirtualHardwareSectionCpu(URI vmHref, RasdItem rasd)
Task	editVirtualHardwareSectionDisks(String vmUrn, RasdItemsList rasdItemsList) Modifies the disks list in virtual hardware section of a Vm.
Task	editVirtualHardwareSectionDisks(URI vmHref, RasdItemsList rasdItemsList)
Task	editVirtualHardwareSectionMemory(String vmUrn, RasdItem rasd) Modifies the memory properties in virtual hardware section of a Vm.
Task	editVirtualHardwareSectionMemory(URI vmHref, RasdItem rasd)
Task	editVirtualHardwareSectionNetworkCards(String vmUrn, RasdItemsList rasdItemsList) Modifies the network cards list in virtual hardware section of a Vm.
Task	editVirtualHardwareSectionNetworkCards(URI vmHref, RasdItemsList rasdItemsList)
Task	editVirtualHardwareSectionSerialPorts(String vmUrn, RasdItemsList rasdItemsList) Modifies the serial ports list in virtual hardware section of a Vm.
Task	editVirtualHardwareSectionSerialPorts(URI vmHref, RasdItemsList rasdItemsList)
Task	ejectMedia(String vmUrn, MediaInsertOrEjectParams mediaParams) Ejects media from a Vm.
Task	ejectMedia(URI vmHref, MediaInsertOrEjectParams mediaParams)
Vm	get(String vmUrn) Retrieves a Vm.
Vm	get(URI vmHref)
GuestCustomizationSection	getGuestCustomizationSection(String vmUrn) Retrieves the guest customization section of a Vm.
GuestCustomizationSection	getGuestCustomizationSection(URI vmHref)
MetadataApi.Writeable	getMetadataApi(String vmUrn) Synchronous access to Vm Metadata features.
MetadataApi.Writeable	getMetadataApi(URI vmHref)
NetworkConnectionSection	getNetworkConnectionSection(String vmUrn) Retrieves the network connection section of a Vm.
NetworkConnectionSection	getNetworkConnectionSection(URI vmHref)
OperatingSystemSection	getOperatingSystemSection(String vmUrn) Retrieves the operating system section of a Vm.
OperatingSystemSection	getOperatingSystemSection(URI vmHref)
VmPendingQuestion	getPendingQuestion(String vmUrn) Retrieves a pending question for a Vm.
VmPendingQuestion	getPendingQuestion(URI vmHref)
ProductSectionList	getProductSections(String vmUrn) Retrieves Vm product sections.
ProductSectionList	getProductSections(URI vmHref)
RuntimeInfoSection	getRuntimeInfoSection(String vmUrn) Retrieves the runtime info section of a Vm.
RuntimeInfoSection	getRuntimeInfoSection(URI vmHref)
byte[]	getScreenImage(String vmUrn) Retrieves the thumbnail of the screen of a Vm.
byte[]	getScreenImage(URI vmHref)
ScreenTicket	getScreenTicket(String vmUrn) Retrieve a screen ticket for remote console connection to a Vm.
ScreenTicket	getScreenTicket(URI vmHref)
VirtualHardwareSection	getVirtualHardwareSection(String vmUrn) Retrieves the virtual hardware section of a Vm.
VirtualHardwareSection	getVirtualHardwareSection(URI vmHref)
RasdItem	getVirtualHardwareSectionCpu(String vmUrn) Retrieves the CPU properties in virtual hardware section of a Vm.
RasdItem	getVirtualHardwareSectionCpu(URI vmHref)
RasdItemsList	getVirtualHardwareSectionDisks(String vmUrn) Retrieves a list of items for disks from virtual hardware section of a Vm.
RasdItemsList	getVirtualHardwareSectionDisks(URI vmHref)
RasdItemsList	getVirtualHardwareSectionMedia(String vmUrn) Retrieves the list of items that represents the floppies and CD/DVD drives in a Vm.
RasdItemsList	getVirtualHardwareSectionMedia(URI vmHref)
RasdItem	getVirtualHardwareSectionMemory(String vmUrn) Retrieves the item that contains memory information from virtual hardware section of a Vm.
RasdItem	getVirtualHardwareSectionMemory(URI vmHref)
RasdItemsList	getVirtualHardwareSectionNetworkCards(String vmUrn) Retrieves a list of items for network cards from virtual hardware section of a Vm.
RasdItemsList	getVirtualHardwareSectionNetworkCards(URI vmHref)
RasdItemsList	getVirtualHardwareSectionSerialPorts(String vmUrn) Retrieves a list of items for serial ports from virtual hardware section of a Vm.
RasdItemsList	getVirtualHardwareSectionSerialPorts(URI vmHref)
Task	insertMedia(String vmUrn, MediaInsertOrEjectParams mediaParams) Insert media into a Vm.
Task	insertMedia(URI vmHref, MediaInsertOrEjectParams mediaParams)
Task	installVMwareTools(String vmUrn) Installs VMware tools to the virtual machine.
Task	installVMwareTools(URI vmHref)
Task	powerOff(String vmUrn) Powers off a Vm.
Task	powerOff(URI vmHref)
Task	powerOn(String vmUrn) Powers on a Vm.
Task	powerOn(URI vmHref)
Task	reboot(String vmUrn) Reboots a Vm.
Task	reboot(URI vmHref)
Task	relocate(String vmUrn, RelocateParams params) Relocates a Vm.
Task	relocate(URI vmHref, RelocateParams params)
Task	remove(String vmUrn) Deletes a Vm.
Task	remove(URI vmHref)
Task	reset(String vmUrn) Resets a Vm.
Task	reset(URI vmHref)
Task	shutdown(String vmUrn) Shuts down a Vm.
Task	shutdown(URI vmHref)
Task	suspend(String vmUrn) Suspends a Vm.
Task	suspend(URI vmHref)
Task	undeploy(String vmUrn, UndeployVAppParams params) Undeploy a Vm.
Task	undeploy(URI vmHref, UndeployVAppParams params)
Task	upgradeHardwareVersion(String vmUrn) Upgrade virtual hardware version of a VM to the highest supported virtual hardware version of provider vDC where the VM locates.
Task	upgradeHardwareVersion(URI vmHref)

Method Detail

get

Vm get(String vmUrn)

Retrieves a Vm.

Since:

0.9

See Also:

VAppApi.get(String)

get

Vm get(URI vmHref)

edit

Task edit(String vmUrn,
        Vm vm)

Modifies the name/description of a Vm.

Since:

0.9

See Also:

VAppApi.edit(String, VApp)

edit

Task edit(URI vmHref,
        Vm vm)

remove

Task remove(String vmUrn)

Deletes a Vm.

Since:

0.9

See Also:

VAppApi.remove(String)

remove

Task remove(URI vmHref)

consolidate

Task consolidate(String vmUrn)

Consolidates a Vm.

 POST /vApp/{id}/action/consolidate
 

Since:

1.5

consolidate

Task consolidate(URI vmHref)

deploy

Task deploy(String vmUrn,
          DeployVAppParams params)

Deploys a Vm.

Since:

0.9

See Also:

VAppApi.deploy(String, DeployVAppParams)

deploy

Task deploy(URI vmHref,
          DeployVAppParams params)

discardSuspendedState

Task discardSuspendedState(String vmUrn)

Discard suspended state of a Vm.

Since:

0.9

See Also:

VAppApi.discardSuspendedState(String)

discardSuspendedState

Task discardSuspendedState(URI vmHref)

installVMwareTools

Task installVMwareTools(String vmUrn)

Installs VMware tools to the virtual machine. It should be running in order for them to be installed.

 POST /vApp/{id}/action/installVMwareTools
 

Since:

1.5

installVMwareTools

Task installVMwareTools(URI vmHref)

relocate

Task relocate(String vmUrn,
            RelocateParams params)

Relocates a Vm.

 POST /vApp/{id}/action/relocate
 

Since:

1.5

relocate

Task relocate(URI vmHref,
            RelocateParams params)

undeploy

Task undeploy(String vmUrn,
            UndeployVAppParams params)

Undeploy a Vm.

Since:

0.9

See Also:

VAppApi.undeploy(String, UndeployVAppParams)

undeploy

Task undeploy(URI vmHref,
            UndeployVAppParams params)

upgradeHardwareVersion

Task upgradeHardwareVersion(String vmUrn)

Upgrade virtual hardware version of a VM to the highest supported virtual hardware version of provider vDC where the VM locates.

 POST /vApp/{id}/action/upgradeHardwareVersion
 

Since:

1.5

upgradeHardwareVersion

Task upgradeHardwareVersion(URI vmHref)

powerOff

Task powerOff(String vmUrn)

Powers off a Vm.

Since:

0.9

See Also:

VAppApi.powerOff(String)

powerOff

Task powerOff(URI vmHref)

powerOn

Task powerOn(String vmUrn)

Powers on a Vm.

Since:

0.9

See Also:

VAppApi.powerOn(String)

powerOn

Task powerOn(URI vmHref)

reboot

Task reboot(String vmUrn)

Reboots a Vm.

Since:

0.9

See Also:

VAppApi.reboot(String)

reboot

Task reboot(URI vmHref)

reset

Task reset(String vmUrn)

Resets a Vm.

Since:

0.9

See Also:

VAppApi.reset(String)

reset

Task reset(URI vmHref)

shutdown

Task shutdown(String vmUrn)

Shuts down a Vm.

Since:

0.9

See Also:

VAppApi.shutdown(String)

shutdown

Task shutdown(URI vmHref)

suspend

Task suspend(String vmUrn)

Suspends a Vm.

Since:

0.9

See Also:

VAppApi.suspend(String)

suspend

Task suspend(URI vmHref)

getGuestCustomizationSection

GuestCustomizationSection getGuestCustomizationSection(String vmUrn)

Retrieves the guest customization section of a Vm.

 GET /vApp/{id}/guestCustomizationSection
 

Since:

1.0

getGuestCustomizationSection

GuestCustomizationSection getGuestCustomizationSection(URI vmHref)

editGuestCustomizationSection

Task editGuestCustomizationSection(String vmUrn,
                                 GuestCustomizationSection section)

Modifies the guest customization section of a Vm.

 PUT /vApp/{id}/guestCustomizationSection
 

Since:

1.0

editGuestCustomizationSection

Task editGuestCustomizationSection(URI vmHref,
                                 GuestCustomizationSection section)

ejectMedia

Task ejectMedia(String vmUrn,
              MediaInsertOrEjectParams mediaParams)

Ejects media from a Vm.

 PUT /vApp/{id}/media/action/ejectMedia
 

Since:

0.9

ejectMedia

Task ejectMedia(URI vmHref,
              MediaInsertOrEjectParams mediaParams)

insertMedia

Task insertMedia(String vmUrn,
               MediaInsertOrEjectParams mediaParams)

Insert media into a Vm.

 PUT /vApp/{id}/media/action/insertMedia
 

Since:

0.9

insertMedia

Task insertMedia(URI vmHref,
               MediaInsertOrEjectParams mediaParams)

getNetworkConnectionSection

NetworkConnectionSection getNetworkConnectionSection(String vmUrn)

Retrieves the network connection section of a Vm.

 GET /vApp/{id}/networkConnectionSection
 

Since:

0.9

getNetworkConnectionSection

NetworkConnectionSection getNetworkConnectionSection(URI vmHref)

editNetworkConnectionSection

Task editNetworkConnectionSection(String vmUrn,
                                NetworkConnectionSection section)

Modifies the network connection section of a Vm.

 PUT /vApp/{id}/networkConnectionSection
 

Since:

0.9

editNetworkConnectionSection

Task editNetworkConnectionSection(URI vmHref,
                                NetworkConnectionSection section)

getOperatingSystemSection

OperatingSystemSection getOperatingSystemSection(String vmUrn)

Retrieves the operating system section of a Vm.

 GET /vApp/{id}/operatingSystemSection
 

Since:

0.9

getOperatingSystemSection

OperatingSystemSection getOperatingSystemSection(URI vmHref)

editOperatingSystemSection

Task editOperatingSystemSection(String vmUrn,
                              OperatingSystemSection section)

Modifies the operating system section of a Vm.

 PUT /vApp/{id}/operatingSystemSection
 

Since:

0.9

editOperatingSystemSection

Task editOperatingSystemSection(URI vmHref,
                              OperatingSystemSection section)

getProductSections

ProductSectionList getProductSections(String vmUrn)

Retrieves Vm product sections.

Since:

1.5

See Also:

VAppApi.getProductSections(String)

getProductSections

ProductSectionList getProductSections(URI vmHref)

editProductSections

Task editProductSections(String vmUrn,
                       ProductSectionList sectionList)

Modifies the product section information of a Vm.

Since:

1.5

See Also:

VAppApi.editProductSections(String, ProductSectionList)

editProductSections

Task editProductSections(URI vmHref,
                       ProductSectionList sectionList)

getPendingQuestion

VmPendingQuestion getPendingQuestion(String vmUrn)

Retrieves a pending question for a Vm. The user should answer to the question by operation answerQuestion(String, VmQuestionAnswer). Usually questions will be asked when the VM is powering on.

 GET /vApp/{id}/question
 

Since:

0.9

getPendingQuestion

VmPendingQuestion getPendingQuestion(URI vmHref)

answerQuestion

void answerQuestion(String vmUrn,
                  VmQuestionAnswer answer)

Answer a pending question on a Vm. The answer IDs of choice and question should match the ones returned from operation getPendingQuestion(String).

 POST /vApp/{id}/question/action/answer
 

Since:

0.9

answerQuestion

void answerQuestion(URI vmHref,
                  VmQuestionAnswer answer)

getRuntimeInfoSection

RuntimeInfoSection getRuntimeInfoSection(String vmUrn)

Retrieves the runtime info section of a Vm.

 GET /vApp/{id}/runtimeInfoSection
 

Since:

1.5

getRuntimeInfoSection

RuntimeInfoSection getRuntimeInfoSection(URI vmHref)

getScreenImage

byte[] getScreenImage(String vmUrn)

Retrieves the thumbnail of the screen of a Vm. The content type of the response may vary (e.g. image/png, image/gif).

 GET /vApp/{id}/screen
 

Since:

0.9

getScreenImage

byte[] getScreenImage(URI vmHref)

getScreenTicket

ScreenTicket getScreenTicket(String vmUrn)

Retrieve a screen ticket for remote console connection to a Vm. A screen ticket is a string that includes the virtual machine's IP address, its managed object reference, and a string that has been encoded as described in RFC 2396. Each VM element in a vApp includes a link where rel="screen:acquireTicket". You can use that link to request a screen ticket that you can use with the vmware-vmrc utility to open a VMware Remote Console for the virtual machine represented by that VM element. The vApp should be running to get a valid screen ticket.

 GET /vApp/{id}/screen/action/acquireTicket
 

Since:

0.9

getScreenTicket

ScreenTicket getScreenTicket(URI vmHref)

getVirtualHardwareSection

VirtualHardwareSection getVirtualHardwareSection(String vmUrn)

Retrieves the virtual hardware section of a Vm.

 GET /vApp/{id}/virtualHardwareSection
 

Since:

0.9

getVirtualHardwareSection

VirtualHardwareSection getVirtualHardwareSection(URI vmHref)

editVirtualHardwareSection

Task editVirtualHardwareSection(String vmUrn,
                              VirtualHardwareSection section)

Modifies the virtual hardware section of a Vm.

 PUT /vApp/{id}/virtualHardwareSection
 

Since:

0.9

editVirtualHardwareSection

Task editVirtualHardwareSection(URI vmHref,
                              VirtualHardwareSection section)

getVirtualHardwareSectionCpu

RasdItem getVirtualHardwareSectionCpu(String vmUrn)

Retrieves the CPU properties in virtual hardware section of a Vm.

 GET /vApp/{id}/virtualHardwareSection/cpu
 

Since:

0.9

getVirtualHardwareSectionCpu

RasdItem getVirtualHardwareSectionCpu(URI vmHref)

editVirtualHardwareSectionCpu

Task editVirtualHardwareSectionCpu(String vmUrn,
                                 RasdItem rasd)

Modifies the CPU properties in virtual hardware section of a Vm.

 PUT /vApp/{id}/virtualHardwareSection/cpu
 

Since:

0.9

editVirtualHardwareSectionCpu

Task editVirtualHardwareSectionCpu(URI vmHref,
                                 RasdItem rasd)

getVirtualHardwareSectionDisks

RasdItemsList getVirtualHardwareSectionDisks(String vmUrn)

Retrieves a list of items for disks from virtual hardware section of a Vm.

 GET /vApp/{id}/virtualHardwareSection/disks
 

Since:

0.9

getVirtualHardwareSectionDisks

RasdItemsList getVirtualHardwareSectionDisks(URI vmHref)

editVirtualHardwareSectionDisks

Task editVirtualHardwareSectionDisks(String vmUrn,
                                   RasdItemsList rasdItemsList)

Modifies the disks list in virtual hardware section of a Vm.

 PUT /vApp/{id}/virtualHardwareSection/disks
 

Since:

0.9

editVirtualHardwareSectionDisks

Task editVirtualHardwareSectionDisks(URI vmHref,
                                   RasdItemsList rasdItemsList)

getVirtualHardwareSectionMedia

RasdItemsList getVirtualHardwareSectionMedia(String vmUrn)

Retrieves the list of items that represents the floppies and CD/DVD drives in a Vm.

 GET /vApp/{id}/virtualHardwareSection/media
 

Since:

0.9

getVirtualHardwareSectionMedia

RasdItemsList getVirtualHardwareSectionMedia(URI vmHref)

getVirtualHardwareSectionMemory

RasdItem getVirtualHardwareSectionMemory(String vmUrn)

Retrieves the item that contains memory information from virtual hardware section of a Vm.

 GET /vApp/{id}/virtualHardwareSection/memory
 

Since:

0.9

getVirtualHardwareSectionMemory

RasdItem getVirtualHardwareSectionMemory(URI vmHref)

editVirtualHardwareSectionMemory

Task editVirtualHardwareSectionMemory(String vmUrn,
                                    RasdItem rasd)

Modifies the memory properties in virtual hardware section of a Vm.

 PUT /vApp/{id}/virtualHardwareSection/memory
 

Since:

0.9

editVirtualHardwareSectionMemory

Task editVirtualHardwareSectionMemory(URI vmHref,
                                    RasdItem rasd)

getVirtualHardwareSectionNetworkCards

RasdItemsList getVirtualHardwareSectionNetworkCards(String vmUrn)

Retrieves a list of items for network cards from virtual hardware section of a Vm.

 GET /vApp/{id}/virtualHardwareSection/networkCards
 

Since:

0.9

getVirtualHardwareSectionNetworkCards

RasdItemsList getVirtualHardwareSectionNetworkCards(URI vmHref)

editVirtualHardwareSectionNetworkCards

Task editVirtualHardwareSectionNetworkCards(String vmUrn,
                                          RasdItemsList rasdItemsList)

Modifies the network cards list in virtual hardware section of a Vm.

 PUT /vApp/{id}/virtualHardwareSection/networkCards
 

Since:

0.9

editVirtualHardwareSectionNetworkCards

Task editVirtualHardwareSectionNetworkCards(URI vmHref,
                                          RasdItemsList rasdItemsList)

getVirtualHardwareSectionSerialPorts

RasdItemsList getVirtualHardwareSectionSerialPorts(String vmUrn)

Retrieves a list of items for serial ports from virtual hardware section of a Vm.

 GET /vApp/{id}/virtualHardwareSection/serialPorts
 

Since:

1.5

getVirtualHardwareSectionSerialPorts

RasdItemsList getVirtualHardwareSectionSerialPorts(URI vmHref)

editVirtualHardwareSectionSerialPorts

Task editVirtualHardwareSectionSerialPorts(String vmUrn,
                                         RasdItemsList rasdItemsList)

Modifies the serial ports list in virtual hardware section of a Vm.

 PUT /vApp/{id}/virtualHardwareSection/serialPorts
 

Since:

1.5

editVirtualHardwareSectionSerialPorts

Task editVirtualHardwareSectionSerialPorts(URI vmHref,
                                         RasdItemsList rasdItemsList)

getMetadataApi

MetadataApi.Writeable getMetadataApi(String vmUrn)

Synchronous access to Vm Metadata features.

getMetadataApi

MetadataApi.Writeable getMetadataApi(URI vmHref)