5.1
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 Template as OVF
- Upload a Media Image
- Copying and Moving with the vCloud API
- Capturing and Importing vApps
- Cataloging vApp Templates and Media Images
- Creating and Using Independent Disks
- View or Change the Owner of an Object
- Deploying and Operating vApps
- Summary of vCloud API vApp and Virtual Machine Operations Requests
- Create a vApp From a Template
- Compose a vApp From Existing Virtual Machines
- Recompose a vApp to Add or Remove Virtual Machines
- 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
- Controlling Access to vApps and Catalogs
- Managing and Monitoring a Cloud
- Summary of vSphere Platform Extension 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
H
host
to enable or disable 193
to update or repair 193
I
id attribute, and entity resolver 312
independent disk
about 75
list virtual machines using 56
to attach or detach 83, 93
to create 76
to create or update 56
to remove 78
instantiation parameters
in instantiateVAppTemplate request 85
sections allowed in 97
IP address, of virtual machine NIC 115
IP addresses, allocated to network 41
K
keytab, to upload 233
L
LDAP, certificate and keystore 233
Link element, rel attribute 12
load balancer service 163
logging, of firewall actions 158
login
integrated identity provider 44
SAML identity provider 46
login URL, to obtain 41, 43
logout 40
M
maintenance mode, vApp 97
media
cataloging 72
copying or moving 71
retrieve owner 79
to copy, move, or delete 56
to insert or remove virtual 83
to upload 55
to upload or download 56
uploading 69
metadata
about 239
to retrieve or modify 241
to search for 260
metadata value, to retrieve or modify 244
N
NAT service
in Edge Gateway 160
in vApp network 112
network
list IP addresses allocated to 41
to create, update, or remove 129
to reset 129
to retrieve 41
network pool
and organization vDC network 148
isolation-backed 225
list of 204
portgroup-backed 227
to create 222
to retrieve or update 193
VLAN-backed 223
VxlanPoolType 209, 222, 225
network services
in Edge Gateway 156
in vApp network 112
list of 148
networks
about 148
DHCP service 166
NAT services 160
to retrieve list from vCenter 203
VPN 165
notifications
format of 267
to enable or disable 264
O
object hierarchy, diagram of 10
object identifiers 12
object references, about 12
organization
retrieve or update settings 136
system 132
to administer 132
to create 133
to create, update, or remove 129
to enable or disable 129, 139
to remove 139
to retrieve administrative view of 129
organization vDC network
about 148
direct 167
isolated 173
routed 170
to administer 147
to configure static routes 161
to create 166
to create, update, or remove 129
vCloud API Programming Guide
316 VMware, Inc.