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
resource classes 343
REST APIs for 353
to register 330, 332
to retrieve list of 330
to unregister 330
URL patterns for 354
external network
to retrieve or update 235
to create 261
F
firewall service
and syslog 196
in Edge Gateway 179
in vApp network 131
G
group
to create, update, or remove 149
to import 223
to import from SAML 225
groups, to administer 219
H
host
to update or repair 235
to enable or disable 235
I
id attribute, and entity resolver 362
independent disk
about 80
list virtual machines using 56
to attach or detach 91, 112
to create 80
to create or update 56
to remove 82
instantiation parameters
in instantiateOvf request 97
in instantiateVAppTemplate request 93
sections allowed in 116
IP address, of virtual machine NIC 134
IP addresses, allocated to network 41
K
keytab, to upload 275
L
LDAP, certificate and keystore 275
Link element, rel attribute 12
load balancer service 184
logging, of firewall actions 179
login
integrated identity provider 44
SAML identity provider 46
login URL, to obtain 41, 43
logout 40
M
maintenance mode, vApp 116
media
downloading 74
retrieve owner 83
supported formats 72
to copy, move, or delete 56
to insert or remove virtual 91
to upload 55
to upload or download 56
uploading 72
metadata
about 281
to retrieve or modify 283
to search for 303
metadata value, to retrieve or modify 286
N
NAT service
in Edge Gateway 181
in vApp network 131
network
list IP addresses allocated to 41
to create, update, or remove 149
to reset 149
to retrieve 41
network pool
and organization VDC network 169
isolation-backed 267
list of 246
portgroup-backed 269
to create 264
to retrieve or update 235
VLAN-backed 265
VxlanPoolType 251, 264, 267
network services
in Edge Gateway 177
in vApp network 131
list of 169
networks
about 169
DHCP service 187
NAT services 181
to retrieve list from vCenter 245
VPN 186
notifications
format of 312
to enable or disable 308
O
object hierarchy, diagram of 10
vCloud API Programming Guide
366 VMware, Inc.