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
118 VMware, Inc.
ListNetworkPoolsina
vCloud
GETAPI‐URL/admin/extension/
networkPoolReferences
None VMWNetworkPoolReferences
ListvCenterServers
RegisteredtoavCloud
GETAPI‐URL/admin/extension/
vimServerReferences
None VMWVimServerReferences
GetInformationAbout
avCenterServer
GETAPI‐URL/admin/extension/
vimServer/id
None VimServer
ListAvailableResource
PoolsonavCenter
Server
GETAPI‐URL/admin/extension/
vimServer/id/resourcePoolList
None ResourcePoolList
ModifyvCenterServer
Settings
PUTAPI‐URL
/admin/extension/
vimServer/id/
VimServer Task
RegisteravCenter
ServerandvShield
Manager
POSTAPI‐URL/admin/extension/
action/registervimserver
RegisterVimServerParams RegisterVimServerParams
UnregisteravCenter
ServerandvShield
Manager
POSTAPI‐URL/admin/extension/
vimServer/id/action/unregister
None Task
ForceReconnectiontoa
vCenterServer
POSTAPI‐URL/admin/extension/
vimServer/id/
forcevimserverreconnect
None 204NoContent
ListESX/ESXiHostsin
avCloud
GETAPI‐URL/admin/extension/
hostReferences
None VMWHostReferences
GetInformationAbout
aHost
GETAPI‐URL/admin/extension/
host/id
None Host
PrepareaHost POSTAPI‐URL/admin/extension/
host/id/action/prepare
PrepareHostParams Task
Unpreparea Host POSTAPI‐URL/admin/extension/
host/id/action/unprepare
None Task
EnableorDisablea
Host
POSTAPI‐URL/admin/extension/
host/id/action/enable
POSTAPI‐URL/admin/extension/
host/id/action/disable
None 204NoContent
RepairaHost POSTAPI‐URL/admin/extension/
host/id/action/repair
None 204NoContent
UpgradeaHost
Agent POSTAPI‐URL/admin/extension/
host/id/action/upgrade
None Task
CreateaProvidervDC POSTAPI‐URL/admin/extension/
providervdcs
VMWProviderVdc VMWProviderVdc
ExaminethevSphere
ObjectsinaProvider
vDC
GETAPI‐URL/admin/extension/
providervdc/id
None VMWProviderVdc
ModifyaProvidervDC PUTAPI‐URL/admin/extension/
providervdcs
VMWProviderVdc VMWProviderVdc
EnableorDisablea
ProvidervDC
POSTAPI‐URL/admin/extension/
providervdc/id/action/enable
POSTAPI‐URL/admin/extension/
providervdc/id/action/disable
None 204No
Content
RemoveaProvider
vDC
DELETE
API‐URL/admin/extension/
providervdc/id
None Task
CreateanExternal
Network
POSTAPI‐URL/admin/extension/
externalnets
VMWExternalNetwork VMWExternalNetwork
Table 7-1. Summary of vSphere Platform Operations Requests (Continued)
Operation Request Request Body Response