1.0
Table Of Contents
- vCloud API Programming Guide
- Contents
- About This Book
- Introducing the VMware vCloud API
- Hello vCloud: A Structured REST Workflow Example
- Logging In and Getting an Organization List
- Browsing an Organization
- Finding a vApp Template
- Getting Information About a vDC
- Instantiating the Template in the vDC
- Deploying and Powering On the vApp
- Getting Information About the vApp
- Displaying the Console
- Deleting the vApp
- Logging Out
- Moving on to Additional Use Cases
- Browsing
- Provisioning
- Summary of Provisioning Requests
- Upload OVF to Create a vApp Template
- View the OVF Descriptor of a vApp Template
- Download a vApp Template as OVF
- Upload a Media Image
- Copying and Moving
- Changing a Name or Description
- Delete a vAppTemplate, vApp, or Media Image
- Cataloging vApp Templates and Media Images
- Controlling Access
- Datacenter Operations
- Summary of Datacenter Operations Requests
- vApp Lifecycle
- Instantiate a vApp Template
- Compose a vApp
- Recompose a vApp to Add or Remove Virtual Machines
- Capture a vApp to Create a vApp Template
- Reconfiguring vApps and Virtual Machines
- Deploying and Controlling vApps and Virtual Machines
- Deploy a vApp or Virtual Machine
- Undeploy a vApp or Virtual Machine
- Power On a vApp or Virtual Machine
- Power Off a vApp or Virtual Machine
- Reset a vApp or Virtual Machine
- Suspend a vApp or Virtual Machine
- Discard the Suspended State of a vApp or Virtual Machine
- Shut Down a vApp or Virtual Machine
- Reboot a vApp or Virtual Machine
- List Media Devices of a Virtual Machine
- Insert Media Into a Virtual Machine
- Eject Media from a Virtual Machine
- Get a Screen Thumbnail for a Virtual Machine
- Get a Screen Ticket for a Virtual Machine
- Provide User Input Requested by a Virtual Machine
- Control Access to vApps
- Retrieve a Task
- Administrative Operations
- VMware vSphere Platform Operations
- Summary of vSphere Platform Operations Requests
- List vSphere Platform Operations and Objects for a vCloud
- List Provider vDCs in a vCloud
- List External Networks in a vCloud
- List Network Pools in a vCloud
- List vCenter Servers Registered to a vCloud
- List ESX/ESXi Hosts in a vCloud
- Create a Provider vDC
- Create an External Network
- Create a Network Pool
- Import a Virtual Machine from vCenter
- XML Representations in the vCloud API
- User API Reference
- Request Parameters Reference
- Administrative API Reference
- vSphere Platform Extensions Reference
- OVF and the vCloud API
- An Introduction to REST for vCloud API Users
- Index
vCloud API Programming Guide
40 VMware, Inc.
Get Information About a vApp or Virtual Machine
CatalogscannotcontainreferencestovAppsorthevirtualmachines( Vmobjects)thattheycontain.Aclientcan
discovertheURLofavAppbybrowsinginavDCforaResourceEntityelementthatreferencesit.After
clienthasthetemplate’sURL,itcanuseitasthetargetof
aGETrequest,asshowninExample 2‐8onpage 39
toretrievethevApprepresentationandtheVmelementsitcontains.
Get Information About a Network
Network(OrgNetwork)elementscanbecontainedbyOrgandVdcelements.Ifanorganizationcontainsany
networks,eachoneisreferencedbyaLinkelementwhererel="down"intheOrgbody.Eachorganization
networkisamemberoftheAvailableNetworkselementineachoftheorganization’svDCs.
Togetinformation
aboutanetwork,makeaGETrequesttoitsURL,asshowninExample 3‐7.
Example 3-7. Get Information About a Network
Request:
GET http://vcloud.example.com/api/v1.0/network/54
Response:
200 OK
Content-Type: application/vnd.vmware.admin.network+xml
...
<OrgNetwork xmlns="http://www.vmware.com/vcloud/v1" name="Internet"
type="application/vnd.vmware.admin.network+xml"
ref="http://vcloud.example.com/api/v1.0/admin/network/54" ...>
<Link rel="alternate" type="application/vnd.vmware.vcloud.network+xml"
href="http://vcloud.example.com/api/v1.0/network/54"/>
<Link rel="edit" type="application/vnd.vmware.admin.network+xml"
href="http://vcloud.example.com/api/v1.0/admin/network/54"/>
<Link rel="remove" href="http://vcloud.example.com/api/v1.0/admin/network/54"/>
<Link rel="up" type="application/vnd.vmware.admin.organization+xml"
href="http://vcloud.example.com/api/v1.0//org/26"/>
<Description>Bridged to the Public Internet</Description>
<Configuration>
<IpScope>
<IsInherited>true</IsInherited>
<Gateway>10.147.56.253</Gateway>
<Netmask>255.255.255.0</Netmask>
<Dns1>10.147.115.1</Dns1>
<Dns2>10.147.115.2</Dns2>
<DnsSuffix>example.com</DnsSuffix>
<IpRanges>
<IpRange>
<StartAddress>10.147.56.1</StartAddress>
<EndAddress>10.147.56.255</EndAddress>
</IpRange>
</IpRanges>
</IpScope>
<ParentNetwork type="application/vnd.vmware.admin.network+xml" name="ExternalNetwork-VC1"
href="http://vcloud.example.com/api/v1.0/admin/network/7"/>
<FenceMode>bridged</FenceMode>
</Configuration>
</OrgNetwork>