5.5
Table Of Contents
- vCloud API Programming Guide
- Contents
- vCloud API Programming Guide
- About the VMware vCloud API
- Hello vCloud: A Simplified RESTful Workflow
- Exploring a Cloud
- Summary of vCloud API Browsing Requests
- Retrieve the Login URL and List of Supported API Versions
- Create a Login Session Using the Integrated Identity Provider
- Retrieve a List of Organizations Accessible to You
- Retrieve an Administrative View of a Cloud
- Retrieve a List of vSphere Platform Operations and Objects for a Cloud
- Provisioning an Organization
- Summary of vCloud API Provisioning Requests
- Upload an OVF Package to Create a vApp Template
- Download a vApp or vApp Template as OVF
- Upload a Media Image
- Download a Media Image
- Capturing and Importing vApps
- Managing Catalog Items
- Creating and Using Independent Disks
- View or Change the Owner of an Object
- Controlling Access to vApps and Catalogs
- Deploying and Operating vApps
- Summary of vCloud API vApp and Virtual Machine Operations Requests
- Create a vApp From a Template
- Create a vApp From an OVF Package
- Compose a vApp From Existing Virtual Machines
- Recompose a vApp to Add or Remove Virtual Machines
- Clone a vApp
- Capture a vApp as a Template
- Update vApp Access Controls
- Provide User Input Requested by a Virtual Machine
- Attach or Detach an Independent Disk
- Creating and Using vApp Snapshots
- Operate a vApp
- Configuring vApps and Virtual Machines
- Retrieve the Configuration Links for a vApp
- Retrieve the Configuration Links for a Virtual Machine
- Update Multiple Sections of a Virtual Machine
- Retrieve or Update a Modifiable Section
- Update a vApp Network Configuration
- Update the NetworkConnectionSection of a Virtual Machine
- Retrieve or Modify the CPU Configuration of a Virtual Machine
- Retrieve or Modify the GuestCustomizationSection of a Virtual Machine
- Retrieve or Modify ProductSection Elements
- Retrieve or Modify Groups of Related Sections in a Virtual Machine
- Retrieve or Modify the Hard Disk Configuration of a Virtual Machine
- Update the Storage Profile for a Virtual Machine
- Creating and Managing Organizations
- Summary of Administrative Requests
- Administrator Credentials and Privileges
- Organization Administration
- VDC Administration
- Network Administration
- Catalog Administration
- User and Group Administration
- Working With Roles and Rights
- Managing and Monitoring a Cloud
- Summary of System Administration Requests
- Retrieve or Update System Settings
- Attach a vCenter Server
- Finding Available vCenter Resources
- Create a Provider VDC
- Create an External Network
- Create a Network Pool
- Import a Virtual Machine from vCenter
- Relocate a Virtual Machine to a Different Datastore
- Truststore and Keytab Maintenance
- Retrieve the vSphere URL of an Object
- Working With Object Metadata
- Using the Query Service
- Configuring and Using Blocking Tasks and Notifications
- vCloud Director Extension Services
- XML Representations in the vCloud API
- Index
to retrieve list from vCenter 249
to refresh list of 249
system settings, to retrieve or update 239
T
task
blocking 325
service-specific 340
to cancel 149
to retrieve 149
update progress 327
task list, to retrieve 149
task operations 320
timezone, in dateTime values 357
truststore, to upload 275
U
user
list of rights granted 149
to import from SAML 225
to retrieve 149
to update or remove 149
to create 149, 220
to import 222
users, to administer 219
V
vApp
access control for 110, 207
add virtual machines 103
capturing 75, 108
changing owner 83
cloning 106
composing 101
configuration links in 118
controlling access to 84
datacenter operations 89
importing 75, 271
importing from vCenter 270
list of power operations 91
maintenance mode 116
recompose 103
remove virtual machines 103
to change owner 149
to download 56
to import from vCenter as template 235
to import from vSphere 235
to undeploy 38
to capture or clone 91
to change name or description 91
to compose or recompose 91
to configure 116
to create from OVF 91
to delete 38
to deploy or undeploy 91
to download as OVF package 68
to enable for download 69
to enter or exit maintenance mode 235
to instantiate 93
to modify vApp network configuration 128
to operate 115
to power off 38
to retrieve 34
to view or modify lease settings 119
to view or modify network settings 119
to view or modify startup settings 119
Vm snapshots 91
vApp network
about 169
to modify 128
to retrieve 169
to view or modify configuration 119
vApp snapshot 114
vApp template
captured from vApp 108
hardware customization 95
retrieve owner 83
to change name or description 56
to copy, move, or delete 56
to create from OVF 56
to download 56
to download as OVF package 68
to enable for download 69
to enable or disable for download 56
to import virtual machine as 272
to instantiate 31, 91
to relocate virtual machine from 91
to retrieve 41
to update 116
to upload or download 55
upload URL 64
uploading vmdk files 66
vCenter server
to attach 240
to register or unregister 235
to update settings 235
vCenter resources, to discover 242
vCloud API
and RESTful programming style 9
revision history 7
VDC
allocation models 161
instantiateVAppTemplate action 30
networks in 30
SupportedHardwareVersion elements 161
vCloud API Programming Guide
368 VMware, Inc.