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
92 VMware, Inc.
AddaNetworktoanOrganization POSTAPI‐URL/admin/org/id/networks OrgNetwork OrgNetwork
GetanAdministrativeViewofan
OrganizationNetwork
GETAPI‐URL/admin/network/id None OrgNetwork
ModifyanOrganizationNetwork PUTAPI‐URL/admin/network/id OrgNetwork Task
RemoveanOrganizationNetwork DELETEAPI‐URL/admin/network/id None Task
EnableorDisableanOrganization POSTAPI‐URL/admin/org/id/
action/enable
POSTAPI‐URL/admin/org/id/
action/disable
None 204NoContent
RemoveanOrganization DELETEAPI‐URL/admin/org/id None None
ExaminetheContentsofaProvider
vDC
GETAPI‐URL/admin/providervdc/id None ProviderVdc
AllocateavDCtoanOrganization POSTAPI‐URL/admin/org/id/vdcs AdminVdc AdminVdc
ListtheOrganizationvDCs
SupportedbyaProvidervDC
GETAPI‐URL/admin/providervdc/id/
vdcReferences
None VdcReferences
GetanAdministrativeViewofavDC
GETAPI‐URL/admin/vdc/id None AdminVdc
ModifyavDC PUTAPI‐URL/admin/vdc/id AdminVdc AdminVdc
EnableorDisableavDC POSTAPI‐URL/admin/vdc/id/
action/enable
POSTAPI‐URL/admin/vdc/id/
action/disable
None 204NoContent
RemoveavDC DELETEAPI‐URL/admin/vdc/id None Task
CreateaCatalog POSTAPI‐URL/admin/org/id/catalogs Catalog Catalog
GetanAdministrativeViewofa
Catalog
GETAPI‐URL/admin/catalog/id
None Catalog
PublishaCatalog POSTAPI‐URL/admin/catalog/id/
action/publish
PublishCatalogParams 204NoContent
ModifyCatalogMetadata PUTAPI‐URL/admin/catalog/id Catalog Catalog
RemoveaCatalog DELETEAPI‐URL/admin/catalog/id None 204NoContent
CreateorImportaUser POSTAPI‐URL/admin/org/id/users User User
GetanAdministrativeViewofaUser GETAPI‐URL/admin/user/id None User
ModifyUserMetadata PUTAPI‐
URL/admin/user/id User User
RemoveaUser DELETEAPI‐URL/admin/user/id None 204NoContent
ImportaGroup POSTAPI‐URL/admin/org/id/groups Group Group
ViewGroupMetadata GETAPI‐URL/admin/group‐id None Group
ModifyGroupMetadata PUTAPI‐URL/admin/group/id Group Group
RemoveaGroup DELETEAPI‐URL/admin/group/id None 204NoContent
CreateaRole POSTAPI‐URL/admin/roles Role Role
ViewRoleMetadata GETAPI
‐URL/admin/role/id None Role
ModifyaRole PUTAPI‐URL/admin/role/id Role Role
RemoveaRole DELETEAPI‐URL/admin/role/id None 204NoContent
ViewaRight GETAPI‐URL/admin/right/id None Right
Table 6-1. Summary of Administrative Requests (Continued)
Operation Request Request Body Response