vcloud API Programming Guide vcloud API 1.0

Size: px
Start display at page:

Download "vcloud API Programming Guide vcloud API 1.0"

Transcription

1 vcloud API 1.0 This document supports the version of each product listed and supports all subsequent versions until the document is replaced by a new edition. To check for more recent editions of this document, see EN

2 You can find the most up-to-date technical documentation on the VMware Web site at: The VMware Web site also provides the latest product updates. If you have comments about this documentation, submit your feedback to: Copyright 2009, 2011 VMware, Inc. All rights reserved. This product is protected by U.S. and international copyright and intellectual property laws. VMware products are covered by one or more patents listed at VMware is a registered trademark or trademark of VMware, Inc. in the United States and/or other jurisdictions. All other marks and names mentioned herein may be trademarks of their respective companies. VMware, Inc Hillview Ave. Palo Alto, CA VMware, Inc.

3 Contents 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 vapp or Virtual Machine 40 Get Information About a Network 40 4 Provisioning 41 Summary of Provisioning Requests 41 Upload OVF to Create a vapp Template 42 VMware, Inc. 3

4 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 vapptemplate 53 Change the Name or Description of a vapp 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 Remove an Item from a Catalog 56 Catalog Links in a VApp Template or Media Image 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 Undeploy a vapp or Virtual Machine 81 Power On a vapp or Virtual Machine 81 Power Off a vapp or Virtual Machine 82 Reset a vapp or Virtual Machine 82 Suspend a vapp or Virtual Machine 83 Discard the Suspended State of a vapp or Virtual Machine 83 Shut Down a vapp or Virtual Machine 84 Reboot a vapp or Virtual Machine 84 List Media Devices of a Virtual Machine 85 Insert Media Into a Virtual Machine 85 Eject Media from a Virtual Machine 86 Get a Screen Thumbnail for a Virtual Machine 86 4 VMware, Inc.

5 Contents 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 List the Organization vdcs Supported by a Provider vdc 104 Allocate a vdc to an Organization 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 Publish a Catalog 109 Modify Catalog Metadata 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 View Group Metadata 114 Modify Group Metadata 114 Remove a Group 114 Role Administration 114 Create a Role 114 View Role Metadata 115 Modify a Role 116 Remove a Role 116 View a Right 116 VMware, Inc. 5

6 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 Unprepare a Host 126 Enable or Disable a Host 126 Repair 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 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 Complex Types 143 Common Attributes 143 name 144 href 144 type 144 status 144 XML Namespace Identifiers 145 Common Elements 146 Description 146 Error VMware, Inc.

7 Contents Link 147 API Versioning 147 SupportedVersions 148 VersionInfo 148 Extensibility 148 VCloudExtension User API Reference 151 OrgList 151 Org 151 Vdc 152 StorageCapacity 153 ComputeCapacity 153 AvailableNetworks 153 ResourceEntities 154 ResourceEntity 154 OrgNetwork 154 Configuration 155 Catalog 160 CatalogItems 160 CatalogItem 160 Media 161 VAppTemplate 161 Children 162 VApp 162 Vm 163 Section 163 LeaseSettingsSection 164 StartupSection 164 CustomizationSection 164 NetworkConfigSection 165 NetworkConnectionSection 165 VirtualHardwareSection 167 OperatingSystemSection 167 GuestCustomizationSection 167 RasdItemsList 168 ScreenTicket 168 TasksList 168 Tasks 168 Task 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 VMware, Inc. 7

8 CloneVAppParams 176 MediaInsertOrEjectParams 177 VmPendingQuestion 177 VmQuestionAnswer 177 ControlAccessParams 177 AccessSettings Administrative API Reference 179 VCloud 179 OrganizationReferences 180 ProviderVdcReferences 180 RightReferences 180 RoleReferences 180 Networks 180 ExternalNetwork 180 AdminOrg 180 Settings 181 Users 185 Groups 185 Catalogs 185 Catalog 186 Vdcs 186 ProviderVdc 186 ComputeCapacity 187 StorageCapacity 188 NetworkPoolReferences 188 NetworkPoolReference 188 VdcReferences 188 AdminVdc 188 AllocationModel 190 User 190 Group 191 Role 191 RightReferences 191 RightReference 191 Right vsphere Platform Extensions Reference 193 VMWExtension 193 VMWProviderVdcReferences 194 VMWExternalNetworkReferences 194 VMWNetworkPoolReferences 194 VMWVimServerReferences 194 VMWHostReferences 194 VimServer 194 VmObjectRefsList 195 VimObjectRef 195 ResourcePoolList 196 ResourcePool 196 ShieldManager 196 VMWProviderVdc 197 VMWNetworkPool 198 FencePoolType 198 PortGroupPoolType 198 VlanPoolType VMware, Inc.

9 Contents VMWExternalNetwork 199 VlanRange 199 VMWHostReferences 199 Host 199 Request Parameters 200 PrepareHostParams 200 RegisterVimServerParams 200 ImportVmAsVAppParams 201 ImportVmAsVAppTemplateParams 201 A 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 Virtual Disk Files 205 Networks 205 B 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 VMware, Inc. 9

10 10 VMware, Inc.

11 About This Book The vcloud API Programming Guide provides information about version 1.0 of the vcloud API. VMware provides many different APIs and SDKs for various applications and goals. This book provides information about the vcloud API for developers that are interested in creating RESTful clients of VMware Cloud Director. To view the current version of this book as well as all VMware API and SDK documentation, go to Revision History This book is revised with each release of the product or when necessary. A revised version can contain minor or major changes. Table 1 summarizes the significant changes in each version of this book. Table 1. Revision History Revision Date 08MAR11 Description GuestCustomizationSection not allowed in InstantiationParams 30AUG10 Version 1.0 Intended Audience This guide is intended for software developers who are building VMware Ready Cloud Services, including interactive clients of VMware Cloud Director. This guide assumes you are familiar with Representational State Transfer (REST) and RESTful programming conventions, the Open Virtualization Format Specification, and VMware Virtual machine technology. Familiarity with other widely deployed technologies such as XML, HTTP, and the Windows or Linux operating systems is also assumed. VMware Technical Publications Glossary VMware Technical Publications provides a glossary of terms that might be unfamiliar to you. For definitions of terms as they are used in VMware technical documentation go to Document Feedback VMware welcomes your suggestions for improving our documentation. Send your feedback to docfeedback@vmware.com. VMware, Inc. 11

12 Technical Support and Education Resources The following sections describe the technical support resources available to you. To access the current versions of other VMware books, go to Online and Telephone Support To use online support to submit technical support requests, view your product and contract information, and register your products, go to Support Offerings To find out how VMware support offerings can help meet your business needs, go to VMware Professional Services VMware Education Services courses offer extensive hands on labs, case study examples, and course materials designed to be used as on the job reference tools. Courses are available onsite, in the classroom, and live online. For onsite pilot programs and implementation best practices, VMware Consulting Services provides offerings to help you assess, plan, build, and manage your virtual environment. To access information about education classes, certification programs, and consulting services, go to 12 VMware, Inc.

13 1 Introducing the VMware vcloud API 1 The VMware vcloud API provides support for developers who are building interactive clients of VMware Cloud Director using a RESTful application development style. vcloud API clients and servers communicate over HTTP, exchanging representations of vcloud objects. These representations take the form of XML elements. HTTP GET requests are used to retrieve the current representation of an object, HTTP POST and PUT requests are used to create or modify an object, and HTTP DELETE requests are typically used to delete an object. This chapter introduces the vcloud API and includes the following topics: vcloud Object Taxonomy on page 13 Objects, References, and Representations on page 15 Links and Link Relations on page 15 vcloud Client Workflow Overview on page 17 About the Examples on page 19 vcloud Object Taxonomy The vcloud API defines a set of objects common to cloud computing environments. Figure 1 1 illustrates the principal object types. vcloud Organizations A vcloud contains one or more organizations. A vcloud organization is a unit of administration for a collection of users, groups, and computing resources. Users authenticate at the organization level, supplying credentials established by an organization administrator when the user was created or imported. vcloud Users and Groups An organization can contain an arbitrary number of users and groups. Users can be created by the organization administrator or imported from a directory service such as LDAP. Groups must be imported from the directory service. Permissions within an organization are controlled through the assignment of rights and roles to users and groups. vcloud Networks An organization can be provisioned with one or more networks. These organization networks can be configured to provide services such as DHCP, NAT, and firewalls. VMware, Inc. 13

