1.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
- Provisioning an Organization with vApps, Templates, and Media
- 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
- Operate a vApp
- Configuring vApps and Virtual Machines
- Retrieve the Configuration Links for a vApp
- Retrieve the Configuration Links for 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
- Creating, Provisioning, and Managing Organizations
- Summary of Administrative Requests
- Administrator Credentials and Privileges
- Organization Administration
- Network Administration
- vDC Administration
- Catalog Administration
- User and Group Administration
- Working With Roles and Rights
- Controlling Access to vApps and Catalogs
- Using vCloud API Extensions to Provision and Manage a Cloud
- Working With Object Metadata
- Using the Query Service
- Configuring and Using Blocking Tasks and Notifications
- XML Representations in the vCloud API
- Index
n
Retrieve the XML representation of the organization. See “Retrieve a List of Organizations Accessible to
You,” on page 46.
Procedure
n
To enable an organization, POST a request to its action/enable link.
n
To disable an organization, POST a request to its action/disable link.
n
To remove an organization:
a POST a request to the action/disable link to disable the organization.
After the organization is disabled, its representation includes a rel="remove" link.
b Delete or change ownership of all objects that the organization's users own.
c Make a DELETE request to the organization's rel="remove" link.
The server takes the requested action and returns an HTTP status of 204 No Content.
Example: Enable an Organization
This example enables the organization created in “Example: Create an Organization,” on page 113
Request:
POST https://vcloud.example.com/api/admin/org/26/action/enable
Response:
204 No Content
Network Administration
A newly created organization has no networks in it. An organization administrator must create organization
networks from resources such as external networks and network pools that a system administrator provisions.
An organization can be provisioned with one or more networks. These organization networks can be
configured to provide services such as DHCP, NAT, VPN, and firewalls.
About vCloud Director Networks
Simple vCloud API networks can rely on default values for many configuration parameters. vCloud API
networks that have advanced features require a more detailed specification.
There are three categories of vCloud networks: external networks, organization networks, and vApp networks.
There are also network pools which, while not networks themselves, provide network resources to certain
types of organization and vApp networks. You can configure organization and vApp networks to allow direct
or routed connections to other networks. You can also configure them to be isolated, with no connectivity to
other networks.
vApp Networks
A vApp network is a logical network that controls how the virtual machines in a vApp connect to each other
and to organization networks. Users specify vApp network details in an instantiateVAppTemplate or
composeVApp request. The network is created when the vApp is deployed, and deleted when the vApp is
undeployed. All nonisolated virtual machines in the vApp connect to a vApp network, as specified in their
NetworkConnectionSection elements.
vCloud API Programming Guide
118 VMware, Inc.