VAppApi (jclouds 1.5.5 API)

```
public interface VAppApi
```
Provides synchronous access to VApp objects.

Version:

1.5

Author:

grkvlt@apache.org, Adrian Cole

See Also:
VAppAsyncApi

Method Summary

Methods
Modifier and Type	Method and Description
`Task`	`deploy(String vAppUrn, DeployVAppParams params)` Deploys a `VApp`.
`Task`	`deploy(URI vAppHref, DeployVAppParams params)`
`Task`	`discardSuspendedState(String vAppUrn)` Discard suspended state of a `VApp`.
`Task`	`discardSuspendedState(URI vAppHref)`
`Task`	`edit(String vAppUrn, VApp vApp)` Modifies the name/description of a `VApp`.
`Task`	`edit(URI vAppHref, VApp vApp)`
`ControlAccessParams`	`editControlAccess(String vAppUrn, ControlAccessParams params)` Modifies the control access of a `VApp`.
`ControlAccessParams`	`editControlAccess(URI vAppHref, ControlAccessParams params)`
`Task`	`editLeaseSettingsSection(String vAppUrn, LeaseSettingsSection section)` Modifies the lease settings section of a `VApp`.
`Task`	`editLeaseSettingsSection(URI vAppHref, LeaseSettingsSection section)`
`Task`	`editNetworkConfigSection(String vAppUrn, NetworkConfigSection section)` Modifies the network config section of a `VApp`.
`Task`	`editNetworkConfigSection(URI vAppHref, NetworkConfigSection section)`
`void`	`editOwner(String vAppUrn, Owner owner)` Changes `VApp` owner.
`void`	`editOwner(URI vAppHref, Owner owner)`
`Task`	`editProductSections(String vAppUrn, ProductSectionList sectionList)` Modifies the product section information of a `VApp`.
`Task`	`editProductSections(URI vAppHref, ProductSectionList sectionList)`
`Task`	`editStartupSection(String vAppUrn, StartupSection section)` Modifies the startup section of a `VApp`.
`Task`	`editStartupSection(URI vAppHref, StartupSection section)`
`void`	`enterMaintenanceMode(String vAppUrn)` Place the `VApp` into maintenance mode.
`void`	`enterMaintenanceMode(URI vAppHref)`
`void`	`exitMaintenanceMode(String vAppUrn)` Take the `VApp` out of maintenance mode.
`void`	`exitMaintenanceMode(URI vAppHref)`
`VApp`	`get(String vAppUrn)` Retrieves a `VApp`.
`VApp`	`get(URI vAppHref)`
`ControlAccessParams`	`getAccessControl(String vAppUrn)` Retrieves the control access information for a `VApp`.
`ControlAccessParams`	`getAccessControl(URI vAppHref)`
`LeaseSettingsSection`	`getLeaseSettingsSection(String vAppUrn)` Retrieves the lease settings section of a `VApp`.
`LeaseSettingsSection`	`getLeaseSettingsSection(URI vAppHref)`
`MetadataApi.Writeable`	`getMetadataApi(String vAppUrn)` Synchronous access to `VApp` `Metadata` features.
`MetadataApi.Writeable`	`getMetadataApi(URI vAppHref)`
`NetworkConfigSection`	`getNetworkConfigSection(String vAppUrn)` Retrieves the network config section of a `VApp`.
`NetworkConfigSection`	`getNetworkConfigSection(URI vAppHref)`
`NetworkSection`	`getNetworkSection(String vAppUrn)` Retrieves the network section of a `VApp`.
`NetworkSection`	`getNetworkSection(URI vAppHref)`
`Owner`	`getOwner(String vAppUrn)` Retrieves the owner of a `VApp`.
`Owner`	`getOwner(URI vAppHref)`
`ProductSectionList`	`getProductSections(String vAppUrn)` Retrieves `VApp` product sections.
`ProductSectionList`	`getProductSections(URI vAppHref)`
`StartupSection`	`getStartupSection(String vAppUrn)` Retrieves the startup section of a `VApp`.
`StartupSection`	`getStartupSection(URI vAppHref)`
`Task`	`powerOff(String vAppUrn)` Powers off a `VApp`.
`Task`	`powerOff(URI vAppHref)`
`Task`	`powerOn(String vAppUrn)` Powers on a `VApp`.
`Task`	`powerOn(URI vAppHref)`
`Task`	`reboot(String vAppUrn)` Reboots a `VApp`.
`Task`	`reboot(URI vAppHref)`
`Task`	`recompose(String vAppUrn, RecomposeVAppParams params)` Recompose a `VApp` by removing its own VMs and/or adding new ones from other vApps or vApp templates.
`Task`	`recompose(URI vAppHref, RecomposeVAppParams params)`
`Task`	`remove(String vAppUrn)` Deletes a `VApp`.
`Task`	`remove(URI vAppHref)`
`Task`	`reset(String vAppUrn)` Resets a `VApp`.
`Task`	`reset(URI vAppHref)`
`Task`	`shutdown(String vAppUrn)` Shuts down a `VApp`.
`Task`	`shutdown(URI vAppHref)`
`Task`	`suspend(String vAppUrn)` Suspends a `VApp`.
`Task`	`suspend(URI vAppHref)`
`Task`	`undeploy(String vAppUrn, UndeployVAppParams params)` Undeploy a `VApp`.
`Task`	`undeploy(URI vAppHref, UndeployVAppParams params)`

