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
Example: Synchronize Syslog Server Settings for an Edge Gateway
This request synchronizes the syslog server settings for the Edge Gateway created in “Create an Edge
Gateway,” on page 151.
POST https://vcloud.example.com/api/admin/edgeGateway/2000/action/syncSyslogServerSettings
Response:
202 Accepted
Content-Type: application/vnd.vmware.vcloud.task+xml
...
<Task ... >
...
</Task>
Catalog Administration
A newly created organization has no catalogs in it. After an organization administrator or catalog author creates
a catalog, members of the organization can add items to it or remove items from it if they have the necessary
rights.
Catalogs can contain references to vApp templates and media images. A system administrator or a privileged
member of the organization that owns the catalog can create and remove these references. A catalog can be
shared to make it visible to other members of an organization, and can be published to make it visible to
administrators in other organizations. A system administrator specifies which organizations can publish
catalogs, and an organization administrator controls access to catalogs by organization members.
Access to Catalogs
By default, a catalog is accessible only to its creator. An organization administrator or catalog author can grant
catalog access to other members of the organization, individually or collectively. See “Controlling Access to
vApps and Catalogs,” on page 191. An organization administrator or catalog author can also publish a catalog
to make it available to administrators in other organizations. An organization administrator or system
administrator can change the owner of a catalog. See “View or Change the Owner of an Object,” on page 79.
Add a Catalog to an Organization
Every organization has an add URL for catalogs. An organization administrator or catalog author can create
a catalog by POSTing an AdminCatalog element to this URL
A newly-created Catalog object is an empty container for references to vApp templates and media images.
Prerequisites
Verify that you are logged in as a system administrator, an organization administrator, or a user with the
Catalog Author role.
Procedure
1 Retrieve the XML representation of the organization to which you want to add the catalog.
Use a request like this one:
GET https://vcloud.example.com/api/admin/org/26
vCloud API Programming Guide
176 VMware, Inc.