Sign In
Upload
Manuals
Brands
VMWARE Manuals
Software
VCLOUD API 1.0 - TECHNICAL NOTE
VMWARE VCLOUD API 1.0 - TECHNICAL NOTE Manuals
Manuals and User Guides for VMWARE VCLOUD API 1.0 - TECHNICAL NOTE. We have
1
VMWARE VCLOUD API 1.0 - TECHNICAL NOTE manual available for free PDF download: Programming Manual
VMWARE VCLOUD API 1.0 - TECHNICAL NOTE Programming Manual (212 pages)
Brand:
VMWARE
| Category:
Software
| Size: 2.01 MB
Table of Contents
Table of Contents
3
About this Book
11
1 Introducing the Vmware Vcloud API
13
Vcloud Object Taxonomy
13
Vcloud Organizations
13
Objects, References, and Representations
15
Links and Link Relations
15
Vcloud Client Workflow Overview
17
Requests
17
Responses
18
Configuring the Vcloud API URL
19
Related Publications
19
About the Examples
19
2 Hello Vcloud: a Structured REST Workflow Example
21
Logging in and Getting an Organization List
21
Browsing an Organization
22
Finding a Vapp Template
23
Getting Information about a VDC
24
Instantiating the Template in the VDC
24
Deploying and Powering on the Vapp
26
Getting Information about the Vapp
27
Displaying the Console
29
Retrieve a Screen Ticket
29
Use the Ticket with Vmware-Vmrc
30
Deleting the Vapp
30
Logging out
30
Moving on to Additional Use Cases
31
3 Browsing
33
Summary of Browsing Requests
33
Discovering the Contents of an Organization, Catalog, or VDC
34
List the Organizations in a Vcloud
34
List the Contents of an Organization
34
List the Contents of a Catalog
35
Get Information about a Catalogitem
36
List the Contents of a VDC
37
Getting more Information about an Object
38
Get Information about a Media Image
38
Get Information about a Vapptemplate
39
Get Information about a Network
40
Get Information about a Vapp or Virtual Machine
40
4 Provisioning
41
Summary of Provisioning Requests
41
Upload OVF to Create a Vapp Template
42
Restrictions on Uploaded Content
43
Initiate the Upload
43
Including a Manifest
45
Uploading the Files
45
View the OVF Descriptor of a Vapp Template
47
Download a Vapp Template as OVF
47
Enable a Vapp Template for Download
48
Disable a Vapp Template for Download
49
Upload a Media Image
50
Copying and Moving
50
Copy or Move a Media Image
51
Copy or Move a Vapp Template
51
Copy or Move a Vapp
52
Changing a Name or Description
53
Change the Name or Description of a Vapp
53
Change the Name or Description of a Vapptemplate
53
Change the Name or Description of a Media Image
54
Delete a Vapptemplate, Vapp, or Media Image
54
Cataloging Vapp Templates and Media Images
54
Add an Item to a Catalog
54
Catalog Links in a Vapp Template or Media Image
56
Remove an Item from a Catalog
56
Controlling Access
56
Control Access to Catalogs
56
5 Datacenter Operations
59
Summary of Datacenter Operations Requests
59
Vapp Lifecycle
60
Instantiate a Vapp Template
61
About Instantiation Parameters
62
About Vapp Networks
62
Instantiating a Vapptemplate Using Default Parameters
62
Instantiating a Vapp Template Using Additional Parameters
62
Retrieve or Modify the Customizationsection of a Vapp Template
64
Compose a Vapp
65
Finding Virtual Machine Urls to Use in a Composition Item
66
Recompose a Vapp to Add or Remove Virtual Machines
67
Capture a Vapp to Create a Vapp Template
68
Reconfiguring Vapps and Virtual Machines
69
Reconfigure a Vapp
69
Reconfigure a Virtual Machine
73
Deploying and Controlling Vapps and Virtual Machines
80
Deploy a Vapp or Virtual Machine
80
Power on a Vapp or Virtual Machine
81
Undeploy a Vapp or Virtual Machine
81
Power off a Vapp or Virtual Machine
82
Reset a Vapp or Virtual Machine
82
Discard the Suspended State of a Vapp or Virtual Machine
83
Suspend a Vapp or Virtual Machine
83
Reboot a Vapp or Virtual Machine
84
Shut down a Vapp or Virtual Machine
84
Insert Media into a Virtual Machine
85
List Media Devices of a Virtual Machine
85
Eject Media from a Virtual Machine
86
Get a Screen Thumbnail for a Virtual Machine
86
Get a Screen Ticket for a Virtual Machine
87
Provide User Input Requested by a Virtual Machine
87
Control Access to Vapps
89
Retrieve a Task
89
6 Administrative Operations
91
Summary of Administrative Requests
91
Administrator Credentials and Privileges
93
Administrative Objects and Urls
93
Get an Administrative View of a Cloud
93
Organization Administration
94
Create an Organization
95
Get an Administrative View of an Organization
96
List All Tasks Owned by an Organization
97
Modify an Organization
97
Enable or Disable an Organization
98
Remove an Organization
99
Network Administration
99
View the Properties of an External Network
99
Add a Network to an Organization
100
Get an Administrative View of an Organization Network
101
Modify an Organization Network
101
Remove an Organization Network
102
VDC Administration
102
Examine the Contents of a Provider VDC
103
Allocate a VDC to an Organization
104
List the Organization Vdcs Supported by a Provider VDC
104
Get an Administrative View of a VDC
106
Modify a VDC
106
Enable or Disable a VDC
107
Remove a VDC
107
Catalog Administration
107
Create a Catalog
107
Get an Administrative View of a Catalog
108
Modify Catalog Metadata
109
Publish a Catalog
109
Remove a Catalog
110
User Administration
110
Create or Import a User
110
Get an Administrative View of a User
112
Modify User Metadata
112
Remove a User
113
Group Administration
113
Import a Group
113
Modify Group Metadata
114
Remove a Group
114
View Group Metadata
114
Role Administration
114
Create a Role
114
View Role Metadata
115
Modify a Role
116
Remove a Role
116
View a Right
116
7 Vmware Vsphere Platform Operations
117
Summary of Vsphere Platform Operations Requests
117
List Vsphere Platform Operations and Objects for a Vcloud
119
List Provider Vdcs in a Vcloud
120
List External Networks in a Vcloud
120
List Network Pools in a Vcloud
120
List Vcenter Servers Registered to a Vcloud
120
Get Information about a Vcenter Server
120
List Available Resource Pools on a Vcenter Server
121
Modify Vcenter Server Settings
122
Register a Vcenter Server and Vshield Manager
122
Unregister a Vcenter Server and Vshield Manager
123
Force Reconnection to a Vcenter Server
124
List Esx/Esxi Hosts in a Vcloud
124
Get Information about a Host
124
Prepare a Host
125
Enable or Disable a Host
126
Repair a Host
126
Unprepare a Host
126
Upgrade a Host Agent
127
Create a Provider VDC
127
Examine the Vsphere Objects in a Provider VDC
131
Modify a Provider VDC
131
Enable or Disable a Provider VDC
132
Remove a Provider VDC
132
Create an External Network
133
Get Information about an External Network
134
Modify an External Network
135
Remove an External Network
135
Create a Network Pool
136
Get Information about a Network Pool
137
Modify a Network Pool
137
Remove a Network Pool
138
Import a Virtual Machine from Vcenter
138
Discover the Virtual Machines in a Vcenter
138
Import a Virtual Machine as a Vapp
139
Import a Virtual Machine as a Vapp Template
140
8 XML Representations in the Vcloud API
141
About Object Representations
141
Schema
141
Content Type
142
Object Reference Prototype
142
Common Datatypes
142
Primitive XML Datatypes
142
Common Attributes
143
Complex Types
143
Href
144
Name
144
Status
144
Type
144
XML Namespace Identifiers
145
Common Elements
146
Description
146
Error
146
API Versioning
147
Link
147
Extensibility
148
Supportedversions
148
Versioninfo
148
Vcloudextension
149
9 User API Reference
151
Orglist
151
Org
151
VDC
152
Availablenetworks
153
Computecapacity
153
Storagecapacity
153
Orgnetwork
154
Resourceentities
154
Resourceentity
154
Configuration
155
Catalog
160
Catalogitem
160
Catalogitems
160
Media
161
Vapptemplate
161
Children
162
Vapp
162
Section
163
Customizationsection
164
Leasesettingssection
164
Startupsection
164
Networkconfigsection
165
Networkconnectionsection
165
Guestcustomizationsection
167
Operatingsystemsection
167
Virtualhardwaresection
167
Rasditemslist
168
Screenticket
168
Task
168
Tasks
168
Taskslist
168
10 Request Parameters Reference
171
Uploadvapptemplateparams
171
Instantiatevapptemplateparams
172
Instantiationparams
172
Composevappparams
173
Item
173
Networkassignment
174
Recomposevappparams
174
Deployvappparams
175
Undeployvappparams
175
Capturevappparams
175
Clonemediaparams
176
Clonevapptemplateparams
176
Clonevappparams
176
Mediainsertorejectparams
177
Vmpendingquestion
177
Vmquestionanswer
177
Controlaccessparams
177
Accesssettings
178
11 Administrative API Reference
179
Vcloud
179
Organizationreferences
180
Providervdcreferences
180
Rightreferences
180
Rolereferences
180
Networks
180
Externalnetwork
180
Adminorg
180
Settings
181
Catalogs
185
Groups
185
Users
185
Catalog
186
Providervdc
186
Vdcs
186
Computecapacity
187
Adminvdc
188
Networkpoolreference
188
Networkpoolreferences
188
Storagecapacity
188
Vdcreferences
188
Allocationmodel
190
User
190
Group
191
Rightreference
191
Rightreferences
191
Role
191
Right
192
12 Vsphere Platform Extensions Reference
193
Vmwextension
193
Vmwprovidervdcreferences
194
Vmwexternalnetworkreferences
194
Vmwnetworkpoolreferences
194
Vmwvimserverreferences
194
Vmwhostreferences
194
Vimserver
194
Vmobjectrefslist
195
Vimobjectref
195
Resourcepool
196
Resourcepoollist
196
Shieldmanager
196
Vmwprovidervdc
197
Fencepooltype
198
Portgrouppooltype
198
Vlanpooltype
198
Vmwnetworkpool
198
Host
199
Vlanrange
199
Vmwexternalnetwork
199
Vmwhostreferences
199
Preparehostparams
200
Registervimserverparams
200
Request Parameters
200
Importvmasvappparams
201
Importvmasvapptemplateparams
201
OVF and the Vcloud API
203
About OVF
203
About OVF Packages
204
About OVA Files
204
How the Vcloud API Uses OVF
204
Virtual Machines
204
Networks
205
Virtual Disk Files
205
An Introduction to REST for Vcloud API Users
207
How REST Works
207
Using the Vcloud REST API
207
Restful Workflow Patterns
208
For more Information about REST
208
Index
209
Advertisement
Advertisement
Related Products
VMWARE APPSPEED SERVER 1.5 - VCENTER APPSPEED INSTALLATION AND
VMWARE VSHIELD APP 1.0 -
VMWARE VSHIELD APP 1.0.0 UPDATE 1 - API
VMWARE VSHIELD APP 1.0 - API
VMware ACE
VMware 454885-B21 - Lab Manager Standard Foundation Bundle
VMware 4817V62 - vSphere - PC
VMware ACE EN-000042-00
VMWARE CLOUD COMPUTING -
VMWARE CLOUD DIRECTOR 1.0
VMWARE Categories
Software
Network Hardware
Switch
Storage
More VMWARE Manuals
Login
Sign In
OR
Sign in with Facebook
Sign in with Google
Upload manual
Upload from disk
Upload from URL