- Method Detail
  - get
```
VApp get(String vAppUrn)
```
    Retrieves a VApp. The VApp could be in one of these statuses:
    - FAILED_CREATION(-1) - Transient entity state, e.g., model object is addd but the corresponding VC backing does not exist yet. This is further sub-categorized in the respective entities.
    - UNRESOLVED(0) - Entity is whole, e.g., VM creation is complete and all the required model objects and VC backings are created.
    - RESOLVED(1) - Entity is resolved.
    - DEPLOYED(2) - Entity is deployed.
    - SUSPENDED(3) - All VMs of the vApp are suspended.
    - POWERED_ON(4) - All VMs of the vApp are powered on.
    - WAITING_FOR_INPUT(5) - VM is pending response on a question.
    - UNKNOWN(6) - Entity state could not be retrieved from the inventory, e.g., VM power state is null.
    - UNRECOGNIZED(7) - Entity state was retrieved from the inventory but could not be mapped to an internal state.
    - POWERED_OFF(8) - All VMs of the vApp are powered off.
    - INCONSISTENT_STATE(9) - Apply to VM status, if a vm is POWERED_ON, or WAITING_FOR_INPUT, but is undeployed, it is in an inconsistent state.
    - MIXED(10) - vApp status is set to MIXED when the VMs in the vApp are in different power states
```
 GET /vApp/{id}
 
```
    Since:
    
    0.9
  - get
```
VApp get(URI vAppHref)
```
  - edit
```
Task edit(String vAppUrn,
        VApp vApp)
```
    Modifies the name/description of a VApp.
```
 PUT /vApp/{id}
 
```
    Since:
    
    0.9
  - edit
```
Task edit(URI vAppHref,
        VApp vApp)
```
  - remove
```
Task remove(String vAppUrn)
```
    Deletes a VApp.
```
 DELETE /vApp/{id}
 
```
    Since:
    
    0.9
  - remove
```
Task remove(URI vAppHref)
```
  - editControlAccess
```
ControlAccessParams editControlAccess(String vAppUrn,
                                    ControlAccessParams params)
```
    Modifies the control access of a VApp.
```
 POST /vApp/{id}/action/controlAccess
 
```
    Since:
    
    0.9
  - editControlAccess
```
ControlAccessParams editControlAccess(URI vAppHref,
                                    ControlAccessParams params)
```
  - deploy
```
Task deploy(String vAppUrn,
          DeployVAppParams params)
```
    Deploys a VApp. Deployment means allocation of all resource for a vApp/VM like CPU and memory from a vDC resource pool. Deploying a vApp automatically deploys all of the virtual machines it contains. As of version 1.5 the operation supports force customization passed with DeployVAppParamsType#setForceCustomization(Boolean) parameter.
```
 POST /vApp/{id}/action/deploy
 
```
    Since:
    
    0.9
  - deploy
```
Task deploy(URI vAppHref,
          DeployVAppParams params)
```
  - discardSuspendedState
```
Task discardSuspendedState(String vAppUrn)
```
    Discard suspended state of a VApp. Discarding suspended state of a vApp automatically discarded suspended states of all of the virtual machines it contains.
```
 POST /vApp/{id}/action/discardSuspendedState
 
```
    Since:
    
    0.9
  - discardSuspendedState
```
Task discardSuspendedState(URI vAppHref)
```
  - enterMaintenanceMode
```
void enterMaintenanceMode(String vAppUrn)
```
    Place the VApp into maintenance mode. While in maintenance mode, a system admin can operate on the vApp as usual, but end users are restricted to read-only operations. Any user-initiated tasks running when the vApp enters maintenance mode will continue.
```
 POST /vApp/{id}/action/enterMaintenanceMode
 
```
    Since:
    
    1.5
  - enterMaintenanceMode