14 Figure 1-1. vcloud Object Taxonomy Organization vapp vapp vdc1 Media vdc2 vapp template Media vapp template Catalog 3 Catalogitem em Catalog 2 em em Catalogitem em Catalog 1 em em Catalogitem Catalogitem Catalogitem Catalogitem Media Media Network Network users groups TasksList vcloud Virtual Datacenters A vcloud virtual datacenter (vdc) is an allocation mechanism for resources such as networks, storage, CPU, and memory. In a vdc, computing resources are fully virtualized, and can be allocated based on demand, service level requirements, or a combination of the two. There are two kinds of vdcs: Provider vdcs. These vdcs contain all the resources available from the vcloud service provider. Provider vdcs are created and managed by vcloud system administrators. Organization vdcs. These vdcs provide an environment where virtual systems can be stored, deployed, and operated. They also provide storage for virtual media, such as floppy disks and CD ROMs. An organization administrator specifies how resources from a provider vdc are distributed to the vdcs in an organization. vcloud Catalogs Catalogs contain references to virtual systems and media images. A catalog can be shared to make it visible to other members of an organization, and can be published to make it visible to other organizations. A vcloud system administrator specifies which organizations can publish catalogs, and an organization administrator controls access to catalogs by organization members. vcloud Tasks Long running operations initiated by members of an organization create tasks, which are kept on the organization s tasks list. 14 VMware, Inc.

15 Chapter 1 Introducing the VMware vcloud API Virtual Systems and Media Images in a vcloud Virtual systems and media images are stored in a vdc and can be included in a catalog. Media images are stored in their native representation (ISO or floppy). Virtual systems are stored as templates, using an open standard format (OVF 1.0). These templates can be retrieved from catalogs and transformed into virtual systems, called vapps, through a process called instantiation, which binds a template s abstract resource requirements to resources available in a vdc. A vapp contains one or more individual virtual machines (Vm elements), along with parameters that define operational details such as: How the contained virtual machines are connected to each other and to external networks. The order in which individual virtual machines are powered on or off. End user license agreement terms for each virtual machine. Deployment lease terms (typically inherited from the containing organization) that constrain the vapp s consumption of vdc resources Access control information specifying which users and groups can perform operations such as deploy, power on, modify, and suspend on the vapp and the virtual machines it contains. Objects, References, and Representations The vcloud API represents objects in the vcloud as XML documents in which object properties are encoded as elements and attributes with typed values and an explicit object hierarchy defined by an XML schema. Every object in a vcloud is uniquely identified by a URL. This URL is constructed by the server and returned in the value of the href attribute of the XML element that represents the object. It also appears in various elements of LinkType and ReferenceType. This URL serves as a unique identifier that persists for the life of the object and is never re used. Although URLs have a well known syntax and a well understood interpretation, a client should treat each href as an opaque string. The rules that govern construction of href strings by the server might change in future releases. Object types, specified as MIME content types, are included in the XML representations of first class objects such as the ones shown in Figure 1 1. For more information, see Content Type on page 142. Links and Link Relations The vcloud API makes extensive use of links (URLs) to provide references to objects and the actions that they support. These links are the primary mechanism by which a server tells a client how to access and operate on an object. Links are created by the server, and are read only at the client. (If a client request body includes a link, the server ignores it.) In the XML representation of a vcloud object, each link is defined in a Link element that has the following form: <Link rel="relationship" type="application/vnd.vmware.vcloud.type+xml" href="url" name="string"/> The rel attribute value defines the relationship of the object whose XML representation contains the Link to a target object. The relationship also indicates the HTTP request type to use when making a request with the href attribute of the link, as shown in Table 1 1: Table 1-1. Link Relationships and HTTP Request Types rel Attribute Value Relation Description HTTP Request add adds an item to this container POST alternate a link to an alternate representation of this object GET catalogitem a link to the catalogitem that contains a reference to this object. GET controlaccess apply access controls POST copy not supported in this release N/A deploy deploy this object POST VMware, Inc. 15

16 Table 1-1. Link Relationships and HTTP Request Types (Continued) rel Attribute Value Relation Description HTTP Request disable disable this object POST discardstate discard the suspended state of this virtual machine POST down the referenced object is contained by this object GET download:alternate not supported in this release N/A download:default default download location for this file GET edit modifies this object PUT enable enable this object POST extension not supported in this release N/A media:ejectmedia eject virtual media from a virtual device POST media:insertmedia insert virtual media in a virtual device POST move not supported in this release N/A ova not supported in this release N/A ovf the OVF representation of this vapptemplate GET power:poweroff power off the referenced object POST power:poweron power on this object POST power:reboot reboot this object POST power:reset reset this object POST power:shutdown shut down this object POST power:suspend suspend this object POST publish publish this catalog POST recompose recompose this vapp POST reconnect reconnect this vcenter Server POST register register this vcenter Server POST remove remove this object DELETE repair repair this host POST screen:acquireticket acquire a screen ticket for this virtual machine GET screen:thumbnail thumbnail view of a virtual machine screen, in png format GET task:cancel not supported in this release N/A undeploy undeploy this object POST unregister unregister this vcenter Server POST up the referenced object contains this object GET upgrade upgrade this host POST upload:alternate not supported in this release N/A upload:default default upload location for this file PUT The type attribute value defines the media type (HTTP Content Type) of the request or response document. This attribute is present only for links to objects. It is not present for links to actions. The href attribute value is a URL, which should be considered an opaque identifier (one that the client should not attempt to parse or interpret). An href uniquely identifies, and persists for the life of, the referenced object. These identifiers are never re used. The name attribute value of the Link is the same as the name of the referenced object. Action links do not include a name attribute. 16 VMware, Inc.

17 Chapter 1 Introducing the VMware vcloud API Links provide a way for the server to inform a client about object relationships and the operations that objects support. For example, a container such as an organization or catalog can return links to the objects it contains, and a virtual system (a vapp or Vm) can contain action links that enable operations such as power state changes or virtual device reconfiguration. Links to actions and contained objects are omitted from responses if the request was made by a user who has insufficient privileges to access the object or perform the action. Action links are also omitted when the action cannot be performed (powering on a virtual machine that is already powered on, for example). NOTE When a client uses a link to reference an object, only the href attribute is required. The name and type are ignored. vcloud Client Workflow Overview Clients of the vcloud API implement a RESTful workflow, making HTTP requests to the server and retrieving the information they need from the server s responses. Requests Clients make HTTP requests to vcloud URLs, href attribute values which are typically provided by the server in response to GET requests by the client. Every vcloud has a well known URL from which a client can get the server s login URL and the list of vcloud API versions that the server supports, along with additional information (see API Versioning on page 147). After a client has logged in, all vcloud API URLs can be discovered by making GET requests to URLs listed in the login response and the URLs contained in responses to those requests. Request Headers All requests from authenticated clients must include an authentication header. See Authentication on page 18. Requests that include a document body must start with the appropriate HTTP Content Type header. The type attribute of a response body indicates the content type of the document. For example, this response fragment indicates that the content type associated with a CatalogItem entity is application/vnd.vmware.vcloud.catalogitem+xml. <CatalogItem type="application/vnd.vmware.vcloud.catalogitem+xml" href=" name="ubuntu Template with vsftpd"/> Any request that includes a CatalogItem requires the following Content Type header: Content-Type: application/vnd.vmware.vcloud.catalogitem+xml When it appears as the value of a Content Type header or the type attribute of an element in the vcloud API, this string is case insensitive in requests, and can be returned in either mixed case or lowercase characters in responses. For more information, see Content Type on page 142. Request Bodies This release of Cloud Director uses a validating XML parser that requires elements in a request body to agree in both order and number with the schema. Request bodies are rejected as invalid unless they meet the following criteria: XML namespace attributes must be supplied for all namespaces represented by elements in the request. See XML Namespace Identifiers on page 145. If multiple namespaces are represented in the request, XML namespace attributes must include an identifying prefix, and that prefix must be used with elements from that namespace. See XML Namespace Prefixes in Request and Response Bodies on page 146. VMware, Inc. 17

