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
OrgLdapSettings
Defines whether this organization is connected to an LDAP service, and
whether it uses the service defined in the system LdapSettings or a custom
LDAP service defined here.
OrgEmailSettings
Defines whether this organization uses the email service defined in the system
EmailSettings or a custom email service defined here.
OrgPasswordPolicySettin
gs
Specifies policies to be followed when a user in this organization enters an
incorrect password. Initial values are inherited from the system
PasswordPolicySettings.
OrgOperationLimitsSetti
ngs
Specifies limits to be placed on simultaneous resource-intensive operations and
console sessions for members of this organization.
OrgGuestPersonalization
Settings
Default values for GuestCustomizationSection elements in virtual machines
created by this organization. See “Retrieve or Modify the
GuestCustomizationSection of a Virtual Machine,” on page 118
OrgFederationSettings
Defines the SAML identity provider used by this organization. An organization
can define a SAML identity provider that it shares with other applications or
enterprises. Users that authenticate to the identity provider obtain a token that
they can then use to log in to the organization. Such a strategy can enable an
enterprise to provide access to multiple, unrelated services, including
vCloud Director with a single set of credentials, an arrangement often referred
to as "single sign-on." An organization that wants to participate in a federated
identity scheme must include an OrgFederationSettings element that contains
SAML metadata retrieved from the federation's identity provider. By default,
this element is empty.
NOTE To update or remove OrgFederationSettings after a SAML identity
provider has been specified, you must include an empty SAMLMetadata element
in the update request. If this element is not present in the update request, the
OrgFederationSettings are not changed.
Prerequisites
Verify that you are logged in to the vCloud API as an organization administrator or system administrator.
Procedure
1 Retrieve the list of organization settings elements.
Use a request like this one:
GET https://vcloud.example.com/api/admin/org/26/settings
The response is an OrgSettings element.
2 Examine the OrgSettings element to find the links to the sections to view or modify.
Each section is represented in the OrgSettings element with a link where rel="down". You can use that
link to retrieve the section. The retrieved section includes a link where rel="edit". You can use that link
as the target of a PUT request that modifies the settings that the element represents. The OrgSettings
element itself also has a rel="edit" link, which you can use to update multiple settings sections in one
request.
3 Retrieve the settings element to modify.
Make a GET request to the URL in the element's href attribute value.
Chapter 6 Creating and Managing Organizations
VMware, Inc. 137