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

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
3 Browsing

33
- Summary of Browsing Requests
  33
- Discovering the Contents of an Organization, Catalog, or VDC
  34
4 Provisioning

41
- Summary of Provisioning Requests
  41
- Upload OVF to Create a Vapp Template
  42
5 Datacenter Operations

59
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 Categories

Software Network Hardware

Switch

Storage

More VMWARE Manuals