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
Enable, Disable, or Remove an Organization
An AdminOrg element includes action links that a system administrator can use to enable, disable, or remove
the organization.
Prerequisites
n
Verify that you are logged in to the vCloud API as a system administrator.
n
Retrieve the XML representation of the organization. See “Retrieve a List of Organizations Accessible to
You,” on page 48.
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 133.
Request:
POST https://vcloud.example.com/api/admin/org/26/action/enable
Response:
204 No Content
vDC Administration
A newly created organization has no vDCs in it. A system administrator must use system resources to create
them.
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.
vDC administration involves the following objects:
n
A ProviderVdc, which a system administrator creates from vSphere platform resources. See “Create a
Provider vDC,” on page 209.
n
An AdminVdc, which a system administrator creates to allocate a subset of ProviderVdc resources to a vDC
in a specific organization. Organization members see an AdminVdc as a Vdc.
Chapter 6 Creating and Managing Organizations
VMware, Inc. 139