```
void enterMaintenanceMode(URI vAppHref)
```
  - exitMaintenanceMode
```
void exitMaintenanceMode(String vAppUrn)
```
    Take the VApp out of maintenance mode.
```
 POST /vApp/{id}/action/exitMaintenanceMode
 
```
    Since:
    
    1.5
  - exitMaintenanceMode
```
void exitMaintenanceMode(URI vAppHref)
```
  - recompose
```
Task recompose(String vAppUrn,
             RecomposeVAppParams params)
```
    Recompose a VApp by removing its own VMs and/or adding new ones from other vApps or vApp templates. To remove VMs you should put their references in elements. The way you add VMs is the same as described in compose vApp operation VdcApi#composeVApp(String, org.jclouds.vcloud.director.v1_5.domain.ComposeVAppParams). The status of vApp will be in org.jclouds.vcloud.director.v1_5.domain.ResourceEntityType.Status#UNRESOLVED until the recompose task is finished.
```
 POST /vApp/{id}/action/recomposeVApp
 
```
    Since:
    
    1.0
  - recompose
```
Task recompose(URI vAppHref,
             RecomposeVAppParams params)
```
  - undeploy
```
Task undeploy(String vAppUrn,
            UndeployVAppParams params)
```
    Undeploy a VApp. Undeployment means deallocation of all resources for a vApp/VM like CPU and memory from a vDC resource pool. Undeploying a vApp automatically undeploys all of the virtual machines it contains.
```
 POST /vApp/{id}/action/undeploy
 
```
    Since:
    
    0.9
  - undeploy
```
Task undeploy(URI vAppHref,
            UndeployVAppParams params)
```
  - getAccessControl
```
ControlAccessParams getAccessControl(String vAppUrn)
```
    Retrieves the control access information for a VApp. The vApp could be shared to everyone or could be shared to specific user, by editing the control access values.
```
 GET /vApp/{id}/controlAccess
 
```
    Since:
    
    0.9
  - getAccessControl
```
ControlAccessParams getAccessControl(URI vAppHref)
```
  - powerOff
```
Task powerOff(String vAppUrn)
```
    Powers off a VApp. If the operation is used over a vApp then all VMs are powered off. This operation is allowed only when the vApp/VM is powered on.
```
 POST /vApp/{id}/power/action/powerOff
 
```
    Since:
    
    0.9
  - powerOff
```
Task powerOff(URI vAppHref)
```
  - powerOn
```
Task powerOn(String vAppUrn)
```
    Powers on a VApp. If the operation is used over a vApp then all VMs are powered on. This operation is allowed only when the vApp/VM is powered off.
```
 POST /vApp/{id}/power/action/powerOn
 
```
    Since:
    
    0.9
  - powerOn
```
Task powerOn(URI vAppHref)
```
  - reboot
```
Task reboot(String vAppUrn)
```
    Reboots a VApp. The vApp/VM should be started in order to reboot it.
```
 POST /vApp/{id}/power/action/reboot
 
```
    Since:
    
    0.9
  - reboot
```
Task reboot(URI vAppHref)
```
  - reset
```
Task reset(String vAppUrn)
```
    Resets a VApp. If the operation is used over a vApp then all VMs are reset. This operation is allowed only when the vApp/VM is powered on.
```
 POST /vApp/{id}/power/action/reset
 
```
    Since:
    
    0.9
  - reset
```
Task reset(URI vAppHref)
```
  - shutdown
```
Task shutdown(String vAppUrn)
```
    Shuts down a VApp. If the operation is used over a vApp then all VMs are shutdown. This operation is allowed only when the vApp/VM is powered on.
```
 POST /vApp/{id}/power/action/shutdown
 
```
    Since:
    
    0.9
  - shutdown
```
Task shutdown(URI vAppHref)
```
  - suspend
```
Task suspend(String vAppUrn)
```
    Suspends a VApp. If the operation is used over a vApp then all VMs are suspended. This operation is allowed only when the vApp/VM is powered on.
```
 POST /vApp/{id}/power/action/suspend
 
```
    Since:
    
    0.9
  - suspend
```
Task suspend(URI vAppHref)
```
  - getLeaseSettingsSection
```
LeaseSettingsSection getLeaseSettingsSection(String vAppUrn)
```
    Retrieves the lease settings section of a VApp.
```
 GET /vApp/{id}/leaseSettingsSection
 
```
    Since:
    
    0.9
  - getLeaseSettingsSection
```
LeaseSettingsSection getLeaseSettingsSection(URI vAppHref)
```
  - editLeaseSettingsSection