18 All required elements must appear in request bodies. All elements that appear in request bodies must appear in the order established by the schema, and with content that conforms to the type constraint specified in the schema. See Schema Validation on page 142. Authentication HTTP communications between a vcloud client and server are typically secured with SSL. In addition, the vcloud API implements Basic HTTP Authentication, as defined by RFC 2617, which enables a client to obtain a token that it can use to authenticate individual HTTP requests. To obtain and use an authentication token, a client must first discover the server s login URL, and then POST a login request to that URL, supplying the credentials of an authorized user. To obtain and use an authentication token 1 Make an API version request to a vcloud service to obtain the login URL for that service. For more information, see API Versioning on page Make an HTTP POST request to the login URL, as shown in Example 2 1 on page 21. If the authentication header is missing, the server returns HTTP response code 401. If the credentials supplied in the authentication header are invalid, the server returns HTTP response code 401. If the request is successful, the server returns HTTP response code 200 (OK) and headers that include an authorization header of the form: x-vcloud-authorization: token This header must be included in each subsequent vcloud API request. The response body is an OrgList element, which is a list of all organizations that the user can access. The authentication token expires after a configurable interval of client inactivity. The default is 30 minutes after the token is created. After the token expires, all requests fail with HTTP response code 401 until the client logs in again to obtain a new token. NOTE Certain administrative operations have special authentication requirements. For more information, see Administrator Credentials and Privileges on page 93. Responses All responses include an HTTP status code and, unless the status code is 204 (No Content), a Content Type header. Response content depends on the request. Some responses include a document body, some include only a URL, and some are empty. Status Codes Table 1 2 lists the subset of HTTP status codes that a vcloud API client can expect in a response. Table 1-2. HTTP Status Codes Returned by the vcloud API Status Code Status Description 200 OK The request is valid and was completed. The response includes a document body. 201 Created The request is valid. The requested object was created and can be found at the URL specified in the Location header. 202 Accepted The request is valid and a task was created to handle it. This response is usually accompanied by a task URL. 204 No Content The request is valid and was completed. The response does not include a body. 303 See Other The response to the request can be found at the URL specified in the Location header. 400 Bad Request The request body is malformed, incomplete, or otherwise invalid. 18 VMware, Inc.

