5.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
- 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 or vApp Template as OVF
- Upload a Media Image
- Download a Media Image
- Capturing and Importing vApps
- Managing Catalog Items
- Creating and Using Independent Disks
- View or Change the Owner of an Object
- Controlling Access to vApps and Catalogs
- Deploying and Operating vApps
- Summary of vCloud API vApp and Virtual Machine Operations Requests
- Create a vApp From a Template
- Create a vApp From an OVF Package
- Compose a vApp From Existing Virtual Machines
- Recompose a vApp to Add or Remove Virtual Machines
- Clone a vApp
- Capture a vApp as a Template
- Update vApp Access Controls
- 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
- Managing and Monitoring a Cloud
- Summary of System Administration 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
Table 5‑3. Summary of Vm Reconfiguration Requests (Continued)
Operation Request Request Body Response
Retrieve network card items
from the
VirtualHardwareSection
of a virtual machine
GET API-URL/vApp/vm-
id/
virtualHardwareSection/
networkCards
None
RasdItemsList
Update network card items
in the
VirtualHardwareSection
of a virtual machine
PUT API-URL/vApp/vm-
id/
virtualHardwareSection/
networkCards
RasdItemsList Task
Update the name,
Description, and any or all
of
VirtualHardwareSection,
OperatingSystemSection,
NetworkConnectionSectio
n,
GuestCustomizationSecti
on of a virtual machine.
POST API-URL/vApp/vm-
id/ action/reconfigureVm
Vm Task
vCloud API Custom Attributes
vCloud API custom attributes extend several elements in the ovf and rasd XML namespaces. You can use
these attributes to provide additional detail about virtual NIC and hard disk controller devices, or to specify
the guest operating system type.
With the exception of osType, custom attributes are scoped to ovf:Item elements based on the elements'
RASD resource type. The osType attribute applies to the ovf:OperatingSystemSection element. All of the
elements to which these custom attributes apply are contained in the VirtualHardwareSection of a Vm.
Table 5‑4. vCloud API Custom Attributes for OVF and RASD Elements
Element Name
RASD
Resource
Type Attribute Name Attribute Type Description
rasd:Connection 10
(Network
adapters)
ipAddressingMode xs:string IP addressing mode to use for this
connection. One of NONE, MANUAL,
DHCP, POOL.
rasd:Connection 10
(Network
adapters)
ipAddress xs:string
If ipAddressingMode="MANUAL",
set the IP address here
rasd:Connection 10
(Network
adapters)
primaryNetworkCon
nection
xs:boolean True if this is the primary network
connection of the virtual machine
rasd:HostResource 17 (Hard
disks)
capacity xs:string Hard disk capacity in megabytes.
See “Retrieve or Modify the Hard
Disk Configuration of a Virtual
Machine,” on page 143
rasd:HostResource 17 (Hard
disks)
busType xs:string Bus type. One of:
n
5 (IDE)
n
6 (SCSI)
n
20 (SATA)
vCloud API Programming Guide
124 VMware, Inc.