```
Task editLeaseSettingsSection(String vAppUrn,
                            LeaseSettingsSection section)
```
    Modifies the lease settings section of a VApp.
```
 PUT /vApp/{id}/leaseSettingsSection
 
```
    Since:
    
    0.9
  - editLeaseSettingsSection
```
Task editLeaseSettingsSection(URI vAppHref,
                            LeaseSettingsSection section)
```
  - getNetworkConfigSection
```
NetworkConfigSection getNetworkConfigSection(String vAppUrn)
```
    Retrieves the network config section of a VApp.
```
 GET /vApp/{id}/networkConfigSection
 
```
    Since:
    
    0.9
  - getNetworkConfigSection
```
NetworkConfigSection getNetworkConfigSection(URI vAppHref)
```
  - editNetworkConfigSection
```
Task editNetworkConfigSection(String vAppUrn,
                            NetworkConfigSection section)
```
    Modifies the network config section of a VApp.
```
 PUT /vApp/{id}/networkConfigSection
 
```
    Since:
    
    0.9
  - editNetworkConfigSection
```
Task editNetworkConfigSection(URI vAppHref,
                            NetworkConfigSection section)
```
  - getNetworkSection
```
NetworkSection getNetworkSection(String vAppUrn)
```
    Retrieves the network section of a VApp.
```
 GET /vApp/{id}/networkSection
 
```
    Since:
    
    0.9
  - getNetworkSection
```
NetworkSection getNetworkSection(URI vAppHref)
```
  - getOwner
```
Owner getOwner(String vAppUrn)
```
    Retrieves the owner of a VApp.
```
 GET /vApp/{id}/owner
 
```
    Since:
    
    1.5
  - getOwner
```
Owner getOwner(URI vAppHref)
```
  - editOwner
```
void editOwner(String vAppUrn,
             Owner owner)
```
    Changes VApp owner.
```
 PUT /vApp/{id}/owner
 
```
    Since:
    
    1.5
  - editOwner
```
void editOwner(URI vAppHref,
             Owner owner)
```
  - getProductSections
```
ProductSectionList getProductSections(String vAppUrn)
```
    Retrieves VApp product sections.
```
 GET /vApp/{id}/productSections
 
```
    Since:
    
    1.5
  - getProductSections
```
ProductSectionList getProductSections(URI vAppHref)
```
  - editProductSections
```
Task editProductSections(String vAppUrn,
                       ProductSectionList sectionList)
```
    Modifies the product section information of a VApp.
```
 PUT /vApp/{id}/productSections
 
```
    Since:
    
    1.5
  - editProductSections
```
Task editProductSections(URI vAppHref,
                       ProductSectionList sectionList)
```
  - getStartupSection
```
StartupSection getStartupSection(String vAppUrn)
```
    Retrieves the startup section of a VApp.
```
 GET /vApp/{id}/startupSection
 
```
    Since:
    
    0.9
  - getStartupSection
```
StartupSection getStartupSection(URI vAppHref)
```
  - editStartupSection
```
Task editStartupSection(String vAppUrn,
                      StartupSection section)
```
    Modifies the startup section of a VApp.
```
 PUT /vApp/{id}/startupSection
 
```
    Since:
    
    0.9
  - editStartupSection
```
Task editStartupSection(URI vAppHref,
                      StartupSection section)
```
  - getMetadataApi
```
MetadataApi.Writeable getMetadataApi(String vAppUrn)
```
    Synchronous access to VApp Metadata features.
  - getMetadataApi
```
MetadataApi.Writeable getMetadataApi(URI vAppHref)
```

Interface VAppApi

Method Summary

Method Detail

get

get

edit

edit

remove

remove

editControlAccess

editControlAccess

deploy

deploy

discardSuspendedState

discardSuspendedState

enterMaintenanceMode

enterMaintenanceMode

exitMaintenanceMode

exitMaintenanceMode

recompose

recompose

undeploy

undeploy

getAccessControl

getAccessControl

powerOff

powerOff

powerOn

powerOn

reboot

reboot

reset

reset

shutdown

shutdown

suspend

suspend

getLeaseSettingsSection

getLeaseSettingsSection

editLeaseSettingsSection

editLeaseSettingsSection

getNetworkConfigSection

getNetworkConfigSection

editNetworkConfigSection

editNetworkConfigSection

getNetworkSection

getNetworkSection

getOwner

getOwner

editOwner

editOwner

getProductSections

getProductSections

editProductSections

editProductSections

getStartupSection

getStartupSection

editStartupSection

editStartupSection

getMetadataApi

getMetadataApi