1.0
Table Of Contents
- vCloud API Programming Guide
- Contents
- About This Book
- Introducing the VMware vCloud API
- Hello vCloud: A Structured REST Workflow Example
- Logging In and Getting an Organization List
- Browsing an Organization
- Finding a vApp Template
- Getting Information About a vDC
- Instantiating the Template in the vDC
- Deploying and Powering On the vApp
- Getting Information About the vApp
- Displaying the Console
- Deleting the vApp
- Logging Out
- Moving on to Additional Use Cases
- Browsing
- Provisioning
- Summary of Provisioning Requests
- Upload OVF to Create a vApp Template
- View the OVF Descriptor of a vApp Template
- Download a vApp Template as OVF
- Upload a Media Image
- Copying and Moving
- Changing a Name or Description
- Delete a vAppTemplate, vApp, or Media Image
- Cataloging vApp Templates and Media Images
- Controlling Access
- Datacenter Operations
- Summary of Datacenter Operations Requests
- vApp Lifecycle
- Instantiate a vApp Template
- Compose a vApp
- Recompose a vApp to Add or Remove Virtual Machines
- Capture a vApp to Create a vApp Template
- Reconfiguring vApps and Virtual Machines
- Deploying and Controlling vApps and Virtual Machines
- Deploy a vApp or Virtual Machine
- Undeploy a vApp or Virtual Machine
- Power On a vApp or Virtual Machine
- Power Off a vApp or Virtual Machine
- Reset a vApp or Virtual Machine
- Suspend a vApp or Virtual Machine
- Discard the Suspended State of a vApp or Virtual Machine
- Shut Down a vApp or Virtual Machine
- Reboot a vApp or Virtual Machine
- List Media Devices of a Virtual Machine
- Insert Media Into a Virtual Machine
- Eject Media from a Virtual Machine
- Get a Screen Thumbnail for a Virtual Machine
- Get a Screen Ticket for a Virtual Machine
- Provide User Input Requested by a Virtual Machine
- Control Access to vApps
- Retrieve a Task
- Administrative Operations
- VMware vSphere Platform Operations
- Summary of vSphere Platform Operations Requests
- List vSphere Platform Operations and Objects for a vCloud
- List Provider vDCs in a vCloud
- List External Networks in a vCloud
- List Network Pools in a vCloud
- List vCenter Servers Registered to a vCloud
- List ESX/ESXi Hosts in a vCloud
- Create a Provider vDC
- Create an External Network
- Create a Network Pool
- Import a Virtual Machine from vCenter
- XML Representations in the vCloud API
- User API Reference
- Request Parameters Reference
- Administrative API Reference
- vSphere Platform Extensions Reference
- OVF and the vCloud API
- An Introduction to REST for vCloud API Users
- Index
vCloud API Programming Guide
200 VMware, Inc.
Request Parameters
ThevSpherePlatformextensionsdefinedseveralelementsthatprovideparameterstorequeststhatcreate,
delete,modify,orchangethestateofavSpherePlatformobject.
PrepareHostParams
ThePrepareHostParamselementformsthebodyofaprepareorunpreparerequestforanESXhost.
RegisterVimServerParams
TheRegisterVimServerParamselementformsthebodyofaregistervimserverrequest.
Ready 1 1 xs:boolean Trueifthehostisready
Available 1 1 xs:boolean Trueifthehostisavailable
Enabled 1 1 xs:boolean TrueifthehostisenabledforusewithCloud
Director
Busy 1 1 xs:boolean Trueifthehostisbusy
EnableHostForHostSpanning 1 1 xs:boolean Trueifthehostisenabledforhostspanning.If
true,thehostcannotbeputinstandbyor
maintenancemode.
CpuType 0 1 xs:string CPUtypeof
thehost
NumOfCpusLogical 1 1 xs:int NumberoflogicalCPUs
NumOfCpusPackages 1 1 xs:int NumberofCPUpackages
CpuTotal 1 1 xs:long TotalCPUcapabilityofthishost
MemUsed 1 1 xs:double Memoryreserved
MemTotal 1 1 xs:double Totalmemory
HostOsName 0 1 xs:string Hostoperatingsystemname
HostOsVersion 0 1 xs:string Hostoperatingsystemversion
SystemMessages 0 1 xs:string vCentermessagesforthishost
VimPropertyPageUrl 0 1 xs:string URLforhostpropertypageinvSphere
VmMoRef 0 1 xs:string vSpheremanagedobjectreferenceforthisobject
Schema (Continued)
Name Min Max Type Description
Schema
Name Min Max Type Description
Username 1 1 xs:string Usernameofahostadministrator
Password 1 1 xs:string PasswordforspecifiedUsername
Schema
Name Min Max Type Description
VimServer 1 1 VimServerType vCenterservertoregister
ShieldManager 1 1 ShieldManagerType vShieldManagerassociatedwiththevCenterservertoregister