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
VMware, Inc. 125
Chapter 7 VMware vSphere Platform Operations
Example 7-10. Get Information About a Host
Request:
GET http://vcloud.example.com/api/v1.0/admin/extension/host/22
Response:
200 OK
Content-Type: application/vnd.vmware.admin.host+xml
...
<vmext:Host xmlns:vmext="http://www.vmware.com/vcloud/extension/v1"
xmlns:vcloud="http://www.vmware.com/vcloud/v1" name="10.115.121.14"
href="http://vcloud.example.com/api/v1.0/admin/extension/host/22" ... >
<vcloud:Link rel="disable"
href="http://vcloud.example.com/api/v1.0/admin/extension/host/22/action/disable"/>
<vcloud:Description/>
<vmext:Ready>true</vmext:Ready>
<vmext:Available>true</vmext:Available>
<vmext:Enabled>true</vmext:Enabled>
<vmext:Busy>false</vmext:Busy>
<vmext:EnableHostForHostSpanning>true</vmext:EnableHostForHostSpanning>
<vmext:CpuType>Intel(R) Xeon(R) CPU E5310 @ 1.60GHz</vmext:CpuType>
<vmext:NumOfCpusPackages>2</vmext:NumOfCpusPackages>
<vmext:NumOfCpusLogical>8</vmext:NumOfCpusLogical>
<vmext:CpuTotal>1600</vmext:CpuTotal>
<vmext:MemUsed>0.0</vmext:MemUsed>
<vmext:MemTotal>8187.5546875</vmext:MemTotal>
<vmext:HostOsName>VMware ESXi</vmext:HostOsName>
<vmext:HostOsVersion>4.0.0</vmext:HostOsVersion>
<vmext:VimPropertyPageUrl>
vpxclient://7416E531-05B9-4C1F-854D-97EF7C546CB0::HostSystem:host-20/
</vmext:VimPropertyPageUrl>
<vmext:VmMoRef>host-20</vmext:VmMoRef>
</vmext:Host>
Prepare a Host
WhenyouaddahosttoavSphereclusterthatCloudDirectoruses,youmustpreparethehostbeforea
providervDCcanusethehost’sresources.
Youcannotprepareahostthatisinlockdownmode.Afteryouprepareahost,youcanenablelockdownmode.
Asystemadministratorcanprepare
ahostbymakingaPOSTrequesttothehost’saction/prepareURLand
supplyingaPrepareHostParamsrequestbodythatincludestheusernameandpasswordofahost
administrator,asshowninExample 7‐11.
Example 7-11. Prepare a Host
Request:
POST http://vcloud.example.com/api/v1.0/admin/extension/host/1/action/prepare
Content-Type: application/vnd.vmware.admin.prepareHostParams+xml
...
<vmext:PrepareHostParams xmlns:vmext="http://www.vmware.com/vcloud/extension/v1"
xmlns:vcloud="http://www.vmware.com/vcloud/v1"
type="application/vnd.vmware.admin.vmwprovidervdc+xml">
<vmext:Username>Administrator</vmext:Username>
<vmext:Password>Pa55w0rd</vmext:Password>
</vmext:PrepareHostParams>