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
<PrimaryNetworkConnectionIndex>0</PrimaryNetworkConnectionIndex>
<NetworkConnection
network="vAppNetwork">
<NetworkConnectionIndex>0</NetworkConnectionIndex>
<IpAddress>10.147.122.134</IpAddress>
<IsConnected>false</IsConnected>
<MACAddress>00:50:56:01:01:49</MACAddress>
<IpAddressAllocationMode>POOL</IpAddressAllocationMode>
</NetworkConnection>
</NetworkConnectionSection>
<GuestCustomizationSection>
<Link
rel="edit"
href="https://vcloud.example.com/api/vApp/vm-4/guestCustomizationSection+xml/">
</Link>
...
</GuestCustomizationSection>
...
</Vm>
Summary of Vm Reconfiguration Requests
Vm reconfiguration requests retrieve or update modifiable sections of a virtual machine (Vm object)
n
API-URL is a URL of the form https://vcloud.example.com/api.
n
id is a unique identifier in the form of a UUID, as defined by RFC 4122.
Request URLs are always available when you GET the representation of the object on which they operate. URL
forms are for reference purposes only. For more information about the requests and responses for each
operation, see “About the Schema Reference Downloadable Archive,” on page 19.
Table 5-3. Summary of Vm Reconfiguration Requests
Operation Request Request Body Response
Retrieve the
NetworkConnectionSectio
n of a virtual machine
GET API-URL/vApp/vm-id/
networkConnectionSectio
n/
None
NetworkConnectionSectio
n
Update the
NetworkConnectionSectio
n of a virtual machine
PUT API-URL/vApp/vm-id/
networkConnectionSectio
n/
NetworkConnectionSecti
on
Task
Retrieve the
GuestCustomizationSecti
on of a virtual machine
GET API-URL/vApp/vm-id/
guestCustomizationSectio
n/
None
GuestCustomizationSecti
o
Update the
GuestCustomizationSecti
on of a virtual machine
PUT API-URL/vApp/vm-id/
guestCustomizationSectio
n/
GuestCustomizationSect
io
Task
Retrieve the
OperatingSystemSection
of a virtual machine
GET API-URL/vApp/vm-id/
operatingSystemSection/
None
OperatingSystemSection
Update the
OperatingSystemSection
of a virtual machine
PUT API-URL/vApp/vm-id/
operatingSystemSection/
OperatingSystemSection Task
Retrieve the
VirtualHardwareSection
of a virtual machine
GET API-URL/vApp/vm-id/
virtualHardwareSection/
None
VirtualHardwareSection
vCloud API Programming Guide
92 VMware, Inc.