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
Add a Network to an Organization
To add a network to an organization, a system administrator POSTs an OrgNetwork element to the organization's
add URL for networks.
A newly created organization has no networks in it. A system administrator must create an organization
network from resources that an external network or network pool provide. The contents of the
Configuration element of the OrgNetwork define the properties of the network, including its connections to
other networks. See “Create an Organization Network With a Direct Connection,” on page 125, “Create an
Organization Network With a Routed Connection,” on page 128, and “Create an Isolated Organization
Network,” on page 136.
For more information about the types of networks you can create and the resources on which they depend,
see “About vCloud Director Networks,” on page 118.
Prerequisites
Verify that you are logged in as a system administrator.
Procedure
1 Retrieve the XML representation of the organization to which you want to add the network.
This request retrieves an administrative view of an organization.
GET https://vcloud.example.com/api/admin/org/26
2 Examine the response to locate the Link element that contains the URL for adding networks to the
organization.
This element has a rel attribute value of add and a type attribute value of
application/vnd.vmware.admin.network+xml, as shown here:
<Link
href="https://vcloud.example.com/api/admin/org/26/networks"
rel="add"
type="application/vnd.vmware.admin.network+xml"/>
3 Create an OrgNetwork element.
4 POST the OrgNetwork element to the URL described in Step 2.
The server creates the new organization network, and returns an OrgNetwork element that includes the contents
you POSTed, along with a set of Link elements that you can use to access, remove, or modify it. Users can
reference this network using the URL specified in the href attribute of the Link where rel="alternate". The
new network is added to the list of Networks shown in the AdminOrg element that represents the organization.
Create an Organization Network With a Direct Connection
An organization network with a direct connection is accessible by multiple organizations. Virtual machines
belonging to different organizations can connect to and see traffic on this network.
An organization network with a direct connection is configured as a child network of one of the external
networks provisioned to the cloud by the system administrator.
Prerequisites
n
Verify that you are logged in as a system administrator.
n
Retrieve the list of external networks. For information about how to retrieve this list, see “External
Networks and Network Pools,” on page 121.
Chapter 6 Creating, Provisioning, and Managing Organizations
VMware, Inc. 125