org.jclouds.vcloud.features
Interface VAppTemplateClient


public interface VAppTemplateClient

Provides access to VApp Template functionality in vCloud

Author:
Adrian Cole
See Also:

Method Summary
 VAppTemplate captureVAppAsTemplateInVDC(URI sourceVAppHref, String newTemplateName, URI targetVdcHref, CaptureVAppOptions... options)
          The captureVApp request creates a vApp template from an instantiated vApp.
 Task copyVAppTemplateToVDCAndName(URI sourceVAppTemplate, URI vDC, String newName, CloneVAppTemplateOptions... options)
           
 VApp createVAppInVDCByInstantiatingTemplate(String appName, URI vDC, URI template, InstantiateVAppTemplateOptions... options)
           
 Task deleteVAppTemplate(URI id)
          delete a vAppTemplate, vApp, or media image.
 VAppTemplate findVAppTemplateInOrgCatalogNamed(String orgName, String catalogName, String itemName)
          returns the vapp template corresponding to a catalog item in the catalog associated with the specified name.
 Envelope getOvfEnvelopeForVAppTemplate(URI vAppTemplate)
           
 VAppTemplate getVAppTemplate(URI vApp)
           
 Task moveVAppTemplateToVDCAndRename(URI sourceVAppTemplate, URI vDC, String newName, CloneVAppTemplateOptions... options)
           
 

Method Detail

findVAppTemplateInOrgCatalogNamed

VAppTemplate findVAppTemplateInOrgCatalogNamed(@Nullable
                                               String orgName,
                                               @Nullable
                                               String catalogName,
                                               String itemName)
returns the vapp template corresponding to a catalog item in the catalog associated with the specified name. Note that the org and catalog parameters can be null to choose default.

Parameters:
orgName - organization name, or null for the default
catalogName - catalog name, or null for the default
itemName - item you wish to lookup
Throws:
NoSuchElementException - if you specified an org, catalog, or catalog item name that isn't present

createVAppInVDCByInstantiatingTemplate

VApp createVAppInVDCByInstantiatingTemplate(String appName,
                                            URI vDC,
                                            URI template,
                                            InstantiateVAppTemplateOptions... options)

copyVAppTemplateToVDCAndName

Task copyVAppTemplateToVDCAndName(URI sourceVAppTemplate,
                                  URI vDC,
                                  String newName,
                                  CloneVAppTemplateOptions... options)

moveVAppTemplateToVDCAndRename

Task moveVAppTemplateToVDCAndRename(URI sourceVAppTemplate,
                                    URI vDC,
                                    String newName,
                                    CloneVAppTemplateOptions... options)

captureVAppAsTemplateInVDC

VAppTemplate captureVAppAsTemplateInVDC(URI sourceVAppHref,
                                        String newTemplateName,
                                        URI targetVdcHref,
                                        CaptureVAppOptions... options)
The captureVApp request creates a vApp template from an instantiated vApp.

Note

Before it can be captured, a vApp must be undeployed

Parameters:
targetVdcHref -
sourceVAppHref -
newTemplateName -
options -
Returns:
template in progress

getVAppTemplate

VAppTemplate getVAppTemplate(URI vApp)

getOvfEnvelopeForVAppTemplate

Envelope getOvfEnvelopeForVAppTemplate(URI vAppTemplate)

deleteVAppTemplate

Task deleteVAppTemplate(URI id)
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.

Parameters:
id - href of the vApp
Returns:
task of the operation in progress


Copyright © 2009-2012 jclouds. All Rights Reserved.