19 Chapter 1 Introducing the VMware vcloud API Table 1-2. HTTP Status Codes Returned by the vcloud API (Continued) Status Code Status Description 401 Unauthorized An authorization header was expected but not found. 403 Forbidden The requesting user does not have adequate privileges to access one or more objects specified in the request. 404 Not Found One or more objects specified in the request could not be found in the specified container. 405 Method Not Allowed 500 Internal Server Error The HTTP method specified in the request is not supported for this object. The request was received but could not be completed due to an internal error at the server. 501 Not Implemented The request is not implemented by the server. 503 Service Unavailable One or more services needed to complete the request are not available on the server. Configuring the vcloud API URL The base URL used in href values includes the fully qualified domain name of the server host. In cases where this hostname cannot be resolved from the client (for example, if the Cloud Director installation includes multiple server hosts that you access through a load balancer) you can specify a URL for the server to use when constructing href strings. For more information, see Configure the External REST API Base URI in the Cloud Director Administratorʹs Guide. Related Publications The VMware Cloud Director Administratorʹs Guide and VMware Cloud Director User s Guide contain detailed information about many of the objects and operations referred to in this guide. Most users of the vcloud API will find the information in those documents valuable when developing client applications. To access the current versions of these and other VMware books, go to About the Examples This guide includes many examples of HTTP requests and responses. These examples are intended to show the workflow and content associated with specific types of operations such as browsing, managing inventory, and operating virtual systems. Example requests generally conform to the rules listed in Request Bodies on page 17. Most example responses show only those elements and attributes that are relevant to the operation being discussed. Ellipses ( ) indicate omitted content within response bodies. HTTP Content Type headers are shown where needed for all examples that are not fragments of some larger example that includes this header. Although the examples show these strings using the character case in which they are defined by the implementation, these strings are case insensitive in requests, and can be returned in either mixed case or lowercase characters in responses. Other HTTP headers, such as Date, Content Length, and Server, are omitted because they are not relevant to the specifics of any example. The XML version and encoding header (<?xml version="1.0" encoding="utf-8"?>) is not included in most examples, although it is a required part of all requests and responses that contain an XML body. In addition: Unsecured URLs ( are used in the examples. In practice, most sites will require the use of SSL ( Object IDs shown in href attribute values appear as small integers (for example vapp-7 or org/3). In the vcloud API supported by Cloud Director, object IDs are 10 digit decimal integers (for example vapp or org/ ). VMware, Inc. 19

20 20 VMware, Inc.

21 2 Hello vcloud: A Structured REST 2 Workflow Example This chapter presents a simple example of a structured REST workflow for discovering and deploying a particular vapp (in this case, an FTP server with a connection to the public Internet). This chapter includes the following topics: Logging In and Getting an Organization List on page 21 Browsing an Organization on page 22 Finding a vapp Template on page 23 Getting Information About a vdc on page 24 Instantiating the Template in the vdc on page 24 Deploying and Powering On the vapp on page 26 Getting Information About the vapp on page 27 Deleting the vapp on page 30 Logging Out on page 30 Logging In and Getting an Organization List Every vcloud has a login URL that a client can obtain by making an unauthenticated GET request to the vcloud s versions URL, as shown in Example 8 2 on page 147. Because all other vcloud API requests must be authenticated, any vcloud API workflow has to begin with a login request that supplies user credentials in the form required by Basic HTTP authentication (MIME Base64 encoding of a string having the form user@vcloud organization:password). Example 2 1 shows a login request and response for a vcloud whose login URL is Example 2-1. Login Request and Response POST Authorization: Basic encoded-credentials 200 OK Date: request-date x-vcloud-authorization: cn9uymdugn8e2j96+5lqrc3ybvfsegdhxzyfjrj/6bm= Content-Type: application/vnd.vmware.vcloud.orglist+xml <?xml version="1.0" encoding="utf-8"?> <OrgList href=" > <Org type="application/vnd.vmware.vcloud.org+xml" name="exampleorg" href=" VMware, Inc. 21

22 <Org /> <Org /> </OrgList> The response includes an authentication token supplied in the x-vcloud-authorization header, and a list of the organizations to which the authenticated user has access. Each Org has a URL (in its href attribute value) that the client can use to get more information about objects that the organization contains. For more information about authentication, see Authentication on page 18. NOTE This example, like other examples in this guide, omits certain required HTTP headers and other content so that it can provide a concise, readable subset of an actual request and response. For more information, see About the Examples on page 19. Browsing an Organization You can use an HTTP GET request and one of the Org URLs returned by the login request to discover the contents of an organization, as shown in Example 2 2. (For a more complete version of this example, see Example 3 1 on page 34.) Example 2-2. List the Contents of an Organization GET OK Content-Type: application/vnd.vmware.vcloud.org+xml <Org name="exampleorg" type="application/vnd.vmware.vcloud.org+xml" href=" > <Link /> <Link rel="down" type="application/vnd.vmware.vcloud.catalog+xml" href=" name="maincatalog"/> <Link /> <Link rel="down" type="application/vnd.vmware.vcloud.vdc+xml" href=" name="examplevdc01"/> <Link /> <Link rel="down" type="application/vnd.vmware.vcloud.network+xml" href=" name="isolatedorgnet"/> <Link rel="down" type="application/vnd.vmware.vcloud.network+xml" href=" name="internet"/> <Description>Example Corp s Primary Organization</Description> </Org> Links in the response whose rel attribute has a value of down are references to objects that the organization contains. Example 2 2 shows the subset of those items that you will need for this exercise: A catalog named MainCatalog, at URL where you can look for vapp templates. A vdc named ExampleVdc01, at URL where you can deploy the vapp. Two networks: one named Internet, at URL and one named IsolatedOrgNet, at URL You can connect connect the vapp to either of these networks. 22 VMware, Inc.

23 Chapter 2 Hello vcloud: A Structured REST Workflow Example Finding a vapp Template The client can use the catalog URL shown in Example 2 2 as the target of a GET request that returns the contents of the catalog, as shown in Example 2 3. Example 2-3. Finding a vapp Template in a Catalog GET OK Content-Type: application/vnd.vmware.vcloud.catalog+xml <Catalog name="maincatalog" type="application/vnd.vmware.vcloud.catalog+xml" href=" > <Description>Main Org Catalog</Description> <CatalogItems> <CatalogItem type="application/vnd.vmware.vcloud.catalogitem+xml" name="ubuntu Template with vsftpd" href=" </CatalogItems> </Catalog> Every vapp template or media image that has been added to the catalog is represented as a CatalogItem element. When a client browses a catalog, it can read only the name, type, and href of each CatalogItem. To retrieve an item from the catalog, more information is required. In Example 2 4, the client makes a GET request to a CatalogItem URL (its href value). The response provides more information, including a description of the referenced object and another URL that the client can use to retrieve a representation of the object. Example 2-4. Getting the vapp Template URL From a CatalogItem GET OK Content-Type: application/vnd.vmware.vcloud.catalogitem+xml <CatalogItem name="ubuntu Template with vsftpd" href=" > <Description>Ubuntu Template with vsftpd</description> <Entity href=" type="application/vnd.vmware.vcloud.vapptemplate+xml" name="ubuntu Template with vsftpd"/> </CatalogItem> This response shows that a suitable vapp template can be found at VMware, Inc. 23

24 Getting Information About a vdc Instantiation, deployment, and operation of a vapp all take place in the context of a vdc. The XML representation of a vdc object defines that context in detail. For this exercise, you need only two pieces of information from the vdc: The URL that a client can use to request an instantiatevapptemplate operation in the vdc A list of networks to which the vapp can connect. Example 2 5 shows this subset of vdc contents. (For a more complete look at those contents, see Example 3 4 on page 37.) Example 2-5. List the Contents of a vdc GET OK Content-Type: application/vnd.vmware.vcloud.vdc+xml <Vdc name="examplevdc01" type="application/vnd.vmware.vcloud.vdc+xml" href=" > <Link rel="add" type="application/vnd.vmware.vcloud.instantiatevapptemplateparams+xml" href=" /> <AvailableNetworks> <Network href=" type="application/vnd.vmware.vcloud.network+xml" name="isolatedorgnet"/> <Network href=" type="application/vnd.vmware.vcloud.network+xml" name="internet"/> </AvailableNetworks> </Vdc> The information you need is available here in two places: An Link element containing an action URL, The rel attribute of this Link has a value of add, indicating that it implements an action that adds an object to the vdc. A list of AvailableNetworks that includes all the networks owned by the organization that contains this vdc. Since we want this FTP server to be accessible on the public Internet, we will connect the vapp to the network named Internet. Both these pieces of information are put to use in Example 2 6. Instantiating the Template in the vdc To create a vapp from this template, you must bind its abstract resource requirements, such as network connections, storage resources, memory, and CPU capacity, to appropriate resources in the target vdc. This binding operation is called instantiation. Although a client can specify these bindings in detail, a simple instantiation, which relies on organization and vdc defaults, requires only a few pieces of information: A name for the vapp that the request creates The URL of the template to instantiate. In this case, the URL (retrieved in Example 2 4) is VMware, Inc.

25 Chapter 2 Hello vcloud: A Structured REST Workflow Example Creation parameters for a vapp network. A vapp network defines how the vapp connects to an organization network available in the target vdc. For more information, see About vapp Networks on page 62. The instantiatevapptemplate request in Example 2 6 supplies these parameters in the following places: The name is supplied in the name attribute of the InstantiateVAppTemplateParams request. (This request also provides a description, which is optional but a good practice.) The template URL is suppled in the Source element The vapp network is specified in the NetworkConfigSection element. This specification includes three parameters: A name for the network, supplied in the name attribute of the NetworkConfigSection element. If the vapp template includes an ovf:network element, the name you specify for the vapp network must match the name specified in that element s ovf:name attribute. A reference to the organization network to which the vapp network connects, specified in the ParentNetwork element. The URL used here is one returned in Example 2 5, in the AvailableNetworks element of the vdc. A fence mode, specified in the FenceMode element. A value of bridged indicates that the vapp network is connected directly to the organization network. The target of the request is the instantiatevapptemplate URL of this vdc (see Example 2 5). Because the operation creates a new object (a vapp), the HTTP request type is POST. Example 2-6. Instantiating a vapp Template POST Content-Type: application/vnd.vmware.vcloud.instantiatevapptemplateparams+xml <InstantiateVAppTemplateParams name="linux FTP server" xmlns=" xmlns:ovf=" > <Description>Example FTP Server vapp</description> <InstantiationParams> <NetworkConfigSection> <ovf:info>configuration parameters for vappnetwork</ovf:info> <NetworkConfig networkname="vappnetwork"> <Configuration> <ParentNetwork href=" <FenceMode>bridged</FenceMode> </Configuration> </NetworkConfig> </NetworkConfigSection> </InstantiationParams> <Source href=" </InstantiateVAppTemplateParams> 201 Created Content-Type: application/vnd.vmware.vcloud.vapp+xml <VApp deployed= false status="0" name="linux FTP server" type="application/vnd.vmware.vcloud.vapp+xml" href=" > <Link rel="up" type="application/vnd.vmware.vcloud.vdc+xml" href=" <Description>Example FTP Server vapp</description> <Tasks> VMware, Inc. 25

26 <Task status="running" starttime=" t08:00: :00" operation="creating Virtual Application Linux FTP server(7)" expirytime=" t08:00: :00" type="application/vnd.vmware.vcloud.task+xml" href=" <Owner type="application/vnd.vmware.vcloud.vapp+xml" name="linuxftpserver" href=" </Task> </Tasks> </VApp> NOTE A vapp template might include a license agreement or other terms that you must accept before you can create a vapp from it. In this example, the template contains no such terms. If it did, the request would fail if it did not include an AllEULAsAccepted element, as shown in Example 5 1 on page 63. The response to the instantiation request is a sparsely populated vapp body, which includes the following information: The status of the vapp. The status value 0 indicates that the vapp is unresolved, because instantiation has not completed. The name of the vapp, as supplied in the request The vapp URL, shown in the href attribute of the VApp body A task created to track the instantiation. The Task element has an operation attribute that describes what is happening, and contains an Owner element that is a reference the vapp being created. For more information, see Task on page 168. Deploying and Powering On the vapp After the instantiation task completes, the template has been transformed into a vapp. The vapp body no longer includes a Tasks element, and it now includes a number of Link elements that you can use to deploy and operate the vapp. Example 2 7 shows a request and response for a deploy action. The request URL is the rel="deploy" link returned in the vapp body (see Example 2 8). The request body is a DeployVAppParams element, which specifies deployment details. Example 2-7. Deploy and Power On a vapp POST Content-type: application/vnd.vmware.vcloud.deployvappparams+xml <DeployVAppParams poweron="true" deploymentleaseseconds=" " xmlns=" 202 Accepted <Task xmlns=" status="running" starttime=" t11:15: :00" operation="starting Virtual Application Linux FTP server(7)" expirytime=" t08:00: :00" type="application/vnd.vmware.vcloud.task+xml" href=" > <Owner type="application/vnd.vmware.vcloud.vapp+xml" name="linuxftpserver" href=" </Task> Because deployment is a long running operation that can fail for a variety of reasons (inability of the vdc to satisfy the vapp s resource requirements, for example), the response is a Task. 26 VMware, Inc.

27 Chapter 2 Hello vcloud: A Structured REST Workflow Example Because the deployment request specified poweron="true", the vapp is powered on and ready for use when the task completes. The client can wait for a suitable interval and check the task status (see Retrieve a Task on page 89), or simply begin requesting operations on the powered on vapp and checking the task status if those requests fail. See Deploying and Controlling vapps and Virtual Machines on page 80. Getting Information About the vapp As other examples have shown, a client can always use an HTTP GET request to discover the current state of any vcloud object, including a vapp. The response in Example 2 8 reveals several things: The vapp is deployed (its deployed attribute is set to true) and powered on (status="4"). The Vm in its Children collection is also powered on and deployed. The Vm is connected to the vapp network created during instantiation (see Example 2 6). Properties of this network are included in the NetworkConfigSection of the vapp, though most are not shown here. Action links for all operations except poweron are present in both the vapp itself and its child Vm. Because the vapp is already powered on, that operation is invalid for the vapp in its current state, so the link is not part of the response. (The link for deploy is always present, even in a deployed vapp, because the deploy action is always valid.) The Vm element also includes several links for actions that not applicable to a vapp: actions like acquiring a screen ticket or thumbnail, and inserting or removing media, are specific to a virtual machine. Other actions like shutdown and reboot, can be applied to either object. See Deploying and Controlling vapps and Virtual Machines on page 80. Much additional information is available, though most of it is not shown here. The example does show where to find the IP address of the vapp, in the IpAddress element of the NetworkConnection. Example 2-8. Get Information About the vapp GET OK Content-Type: application/vnd.vmware.vcloud.vapp+xml <VApp status="4" name="linux FTP server" type="application/vnd.vmware.vcloud.vapp+xml" href=" > <Link rel="power:reboot" href=" <Link rel="power:poweroff" href=" <Link rel="undeploy" href=" <Link rel="deploy" href=" <Link rel="power:shutdown" href=" <Link rel="power:reset" href=" <Link rel="power:suspend" href=" <Link rel="down" type="application/vnd.vmware.vcloud.controlaccess+xml" href=" <Link rel="controlaccess" type="application/vnd.vmware.vcloud.controlaccess+xml" href=" <Link rel="up" type="application/vnd.vmware.vcloud.vdc+xml" href=" <Link rel="edit" type="application/vnd.vmware.vcloud.vapp+xml" href=" <Description>Example FTP Server vapp</description> <LeaseSettingsSection > </LeaseSettingsSection> <ovf:startupsection > VMware, Inc. 27

vcloud API Programming Guide

vcloud API Programming Guide vcloud Director 1.5 This document supports the version of each product listed and supports all subsequent versions until the document is replaced by a new edition. To check for more recent editions of

More information

vcloud SDK for.net Developer s Guide VMware vcloud SDK 1.0

vcloud SDK for.net Developer s Guide VMware vcloud SDK 1.0 VMware vcloud SDK 1.0 This document supports the version of each product listed and supports all subsequent versions until the document is replaced by a new edition. To check for more recent editions of

More information

Using the vcenter Orchestrator Plug-In for vcloud Director 1.0

Using the vcenter Orchestrator Plug-In for vcloud Director 1.0 Using the vcenter Orchestrator Plug-In for vcloud Director 1.0 vcenter Orchestrator 4.1 vcloud Director 1.0 vcloud Director 1.0.1 This document supports the version of each product listed and supports

More information

vcloud API Programming Guide

vcloud API Programming Guide vcloud Director 5.5 This document supports the version of each product listed and supports all subsequent versions until the document is replaced by a new edition. To check for more recent editions of

More information

Using the vcenter Orchestrator Plug-In for vcloud Director 5.5. vrealize Orchestrator 5.5

Using the vcenter Orchestrator Plug-In for vcloud Director 5.5. vrealize Orchestrator 5.5 Using the vcenter Orchestrator Plug-In for vcloud Director 5.5 vrealize Orchestrator 5.5 You can find the most up-to-date technical documentation on the VMware website at: https://docs.vmware.com/ If you

More information

Request Manager User's Guide

Request Manager User's Guide vcloud Request Manager 1.0.0 This document supports the version of each product listed and supports all subsequent versions until the document is replaced by a new edition. To check for more recent editions

More information

vcloud API Programming Guide

vcloud API Programming Guide vcloud Director 5.6 This document supports the version of each product listed and supports all subsequent versions until the document is replaced by a new edition. To check for more recent editions of

More information

vcloud Director User's Guide

vcloud Director User's Guide vcloud Director 8.0 This document supports the version of each product listed and supports all subsequent versions until the document is replaced by a new edition. To check for more recent editions of

More information

vcloud Director Administrator's Guide

vcloud Director Administrator's Guide vcloud Director 5.1.1 This document supports the version of each product listed and supports all subsequent versions until the document is replaced by a new edition. To check for more recent editions of

More information

vcloud Director User's Guide

vcloud Director User's Guide vcloud Director 8.20 This document supports the version of each product listed and supports all subsequent versions until the document is replaced by a new edition. To check for more recent editions of

More information

Installing and Configuring vcloud Connector

Installing and Configuring vcloud Connector Installing and Configuring vcloud Connector vcloud Connector 2.6.0 This document supports the version of each product listed and supports all subsequent versions until the document is replaced by a new

More information

vcloud Director User's Guide

vcloud Director User's Guide vcloud Director 5.6 This document supports the version of each product listed and supports all subsequent versions until the document is replaced by a new edition. To check for more recent editions of

More information

vcloud Director User's Guide

vcloud Director User's Guide vcloud Director 8.20 This document supports the version of each product listed and supports all subsequent versions until the document is replaced by a new edition. To check for more recent editions of

More information

vcloud Director User's Guide 04 OCT 2018 vcloud Director 9.5

vcloud Director User's Guide 04 OCT 2018 vcloud Director 9.5 vcloud Director User's Guide 04 OCT 2018 vcloud Director 9.5 You can find the most up-to-date technical documentation on the VMware website at: https://docs.vmware.com/ If you have comments about this

More information

Lifecycle Manager User's Guide

Lifecycle Manager User's Guide vcenter Lifecycle Manager 1.2 This document supports the version of each product listed and supports all subsequent versions until the document is replaced by a new edition. To check for more recent editions

More information

Using vrealize Operations Tenant App as a Service Provider

Using vrealize Operations Tenant App as a Service Provider Using vrealize Operations Tenant App as a Service Provider Using vrealize Operations Tenant App as a Service Provider You can find the most up-to-date technical documentation on the VMware Web site at:

More information

Installing and Configuring vcloud Connector

Installing and Configuring vcloud Connector Installing and Configuring vcloud Connector vcloud Connector 2.5.0 This document supports the version of each product listed and supports all subsequent versions until the document is replaced by a new

More information

vcloud Director Administrator's Guide

vcloud Director Administrator's Guide vcloud Director 5.5 This document supports the version of each product listed and supports all subsequent versions until the document is replaced by a new edition. To check for more recent editions of

More information

VMware vfabric Data Director Installation Guide

VMware vfabric Data Director Installation Guide VMware vfabric Data Director Installation Guide vfabric Data Director 1.0.1 This document supports the version of each product listed and supports all subsequent versions until the document is replaced

More information

VMware View Upgrade Guide

VMware View Upgrade Guide View 4.0 View Manager 4.0 View Composer 2.0 This document supports the version of each product listed and supports all subsequent versions until the document is replaced by a new edition. To check for

More information

Multi-Machine Guide vcloud Automation Center 5.2

Multi-Machine Guide vcloud Automation Center 5.2 Multi-Machine Guide vcloud Automation Center 5.2 This document supports the version of each product listed and supports all subsequent versions until the document is replaced by a new edition. To check

More information

vcloud Director Tenant Portal Guide 04 OCT 2018 vcloud Director 9.5

vcloud Director Tenant Portal Guide 04 OCT 2018 vcloud Director 9.5 vcloud Director Tenant Portal Guide 04 OCT 2018 vcloud Director 9.5 You can find the most up-to-date technical documentation on the VMware website at: https://docs.vmware.com/ If you have comments about

More information

vcloud Director Administrator's Guide vcloud Director 8.10

vcloud Director Administrator's Guide vcloud Director 8.10 vcloud Director Administrator's Guide vcloud Director 8.10 You can find the most up-to-date technical documentation on the VMware website at: https://docs.vmware.com/ If you have comments about this documentation,

More information

VMware vfabric Data Director Installation Guide

VMware vfabric Data Director Installation Guide VMware vfabric Data Director Installation Guide vfabric Data Director 2.5 This document supports the version of each product listed and supports all subsequent versions until the document is replaced by

More information

vcloud SDK for.net Developer's Guide

vcloud SDK for.net Developer's Guide vcloud Director 8.10 This document supports the version of each product listed and supports all subsequent versions until the document is replaced by a new edition. To check for more recent editions of

More information

IaaS Integration for Multi- Machine Services. vrealize Automation 6.2

IaaS Integration for Multi- Machine Services. vrealize Automation 6.2 IaaS Integration for Multi- Machine Services vrealize Automation 6.2 You can find the most up-to-date technical documentation on the VMware website at: https://docs.vmware.com/ If you have comments about

More information

IaaS Integration for Multi-Machine Services

IaaS Integration for Multi-Machine Services IaaS Integration for Multi-Machine Services vcloud Automation Center 6.1 This document supports the version of each product listed and supports all subsequent versions until the document is replaced by

More information

vsphere Guest Programming Guide VMware vsphere Guest SDK 4.0

vsphere Guest Programming Guide VMware vsphere Guest SDK 4.0 VMware vsphere Guest SDK 4.0 This document supports the version of each product listed and supports all subsequent versions until the document is replaced by a new edition. To check for more recent editions

More information

vcenter Chargeback User s Guide

vcenter Chargeback User s Guide vcenter Chargeback 1.5 This document supports the version of each product listed and supports all subsequent versions until the document is replaced by a new edition. To check for more recent editions

More information

vcloud SDK for.net Developer's Guide

vcloud SDK for.net Developer's Guide vcloud Director 5.1 This document supports the version of each product listed and supports all subsequent versions until the document is replaced by a new edition. To check for more recent editions of

More information

vcenter CapacityIQ Installation Guide

vcenter CapacityIQ Installation Guide vcenter CapacityIQ 1.0 This document supports the version of each product listed and supports all subsequent versions until the document is replaced by a new edition. To check for more recent editions

More information

vcenter CapacityIQ Installation Guide

vcenter CapacityIQ Installation Guide vcenter CapacityIQ 1.0.1 This document supports the version of each product listed and supports all subsequent versions until the document is replaced by a new edition. To check for more recent editions

More information

vsphere Web Client Extensions Programming Guide vsphere 5.1

vsphere Web Client Extensions Programming Guide vsphere 5.1 vsphere Web Client Extensions Programming Guide vsphere 5.1 This document supports the version of each product listed and supports all subsequent versions until the document is replaced by a new edition.

More information

What s New with VMware vcloud Director 8.0

What s New with VMware vcloud Director 8.0 Feature Overview TECHNICAL WHITE PAPER Table of Contents What s New with VMware....3 Support for vsphere 6.0 and NSX 6.1.4....4 VMware vsphere 6.0 Support...4 VMware NSX 6.1.4 Support....4 Organization

More information

vsphere Basic System Administration

vsphere Basic System Administration Update 1 ESX 4.0 ESXi 4.0 vcenter Server 4.0 This document supports the version of each product listed and supports all subsequent versions until the document is replaced by a new edition. To check for

More information

VMware Identity Manager Cloud Deployment. Modified on 01 OCT 2017 VMware Identity Manager

VMware Identity Manager Cloud Deployment. Modified on 01 OCT 2017 VMware Identity Manager VMware Identity Manager Cloud Deployment Modified on 01 OCT 2017 VMware Identity Manager You can find the most up-to-date technical documentation on the VMware Web site at: https://docs.vmware.com/ The

More information

VMware Identity Manager Cloud Deployment. DEC 2017 VMware AirWatch 9.2 VMware Identity Manager

VMware Identity Manager Cloud Deployment. DEC 2017 VMware AirWatch 9.2 VMware Identity Manager VMware Identity Manager Cloud Deployment DEC 2017 VMware AirWatch 9.2 VMware Identity Manager You can find the most up-to-date technical documentation on the VMware website at: https://docs.vmware.com/

More information

VMware vcloud Director for Service Providers

VMware vcloud Director for Service Providers Architecture Overview TECHNICAL WHITE PAPER Table of Contents Scope of Document....3 About VMware vcloud Director....3 Platform for Infrastructure Cloud...3 Architecture Overview....3 Constructs of vcloud

More information

vcloud Director Administrator's Guide vcloud Director 9.0

vcloud Director Administrator's Guide vcloud Director 9.0 vcloud Director 9.0 You can find the most up-to-date technical documentation on the VMware Web site at: https://docs.vmware.com/ The VMware Web site also provides the latest product updates. If you have

More information

Deploying VMware Identity Manager in the DMZ. JULY 2018 VMware Identity Manager 3.2

Deploying VMware Identity Manager in the DMZ. JULY 2018 VMware Identity Manager 3.2 Deploying VMware Identity Manager in the DMZ JULY 2018 VMware Identity Manager 3.2 You can find the most up-to-date technical documentation on the VMware website at: https://docs.vmware.com/ If you have

More information

Deploying VMware Identity Manager in the DMZ. SEPT 2018 VMware Identity Manager 3.3

Deploying VMware Identity Manager in the DMZ. SEPT 2018 VMware Identity Manager 3.3 Deploying VMware Identity Manager in the DMZ SEPT 2018 VMware Identity Manager 3.3 You can find the most up-to-date technical documentation on the VMware website at: https://docs.vmware.com/ If you have

More information

Developing and Deploying vsphere Solutions, vservices, and ESX Agents. 17 APR 2018 vsphere Web Services SDK 6.7 vcenter Server 6.7 VMware ESXi 6.

Developing and Deploying vsphere Solutions, vservices, and ESX Agents. 17 APR 2018 vsphere Web Services SDK 6.7 vcenter Server 6.7 VMware ESXi 6. Developing and Deploying vsphere Solutions, vservices, and ESX Agents 17 APR 2018 vsphere Web Services SDK 6.7 vcenter Server 6.7 VMware ESXi 6.7 You can find the most up-to-date technical documentation

More information

vsphere Replication for Disaster Recovery to Cloud vsphere Replication 6.5

vsphere Replication for Disaster Recovery to Cloud vsphere Replication 6.5 vsphere Replication for Disaster Recovery to Cloud vsphere Replication 6.5 You can find the most up-to-date technical documentation on the VMware website at: https://docs.vmware.com/ If you have comments

More information

Getting Started with ESXi Embedded

Getting Started with ESXi Embedded ESXi 4.0 Embedded vcenter Server 4.0 This document supports the version of each product listed and supports all subsequent versions until the document is replaced by a new edition. To check for more recent

More information

VMware vcenter Configuration Manager and VMware vcenter Application Discovery Manager Integration Guide

VMware vcenter Configuration Manager and VMware vcenter Application Discovery Manager Integration Guide VMware vcenter Configuration Manager and VMware vcenter Application Discovery Manager Integration Guide vcenter Configuration Manager 5.7 vcenter Application Discovery Manager 6.2 This document supports

More information

Developing and Deploying vsphere Solutions, vservices, and ESX Agents

Developing and Deploying vsphere Solutions, vservices, and ESX Agents Developing and Deploying vsphere Solutions, vservices, and ESX Agents vsphere 5.0 This document supports the version of each product listed and supports all subsequent versions until the document is replaced

More information

Installing and Configuring vcenter Support Assistant

Installing and Configuring vcenter Support Assistant Installing and Configuring vcenter Support Assistant vcenter Support Assistant 6.0 This document supports the version of each product listed and supports all subsequent versions until the document is replaced

More information

VMware Identity Manager Connector Installation and Configuration (Legacy Mode)

VMware Identity Manager Connector Installation and Configuration (Legacy Mode) VMware Identity Manager Connector Installation and Configuration (Legacy Mode) VMware Identity Manager This document supports the version of each product listed and supports all subsequent versions until

More information

vsphere Basic System Administration

vsphere Basic System Administration Update 1 ESX 4.0 ESXi 4.0 vcenter Server 4.0 This document supports the version of each product listed and supports all subsequent versions until the document is replaced by a new edition. To check for

More information

vsphere Replication for Disaster Recovery to Cloud

vsphere Replication for Disaster Recovery to Cloud vsphere Replication for Disaster Recovery to Cloud vsphere Replication 5.6 This document supports the version of each product listed and supports all subsequent versions until the document is replaced

More information

VMware Skyline Collector Installation and Configuration Guide. VMware Skyline 1.4

VMware Skyline Collector Installation and Configuration Guide. VMware Skyline 1.4 VMware Skyline Collector Installation and Configuration Guide VMware Skyline 1.4 You can find the most up-to-date technical documentation on the VMware website at: https://docs.vmware.com/ If you have

More information

vsphere Replication for Disaster Recovery to Cloud

vsphere Replication for Disaster Recovery to Cloud vsphere Replication for Disaster Recovery to Cloud vsphere Replication 6.0 This document supports the version of each product listed and supports all subsequent versions until the document is replaced

More information

VMware vcloud Air Key Concepts

VMware vcloud Air Key Concepts vcloud Air This document supports the version of each product listed and supports all subsequent versions until the document is replaced by a new edition. To check for more recent editions of this document,

More information

Developing and Deploying vsphere Solutions, vservices, and ESX Agents

Developing and Deploying vsphere Solutions, vservices, and ESX Agents Developing and Deploying vsphere Solutions, vservices, and ESX Agents Modified on 27 JUL 2017 vsphere Web Services SDK 6.5 vcenter Server 6.5 VMware ESXi 6.5 Developing and Deploying vsphere Solutions,

More information

VMware Skyline Collector Installation and Configuration Guide. VMware Skyline Collector 2.0

VMware Skyline Collector Installation and Configuration Guide. VMware Skyline Collector 2.0 VMware Skyline Collector Installation and Configuration Guide VMware Skyline Collector 2.0 You can find the most up-to-date technical documentation on the VMware website at: https://docs.vmware.com/ If

More information

vsphere Replication for Disaster Recovery to Cloud vsphere Replication 8.1

vsphere Replication for Disaster Recovery to Cloud vsphere Replication 8.1 vsphere Replication for Disaster Recovery to Cloud vsphere Replication 8.1 You can find the most up-to-date technical documentation on the VMware website at: https://docs.vmware.com/ If you have comments

More information

vsphere PowerCLI Installation Guide VMware vsphere PowerCLI 4.1 Update 1 EN

vsphere PowerCLI Installation Guide VMware vsphere PowerCLI 4.1 Update 1 EN VMware vsphere PowerCLI 4.1 Update 1 EN-000407-00 You can find the most up-to-date technical documentation on the VMware Web site at: http://www.vmware.com/support/ The VMware Web site also provides the

More information

VMware vcenter AppSpeed Installation and Upgrade Guide AppSpeed 1.2

VMware vcenter AppSpeed Installation and Upgrade Guide AppSpeed 1.2 VMware vcenter AppSpeed Installation and Upgrade Guide AppSpeed 1.2 This document supports the version of each product listed and supports all subsequent versions until the document is replaced by a new

More information

Infrastructure Navigator Installation and Administration Guide

Infrastructure Navigator Installation and Administration Guide Infrastructure Navigator Installation and Administration Guide vcenter Infrastructure Navigator 1.1.0 This document supports the version of each product listed and supports all subsequent versions until

More information

VMware vcloud Air User's Guide

VMware vcloud Air User's Guide vcloud Air This document supports the version of each product listed and supports all subsequent versions until the document is replaced by a new edition. To check for more recent editions of this document,

More information

vcloud SDK for.net Developer's Guide

vcloud SDK for.net Developer's Guide vcloud Director 5.5 This document supports the version of each product listed and supports all subsequent versions until the document is replaced by a new edition. To check for more recent editions of

More information

VMware vrealize Operations Management Pack for vcloud Director 4.5 Guide

VMware vrealize Operations Management Pack for vcloud Director 4.5 Guide VMware vrealize Operations Management Pack for Director 4.5 Guide This document supports the version of each product listed and supports all subsequent versions until the document is replaced by a new

More information

Ver Enterprise Cloud. User s Guide for. API Function. ver1.03

Ver Enterprise Cloud. User s Guide for. API Function. ver1.03 Enterprise Cloud User s Guide for API Function ver1.03 1 Index Index... 2 1 Use of this document... 4 2 Common Information... 5 API use flow...5 Preparation...5 API Workflow...5 API Endpoint...6 3 API

More information

Developing and Deploying vsphere Solutions, vservices, and ESX Agents

Developing and Deploying vsphere Solutions, vservices, and ESX Agents Developing and Deploying vsphere Solutions, vservices, and ESX Agents vsphere 6.0 This document supports the version of each product listed and supports all subsequent versions until the document is replaced

More information

VMware vrealize Operations Management Pack for vcloud Director 5.0 Guide

VMware vrealize Operations Management Pack for vcloud Director 5.0 Guide VMware vrealize Operations Management Pack for vcloud Director 5.0 Guide You can find the most up-to-date technical documentation on the VMware website at: https://docs.vmware.com/ If you have comments

More information

Using the vrealize Orchestrator Plug-In for vrealize Automation 7.0. vrealize Orchestrator 7.0

Using the vrealize Orchestrator Plug-In for vrealize Automation 7.0. vrealize Orchestrator 7.0 Using the vrealize Orchestrator Plug-In for vrealize Automation 7.0 vrealize Orchestrator 7.0 You can find the most up-to-date technical documentation on the VMware website at: https://docs.vmware.com/

More information

Using VMware vrealize Orchestrator with VMware vcloud Availability for vcloud Director Version 1.0 April 2017

Using VMware vrealize Orchestrator with VMware vcloud Availability for vcloud Director Version 1.0 April 2017 Using VMware vrealize Orchestrator with VMware vcloud Availability for vcloud Director Version 1.0 April 2017 Page 1 of 53 This product is protected by U.S. and international copyright and intellectual

More information

vcloud Director Data Protection Extension REST API

vcloud Director Data Protection Extension REST API vcloud Director Data Protection Extension REST API Version 2.0.4 1 Reference Guide 302-001-989 REV 05 Copyright 2001-2016 EMC Corporation. All rights reserved. Published in the USA. Published October,

More information

Using vrealize Operations Tenant App for vcloud Director as a Tenant Admin

Using vrealize Operations Tenant App for vcloud Director as a Tenant Admin Using vrealize Operations Tenant App for vcloud Director as a Tenant Admin Using vrealize Operations Tenant App for vcloud Director as a Tenant Admin You can find the most up-to-date technical documentation

More information

VMware vcenter Configuration Manager Administration Guide vcenter Configuration Manager 5.7

VMware vcenter Configuration Manager Administration Guide vcenter Configuration Manager 5.7 VMware vcenter Configuration Manager Administration Guide vcenter Configuration Manager 5.7 This document supports the version of each product listed and supports all subsequent versions until the document

More information

vcenter Update Manager PowerCLI Installation and Administration Guide vcenter Update Manager PowerCLI 4.1 EN

vcenter Update Manager PowerCLI Installation and Administration Guide vcenter Update Manager PowerCLI 4.1 EN vcenter Update Manager PowerCLI Installation and Administration Guide vcenter Update Manager PowerCLI 4.1 EN-000368-00 vcenter Update Manager PowerCLI Installation and Administration Guide You can find

More information

vrealize Operations Manager API Programming Guide vrealize Operations Manager 6.6

vrealize Operations Manager API Programming Guide vrealize Operations Manager 6.6 vrealize Operations Manager API Programming Guide vrealize Operations Manager 6.6 vrealize Operations Manager API Programming Guide You can find the most up-to-date technical documentation on the VMware

More information

vshield Quick Start Guide

vshield Quick Start Guide vshield Manager 4.1.0 Update 1 vshield Zones 4.1.0 Update 1 vshield Edge 1.0.0 Update 1 vshield App 1.0.0 Update 1 vshield Endpoint 1.0.0 Update 1 This document supports the version of each product listed

More information

Upgrade Guide. vcloud Availability for vcloud Director 2.0

Upgrade Guide. vcloud Availability for vcloud Director 2.0 vcloud Availability for vcloud Director 2.0 Upgrade Guide vcloud Availability for vcloud Director 2.0 vcloud Availability for vcloud Director 2.0 Upgrade Guide You can find the most up-to-date technical

More information

Horizon DaaS Platform 6.1 Service Provider Installation - vcloud

Horizon DaaS Platform 6.1 Service Provider Installation - vcloud Horizon DaaS Platform 6.1 Service Provider Installation - vcloud This guide provides information on how to install and configure the DaaS platform Service Provider appliances using vcloud discovery of

More information

vsphere Datacenter Administration Guide

vsphere Datacenter Administration Guide vsphere Datacenter Administration Guide ESX 4.1 ESXi 4.1 vcenter Server 4.1 This document supports the version of each product listed and supports all subsequent versions until the document is replaced

More information

Installing and Configuring vcenter Multi-Hypervisor Manager

Installing and Configuring vcenter Multi-Hypervisor Manager Installing and Configuring vcenter Multi-Hypervisor Manager vcenter Server 5.1 vcenter Multi-Hypervisor Manager 1.1.2 This document supports the version of each product listed and supports all subsequent

More information

Managing Multi-Hypervisor Environments with vcenter Server

Managing Multi-Hypervisor Environments with vcenter Server Managing Multi-Hypervisor Environments with vcenter Server vcenter Server 5.1 vcenter Multi-Hypervisor Manager 1.1.2 This document supports the version of each product listed and supports all subsequent

More information

vcenter Server Installation and Setup Modified on 11 MAY 2018 VMware vsphere 6.7 vcenter Server 6.7

vcenter Server Installation and Setup Modified on 11 MAY 2018 VMware vsphere 6.7 vcenter Server 6.7 vcenter Server Installation and Setup Modified on 11 MAY 2018 VMware vsphere 6.7 vcenter Server 6.7 You can find the most up-to-date technical documentation on the VMware website at: https://docs.vmware.com/

More information

vsphere Virtual Machine Administration

vsphere Virtual Machine Administration ESXi 5.0 vcenter Server 5.0 This document supports the version of each product listed and supports all subsequent versions until the document is replaced by a new edition. To check for more recent editions

More information

VMware vsphere Update Manager PowerCLI Installation and Administration Guide Update Manager PowerCLI 6.0 EN

VMware vsphere Update Manager PowerCLI Installation and Administration Guide Update Manager PowerCLI 6.0 EN VMware vsphere Update Manager PowerCLI Installation and Administration Guide Update Manager PowerCLI 6.0 EN-001579-00 VMware vsphere Update Manager PowerCLI Installation and Administration Guide You can

More information

VMware vcenter Discovered Machines Import Tool User's Guide Version for vcenter Configuration Manager 5.6

VMware vcenter Discovered Machines Import Tool User's Guide Version for vcenter Configuration Manager 5.6 VMware vcenter Discovered Machines Import Tool User's Guide Version 5.3.0.25 for vcenter Configuration Manager 5.6 This document supports the version of each product listed and supports all subsequent

More information

vcenter Server Installation and Setup Update 1 Modified on 30 OCT 2018 VMware vsphere 6.7 vcenter Server 6.7

vcenter Server Installation and Setup Update 1 Modified on 30 OCT 2018 VMware vsphere 6.7 vcenter Server 6.7 vcenter Server Installation and Setup Update 1 Modified on 30 OCT 2018 VMware vsphere 6.7 vcenter Server 6.7 You can find the most up-to-date technical documentation on the VMware website at: https://docs.vmware.com/

More information

vrealize Suite Lifecycle Manager 1.0 Installation and Management vrealize Suite 2017

vrealize Suite Lifecycle Manager 1.0 Installation and Management vrealize Suite 2017 vrealize Suite Lifecycle Manager 1.0 Installation and Management vrealize Suite 2017 vrealize Suite Lifecycle Manager 1.0 Installation and Management You can find the most up-to-date technical documentation

More information

vshield Administration Guide

vshield Administration Guide vshield Manager 5.1 vshield App 5.1 vshield Edge 5.1 vshield Endpoint 5.1 This document supports the version of each product listed and supports all subsequent versions until the document is replaced by

More information

vrealize Operations Manager Customization and Administration Guide vrealize Operations Manager 6.4

vrealize Operations Manager Customization and Administration Guide vrealize Operations Manager 6.4 vrealize Operations Manager Customization and Administration Guide vrealize Operations Manager 6.4 vrealize Operations Manager Customization and Administration Guide You can find the most up-to-date technical

More information

VMware Integrated OpenStack Quick Start Guide

VMware Integrated OpenStack Quick Start Guide VMware Integrated OpenStack Quick Start Guide VMware Integrated OpenStack 1.0.1 This document supports the version of each product listed and supports all subsequent versions until the document is replaced

More information

vrealize Infrastructure Navigator Installation and Configuration Guide

vrealize Infrastructure Navigator Installation and Configuration Guide vrealize Infrastructure Navigator Installation and Configuration Guide vrealize Infrastructure Navigator 5.8.5 This document supports the version of each product listed and supports all subsequent versions

More information

Programming Guide Guest SDK 3.5

Programming Guide Guest SDK 3.5 Guest SDK 3.5 Revision: 20071129 Item: SDK-ENG-Q407-126 You can find the most up-to-date technical documentation on our Web site at http://www.vmware.com/support/ The VMware Web site also provides the

More information

vcloud Usage Meter 3.6 User's Guide vcloud Usage Meter 3.6

vcloud Usage Meter 3.6 User's Guide vcloud Usage Meter 3.6 vcloud Usage Meter 3.6 You can find the most up-to-date technical documentation on the VMware Web site at: https://docs.vmware.com/ The VMware Web site also provides the latest product updates. If you

More information

Setting Up Resources in VMware Identity Manager (On Premises) Modified on 30 AUG 2017 VMware AirWatch 9.1.1

Setting Up Resources in VMware Identity Manager (On Premises) Modified on 30 AUG 2017 VMware AirWatch 9.1.1 Setting Up Resources in VMware Identity Manager (On Premises) Modified on 30 AUG 2017 VMware AirWatch 9.1.1 Setting Up Resources in VMware Identity Manager (On Premises) You can find the most up-to-date

More information

Tenant Administration. vrealize Automation 6.2

Tenant Administration. vrealize Automation 6.2 vrealize Automation 6.2 You can find the most up-to-date technical documentation on the VMware website at: https://docs.vmware.com/ If you have comments about this documentation, submit your feedback to

More information

What s New in VMware vcloud Director 8.20

What s New in VMware vcloud Director 8.20 What s New in VMware vcloud Director 8.20 Feature Overview TECHNICAL WHITE PAPER Table of Contents Introduction.... 3 Feature Updates.... 3 Advanced NSX Networking Features.... 3 Custom Role-Based Access

More information

Reconfiguring VMware vsphere Update Manager. 17 APR 2018 VMware vsphere 6.7 vsphere Update Manager 6.7

Reconfiguring VMware vsphere Update Manager. 17 APR 2018 VMware vsphere 6.7 vsphere Update Manager 6.7 Reconfiguring VMware vsphere Update Manager 17 APR 2018 VMware vsphere 6.7 vsphere Update Manager 6.7 You can find the most up-to-date technical documentation on the VMware website at: https://docs.vmware.com/

More information

Using the Horizon vrealize Orchestrator Plug-In

Using the Horizon vrealize Orchestrator Plug-In Using the Horizon vrealize Orchestrator Plug-In VMware Horizon 6 version 6.2.3, VMware Horizon 7 versions 7.0.3 and later Modified on 4 JAN 2018 VMware Horizon 7 7.4 You can find the most up-to-date technical

More information

TECHNICAL WHITE PAPER AUGUST 2017 REVIEWER S GUIDE FOR VIEW IN VMWARE HORIZON 7: INSTALLATION AND CONFIGURATION. VMware Horizon 7 version 7.

TECHNICAL WHITE PAPER AUGUST 2017 REVIEWER S GUIDE FOR VIEW IN VMWARE HORIZON 7: INSTALLATION AND CONFIGURATION. VMware Horizon 7 version 7. TECHNICAL WHITE PAPER AUGUST 2017 REVIEWER S GUIDE FOR VIEW IN VMWARE HORIZON 7: INSTALLATION AND CONFIGURATION VMware Horizon 7 version 7.x Table of Contents Introduction.... 3 JMP Next-Generation Desktop

More information

Certified Reference Design for VMware Cloud Providers

Certified Reference Design for VMware Cloud Providers VMware vcloud Architecture Toolkit for Service Providers Certified Reference Design for VMware Cloud Providers Version 2.5 August 2018 2018 VMware, Inc. All rights reserved. This product is protected by

More information

IaaS Configuration for vcloud Director

IaaS Configuration for vcloud Director vcloud Automation Center 6.1 This document supports the version of each product listed and supports all subsequent versions until the document is replaced by a new edition. To check for more recent editions

More information

vcloud Usage Meter 3.5 User's Guide vcloud Usage Meter 3.5

vcloud Usage Meter 3.5 User's Guide vcloud Usage Meter 3.5 vcloud Usage Meter 3.5 User's Guide vcloud Usage Meter 3.5 You can find the most up-to-date technical documentation on the VMware website at: https://docs.vmware.com/ If you have comments about this documentation,

More information

Reconfiguring VMware vsphere Update Manager. Update 1 VMware vsphere 6.5 vsphere Update Manager 6.5

Reconfiguring VMware vsphere Update Manager. Update 1 VMware vsphere 6.5 vsphere Update Manager 6.5 Reconfiguring VMware vsphere Update Manager Update 1 VMware vsphere 6.5 vsphere Update Manager 6.5 You can find the most up-to-date technical documentation on the VMware website at: https://docs.vmware.com/

More information