org.jclouds.vcloud.features

Interface VAppClient

public interface VAppClient

Provides access to VApp functionality in vCloud

Author:

Adrian Cole

See Also:

Method Summary

Methods

Modifier and Type	Method and Description
Task	copyVAppToVDCAndName(URI sourceVApp, URI vDC, String newName, CloneVAppOptions... options)
Task	deleteVApp(URI href) delete a vAppTemplate, vApp, or media image.
Task	deployAndPowerOnVApp(URI href) like deployVApp(URI), except deploy transitions to power on state
Task	deployVApp(URI href) To deploy a vApp, the client makes a request to its action/deploy URL.
VApp	findVAppInOrgVDCNamed(String orgName, String catalogName, String vAppName)
VApp	getVApp(URI vApp)
Task	moveVAppToVDCAndRename(URI sourceVApp, URI vDC, String newName, CloneVAppOptions... options)
Task	powerOffVApp(URI href) A powerOff request to a vApp URL powers off all of the virtual machines in the vApp, as specified in its StartupSection field.
Task	powerOnVApp(URI href) A powerOn request to a vApp URL powers on all of the virtual machines in the vApp, as specified in the vApp’s StartupSection field.
void	rebootVApp(URI href) A reboot request to a vApp URL reboots all of the virtual machines in the vApp, as specified in its StartupSection field.
Task	resetVApp(URI href) A reset request to a vApp URL resets all of the virtual machines in the vApp, as specified in its StartupSection field.
void	shutdownVApp(URI href) A shutdown request to a vApp URL shuts down all of the virtual machines in the vApp, as specified in its StartupSection field.
Task	suspendVApp(URI href) A suspend request to a vApp URL suspends all of the virtual machines in the vApp, as specified in its StartupSection field.
Task	undeployAndSaveStateOfVApp(URI href) like undeployVApp(URI), where the undeployed virtual machines are suspended and their suspend state saved
Task	undeployVApp(URI href) Undeploying a vApp powers off or suspends any running virtual machines it contains, then frees the resources reserved for the vApp and sets the vApp’s deploy attribute to a value of false to indicate that it is not deployed.

Method Detail

findVAppInOrgVDCNamed

VApp findVAppInOrgVDCNamed(@Nullable
                         String orgName,
                         @Nullable
                         String catalogName,
                         String vAppName)

copyVAppToVDCAndName

Task copyVAppToVDCAndName(URI sourceVApp,
                        URI vDC,
                        String newName,
                        CloneVAppOptions... options)

moveVAppToVDCAndRename

Task moveVAppToVDCAndRename(URI sourceVApp,
                          URI vDC,
                          String newName,
                          CloneVAppOptions... options)

getVApp

VApp getVApp(URI vApp)

deployVApp

Task deployVApp(URI href)

To deploy a vApp, the client makes a request to its action/deploy URL. Deploying a vApp automatically deploys all of the virtual machines it contains. To deploy a virtual machine, the client makes a request to its action/deploy URL.

Deploying a Vm implicitly deploys the parent vApp if that vApp is not already deployed.

deployAndPowerOnVApp

Task deployAndPowerOnVApp(URI href)

like deployVApp(URI), except deploy transitions to power on state

undeployVApp

Task undeployVApp(URI href)

Undeploying a vApp powers off or suspends any running virtual machines it contains, then frees the resources reserved for the vApp and sets the vApp’s deploy attribute to a value of false to indicate that it is not deployed.

Undeploying a virtual machine powers off or suspends the virtual machine, then frees the resources reserved for it and sets the its deploy attribute to a value of false to indicate that it is not deployed. This operation has no effect on the containing vApp.

NOTE

Using this method will simply power off the vms. In order to save their state, use #undeployAndSaveStateOf

undeployAndSaveStateOfVApp

Task undeployAndSaveStateOfVApp(URI href)

like undeployVApp(URI), where the undeployed virtual machines are suspended and their suspend state saved

powerOnVApp

Task powerOnVApp(URI href)

A powerOn request to a vApp URL powers on all of the virtual machines in the vApp, as specified in the vApp’s StartupSection field.

A powerOn request to a virtual machine URL powers on the specified virtual machine and forces deployment of the parent vApp.

NOTE

A powerOn request to a vApp or virtual machine that is undeployed forces deployment.

powerOffVApp

Task powerOffVApp(URI href)

A powerOff request to a vApp URL powers off all of the virtual machines in the vApp, as specified in its StartupSection field.

A powerOff request to a virtual machine URL powers off the specified virtual machine.

shutdownVApp

void shutdownVApp(URI href)

A shutdown request to a vApp URL shuts down all of the virtual machines in the vApp, as specified in its StartupSection field.

A shutdown request to a virtual machine URL shuts down the specified virtual machine.

NOTE

resetVApp

Task resetVApp(URI href)

A reset request to a vApp URL resets all of the virtual machines in the vApp, as specified in its StartupSection field.

A reset request to a virtual machine URL resets the specified virtual machine.

rebootVApp

void rebootVApp(URI href)

A reboot request to a vApp URL reboots all of the virtual machines in the vApp, as specified in its StartupSection field.

A reboot request to a virtual machine URL reboots the specified virtual machine.

NOTE

Because this request sends a signal to the guest OS, the vCloud API cannot track the progress or verify the result of the requested operation. Hence, void is returned

suspendVApp

Task suspendVApp(URI href)

A suspend request to a vApp URL suspends all of the virtual machines in the vApp, as specified in its StartupSection field.

A suspend request to a virtual machine URL suspends the specified virtual machine.

deleteVApp

Task deleteVApp(URI href)

delete a vAppTemplate, vApp, or media image. You cannot delete an object if it is in use. Any object that is being copied or moved is in use. Other criteria that determine whether an object is in use depend on the object type.

• A vApptemplate is in use if it is being instantiated. After instantiation is complete, the template is no longer in use.
• A vApp is in use if it is deployed.
• A media image is in use if it is inserted in a Vm.

Parameters:

href - href of the vApp

Returns:

task of the operation in progress