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
Example: The System Organization
Every VCloud object contains a link, like the one shown here, to the System organization.
<VCloud ... >
...
<Link
rel="down"
type="application/vnd.vmware.admin.systemOrganization+xml"
name="System"
href="https://vcloud.example.com/api/admin/org/123"/>
...
</VCloud>
Unlike Org and AdminOrg objects, the System organization cannot contain catalogs, vDCs, groups, or users who
are not system administrators.
Organization Administration
System administrators work with AdminOrg elements to create and modify organizations. Organization
administrators can modify most properties of these organizations.
A cloud can contain one or more organizations. Each organization is a unit of administration for a collection
of users, groups, and computing resources. Users authenticate at the organization level, supplying credentials
established when the user was created or imported.
An AdminOrg is an extended representation of an Org object, and is accessed at
API-URL
/admin/org/
id
, rather
than
API-URL
/org/
id
. Although system administrators work with AdminOrg elements to create and modify
organizations, most modifications to an AdminOrg also modify some property of the corresponding Org that is
visible to users.
Create an Organization
To create an organization, a system administrator POSTs an AdminOrg element to the cloud’s add URL for
orgs.
When you create an organization, you can specify its properties in detail. You must specify a subset of those
properties during creation. Properties that you do not specify in the creation request are initialized with default
values that you can modify later.
Prerequisites
Verify that you are logged in as a system administrator.
Procedure
1 Retrieve the XML representation of the cloud.
Use a request like this one.
GET https://vcloud.example.com/api/admin
2 Examine the response to locate the Link element that contains the URL for adding organizations to the
cloud.
This element has a rel attribute value of add and a type attribute value of
application/vnd.vmware.admin.organization+xml, as shown here:
<Link href="https://vcloud.example.com/api/admin/orgs"
rel="add"
type="application/vnd.vmware.admin.organization+xml"/>
vCloud API Programming Guide
112 VMware, Inc.