VMware VCLOUD API 1.0 - API User Manual

vCloud API Programming Guide
4 VMware, Inc.
4 Provisioning 41
SummaryofProvisioningRequests 41
UploadOVFtoCreateavAppTemplate 42
RestrictionsonUploadedContent 43
InitiatetheUpload 43
IncludingaManifest 45
UploadingtheFiles 45
ViewtheOVFDescriptorofavAppTemplate 47
DownloadavAppTemplateasOVF 47
EnableavAppTemplateforDownload 48
DisableavAppTemplateforDownload 49
UploadaMediaImage 50
Copyingand
Moving 50
CopyorMoveaMediaImage 51
CopyorMoveavAppTemplate 51
CopyorMoveavApp 52
ChangingaNameorDescription 53
ChangetheNameorDescriptionofavAppTemplate 53
ChangetheNameorDescriptionofavApp 53
ChangetheNameorDescriptionofaMediaImage 54
DeleteavAppTemplate,vApp,orMediaImage 54
CatalogingvAppTemplatesandMediaImages 54
AddanItemtoaCatalog 54
RemoveanItemfromaCatalog 56
CatalogLinksinaVAppTemplateorMediaImage 56
ControllingAccess 56
ControlAccesstoCatalogs 56
5 DatacenterOperations 59
SummaryofDatacenterOperationsRequests 59
vAppLifecycle 60
InstantiateavAppTemplate 61
AboutInstantiationParameters 62
AboutvAppNetworks 62
InstantiatingavAppTemplateUsingDefaultParameters 62
InstantiatingavAppTemplateUsingAdditionalParameters 62
RetrieveorModifytheCustomizationSectionofavAppTemplate 64
ComposeavApp 65
FindingVirtualMachineURLstoUseinaCompositionItem 66
RecomposeavAppto
AddorRemoveVirtualMachines 67
CaptureavApptoCreateavAppTemplate 68
ReconfiguringvAppsandVirtualMachines 69
ReconfigureavApp 69
ReconfigureaVirtualMachine 73
DeployingandControllingvAppsandVirtualMachines 80
DeployavApporVirtualMachine 80
UndeployavApporVirtualMachine 81
PowerOnavApporVirtualMachine 81
PowerOffavApp
orVirtualMachine 82
ResetavApporVirtualMachine 82
SuspendavApporVirtualMachine 83
DiscardtheSuspendedStateofavApporVirtualMachine 83
ShutDownavApporVirtualMachine 8 4
RebootavApporVirtualMachine 84
ListMediaDevicesofaVirtualMachine 85

VMware VCLOUD API 1.0 - API Specifications

General

Brand	VMware
Model	VCLOUD API 1.0 - API
Category	Software
Language	English

Summary

Introducing the VMware vCloud API

Links and Link Relations

vCloud Client Workflow Overview

Describes the RESTful workflow for clients interacting with the vCloud API.

Hello vCloud: A Structured REST Workflow Example

Instantiating the Template in the vDC

Deploying and Powering On the vApp

Provisioning

Upload OVF to Create a vApp Template

Describes the workflow for uploading OVF packages to create vApp templates.

Copy or Move a vApp Template

Datacenter Operations

Instantiate a vApp Template

Creates a vApp from a template by allocating vDC-specific resources and bindings.

Reconfigure a vApp

Modifies vApp configurations, including lease settings, startup order, and network settings.

Deploy a vApp or Virtual Machine

Initiates the deployment of a vApp or individual virtual machine.

Administrative Operations

Role Administration

VMware vSphere Platform Operations

List Provider vDCs in a vCloud

Create a Provider vDC

Describes the process of creating a provider vDC using vSphere resources.

Create an External Network

Details how to add external networks to a vCloud, linking them to vSphere portgroups.

Administrative API Reference

Organization Administration

Provides administrative views and management of organization settings, quotas, and policies.

User Administration

vSphere Platform Extensions Reference

VimServer

VMWProviderVdc

Represents provider vDC objects, specifying resources like compute, storage, and networks from vSphere.

Appendix B An Introduction to REST for vCloud API Users

How REST Works

Using the vCloud REST API