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
Organization vDCs
An organization virtual datacenter (organization vDC) is a deployment
environment for virtual systems owned by the containing organization, and an
allocation mechanism for resources such as networks, storage, CPU, and
memory. In an organization vDC, computing resources are fully virtualized,
and can be allocated based on demand, service level requirements, or a
combination of the two.
Organization vDC
Networks
An organization vDC can be provisioned with one or more networks. These
organization vDC networks can be configured to provide direct or routed
connections to external networks, or can be isolated from external networks
and other organization vDC networks. Routed connections require an Edge
Gateway and network pool in the vDC. The Edge Gateway provides firewall,
network address translation, static routing, VPN, and load balancing services.
Virtual Systems and
Media Images
Virtual systems and media images are stored in a vDC and can be included in
a catalog. Media images are stored in their native representation (ISO or
floppy). Virtual systems are initially stored as templates, using an open
standard format (OVF 1.0). These templates can be retrieved from catalogs and
transformed into virtual systems, called vApps, through a process called
instantiation, which binds a template’s abstract resource requirements to
resources available in a vDC. A vApp contains one or more individual virtual
machines (Vm elements), along with parameters that define operational details,
including:
n
How the contained virtual machines are connected to each other and to
external networks.
n
The order in which individual virtual machines are powered on or off.
n
End-user license agreement terms for each virtual machine.
n
Deployment lease terms, typically inherited from the containing
organization, that constrain the consumption of vDC resources by the
vApp.
n
Access control information specifying which users and groups can
perform operations such as deploy, power on, modify, and suspend on the
vApp and the virtual machines that it contains.
Tasks
Asynchronous operations that members of an organization initiate are tracked
by task objects, which are kept on the organization’s tasks list.
Chapter 1 About the VMware vCloud API
VMware, Inc. 11