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. 101
Chapter 6 Administrative Operations
<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>
Theresponseechoestherequest,andcontainssomeadditionalelements:
ATaskthattrackscreationofthenetwork.
AdditionalmembersoftheConfigurationelementthatareinheritedfromtheorganization’sdefaults,
becausetheywerenotspecifiedintherequest.
ThesamerequestwithadifferentvalueforFenceModecontentswouldcreateanetworkwithadifferenttype
ofconnectiontotheparent.Formoreinformation,see“FenceMode”onpage 155.
Get an Administrative View of an Organization Network
Toseeanadministrativeviewofanorganizationnetwork,anadministratorcanmakeaGETrequesttothe
network’sadminURL(thehrefelementoftheOrgNetworkbody),asshowninExample 6‐11.Theresponse,
mostofwhichisnotshownhere,wouldbeidenticaltotheoneshownin
Example 6‐10,butwithouttheTasks
element.
Example 6-11. Get an Administrative View of an Organization Network
Request:
GET http://vcloud.example.com/api/v1.0/admin/network/54
Response:
200 OK
Content-Type: application/vnd.vmware.admin.network+xm
...
<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" ...>
...
<Description>Bridged to the public Internet</Description>
...
</OrgNetwork>
Modify an Organization Network
Anadministratorcanusetherel="edit"linkinanOrgNetworkbodytomodifythenetwork’sname,
description,orconfiguration.Example 6‐12doesthisbymakingaPUTrequesttotherel="edit"link
returnedinExample 6‐10.Therequestmodifiesthenetwork’sFenceModeelementandaddselementstothe
Configurationto
definetheNATservicebeingaddedtothenetwork.
Example 6-12. Modify a Network
Request:
PUT http://vcloud.example.com/api/v1.0/admin/network/54
Content-Type: application/vnd.vmware.admin.network+xml
...
<OrgNetwork name="Internet" xmlns="http://www.vmware.com/vcloud/v1">
<Description>NAT-ed to the public Internet</Description>
<Configuration>
<ParentNetwork type="application/vnd.vmware.admin.network+xml" name="ExternalNetwork-VC1"
href="http://vcloud.example.com/api/v1.0/admin/network/7"/>
<FenceMode>natRouted</FenceMode>
<Features>
<DhcpService>